Installs

API Reference

Zones

Installs

Create an install of a package

client.zones.installs.create(, , ?): Task { id, created_at, operation, 9 more }

POST/zones/{zone_id}/installs

List installs in a zone

client.zones.installs.list(, ?, ?): InstallList { items, pagination }

GET/zones/{zone_id}/installs

Get a specific zone install

client.zones.installs.retrieve(, , ?): Install { id, created_at, package_id, 9 more }

GET/zones/{zone_id}/installs/{install_id}

Delete a zone install

client.zones.installs.delete(, , ?): Task { id, created_at, operation, 9 more }

DELETE/zones/{zone_id}/installs/{install_id}

ModelsExpand Collapse

Install { id, created_at, package_id, 9 more }

id: string

created_at: string

formatdate-time

package_id: string

package_slug: string

status: InstallStatus

Accepts one of the following:

"pending"

"active"

"deleting"

"failed"

"deleted"

updated_at: string

formatdate-time

inputs?: Record<string, unknown>

Install-specific input values that supplement the package's inputs. Merged with the package's input values to form the complete entities.inputs for entity binding evaluation.

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.

org_id?: string

outputs?: Record<string, unknown>

Resolved output values produced by the provisioner, conforming to the package's Package.outputs.schema. Flat — the provisioner evaluates Package.outputs.bindings against the resolved entity graph.

package_version?: number

zone_id?: string

InstallList { items, pagination }

items: Array<Install { id, created_at, package_id, 9 more } >

id: string

created_at: string

formatdate-time

package_id: string

package_slug: string

status: InstallStatus

Accepts one of the following:

"pending"

"active"

"deleting"

"failed"

"deleted"

updated_at: string

formatdate-time

inputs?: Record<string, unknown>

Install-specific input values that supplement the package's inputs. Merged with the package's input values to form the complete entities.inputs for entity binding evaluation.

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.

org_id?: string

outputs?: Record<string, unknown>

package_version?: number

zone_id?: 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.

InstallStatus = "pending" | "active" | "deleting" | 2 more

Accepts one of the following:

"pending"

"active"

"deleting"

"failed"

"deleted"