> ## 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 application instance status (GET /v1/apps/instances/id/{id}/status) > GET /api/v1/apps/instances/id/{id}/status. Edge applications 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-application.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 application 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-application.json GET /v1/apps/instances/id/{id}/status openapi: 3.0.0 info: title: ZEDEDA Edge Application Service description: >- The ZEDEDA Edge Application Service is part of ZEDEDA Edge Orchestration Platform. This service enables customers to define their edge applications on ZEDEDA platform and to deploy/upgrade/restarti/monitor them to edge node(s) remotely. You can use the ZEDEDA Edge Application Service to provision and manage ilifecycle of thousands of edge applications to millions of edge nodes distributed in different geographical locations in a secure and scalable manner. 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: EdgeApplicationConfiguration - name: EdgeApplicationInstanceConfiguration - name: PatchEnvelopeConfiguration - name: EdgeApplicationInstanceStatus externalDocs: description: ZEDEDA Product Documentation url: https://docs.zededa.com/-M-8m8d8KqdLpfOgY_jo/edge-apps paths: /v1/apps/instances/id/{id}/status: get: tags: - EdgeApplicationInstanceStatus summary: Get edge application instance status description: >- Get the status of an edge application instance as reported by the edge node where the edge application instance has been deployed. operationId: EdgeApplicationInstanceStatus_GetEdgeApplicationInstanceStatus parameters: - name: id description: System defined universally unique Id of the app instance 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/AppInstStatusMsg' '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 application 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-apps components: schemas: AppInstStatusMsg: type: object properties: id: type: string description: app instance id name: type: string description: >- User defined name of the app instance, unique across the enterprise. Once app instance 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/AppInstStatusMsg/properties/name' keyword: uniqueItems sourceValue: true deviceId: type: string description: >- User defined name of the device, unique across the enterprise. Once device 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/AppInstStatusMsg/properties/deviceId' keyword: uniqueItems sourceValue: true appId: type: string description: >- User defined name of the edge app, unique across the enterprise. Once edge app 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/AppInstStatusMsg/properties/appId' keyword: uniqueItems sourceValue: true 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: ^[^<%&?/\>]+$ adminState: description: App instance status allOf: - $ref: '#/components/schemas/AdminState' errInfo: type: array items: $ref: '#/components/schemas/DeviceError' description: Device error details bootTime: type: string format: date-time description: device boot time lastUpdate: type: string format: date-time description: device last update time IoStatusList: type: array items: $ref: '#/components/schemas/IoBundleStatus' description: Io bundle status list swInfo: type: array items: $ref: '#/components/schemas/SWInfo' description: Software details runState: description: app instance state allOf: - $ref: '#/components/schemas/RunState' netCounterList: type: array items: $ref: '#/components/schemas/NetworkCounters' description: network counter list Memory: description: memory summary allOf: - $ref: '#/components/schemas/MemorySummary' Storage: description: storage summary allOf: - $ref: '#/components/schemas/StorageSummary' netStatusList: type: array items: $ref: '#/components/schemas/NetworkStatus' description: network status list upTime: type: string format: date-time description: device up time swState: description: software state allOf: - $ref: '#/components/schemas/SWState' Cpu: description: SPU details allOf: - $ref: '#/components/schemas/CpuSummary' projectId: type: string description: >- User defined name of the project, unique across the enterprise. Once project 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/AppInstStatusMsg/properties/projectId' keyword: uniqueItems sourceValue: true title: type: string description: app instance status title appStatusFromTPController: description: app status from third party controller allOf: - $ref: '#/components/schemas/AppStatusFromTPController' appType: description: type of app allOf: - $ref: '#/components/schemas/AppType' 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/AppInstStatusMsg/properties/clusterId' keyword: uniqueItems sourceValue: true deploymentType: description: 'type of deployment for the app, eg: azure, k3s, standalone' allOf: - $ref: '#/components/schemas/DeploymentType' memorySummary: description: memory summary allOf: - $ref: '#/components/schemas/AppInstMemorySummary' volumeRefs: type: array items: type: string description: list of volume ids attached zpoolMetrics: description: Last received counters for zvol metrics allOf: - $ref: '#/components/schemas/StorageDeviceMetrics' patchEnvelopeUsageInfo: type: array items: $ref: '#/components/schemas/PatchEnvelopeUsageInfo' description: patch envelope usage info containerStatusList: type: array items: $ref: '#/components/schemas/ComposeContainerStatus' description: docker-compose container status runtimePlatformVersions: description: Runtime platform versions allOf: - $ref: '#/components/schemas/RuntimePlatformVersions' app: description: App bundle specific info allOf: - $ref: '#/components/schemas/AppInfo' device: description: Device specific info allOf: - $ref: '#/components/schemas/DevInfo' description: AppInstanceStatusMsg encapsulates the status of an app instance title: App instance status message 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' AdminState: type: string enum: - ADMIN_STATE_UNSPECIFIED - ADMIN_STATE_CREATED - ADMIN_STATE_DELETED - ADMIN_STATE_ACTIVE - ADMIN_STATE_INACTIVE - ADMIN_STATE_REGISTERED - ADMIN_STATE_ARCHIVED - ADMIN_STATE_DELETION_PENDING default: ADMIN_STATE_UNSPECIFIED description: |- - ADMIN_STATE_CREATED: Entity Created in the controller - ADMIN_STATE_DELETED: Entity Deleted in the controller - ADMIN_STATE_ACTIVE: Entity Activated in the controller - ADMIN_STATE_INACTIVE: Entity Deactivated in the controller - ADMIN_STATE_REGISTERED: Specific to Edge-node - Edge-node Registered with the controller - ADMIN_STATE_ARCHIVED: Entity Archived in the controller - ADMIN_STATE_DELETION_PENDING: Entity was marked as Deleted but not yet deleted in the controller title: AdminState - On update, please update AdminState_HttpRequest as well 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 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 SWInfo: type: object properties: version: type: string description: software version hash: type: string description: software hash state: description: Software state allOf: - $ref: '#/components/schemas/SWState' disk: type: string description: software disk downloadProgress: type: number format: int64 description: download progress imageName: type: string description: image name description: Software Information title: Software Information 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 NetworkCounters: type: object properties: ifName: type: string description: ifName txBytes: type: number format: uint64 description: Tx Bytes rxBytes: type: number format: uint64 description: Rx Bytes txPkts: type: number format: uint64 description: Tx Packets rxPkts: type: number format: uint64 description: Rx packets txErrors: type: number format: uint64 description: Tx Errors rxErrors: type: number format: uint64 description: Rx Errors txDrops: type: number format: uint64 description: Tx Drops rxDrops: type: number format: uint64 description: Rx Drops txAclDrops: type: number format: uint64 description: Tx ACL Rate Drops rxAclDrops: type: number format: uint64 description: Rx ACL Rate Drops txAclRateLimitDrops: type: number format: uint64 description: Tx ACL Rate Limit Drops rxAclRateLimitDrops: type: number format: uint64 description: Rx ACL Rate Limit Drops description: NetworkCounter is used to store the Network Stats and Counters title: NetworkCounter is used to store the Network Stats and Counters MemorySummary: type: object properties: TotalMB: type: number format: double description: Total memory for the device in MBs UsedMB: type: number format: double description: Total memory used by the device in MBs within allocated memory AllocatedMB: type: number format: double description: Total allocated memory in MBs description: Memory Summary title: Memory Summary StorageSummary: type: object properties: TotalMB: type: number format: double description: Total Storage for the device in MBs UsedMB: type: number format: double description: How much is used within the allocated total storage AllocatedMB: type: number format: double description: Total reserved for running applications + temp. images etc sharedStorageSummary: type: array items: $ref: '#/components/schemas/SharedStorageSummary' description: Shared storage summary Id: type: string description: Id Name: type: string description: Name description: Storage Summary title: Storage Summary NetworkStatus: type: object properties: up: type: boolean description: Network Status flag macAddr: type: string description: mac Address ifName: type: string description: ifName ipAddrs: type: array items: type: string description: Array of IP addresses defaultRouters: type: array items: type: string description: Default Routers dns: type: object description: DNS Configuration allOf: - $ref: '#/components/schemas/DNSInfo' location: type: object description: Geo Location Details allOf: - $ref: '#/components/schemas/GeoLocation' uplink: type: boolean description: Uplink flag proxy: type: object description: Network Proxy status allOf: - $ref: '#/components/schemas/NetProxyStatus' errInfo: type: object description: Network error details allOf: - $ref: '#/components/schemas/DeviceError' gpsLocation: type: object description: Location from GNSS receivers on WWAN type adapters allOf: - $ref: '#/components/schemas/GPSLocation' cellular: type: object description: Cellular network status allOf: - $ref: '#/components/schemas/CellularStatus' mtu: type: integer format: int64 description: Network MTU pnacStatus: description: PNAC 802.1X authentication status for this port title: PNAC (802.1X) authentication status for this port allOf: - $ref: '#/components/schemas/PNACPortStatus' configSource: description: Identifies the source of this network port configuration allOf: - $ref: '#/components/schemas/commonPortConfigSource' description: NetworkStatus is used to store the Network status title: NetworkStatus is used to store the Network Status SWState: type: string enum: - SW_STATE_UNSPECIFIED - SW_STATE_INITIAL - SW_STATE_DOWNLOAD_IN_PROGRESS - SW_STATE_DOWNLOADED - SW_STATE_VERIFIED - SW_STATE_INSTALLED - SW_STATE_BOOTING - SW_STATE_RUNNING - SW_STATE_HALTING - SW_STATE_HALTED - SW_STATE_REFRESHING - SW_STATE_PURGING - SW_STATE_RESOLVING_TAG - SW_STATE_RESOLVED_TAG - SW_STATE_CREATING_VOLUME - SW_STATE_CREATED_VOLUME - SW_STATE_VERIFYING - SW_STATE_LOADING - SW_STATE_LOADED - SW_STATE_AWAITNETWORKINSTANCE default: SW_STATE_UNSPECIFIED description: |- - SW_STATE_RESOLVING_TAG: Prior to DOWNLOAD_STARTED we go through these: Resolving an image tag - SW_STATE_RESOLVED_TAG: Tag has been resolved/failed - SW_STATE_CREATING_VOLUME: Prior to INSTALLED we go through these: Volume create in progress - SW_STATE_CREATED_VOLUME: Volume create done/failed - SW_STATE_VERIFYING: Verification in-progress - SW_STATE_LOADING: Loading blob in CAS - SW_STATE_LOADED: Loaded blob in CAS - SW_STATE_AWAITNETWORKINSTANCE: Wait for network instance title: State of EVE/Edge Application software CpuSummary: type: object properties: Utilization: type: number format: double description: CPU Utilization description: CPU Summary title: CPU Summary AppStatusFromTPController: type: object properties: appName: type: string appId: type: string eveDeviceId: type: string enterpriseId: type: string type: $ref: '#/components/schemas/ControllerType' azureStatus: $ref: '#/components/schemas/AzureStatus' vceStatus: $ref: '#/components/schemas/VCEStatus' AppType: type: string enum: - APP_TYPE_UNSPECIFIED - APP_TYPE_VM - APP_TYPE_VM_RUNTIME - APP_TYPE_CONTAINER - APP_TYPE_MODULE - APP_TYPE_DOCKER_COMPOSE default: APP_TYPE_UNSPECIFIED description: type of app bundle. DeploymentType: type: string enum: - DEPLOYMENT_TYPE_UNSPECIFIED - DEPLOYMENT_TYPE_STAND_ALONE - DEPLOYMENT_TYPE_AZURE - DEPLOYMENT_TYPE_K3S - DEPLOYMENT_TYPE_AWS - DEPLOYMENT_TYPE_K3S_AZURE - DEPLOYMENT_TYPE_K3S_AWS - DEPLOYMENT_TYPE_VMWARE_VCE - DEPLOYMENT_TYPE_VMWARE_TKG_ATTACH - DEPLOYMENT_TYPE_DOCKER_RUNTIME default: DEPLOYMENT_TYPE_UNSPECIFIED AppInstMemorySummary: type: object properties: AllocatedMB: type: number format: double description: Total memory allocated for the App instance. title: |- AllocatedMB - Total memory allocated to the App Instance. Normally, AllocatedMB >= UsedMB + AvailableMB UsedMB: type: number format: double description: Total memory used by the App within allocated memory AvailableMB: type: number format: double description: Available / Free memory in the App description: Memory Information for the App Instance. title: App Instance Memory Summary StorageDeviceMetrics: type: object properties: readErrors: type: number format: int64 description: read errors counter writeErrors: type: number format: int64 description: write errors counter checksumErrors: type: number format: int64 description: checksum errors counter bytesRead: type: number format: int64 description: read bytes counter bytesWrite: type: number format: int64 description: write bytes counter PatchEnvelopeUsageInfo: type: object properties: uuid: type: string description: Id of patch envelope title: UUID of PatchEnvelope patchApiCallCount: type: number format: uint64 description: number of times app instance called patch APIs title: count the number of times app instance called patch APIs version: type: string description: version of patch envelope title: Version of PatchEnvelope downloadCount: type: string format: uint64 description: ' number of times app instance download whole patch envelope or part of it' title: |- count the number of times app instance actually downloaded whole patch envelope or part of it ComposeContainerStatus: type: object properties: containerName: type: string description: container name containerImage: type: string description: container image containerEntryPoint: type: string description: container entry point createTimeUTC: type: string description: container creation time - UTC portMaps: type: array items: $ref: '#/components/schemas/ContainerPortMap' description: ports mapped to container containerState: type: string description: running status of container (running, stopped, exited) uptime: type: number format: uint64 description: container up-time in seconds from start errInfo: description: >- container error information **Source definition conflict:** this property declares type `"number"`, while the referenced definition declares `"object"`. The referenced schema is shown; the conflicting declaration needs correction in ZEDEDA's Swagger definition. allOf: - $ref: '#/components/schemas/DeviceError' x-zededa-source-issues: - code: conflicting-reference pointer: '#/definitions/ComposeContainerStatus/properties/errInfo' keyword: type sourceValue: number reference: '#/definitions/DeviceError' referencedValue: object RuntimePlatformVersions: type: object properties: agentVersion: type: string description: agent version composeVersion: type: string description: compose version containerRuntimeVersion: type: string description: container runtime platform version kernelVersion: type: string description: kernel version kubernetesVersion: type: string description: kubernetes version AppInfo: type: object properties: appId: type: string description: system generated unique id for the app bundle readOnly: true pattern: '[0-9A-Za-z-]+' appName: type: string description: app bundle name DevInfo: type: object properties: deviceId: type: string description: system generated unique id for the device readOnly: true pattern: '[0-9A-Za-z-]+' deviceName: type: string description: device name rawStatus: type: string description: device raw 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 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 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 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' SharedStorageSummary: type: object properties: Id: type: string description: Id Name: type: string description: Name AllocatedMB: type: number format: double description: Allocated Storage in MBs UsedMB: type: number format: double description: How much is used within the allocated total storage description: Shared Storage Summary title: Shared Storage Summary DNSInfo: type: object properties: servers: type: array items: type: string description: Array of dns server domain: type: string description: domain name search: type: array items: type: string description: Array of search strings description: 'DNSInfo is used to store Domain Name Server configuration. ' title: DNSInfo consists of DNS Configurations. required: - servers - domain - search GeoLocation: type: object properties: underlayIP: type: string description: Single IP address, either in IPv4 or in IPv6 format hostname: type: string description: Host name city: type: string description: City region: type: string description: Region country: type: string description: >- Country code consisting of 2 capital letters as per ISO 3166-1 alpha2 standard loc: type: string description: >- Ordered pair of (latitude, longitude) separated by comma (,). Latitude is the horizontal component used for geographic positioning; it is the angle between 0° (the equator) and ±90° (north or south) at the poles measured in decimal degrees. It is the first value in an ordered pair. A negative number denotes a location south of the equator; a positive number is north. Longitude is the vertical component used for geographic positioning; it is the angle between 0° (the Prime Meridian) and ±180° (westward or eastward) measured in decimal degrees. It is the second number in an ordered pair. A negative number indicates a location west of Greenwich, England; a positive number east. org: type: string description: >- The name of the recipient, firm, or company at this geographical location. postal: type: string description: Postal code (ZIP code for USA) of the geographical location latlong: type: string description: 'Deprecated field: comma, separated lat, long' freeloc: type: string description: Free formatted location string description: >- Geographic location of an edge node determined by a variety of data collection mechanisms (e.g. network routing addresses or internal GPS devices). title: Geographic location of an edge node NetProxyStatus: type: object properties: networkProxy: type: boolean description: Use pacfile (Auto discover or manual upload) title: Enable, the proxy configuration coming from network proxies: type: array items: $ref: '#/components/schemas/NetProxyServer' description: protocol level proxies title: protocol level proxies exceptions: type: string description: exceptions pacfile: type: string description: proxy configuration in a pacfile title: proxy configuration in a pacfile networkProxyURL: type: string description: Network Proxy URL title: Direct URL for wpad.dat download wpadProxyURL: type: string description: WPAD Proxy URL description: NetProxyStatus is used to store the proxy configurations title: NetProxyStatus is used to store the proxy configurations GPSLocation: type: object properties: latitude: type: number format: double description: Latitude longitude: type: number format: double description: Longitude altitude: type: number format: double description: Altitude from mean sea level timestamp: type: object format: date-time description: UTC timestamp horizontalReliability: type: number format: int64 description: Horizontal reliability verticalReliability: type: number format: int64 description: Vertical reliability horizontalUncertainty: type: number format: double description: Horizontal uncertainty verticalUncertainty: type: number format: double description: Vertical uncertainty logicalLabel: type: string description: Logical label of the adapter used to get GPS coordinates CellularStatus: type: object properties: providers: type: array items: $ref: '#/components/schemas/NetworkProvider' description: List of network providers modem: type: object description: Modem detail allOf: - $ref: '#/components/schemas/ModemDetail' simCards: type: array items: $ref: '#/components/schemas/SIMCard' description: List of SIM Cards description: CellularStatus contains status information for a single cellular network title: CellularStatus contains status information for a single cellular network PNACPortStatus: type: object properties: enabled: type: boolean description: Whether 802.1X authentication is enabled on this port supplicantState: description: 802.1X supplicant state allOf: - $ref: '#/components/schemas/PNACSupplicantState' lastAuthTimestamp: type: string format: date-time description: Timestamp of the most recent successful 802.1X authentication. err: type: object description: Supplicant authentication error details allOf: - $ref: '#/components/schemas/DeviceError' description: >- PNACPortStatus reports the 802.1X authentication status of a network port. commonPortConfigSource: type: object properties: origin: description: Indicates where EVE obtained the network config. allOf: - $ref: '#/components/schemas/commonNetworkConfigOrigin' submittedAt: type: string format: date-time description: >- Timestamp when this port’s configuration was originally submitted or created at its source. Meaning depends on the origin: - Controller, LOC, bootstrap: timestamp provided by the controller. - Local override.json: when the file was first loaded by EVE. - Last-resort: when EVE generated the fallback config. - LPS modifications: when the modified config was received. - TUI: when the user submitted the configuration. This is different from DevicePortStatus.timePriority, which is used to compare and prioritize different sources of network configuration (and may be synthetic for some sources, e.g. year 2000 for override.json, epoch 0 for last-resort). By contrast, submitted_at represents when this port’s configuration first came into existence, regardless of when or whether the device applied it. Note: this is a per-port timestamp. The underlying network config may cover multiple ports, but only the portion relevant to this port is reflected here. description: >- PortConfigSource describes the origin of the configuration used for a network port. It helps distinguish between controller-provided, locally-modified, or initial configs. ControllerType: type: string enum: - CONTROLLER_TYPE_UNSPECIFIED - CONTROLLER_TYPE_AZURE - CONTROLLER_TYPE_AWS - CONTROLLER_TYPE_GCP - CONTROLLER_TYPE_VCO default: CONTROLLER_TYPE_UNSPECIFIED description: third party controller types. AzureStatus: type: object properties: azureDevStatus: $ref: '#/components/schemas/AzureDevStatusDetail' description: status of device from azure. VCEStatus: type: object properties: vceStatusDetail: $ref: '#/components/schemas/VCEStatusDetail' description: status of object on velocloud. ContainerPortMap: type: object properties: ip: type: string description: container ip privatePort: type: number format: int64 description: container private port publicPort: type: number format: int64 description: container public port type: type: string description: port type (tcp, udp) runtimeIp: type: string description: >- IP address that can be used for connecting to port mapped containers inside runtime 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 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 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 NetProxyServer: type: object properties: proto: description: >- Net Proxy proto **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/NetworkProxyProto' x-zededa-source-issues: - code: conflicting-reference pointer: '#/definitions/NetProxyServer/properties/proto' keyword: type sourceValue: object reference: '#/definitions/NetworkProxyProto' referencedValue: string server: type: string description: Net Proxy Server port: type: number format: int64 description: Net Proxy Port description: Net Proxy Server title: Net Proxy Server NetworkProvider: type: object properties: plmn: type: string description: PLMN code name: type: string description: Human-friendly name rat: type: string description: Radio Access Technology allOf: - $ref: '#/components/schemas/RadioAccessTechnology' roaming: type: boolean description: Is Roaming ON connectedAt: type: string format: date-time description: Time when was the connection established description: NetworkProvider describes a cellular Network Provider title: NetworkProvider describes a cellular Network Provider ModemDetail: type: object properties: manufacturer: type: string description: Modem manufacturer model: type: string description: Modem model firmwareVersion: type: string description: Modem firmware version imei: type: string description: Modem IMEI operatingState: type: string description: Modem operating state allOf: - $ref: '#/components/schemas/ZCellularOperatingState' controlProtocol: type: string description: Modem control protocol allOf: - $ref: '#/components/schemas/ZCellularControlProtocol' description: ModemDetail describes a cellular Modem title: ModemDetail describes a cellular Modem SIMCard: type: object properties: slotNumber: type: number format: int64 description: Slot number slotActivated: type: boolean description: Is Slot activated iccid: type: string description: Integrated Circuit Card Identifier imsi: type: string description: International Mobile Subscriber Identity state: type: string description: Current state of the SIM card description: SIMCard describes a SIM slot title: SIMCard describes a SIM slot PNACSupplicantState: type: string enum: - PNAC_SUPPLICANT_STATE_UNSPECIFIED - PNAC_SUPPLICANT_STATE_DISCONNECTED - PNAC_SUPPLICANT_STATE_CONNECTING - PNAC_SUPPLICANT_STATE_AUTHENTICATING - PNAC_SUPPLICANT_STATE_AUTHENTICATED - PNAC_SUPPLICANT_STATE_FAILED - PNAC_SUPPLICANT_STATE_HELD default: PNAC_SUPPLICANT_STATE_UNSPECIFIED description: |- PNACSupplicantState describes the 802.1X supplicant state for PNAC. - PNAC_SUPPLICANT_STATE_DISCONNECTED: Supplicant is idle or link is down; no authentication in progress. - PNAC_SUPPLICANT_STATE_CONNECTING: Link is up and the supplicant is initiating authentication. - PNAC_SUPPLICANT_STATE_AUTHENTICATING: Active EAP authentication exchange is in progress. - PNAC_SUPPLICANT_STATE_AUTHENTICATED: Authentication completed successfully; port is authorized. - PNAC_SUPPLICANT_STATE_FAILED: Authentication failed and access was not granted. - PNAC_SUPPLICANT_STATE_HELD: Supplicant is in a held or backoff state following repeated failures. commonNetworkConfigOrigin: type: string enum: - NETWORK_CONFIG_ORIGIN_UNSPECIFIED - NETWORK_CONFIG_ORIGIN_CONTROLLER - NETWORK_CONFIG_ORIGIN_BOOTSTRAP - NETWORK_CONFIG_ORIGIN_OVERRIDE - NETWORK_CONFIG_ORIGIN_LASTRESORT - NETWORK_CONFIG_ORIGIN_TUI - NETWORK_CONFIG_ORIGIN_LOC - NETWORK_CONFIG_ORIGIN_LPS default: NETWORK_CONFIG_ORIGIN_UNSPECIFIED description: >- NetworkConfigOrigin enumerates all possible origins of a network port configuration. - NETWORK_CONFIG_ORIGIN_UNSPECIFIED: Unknown or unset origin. - NETWORK_CONFIG_ORIGIN_CONTROLLER: Config received from the controller. - NETWORK_CONFIG_ORIGIN_BOOTSTRAP: Initial device config embedded in the EVE installer, signed by the controller. - NETWORK_CONFIG_ORIGIN_OVERRIDE: Manually created JSON config injected into the installer. - NETWORK_CONFIG_ORIGIN_LASTRESORT: Fallback configuration automatically generated to enable DHCP on all Ethernet ports. Used when no network config is available or when "network.fallback.any.eth" is enabled and none of the existing configs provide controller connectivity. - NETWORK_CONFIG_ORIGIN_TUI: Config entered via the terminal UI (TUI). - NETWORK_CONFIG_ORIGIN_LOC: Configuration signed by the controller and delivered through the Local Operator Console (LOC) in an air-gapped environment. - NETWORK_CONFIG_ORIGIN_LPS: Config changes made locally through the Local Profile Server (LPS). AzureDevStatusDetail: type: object properties: oState: type: string aState: type: string connectionStateUpdatedTime: type: string twin: $ref: '#/components/schemas/TwinDetail' lastActivityTime: type: string statusUpdateTime: type: string VCEStatusDetail: type: object properties: vceURL: type: string vceEdgeId: type: integer format: int64 activationState: type: string edgeState: type: string serviceState: type: string haState: type: string haPreviousState: type: string bastionState: type: string created: type: string format: date-time activationKey: type: string activationKeyExpires: type: string format: date-time activationTime: type: string format: date-time serialNumber: type: string lteRegion: type: string alertsEnabled: type: boolean operatorAlertsEnabled: type: boolean edgeStateTime: type: string format: date-time isLive: type: boolean systemUpSince: type: string format: date-time serviceUpSince: type: string format: date-time lastContact: type: string format: date-time haLastContact: type: string format: date-time haSerialNumber: type: string modified: type: string format: date-time isHub: type: boolean statusFetchedAt: type: string format: date-time NetworkProxyProto: type: string enum: - NETWORK_PROXY_PROTO_HTTP - NETWORK_PROXY_PROTO_HTTPS - NETWORK_PROXY_PROTO_SOCKS - NETWORK_PROXY_PROTO_FTP - NETWORK_PROXY_PROTO_OTHER default: NETWORK_PROXY_PROTO_HTTP RadioAccessTechnology: type: string enum: - RADIO_ACCESS_TECHNOLOGY_UNSPECIFIED - RADIO_ACCESS_TECHNOLOGY_GSM - RADIO_ACCESS_TECHNOLOGY_UMTS - RADIO_ACCESS_TECHNOLOGY_LTE - RADIO_ACCESS_TECHNOLOGY_5GNR default: RADIO_ACCESS_TECHNOLOGY_UNSPECIFIED description: |2- - RADIO_ACCESS_TECHNOLOGY_GSM: Global System for Mobile Communications (2G). - RADIO_ACCESS_TECHNOLOGY_UMTS: Universal Mobile Telecommunications System (3G). - RADIO_ACCESS_TECHNOLOGY_LTE: Long Term Evolution (4G). - RADIO_ACCESS_TECHNOLOGY_5GNR: 5G New Radio. ZCellularOperatingState: type: string enum: - Z_CELLULAR_OPERATING_STATE_UNSPECIFIED - Z_CELLULAR_OPERATING_STATE_OFFLINE - Z_CELLULAR_OPERATING_STATE_RADIO_OFF - Z_CELLULAR_OPERATING_STATE_ONLINE - Z_CELLULAR_OPERATING_STATE_ONLINE_AND_CONNECTED - Z_CELLULAR_OPERATING_STATE_UNRECOGNIZED default: Z_CELLULAR_OPERATING_STATE_UNSPECIFIED ZCellularControlProtocol: type: string enum: - Z_CELLULAR_CONTROL_PROTOCOL_UNSPECIFIED - Z_CELLULAR_CONTROL_PROTOCOL_QMI - Z_CELLULAR_CONTROL_PROTOCOL_MBIM default: Z_CELLULAR_CONTROL_PROTOCOL_UNSPECIFIED TwinDetail: type: object properties: authenticationType: type: string cloudToDeviceMessageCount: type: integer format: int64 reported: type: string format: byte desired: type: string format: byte moduleCount: type: integer format: int64 lastDesiredStatus: type: string format: byte tags: type: string format: byte statusCode: type: integer format: int32 description: type: string securitySchemes: BearerToken: type: http description: Bearer token for user session scheme: bearer ````