Versions

List zone package versions

API Reference

Zones

Packages

Versions

List zone package versions

client.zones.packages.versions.list(, , ?): PackageVersionList { items, pagination }

GET/zones/{zone_id}/packages/{package_id}/versions

List zone package versions

ParametersExpand Collapse

packageID: string

minLength1

maxLength70

params: VersionListParams { zone_id, after, before, 2 more }

zone_id: string

Path param

after?: string

Query param: Cursor for forward pagination. Returned in Pagination.after_cursor. Mutually exclusive with before.

minLength1

maxLength255

before?: string

Query param: Cursor for backward pagination. Returned in Pagination.before_cursor. Mutually exclusive with after.

minLength1

maxLength255

limit?: number

Query param: Maximum number of items to return per page.

minimum1

maximum100

xClientRequestID?: string

Header param: Unique request identifier specified by the originating caller and passed along by proxies.

formatuuid

ReturnsExpand Collapse

PackageVersionList { items, pagination }

items: Array<PackageVersion { id, created_at, manifest_sha, 12 more } >

id: string

created_at: string

formatdate-time

manifest_sha: string

name: string

owner_type: "platform" | "customer"

Accepts one of the following:

"platform"

"customer"

version: number

formatint32

archived_at?: string | null

formatdate-time

created_by?: string

description?: string

icon_url?: string

inputs?: PackageInputBinding { bindings, schema }

Input binding for a package.

schema constrains install-level inputs. bindings is a CEL expression that assembles the flat input map — static values are CEL literals, install-provided values are pkg.inputs.X references. Evaluated at provisioning time to produce the entities.inputs map for entity bindings.

bindings?: string

CEL expression assembling the flat input map from static values and install-provided values (referenced via pkg.inputs.X).

Scope:

pkg.inputs — install-supplied values conforming to schema.

schema?: Schema { additionalProperties, const, default, 17 more }

A subset of JSON Schema 2020-12 used to describe package input and output shapes.

Supported keywords:

Structural: type, properties, required, items, additionalProperties
Annotations: title, description, default, readOnly, writeOnly
Constraints: pattern, minLength, maxLength, minimum, maximum, minItems, maxItems, enum, const, format

Intentionally unsupported (reject at release time rather than silently ignore):

Schema combinators: allOf, anyOf, oneOf, not
References: $ref, $dynamicRef
patternProperties, propertyNames, unevaluatedProperties
Custom vocabularies and $vocabulary

Dialect: JSON Schema 2020-12 (implied — authors do not include $schema).

additionalProperties?: unknown

Schema for properties not named in properties.

const?: unknown

Constant allowed value.

default?: unknown

Default value (annotation).

description?: string

Human-readable description (annotation).

enum?: Array<unknown>

Enumerated allowed values.

format?: string

Format hint (e.g., "uri", "uuid", "email", "date-time").

items?: unknown

Schema for array items.

maximum?: number

maxItems?: number

maxLength?: number

minimum?: number

minItems?: number

minLength?: number

pattern?: string

properties?: unknown

Property schemas, keyed by property name.

readOnly?: boolean

Read-only hint — server-populated, ignored on write.

required?: Array<string>

Names of required properties.

title?: string

Human-readable title (annotation).

type?: "object" | "array" | "string" | 4 more

The type keyword in JSON Schema 2020-12.

Accepts one of the following:

"object"

"array"

"string"

"integer"

"number"

"boolean"

"null"

writeOnly?: boolean

Write-only hint (passwords, secrets) — never returned on read.

links?: Array<Link>

href: string

Target reference.

Fragment URIs (#name) reference other entities in the same graph by their local name (the key in the entity map). Absolute paths and URLs reference external resources outside the graph.

rel: string

Link relation type.

properties?: Record<string, unknown>

Additional metadata keyed by property name.

titles?: Record<string, string>

Human-readable titles keyed by BCP 47 language tag.

type?: string

Media type of the target resource (per RFC 7033 section 4.4.4.3). Applies to external hrefs; typically omitted for intra-graph references.

outputs?: PackageOutputBinding { bindings, schema }

Output binding for a package.

schema describes the flat outputs surfaced on an install. bindings is a CEL expression — a map literal whose keys match schema.properties and whose values project fields out of the resolved entity graph. Evaluated after the provisioner has resolved all entities.

bindings: string

CEL expression source. Must evaluate to a map whose fields match schema.properties.

Scope: entities:

entities.inputs — the package's input values (merged with install inputs at provisioning time).
entities.<name> — resolved entities in the graph, each with href: string and outputs: map<string, dyn>.

schema: Schema { additionalProperties, const, default, 17 more }

A subset of JSON Schema 2020-12 used to describe package input and output shapes.

Supported keywords:

Structural: type, properties, required, items, additionalProperties
Annotations: title, description, default, readOnly, writeOnly
Constraints: pattern, minLength, maxLength, minimum, maximum, minItems, maxItems, enum, const, format

Intentionally unsupported (reject at release time rather than silently ignore):

Schema combinators: allOf, anyOf, oneOf, not
References: $ref, $dynamicRef
patternProperties, propertyNames, unevaluatedProperties
Custom vocabularies and $vocabulary

Dialect: JSON Schema 2020-12 (implied — authors do not include $schema).

additionalProperties?: unknown

Schema for properties not named in properties.

const?: unknown

Constant allowed value.

default?: unknown

Default value (annotation).

description?: string

Human-readable description (annotation).

enum?: Array<unknown>

Enumerated allowed values.

format?: string

Format hint (e.g., "uri", "uuid", "email", "date-time").

items?: unknown

Schema for array items.

maximum?: number

maxItems?: number

maxLength?: number

minimum?: number

minItems?: number

minLength?: number

pattern?: string

properties?: unknown

Property schemas, keyed by property name.

readOnly?: boolean

Read-only hint — server-populated, ignored on write.

required?: Array<string>

Names of required properties.

title?: string

Human-readable title (annotation).

type?: "object" | "array" | "string" | 4 more

The type keyword in JSON Schema 2020-12.

Accepts one of the following:

"object"

"array"

"string"

"integer"

"number"

"boolean"

"null"

writeOnly?: boolean

Write-only hint (passwords, secrets) — never returned on read.

properties?: Record<string, unknown>

Vocabulary-defined metadata properties, keyed by property URN.

Known properties are declared with their schemas; additional properties with custom URNs are permitted via Record<unknown>.

Each property carries x-subject-types indicating which entity types it applies to. Properties with draft/ in the URN are experimental and carry x-internal: true.

tags?: Array<string>

pagination: Pagination { after_cursor, before_cursor, total_count }

Cursor-based pagination metadata returned alongside a list of results

after_cursor: string | null

An opaque cursor used for paginating through a list of results

minLength1

maxLength255

before_cursor: string | null

An opaque cursor used for paginating through a list of results

minLength1

maxLength255

total_count?: number

Total number of items across all pages. Only present when the request includes ?expand[]=total_count.

List zone package versions

import KeycardAPI from '@keycardai/api';

const client = new KeycardAPI();

const packageVersionList = await client.zones.packages.versions.list('lkfwmkifjr:4mtu9913w4', {
  zone_id: 'zone_id',
});

console.log(packageVersionList.items);

{
  "items": [
    {
      "id": "id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "manifest_sha": "manifest_sha",
      "name": "name",
      "owner_type": "platform",
      "version": 0,
      "archived_at": "2019-12-27T18:11:19.117Z",
      "created_by": "created_by",
      "description": "description",
      "icon_url": "icon_url",
      "inputs": {
        "bindings": "bindings",
        "schema": {
          "additionalProperties": {},
          "const": {},
          "default": {},
          "description": "description",
          "enum": [
            {}
          ],
          "format": "format",
          "items": {},
          "maximum": 0,
          "maxItems": 0,
          "maxLength": 0,
          "minimum": 0,
          "minItems": 0,
          "minLength": 0,
          "pattern": "pattern",
          "properties": {},
          "readOnly": true,
          "required": [
            "string"
          ],
          "title": "title",
          "type": "object",
          "writeOnly": true
        }
      },
      "links": [
        {
          "href": "href",
          "rel": "rel",
          "properties": {
            "foo": "bar"
          },
          "titles": {
            "foo": "string"
          },
          "type": "type"
        }
      ],
      "outputs": {
        "bindings": "bindings",
        "schema": {
          "additionalProperties": {},
          "const": {},
          "default": {},
          "description": "description",
          "enum": [
            {}
          ],
          "format": "format",
          "items": {},
          "maximum": 0,
          "maxItems": 0,
          "maxLength": 0,
          "minimum": 0,
          "minItems": 0,
          "minLength": 0,
          "pattern": "pattern",
          "properties": {},
          "readOnly": true,
          "required": [
            "string"
          ],
          "title": "title",
          "type": "object",
          "writeOnly": true
        }
      },
      "properties": {
        "foo": "bar"
      },
      "tags": [
        "string"
      ]
    }
  ],
  "pagination": {
    "after_cursor": "x",
    "before_cursor": "x",
    "total_count": 0
  }
}

Returns Examples

{
  "items": [
    {
      "id": "id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "manifest_sha": "manifest_sha",
      "name": "name",
      "owner_type": "platform",
      "version": 0,
      "archived_at": "2019-12-27T18:11:19.117Z",
      "created_by": "created_by",
      "description": "description",
      "icon_url": "icon_url",
      "inputs": {
        "bindings": "bindings",
        "schema": {
          "additionalProperties": {},
          "const": {},
          "default": {},
          "description": "description",
          "enum": [
            {}
          ],
          "format": "format",
          "items": {},
          "maximum": 0,
          "maxItems": 0,
          "maxLength": 0,
          "minimum": 0,
          "minItems": 0,
          "minLength": 0,
          "pattern": "pattern",
          "properties": {},
          "readOnly": true,
          "required": [
            "string"
          ],
          "title": "title",
          "type": "object",
          "writeOnly": true
        }
      },
      "links": [
        {
          "href": "href",
          "rel": "rel",
          "properties": {
            "foo": "bar"
          },
          "titles": {
            "foo": "string"
          },
          "type": "type"
        }
      ],
      "outputs": {
        "bindings": "bindings",
        "schema": {
          "additionalProperties": {},
          "const": {},
          "default": {},
          "description": "description",
          "enum": [
            {}
          ],
          "format": "format",
          "items": {},
          "maximum": 0,
          "maxItems": 0,
          "maxLength": 0,
          "minimum": 0,
          "minItems": 0,
          "minLength": 0,
          "pattern": "pattern",
          "properties": {},
          "readOnly": true,
          "required": [
            "string"
          ],
          "title": "title",
          "type": "object",
          "writeOnly": true
        }
      },
      "properties": {
        "foo": "bar"
      },
      "tags": [
        "string"
      ]
    }
  ],
  "pagination": {
    "after_cursor": "x",
    "before_cursor": "x",
    "total_count": 0
  }
}