Get edge application instance (GET /v1/apps/instances/id/{id})

Get edge application instance

curl --request GET \
  --url https://{apiHost}/api/v1/apps/instances/id/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{apiHost}/api/v1/apps/instances/id/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "name": "<string>",
  "title": "<string>",
  "projectId": "<string>",
  "appId": "<string>",
  "deviceId": "<string>",
  "activate": true,
  "id": "<string>",
  "description": "<string>",
  "revision": {
    "curr": "<string>",
    "createdAt": {},
    "createdBy": "<string>",
    "updatedAt": {},
    "updatedBy": "<string>",
    "prev": "<string>"
  },
  "tags": {},
  "clusterID": "<string>",
  "vminfo": {
    "cpus": 123,
    "memory": 123,
    "mode": "HV_PV",
    "vnc": true,
    "vncDisplay": 123,
    "cpuPinningEnabled": true,
    "vmmMaxmem": 123,
    "bootloaderMode": "VM_BOOTLOADER_MODE_UNSPECIFIED",
    "enableOemWinLicenseKey": true,
    "disableVTPM": true
  },
  "drives": [
    {
      "imagename": "<string>",
      "maxsize": 123,
      "readonly": true,
      "preserve": true,
      "drvtype": "<string>",
      "target": "<string>",
      "volumelabel": "<string>",
      "mvolname": "<string>",
      "imvolname": "<string>",
      "ignorepurge": true,
      "cleartext": true,
      "mountpath": "<string>",
      "runtimeInternal": true
    }
  ],
  "interfaces": [
    {
      "intfname": "<string>",
      "netname": "<string>",
      "io": {
        "type": "IO_TYPE_UNSPECIFIED",
        "name": "<string>",
        "tags": {}
      },
      "intforder": 123,
      "directattach": true,
      "privateip": true,
      "acls": [
        {
          "matches": [
            {
              "type": "<string>",
              "value": "<string>"
            }
          ],
          "actions": [
            {
              "drop": true,
              "limit": true,
              "limitrate": 123,
              "limitunit": "<string>",
              "limitburst": 123,
              "portmap": true,
              "mapparams": {
                "port": 123
              }
            }
          ],
          "id": 123,
          "name": "<string>"
        }
      ],
      "ipaddr": "<string>",
      "macaddr": "<string>",
      "accessVlanId": 2047.5,
      "eidregister": {
        "AppCert": "aSDinaTvuI8gbWludGxpZnk=",
        "AppPublicKey": "aSDinaTvuI8gbWludGxpZnk=",
        "AppPrivateKey": "aSDinaTvuI8gbWludGxpZnk=",
        "UUID": "<string>",
        "DisplayName": "<string>",
        "LispInstance": 123,
        "EID": "<string>",
        "EIDHashLen": 123,
        "LispSignature": "<string>",
        "LispMapServers": [
          {
            "nameOrIp": "<string>",
            "credential": "<string>"
          }
        ]
      },
      "netinstname": "<string>",
      "netinsttag": {},
      "netinstid": "<string>",
      "defaultNetInstance": true,
      "allowToDiscover": true
    }
  ],
  "userData": "<string>",
  "customConfig": {
    "name": "<string>",
    "add": true,
    "override": true,
    "allowStorageResize": true,
    "fieldDelimiter": "<string>",
    "template": "<string>",
    "variableGroups": [
      {
        "name": "<string>",
        "variables": [
          {
            "format": "VARIABLE_FORMAT_TEXT",
            "name": "username",
            "label": "Enter User Name",
            "required": "True"
          }
        ],
        "required": true,
        "condition": {
          "name": "<string>",
          "value": "<string>",
          "operator": "CONDITION_OPERATOR_UNSPECIFIED"
        }
      }
    ]
  },
  "collectStatsIPAddr": "<string>",
  "bundleversion": "<string>",
  "logs": {
    "access": true
  },
  "restart": {
    "counter": 123,
    "opsTime": {}
  },
  "refresh": {
    "counter": 123,
    "opsTime": {}
  },
  "purge": {
    "counter": 123,
    "opsTime": {}
  },
  "remoteConsole": true,
  "encryptedSecrets": {},
  "cryptoKey": "<string>",
  "manifestInfo": {
    "bundleVersion": "<string>",
    "nextBundleVersion": "<string>",
    "transitionAction": "INSTANCE_TA_UNSPECIFIED",
    "params": {},
    "details": {
      "cause": "TRANS_CAUSE_UNSPECIFIED",
      "severity": "<string>",
      "scope": {
        "type": "OBJECT_TYPE_UNSPECIFIED",
        "id": "<string>"
      }
    },
    "enablevnc": true
  },
  "appType": "APP_TYPE_UNSPECIFIED",
  "isSecretUpdated": true,
  "appPolicyId": "<string>",
  "deploymentType": "DEPLOYMENT_TYPE_UNSPECIFIED",
  "userDefinedVersion": "<string>",
  "startDelayInSeconds": 123,
  "cloudInitVersion": 123,
  "allowSnapshots": true,
  "maxSnapshots": 123,
  "availableSnapshots": [
    {
      "name": "<string>",
      "id": "<string>",
      "state": "INVALID",
      "config": {},
      "activate": true,
      "immediate": true
    }
  ],
  "patchEnvelopeId": "<string>",
  "patchEnvelopeName": "<string>",
  "edgeNodeCluster": {
    "id": "<string>",
    "designatedNodeID": "<string>",
    "name": "<string>",
    "enableAppPinning": true
  },
  "dockerComposeYamlText": "<string>",
  "dockerComposeTarImageName": "<string>",
  "datastoreIdList": [
    "<string>"
  ],
  "PersistentRuntimeSizeBytes": "<string>"
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "typeUrl": "<string>",
      "value": "aSDinaTvuI8gbWludGxpZnk="
    }
  ]
}

Authentication · API availability · Download OpenAPI

Authorizations

Authorization

string

header

required

Bearer token for user session

Headers

X-Request-Id

string

User-Agent specified id to track a request

Path Parameters

string

required

System defined universally unique Id of the app instance

Response

A successful response.

App Instance detail

name

string

required

User defined name of the app instance, unique across the enterprise. Once app instance is created, name can’t be changed

Required string length: 3 - 256

Pattern: [a-zA-Z0-9][a-zA-Z0-9_.-]+

title

string

required

User defined title of the app instance. Title can be changed at any time

Required string length: 3 - 256

Pattern: ^[a-zA-Z0-9]+[a-zA-Z0-9!-~ ]+$

projectId

string

required

project name which the given app instance belong to

appId

string

required

User defined name of the edge app, unique across the enterprise. Once app name is created, name can’t be changed

Required string length: 3 - 256

Pattern: [a-zA-Z0-9][a-zA-Z0-9_.-]+

deviceId

string

required

User defined name of the device name, unique across the enterprise. Once device name is defined, name can’t be changed

Required string length: 3 - 256

Pattern: [a-zA-Z0-9][a-zA-Z0-9_.-]+

activate

boolean

required

app instance activation flag

string

read-only

System defined universally unique Id of the app instance

Pattern: [0-9A-Za-z-]+

description

string

Detailed description of the app instance

Maximum string length: 256

revision

ObjectRevision is used to store the user information. · object

app instance object revision details

Show child attributes

tags

object

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.

Show child attributes

clusterID

string

System defined universally unique clusterInstance ID, unique across the enterprise.

Required string length: 3 - 256

Pattern: [a-zA-Z0-9][a-zA-Z0-9_.-]+

vminfo

vm detail · object

virtual machine info

Show child attributes

drives

Drive details · object[]

drive details

Show child attributes

interfaces

App Interface detail · object[]

application interfaces

Show child attributes

userData

string

Deprecated: Application initiazation script in cloud-config format to be used by cloud-init

customConfig

object

Application initialization script template in cloud-config format and user specified values

Show child attributes

collectStatsIPAddr

string

holds the static Ip of the app instance

bundleversion

string

version of bundle app is referring to

logs

App Instance Logs configuration · object

App Instance logs

Show child attributes

restart

Zed cloud Operation command · object

Restart counter: ZedCloudOpsCmd

Show child attributes

refresh

Zed cloud Operation command · object

Refresh counter: ZedCloudOpsCmd

Show child attributes

purge

Zed cloud Operation command · object

Purge counter: ZedCloudOpsCmd

Show child attributes

remoteConsole

boolean

Remote console flag

encryptedSecrets

object

user encrypted secrets map

Show child attributes

cryptoKey

string

Crypto Key for decrypting user secret information

manifestInfo

Transition action information · object

app manifest Info

Show child attributes

appType

enum<string>

default:APP_TYPE_UNSPECIFIED

type of bundle

Available options:

APP_TYPE_UNSPECIFIED,

APP_TYPE_VM,

APP_TYPE_VM_RUNTIME,

APP_TYPE_CONTAINER,

APP_TYPE_MODULE,

APP_TYPE_DOCKER_COMPOSE

isSecretUpdated

boolean

This field tells whether user secrets has updated or not, especially the cusotom config

appPolicyId

string

app policy id

deploymentType

enum<string>

default:DEPLOYMENT_TYPE_UNSPECIFIED

type of deployment for the app, eg: azure, k3s, standalone

Available options:

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

userDefinedVersion

string

Instance version tells which edge app does this instance is running

startDelayInSeconds

integer<int64>

start delay is the time in seconds EVE should wait after boot before starting the application instance

cloudInitVersion

integer<int64>

Cloud-init version that indicates whether it necessary or not for cloud-init tool to restart in a guest

allowSnapshots

boolean

Flag to determine if a snapshot creation is allowed

maxSnapshots

integer<int64>

Maximum number of snapshots allowed to be created

availableSnapshots

App instance snapshot · object[]

The list of available snapshots of the application instance

Show child attributes

patchEnvelopeId

string

patch envelope id

patchEnvelopeName

string

patch envelope name

edgeNodeCluster

object

edge node cluster

Show child attributes

dockerComposeYamlText

string

read-only

Docker compose base64 encoded plain text

dockerComposeTarImageName

string

read-only

Docker compose tar image name

datastoreIdList

string[]

read-only

List of datastore ids containing private registry credentials

PersistentRuntimeSizeBytes

string<uint64>

Persistent runtime size in bytes

⌘I

Get edge application instance

curl --request GET \
  --url https://{apiHost}/api/v1/apps/instances/id/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{apiHost}/api/v1/apps/instances/id/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "name": "<string>",
  "title": "<string>",
  "projectId": "<string>",
  "appId": "<string>",
  "deviceId": "<string>",
  "activate": true,
  "id": "<string>",
  "description": "<string>",
  "revision": {
    "curr": "<string>",
    "createdAt": {},
    "createdBy": "<string>",
    "updatedAt": {},
    "updatedBy": "<string>",
    "prev": "<string>"
  },
  "tags": {},
  "clusterID": "<string>",
  "vminfo": {
    "cpus": 123,
    "memory": 123,
    "mode": "HV_PV",
    "vnc": true,
    "vncDisplay": 123,
    "cpuPinningEnabled": true,
    "vmmMaxmem": 123,
    "bootloaderMode": "VM_BOOTLOADER_MODE_UNSPECIFIED",
    "enableOemWinLicenseKey": true,
    "disableVTPM": true
  },
  "drives": [
    {
      "imagename": "<string>",
      "maxsize": 123,
      "readonly": true,
      "preserve": true,
      "drvtype": "<string>",
      "target": "<string>",
      "volumelabel": "<string>",
      "mvolname": "<string>",
      "imvolname": "<string>",
      "ignorepurge": true,
      "cleartext": true,
      "mountpath": "<string>",
      "runtimeInternal": true
    }
  ],
  "interfaces": [
    {
      "intfname": "<string>",
      "netname": "<string>",
      "io": {
        "type": "IO_TYPE_UNSPECIFIED",
        "name": "<string>",
        "tags": {}
      },
      "intforder": 123,
      "directattach": true,
      "privateip": true,
      "acls": [
        {
          "matches": [
            {
              "type": "<string>",
              "value": "<string>"
            }
          ],
          "actions": [
            {
              "drop": true,
              "limit": true,
              "limitrate": 123,
              "limitunit": "<string>",
              "limitburst": 123,
              "portmap": true,
              "mapparams": {
                "port": 123
              }
            }
          ],
          "id": 123,
          "name": "<string>"
        }
      ],
      "ipaddr": "<string>",
      "macaddr": "<string>",
      "accessVlanId": 2047.5,
      "eidregister": {
        "AppCert": "aSDinaTvuI8gbWludGxpZnk=",
        "AppPublicKey": "aSDinaTvuI8gbWludGxpZnk=",
        "AppPrivateKey": "aSDinaTvuI8gbWludGxpZnk=",
        "UUID": "<string>",
        "DisplayName": "<string>",
        "LispInstance": 123,
        "EID": "<string>",
        "EIDHashLen": 123,
        "LispSignature": "<string>",
        "LispMapServers": [
          {
            "nameOrIp": "<string>",
            "credential": "<string>"
          }
        ]
      },
      "netinstname": "<string>",
      "netinsttag": {},
      "netinstid": "<string>",
      "defaultNetInstance": true,
      "allowToDiscover": true
    }
  ],
  "userData": "<string>",
  "customConfig": {
    "name": "<string>",
    "add": true,
    "override": true,
    "allowStorageResize": true,
    "fieldDelimiter": "<string>",
    "template": "<string>",
    "variableGroups": [
      {
        "name": "<string>",
        "variables": [
          {
            "format": "VARIABLE_FORMAT_TEXT",
            "name": "username",
            "label": "Enter User Name",
            "required": "True"
          }
        ],
        "required": true,
        "condition": {
          "name": "<string>",
          "value": "<string>",
          "operator": "CONDITION_OPERATOR_UNSPECIFIED"
        }
      }
    ]
  },
  "collectStatsIPAddr": "<string>",
  "bundleversion": "<string>",
  "logs": {
    "access": true
  },
  "restart": {
    "counter": 123,
    "opsTime": {}
  },
  "refresh": {
    "counter": 123,
    "opsTime": {}
  },
  "purge": {
    "counter": 123,
    "opsTime": {}
  },
  "remoteConsole": true,
  "encryptedSecrets": {},
  "cryptoKey": "<string>",
  "manifestInfo": {
    "bundleVersion": "<string>",
    "nextBundleVersion": "<string>",
    "transitionAction": "INSTANCE_TA_UNSPECIFIED",
    "params": {},
    "details": {
      "cause": "TRANS_CAUSE_UNSPECIFIED",
      "severity": "<string>",
      "scope": {
        "type": "OBJECT_TYPE_UNSPECIFIED",
        "id": "<string>"
      }
    },
    "enablevnc": true
  },
  "appType": "APP_TYPE_UNSPECIFIED",
  "isSecretUpdated": true,
  "appPolicyId": "<string>",
  "deploymentType": "DEPLOYMENT_TYPE_UNSPECIFIED",
  "userDefinedVersion": "<string>",
  "startDelayInSeconds": 123,
  "cloudInitVersion": 123,
  "allowSnapshots": true,
  "maxSnapshots": 123,
  "availableSnapshots": [
    {
      "name": "<string>",
      "id": "<string>",
      "state": "INVALID",
      "config": {},
      "activate": true,
      "immediate": true
    }
  ],
  "patchEnvelopeId": "<string>",
  "patchEnvelopeName": "<string>",
  "edgeNodeCluster": {
    "id": "<string>",
    "designatedNodeID": "<string>",
    "name": "<string>",
    "enableAppPinning": true
  },
  "dockerComposeYamlText": "<string>",
  "dockerComposeTarImageName": "<string>",
  "datastoreIdList": [
    "<string>"
  ],
  "PersistentRuntimeSizeBytes": "<string>"
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "operationType": "OPS_TYPE_UNSPECIFIED",
  "operationStatus": "OPS_STATUS_UNSPECIFIED",
  "objectKind": "<string>",
  "objectId": "<string>",
  "objectName": "<string>",
  "objectRevision": "<string>",
  "objectType": "OBJECT_TYPE_UNSPECIFIED",
  "operationTime": "<string>",
  "startTime": "<string>",
  "endTime": "<string>",
  "user": "<string>",
  "httpStatusCode": 123,
  "httpStatusMsg": "<string>",
  "jobId": "<string>",
  "error": [
    {
      "ec": "zMsgErrorNone",
      "location": "<string>",
      "details": "<string>"
    }
  ]
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "typeUrl": "<string>",
      "value": "aSDinaTvuI8gbWludGxpZnk="
    }
  ]
}

API guides

API services

Get edge application instance (GET /v1/apps/instances/id/{id})

Authorizations

Headers

Path Parameters

Response