Skip to content
Docs

Versions

Versions

List zone package versions
GET/zones/{zone_id}/packages/{package_id}/versions
Get a specific zone package version
GET/zones/{zone_id}/packages/{package_id}/versions/{version_id}
ModelsExpand Collapse
PackageVersion = object { id, created_at, manifest_sha, 12 more }
id: string
created_at: string
formatdate-time
manifest_sha: string
name: string
owner_type: "platform" or "customer"
Accepts one of the following:
"platform"
"customer"
version: number
formatint32
archived_at: optional string
formatdate-time
created_by: optional string
description: optional string
icon_url: optional string
inputs: optional 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: optional 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: optional object { 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: optional unknown

Schema for properties not named in properties.

const: optional unknown

Constant allowed value.

default: optional unknown

Default value (annotation).

description: optional string

Human-readable description (annotation).

enum: optional array of unknown

Enumerated allowed values.

format: optional string

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

items: optional unknown

Schema for array items.

maximum: optional number
maxItems: optional number
maxLength: optional number
minimum: optional number
minItems: optional number
minLength: optional number
pattern: optional string
properties: optional unknown

Property schemas, keyed by property name.

readOnly: optional boolean

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

required: optional array of string

Names of required properties.

title: optional string

Human-readable title (annotation).

type: optional "object" or "array" or "string" or 4 more

The type keyword in JSON Schema 2020-12.

Accepts one of the following:
"object"
"array"
"string"
"integer"
"number"
"boolean"
"null"
writeOnly: optional boolean

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

outputs: optional 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: object { 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: optional unknown

Schema for properties not named in properties.

const: optional unknown

Constant allowed value.

default: optional unknown

Default value (annotation).

description: optional string

Human-readable description (annotation).

enum: optional array of unknown

Enumerated allowed values.

format: optional string

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

items: optional unknown

Schema for array items.

maximum: optional number
maxItems: optional number
maxLength: optional number
minimum: optional number
minItems: optional number
minLength: optional number
pattern: optional string
properties: optional unknown

Property schemas, keyed by property name.

readOnly: optional boolean

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

required: optional array of string

Names of required properties.

title: optional string

Human-readable title (annotation).

type: optional "object" or "array" or "string" or 4 more

The type keyword in JSON Schema 2020-12.

Accepts one of the following:
"object"
"array"
"string"
"integer"
"number"
"boolean"
"null"
writeOnly: optional boolean

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

properties: optional map[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: optional array of string
PackageVersionList = object { items, pagination }
items: array of PackageVersion { id, created_at, manifest_sha, 12 more }
id: string
created_at: string
formatdate-time
manifest_sha: string
name: string
owner_type: "platform" or "customer"
Accepts one of the following:
"platform"
"customer"
version: number
formatint32
archived_at: optional string
formatdate-time
created_by: optional string
description: optional string
icon_url: optional string
inputs: optional 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: optional 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: optional object { 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: optional unknown

Schema for properties not named in properties.

const: optional unknown

Constant allowed value.

default: optional unknown

Default value (annotation).

description: optional string

Human-readable description (annotation).

enum: optional array of unknown

Enumerated allowed values.

format: optional string

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

items: optional unknown

Schema for array items.

maximum: optional number
maxItems: optional number
maxLength: optional number
minimum: optional number
minItems: optional number
minLength: optional number
pattern: optional string
properties: optional unknown

Property schemas, keyed by property name.

readOnly: optional boolean

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

required: optional array of string

Names of required properties.

title: optional string

Human-readable title (annotation).

type: optional "object" or "array" or "string" or 4 more

The type keyword in JSON Schema 2020-12.

Accepts one of the following:
"object"
"array"
"string"
"integer"
"number"
"boolean"
"null"
writeOnly: optional boolean

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

outputs: optional 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: object { 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: optional unknown

Schema for properties not named in properties.

const: optional unknown

Constant allowed value.

default: optional unknown

Default value (annotation).

description: optional string

Human-readable description (annotation).

enum: optional array of unknown

Enumerated allowed values.

format: optional string

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

items: optional unknown

Schema for array items.

maximum: optional number
maxItems: optional number
maxLength: optional number
minimum: optional number
minItems: optional number
minLength: optional number
pattern: optional string
properties: optional unknown

Property schemas, keyed by property name.

readOnly: optional boolean

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

required: optional array of string

Names of required properties.

title: optional string

Human-readable title (annotation).

type: optional "object" or "array" or "string" or 4 more

The type keyword in JSON Schema 2020-12.

Accepts one of the following:
"object"
"array"
"string"
"integer"
"number"
"boolean"
"null"
writeOnly: optional boolean

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

properties: optional map[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: optional array of string