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

Zededa EdgeNetworkInstanceStatus API

The EdgeNetworkInstanceStatus API from Zededa — 5 operation(s) for edgenetworkinstancestatus.

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

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

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

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

5 operations 5 paths 33 schemas 5 GET

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
License
Terms of Service
Resource Areas
1

Authentication & Security 1

Zededa EdgeNetworkInstanceStatus 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 5

Across 5 paths, the API surfaces 5 operations — 5 GET. Each is listed below with its method, path, parameters, and response codes.

EdgeNetworkInstanceStatus 5
GET
/v1/netinsts/id/{id}/status
Get edge network instance status
EdgeNetworkInstanceStatus_GetEdgeNetworkInstanceStatus 2 params → 200401403404500504default
GET
/v1/netinsts/name/{name}/status
Get edge network instance status
EdgeNetworkInstanceStatus_GetEdgeNetworkInstanceStatusByName 2 params → 200401403404500504default
GET
/v1/netinsts/status
Query status of edge network instances
EdgeNetworkInstanceStatus_QueryEdgeNetworkInstanceStatus 17 params → 200400401403500504default
GET
/v1/netinsts/status-config
Query status and config of edge network instances
EdgeNetworkInstanceStatus_QueryEdgeNetworkInstanceStatusConfig 17 params → 200400401403500504default
GET
/v1/netinsts/tags
Query Network instance tags
EdgeNetworkInstanceStatus_GetNetworkInstanceInterfaceTags 6 params → 200400401403500504default

Schemas 33

The contract defines 33 schemas that model the data the API accepts and returns. The most detailed are NetInstStatusMsg (22 properties), NetInstConfigStatus (16 properties), ZsrvResponse (15 properties), NetInstStatusSummaryMsg (14 properties). Each schema is shown below with its type and property counts.

ZcOpsType
string
Severity
string
ObjectType
string
NetInstStatusSummaryMsg
object
Network instance provides Edge applications a variety of connectivity choices for all types of networks. This enables logical secure connectivity between Edge…
14 properties
Summary
object
Summary is used to store the Summary details
3 properties
VifInfo
object
3 properties
IoBundleStatus
object
IoBundleStatus is used to store the status of the Input Output bundle
7 properties 4 required
NetInstStatusMsg
object
Network instance provides Edge applications a variety of connectivity choices for all types of networks. This enables logical secure connectivity between Edge…
22 properties
NetworkInstanceDhcpType
string
Entity
string
- ENTITYUNSPECIFIED: Invalid Device Entity - ENTITYBASEOS: Base OS entity - ENTITYSYSTEMADAPTER: System Adapter Entity - ENTITYVAULT: Vault Entity - ENTITYATTE…
DeviceError
object
DeviceError store the error occurred at the device side
5 properties 4 required
ObjectTagsList
object
Returned list of Object tags matched by filter criteria
2 properties
protobufAny
object
2 properties
Cursor
object
Cursor helps in filtering the various list response like edge-app bundle list, model list, bundle list etc.
5 properties
DeviceEntity
object
3 properties
IoType
string
- IOTYPEUNSPECIFIED: No operation/ Invalid peration - IOTYPEETH: Ethernet - IOTYPEUSB: USB Type - General - IOTYPECOM: Communication Port - IOTYPEAUDIO: Audio…
ZcOpsStatus
string
- OPSSTATUSPENDING: In rare cases, system may not start operation when it was requested. Client will be notified that operation is PENDING - OPSSTATUSONGOING:…
LTEAdapter
object
Details of LTE Adapter
7 properties
SimcardState
string
ZsrvError
object
3 properties
IoAddresses
object
1 property
IPAssignment
object
2 properties
googlerpcStatus
object
3 properties
NetInstStatusListMsg
object
4 properties
NetInstConfigStatusList
object
4 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…
NetInstConfigStatus
object
NetInstConfigStatus stores the summary of the network instance config status.
16 properties
NetworkInstanceKind
string
ObjectTag
object
Object tag deaails.
3 properties
RunState
string
- RUNSTATEONLINE: Entity Online - RUNSTATEHALTED: Entity Halted - RUNSTATEINIT: Entity Initializing - RUNSTATEREBOOTING: Entity Rebooting - RUNSTATEOFFLINE: En…
eveinfoIPRoute
object
Information about an IP route configured for a network instance. The next-hop for the IP route is specified by the "gateway" IP address (empty for a connected…
4 properties
IoMemberStatus
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zededa-edgenetworkinstancestatus-api-openapi.yml Raw ↑

Other APIs Zededa publishes across the network.

Zededa AppProfileService API
Zededa ArtifactManager API
Zededa AssetGroupService API
Zededa BulkJobOps API
Zededa CertificateEnrollmentProfileConfiguration API
Zededa CloudDiagnostics API
Zededa ClusterGroups API
Zededa ClusterStatus API
Zededa DatastoreConfiguration API
Zededa EdgeApplicationConfiguration API
Zededa EdgeApplicationInstanceConfiguration API
Zededa EdgeApplicationInstanceStatus API