search templates

Searches for templates using filter-based queries.

Use select_filters to search by specific field conditions. Results include both your own templates and publicly shared templates.

Available filter fields: creator_id, created_at, count_created, default_tag, docker_login_repo, id, image, jup_direct, hash_id, name, recent_create_date, recommended_disk_space, recommended, ssh_direct, tag, use_ssh

Operators: eq, neq, lt, lte, gt, gte, in, notin

For detailed usage, see Creating and Using Templates with API.

CLI Usage: vastai search templates

GET /api/v0/template

search templates

cURL

curl --request GET \
  --url https://console.vast.ai/api/v0/template/ \
  --header 'Authorization: Bearer <token>'

200

{
  "success": true,
  "templates_found": 5,
  "templates": [
    {
      "id": 123,
      "name": "<string>",
      "image": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

API key must be provided in the Authorization header

Query Parameters

select_filters · string

JSON-encoded filter object. Format: {"field": {"op": value}}. Example: {"use_ssh": {"eq": true}, "recommended": {"eq": true}} or {"count_created": {"gt": 100}}

select_cols · string

JSON-encoded array of columns to return. Example: ["*"] for all columns or ["id", "name", "hash_id"] for specific columns.

order_by · string

Column to order the results by.

Response

200

application/json

Successfully retrieved templates

success · boolean · required

Example:

true

templates_found · integer · required

Number of templates found.

Example:

5

templates · object[] · required

List of templates matching the search criteria.

Show child attributes