Instance Templates
List instance templates
⚠️ This endpoint is in public preview.
List all instance templates.
get/preview/v2/instance_templates
Query parameters
workspacestring required
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
Filter by workspace.
idSfcApiResourcePathOrIdInstanceTemplateId[]
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.
includeSfcApiInstanceTemplateInclude[]
Additional fields to include in the response.
Response
Paginated list of instance templates.
Example response
{
"object": "list",
"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",
"name": "my-resource-name",
"object": "instance_template",
"image": {
"id": "image_k3R-nX9vLm7Qp2Yw5Jd8F",
"name": "my-resource-name"
},
"created_at": 1738972800,
"cloud_init_user_data": "IyEvYmluL2Jhc2gKZWNobyBoZWxsbyB3b3JsZAo="
}
]
}