Workloads V2

The Workloads V2 API allows you to create, retrieve, and delete workloads that originate from third-party ML frameworks, tools, or the broader Kubernetes ecosystem. These workloads are registered in the platform through the Workload Types API, some are already registered in NVIDIA Run:ai, while others can be added by administrators. Each submission combines the user’s Kubernetes manifest with NVIDIA Run:ai scheduling metadata, enabling consistent orchestration, monitoring, and governance. See Extending workload support for more details.

Create a workload

Submit a workload with metadata and a Kubernetes manifest [Experimental].

SecuritybearerAuth

Request

Request Body schema: application/json
required

Workload metadata and manifest

required	object (WorkloadV2MetadataCreateParams)
	object (Manifest) The full Kubernetes manifest for the workload in JSON form. Mutually exclusive with manifestEncodedBase64.
manifestBase64Encoded	string <byte> (ManifestEncoded) Kubernetes YAML manifest encoded in base 64. Mutually exclusive with manifest.

Responses

201

Workload created successfully

400

Bad request.

401

Unauthorized

403

Forbidden

409

The specified resource already exists

500

unexpected error

503

unexpected error

post/api/v2/workloads

Request samples

Payload

application/json

{"metadata": {"name": "my-workload-name",
"projectId": 1,
"priority": "string",
"category": "string"
},
"manifest": {"apiVersion": "apps/v1",
"kind": "Deployment",
"metadata": {"name": "my-app"
},
"spec": {"replicas": 1,
"selector": {"matchLabels": {"app": "my-app"
}
},
"template": {"metadata": {"labels": {"app": "my-app"
}
},
"spec": {"containers": [{"name": "app",
"image": "nginx:latest"
}
]
}
}
}
},
"manifestBase64Encoded": "YXBpVmVyc2lvbjogdjEKa2luZDogUG9kCm1ldGFkYXRhOgogIG5hbWU6IG15LXBvZApzcGVjOgogIGNvbnRhaW5lcnM6CiAgLSBuYW1lOiBuZ2lueAogICAgaW1hZ2U6IG5naW54OmxhdGVzdAo="
}

Response samples

application/json

{"metadata": {"name": "my-workload-name",
"projectId": 1,
"priority": "string",
"category": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gvk": {"group": "apps",
"version": "v1",
"kind": "Deployment"
},
"projectName": "project-a",
"clusterId": "71f69d83-ba66-4822-adf5-55ce55efd210",
"tenantId": 1001,
"departmentId": 2,
"departmentName": "default",
"createdAt": "2024-01-15T10:30:00Z",
"createdBy": "user@run.ai",
"updatedAt": "2024-01-15T10:35:00Z",
"updatedBy": "user@run.ai",
"deletedAt": "2024-01-15T10:35:00Z",
"deletedBy": "user@run.ai"
},
"desiredPhase": "Running",
"workloadManifest": {"apiVersion": "apps/v1",
"kind": "Deployment",
"metadata": {"name": "my-app"
},
"spec": {"replicas": 1,
"selector": {"matchLabels": {"app": "my-app"
}
},
"template": {"metadata": {"labels": {"app": "my-app"
}
},
"spec": {"containers": [{"name": "app",
"image": "nginx:latest"
}
]
}
}
}
},
"rawManifest": {"apiVersion": "apps/v1",
"kind": "Deployment",
"metadata": {"name": "my-app"
},
"spec": {"replicas": 1,
"selector": {"matchLabels": {"app": "my-app"
}
},
"template": {"metadata": {"labels": {"app": "my-app"
}
},
"spec": {"containers": [{"name": "app",
"image": "nginx:latest"
}
]
}
}
}
}
}

Get a specific workload

Retrieve details of a specific workload by ID [Experimental]

SecuritybearerAuth

Request

path Parameters

WorkloadV2Id

required

string <uuid>

The ID of the workload.

Responses

200

Successfully retrieved the workload

401

Unauthorized

403

Forbidden

404

The specified resource was not found

500

unexpected error

503

unexpected error

get/api/v2/workloads/{WorkloadV2Id}

Response samples

application/json

{"workload": {"metadata": {"name": "my-workload-name",
"projectId": 1,
"priority": "string",
"category": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gvk": {"group": "apps",
"version": "v1",
"kind": "Deployment"
},
"projectName": "project-a",
"clusterId": "71f69d83-ba66-4822-adf5-55ce55efd210",
"tenantId": 1001,
"departmentId": 2,
"departmentName": "default",
"createdAt": "2024-01-15T10:30:00Z",
"createdBy": "user@run.ai",
"updatedAt": "2024-01-15T10:35:00Z",
"updatedBy": "user@run.ai",
"deletedAt": "2024-01-15T10:35:00Z",
"deletedBy": "user@run.ai"
},
"desiredPhase": "Running",
"workloadManifest": {"apiVersion": "apps/v1",
"kind": "Deployment",
"metadata": {"name": "my-app"
},
"spec": {"replicas": 1,
"selector": {"matchLabels": {"app": "my-app"
}
},
"template": {"metadata": {"labels": {"app": "my-app"
}
},
"spec": {"containers": [{"name": "app",
"image": "nginx:latest"
}
]
}
}
}
},
"rawManifest": {"apiVersion": "apps/v1",
"kind": "Deployment",
"metadata": {"name": "my-app"
},
"spec": {"replicas": 1,
"selector": {"matchLabels": {"app": "my-app"
}
},
"template": {"metadata": {"labels": {"app": "my-app"
}
},
"spec": {"containers": [{"name": "app",
"image": "nginx:latest"
}
]
}
}
}
}
},
"syncInfo": {"status": "Queued",
"message": "string"
}
}

Delete a workload

Delete a specific workload by ID [Experimental]

SecuritybearerAuth

Request

path Parameters

WorkloadV2Id

required

string <uuid>

The ID of the workload.

Responses

202

Deletion request accepted.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

500

unexpected error

503

unexpected error

delete/api/v2/workloads/{WorkloadV2Id}

Response samples

application/json

{"metadata": {"name": "my-workload-name",
"projectId": 1,
"priority": "string",
"category": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"gvk": {"group": "apps",
"version": "v1",
"kind": "Deployment"
},
"projectName": "project-a",
"clusterId": "71f69d83-ba66-4822-adf5-55ce55efd210",
"tenantId": 1001,
"departmentId": 2,
"departmentName": "default",
"createdAt": "2024-01-15T10:30:00Z",
"createdBy": "user@run.ai",
"updatedAt": "2024-01-15T10:35:00Z",
"updatedBy": "user@run.ai",
"deletedAt": "2024-01-15T10:35:00Z",
"deletedBy": "user@run.ai"
},
"desiredPhase": "Running",
"workloadManifest": {"apiVersion": "apps/v1",
"kind": "Deployment",
"metadata": {"name": "my-app"
},
"spec": {"replicas": 1,
"selector": {"matchLabels": {"app": "my-app"
}
},
"template": {"metadata": {"labels": {"app": "my-app"
}
},
"spec": {"containers": [{"name": "app",
"image": "nginx:latest"
}
]
}
}
}
},
"rawManifest": {"apiVersion": "apps/v1",
"kind": "Deployment",
"metadata": {"name": "my-app"
},
"spec": {"replicas": 1,
"selector": {"matchLabels": {"app": "my-app"
}
},
"template": {"metadata": {"labels": {"app": "my-app"
}
},
"spec": {"containers": [{"name": "app",
"image": "nginx:latest"
}
]
}
}
}
}
}

➔ Next to Workspaces

Workloads V2

Create a workload

Request Body schema: application/jsonrequired

Get a specific workload

path Parameters

Delete a workload

path Parameters

Request Body schema: application/json
required