Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Zededa

Zededa EdgeNetworkInstanceConfiguration API

The EdgeNetworkInstanceConfiguration API from Zededa — 3 operation(s) for edgenetworkinstanceconfiguration.

Documentation Provider Profile APIs.io OpenAPI GitHub

Zededa EdgeNetworkInstanceConfiguration API is one of 35 APIs that Zededa publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include EdgeNetworkInstanceConfiguration. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 6 operations across 3 paths, and defines 32 schemas. It is described by OpenAPI 2.0, at version 1.0.

Requests are made against the base URL https://zedcontrol.zededa.net/api.

6 operations 3 paths 32 schemas 1 DELETE3 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
1.0
Base URL
https://zedcontrol.zededa.net/api
Authentication
API Key
Contact
ZEDEDA API Support
License
Apache 2.0
Terms of Service
View terms
Resource Areas
1

Authentication & Security 1

Zededa EdgeNetworkInstanceConfiguration API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (BearerToken). By default, every request must be authenticated.

  • BearerToken — Bearer token for user session

Paths & Operations 6

Across 3 paths, the API surfaces 6 operations — 1 DELETE, 3 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

EdgeNetworkInstanceConfiguration 6
GET
/v1/netinsts
Query edge network instances
EdgeNetworkInstanceConfiguration_QueryEdgeNetworkInstances 14 params → 200400401403500504default
POST
/v1/netinsts
Create edge network instance
EdgeNetworkInstanceConfiguration_CreateEdgeNetworkInstance 2 params → 200400401403409500504default
GET
/v1/netinsts/id/{id}
Get edge network instance
EdgeNetworkInstanceConfiguration_GetEdgeNetworkInstance 2 params → 200401403404500504default
DELETE
/v1/netinsts/id/{id}
Delete edge network instance
EdgeNetworkInstanceConfiguration_DeleteEdgeNetworkInstance 2 params → 200401403404500504default
PUT
/v1/netinsts/id/{id}
Update edge network instance
EdgeNetworkInstanceConfiguration_UpdateEdgeNetworkInstance 3 params → 200401403404409500504default
GET
/v1/netinsts/name/{name}
Get edge network instance
EdgeNetworkInstanceConfiguration_GetEdgeNetworkInstanceByName 2 params → 200401403404500504default

Schemas 32

The contract defines 32 schemas that model the data the API accepts and returns. The most detailed are NetInstConfig (26 properties), NetInstConfigUpdate_HttpRequest (26 properties), ZsrvResponse (15 properties), NetInstShortConfig (10 properties). Each schema is shown below with its type and property counts.

ZcOpsType
string
NtpServer
object
NTP Server
1 property
ObjectType
string
NetInstList
object
5 properties
LispConfig
object
List Configurations.
6 properties
Summary
object
Summary is used to store the Summary details
3 properties
dhcpIpRange
object
DHCP IP range
2 properties
NetworkInstanceDhcpType
string
protobufAny
object
2 properties
ServicePoint
object
Service Point
3 properties
Cursor
object
Cursor helps in filtering the various list response like edge-app bundle list, model list, bundle list etc.
5 properties
StaticDNSList
object
Static DNS list
2 properties
spType
string
clone of types defined in API repo. - SPTYPEMAPSERVER: mapping service for zededa overlay service - SPTYPESUPPORTSERVER: if device has support feature enabled,…
ObjectRevision
object
ObjectRevision store the user details, who has doent the necessary operation like Create Operation or update operation
6 properties 5 required
OpaqueConfigType
string
NetInstConfig
object
Network instance provides Edge applications a variety of connectivity choices for all types of networks. This enables logical secure connectivity between Edge…
26 properties 5 required
ZcOpsStatus
string
- OPSSTATUSPENDING: In rare cases, system may not start operation when it was requested. Client will be notified that operation is PENDING - OPSSTATUSONGOING:…
NetInstConfigUpdate_HttpRequest
object
Network instance provides Edge applications a variety of connectivity choices for all types of networks. This enables logical secure connectivity between Edge…
26 properties 6 required
NetInstOpaqueConfig
object
Network Instance Opaque config. This is service specific configuration.
3 properties
NetInstEdgeNodeCluster
object
2 properties
StaticIPRoute
object
Static IP Routes
4 properties
ZsrvError
object
3 properties
googlerpcStatus
object
3 properties
commonConnectivityProbeMethod
string
User-defined method to use to determine the connectivity status. - CONNECTIVITYPROBEMETHODUNSPECIFIED: Connectivity probing method is not specified and therefo…
NetInstShortConfig
object
Network instance provides Edge applications a variety of connectivity choices for all types of networks. This enables logical secure connectivity between Edge…
10 properties
commonConnectivityProbe
object
Configuration for user-defined connectivity-testing probe.
2 properties
DhcpServerConfig
object
8 properties
ZsrvResponse
object
15 properties
ZsrvErrorCode
string
- zMsgErrorNone: common validation errors - IncompleteData: message had fields that weren't filled in - InvalidData: message contained the field that wasn't ex…
NetworkInstanceKind
string
commonProbeEndpoint
object
Address of a remote endpoint to probe in order to determine connectivity status.
2 properties
ProbeConfig
object
Probing configuration
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zededa-edgenetworkinstanceconfiguration-api-openapi.yml Raw ↑

Other APIs Zededa publishes across the network.

Zededa AppProfileService API
AE Profile APIs.io
Zededa ArtifactManager API
AE Profile APIs.io
Zededa AssetGroupService API
AE Profile APIs.io
Zededa BulkJobOps API
AE Profile APIs.io
Zededa CertificateEnrollmentProfileConfiguration API
AE Profile APIs.io
Zededa CloudDiagnostics API
AE Profile APIs.io
Zededa ClusterGroups API
AE Profile APIs.io
Zededa ClusterStatus API
AE Profile APIs.io
Zededa DatastoreConfiguration API
AE Profile APIs.io
Zededa EdgeApplicationConfiguration API
AE Profile APIs.io
Zededa EdgeApplicationInstanceConfiguration API
AE Profile APIs.io
Zededa EdgeApplicationInstanceStatus API
AE Profile APIs.io
#EdgeNetworkInstanceConfiguration
← Back to Z APIs
API Details
ID
zededa:zededa-edgenetworkinstanceconfiguration-api
Base URL
https://zedcontrol.zededa.net/api
Docs
https://zedcontrol.zededa.net/api/v1/docs/
Provider
Zededa
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network