Zededa EdgeNetworkInstanceStatus API
The EdgeNetworkInstanceStatus API from Zededa — 5 operation(s) for edgenetworkinstancestatus.
The EdgeNetworkInstanceStatus API from Zededa — 5 operation(s) for edgenetworkinstancestatus.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/zededa-edgenetworkinstancestatus-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: ZEDEDA App Profiles Service AppProfileService Edge Network Instance Status API
description: The ZEDEDA App Profiles Service is part of ZEDEDA Edge Orchestration Platform. This service enables customers to define their app profiles on ZEDEDA platform and to manage them remotely.
termsOfService: https://www.zededa.com/terms
version: '1.0'
contact:
name: ZEDEDA API Support
url: https://www.zededa.com/support
email: support@zededa.com
license:
name: Apache 2.0
url: http://www.apache.org/licenses/LICENSE-2.0.html
servers:
- url: /api
security:
- BearerToken: []
tags:
- name: EdgeNetworkInstanceStatus
paths:
/v1/netinsts/id/{id}/status:
get:
summary: Get edge network instance status
description: Get the status of an edge network instance as reported by the edge node where the edge network instance has been deployed.
operationId: EdgeNetworkInstanceStatus_GetEdgeNetworkInstanceStatus
responses:
'200':
description: A successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/NetInstStatusMsg'
'401':
description: Unauthorized. The API gateway did not process the request because it lacks valid authentication credentials for the target resource. The request header has either no authorization details or an authorization that has been refused.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'403':
description: Forbidden. The API gateway did not process the request because the requestor does not have edge-node level access permission for the operation or does not have access scope to the project.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'404':
description: Not Found. The API gateway did not process the request because the requested resource could not be found.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'500':
description: Internal Server Error. The API gateway experienced an unexpected condition. Specific error condition is indicated in error codes.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'504':
description: Gateway Timeout. The API gateway did not receive a timely response from an upstream microservice it needed to communicate with in order to complete the request.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/googlerpcStatus'
parameters:
- name: id
in: path
required: true
schema:
type: string
- name: X-Request-Id
in: header
required: false
description: User-Agent specified id to track a request
schema:
type: string
tags:
- EdgeNetworkInstanceStatus
externalDocs:
description: ZEDEDA Product Documentation
url: https://docs.zededa.com/-M-8m8d8KqdLpfOgY_jo/edge-network
/v1/netinsts/name/{name}/status:
get:
summary: Get edge network instance status
description: Get the status of an edge network instance as reported by the edge node where the edge network instance has been deployed.
operationId: EdgeNetworkInstanceStatus_GetEdgeNetworkInstanceStatusByName
responses:
'200':
description: A successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/NetInstStatusMsg'
'401':
description: Unauthorized. The API gateway did not process the request because it lacks valid authentication credentials for the target resource. The request header has either no authorization details or an authorization that has been refused.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'403':
description: Forbidden. The API gateway did not process the request because the requestor does not have edge-node level access permission for the operation or does not have access scope to the project.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'404':
description: Not Found. The API gateway did not process the request because the requested resource could not be found.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'500':
description: Internal Server Error. The API gateway experienced an unexpected condition. Specific error condition is indicated in error codes.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'504':
description: Gateway Timeout. The API gateway did not receive a timely response from an upstream microservice it needed to communicate with in order to complete the request.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/googlerpcStatus'
parameters:
- name: name
in: path
required: true
schema:
type: string
- name: X-Request-Id
in: header
required: false
description: User-Agent specified id to track a request
schema:
type: string
tags:
- EdgeNetworkInstanceStatus
externalDocs:
description: ZEDEDA Product Documentation
url: https://docs.zededa.com/-M-8m8d8KqdLpfOgY_jo/edge-network
/v1/netinsts/status:
get:
summary: Query status of edge network instances
description: Query the status of edge network instances as reported by the edge nodes where the edge network instances have been deployed.
operationId: EdgeNetworkInstanceStatus_QueryEdgeNetworkInstanceStatus
responses:
'200':
description: A successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/NetInstStatusListMsg'
'400':
description: Bad Request. The API gateway did not process the request because of invalid value of filter parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'401':
description: Unauthorized. The API gateway did not process the request because it lacks valid authentication credentials for the target resource. The request header has either no authorization details or an authorization that has been refused.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'403':
description: Forbidden. The API gateway did not process the request because the requestor does not have edge-node level access permission for the operation or does not have access scope to the project.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'500':
description: Internal Server Error. The API gateway experienced an unexpected condition. Specific error condition is indicated in error codes.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'504':
description: Gateway Timeout. The API gateway did not receive a timely response from an upstream microservice it needed to communicate with in order to complete the request.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/googlerpcStatus'
parameters:
- name: deviceName
in: query
required: false
schema:
type: string
- name: projectName
in: query
required: false
schema:
type: string
- name: namePattern
in: query
required: false
schema:
type: string
- name: tags
in: query
required: false
schema:
type: string
- name: runState
in: query
required: false
schema:
type: string
enum:
- UNSPECIFIED
- ONLINE
- HALTED
- INIT
- REBOOTING
- OFFLINE
- UNKNOWN
- UNPROVISIONED
- PROVISIONED
- SUSPECT
- DOWNLOADING
- RESTARTING
- PURGING
- HALTING
- ERROR
- VERIFYING
- LOADING
- CREATING_VOLUME
- BOOTING
- MAINTENANCE_MODE
- START_DELAYED
- BASEOS_UPDATING
- PREPARING_POWEROFF
- POWERING_OFF
- PREPARED_POWEROFF
default: UNSPECIFIED
- name: deviceNamePattern
in: query
required: false
schema:
type: string
- name: projectNamePattern
in: query
required: false
schema:
type: string
- name: type
in: query
required: false
schema:
type: integer
format: int32
- name: kind
in: query
required: false
schema:
type: integer
format: int32
- name: summary
in: query
required: false
schema:
type: boolean
- name: next.pageToken
description: Page Token
in: query
required: false
schema:
type: string
- name: next.orderBy
description: OrderBy helps in sorting the list response
in: query
required: false
style: form
explode: true
schema:
type: array
items:
type: string
- name: next.pageNum
description: Page Number
in: query
required: false
schema:
type: number
format: int64
- name: next.pageSize
description: Defines the page size
in: query
required: false
schema:
type: number
format: int64
- name: next.totalPages
description: Total number of pages to be fetched.
in: query
required: false
schema:
type: number
format: int64
- name: fields
in: query
required: false
style: form
explode: true
schema:
type: array
items:
type: string
- name: X-Request-Id
in: header
required: false
description: User-Agent specified id to track a request
schema:
type: string
tags:
- EdgeNetworkInstanceStatus
externalDocs:
description: ZEDEDA Product Documentation
url: https://docs.zededa.com/-M-8m8d8KqdLpfOgY_jo/edge-network
/v1/netinsts/status-config:
get:
summary: Query status and config of edge network instances
description: Query the status and config of edge network instances as reported by the edge nodes where the edge network instances have been deployed.
operationId: EdgeNetworkInstanceStatus_QueryEdgeNetworkInstanceStatusConfig
responses:
'200':
description: A successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/NetInstConfigStatusList'
'400':
description: Bad Request. The API gateway did not process the request because of invalid value of filter parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'401':
description: Unauthorized. The API gateway did not process the request because it lacks valid authentication credentials for the target resource. The request header has either no authorization details or an authorization that has been refused.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'403':
description: Forbidden. The API gateway did not process the request because the requestor does not have edge-node level access permission for the operation or does not have access scope to the project.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'500':
description: Internal Server Error. The API gateway experienced an unexpected condition. Specific error condition is indicated in error codes.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'504':
description: Gateway Timeout. The API gateway did not receive a timely response from an upstream microservice it needed to communicate with in order to complete the request.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/googlerpcStatus'
parameters:
- name: deviceName
in: query
required: false
schema:
type: string
- name: projectName
in: query
required: false
schema:
type: string
- name: namePattern
in: query
required: false
schema:
type: string
- name: tags
in: query
required: false
schema:
type: string
- name: runState
in: query
required: false
schema:
type: string
enum:
- UNSPECIFIED
- ONLINE
- HALTED
- INIT
- REBOOTING
- OFFLINE
- UNKNOWN
- UNPROVISIONED
- PROVISIONED
- SUSPECT
- DOWNLOADING
- RESTARTING
- PURGING
- HALTING
- ERROR
- VERIFYING
- LOADING
- CREATING_VOLUME
- BOOTING
- MAINTENANCE_MODE
- START_DELAYED
- BASEOS_UPDATING
- PREPARING_POWEROFF
- POWERING_OFF
- PREPARED_POWEROFF
default: UNSPECIFIED
- name: deviceNamePattern
in: query
required: false
schema:
type: string
- name: projectNamePattern
in: query
required: false
schema:
type: string
- name: type
in: query
required: false
schema:
type: integer
format: int32
- name: kind
in: query
required: false
schema:
type: integer
format: int32
- name: summary
in: query
required: false
schema:
type: boolean
- name: next.pageToken
description: Page Token
in: query
required: false
schema:
type: string
- name: next.orderBy
description: OrderBy helps in sorting the list response
in: query
required: false
style: form
explode: true
schema:
type: array
items:
type: string
- name: next.pageNum
description: Page Number
in: query
required: false
schema:
type: number
format: int64
- name: next.pageSize
description: Defines the page size
in: query
required: false
schema:
type: number
format: int64
- name: next.totalPages
description: Total number of pages to be fetched.
in: query
required: false
schema:
type: number
format: int64
- name: fields
in: query
required: false
style: form
explode: true
schema:
type: array
items:
type: string
- name: X-Request-Id
in: header
required: false
description: User-Agent specified id to track a request
schema:
type: string
tags:
- EdgeNetworkInstanceStatus
externalDocs:
description: ZEDEDA Product Documentation
url: https://docs.zededa.com/-M-8m8d8KqdLpfOgY_jo/edge-network
/v1/netinsts/tags:
get:
summary: Query Network instance tags
description: Netork instance tags LIST API is to fetch the interfaces tags attached to app instances.
operationId: EdgeNetworkInstanceStatus_GetNetworkInstanceInterfaceTags
responses:
'200':
description: A successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/ObjectTagsList'
'400':
description: Bad Request. The API gateway did not process the request because of invalid value of filter parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'401':
description: Unauthorized. The API gateway did not process the request because it lacks valid authentication credentials for the target resource. The request header has either no authorization details or an authorization that has been refused.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'403':
description: Forbidden. The API gateway did not process the request because the requestor does not have edge-node level access permission for the operation or does not have access scope to the project.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'500':
description: Internal Server Error. The API gateway experienced an unexpected condition. Specific error condition is indicated in error codes.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
'504':
description: Gateway Timeout. The API gateway did not receive a timely response from an upstream microservice it needed to communicate with in order to complete the request.
content:
application/json:
schema:
$ref: '#/components/schemas/ZsrvResponse'
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/googlerpcStatus'
parameters:
- name: next.pageToken
description: Page Token
in: query
required: false
schema:
type: string
- name: next.orderBy
description: OrderBy helps in sorting the list response
in: query
required: false
style: form
explode: true
schema:
type: array
items:
type: string
- name: next.pageNum
description: Page Number
in: query
required: false
schema:
type: number
format: int64
- name: next.pageSize
description: Defines the page size
in: query
required: false
schema:
type: number
format: int64
- name: next.totalPages
description: Total number of pages to be fetched.
in: query
required: false
schema:
type: number
format: int64
- name: X-Request-Id
in: header
required: false
description: User-Agent specified id to track a request
schema:
type: string
tags:
- EdgeNetworkInstanceStatus
externalDocs:
description: ZEDEDA Product Documentation
url: https://docs.zededa.com/-M-8m8d8KqdLpfOgY_jo/edge-network
components:
schemas:
ObjectTag:
type: object
properties:
key:
type: string
description: object tag key identifier.
value:
type: string
description: value associated for the object tag key
description:
type: string
description: Description of the tag key
description: Object tag deaails.
title: Object Tag details
NetInstConfigStatusList:
type: object
properties:
list:
type: array
items:
$ref: '#/components/schemas/NetInstConfigStatus'
summaryByKind:
$ref: '#/components/schemas/Summary'
description: Summary information about netinstance config status list records by network instance kind.
summaryByAddressType:
$ref: '#/components/schemas/Summary'
description: Summary information about netinstance config status list records by addressing type.
next:
$ref: '#/components/schemas/Cursor'
ZsrvError:
type: object
properties:
ec:
$ref: '#/components/schemas/ZsrvErrorCode'
title: 'Enumrated error code, describes more granular numerical
value than just httpStatus'
location:
type: string
title: 'Ignore: Internal field only'
details:
type: string
title: Field captures string description of details
ObjectTagsList:
type: object
properties:
objectTags:
type: array
items:
$ref: '#/components/schemas/ObjectTag'
description: Details of Object tags list records.
next:
$ref: '#/components/schemas/Cursor'
description: Returned record page.
description: Returned list of Object tags matched by filter criteria
title: Object tag list records
Summary:
type: object
properties:
description:
type: string
description: Summary description
total:
type: number
format: int64
description: Total
values:
type: object
additionalProperties:
type: integer
format: int64
description: 'Values: Map for storing <string, uint32>'
description: Summary is used to store the Summary details
title: Summary is used to store the Summary details
protobufAny:
type: object
properties:
typeUrl:
type: string
value:
type: string
format: byte
IoMemberStatus:
type: object
properties:
name:
type: string
description: IoBundle Member name
ioAddress:
$ref: '#/components/schemas/IoAddresses'
description: IO addresses of the member. Each address corresponds to the member in the members array
Entity:
type: string
enum:
- ENTITY_UNSPECIFIED
- ENTITY_BASE_OS
- ENTITY_SYSTEM_ADAPTER
- ENTITY_VAULT
- ENTITY_ATTESTATION
- ENTITY_APP_INSTANCE
- ENTITY_PORT
- ENTITY_NETWORK
- ENTITY_NETWORK_INSTANCE
- ENTITY_CONTENT_TREE
- ENTITY_CONTENT_BLOB
- ENTITY_VOLUME
default: ENTITY_UNSPECIFIED
description: "- ENTITY_UNSPECIFIED: Invalid Device Entity\n - ENTITY_BASE_OS: Base OS entity\n - ENTITY_SYSTEM_ADAPTER: System Adapter Entity\n - ENTITY_VAULT: Vault Entity\n - ENTITY_ATTESTATION: Attestation Entity\n - ENTITY_APP_INSTANCE: App Instance Entity\n - ENTITY_PORT: Port Entity\n - ENTITY_NETWORK: Network Entity\n - ENTITY_NETWORK_INSTANCE: Network Instance Entity\n - ENTITY_CONTENT_TREE: ContentTree Entity\n - ENTITY_CONTENT_BLOB: Blob Entity\n - ENTITY_VOLUME: VOLUME Entity"
title: Edge node components
Cursor:
type: object
properties:
pageToken:
type: string
description: Page Token
orderBy:
type: array
items:
type: string
description: OrderBy helps in sorting the list response
pageNum:
type: number
format: int64
description: Page Number
pageSize:
type: number
format: int64
description: Defines the page size
totalPages:
type: number
format: int64
description: Total number of pages to be fetched.
description: 'Cursor helps in filtering the various list response like edge-app bundle list, model list, bundle list etc. '
title: Cursor is used as filter in list operation.
DeviceEntity:
type: object
properties:
entity:
$ref: '#/components/schemas/Entity'
entityId:
type: string
entityName:
type: string
NetInstStatusMsg:
type: object
example:
id: d85a545f-6510-4327-b03d-c02eef119e99
name: sample-app
properties:
id:
type: string
description: System defined universally unique Id of the network instance
readOnly: true
pattern: '[0-9A-Za-z-]+'
uniqueItems: true
name:
type: string
description: User defined name of the network instance, unique across the enterprise. Once object is created, name can’t be changed
maxLength: 256
minLength: 3
pattern: '[a-zA-Z0-9][a-zA-Z0-9_.-]+'
uniqueItems: true
deviceId:
type: string
title: device on which this network is running
runState:
$ref: '#/components/schemas/RunState'
upTimeStamp:
type: string
format: date-time
tags:
type: object
additionalProperties:
type: string
description: Tags are name/value pairs that enable you to categorize resources. Tag names are case insensitive with max_length 512 and min_length 3. Tag values are case sensitive with max_length 256 and min_length 3.
maxLength: 32
pattern: ^[^<%&?/\>]+$
clusterID:
type: string
description: System defined universally unique clusterInstance ID, unique across the enterprise.
maxLength: 256
minLength: 3
pattern: '[a-zA-Z0-9][a-zA-Z0-9_.-]+'
uniqueItems: true
projectId:
type: string
kind:
$ref: '#/components/schemas/NetworkInstanceKind'
bridgeNum:
type: integer
format: int64
bridgeName:
type: string
bridgeIPAddr:
type: string
ipMappings:
type: array
items:
$ref: '#/components/schemas/IPAssignment'
vifs:
type: array
items:
$ref: '#/components/schemas/VifInfo'
ipv4Eid:
type: boolean
assignedAdapters:
type: array
items:
$ref: '#/components/schemas/IoBundleStatus'
uplinkIntf:
type: string
mtu:
type: integer
format: int64
description: Maximum transmission unit (MTU) to set for the network instance and all application interfaces connected to it
ipRoutes:
type: array
items:
$ref: '#/components/schemas/eveinfoIPRoute'
description: List of IP routes used by the network instance
ports:
type: array
items:
type: string
description: List of ports used by the network instance
errInfo:
type: array
items:
$ref: '#/components/schemas/DeviceError'
rawStatus:
type: string
description: Network instance provides Edge applications a variety of connectivity choices for all types of networks. This enables logical secure connectivity between Edge applications within a single Edge node and within a logical group of Edge nodes. This provides detailed status of a Network instance.
title: Network instance detailed status
ZcOpsType:
type: string
enum:
- OPS_TYPE_UNSPECIFIED
- OPS_TYPE_READ
- OPS_TYPE_DELETE
- OPS_TYPE_CREATE
- OPS_TYPE_UPDATE
- OPS_TYPE_LIST
default: OPS_TYPE_UNSPECIFIED
title: ZedCloud internal operation type
IoBundleStatus:
type: object
properties:
type:
type: object
$ref: '#/components/schemas/IoType'
description: IoType specifies the type of the Input output of the device
name:
type: string
description: Io Bundle status name
members:
type: array
items:
type: string
description: Member Array
title: members - Deprecated by memberList
appName:
type: string
description: Application name
lteInfo:
type: object
$ref: '#/components/schemas/LTEAdapter'
description: LTE information
err:
$ref: '#/components/schemas/DeviceError'
description: Device error details
title: 6 - DEPRECATED
memberList:
type: array
items:
$ref: '#/components/schemas/IoMemberStatus'
description: List of IO members
description: IoBundleStatus is used to store the status of the Input Output bundle
title: IoBundleStatus is used to store the status of the Input Output bundle
required:
- type
- name
- members
- appName
VifInfo:
type: object
properties:
vifName:
type: string
macAddress:
type: string
appName:
type: string
ZsrvResponse:
type: object
properties:
operationType:
$ref: '#/components/schemas/ZcOpsType'
title: "Describes one of the operations type : possible values\n Read/Delete/Create/Update/List"
operationStatus:
$ref: '#/components/schemas/ZcOpsStatus'
title: if this is log running job
objectKind:
type: string
title: zedcloud object kind on which the operation was performed
objectId:
type: string
title: Unique value identifies the object that was operated on
objectName:
type: string
title: name of the object
objectRevision:
type: string
title: 'object revision post the operation, note Read operation
doesn''t change the revision'
objectType:
$ref: '#/components/schemas/ObjectType'
operationTime:
type: string
title: time of operation
startTime:
type: string
title: total time taken by operations
endTime:
type: string
user:
type: string
title: the operation is performed on behalf of this user
httpStatusCode:
type: integer
format: int32
title: http response
httpStatusMsg:
type: string
title: summary of the error in text format
jobId:
type: string
title: for tracking asynchronous tasks
error:
type: array
items:
$ref: '#/components/schemas/ZsrvError'
title: 'one or more errors will be set if the operation failed
i.e. httpStatusCode != 2xx'
ObjectType:
type:
# --- truncated at 32 KB (48 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/zededa/refs/heads/main/openapi/zededa-edgenetworkinstancestatus-api-openapi.yml