Versions

Get a specific zone package version

API Reference

Zones

Packages

Versions

Get a specific zone package version

zones.packages.versions.retrieve(, ) -> PackageVersion

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

Get a specific zone package version

ParametersExpand Collapse

zone_id: str

package_id: str

minLength1

maxLength70

version_id: str

x_client_request_id: Optional[str]

formatuuid

ReturnsExpand Collapse

class PackageVersion: …

id: str

created_at: datetime

formatdate-time

manifest_sha: str

name: str

owner_type: Literal["platform", "customer"]

Accepts one of the following:

"platform"

"customer"

version: int

formatint32

archived_at: Optional[datetime]

formatdate-time

created_by: Optional[str]

description: Optional[str]

icon_url: Optional[str]

inputs: Optional[PackageInputBinding]

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: Optional[str]

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: Optional[Schema]

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).

additional_properties: Optional[object]

Schema for properties not named in properties.

const: Optional[object]

Constant allowed value.

default: Optional[object]

Default value (annotation).

description: Optional[str]

Human-readable description (annotation).

enum: Optional[List[object]]

Enumerated allowed values.

format: Optional[str]

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

items: Optional[object]

Schema for array items.

maximum: Optional[float]

max_items: Optional[int]

max_length: Optional[int]

minimum: Optional[float]

min_items: Optional[int]

min_length: Optional[int]

pattern: Optional[str]

properties: Optional[object]

Property schemas, keyed by property name.

read_only: Optional[bool]

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

required: Optional[List[str]]

Names of required properties.

title: Optional[str]

Human-readable title (annotation).

type: Optional[Literal["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"

write_only: Optional[bool]

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

links: Optional[List[Link]]

href: str

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: str

Link relation type.

properties: Optional[Dict[str, object]]

Additional metadata keyed by property name.

titles: Optional[Dict[str, str]]

Human-readable titles keyed by BCP 47 language tag.

type: Optional[str]

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: Optional[PackageOutputBinding]

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: str

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

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).

additional_properties: Optional[object]

Schema for properties not named in properties.

const: Optional[object]

Constant allowed value.

default: Optional[object]

Default value (annotation).

description: Optional[str]

Human-readable description (annotation).

enum: Optional[List[object]]

Enumerated allowed values.

format: Optional[str]

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

items: Optional[object]

Schema for array items.

maximum: Optional[float]

max_items: Optional[int]

max_length: Optional[int]

minimum: Optional[float]

min_items: Optional[int]

min_length: Optional[int]

pattern: Optional[str]

properties: Optional[object]

Property schemas, keyed by property name.

read_only: Optional[bool]

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

required: Optional[List[str]]

Names of required properties.

title: Optional[str]

Human-readable title (annotation).

type: Optional[Literal["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"

write_only: Optional[bool]

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

properties: Optional[Dict[str, object]]

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: Optional[List[str]]

Get a specific zone package version

from keycardai_api import KeycardAPI

client = KeycardAPI()
package_version = client.zones.packages.versions.retrieve(
    version_id="version_id",
    zone_id="zone_id",
    package_id="lkfwmkifjr:4mtu9913w4",
)
print(package_version.id)

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

Returns Examples

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