> ## 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.

# Query status and config of edge network instances

> GET /api/v1/netinsts/status-config. 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:
>
> <ol aria-label="Console menu path">
>   <li>Profile menu</li><li>Help & Documentation</li><li>API Reference</li>
> </ol>
>
> 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)

&#x20;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.
Bad Request. The API gateway did not process the request because of invalid value of filter parameters.
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.
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/status-config
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/status-config:
    get:
      tags:
        - EdgeNetworkInstanceStatus
      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
      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
          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
          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
      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'
      externalDocs:
        description: ZEDEDA Product Documentation
        url: https://docs.zededa.com/-M-8m8d8KqdLpfOgY_jo/edge-network
components:
  schemas:
    NetInstConfigStatusList:
      type: object
      properties:
        list:
          type: array
          items:
            $ref: '#/components/schemas/NetInstConfigStatus'
        summaryByKind:
          description: >-
            Summary information about netinstance config status list records by
            network instance kind.
          allOf:
            - $ref: '#/components/schemas/Summary'
        summaryByAddressType:
          description: >-
            Summary information about netinstance config status list records by
            addressing type.
          allOf:
            - $ref: '#/components/schemas/Summary'
        next:
          $ref: '#/components/schemas/Cursor'
    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'
    NetInstConfigStatus:
      type: object
      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/NetInstConfigStatus/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/NetInstConfigStatus/properties/name'
              keyword: uniqueItems
              sourceValue: true
        runState:
          $ref: '#/components/schemas/RunState'
        upTimeStamp:
          type: string
          format: date-time
        uplinkIntf:
          type: string
        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: >-
            User defined name of the clusterInstance, 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/NetInstConfigStatus/properties/clusterID'
              keyword: uniqueItems
              sourceValue: true
        type:
          $ref: '#/components/schemas/NetworkInstanceDhcpType'
        kind:
          $ref: '#/components/schemas/NetworkInstanceKind'
        deviceDefault:
          type: boolean
        deviceId:
          type: string
        projectId:
          type: string
        deviceName:
          type: string
        projectName:
          type: string
        networkPolicyId:
          type: string
        edgeNodeClusterID:
          type: string
      description: >-
        NetInstConfigStatus stores the summary of the network instance config
        status.
      title: Network instance config status
    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
    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.
    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
    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
    NetworkInstanceDhcpType:
      type: string
      enum:
        - NETWORK_INSTANCE_DHCP_TYPE_UNSPECIFIED
        - NETWORK_INSTANCE_DHCP_TYPE_V4
        - NETWORK_INSTANCE_DHCP_TYPE_V6
        - NETWORK_INSTANCE_DHCP_TYPE_CRYPTOEID
        - NETWORK_INSTANCE_DHCP_TYPE_CRYPTOV4
        - NETWORK_INSTANCE_DHCP_TYPE_CRYPTOV6
      default: NETWORK_INSTANCE_DHCP_TYPE_UNSPECIFIED
      title: |-
        NetworkInstanceDhcpType: Used in the network instance provide
           dhcp server configuration
    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
    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
  securitySchemes:
    BearerToken:
      type: http
      description: Bearer token for user session
      scheme: bearer

````