Template

Templates are a pre-set configuration used to quickly configure and submit workloads using existing assets.

List templates.

get

Retrieve a list of templates.

Authorizations
AuthorizationstringRequired

Bearer authentication

Query parameters
namestringOptional

Filter results by name.

scopestringOptional

Filter results by scope.

projectIdinteger · int32Optional

Filter results by project id. if scope filter is project, only assets from the specific project will be included in the response. otherwise, the response will include both project, department, cluster and tenant assets.

departmentIdstringOptional

Filter using the department id.

Example: 1
clusterIdstring · uuidOptional

Filter using the Universally Unique Identifier (UUID) of the cluster.

Example: d73a738f-fab3-430a-8fa3-5241493d7128
distributedFrameworkstringOptional

Filter results to workload of type distributed and distributedFramework.

isDistributedbooleanOptional

Filter results to workload of type distributed.

isTrainingbooleanOptional

Filter results to workload of type training.

isWorkspacebooleanOptional

Filter results to workload of type workspace.

Responses
chevron-right
200

Request completed successfully.

application/json
get
/api/v1/asset/workload-template

Create a template.

post

Use to create a template.

Authorizations
AuthorizationstringRequired

Bearer authentication

Body
Responses
post
/api/v1/asset/workload-template

Get a template.

get

Retrieve the details of a template by id.

Authorizations
AuthorizationstringRequired

Bearer authentication

Path parameters
AssetIdstring · uuid · min: 1Required

Unique identifier of the asset.

Responses
chevron-right
200

Request completed successfully.

application/json
get
/api/v1/asset/workload-template/{AssetId}

Update a template.

put

Use to update the details of a template by id.

Authorizations
AuthorizationstringRequired

Bearer authentication

Path parameters
AssetIdstring · uuid · min: 1Required

Unique identifier of the asset.

Body
Responses
put
/api/v1/asset/workload-template/{AssetId}

Delete a template.

delete

Use to delete a template by id.

Authorizations
AuthorizationstringRequired

Bearer authentication

Path parameters
AssetIdstring · uuid · min: 1Required

Unique identifier of the asset.

Responses
delete
/api/v1/asset/workload-template/{AssetId}

Last updated