Installs

Get a specific zone install

API Reference

Zones

Installs

Get a specific zone install

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

Get a specific zone install

Path ParametersExpand Collapse

zone_id: string

install_id: string

maxLength26

Header ParametersExpand Collapse

"X-Client-Request-ID": optional string

formatuuid

ReturnsExpand Collapse

Install = object { 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: optional map[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: optional array of object { href, rel, properties, 2 more }

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: optional map[unknown]

Additional metadata keyed by property name.

titles: optional map[string]

Human-readable titles keyed by BCP 47 language tag.

type: optional 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: optional string

outputs: optional map[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: optional number

zone_id: optional string

Get a specific zone install

curl https://zones/$ZONE_ID/installs/$INSTALL_ID

{
  "id": "id",
  "created_at": "2019-12-27T18:11:19.117Z",
  "package_id": "package_id",
  "package_slug": "package_slug",
  "status": "pending",
  "updated_at": "2019-12-27T18:11:19.117Z",
  "inputs": {
    "client_id": "bar",
    "client_secret": "bar"
  },
  "links": [
    {
      "href": "href",
      "rel": "rel",
      "properties": {
        "foo": "bar"
      },
      "titles": {
        "foo": "string"
      },
      "type": "type"
    }
  ],
  "org_id": "org_id",
  "outputs": {
    "mcp_url": "bar"
  },
  "package_version": 0,
  "zone_id": "zone_id"
}

Returns Examples

{
  "id": "id",
  "created_at": "2019-12-27T18:11:19.117Z",
  "package_id": "package_id",
  "package_slug": "package_slug",
  "status": "pending",
  "updated_at": "2019-12-27T18:11:19.117Z",
  "inputs": {
    "client_id": "bar",
    "client_secret": "bar"
  },
  "links": [
    {
      "href": "href",
      "rel": "rel",
      "properties": {
        "foo": "bar"
      },
      "titles": {
        "foo": "string"
      },
      "type": "type"
    }
  ],
  "org_id": "org_id",
  "outputs": {
    "mcp_url": "bar"
  },
  "package_version": 0,
  "zone_id": "zone_id"
}