Query edge application images

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

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

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

{
  "terse": {
    "description": "<string>",
    "total": 123,
    "values": {}
  },
  "summaryByImageStatus": {
    "description": "<string>",
    "total": 123,
    "values": {}
  },
  "summaryByImageArch": {
    "description": "<string>",
    "total": 123,
    "values": {}
  },
  "summaryByImageType": {
    "description": "<string>",
    "total": 123,
    "values": {}
  },
  "summaryByImageFormat": {
    "description": "<string>",
    "total": 123,
    "values": {}
  },
  "summaryByOrigin": {
    "description": "<string>",
    "total": 123,
    "values": {}
  },
  "list": [
    {
      "name": "<string>",
      "title": "<string>",
      "imageFormat": "FmtUnknown",
      "imageArch": "UNSPECIFIED",
      "imageType": "IMAGE_TYPE_UNSPECIFIED",
      "datastoreId": "<string>",
      "id": "<string>",
      "description": "<string>",
      "revision": {
        "curr": "<string>",
        "createdAt": {},
        "createdBy": "<string>",
        "updatedAt": {},
        "updatedBy": "<string>",
        "prev": "<string>"
      },
      "imageRelUrl": "<string>",
      "imageSha256": "<string>",
      "imageVersion": "<string>",
      "imageStatus": "IMAGE_STATUS_UNSPECIFIED",
      "imageSizeBytes": "<string>",
      "imageError": "<string>",
      "imageLocal": "<string>",
      "originType": "ORIGIN_UNSPECIFIED",
      "projectAccessList": [
        "<string>"
      ],
      "datastoreIdList": [
        "<string>"
      ],
      "isLTS": true
    }
  ],
  "next": {
    "pageToken": "<string>",
    "orderBy": [
      "<string>"
    ],
    "pageNum": 123,
    "pageSize": 123,
    "totalPages": 123
  }
}

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

Query Parameters

summary

boolean

Only summary of the records required

imageType

enum<string>

default:IMAGE_TYPE_UNSPECIFIED

Image type to ne matched.

IMAGE_TYPE_EVE: Base OS images for edge gateway
IMAGE_TYPE_APPLICATION: Edge application images
IMAGE_TYPE_EVEPRIVATE: Private Base OS images for edge gateway
IMAGE_TYPE_ARTIFACT: Image type to be used for configuration/patch service
IMAGE_TYPE_DOCKER_COMPOSE_TAR: Image type to be used for multi-file docker-compose projects
IMAGE_TYPE_DOCKER_RUNTIME: Image type to be used for Docker Compose runtime bundles
IMAGE_TYPE_ZKS_RUNTIME: Image type to be used for ZKS runtime bundles

Available options:

IMAGE_TYPE_UNSPECIFIED,

IMAGE_TYPE_EVE,

IMAGE_TYPE_APPLICATION,

IMAGE_TYPE_EVEPRIVATE,

IMAGE_TYPE_ARTIFACT,

IMAGE_TYPE_DOCKER_COMPOSE_TAR,

IMAGE_TYPE_DOCKER_RUNTIME,

IMAGE_TYPE_ZKS_RUNTIME

imageStatus

enum<string>

default:IMAGE_STATUS_UNSPECIFIED

Image status to be matched.

IMAGE_STATUS_CREATED: Image metadata is created
IMAGE_STATUS_UPLOADING: Image binary is being uploaded to Datstore
IMAGE_STATUS_READY: Image is ready for download
IMAGE_STATUS_INUSE: Image is being used by edge applications
IMAGE_STATUS_FAILED: Image binary upload has failed
IMAGE_STATUS_UPLINKING: Image metadata is being uplinked with Datstore binary

Available options:

IMAGE_STATUS_UNSPECIFIED,

IMAGE_STATUS_CREATED,

IMAGE_STATUS_PENDING,

IMAGE_STATUS_UPLOADING,

IMAGE_STATUS_READY,

IMAGE_STATUS_INUSE,

IMAGE_STATUS_ARCHIVED,

IMAGE_STATUS_MAX,

IMAGE_STATUS_FAILED,

IMAGE_STATUS_UPLINKING

datastoreId

string

Datastore id to be matched.

imageArch

enum<string>

default:UNSPECIFIED

Image architecture to be matched.

Available options:

UNSPECIFIED,

UNDEFINED,

AMD64,

ARM64

namePattern

string

Image name pattern to be matched.

originType

integer<int32>

origin of image

titlePattern

string

Image title pattern to be matched.

next.pageToken

string

Page Token

next.orderBy

string[]

OrderBy helps in sorting the list response

next.pageNum

number<int64>

Page Number

next.pageSize

number<int64>

Defines the page size

next.totalPages

number<int64>

Total number of pages to be fetched.