> ## Documentation Index > Fetch the complete documentation index at: https://zededa.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. > ## Agent Instructions > Use the documentation index to find relevant pages, then read the linked Markdown before answering and cite the source URL. > Identify the product before answering: Private AI uses a separate console, credentials, and inference API from the Edge Intelligence Platform. Do not apply instructions from one product to the other. > Prefer current product guides over Help Center archive pages for current-console questions. Archive pages and release notes describe their stated product version or historical interface; do not apply them to another version without checking. > Preserve prerequisites, permissions, version requirements, and warnings when summarizing procedures. Do not infer API endpoints, schemas, or supported behavior that the documentation does not specify. # Get edge network instance status (GET /v1/netinsts/id/{id}/status) > GET /api/v1/netinsts/id/{id}/status. Edge networks API reference. Sign in to try this endpointExplore the parameters, examples, and responses below. Connect your ZedCloud session when you’re ready to send a request. > [accordion] Connect your console > > Sign in to your usual ZedCloud console, then open: > >
    >
  1. Profile menu
  2. Help & Documentation
  3. API Reference
    4. >
> > Your cluster and authorization are filled in automatically. No token to copy. > [More about signing in ](https://zededa.mintlify.site/api-reference/authentication.md#sign-in-to-the-api-reference) Modifying requests stay off until you enable them. [Authentication](https://zededa.mintlify.site/api-reference/authentication.md) · [API availability](https://zededa.mintlify.site/api-reference/clusters.md) · [Download OpenAPI](https://zededa.mintlify.site/openapi/services/edge-network.json) A successful response. 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. 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. Not Found. The API gateway did not process the request because the requested resource could not be found. Internal Server Error. The API gateway experienced an unexpected condition. Specific error condition is indicated in error codes. 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. An unexpected error response. ## OpenAPI ````yaml openapi/services/edge-network.json GET /v1/netinsts/id/{id}/status openapi: 3.0.0 info: title: ZEDEDA Edge Network Service description: >- The ZEDEDA Edge Network Service is helper service to ZEDEDA Edge Application Service. This service provides edge nodes and applications a variety of connectivity choices for all types of networks. This enables physical connectivity with Ethernet, WiFi, LTE to communicate with Cloud Controller and Data Centres on one hand and logical secure connectivity between applications within a single edge node and within a logical group of edge nodes. This also supports secure tunnel from an edge node or an edge application in a remote location to a Data server behindi firewall in AWS or Azure or On-premise VPC. 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: https://{apiHost}/api variables: apiHost: default: invalid.invalid description: Connect from ZedUI to supply your verified API destination. security: - BearerToken: [] tags: - name: EdgeNetworkConfiguration - name: EdgeNetworkInstanceConfiguration - name: EdgeNetworkInstanceStatus externalDocs: description: ZEDEDA Product Documentation url: https://docs.zededa.com/-M-8m8d8KqdLpfOgY_jo/edge-network paths: /v1/netinsts/id/{id}/status: get: tags: - EdgeNetworkInstanceStatus 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 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 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' externalDocs: description: ZEDEDA Product Documentation url: https://docs.zededa.com/-M-8m8d8KqdLpfOgY_jo/edge-network components: schemas: 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-]+' x-zededa-source-issues: - code: inapplicable-constraint pointer: '#/definitions/NetInstStatusMsg/properties/id' keyword: uniqueItems sourceValue: 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_.-]+' x-zededa-source-issues: - code: inapplicable-constraint pointer: '#/definitions/NetInstStatusMsg/properties/name' keyword: uniqueItems sourceValue: 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_.-]+' x-zededa-source-issues: - code: inapplicable-constraint pointer: '#/definitions/NetInstStatusMsg/properties/clusterID' keyword: uniqueItems sourceValue: 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 ZsrvResponse: type: object properties: operationType: title: |- Describes one of the operations type : possible values Read/Delete/Create/Update/List allOf: - $ref: '#/components/schemas/ZcOpsType' operationStatus: title: if this is log running job allOf: - $ref: '#/components/schemas/ZcOpsStatus' 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 googlerpcStatus: type: object properties: code: type: integer format: int32 message: type: string details: type: array items: $ref: '#/components/schemas/protobufAny' RunState: type: string enum: - RUN_STATE_UNSPECIFIED - RUN_STATE_ONLINE - RUN_STATE_HALTED - RUN_STATE_INIT - RUN_STATE_REBOOTING - RUN_STATE_OFFLINE - RUN_STATE_UNKNOWN - RUN_STATE_UNPROVISIONED - RUN_STATE_PROVISIONED - RUN_STATE_SUSPECT - RUN_STATE_DOWNLOADING - RUN_STATE_RESTARTING - RUN_STATE_PURGING - RUN_STATE_HALTING - RUN_STATE_ERROR - RUN_STATE_VERIFYING - RUN_STATE_LOADING - RUN_STATE_CREATING_VOLUME - RUN_STATE_BOOTING - RUN_STATE_MAINTENANCE_MODE - RUN_STATE_START_DELAYED - RUN_STATE_BASEOS_UPDATING - RUN_STATE_PREPARING_POWEROFF - RUN_STATE_POWERING_OFF - RUN_STATE_PREPARED_POWEROFF default: RUN_STATE_UNSPECIFIED description: |- - RUN_STATE_ONLINE: Entity Online - RUN_STATE_HALTED: Entity Halted - RUN_STATE_INIT: Entity Initializing - RUN_STATE_REBOOTING: Entity Rebooting - RUN_STATE_OFFLINE: Entity Offline - RUN_STATE_UNKNOWN: Entity state Unknown - RUN_STATE_UNPROVISIONED: Entity Unprovisioned - RUN_STATE_PROVISIONED: Entity Provisioned - RUN_STATE_SUSPECT: Entity Suspect - RUN_STATE_DOWNLOADING: Edge-node downloading entity artifacts - RUN_STATE_RESTARTING: Entity Restarting - RUN_STATE_PURGING: Entity Purging - RUN_STATE_HALTING: Entity Halting - RUN_STATE_ERROR: Entity encountered an error - RUN_STATE_VERIFYING: Verification of downloaded Artifacts in Progress. - RUN_STATE_LOADING: Loading of Artifacts into local datastore in Progress. - RUN_STATE_CREATING_VOLUME: Volume creation from artifacts in Progress - RUN_STATE_BOOTING: Entity booting up - RUN_STATE_MAINTENANCE_MODE: Entity maintenance mode - RUN_STATE_START_DELAYED: Application start delayed as per configuration - RUN_STATE_BASEOS_UPDATING: Device BaseOs Update in Progress - RUN_STATE_PREPARING_POWEROFF: device preparing power off - shutting down all app instances - RUN_STATE_POWERING_OFF: device powering off from local profile server - RUN_STATE_PREPARED_POWEROFF: device prepared power off - all app instances are shut down title: RunState - On update, please update RunState_HttpRequest as well NetworkInstanceKind: type: string enum: - NETWORK_INSTANCE_KIND_UNSPECIFIED - NETWORK_INSTANCE_KIND_TRANSPARENT - NETWORK_INSTANCE_KIND_SWITCH - NETWORK_INSTANCE_KIND_LOCAL - NETWORK_INSTANCE_KIND_CLOUD - NETWORK_INSTANCE_KIND_MESH - NETWORK_INSTANCE_KIND_HONEYPOT default: NETWORK_INSTANCE_KIND_UNSPECIFIED IPAssignment: type: object properties: macAddress: type: string ipAddress: type: array items: type: string VifInfo: type: object properties: vifName: type: string macAddress: type: string appName: type: string IoBundleStatus: type: object properties: type: description: >- IoType specifies the type of the Input output of the device **Source definition conflict:** this property declares type `"object"`, while the referenced definition declares `"string"`. The referenced schema is shown; the conflicting declaration needs correction in ZEDEDA's Swagger definition. allOf: - $ref: '#/components/schemas/IoType' x-zededa-source-issues: - code: conflicting-reference pointer: '#/definitions/IoBundleStatus/properties/type' keyword: type sourceValue: object reference: '#/definitions/IoType' referencedValue: string 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 description: LTE information allOf: - $ref: '#/components/schemas/LTEAdapter' err: description: Device error details title: 6 - DEPRECATED allOf: - $ref: '#/components/schemas/DeviceError' 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 eveinfoIPRoute: type: object properties: destinationNetwork: type: string title: >- Destination network address in the CIDR format: / gateway: type: string description: |- Gateway IP address. Empty for connected route. port: type: string description: >- Logical label of the output device port for the routed traffic. Empty if the gateway is IP address of one of the applications. In that case, 'gateway_app' is defined instead. gatewayApp: type: string description: >- UUID of the application used as the gateway for the route. Empty if the gateway is external (not one of the apps but outside of the device) or this is a connected route for a port (thus gateway is empty). In that case, 'port' is defined instead. description: >- 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 route) and the output "port". However, if the gateway is one of the applications running on the device, the port is actually a virtual interface with an EVE-generated interface name and no user-assigned logical label. Therefore, in such cases, it is more useful to leave "port" empty and instead use the "gateway_app" field to publish the UUID of the application used as the gateway. DeviceError: type: object properties: description: type: string description: Description of the error severity: type: string description: Severity of the error allOf: - $ref: '#/components/schemas/Severity' timestamp: type: object format: date-time description: Timestamp at which error had occurred entities: type: array items: $ref: '#/components/schemas/DeviceEntity' description: objects referenced by the description or retry_condition retryCondition: type: string description: condition for retry description: DeviceError store the error occurred at the device side title: DeviceError is used to store the error details of the hardware. required: - description - severity - timestamp - entities 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 ZcOpsStatus: type: string enum: - OPS_STATUS_UNSPECIFIED - OPS_STATUS_PENDING - OPS_STATUS_ONGOING - OPS_STATUS_COMPLETE default: OPS_STATUS_UNSPECIFIED description: >- - OPS_STATUS_PENDING: In rare cases, system may not start operation when it was requested. Client will be notified that operation is PENDING - OPS_STATUS_ONGOING: system will start the operation, but at the time response was generated, operation is still ONGOING. - OPS_STATUS_COMPLETE: Even if the result of the operations may result in failure, but the OpsStatus will marked COMPLETE for almost all cases. title: ZedCloud internal operation status ObjectType: type: string enum: - OBJECT_TYPE_UNSPECIFIED - OBJECT_TYPE_USER - OBJECT_TYPE_EDGE_NODE - OBJECT_TYPE_EDGE_APP - OBJECT_TYPE_IMAGE - OBJECT_TYPE_EDGE_APP_INSTANCE - OBJECT_TYPE_PROJECT - OBJECT_TYPE_NETWORK - OBJECT_TYPE_DATASTORE - OBJECT_TYPE_SERVICE - OBJECT_TYPE_SERVICE_INSTANCE - OBJECT_TYPE_ENTERPRISE - OBJECT_TYPE_ROLE - OBJECT_TYPE_CREDENTIAL - OBJECT_TYPE_NETWORK_INSTANCE - OBJECT_TYPE_VOLUME_INSTANCE - OBJECT_TYPE_REALM - OBJECT_TYPE_AUTHPROFILE - OBJECT_TYPE_POLICY - OBJECT_TYPE_APP_POLICY - OBJECT_TYPE_CLUSTER_INSTANCE - OBJECT_TYPE_PLUGIN - OBJECT_TYPE_DOC_POLICY - OBJECT_TYPE_ORCHESTRATOR_CLUSTER - OBJECT_TYPE_TAGS - OBJECT_TYPE_EDGE_NODE_INTERFACE - OBJECT_TYPE_DEPLOYMENT - OBJECT_TYPE_ENTITLEMENTS - OBJECT_TYPE_DATA_STREAM - OBJECT_TYPE_API_USAGE - OBJECT_TYPE_APP_INSTANCE_SNAPSHOT - OBJECT_TYPE_PATCH_ENVELOPE - OBJECT_TYPE_RESOURCE_USAGE_TRACK - OBJECT_TYPE_PATCH_ENVELOPE_REFERENCE - OBJECT_TYPE_DEV_PASSTHROUGH - OBJECT_TYPE_EDGE_NODE_CLUSTER - OBJECT_TYPE_ASSET_GROUP - OBJECT_TYPE_APP_PROFILE - OBJECT_TYPE_PROFILE_DEPLOYMENT - OBJECT_TYPE_ZKS_INSTANCE - OBJECT_TYPE_CLUSTER_GROUP default: OBJECT_TYPE_UNSPECIFIED ZsrvError: type: object properties: ec: title: |- Enumrated error code, describes more granular numerical value than just httpStatus allOf: - $ref: '#/components/schemas/ZsrvErrorCode' location: type: string title: 'Ignore: Internal field only' details: type: string title: Field captures string description of details protobufAny: type: object properties: typeUrl: type: string value: type: string format: byte IoType: type: string enum: - IO_TYPE_UNSPECIFIED - IO_TYPE_ETH - IO_TYPE_USB - IO_TYPE_COM - IO_TYPE_AUDIO - IO_TYPE_WLAN - IO_TYPE_WWAN - IO_TYPE_HDMI - IO_TYPE_LTE - IO_TYPE_STORAGE_NVME_DEVICE - IO_TYPE_STORAGE_SATA_DEVICE - IO_TYPE_ETH_PF - IO_TYPE_ETH_VF - IO_TYPE_USB_CONTROLLER - IO_TYPE_USB_DEVICE - IO_TYPE_CAN - IO_TYPE_VCAN - IO_TYPE_LCAN - IO_TYPE_VLAN - IO_TYPE_OTHER default: IO_TYPE_UNSPECIFIED description: |- - IO_TYPE_UNSPECIFIED: No operation/ Invalid peration - IO_TYPE_ETH: Ethernet - IO_TYPE_USB: USB Type - General - IO_TYPE_COM: Communication Port - IO_TYPE_AUDIO: Audio Port - IO_TYPE_WLAN: wireless LAN - IO_TYPE_WWAN: Wireless wide area network - IO_TYPE_HDMI: High-Definition Multimedia Interface - IO_TYPE_LTE: LTE Interfaces - IO_TYPE_STORAGE_NVME_DEVICE: Storage NVME device - IO_TYPE_STORAGE_SATA_DEVICE: Storage SATA device - IO_TYPE_ETH_PF: Physical Interface (PF) of the Virtual Functions - IO_TYPE_ETH_VF: Virtual Function (VF) - IO_TYPE_USB_CONTROLLER: USB Type - Controller - IO_TYPE_USB_DEVICE: USB Type - Device - IO_TYPE_CAN: CAN - Device - IO_TYPE_VCAN: VCAN - Virtual CAN device - IO_TYPE_LCAN: LCAN - Logical CAN device - IO_TYPE_VLAN: VLAN - Virtual LAN device - IO_TYPE_OTHER: Other Io Types title: Input/Output Type LTEAdapter: type: object properties: simName: type: string description: Name of SIM card. cellModuleName: type: string description: Name of Cell Module imsi: type: string description: imsi of the SIM iccid: type: string description: iccid of the SIM simcardState: type: string description: State of SimCard allOf: - $ref: '#/components/schemas/SimcardState' imei: type: string description: IMEI of Cell Radio. firmwareVersion: type: string description: Firmware Version of Cell Radio. description: Details of LTE Adapter title: LTE Adapter IoMemberStatus: type: object properties: name: type: string description: IoBundle Member name ioAddress: description: >- IO addresses of the member. Each address corresponds to the member in the members array allOf: - $ref: '#/components/schemas/IoAddresses' Severity: type: string enum: - SEVERITY_UNSPECIFIED - SEVERITY_NOTICE - SEVERITY_WARNING - SEVERITY_ERROR default: SEVERITY_UNSPECIFIED title: Severity tells the severity type DeviceEntity: type: object properties: entity: $ref: '#/components/schemas/Entity' entityId: type: string entityName: type: string ZsrvErrorCode: type: string enum: - zMsgErrorNone - zMsgSucess - NotFound - AlreadyExists - VersionMismatch - RangeError - LargeResult - IncompleteData - InvalidData - FunctionUnsupported - NoMemory - SendFailure - Timeout - BadReqBody - BadReqParam - InvalidFieldFormat - UrlNotFound - ApiVersionNotSupported - Unauthorized - Forbidden - Conflict - NotModified - DependencyConflict - JsonFmtError - ProtoFmtError - CertError - DataBaseConnection - DBError - zMsgAccepted - zMsgCreated - PreConditionFailed - InternalServerError default: zMsgErrorNone description: |- - zMsgErrorNone: common validation errors - IncompleteData: message had fields that weren't filled in - InvalidData: message contained the field that wasn't expected - FunctionUnsupported: this feature unavailable on this version of device - InvalidFieldFormat: message contained the field that wasn't correctly formatted - JsonFmtError: Marshal / Unmarshal errors - DataBaseConnection: generic DB error title: ZedCould internal error code SimcardState: type: string enum: - SIMCARD_STATE_INVALID - SIMCARD_STATE_ASSIGNED - SIMCARD_STATE_PROVISIONED - SIMCARD_STATE_ACTIVE - SIMCARD_STATE_SUSPENDED - SIMCARD_STATE_CANCELLED default: SIMCARD_STATE_INVALID IoAddresses: type: object properties: macAddress: type: string 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 - ENTITY_BASE_OS: Base OS entity - ENTITY_SYSTEM_ADAPTER: System Adapter Entity - ENTITY_VAULT: Vault Entity - ENTITY_ATTESTATION: Attestation Entity - ENTITY_APP_INSTANCE: App Instance Entity - ENTITY_PORT: Port Entity - ENTITY_NETWORK: Network Entity - ENTITY_NETWORK_INSTANCE: Network Instance Entity - ENTITY_CONTENT_TREE: ContentTree Entity - ENTITY_CONTENT_BLOB: Blob Entity - ENTITY_VOLUME: VOLUME Entity title: Edge node components securitySchemes: BearerToken: type: http description: Bearer token for user session scheme: bearer ````