Skip to main content
GET
/
preview
/
v2
/
instance_templates
List instance templates
curl --request GET \
  --url https://api.sfcompute.com/preview/v2/instance_templates \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "has_more": true,
  "data": [
    {
      "id": "itmpl_k3R-nX9vLm7Qp2Yw5Jd8F",
      "resource_path": "<string>",
      "owner": "<string>",
      "workspace": "<string>",
      "workspace_id": "<string>",
      "name": "<string>",
      "object": "instance_template",
      "image": {
        "id": "image_k3R-nX9vLm7Qp2Yw5Jd8F",
        "name": "<string>"
      },
      "cloud_init_user_data_used": true,
      "created_at": 1738972800,
      "cloud_init_user_data": "IyEvYmluL2Jhc2gKZWNobyBoZWxsbyB3b3JsZAo="
    }
  ],
  "cursor": "itmplc_gqXR7s0Kj5mHvE2wNpLc4Q"
}

Authorizations

​
Authorization
string
header
required

Create an API token using sf tokens create or at https://sfcompute.com/account/api-keys.

Query Parameters

​
workspace
string
required

Filter by workspace. 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.

Pattern: (wksp_[0-9a-zA-Z_-]{1,21})|(sfc:workspace:[a-zA-Z0-9._-]+(:[a-zA-Z0-9._-]+){1,1})
Example:

"wksp_k3R-nX9vLm7Qp2Yw5Jd8F"

​
id
string[]

Filter by instance template ID or name (repeatable).

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

Pattern: (itmpl_[0-9a-zA-Z_-]{1,21}|ntmpl_[0-9a-zA-Z_-]{1,21})|(sfc:instance_template:[a-zA-Z0-9._-]+(:[a-zA-Z0-9._-]+){2,2})
​
limit
integer<u-int32>
default:50
Required range: 1 <= x <= 50
​
starting_after
string

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

Pattern: ^itmplc_[A-Za-z0-9_-]+$
Example:

"itmplc_gqXR7s0Kj5mHvE2wNpLc4Q"

​
ending_before
string

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

Pattern: ^itmplc_[A-Za-z0-9_-]+$
Example:

"itmplc_gqXR7s0Kj5mHvE2wNpLc4Q"

​
include
string[]

Additional fields to include in the response.

Allowed value: "cloud_init_user_data"

Response

Paginated list of instance templates.

​
object
string
default:list
required
read-only
Allowed value: "list"
​
has_more
boolean
required
​
data
object[]
required
​
cursor
null | string

Pass as starting_after or ending_before to paginate.

Pattern: ^itmplc_[A-Za-z0-9_-]+$
Example:

"itmplc_gqXR7s0Kj5mHvE2wNpLc4Q"