Skip to content
Docs

Versions

API Reference
Zones
Packages

Versions

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

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]]
class PackageVersionList: …
items: List[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.

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]]