Departments

Get departments

get

list departments

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Query parameters

filterBystring[]Optional

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: ["name!=some-name"]

sortBystring · enumOptional

Sort results by a parameters.

Possible values:

verbositystring · enumOptional

Departments verbosity. If it is set to "verbose", status will be returned. If it is not defined or set to "brief" only unit specific data will be returned.

Example: verbosePossible values:

sortOrderstring · enumOptional

Sort results in descending or ascending order.

Default: ascPossible values:

offsetinteger · int32Optional

The offset of the first item returned in the collection.

Example: 100

limitinteger · int32 · min: 1 · max: 500Optional

The maximum number of entries to return.

Default: 50

Responses

200

ok

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

503

unexpected error

application/json

get

/api/v1/org-unit/departments

HTTPcURLJavaScriptPython

GET /api/v1/org-unit/departments HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "departments": [
    {
      "description": "text",
      "schedulingRules": {
        "interactiveJobTimeLimitSeconds": 100,
        "interactiveJobMaxIdleDurationSeconds": 100,
        "interactiveJobPreemptIdleDurationSeconds": 100,
        "trainingJobMaxIdleDurationSeconds": 100,
        "trainingJobTimeLimitSeconds": 100
      },
      "defaultNodePools": [
        "text"
      ],
      "nodeTypes": {
        "training": [
          "text"
        ],
        "workspace": [
          "text"
        ],
        "names": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      },
      "name": "organization1",
      "clusterId": "71f69d83-ba66-4822-adf5-55ce55efd210",
      "overtimeData": {
        "range24hData": {
          "averageGpuAllocation": 10,
          "averageGpuUtilization": 95,
          "averageGpuMemoryUtilization": 95,
          "updatedAt": "2021-08-01T00:00:00Z"
        },
        "range7dData": {
          "averageGpuAllocation": 10,
          "averageGpuUtilization": 95,
          "averageGpuMemoryUtilization": 95,
          "updatedAt": "2021-08-01T00:00:00Z"
        },
        "range30dData": {
          "averageGpuAllocation": 10,
          "averageGpuUtilization": 95,
          "averageGpuMemoryUtilization": 95,
          "updatedAt": "2021-08-01T00:00:00Z"
        }
      }
    },
    {
      "id": 50,
      "createdAt": "2026-02-05T00:15:46.475Z",
      "updatedAt": "2026-02-05T00:15:46.475Z",
      "createdBy": "text",
      "updatedBy": "text",
      "children": [
        {
          "id": "9f55253e-11ed-47c7-acef-fc4054768dbc",
          "name": "organization1",
          "children": [
            "[Circular Reference]"
          ]
        }
      ],
      "status": {
        "quotaStatus": {
          "allocated": {
            "gpu": 0,
            "cpu": 1000,
            "memory": 1000
          },
          "allocatedNonPreemptible": {
            "gpu": 0,
            "cpu": 1000,
            "memory": 1000
          },
          "requested": {
            "gpu": 0,
            "cpu": 1000,
            "memory": 1000
          }
        }
      },
      "totalResources": {
        "gpuQuota": 1,
        "cpuQuota": 1,
        "memoryQuota": 1
      },
      "resources": []
    }
  ],
  "next": 1
}

Create department

post

Create Department

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Body

application/json

and

Responses

201

Created

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

409

The specified resource already exists

application/json

503

unexpected error

application/json

post

/api/v1/org-unit/departments

HTTPcURLJavaScriptPython

POST /api/v1/org-unit/departments HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 888

{
  "description": "text",
  "schedulingRules": {
    "interactiveJobTimeLimitSeconds": 100,
    "interactiveJobMaxIdleDurationSeconds": 100,
    "interactiveJobPreemptIdleDurationSeconds": 100,
    "trainingJobMaxIdleDurationSeconds": 100,
    "trainingJobTimeLimitSeconds": 100
  },
  "defaultNodePools": [
    "text"
  ],
  "nodeTypes": {
    "training": [
      "text"
    ],
    "workspace": [
      "text"
    ],
    "names": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "name": "organization1",
  "clusterId": "71f69d83-ba66-4822-adf5-55ce55efd210",
  "overtimeData": {
    "range24hData": {
      "averageGpuAllocation": 10,
      "averageGpuUtilization": 95,
      "averageGpuMemoryUtilization": 95,
      "updatedAt": "2021-08-01T00:00:00Z"
    },
    "range7dData": {
      "averageGpuAllocation": 10,
      "averageGpuUtilization": 95,
      "averageGpuMemoryUtilization": 95,
      "updatedAt": "2021-08-01T00:00:00Z"
    },
    "range30dData": {
      "averageGpuAllocation": 10,
      "averageGpuUtilization": 95,
      "averageGpuMemoryUtilization": 95,
      "updatedAt": "2021-08-01T00:00:00Z"
    }
  },
  "resources": []
}

{
  "description": "text",
  "schedulingRules": {
    "interactiveJobTimeLimitSeconds": 100,
    "interactiveJobMaxIdleDurationSeconds": 100,
    "interactiveJobPreemptIdleDurationSeconds": 100,
    "trainingJobMaxIdleDurationSeconds": 100,
    "trainingJobTimeLimitSeconds": 100
  },
  "defaultNodePools": [
    "text"
  ],
  "nodeTypes": {
    "training": [
      "text"
    ],
    "workspace": [
      "text"
    ],
    "names": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "name": "organization1",
  "clusterId": "71f69d83-ba66-4822-adf5-55ce55efd210",
  "overtimeData": {
    "range24hData": {
      "averageGpuAllocation": 10,
      "averageGpuUtilization": 95,
      "averageGpuMemoryUtilization": 95,
      "updatedAt": "2021-08-01T00:00:00Z"
    },
    "range7dData": {
      "averageGpuAllocation": 10,
      "averageGpuUtilization": 95,
      "averageGpuMemoryUtilization": 95,
      "updatedAt": "2021-08-01T00:00:00Z"
    },
    "range30dData": {
      "averageGpuAllocation": 10,
      "averageGpuUtilization": 95,
      "averageGpuMemoryUtilization": 95,
      "updatedAt": "2021-08-01T00:00:00Z"
    }
  },
  "id": 50,
  "createdAt": "2026-02-05T00:15:46.475Z",
  "updatedAt": "2026-02-05T00:15:46.475Z",
  "createdBy": "text",
  "updatedBy": "text",
  "children": [
    {
      "id": "9f55253e-11ed-47c7-acef-fc4054768dbc",
      "name": "organization1",
      "children": [
        {
          "id": "9f55253e-11ed-47c7-acef-fc4054768dbc",
          "name": "organization1",
          "children": "[Circular Reference]"
        }
      ]
    }
  ],
  "projectsAggregatedResources": [
    {
      "nodePool": {
        "id": 22,
        "name": "default"
      },
      "gpu": {
        "deserved": 1000
      },
      "cpu": {
        "deserved": 1000
      },
      "memory": {
        "deserved": 1000,
        "units": "Mib"
      }
    }
  ],
  "status": {
    "nodePoolQuotaStatuses": [
      {
        "allocated": {
          "gpu": 0,
          "cpu": 1000,
          "memory": 1000
        },
        "allocatedNonPreemptible": {
          "gpu": 0,
          "cpu": 1000,
          "memory": 1000
        },
        "requested": {
          "gpu": 0,
          "cpu": 1000,
          "memory": 1000
        },
        "nodePoolName": "text",
        "nodePoolId": "text"
      }
    ],
    "quotaStatus": {
      "allocated": {
        "gpu": 0,
        "cpu": 1000,
        "memory": 1000
      },
      "allocatedNonPreemptible": {
        "gpu": 0,
        "cpu": 1000,
        "memory": 1000
      },
      "requested": {
        "gpu": 0,
        "cpu": 1000,
        "memory": 1000
      }
    }
  },
  "totalResources": {
    "gpuQuota": 1,
    "cpuQuota": 1,
    "memoryQuota": 1
  },
  "resources": []
}

Get department

get

Get department by Id

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

departmentIdstringRequired

The id of the department.

Example: 1Pattern: .*

Responses

200

ok

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

503

unexpected error

application/json

get

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

HTTPcURLJavaScriptPython

GET /api/v1/org-unit/departments/{departmentId} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "description": "text",
  "schedulingRules": {
    "interactiveJobTimeLimitSeconds": 100,
    "interactiveJobMaxIdleDurationSeconds": 100,
    "interactiveJobPreemptIdleDurationSeconds": 100,
    "trainingJobMaxIdleDurationSeconds": 100,
    "trainingJobTimeLimitSeconds": 100
  },
  "defaultNodePools": [
    "text"
  ],
  "nodeTypes": {
    "training": [
      "text"
    ],
    "workspace": [
      "text"
    ],
    "names": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "name": "organization1",
  "clusterId": "71f69d83-ba66-4822-adf5-55ce55efd210",
  "overtimeData": {
    "range24hData": {
      "averageGpuAllocation": 10,
      "averageGpuUtilization": 95,
      "averageGpuMemoryUtilization": 95,
      "updatedAt": "2021-08-01T00:00:00Z"
    },
    "range7dData": {
      "averageGpuAllocation": 10,
      "averageGpuUtilization": 95,
      "averageGpuMemoryUtilization": 95,
      "updatedAt": "2021-08-01T00:00:00Z"
    },
    "range30dData": {
      "averageGpuAllocation": 10,
      "averageGpuUtilization": 95,
      "averageGpuMemoryUtilization": 95,
      "updatedAt": "2021-08-01T00:00:00Z"
    }
  },
  "id": 50,
  "createdAt": "2026-02-05T00:15:46.475Z",
  "updatedAt": "2026-02-05T00:15:46.475Z",
  "createdBy": "text",
  "updatedBy": "text",
  "children": [
    {
      "id": "9f55253e-11ed-47c7-acef-fc4054768dbc",
      "name": "organization1",
      "children": [
        {
          "id": "9f55253e-11ed-47c7-acef-fc4054768dbc",
          "name": "organization1",
          "children": "[Circular Reference]"
        }
      ]
    }
  ],
  "projectsAggregatedResources": [
    {
      "nodePool": {
        "id": 22,
        "name": "default"
      },
      "gpu": {
        "deserved": 1000
      },
      "cpu": {
        "deserved": 1000
      },
      "memory": {
        "deserved": 1000,
        "units": "Mib"
      }
    }
  ],
  "status": {
    "nodePoolQuotaStatuses": [
      {
        "allocated": {
          "gpu": 0,
          "cpu": 1000,
          "memory": 1000
        },
        "allocatedNonPreemptible": {
          "gpu": 0,
          "cpu": 1000,
          "memory": 1000
        },
        "requested": {
          "gpu": 0,
          "cpu": 1000,
          "memory": 1000
        },
        "nodePoolName": "text",
        "nodePoolId": "text"
      }
    ],
    "quotaStatus": {
      "allocated": {
        "gpu": 0,
        "cpu": 1000,
        "memory": 1000
      },
      "allocatedNonPreemptible": {
        "gpu": 0,
        "cpu": 1000,
        "memory": 1000
      },
      "requested": {
        "gpu": 0,
        "cpu": 1000,
        "memory": 1000
      }
    }
  },
  "totalResources": {
    "gpuQuota": 1,
    "cpuQuota": 1,
    "memoryQuota": 1
  },
  "resources": []
}

Update department

put

Update department by Id

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

departmentIdstringRequired

The id of the department.

Example: 1Pattern: .*

Body

application/json

and

Responses

200

Updated

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

503

unexpected error

application/json

put

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

HTTPcURLJavaScriptPython

PUT /api/v1/org-unit/departments/{departmentId} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 384

{
  "description": "text",
  "schedulingRules": {
    "interactiveJobTimeLimitSeconds": 100,
    "interactiveJobMaxIdleDurationSeconds": 100,
    "interactiveJobPreemptIdleDurationSeconds": 100,
    "trainingJobMaxIdleDurationSeconds": 100,
    "trainingJobTimeLimitSeconds": 100
  },
  "defaultNodePools": [
    "text"
  ],
  "nodeTypes": {
    "training": [
      "text"
    ],
    "workspace": [
      "text"
    ],
    "names": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "resources": []
}

{
  "description": "text",
  "schedulingRules": {
    "interactiveJobTimeLimitSeconds": 100,
    "interactiveJobMaxIdleDurationSeconds": 100,
    "interactiveJobPreemptIdleDurationSeconds": 100,
    "trainingJobMaxIdleDurationSeconds": 100,
    "trainingJobTimeLimitSeconds": 100
  },
  "defaultNodePools": [
    "text"
  ],
  "nodeTypes": {
    "training": [
      "text"
    ],
    "workspace": [
      "text"
    ],
    "names": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "name": "organization1",
  "clusterId": "71f69d83-ba66-4822-adf5-55ce55efd210",
  "overtimeData": {
    "range24hData": {
      "averageGpuAllocation": 10,
      "averageGpuUtilization": 95,
      "averageGpuMemoryUtilization": 95,
      "updatedAt": "2021-08-01T00:00:00Z"
    },
    "range7dData": {
      "averageGpuAllocation": 10,
      "averageGpuUtilization": 95,
      "averageGpuMemoryUtilization": 95,
      "updatedAt": "2021-08-01T00:00:00Z"
    },
    "range30dData": {
      "averageGpuAllocation": 10,
      "averageGpuUtilization": 95,
      "averageGpuMemoryUtilization": 95,
      "updatedAt": "2021-08-01T00:00:00Z"
    }
  },
  "id": 50,
  "createdAt": "2026-02-05T00:15:46.475Z",
  "updatedAt": "2026-02-05T00:15:46.475Z",
  "createdBy": "text",
  "updatedBy": "text",
  "children": [
    {
      "id": "9f55253e-11ed-47c7-acef-fc4054768dbc",
      "name": "organization1",
      "children": [
        {
          "id": "9f55253e-11ed-47c7-acef-fc4054768dbc",
          "name": "organization1",
          "children": "[Circular Reference]"
        }
      ]
    }
  ],
  "projectsAggregatedResources": [
    {
      "nodePool": {
        "id": 22,
        "name": "default"
      },
      "gpu": {
        "deserved": 1000
      },
      "cpu": {
        "deserved": 1000
      },
      "memory": {
        "deserved": 1000,
        "units": "Mib"
      }
    }
  ],
  "status": {
    "nodePoolQuotaStatuses": [
      {
        "allocated": {
          "gpu": 0,
          "cpu": 1000,
          "memory": 1000
        },
        "allocatedNonPreemptible": {
          "gpu": 0,
          "cpu": 1000,
          "memory": 1000
        },
        "requested": {
          "gpu": 0,
          "cpu": 1000,
          "memory": 1000
        },
        "nodePoolName": "text",
        "nodePoolId": "text"
      }
    ],
    "quotaStatus": {
      "allocated": {
        "gpu": 0,
        "cpu": 1000,
        "memory": 1000
      },
      "allocatedNonPreemptible": {
        "gpu": 0,
        "cpu": 1000,
        "memory": 1000
      },
      "requested": {
        "gpu": 0,
        "cpu": 1000,
        "memory": 1000
      }
    }
  },
  "totalResources": {
    "gpuQuota": 1,
    "cpuQuota": 1,
    "memoryQuota": 1
  },
  "resources": []
}

Delete department

delete

Delete department by Id

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

departmentIdstringRequired

The id of the department.

Example: 1Pattern: .*

Responses

204

Deleted

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

503

unexpected error

application/json

delete

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

HTTPcURLJavaScriptPython

DELETE /api/v1/org-unit/departments/{departmentId} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update department resources

put

Update department resources by Id

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

departmentIdstringRequired

The id of the department.

Example: 1Pattern: .*

Bodyobject[]

application/json

Resources assigned to this Project per Node Pool

rankstring · nullableOptional

The scheduling rank of this org-unit within the node pool. Determines the scheduling order of workloads between org-units. Workloads in higher-ranked org-units are scheduled before workloads in lower-ranked org-units. For example, all workloads in rank "High" will be scheduled before all workloads in rank "Medium".

Default: MediumLowExample: High

prioritystring · nullableOptionalDeprecated

Deprecated. Use rank instead. The scheduling priority for workloads in this node pool.

Example: Normal

Responses

200

Updated

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

500

unexpected error

application/json

503

unexpected error

application/json

put

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

HTTPcURLJavaScriptPython

PUT /api/v1/org-unit/departments/{departmentId}/resources HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2

[]

[]

Patch department resources

patch

Partial updates to specific items in the list. Should be used for update one or more attributes of an item without modifying the entire resource.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

departmentIdstringRequired

The id of the department.

Example: 1Pattern: .*

Bodyobject[]

application/json

Resources assigned to this Project per Node Pool

rankstring · nullableOptional

The scheduling rank of this org-unit within the node pool. Determines the scheduling order of workloads between org-units. Workloads in higher-ranked org-units are scheduled before workloads in lower-ranked org-units. For example, all workloads in rank "High" will be scheduled before all workloads in rank "Medium".

Default: MediumLowExample: High

prioritystring · nullableOptionalDeprecated

Deprecated. Use rank instead. The scheduling priority for workloads in this node pool.

Example: Normal

Responses

200

Updated

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

500

unexpected error

application/json

503

unexpected error

application/json

patch

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

HTTPcURLJavaScriptPython

PATCH /api/v1/org-unit/departments/{departmentId}/resources HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 2

[]

[]

Get department metrics data.

get

Retrieves department data metrics from the metrics database. Use in reporting and analysis tools.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

departmentIdstringRequired

The id of the department.

Example: 1Pattern: .*

Query parameters

startstring · date-timeRequired

Start date of time range to fetch data in ISO 8601 timestamp format.

Example: 2023-06-06T12:09:18.211Z

endstring · date-timeRequired

End date of time range to fetch data in ISO 8601 timestamp format.

Example: 2023-06-07T12:09:18.211Z

numberOfSamplesinteger · max: 1000Optional

The number of samples to take in the specified time range.

Default: 20Example: 20

nodepoolNamestringOptional

Filter using the nodepool.

Example: default

Responses

200

Executed successfully.

application/jsontext/csv

207

Partial success.

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

500

unexpected error

application/json

503

unexpected error

application/json

get

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

HTTPcURLJavaScriptPython

GET /api/v1/org-unit/departments/{departmentId}/metrics?metricType=GPU_QUOTA&start=2023-06-06T12%3A09%3A18.211Z&end=2023-06-07T12%3A09%3A18.211Z HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "measurements": [
    {
      "type": "ALLOCATED_GPU",
      "labels": "{'gpu': '3'}",
      "values": [
        {
          "value": "85",
          "timestamp": "2023-06-06 12:09:18.211"
        }
      ]
    }
  ]
}

Get departments telemetry

get

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Query parameters

clusterIdstring · uuidOptional

Filter using the Universally Unique Identifier (UUID) of the cluster.

Example: d73a738f-fab3-430a-8fa3-5241493d7128

nodepoolNamestringOptional

Filter using the nodepool.

Example: default

departmentIdstringOptional

Filter using the department id.

Example: 1

telemetryTypestring · enumRequired

Select a telemetry type.

Possible values:

Responses

200

Executed successfully.

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

503

unexpected error

application/json

get

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

HTTPcURLJavaScriptPython

GET /api/v1/org-unit/departments/telemetry?telemetryType=GPU_QUOTA HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "type": "ALLOCATION_RATIO",
  "timestamp": "2023-06-06 12:09:18.211",
  "values": [
    {
      "value": "85",
      "groups": [
        {
          "key": "department",
          "value": "1",
          "name": "department-A"
        }
      ]
    }
  ]
}

Count departments

get

count departments

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Query parameters

filterBystring[]Optional

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: ["name!=some-name"]

Responses

200

ok

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

503

unexpected error

application/json

get

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

HTTPcURLJavaScriptPython

GET /api/v1/org-unit/departments/count HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "count": 1
}

Get departments node pool resources

get

List departments node pool resources

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Query parameters

filterBystring[]Optional

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: ["nodePoolName!=some-name"]

sortBystring · enumOptional

Sort results by a parameters.

Possible values:

sortOrderstring · enumOptional

Sort results in descending or ascending order.

Default: ascPossible values:

offsetinteger · int32Optional

The offset of the first item returned in the collection.

Example: 100

limitinteger · int32 · min: 1 · max: 500Optional

The maximum number of entries to return.

Default: 50

searchstringOptional

Filter results by a free text search.

Example: test project

Responses

200

ok

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

503

unexpected error

application/json

get

/api/v1/org-unit/departments/node-pool-resources

HTTPcURLJavaScriptPython

GET /api/v1/org-unit/departments/node-pool-resources HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "nodePoolResources": [
    {
      "id": "text",
      "orgUnitId": "text",
      "orgUnitName": "organization1",
      "clusterId": "text",
      "nodePoolId": "text",
      "nodePoolName": "text",
      "rank": "text",
      "resources": {
        "gpu": {
          "deserved": 1000,
          "limit": 0,
          "overQuotaWeight": 2
        },
        "cpu": {
          "deserved": 1000,
          "limit": 0,
          "overQuotaWeight": 2
        },
        "memory": {
          "deserved": 1000,
          "limit": 0,
          "overQuotaWeight": 2,
          "units": "Mib"
        }
      }
    }
  ],
  "next": 1
}

Count departments node pool resources

get

Count departments node pool resources

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Query parameters

filterBystring[]Optional

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: ["nodePoolName!=some-name"]

searchstringOptional

Filter results by a free text search.

Example: test project

Responses

200

ok

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

503

unexpected error

application/json

get

/api/v1/org-unit/departments/node-pool-resources/count

HTTPcURLJavaScriptPython

GET /api/v1/org-unit/departments/node-pool-resources/count HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "count": 1
}

Patch multiple departments node pool resources in batch.

post

Partially updates node pool resource quotas for multiple departments in a single request.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Body

application/json

Batch of node pool resources patch requests.

Responses

200

Batch patch processed. Returns succeeded and failed items with totals and a batch id.

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

unexpected error

application/json

503

unexpected error

application/json

post

/api/v1/org-unit/departments/node-pool-resources/batch-patch

HTTPcURLJavaScriptPython

POST /api/v1/org-unit/departments/node-pool-resources/batch-patch HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 244

{
  "patchRequests": [
    {
      "orgUnitId": "3845",
      "nodePoolId": "22",
      "rank": "Low",
      "resources": {
        "gpu": {
          "deserved": 2,
          "limit": 2,
          "overQuotaWeight": 2
        }
      }
    },
    {
      "orgUnitId": "27552",
      "nodePoolId": "33",
      "resources": {
        "cpu": {
          "deserved": 20,
          "limit": 20,
          "overQuotaWeight": 20
        }
      }
    }
  ]
}

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "succeeded": [
    {
      "orgUnitId": "435",
      "orgUnitName": "proj1",
      "nodePoolId": "12",
      "nodePoolName": "default",
      "resources": [
        {
          "gpu": {
            "deserved": 2,
            "limit": 2,
            "overQuotaWeight": 2
          }
        }
      ]
    }
  ],
  "failed": [
    {
      "payload": {
        "orgUnitId": "577",
        "nodePoolId": "12",
        "resources": [
          {
            "gpu": {
              "deserved": 2,
              "limit": 2,
              "overQuotaWeight": 2
            }
          }
        ]
      },
      "code": 404,
      "message": "department not found"
    }
  ],
  "totalRequested": 2,
  "totalSuccessful": 1,
  "totalFailed": 1
}

Deprecated

Get metrics for all departments.

get

Get metrics for all departments in the cluster. Use a time range to return historical data (optional). If you use a start date, an end date is required.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

clusterUuidstring · uuid · min: 1Required

The Universally Unique Identifier (UUID) of the cluster.

Example: 9f55255e-11ed-47c7-acef-fc4054768dbc

Query parameters

startstring · date-timeOptional

Start of time range to fetch data from in UTC format.

Example: 2023-06-06 12:09:18.211

endstring · date-timeOptional

End of time range to fetch data from in UTC format.

Example: 2023-06-07 12:09:18.211

numberOfSamplesinteger · max: 1000Optional

The number of samples to take in the specified time range.

Default: 20Example: 20

nodepoolNamestringOptional

Filter by unique nodepool name.

Example: default

Responses

200

Successfully retrieved metrics for all departments.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

500

unexpected error

application/json

503

unexpected error

application/json

get

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

HTTPcURLJavaScriptPython

GET /v1/k8s/clusters/{clusterUuid}/departments/metrics HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "metadata": {
        "departmentId": 8,
        "departmentName": "default",
        "clusterId": "71f69d83-ba66-4822-adf5-55ce55efd210",
        "clusterName": "cluster-a"
      },
      "current": {
        "resources": [
          {
            "numberOfPendingWorkloads": 1,
            "gpu": {
              "quota": 3,
              "allocated": 2.5,
              "utilization": 0.765
            },
            "cpu": {
              "quota": 3,
              "allocated": 2.5,
              "utilization": 0.765
            },
            "memory": {
              "quota": 3,
              "allocated": 2.5,
              "utilization": 0.765
            },
            "nodepoolName": "nodepoola"
          }
        ],
        "projectResources": [
          {
            "numberOfPendingWorkloads": 1,
            "gpu": {
              "quota": 3,
              "allocated": 2.5,
              "utilization": 0.765
            },
            "cpu": {
              "quota": 3,
              "allocated": 2.5,
              "utilization": 0.765
            },
            "memory": {
              "quota": 3,
              "allocated": 2.5,
              "utilization": 0.765
            },
            "projectName": "project-a",
            "nodepoolName": "nodepoola"
          }
        ]
      },
      "timeRange": null
    }
  ],
  "timeRange": {
    "resources": [
      {
        "numberOfPendingWorkloads": 1,
        "gpu": {
          "quota": 3,
          "allocated": 2.5,
          "utilization": 0.765
        },
        "cpu": {
          "quota": 3,
          "allocated": 2.5,
          "utilization": 0.765
        },
        "memory": {
          "quota": 3,
          "allocated": 2.5,
          "utilization": 0.765
        },
        "timestamp": "2023-06-06T12:09:18.211Z"
      }
    ]
  }
}

Deprecated

Get metrics for a specific department.

get

Get metrics for a specific department in the cluster. Use a time range to return historical data (optional). If you use a start date, an end date is required.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

clusterUuidstring · uuid · min: 1Required

The Universally Unique Identifier (UUID) of the cluster.

Example: 9f55255e-11ed-47c7-acef-fc4054768dbc

departmentIdstringRequired

The id of the department.

Example: 1Pattern: .*

Query parameters

startstring · date-timeOptional

Start of time range to fetch data from in UTC format.

Example: 2023-06-06 12:09:18.211

endstring · date-timeOptional

End of time range to fetch data from in UTC format.

Example: 2023-06-07 12:09:18.211

numberOfSamplesinteger · max: 1000Optional

The number of samples to take in the specified time range.

Default: 20Example: 20

nodepoolNamestringOptional

Filter by unique nodepool name.

Example: default

Responses

200

Successfully retrieved metrics for the department.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

The specified resource was not found

application/json

500

unexpected error

application/json

503

unexpected error

application/json

get

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

HTTPcURLJavaScriptPython

GET /v1/k8s/clusters/{clusterUuid}/departments/{departmentId}/metrics HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "metadata": {
    "departmentId": 8,
    "departmentName": "default",
    "clusterId": "71f69d83-ba66-4822-adf5-55ce55efd210",
    "clusterName": "cluster-a"
  },
  "current": {
    "resources": [
      {
        "numberOfPendingWorkloads": 1,
        "gpu": {
          "quota": 3,
          "allocated": 2.5,
          "utilization": 0.765
        },
        "cpu": {
          "quota": 3,
          "allocated": 2.5,
          "utilization": 0.765
        },
        "memory": {
          "quota": 3,
          "allocated": 2.5,
          "utilization": 0.765
        },
        "nodepoolName": "nodepoola"
      }
    ],
    "projectResources": [
      {
        "numberOfPendingWorkloads": 1,
        "gpu": {
          "quota": 3,
          "allocated": 2.5,
          "utilization": 0.765
        },
        "cpu": {
          "quota": 3,
          "allocated": 2.5,
          "utilization": 0.765
        },
        "memory": {
          "quota": 3,
          "allocated": 2.5,
          "utilization": 0.765
        },
        "projectName": "project-a",
        "nodepoolName": "nodepoola"
      }
    ]
  },
  "timeRange": {
    "resources": [
      {
        "numberOfPendingWorkloads": 1,
        "gpu": {
          "quota": 3,
          "allocated": 2.5,
          "utilization": 0.765
        },
        "cpu": {
          "quota": 3,
          "allocated": 2.5,
          "utilization": 0.765
        },
        "memory": {
          "quota": 3,
          "allocated": 2.5,
          "utilization": 0.765
        },
        "timestamp": "2023-06-06T12:09:18.211Z"
      }
    ]
  }
}

Deprecated

List all departments.

get

List all the departments managed by the tenant on a specific cluster.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

clusterIdstringRequired

The Universally Unique Identifier (UUID) of the cluster.

Example: 9f55255e-11ed-47c7-acef-fc4054768dbc

Query parameters

excludePermissionsbooleanOptional

Backward compatibility of the departmentAdmins field. If true, the departmentAdmins field in the returned departments is not set. If false, the departmentAdmins is set in the returned departments.

Example: true

memoryUnitMbbooleanOptional

Memory returned in MB. When set to false (default) memory will be returned in MiB.

Example: true

Responses

200

Successfully retrieved a list of Departments.

application/json

get

/v1/k8s/clusters/{clusterId}/departments

HTTPcURLJavaScriptPython

GET /v1/k8s/clusters/{clusterId}/departments HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successfully retrieved a list of Departments.

[
  {
    "nodePoolsResources": [
      {
        "id": 1
      },
      {
        "nodePool": {
          "id": 3,
          "name": "default"
        },
        "gpu": {
          "deserved": 0,
          "maxAllowed": 1000,
          "overQuotaWeight": 2
        },
        "cpu": {
          "deserved": 0,
          "maxAllowed": 1000,
          "overQuotaWeight": 2
        },
        "memory": {
          "deserved": 0,
          "maxAllowed": 1000,
          "overQuotaWeight": 2
        }
      }
    ],
    "tenantId": 42,
    "clusterUuid": "UUID",
    "createdAt": "2021-12-14T16:04:15.099Z",
    "id": 2,
    "projects": [
      {
        "id": 16,
        "name": "team-a",
        "deserved_gpus": 3
      }
    ],
    "departmentAdmins": [
      "text"
    ]
  },
  {
    "name": "default"
  }
]

Deprecated

Set the department admins.

put

Deprecated. Instead, use the accessrules API to add the department-admin permissions to a specific subject.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

clusterIdstringRequired

The unique uuid identifying the cluster.

Example: 9f55255e-11ed-47c7-acef-fc4054768dbc

department-idintegerRequired

The unique id identifying the department.

Example: 2

Body

application/json

departmentIdinteger · int32Optional

The unique id identifying the department.

Example: 2

departmentAdminsstring[]Optional

Id's of users with department admin role that are assigned to managed the department

Responses

201

Department admin set successfully.

application/json

400

Bad request.

application/json

401

Unauthenticated

application/json

403

Forbidden

application/json

put

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

HTTPcURLJavaScriptPython

PUT /v1/k8s/clusters/{clusterId}/departments/{department-id}/access-control HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 46

{
  "departmentId": 2,
  "departmentAdmins": [
    "text"
  ]
}

{
  "departmentId": 2,
  "departmentAdmins": [
    "text"
  ]
}