NVIDIA Run:ai Departments API

Departments, in the hierarchy of resource allocation, are above Projects. A Department can contain multiple Projects, and has its own quotas. A Department's quota supersedes the total of the Project quotas in the Department, so tt is recommended that a Department's quota be the total, or more than of all the Project quotas in the Department. For further information see, [Working with Departments](https://run-ai-docs.nvidia.com/saas/platform-management/aiinitiatives/organization/departments).

Documentation Provider Profile APIs.io OpenAPI GitHub

NVIDIA Run:ai Departments API is one of 62 APIs that NVIDIA Run:ai publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Departments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 14 operations across 10 paths, and defines 63 schemas. It is described by OpenAPI 3.0.3, at version latest.

Requests are made against a single base URL, https://app.run.ai.

14 operations 10 paths 63 schemas 1 DELETE8 GET1 PATCH1 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification

OpenAPI 3.0.3

API Version

latest

Base URL

https://app.run.ai

Authentication

HTTP Bearer

License

NVIDIA Run:ai

Resource Areas

Authentication & Security 1

NVIDIA Run:ai Departments API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

bearerAuth — Bearer authentication

Paths & Operations 14

Across 10 paths, the API surfaces 14 operations — 1 DELETE, 8 GET, 1 PATCH, 1 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Departments 14

Departments, in the hierarchy of resource allocation, are above Projects. A Department can contain multiple Projects, and has its own quotas. A Department's quota supersedes the t…

POST

/api/v1/org-unit/departments

Create department

create_department body → 201400401403409503

GET

/api/v1/org-unit/departments

Get departments

get_departments 6 params → 200400401403503

PUT

/api/v1/org-unit/departments/{departmentId}

Update department

update_department 1 param body → 200400401403404503

GET

/api/v1/org-unit/departments/{departmentId}

Get department

get_department 1 param → 200401403404503

DELETE

/api/v1/org-unit/departments/{departmentId}

Delete department

delete_department 1 param → 204400401403404503

PUT

/api/v1/org-unit/departments/{departmentId}/resources

Update department resources

update_department_resources 1 param body → 200400401403404500503

PATCH

/api/v1/org-unit/departments/{departmentId}/resources

Patch department resources

patch_department_resources 1 param body → 200400401403404500503

GET

/api/v1/org-unit/departments/{departmentId}/metrics

Get department metrics data.

get_department_metrics 6 params → 200207400401403404500503

GET

/api/v1/org-unit/departments/telemetry

Get departments telemetry

get_departments_telemetry 5 params → 200400401403503

GET

/api/v1/org-unit/departments/count

Count departments

count_departments 1 param → 200400401403503

GET

/v1/k8s/clusters/{clusterUuid}/departments/metricsdeprecated

Get metrics for all departments.

getDepartmentsMetrics 5 params → 200401403404500503

GET

/v1/k8s/clusters/{clusterUuid}/departments/{departmentId}/metricsdeprecated

Get metrics for a specific department.

getDepartmentMetrics 6 params → 200401403404500503

GET

/v1/k8s/clusters/{clusterId}/departmentsdeprecated

List all departments.

getDepartments 3 params → 200

PUT

/v1/k8s/clusters/{clusterId}/departments/{department-id}/access-controldeprecated

Set the department admins.

updateDepartmentAdmins 2 params body → 201400401403

Schemas 63

The contract defines 63 schemas that model the data the API accepts and returns. The most detailed are ProjectCommonFields (12 properties), Resources (5 properties), ResourcesNullable (5 properties), DepartmentCommonFields (5 properties). Each schema is shown below with its type and property counts.

NodePoolsQuotaStatuses

array

The current quota status for each node pool. Supported only for cluster versions 2.15+ or higher.

Resource

object

3 properties

Verbosity

string

Error

object

3 properties 2 required

units

string

ProjectName1

string

DepartmentForList

DataUpdatableDepartmentFields

object

Updatable fields

4 properties 1 required

TelemetryResponse

object

3 properties 3 required

ClusterId

string

The id of the cluster.

ResourcesDataOvertime

Project2

NodePoolAssignedResourcesCreate

object

4 properties 1 required

AggregatedResources

object

Sum of all resources assigned to the projects under this department per Node Pool

4 properties 1 required

MeasurementResponse

object

3 properties 2 required

departments

object

2 properties 1 required

OvertimeRangeData

object

Average data for the specified time range, or for the lifetime of the project/department if it exists for less than the time range.

4 properties

Department1

object

3 properties 2 required

CountResponse

object

1 property 1 required

ClusterName

string

AssignedResources

object

4 properties

ResourceData

object

quota equals to the given resources and allocated equal to the real count of used resources

3 properties 2 required

NodePoolAssignedResources

1 required

SchedulingRules

object

5 properties

Resource1

object

3 properties

NodepoolName

string

DepartmentCreationRequest

OrgUnitMetricType

string

Specify which metric data to request.

ProjectStatus1

object

3 properties

NodeTypesPerWorkload

object

3 properties

OvertimeData

object

3 properties

QuotaStatusResourceList

object

3 properties

JobsNodeAffinity

object

2 properties

DepartmentAccessControl

object

2 properties

DepartmentProjectChild

object

Department or project child

3 properties 2 required

NodePoolResources

object

2 properties 1 required

ResourcesNullable

object

5 properties

NodeTypeForProject

object

2 properties

TotalResources

object

3 properties

QuotaStatusResource

object

3 properties

OrgUnitTelemetryType

string

Select a telemetry type.

QuotaStatus

object

Sum of all quota statuses of all the node pools

3 properties

NodePoolQuotaStatus

object

4 properties

Department

NonNullResource

object

3 properties

TimeRange

object

Overtime metrics data. Returned only if both start and end query parameters are set.

1 property 1 required

QuotaStatusNodePool

DeservedResource

object

1 property

MetricsResponse

object

1 property 1 required

DepartmentCommonFields

object

5 properties

NodeAffinity

object

2 properties

Department2

DepartmentId

integer

The id of the department

DataDepartmentFields

DepartmentFilterSortFields

string

DepartmentName

string

ResourcePermissions

object

3 properties

ResourcesData

object

4 properties 4 required

ResourcesUpdateRequest

array

Resources assigned to this Project per Node Pool

department

object

3 properties 2 required

Resources

object

5 properties 1 required

DepartmentUpdateRequest

ProjectCommonFields

object

12 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

Other APIs NVIDIA Run:ai publishes across the network.

NVIDIA Run:ai Access Keys API

AE Profile APIs.io

NVIDIA Run:ai Access rules API

AE Profile APIs.io

NVIDIA Run:ai Administrator Command Line Interface API

AE Profile APIs.io

NVIDIA Run:ai AI Applications API

AE Profile APIs.io

NVIDIA Run:ai Applications API

AE Profile APIs.io

NVIDIA Run:ai AuditLogs API

AE Profile APIs.io

NVIDIA Run:ai Clusters API

AE Profile APIs.io

NVIDIA Run:ai Compute API

AE Profile APIs.io

NVIDIA Run:ai ConfigMap API

AE Profile APIs.io

NVIDIA Run:ai Credentials API

AE Profile APIs.io

NVIDIA Run:ai Datasources API

AE Profile APIs.io

NVIDIA Run:ai Datavolumes API

AE Profile APIs.io

#Departments

← Back to N APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

NVIDIA Run:ai Departments API

Metadata

Authentication & Security 1

Paths & Operations 14

Schemas 63

Specification

Source

API Details

Provider

Explore more

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

NVIDIA Run:ai Departments API

Metadata

Authentication & Security 1

Paths & Operations 14

Schemas 63

Specification

Source

More from NVIDIA Run:ai 12

API Details

Provider

Explore more