Template

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

List templates.

Retrieve a list of templates.

SecuritybearerAuth

Request

query Parameters

name	string Filter results by name.
scope	string Filter results by scope.
projectId	integer <int32> 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.
departmentId	string Filter using the department id. Example: departmentId=1
clusterId	string <uuid> Filter using the Universally Unique Identifier (UUID) of the cluster. Example: clusterId=d73a738f-fab3-430a-8fa3-5241493d7128
distributedFramework	string Filter results to workload of type distributed and distributedFramework.
isDistributed	boolean Filter results to workload of type distributed.
isTraining	boolean Filter results to workload of type training.
isWorkspace	boolean Filter results to workload of type workspace.

Responses

200

Request completed successfully.

401

Unauthorized

403

Forbidden

503

unexpected error

get/api/v1/asset/workload-template

Response samples

application/json

{"entries": [{"meta": {"name": "my-asset",
"scope": "tenant",
"id": "a418ed33-9399-48c0-a890-122cadd13bfd",
"kind": "s3",
"createdBy": "test@run.ai",
"createdAt": "2023-02-23T14:25:36.707685Z",
"updatedBy": "test@run.ai",
"updatedAt": "2023-02-23T14:25:36.707685Z",
"workloadSupportedTypes": {"workspace": false,
"training": false,
"distributed": true,
"distFramework": "TF"
}
},
"spec": {"assets": {"environment": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset",
"toolTypes": ["jupyter-notebook"
]
},
"compute": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
},
"datasources": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset",
"kind": "compute"
}
],
"workloadVolumes": ["string"
]
},
"specificEnv": {"command": "python",
"args": "-x my-script.py",
"runAsUid": 500,
"runAsGid": 30,
"supplementalGroups": "2,3,5,8",
"environmentVariables": [{"name": "HOME",
"value": "/home/my-folder",
"secret": {"name": null,
"key": null
},
"exclude": false
}
],
"nodeType": "my-node-type",
"nodePools": ["my-node-pool-a",
"my-node-pool-b"
],
"podAffinity": {"type": "Required",
"key": "string"
},
"terminateAfterPreemption": false,
"autoDeletionTimeAfterCompletionSeconds": 15,
"backoffLimit": 3,
"annotations": [{"name": "billing",
"value": "my-billing-unit",
"exclude": false
}
],
"labels": [{"name": "stage",
"value": "initial-research",
"exclude": false
}
],
"connections": [{"name": "string",
"nodePort": 65535,
"externalUrl": "string",
"authorizedUsers": [null
],
"authorizedGroups": [null
]
}
],
"allowOverQuota": true,
"autoScaling": {"minReplicas": 0,
"maxReplicas": 1,
"scaleToZeroRetentionSeconds": 3600,
"thresholdMetric": "throughput",
"thresholdValue": 0
}
},
"distributed": {"numWorkers": 0,
"noMaster": true,
"distFramework": "MPI",
"master": {"assets": {"environment": {"id": null,
"name": null,
"toolTypes": [ ]
},
"compute": {"id": null,
"name": null
},
"datasources": [null
],
"workloadVolumes": [null
]
},
"specificEnv": {"command": "python",
"args": "-x my-script.py",
"runAsUid": 500,
"runAsGid": 30,
"supplementalGroups": "2,3,5,8",
"environmentVariables": [null
],
"nodeType": "my-node-type",
"nodePools": ["my-node-pool-a",
"my-node-pool-b"
],
"podAffinity": {"type": null,
"key": null
},
"terminateAfterPreemption": false,
"autoDeletionTimeAfterCompletionSeconds": 15,
"backoffLimit": 3,
"annotations": [null
],
"labels": [null
],
"connections": [null
],
"allowOverQuota": true,
"autoScaling": {"minReplicas": null,
"maxReplicas": null,
"scaleToZeroRetentionSeconds": null,
"thresholdMetric": null,
"thresholdValue": null
}
}
}
}
}
}
]
}

Create a template.

Use to create a template.

SecuritybearerAuth

Request

Request Body schema: application/json

required	object (AssetCreationRequest)
required	object (SpecificRunCreationFields) The information needed for creating az template - a set of assets and an optional set of specific environment parameters.

Responses

202

Request accepted successfully.

400

Bad request.

401

Unauthorized

403

Forbidden

409

The specified resource already exists

503

unexpected error

post/api/v1/asset/workload-template

Request samples

Payload

application/json

{"meta": {"name": "my-asset",
"scope": "tenant",
"workloadSupportedTypes": {"workspace": false,
"training": false,
"inference": false,
"distributed": true,
"distFramework": "TF"
}
},
"spec": {"assets": {"environment": "fafd1151-c401-4fdd-ac01-03d8e7a57166",
"compute": "a8d9e7bc-1f1b-4fab-ae09-ad78c0a843fe",
"datasources": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"kind": "compute"
}
],
"workloadVolumes": ["string"
]
},
"specificEnv": {"command": "python",
"args": "-x my-script.py",
"runAsUid": 500,
"runAsGid": 30,
"supplementalGroups": "2,3,5,8",
"environmentVariables": [{"name": "HOME",
"value": "/home/my-folder",
"secret": {"name": "postgress_secret",
"key": "POSTGRES_PASSWORD"
},
"exclude": false
}
],
"nodeType": "my-node-type",
"nodePools": ["my-node-pool-a",
"my-node-pool-b"
],
"podAffinity": {"type": "Required",
"key": "string"
},
"terminateAfterPreemption": false,
"autoDeletionTimeAfterCompletionSeconds": 15,
"backoffLimit": 3,
"annotations": [{"name": "billing",
"value": "my-billing-unit",
"exclude": false
}
],
"labels": [{"name": "stage",
"value": "initial-research",
"exclude": false
}
],
"connections": [{"name": "string",
"nodePort": 65535,
"externalUrl": "string",
"authorizedUsers": ["string"
],
"authorizedGroups": ["string"
]
}
],
"allowOverQuota": true,
"autoScaling": {"minReplicas": 0,
"maxReplicas": 1,
"scaleToZeroRetentionSeconds": 3600,
"thresholdMetric": "throughput",
"thresholdValue": 0
}
}
}
}

Response samples

application/json

{"meta": {"name": "my-asset",
"scope": "tenant",
"id": "a418ed33-9399-48c0-a890-122cadd13bfd",
"kind": "s3",
"createdBy": "test@run.ai",
"createdAt": "2023-02-23T14:25:36.707685Z",
"updatedBy": "test@run.ai",
"updatedAt": "2023-02-23T14:25:36.707685Z",
"workloadSupportedTypes": {"workspace": false,
"training": false,
"distributed": true,
"distFramework": "TF"
}
},
"spec": {"assets": {"environment": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset",
"toolTypes": ["jupyter-notebook"
]
},
"compute": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
},
"datasources": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset",
"kind": "compute"
}
],
"workloadVolumes": ["string"
]
},
"specificEnv": {"command": "python",
"args": "-x my-script.py",
"runAsUid": 500,
"runAsGid": 30,
"supplementalGroups": "2,3,5,8",
"environmentVariables": [{"name": "HOME",
"value": "/home/my-folder",
"secret": {"name": "postgress_secret",
"key": "POSTGRES_PASSWORD"
},
"exclude": false
}
],
"nodeType": "my-node-type",
"nodePools": ["my-node-pool-a",
"my-node-pool-b"
],
"podAffinity": {"type": "Required",
"key": "string"
},
"terminateAfterPreemption": false,
"autoDeletionTimeAfterCompletionSeconds": 15,
"backoffLimit": 3,
"annotations": [{"name": "billing",
"value": "my-billing-unit",
"exclude": false
}
],
"labels": [{"name": "stage",
"value": "initial-research",
"exclude": false
}
],
"connections": [{"name": "string",
"nodePort": 65535,
"externalUrl": "string",
"authorizedUsers": ["string"
],
"authorizedGroups": ["string"
]
}
],
"allowOverQuota": true,
"autoScaling": {"minReplicas": 0,
"maxReplicas": 1,
"scaleToZeroRetentionSeconds": 3600,
"thresholdMetric": "throughput",
"thresholdValue": 0
}
},
"distributed": {"numWorkers": 0,
"noMaster": true,
"distFramework": "MPI",
"master": {"assets": {"environment": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset",
"toolTypes": ["jupyter-notebook"
]
},
"compute": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
},
"datasources": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset",
"kind": "compute"
}
],
"workloadVolumes": ["string"
]
},
"specificEnv": {"command": "python",
"args": "-x my-script.py",
"runAsUid": 500,
"runAsGid": 30,
"supplementalGroups": "2,3,5,8",
"environmentVariables": [{"name": "HOME",
"value": "/home/my-folder",
"secret": {"name": null,
"key": null
},
"exclude": false
}
],
"nodeType": "my-node-type",
"nodePools": ["my-node-pool-a",
"my-node-pool-b"
],
"podAffinity": {"type": "Required",
"key": "string"
},
"terminateAfterPreemption": false,
"autoDeletionTimeAfterCompletionSeconds": 15,
"backoffLimit": 3,
"annotations": [{"name": "billing",
"value": "my-billing-unit",
"exclude": false
}
],
"labels": [{"name": "stage",
"value": "initial-research",
"exclude": false
}
],
"connections": [{"name": "string",
"nodePort": 65535,
"externalUrl": "string",
"authorizedUsers": [null
],
"authorizedGroups": [null
]
}
],
"allowOverQuota": true,
"autoScaling": {"minReplicas": 0,
"maxReplicas": 1,
"scaleToZeroRetentionSeconds": 3600,
"thresholdMetric": "throughput",
"thresholdValue": 0
}
}
}
}
}
}

Get a template.

Retrieve the details of a template by id.

SecuritybearerAuth

Request

path Parameters

AssetId

required

string <uuid> non-empty

Unique identifier of the asset.

Responses

200

Request completed successfully.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

503

unexpected error

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

Response samples

application/json

{"meta": {"name": "my-asset",
"scope": "tenant",
"id": "a418ed33-9399-48c0-a890-122cadd13bfd",
"kind": "s3",
"createdBy": "test@run.ai",
"createdAt": "2023-02-23T14:25:36.707685Z",
"updatedBy": "test@run.ai",
"updatedAt": "2023-02-23T14:25:36.707685Z",
"workloadSupportedTypes": {"workspace": false,
"training": false,
"distributed": true,
"distFramework": "TF"
}
},
"spec": {"assets": {"environment": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset",
"toolTypes": ["jupyter-notebook"
]
},
"compute": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
},
"datasources": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset",
"kind": "compute"
}
],
"workloadVolumes": ["string"
]
},
"specificEnv": {"command": "python",
"args": "-x my-script.py",
"runAsUid": 500,
"runAsGid": 30,
"supplementalGroups": "2,3,5,8",
"environmentVariables": [{"name": "HOME",
"value": "/home/my-folder",
"secret": {"name": "postgress_secret",
"key": "POSTGRES_PASSWORD"
},
"exclude": false
}
],
"nodeType": "my-node-type",
"nodePools": ["my-node-pool-a",
"my-node-pool-b"
],
"podAffinity": {"type": "Required",
"key": "string"
},
"terminateAfterPreemption": false,
"autoDeletionTimeAfterCompletionSeconds": 15,
"backoffLimit": 3,
"annotations": [{"name": "billing",
"value": "my-billing-unit",
"exclude": false
}
],
"labels": [{"name": "stage",
"value": "initial-research",
"exclude": false
}
],
"connections": [{"name": "string",
"nodePort": 65535,
"externalUrl": "string",
"authorizedUsers": ["string"
],
"authorizedGroups": ["string"
]
}
],
"allowOverQuota": true,
"autoScaling": {"minReplicas": 0,
"maxReplicas": 1,
"scaleToZeroRetentionSeconds": 3600,
"thresholdMetric": "throughput",
"thresholdValue": 0
}
},
"distributed": {"numWorkers": 0,
"noMaster": true,
"distFramework": "MPI",
"master": {"assets": {"environment": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset",
"toolTypes": ["jupyter-notebook"
]
},
"compute": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
},
"datasources": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset",
"kind": "compute"
}
],
"workloadVolumes": ["string"
]
},
"specificEnv": {"command": "python",
"args": "-x my-script.py",
"runAsUid": 500,
"runAsGid": 30,
"supplementalGroups": "2,3,5,8",
"environmentVariables": [{"name": "HOME",
"value": "/home/my-folder",
"secret": {"name": null,
"key": null
},
"exclude": false
}
],
"nodeType": "my-node-type",
"nodePools": ["my-node-pool-a",
"my-node-pool-b"
],
"podAffinity": {"type": "Required",
"key": "string"
},
"terminateAfterPreemption": false,
"autoDeletionTimeAfterCompletionSeconds": 15,
"backoffLimit": 3,
"annotations": [{"name": "billing",
"value": "my-billing-unit",
"exclude": false
}
],
"labels": [{"name": "stage",
"value": "initial-research",
"exclude": false
}
],
"connections": [{"name": "string",
"nodePort": 65535,
"externalUrl": "string",
"authorizedUsers": [null
],
"authorizedGroups": [null
]
}
],
"allowOverQuota": true,
"autoScaling": {"minReplicas": 0,
"maxReplicas": 1,
"scaleToZeroRetentionSeconds": 3600,
"thresholdMetric": "throughput",
"thresholdValue": 0
}
}
}
}
}
}

Update a template.

Use to update the details of a template by id.

SecuritybearerAuth

Request

path Parameters

AssetId

required

string <uuid> non-empty

Unique identifier of the asset.

Request Body schema: application/json

required	object (AssetUpdateRequest)
required	object (SpecificRunCreationFields) The information needed for creating az template - a set of assets and an optional set of specific environment parameters.

Responses

202

Request accepted successfully.

400

Bad request.

401

Unauthorized

403

Forbidden

409

The specified resource already exists

503

unexpected error

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

Request samples

Payload

application/json

{"meta": {"name": "my-asset"
},
"spec": {"assets": {"environment": "fafd1151-c401-4fdd-ac01-03d8e7a57166",
"compute": "a8d9e7bc-1f1b-4fab-ae09-ad78c0a843fe",
"datasources": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"kind": "compute"
}
],
"workloadVolumes": ["string"
]
},
"specificEnv": {"command": "python",
"args": "-x my-script.py",
"runAsUid": 500,
"runAsGid": 30,
"supplementalGroups": "2,3,5,8",
"environmentVariables": [{"name": "HOME",
"value": "/home/my-folder",
"secret": {"name": "postgress_secret",
"key": "POSTGRES_PASSWORD"
},
"exclude": false
}
],
"nodeType": "my-node-type",
"nodePools": ["my-node-pool-a",
"my-node-pool-b"
],
"podAffinity": {"type": "Required",
"key": "string"
},
"terminateAfterPreemption": false,
"autoDeletionTimeAfterCompletionSeconds": 15,
"backoffLimit": 3,
"annotations": [{"name": "billing",
"value": "my-billing-unit",
"exclude": false
}
],
"labels": [{"name": "stage",
"value": "initial-research",
"exclude": false
}
],
"connections": [{"name": "string",
"nodePort": 65535,
"externalUrl": "string",
"authorizedUsers": ["string"
],
"authorizedGroups": ["string"
]
}
],
"allowOverQuota": true,
"autoScaling": {"minReplicas": 0,
"maxReplicas": 1,
"scaleToZeroRetentionSeconds": 3600,
"thresholdMetric": "throughput",
"thresholdValue": 0
}
}
}
}

Response samples

application/json

{"meta": {"name": "my-asset",
"scope": "tenant",
"id": "a418ed33-9399-48c0-a890-122cadd13bfd",
"kind": "s3",
"createdBy": "test@run.ai",
"createdAt": "2023-02-23T14:25:36.707685Z",
"updatedBy": "test@run.ai",
"updatedAt": "2023-02-23T14:25:36.707685Z",
"workloadSupportedTypes": {"workspace": false,
"training": false,
"distributed": true,
"distFramework": "TF"
}
},
"spec": {"assets": {"environment": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset",
"toolTypes": ["jupyter-notebook"
]
},
"compute": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
},
"datasources": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset",
"kind": "compute"
}
],
"workloadVolumes": ["string"
]
},
"specificEnv": {"command": "python",
"args": "-x my-script.py",
"runAsUid": 500,
"runAsGid": 30,
"supplementalGroups": "2,3,5,8",
"environmentVariables": [{"name": "HOME",
"value": "/home/my-folder",
"secret": {"name": "postgress_secret",
"key": "POSTGRES_PASSWORD"
},
"exclude": false
}
],
"nodeType": "my-node-type",
"nodePools": ["my-node-pool-a",
"my-node-pool-b"
],
"podAffinity": {"type": "Required",
"key": "string"
},
"terminateAfterPreemption": false,
"autoDeletionTimeAfterCompletionSeconds": 15,
"backoffLimit": 3,
"annotations": [{"name": "billing",
"value": "my-billing-unit",
"exclude": false
}
],
"labels": [{"name": "stage",
"value": "initial-research",
"exclude": false
}
],
"connections": [{"name": "string",
"nodePort": 65535,
"externalUrl": "string",
"authorizedUsers": ["string"
],
"authorizedGroups": ["string"
]
}
],
"allowOverQuota": true,
"autoScaling": {"minReplicas": 0,
"maxReplicas": 1,
"scaleToZeroRetentionSeconds": 3600,
"thresholdMetric": "throughput",
"thresholdValue": 0
}
},
"distributed": {"numWorkers": 0,
"noMaster": true,
"distFramework": "MPI",
"master": {"assets": {"environment": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset",
"toolTypes": ["jupyter-notebook"
]
},
"compute": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset"
},
"datasources": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "my-asset",
"kind": "compute"
}
],
"workloadVolumes": ["string"
]
},
"specificEnv": {"command": "python",
"args": "-x my-script.py",
"runAsUid": 500,
"runAsGid": 30,
"supplementalGroups": "2,3,5,8",
"environmentVariables": [{"name": "HOME",
"value": "/home/my-folder",
"secret": {"name": null,
"key": null
},
"exclude": false
}
],
"nodeType": "my-node-type",
"nodePools": ["my-node-pool-a",
"my-node-pool-b"
],
"podAffinity": {"type": "Required",
"key": "string"
},
"terminateAfterPreemption": false,
"autoDeletionTimeAfterCompletionSeconds": 15,
"backoffLimit": 3,
"annotations": [{"name": "billing",
"value": "my-billing-unit",
"exclude": false
}
],
"labels": [{"name": "stage",
"value": "initial-research",
"exclude": false
}
],
"connections": [{"name": "string",
"nodePort": 65535,
"externalUrl": "string",
"authorizedUsers": [null
],
"authorizedGroups": [null
]
}
],
"allowOverQuota": true,
"autoScaling": {"minReplicas": 0,
"maxReplicas": 1,
"scaleToZeroRetentionSeconds": 3600,
"thresholdMetric": "throughput",
"thresholdValue": 0
}
}
}
}
}
}

Delete a template.

Use to delete a template by id.

SecuritybearerAuth

Request

path Parameters

AssetId

required

string <uuid> non-empty

Unique identifier of the asset.

Responses

202

Accepted.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

503

unexpected error

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

Response samples

application/json

{"code": 202,
"message": "Request has been accepted."
}

➔ Next to Policy