Skip to navigation
REST APIWorkloadsWorkload Properties

Get workload category by id.

View as Markdown

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.

Authentication

AuthorizationBearer
Bearer authentication

Path parameters

categoryIdstringRequiredformat: "uuid"
The unique identifier of the workload category.

Response

Category retrieved successfully
idstringformat: "uuid"
The unique identifier of the workload category.
namestring

A unique, human-readable name for the workload category.

descriptionstringOptional
An optional description providing additional details about the category.
createdAtdatetimeOptional
The date and time when the workload category was created.
createdBystringOptional
The user who created the workload category.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
503
Service Unavailable Error