NVIDIA Run:ai

Workload properties

Workload types are used to define the configuration of workloads in the NVIDIA Run:ai platform. Each workload type has a unique name and is associated with a specific category and priority. Workload types can be used to create new workloads or update existing ones.

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 workload types.

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": [
    ]
}

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
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "categoryName": "Build",
  • "priorityName": "medium",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "updatedBy": "string"
}

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.

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"
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "categoryName": "Build",
  • "priorityName": "medium",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "updatedBy": "string"
}

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