v1

latestOpenAPI 3.1.02026-07-2665179189.7 KB

Instance Templates

List instance templates

⚠️ This endpoint is in public preview.

List all instance templates.

get/preview/v2/instance_templates

Query parameters

workspacestring

A resource path like 'sfc:workspace:acme:my-workspace' or an ID. Resource paths are human-readable but not stable - they change when resources are renamed or moved. IDs are stable and permanent.

Example:wksp_k3R-nX9vLm7Qp2Yw5Jd8F

Scope the returned list to a single workspace (ID, resource path, or name). Without it, the returned list spans every workspace where the caller has InstanceTemplate:List and InstanceTemplate:Read (granted at either the workspace or organization level).

idResourcePathOrIdInstanceTemplateId[]

Filter by instance template ID or name (repeatable).

[
  "itmpl_k3R-nX9vLm7Qp2Yw5Jd8F"
]

limitinteger

starting_afterstring

Example:itmplc_gqXR7s0Kj5mHvE2wNpLc4Q

Set to the response's cursor to fetch the next page.

ending_beforestring

Example:itmplc_gqXR7s0Kj5mHvE2wNpLc4Q

Set to the response's cursor to fetch the previous page.

includeInstanceTemplateInclude[]

Additional fields to include in the response.

Response

Paginated list of instance templates.

object'list' required

cursorstring

has_moreboolean required

Example response

{
  "cursor": "itmplc_gqXR7s0Kj5mHvE2wNpLc4Q",
  "data": [
    {
      "id": "itmpl_k3R-nX9vLm7Qp2Yw5Jd8F",
      "resource_path": "sfc:instance_template:<account_id>:<workspace>:<name>",
      "owner": "my-resource-name",
      "workspace": "my-resource-name",
      "workspace_id": "wksp_k3R-nX9vLm7Qp2Yw5Jd8F",
      "name": "my-resource-name",
      "image": {
        "id": "image_k3R-nX9vLm7Qp2Yw5Jd8F",
        "name": "my-resource-name"
      },
      "tags": {
        "env": "prod",
        "team": "infra"
      },
      "created_at": 1738972800,
      "cloud_init_user_data": "IyEvYmluL2Jhc2gKZWNobyBoZWxsbyB3b3JsZAo="
    }
  ]
}