Run templates

Deprecated

List Run Templates

get

Get a page of run templates.

Args: filter_model: Filter model used for pagination, sorting, filtering. project_name_or_id: Optional name or ID of the project. hydrate: Flag deciding whether to hydrate the output model(s) by including metadata fields in the response.

Returns: Page of run templates.

Authorizations
OAuth2passwordRequired
Token URL:
Query parameters
project_name_or_idany ofOptional
stringOptional
or
string · uuidOptional
or
nullOptional
hydratebooleanOptionalDefault: false
sort_bystringOptionalDefault: created
logical_operatorstring · enumOptional

Logical Ops to use to combine filters on list methods.

Default: andPossible values:
pageinteger · min: 1OptionalDefault: 1
sizeinteger · min: 1 · max: 10000OptionalDefault: 20
idany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
createdany ofOptional
string · date-timeOptional
or
stringOptional
or
nullOptional
updatedany ofOptional
string · date-timeOptional
or
stringOptional
or
nullOptional
tagany ofOptional
stringOptional
or
nullOptional
tagsany ofOptional
string[]Optional
or
nullOptional
scope_userany ofOptional
string · uuidOptional
or
nullOptional
userany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
projectany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
nameany ofOptional
stringOptional
or
nullOptional
hiddenany ofOptional
booleanOptional
or
nullOptional
pipeline_idany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
build_idany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
stack_idany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
code_repository_idany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
pipelineany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
stackany ofOptional
string · uuidOptional
or
stringOptional
or
nullOptional
Responses
200

Successful Response

application/json
get
/api/v1/run_templates
Deprecated

Get Run Template

get

Get a run template.

Args: template_id: ID of the run template to get. hydrate: Flag deciding whether to hydrate the output model(s) by including metadata fields in the response.

Returns: The run template.

Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
template_idstring · uuidRequired
Query parameters
hydratebooleanOptionalDefault: true
Responses
200

Successful Response

application/json
get
/api/v1/run_templates/{template_id}
Deprecated

Update Run Template

put

Update a run template.

Args: template_id: ID of the run template to get. update: The updates to apply.

Returns: The updated run template.

Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
template_idstring · uuidRequired
Body

Run template update model.

nameany ofOptional
string · max: 255Optional
or
nullOptional
descriptionany ofOptional
string · max: 65535Optional
or
nullOptional
hiddenany ofOptional
booleanOptional
or
nullOptional
add_tagsany ofOptional
string[]Optional
or
nullOptional
remove_tagsany ofOptional
string[]Optional
or
nullOptional
Responses
200

Successful Response

application/json
put
/api/v1/run_templates/{template_id}
Deprecated

Delete Run Template

delete

Delete a run template.

Args: template_id: ID of the run template to delete.

Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
template_idstring · uuidRequired
Responses
200

Successful Response

application/json
Responseany
delete
/api/v1/run_templates/{template_id}

No content

Last updated

Was this helpful?