Clusters
Applications
Models
Artifacts
- GETGet Artifact
- DELDelete Artifact
- GETList Artifacts
- GETGet Artifact Version
- DELDelete Artifact Version
- GETList Artifact Versions
- PUTApply Artifact Version
- POSTDelete Artifact Version
- POSTGet Signed Urls For Artifact Version
- POSTCreate Multi Part Upload
- POSTStage Artifact Version
- POSTList Files For Artifact Version
- POSTMark Stage Failure
Prompts
Secret Groups
Model Deployments
Users
Personal Access Tokens
Virtual Accounts
Clusters
List Clusters
Retrieves a list of all latest Clusters. Pagination is available based on query parameters.
GET
/
api
/
svc
/
v1
/
clusters
curl --request GET \
--url https://{controlPlaneURL}/api/svc/v1/clusters \
--header 'Authorization: Bearer <token>'
{
"data": [
{
"id": "<string>",
"fqn": "<string>",
"name": "<string>",
"manifest": {
"type": "cluster",
"name": "<string>",
"cluster_type": "aws-eks",
"environment_names": [
"<string>"
],
"base_domains": [
"<string>"
],
"monitoring": {
"loki_url": "<string>",
"prometheus_url": "<string>",
"kubecost_url": "<string>"
},
"default_registry_fqn": "<string>",
"workbench_config": {
"notebook_config": {
"base_domain": "<string>"
},
"ssh_server_config": {
"base_domain": "<string>",
"port": 123
},
"default_storage_class": "<string>"
},
"cluster_integration_fqn": "<string>",
"workflow_storage_integration_fqn": "<string>",
"supported_nodepools": [
{
"name": "<string>",
"description": "<string>",
"capacityType": "on-demand",
"deviceTypeToMaxCountMap": {},
"taints": [
{
"key": "<string>",
"value": "<string>",
"effect": "<string>"
}
],
"instanceResources": {
"cpu": 123,
"memoryMB": 123,
"ephemeralStorageMB": 123,
"devices": [
{
"type": "nvidia_gpu",
"gpuType": "P4",
"count": 123,
"configuration": [
{
"type": "nvidia_gpu",
"count": 123,
"deviceIdentifier": "<string>",
"migProfile": "<string>",
"perInstanceGpuMemory": 123,
"slicesPerFullGpu": 123,
"nvidiaDevicePluginConfig": "<string>"
}
]
}
],
"gpuCount": 123,
"gpuType": "<string>"
}
}
],
"node_label_keys": {
"nodepool_selector_label": "<string>"
},
"collaborators": [
{
"subject": "<string>",
"role_id": "<string>"
}
]
},
"tenantName": "<string>",
"createdBySubject": {
"subjectId": "<string>",
"subjectType": "user",
"subjectSlug": "<string>",
"subjectDisplayName": "<string>"
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>"
}
],
"pagination": {
"total": 100,
"offset": 0,
"limit": 10
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
Number of items per page
Required range:
1 <= x <= 1000
Example:
10
Number of items to skip
Required range:
x >= 0
Example:
0
Response
200
application/json
Retrieve latest Clusters. If pagination parameters are provided, the response includes paginated data.
The response is of type object
.
Was this page helpful?
curl --request GET \
--url https://{controlPlaneURL}/api/svc/v1/clusters \
--header 'Authorization: Bearer <token>'
{
"data": [
{
"id": "<string>",
"fqn": "<string>",
"name": "<string>",
"manifest": {
"type": "cluster",
"name": "<string>",
"cluster_type": "aws-eks",
"environment_names": [
"<string>"
],
"base_domains": [
"<string>"
],
"monitoring": {
"loki_url": "<string>",
"prometheus_url": "<string>",
"kubecost_url": "<string>"
},
"default_registry_fqn": "<string>",
"workbench_config": {
"notebook_config": {
"base_domain": "<string>"
},
"ssh_server_config": {
"base_domain": "<string>",
"port": 123
},
"default_storage_class": "<string>"
},
"cluster_integration_fqn": "<string>",
"workflow_storage_integration_fqn": "<string>",
"supported_nodepools": [
{
"name": "<string>",
"description": "<string>",
"capacityType": "on-demand",
"deviceTypeToMaxCountMap": {},
"taints": [
{
"key": "<string>",
"value": "<string>",
"effect": "<string>"
}
],
"instanceResources": {
"cpu": 123,
"memoryMB": 123,
"ephemeralStorageMB": 123,
"devices": [
{
"type": "nvidia_gpu",
"gpuType": "P4",
"count": 123,
"configuration": [
{
"type": "nvidia_gpu",
"count": 123,
"deviceIdentifier": "<string>",
"migProfile": "<string>",
"perInstanceGpuMemory": 123,
"slicesPerFullGpu": 123,
"nvidiaDevicePluginConfig": "<string>"
}
]
}
],
"gpuCount": 123,
"gpuType": "<string>"
}
}
],
"node_label_keys": {
"nodepool_selector_label": "<string>"
},
"collaborators": [
{
"subject": "<string>",
"role_id": "<string>"
}
]
},
"tenantName": "<string>",
"createdBySubject": {
"subjectId": "<string>",
"subjectType": "user",
"subjectSlug": "<string>",
"subjectDisplayName": "<string>"
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>"
}
],
"pagination": {
"total": 100,
"offset": 0,
"limit": 10
}
}