Instance

Field Name
Data Type
Description

id

string

Primary instance identifier.

Example: INS-1234-1234-0001

extension

The related extension.

version

string

The version of the extension code this instance is running as provided by the instance itself.

Example: version123

meta

extensionMeta

Extension metadata of the instance.

channel

object

A reference to the channel object.

status

string

The status of the extension instance. Allowed values: connecting, running, disconnected, or deleted.

externalId

string

Identifier of the currently running instance. It must be logically unique for a given Extension (excluding Deleted instances).

audit

object

A reference to the audit object.

Channel object

Field
Type
Description

identity

object

Ziti identity

Example response

 {
    "id": "INS-1234-1234-0001",
    "extension": {
      "id": "EXT-6822-9898-4256",
      "href": "/extensions/EXT-6822-9898-4256",
      "name": "Microsoft AI Cloud Partner"
    },
    "status": "Running",
    "meta": {..},
    "channel": { }
    "externalId": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6",
    "audit": {
      "created": { "at": "...", "by": { } },
      "updated": { "at": "...", "by": { } }
   }
 }

Last updated

Was this helpful?