Version 2.19 has reached end of support. Upgrade to a newer supported version.
Ctrlk
Contact support
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Reports

Create a new report request.

post
Authorizations
AuthorizationstringRequired

Bearer authentication

Body
namestringRequiredExample: 2023 GPU report
startstring · date-timeRequired

timestamp from when to fetch data in UTC

Example: 2023-06-07 12:09:18.211
endstring · date-timeRequired

timestamp until when to fetch data in UTC

Example: 2023-06-07 12:09:18.211
groupBystring · enum · nullableOptionalPossible values:
filterBystring[]Optional

Filter results by a parameter. Use the format field-name == value.

Default: []Example: ["projectName==some-name"]
Responses
202

Accepted.

application/json
namestringRequiredExample: 2023 GPU report
startstring · date-timeRequired

timestamp from when to fetch data in UTC

Example: 2023-06-07 12:09:18.211
endstring · date-timeRequired

timestamp until when to fetch data in UTC

Example: 2023-06-07 12:09:18.211
groupBystring · enum · nullableOptionalPossible values:
filterBystring[]Optional

Filter results by a parameter. Use the format field-name == value.

Default: []Example: ["projectName==some-name"]
idstring · uuidRequired
createdAtstring · date-timeRequired
createdBystringRequiredExample: user@run.ai
tenantIdinteger · int32Required

ID of the tenant where the project is located.

Example: 2
statusstring · enumRequiredPossible values:
statusUpdatedAtstring · date-timeRequired
statusMessagestringOptionalExample: Report in queue
post/api/v1/org-unit/reports
POST /api/v1/org-unit/reports HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 151

{
  "name": "2023 GPU report",
  "start": "2023-06-07 12:09:18.211",
  "end": "2023-06-07 12:09:18.211",
  "groupBy": "Nodepool",
  "filterBy": [
    "projectName==some-name"
  ]
}
{
  "name": "2023 GPU report",
  "start": "2023-06-07 12:09:18.211",
  "end": "2023-06-07 12:09:18.211",
  "groupBy": "Nodepool",
  "filterBy": [
    "projectName==some-name"
  ],
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2026-01-01T00:00:00.000Z",
  "createdBy": "user@run.ai",
  "tenantId": 2,
  "status": "Pending",
  "statusUpdatedAt": "2026-01-01T00:00:00.000Z",
  "statusMessage": "Report in queue"
}

Get report

get
Authorizations
AuthorizationstringRequired

Bearer authentication

Path parameters
reportIdstring · uuidRequired

The report id

Example: 575c19e8-c7c3-45b0-8290-2f47397a8383
Responses
200

Executed successfully.

application/json
namestringRequiredExample: 2023 GPU report
startstring · date-timeRequired

timestamp from when to fetch data in UTC

Example: 2023-06-07 12:09:18.211
endstring · date-timeRequired

timestamp until when to fetch data in UTC

Example: 2023-06-07 12:09:18.211
groupBystring · enum · nullableOptionalPossible values:
filterBystring[]Optional

Filter results by a parameter. Use the format field-name == value.

Default: []Example: ["projectName==some-name"]
idstring · uuidRequired
createdAtstring · date-timeRequired
createdBystringRequiredExample: user@run.ai
tenantIdinteger · int32Required

ID of the tenant where the project is located.

Example: 2
statusstring · enumRequiredPossible values:
statusUpdatedAtstring · date-timeRequired
statusMessagestringOptionalExample: Report in queue
get/api/v1/org-unit/reports/{reportId}
GET /api/v1/org-unit/reports/{reportId} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "name": "2023 GPU report",
  "start": "2023-06-07 12:09:18.211",
  "end": "2023-06-07 12:09:18.211",
  "groupBy": "Nodepool",
  "filterBy": [
    "projectName==some-name"
  ],
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2026-01-01T00:00:00.000Z",
  "createdBy": "user@run.ai",
  "tenantId": 2,
  "status": "Pending",
  "statusUpdatedAt": "2026-01-01T00:00:00.000Z",
  "statusMessage": "Report in queue"
}

Delete report

delete
Authorizations
AuthorizationstringRequired

Bearer authentication

Path parameters
reportIdstring · uuidRequired

The report id

Example: 575c19e8-c7c3-45b0-8290-2f47397a8383
Responses
204

No Content.

No content
delete/api/v1/org-unit/reports/{reportId}
DELETE /api/v1/org-unit/reports/{reportId} HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Download report

get
Authorizations
AuthorizationstringRequired

Bearer authentication

Path parameters
reportIdstring · uuidRequired

The report id

Example: 575c19e8-c7c3-45b0-8290-2f47397a8383
Responses
200

Executed successfully.

text/csv
get/api/v1/org-unit/reports/{reportId}/file
GET /api/v1/org-unit/reports/{reportId}/file HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
PreviousDepartments
NextNodePools

Last updated