Skip to content

Get a page of Orpheus templates ​

http
GET /api/v1/templates

Returns active and inactive templates. The name filters are mutually exclusive. Cursors are bound to the filters; restart pagination after changing them.

operationId: GetTemplates

Authentication ​

bearerAuth / browserSession / Public in anonymous mode

See Space authentication for access, browser writes and SAML callback rules.

Parameters ​

NameInRequiredTypeDescription and constraints
activequeryNoboolean
namequeryNostringExact stored name, including any team slug and tag; case-sensitive. minLength: 1
name_containsqueryNostringLiteral case-insensitive substring of the stored name. minLength: 1
limitqueryNointegerdefault: 50
minimum: 1
maximum: 200
cursorqueryNostringminLength: 1
maxLength: 8192

Responses ​

CodeDescriptionContent
200Successapplication/json: Templates
defaultStructured API error. 401 credentials, 403 CSRF or schedule_forbidden, 404 missing, 409 conflict, 422 validation, 503 unavailable.application/json: Problem

HTTP API