Skip to content
OpenRelay is in early access, and the /v1 API is stable. New capabilities ship in the changelog.
API ReferenceComputeCatalog

VM template catalog

Returns the VM template catalog: each template's name, slug, OS type and version, driver version, whether it needs a GPU, and which GPU models it supports.

Required permission

Requires the catalog.read permission. See Permissions for the roles and API key permissions that include it.

Command line

The orl CLI wraps this endpoint:

orl catalog vm-template list
GET
/v1/vm-templates

Authorization

apiKey
headerAuthorizationBearer <token>

OpenRelay API key. Send it as Authorization: Bearer or_… (legacy vl_… keys still work).

Response Body

Templates

application/json
  1. response
[index: integer]?
Example Request
curl -X GET 'https://api.openrelay.inc/v1/vm-templates'
Example Response
[  {    "id": "string",    "name": "string",    "slug": "string",    "description": "string",    "filename": "string",    "requiresGpu": true,    "osVersion": "string",    "driverVersion": "string",    "osType": "string",    "isDefault": true,    "sortOrder": 0,    "compatibleGpuModelIds": [      "string"    ]  }]