NVIDIA Run:ai

Workload properties

Workload properties define the behavioral and scheduling characteristics of a workload submitted to the NVIDIA Run:ai platform. These properties such as type, category, and priority determine how workloads are classified, monitored, and scheduled.

  • Type - Defines the functional behavior of a workload, such as training or inference, and serves as the foundation for how it is classified within the platform. Each workload type includes a default category (used for monitoring) and a default priority (used for scheduling within a project).
  • Category - Represents the role or purpose of a workload, such as Build, Train, Deploy. Each workload type is assigned a default category to ensure consistent classification across the platform for monitoring purposes. See Monitor workloads by category.
  • Priority - Determines the scheduling order of workloads within a project and whether a workload can be preempted. Higher-priority workloads are scheduled first and may become non-preemptible, preventing interruption by lower-priority workloads. See Workload priority control.

List workload categories.

Retrieves a list of workload categories. These categories are used to classify and monitor different types of workloads within the NVIDIA Run:ai platform.

SecuritybearerAuth
Responses
200

List of categories retrieved successfully.

400

Bad request.

401

Unauthorized

403

Forbidden

503

unexpected error

get/api/v1/workload-categories
Response samples
application/json
{
  • "categories": [
    ]
}

Get workload category by id.

Retrieves a specific workload category by its ID. Workload categories are used to classify and monitor different types of workloads within the NVIDIA Run:ai platform.

SecuritybearerAuth
Request
path Parameters
categoryId
required
string <uuid>

The unique identifier of the workload category.

Responses
200

Category retrieved successfully

400

Bad request.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

503

unexpected error

get/api/v1/workload-categories/{categoryId}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "description": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": "string"
}

List workload types.

Retrieves a list of workload types with their configurations - their corresponding workload categories and priorities.

SecuritybearerAuth
Request
query Parameters
externalTypesOnly
boolean
Default: false

Return only external and user_external sourced workload types.

filterBy
Array of strings

Filter results by a parameter. Use the format field-name operator value. Operators are == Equals, != Not equals, <= Less than or equal, >= Greater than or equal, =@ contains, !@ Does not contain, =^ Starts with and =$ Ends with. Dates are in ISO 8601 timestamp format and available for operators ==, !=, <= and >=.

Example: filterBy=name==Deployment,group==apps
Responses
200

List of types retrieved successfully

400

Bad request.

401

Unauthorized

403

Forbidden

503

unexpected error

get/api/v1/workload-types
Response samples
application/json
{
  • "types": [
    ]
}

Create a workload type.

Create a new workload type in the system by providing its identification details and configuration, making it available for use and management within the platform.

SecuritybearerAuth
Request
Request Body schema: application/json
required

Workload type to create.

categoryId
required
string <uuid>

The unique identifier of the workload category.

priorityId
required
string <uuid>

The unique identifier of the workload priority.

name
required
string^[A-Z][a-z0-9]*([A-Z][a-z0-9]*)*$

The unique name of the workload type. This value must exactly match the Kubernetes Kind that represents the workload type.

group
required
string^[a-z](?:[a-z0-9.-]*[a-z0-9])?$

The Kubernetes group associated with the workload resource.

Array of objects (WorkloadTypeResourceInterfaces) <= 4 items

Lists the versions of the custom resource definition (CRD) supported for this workload type, such as v1, v1beta1, or v1alpha1. This enables the platform to correctly parse, interpret, and manage manifests for this workload type according to the specific structure and schema associated with each listed version. On update, you may only add or remove supported versions, modifying existing version entries is not allowed.

Responses
201

Created

400

Bad request.

401

Unauthorized

403

Forbidden

409

The specified resource already exists

503

unexpected error

post/api/v1/workload-types
Request samples
application/json
{
  • "categoryId": "337f5e5d-288b-40d5-be14-901cc3acacc0",
  • "priorityId": "a57eab25-838b-40cc-a576-57e4056f1d6c",
  • "name": "Deployment",
  • "group": "apps",
  • "resourceInterfaces": [
    ]
}
Response samples
application/json
{
  • "categoryId": "337f5e5d-288b-40d5-be14-901cc3acacc0",
  • "priorityId": "a57eab25-838b-40cc-a576-57e4056f1d6c",
  • "name": "Deployment",
  • "group": "apps",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "categoryName": "Build",
  • "priorityName": "medium",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "resourceInterfaces": [
    ],
  • "clusterStatuses": [
    ]
}

List workload type by id.

Retrieves a specific workload type by its ID.

SecuritybearerAuth
Request
path Parameters
workloadTypeId
required
string <uuid>

The unique identifier of the workload type.

Responses
200

Type retrieved successfully

400

Bad request.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

503

unexpected error

get/api/v1/workload-types/{workloadTypeId}
Response samples
application/json
{
  • "categoryId": "337f5e5d-288b-40d5-be14-901cc3acacc0",
  • "priorityId": "a57eab25-838b-40cc-a576-57e4056f1d6c",
  • "name": "Deployment",
  • "group": "apps",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "categoryName": "Build",
  • "priorityName": "medium",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "resourceInterfaces": [
    ],
  • "clusterStatuses": [
    ]
}

Update a workload type by id.

Update the default category or priority assigned to a workload type.

SecuritybearerAuth
Request
path Parameters
workloadTypeId
required
string <uuid>

The unique identifier of the workload type.

Request Body schema: application/json
required

Workload type to update.

categoryId
string <uuid>

The unique identifier of the workload category.

priorityId
string <uuid>

The unique identifier of the workload priority.

Array of objects (WorkloadTypeResourceInterfaces) <= 4 items

Lists the versions of the custom resource definition (CRD) supported for this workload type, such as v1, v1beta1, or v1alpha1. This enables the platform to correctly parse, interpret, and manage manifests for this workload type according to the specific structure and schema associated with each listed version. On update, you may only add or remove supported versions, modifying existing version entries is not allowed.

Responses
200

Updated successfully

400

Bad request.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

503

unexpected error

put/api/v1/workload-types/{workloadTypeId}
Request samples
application/json
{
  • "categoryId": "337f5e5d-288b-40d5-be14-901cc3acacc0",
  • "priorityId": "a57eab25-838b-40cc-a576-57e4056f1d6c",
  • "resourceInterfaces": [
    ]
}
Response samples
application/json
{
  • "categoryId": "337f5e5d-288b-40d5-be14-901cc3acacc0",
  • "priorityId": "a57eab25-838b-40cc-a576-57e4056f1d6c",
  • "name": "Deployment",
  • "group": "apps",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "categoryName": "Build",
  • "priorityName": "medium",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "updatedBy": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "resourceInterfaces": [
    ],
  • "clusterStatuses": [
    ]
}

Delete a workload type by id.

Deletes a specific workload type by its ID.

SecuritybearerAuth
Request
path Parameters
workloadTypeId
required
string <uuid>

The unique identifier of the workload type.

Responses
204

No Content.

401

Unauthorized

403

Forbidden

500

unexpected error

503

unexpected error

delete/api/v1/workload-types/{workloadTypeId}
Response samples
application/json
{
  • "code": 401,
  • "message": "Issuer is not familiar."
}

Get workload priorities.

Retrieve the list of all workload priorities available in the system

SecuritybearerAuth
Request
query Parameters
sortOrder
string
Default: "asc"

Sort results in descending or ascending order.

Enum: "asc" "desc"
sortBy
string

Defines the field to sort the results by

Enum: "name" "source" "value"
filterBy
Array of strings

Filter results by a parameter. Use the format field-name operator value. Operators are == Equals, != Not equals, <= Less than or equal, >= Greater than or equal, =@ contains, !@ Does not contains, =^ Starts with and =$ Ends with. Dates are in ISO 8601 timestamp format and available for operators ==, !=, <= and >=

Example: filterBy=name!=some-name
Responses
200

Request completed successfully.

400

Bad request.

401

Unauthorized

403

Forbidden

500

unexpected error

503

unexpected error

get/api/v1/workload-priorities
Response samples
application/json
{
  • "priorities": [
    ]
}
➔ Next to Workload templates