Get edge application bundle (GET /v1/apps/name/{name})

Get edge application bundle

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

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

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

{
  "name": "<string>",
  "title": "<string>",
  "originType": "ORIGIN_UNSPECIFIED",
  "id": "<string>",
  "description": "<string>",
  "revision": {
    "curr": "<string>",
    "createdAt": {},
    "createdBy": "<string>",
    "updatedAt": {},
    "updatedBy": "<string>",
    "prev": "<string>"
  },
  "networks": 123,
  "drives": 123,
  "cpus": 123,
  "memory": 123,
  "manifestJSON": {
    "acKind": "VMManifest",
    "acVersion": "1.2.0",
    "name": "<string>",
    "displayName": "<string>",
    "description": "<string>",
    "owner": {
      "user": "<string>",
      "group": "<string>",
      "company": "<string>",
      "website": "<string>",
      "email": "<string>"
    },
    "desc": {
      "appCategory": "APP_CATEGORY_CLOUD_APPLICATION",
      "os": "Linux"
    },
    "images": [
      {
        "imagename": "<string>",
        "imageid": "<string>",
        "imageformat": "FmtUnknown",
        "maxsize": "<string>",
        "preserve": true,
        "target": "<string>",
        "drvtype": "<string>",
        "params": [
          {
            "name": "<string>",
            "value": "<string>"
          }
        ],
        "readonly": true,
        "volumelabel": "<string>",
        "ignorepurge": true,
        "cleartext": true,
        "mountpath": "<string>",
        "imagestatus": "<string>",
        "datastore": [
          {
            "id": "<string>",
            "name": "<string>"
          }
        ]
      }
    ],
    "interfaces": [
      {
        "name": "<string>",
        "type": "<string>",
        "optional": true,
        "directattach": true,
        "privateip": true,
        "acls": [
          {
            "matches": [
              {
                "type": "<string>",
                "value": "<string>"
              }
            ],
            "actions": [
              {
                "drop": true,
                "limit": true,
                "limitValue": {
                  "limitrate": 123,
                  "limitunit": "<string>",
                  "limitburst": 123
                },
                "limitrate": 123,
                "limitunit": "<string>",
                "limitburst": 123,
                "portmap": true,
                "portmapto": {
                  "appPort": 123
                }
              }
            ],
            "name": "<string>"
          }
        ]
      }
    ],
    "permissions": [
      {}
    ],
    "vmmode": "HV_HVM",
    "enablevnc": true,
    "resources": [
      {
        "name": "<string>",
        "value": "<string>"
      }
    ],
    "configuration": {
      "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"
            }
          }
        ]
      }
    },
    "containerDetail": {
      "containerCreateOption": "<string>"
    },
    "module": {
      "twinDetail": "IHsKICAgICAgIm5hbWUiOiAiU2VuZEludGVydmFsIiwKICAgICAgInZhbHVlIjogIjUiCiAgICB9"
    },
    "appType": "APP_TYPE_UNSPECIFIED",
    "deploymentType": "DEPLOYMENT_TYPE_UNSPECIFIED",
    "cpuPinningEnabled": true,
    "runtimeVersion": "RuntimeVersion_Unknown",
    "runtimeProtocolVersion": "RuntimeProtocolVersion_Unknown",
    "PersistentRuntimeSizeBytes": "<string>",
    "dockerComposeYamlText": "<string>",
    "dockerComposeTarImageName": "<string>",
    "enableOemWinLicenseKey": true,
    "disableVTPM": true
  },
  "parentDetail": {
    "idOfParentObject": "<string>",
    "versionOfParentObject": 123,
    "updateAvailable": true,
    "referenceExists": true
  },
  "storage": 123,
  "userDefinedVersion": "<string>",
  "projectAccessList": [
    "<string>"
  ],
  "isImported": true,
  "appInstCount": 123,
  "datastoreIdList": [
    "<string>"
  ],
  "tags": {}
}

{
  "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

name

string

required

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

Response

A successful response.

Edge application gets installed/uninstalled to/from edge node(s) and perform specific edge computing tasks. Lifecycle of Edge application (upgrade/restart) on Edge node can be managed and monitored by ZEDEDA Cloud controller through this detailed configuration.

name

string

required

User defined name of the edge application, unique across the enterprise. Once object 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 edge application. Title can be changed at any time

Required string length: 3 - 256

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

originType

enum<string>

default:ORIGIN_UNSPECIFIED

required

origin of object

Available options:

ORIGIN_UNSPECIFIED,

ORIGIN_IMPORTED,

ORIGIN_LOCAL,

ORIGIN_GLOBAL,

ORIGIN_APP_PROFILE_LOCAL

string

read-only

System defined universally unique Id of the edge application

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

description

string

Detailed description of the edge application

Maximum string length: 256

revision

ObjectRevision is used to store the user information. · object

system defined info

Show child attributes

networks

integer<int64>

user defined network options

drives

integer<int64>

read-only

user defined drives

cpus

integer<int64>

user defined cpus for bundle

memory

integer<int64>

user defined memory for bundle

manifestJSON

object

user defined manifest in JSON format

Show child attributes

parentDetail

Object Import Detail · object

origin and parent related details

Show child attributes

storage

integer<int64>

user defined storage for bundle

userDefinedVersion

string

User defined version for the given edge-app

projectAccessList

string[]

project access list of the app bundle

isImported

boolean

Flag to represent where app bundle is already imported

appInstCount

integer<int32>

App instance count

datastoreIdList

string[]

List of datastore ids containing private registry credential

tags

object

User defined tags for the edge application

Show child attributes

⌘I

Get edge application bundle

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

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

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

{
  "name": "<string>",
  "title": "<string>",
  "originType": "ORIGIN_UNSPECIFIED",
  "id": "<string>",
  "description": "<string>",
  "revision": {
    "curr": "<string>",
    "createdAt": {},
    "createdBy": "<string>",
    "updatedAt": {},
    "updatedBy": "<string>",
    "prev": "<string>"
  },
  "networks": 123,
  "drives": 123,
  "cpus": 123,
  "memory": 123,
  "manifestJSON": {
    "acKind": "VMManifest",
    "acVersion": "1.2.0",
    "name": "<string>",
    "displayName": "<string>",
    "description": "<string>",
    "owner": {
      "user": "<string>",
      "group": "<string>",
      "company": "<string>",
      "website": "<string>",
      "email": "<string>"
    },
    "desc": {
      "appCategory": "APP_CATEGORY_CLOUD_APPLICATION",
      "os": "Linux"
    },
    "images": [
      {
        "imagename": "<string>",
        "imageid": "<string>",
        "imageformat": "FmtUnknown",
        "maxsize": "<string>",
        "preserve": true,
        "target": "<string>",
        "drvtype": "<string>",
        "params": [
          {
            "name": "<string>",
            "value": "<string>"
          }
        ],
        "readonly": true,
        "volumelabel": "<string>",
        "ignorepurge": true,
        "cleartext": true,
        "mountpath": "<string>",
        "imagestatus": "<string>",
        "datastore": [
          {
            "id": "<string>",
            "name": "<string>"
          }
        ]
      }
    ],
    "interfaces": [
      {
        "name": "<string>",
        "type": "<string>",
        "optional": true,
        "directattach": true,
        "privateip": true,
        "acls": [
          {
            "matches": [
              {
                "type": "<string>",
                "value": "<string>"
              }
            ],
            "actions": [
              {
                "drop": true,
                "limit": true,
                "limitValue": {
                  "limitrate": 123,
                  "limitunit": "<string>",
                  "limitburst": 123
                },
                "limitrate": 123,
                "limitunit": "<string>",
                "limitburst": 123,
                "portmap": true,
                "portmapto": {
                  "appPort": 123
                }
              }
            ],
            "name": "<string>"
          }
        ]
      }
    ],
    "permissions": [
      {}
    ],
    "vmmode": "HV_HVM",
    "enablevnc": true,
    "resources": [
      {
        "name": "<string>",
        "value": "<string>"
      }
    ],
    "configuration": {
      "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"
            }
          }
        ]
      }
    },
    "containerDetail": {
      "containerCreateOption": "<string>"
    },
    "module": {
      "twinDetail": "IHsKICAgICAgIm5hbWUiOiAiU2VuZEludGVydmFsIiwKICAgICAgInZhbHVlIjogIjUiCiAgICB9"
    },
    "appType": "APP_TYPE_UNSPECIFIED",
    "deploymentType": "DEPLOYMENT_TYPE_UNSPECIFIED",
    "cpuPinningEnabled": true,
    "runtimeVersion": "RuntimeVersion_Unknown",
    "runtimeProtocolVersion": "RuntimeProtocolVersion_Unknown",
    "PersistentRuntimeSizeBytes": "<string>",
    "dockerComposeYamlText": "<string>",
    "dockerComposeTarImageName": "<string>",
    "enableOemWinLicenseKey": true,
    "disableVTPM": true
  },
  "parentDetail": {
    "idOfParentObject": "<string>",
    "versionOfParentObject": 123,
    "updateAvailable": true,
    "referenceExists": true
  },
  "storage": 123,
  "userDefinedVersion": "<string>",
  "projectAccessList": [
    "<string>"
  ],
  "isImported": true,
  "appInstCount": 123,
  "datastoreIdList": [
    "<string>"
  ],
  "tags": {}
}

{
  "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 bundle (GET /v1/apps/name/{name})

Authorizations

Headers

Path Parameters

Response