Projects

Projects implement resource allocation policies and create segregation between different initiatives. It can represent a team, an individual, or an initiative that shares resources or has a specific resources budget (quota). See Projects for more information.

Get projects

get

List projects

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:

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

nextintegerOptionalExample: 1

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

503

unexpected error

application/json

get

/api/v1/org-unit/projects

HTTPcURLJavaScriptPython

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

{
  "projects": [
    {
      "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"
        }
      },
      "id": 33,
      "name": "organization1",
      "clusterId": "71f69d83-ba66-4822-adf5-55ce55efd210",
      "parentId": "53a9228e-a722-420d-a102-9dc90da2efca",
      "requestedNamespace": "runai-proj1",
      "enforceRunaiScheduler": true,
      "status": {
        "namespace": "runai-proj1",
        "phase": "Creating",
        "phaseMessage": "Project is ready",
        "lastUpdatedTime": "2026-05-11T09:47:34.735Z",
        "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
          }
        },
        "additionalStatusData": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      },
      "totalResources": {
        "gpuQuota": 1,
        "cpuQuota": 1,
        "memoryQuota": 1
      },
      "createdAt": "2026-05-11T09:47:34.735Z",
      "updatedAt": "2026-05-11T09:47:34.735Z",
      "createdBy": "text",
      "updatedBy": "text",
      "parent": {
        "id": "9f55253e-11ed-47c7-acef-fc4054768dbc",
        "name": "organization1",
        "parent": {
          "id": "9f55253e-11ed-47c7-acef-fc4054768dbc",
          "name": "organization1",
          "parent": "[Circular Reference]"
        }
      },
      "effective": {
        "schedulingRules": {
          "interactiveJobTimeLimitSeconds": 100,
          "interactiveJobMaxIdleDurationSeconds": 100,
          "interactiveJobPreemptIdleDurationSeconds": 100,
          "trainingJobMaxIdleDurationSeconds": 100,
          "trainingJobTimeLimitSeconds": 100
        },
        "defaultNodePools": [
          "text"
        ],
        "nodeTypes": {
          "training": [
            "text"
          ],
          "workspace": [
            "text"
          ],
          "names": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          }
        }
      },
      "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": []
    }
  ],
  "next": 1
}

Create project

post

Create a project

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Body

application/json

Updatable fields

descriptionstringOptional

The description of the project.

defaultNodePoolsstring[] · nullableOptional

An ordered list of node pools that defines the default scheduling preference for workloads in this project. The Scheduler will attempt to schedule workloads on node pools in this order. This setting is enforced if no node pool list is defined in the workload policy.

namestringRequired

The unique name of the project within the cluster. Must be a valid Kubernetes name (lowercase, alphanumeric, hyphens allowed).

Example: organization1

clusterIdstring · uuidRequired

The id of the cluster.

Example: 71f69d83-ba66-4822-adf5-55ce55efd210

requestedNamespacestringOptional

The custom Kubernetes namespace name for the project. If not specified, a namespace will be auto-generated using the pattern runai-.

Example: runai-proj1

enforceRunaiSchedulerboolean · nullableOptional

When set to true, enforces that all pods in this project's namespace are scheduled using the NVIDIA Run:ai Scheduler (runai-scheduler). Supported for cluster version 2.21 and later.

Default: true

parentIdstring · nullableOptional

The ID of the parent department. When specified, the project is created as a child of this department and inherits its quota, the quota of other projects within the department and its scheduling rules.

Example: 35000

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/projects

HTTPcURLJavaScriptPython

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

{
  "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",
  "requestedNamespace": "runai-proj1",
  "enforceRunaiScheduler": true,
  "parentId": 35000,
  "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"
    }
  },
  "id": 33,
  "name": "organization1",
  "clusterId": "71f69d83-ba66-4822-adf5-55ce55efd210",
  "parentId": "53a9228e-a722-420d-a102-9dc90da2efca",
  "requestedNamespace": "runai-proj1",
  "enforceRunaiScheduler": true,
  "status": {
    "namespace": "runai-proj1",
    "phase": "Creating",
    "phaseMessage": "Project is ready",
    "lastUpdatedTime": "2026-05-11T09:47:34.735Z",
    "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
      }
    },
    "additionalStatusData": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  },
  "totalResources": {
    "gpuQuota": 1,
    "cpuQuota": 1,
    "memoryQuota": 1
  },
  "createdAt": "2026-05-11T09:47:34.735Z",
  "updatedAt": "2026-05-11T09:47:34.735Z",
  "createdBy": "text",
  "updatedBy": "text",
  "parent": {
    "id": "9f55253e-11ed-47c7-acef-fc4054768dbc",
    "name": "organization1",
    "parent": {
      "id": "9f55253e-11ed-47c7-acef-fc4054768dbc",
      "name": "organization1",
      "parent": {
        "id": "9f55253e-11ed-47c7-acef-fc4054768dbc",
        "name": "organization1",
        "parent": {
          "id": "9f55253e-11ed-47c7-acef-fc4054768dbc",
          "name": "organization1",
          "parent": "[Circular Reference]"
        }
      }
    }
  },
  "effective": {
    "schedulingRules": {
      "interactiveJobTimeLimitSeconds": 100,
      "interactiveJobMaxIdleDurationSeconds": 100,
      "interactiveJobPreemptIdleDurationSeconds": 100,
      "trainingJobMaxIdleDurationSeconds": 100,
      "trainingJobTimeLimitSeconds": 100
    },
    "defaultNodePools": [
      "text"
    ],
    "nodeTypes": {
      "training": [
        "text"
      ],
      "workspace": [
        "text"
      ],
      "names": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  },
  "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": []
}

Get project

get

Get a project by id

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

projectIdstringRequired

The project id

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

Responses

200

ok

application/json

Updatable fields

descriptionstringRequired

The description of the project.

defaultNodePoolsstring[] · nullableOptional

An ordered list of node pools that defines the default scheduling preference for workloads in this project. The Scheduler will attempt to schedule workloads on node pools in this order. This setting is enforced if no node pool list is defined in the workload policy.

idstringRequiredExample: 33

namestringRequiredExample: organization1

clusterIdstring · uuidRequired

The id of the cluster.

Example: 71f69d83-ba66-4822-adf5-55ce55efd210

parentIdstringRequired

department parent uuid

Example: 53a9228e-a722-420d-a102-9dc90da2efca

requestedNamespacestring · nullableOptional

the project's namespace only if requested

Example: runai-proj1

enforceRunaiSchedulerbooleanRequired

a flag to enforce that all pods in this namespace will be scheduled with runai-scheduler. Supported for cluster v2.21+

createdAtstring · date-timeRequired

updatedAtstring · date-timeRequired

createdBystringOptional

updatedBystringOptional

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/projects/{projectId}

HTTPcURLJavaScriptPython

GET /api/v1/org-unit/projects/{projectId} 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"
    }
  },
  "id": 33,
  "name": "organization1",
  "clusterId": "71f69d83-ba66-4822-adf5-55ce55efd210",
  "parentId": "53a9228e-a722-420d-a102-9dc90da2efca",
  "requestedNamespace": "runai-proj1",
  "enforceRunaiScheduler": true,
  "status": {
    "namespace": "runai-proj1",
    "phase": "Creating",
    "phaseMessage": "Project is ready",
    "lastUpdatedTime": "2026-05-11T09:47:34.735Z",
    "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
      }
    },
    "additionalStatusData": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  },
  "totalResources": {
    "gpuQuota": 1,
    "cpuQuota": 1,
    "memoryQuota": 1
  },
  "createdAt": "2026-05-11T09:47:34.735Z",
  "updatedAt": "2026-05-11T09:47:34.735Z",
  "createdBy": "text",
  "updatedBy": "text",
  "parent": {
    "id": "9f55253e-11ed-47c7-acef-fc4054768dbc",
    "name": "organization1",
    "parent": {
      "id": "9f55253e-11ed-47c7-acef-fc4054768dbc",
      "name": "organization1",
      "parent": {
        "id": "9f55253e-11ed-47c7-acef-fc4054768dbc",
        "name": "organization1",
        "parent": {
          "id": "9f55253e-11ed-47c7-acef-fc4054768dbc",
          "name": "organization1",
          "parent": "[Circular Reference]"
        }
      }
    }
  },
  "effective": {
    "schedulingRules": {
      "interactiveJobTimeLimitSeconds": 100,
      "interactiveJobMaxIdleDurationSeconds": 100,
      "interactiveJobPreemptIdleDurationSeconds": 100,
      "trainingJobMaxIdleDurationSeconds": 100,
      "trainingJobTimeLimitSeconds": 100
    },
    "defaultNodePools": [
      "text"
    ],
    "nodeTypes": {
      "training": [
        "text"
      ],
      "workspace": [
        "text"
      ],
      "names": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  },
  "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": []
}

Update project

put

Update project by Id

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

projectIdstringRequired

The project id

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

Body

application/json

Updatable fields

descriptionstringOptional

The description of the project.

defaultNodePoolsstring[] · nullableOptional

An ordered list of node pools that defines the default scheduling preference for workloads in this project. The Scheduler will attempt to schedule workloads on node pools in this order. This setting is enforced if no node pool list is defined in the workload policy.

enforceRunaiSchedulerboolean · nullableOptional

a flag to enforce that all pods in this namespace will be scheduled with runai-scheduler. Supported for cluster v2.21+

Responses

200

Updated

application/json

Updatable fields

descriptionstringRequired

The description of the project.

defaultNodePoolsstring[] · nullableOptional

An ordered list of node pools that defines the default scheduling preference for workloads in this project. The Scheduler will attempt to schedule workloads on node pools in this order. This setting is enforced if no node pool list is defined in the workload policy.

idstringRequiredExample: 33

namestringRequiredExample: organization1

clusterIdstring · uuidRequired

The id of the cluster.

Example: 71f69d83-ba66-4822-adf5-55ce55efd210

parentIdstringRequired

department parent uuid

Example: 53a9228e-a722-420d-a102-9dc90da2efca

requestedNamespacestring · nullableOptional

the project's namespace only if requested

Example: runai-proj1

enforceRunaiSchedulerbooleanRequired

a flag to enforce that all pods in this namespace will be scheduled with runai-scheduler. Supported for cluster v2.21+

createdAtstring · date-timeRequired

updatedAtstring · date-timeRequired

createdBystringOptional

updatedBystringOptional

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/projects/{projectId}

HTTPcURLJavaScriptPython

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

{
  "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"
    }
  },
  "enforceRunaiScheduler": true,
  "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"
    }
  },
  "id": 33,
  "name": "organization1",
  "clusterId": "71f69d83-ba66-4822-adf5-55ce55efd210",
  "parentId": "53a9228e-a722-420d-a102-9dc90da2efca",
  "requestedNamespace": "runai-proj1",
  "enforceRunaiScheduler": true,
  "status": {
    "namespace": "runai-proj1",
    "phase": "Creating",
    "phaseMessage": "Project is ready",
    "lastUpdatedTime": "2026-05-11T09:47:34.735Z",
    "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
      }
    },
    "additionalStatusData": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  },
  "totalResources": {
    "gpuQuota": 1,
    "cpuQuota": 1,
    "memoryQuota": 1
  },
  "createdAt": "2026-05-11T09:47:34.735Z",
  "updatedAt": "2026-05-11T09:47:34.735Z",
  "createdBy": "text",
  "updatedBy": "text",
  "parent": {
    "id": "9f55253e-11ed-47c7-acef-fc4054768dbc",
    "name": "organization1",
    "parent": {
      "id": "9f55253e-11ed-47c7-acef-fc4054768dbc",
      "name": "organization1",
      "parent": {
        "id": "9f55253e-11ed-47c7-acef-fc4054768dbc",
        "name": "organization1",
        "parent": {
          "id": "9f55253e-11ed-47c7-acef-fc4054768dbc",
          "name": "organization1",
          "parent": "[Circular Reference]"
        }
      }
    }
  },
  "effective": {
    "schedulingRules": {
      "interactiveJobTimeLimitSeconds": 100,
      "interactiveJobMaxIdleDurationSeconds": 100,
      "interactiveJobPreemptIdleDurationSeconds": 100,
      "trainingJobMaxIdleDurationSeconds": 100,
      "trainingJobTimeLimitSeconds": 100
    },
    "defaultNodePools": [
      "text"
    ],
    "nodeTypes": {
      "training": [
        "text"
      ],
      "workspace": [
        "text"
      ],
      "names": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  },
  "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": []
}

Delete project

delete

Delete a project

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

projectIdstringRequired

The project id

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

Responses

202

Accepted

204

Deleted

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

delete

/api/v1/org-unit/projects/{projectId}

HTTPcURLJavaScriptPython

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

No content

Update project resources

put

Update projects resources

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

projectIdstringRequired

The project id

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

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

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

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/projects/{projectId}/resources

HTTPcURLJavaScriptPython

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

[]

[]

Patch project 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

projectIdstringRequired

The project id

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

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

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

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

patch

/api/v1/org-unit/projects/{projectId}/resources

HTTPcURLJavaScriptPython

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

[]

[]

Get project metrics data.

get

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

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

projectIdstringRequired

The project id

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

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/projects/{projectId}/metrics

HTTPcURLJavaScriptPython

GET /api/v1/org-unit/projects/{projectId}/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 projects telemetry

get

Get projects telemetry data by the given query parameters

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

nodepoolIdstringOptional

Filter using the nodepool.

Example: 1

departmentIdstringOptional

Filter using the department id.

Example: 1

telemetryTypestring · enumRequired

Select a telemetry type.

Possible values:

Responses

200

Executed successfully.

application/json

typestringRequired

specifies what data returned

Example: ALLOCATION_RATIO

timestampstring · date-timeRequiredExample: 2023-06-06 12:09:18.211

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

503

unexpected error

application/json

get

/api/v1/org-unit/projects/telemetry

HTTPcURLJavaScriptPython

GET /api/v1/org-unit/projects/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 projects

get

count projects

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"]

searchstringOptional

Filter results by a free text search.

Example: test project

Responses

200

ok

application/json

countinteger · int64RequiredExample: 1

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

503

unexpected error

application/json

get

/api/v1/org-unit/projects/count

HTTPcURLJavaScriptPython

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

{
  "count": 1
}

Get projects node pool resources

get

List projects 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

nextintegerOptionalExample: 1

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

503

unexpected error

application/json

get

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

HTTPcURLJavaScriptPython

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

{
  "nodePoolResources": [
    {
      "id": "text",
      "orgUnitId": "text",
      "orgUnitName": "organization1",
      "parentId": "text",
      "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"
        }
      },
      "quotaStatus": {
        "allocated": {
          "gpu": 0,
          "cpu": 1000,
          "memory": 1000
        },
        "allocatedNonPreemptible": {
          "gpu": 0,
          "cpu": 1000,
          "memory": 1000
        },
        "requested": {
          "gpu": 0,
          "cpu": 1000,
          "memory": 1000
        }
      }
    }
  ],
  "next": 1
}

Count projects node pool resources

get

Count projects 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

countinteger · int64RequiredExample: 1

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

503

unexpected error

application/json

get

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

HTTPcURLJavaScriptPython

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

{
  "count": 1
}

Patch multiple projects node pool resources in batch.

post

Partially updates node pool resource quotas for multiple projects 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

idstring · uuidRequired

The unique ID of the batch operation.

totalRequestedintegerRequired

Total number of items requested in the batch.

totalSuccessfulintegerRequired

Number of items successfully processed.

totalFailedintegerRequired

Number of items that failed.

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/projects/node-pool-resources/batch-patch

HTTPcURLJavaScriptPython

POST /api/v1/org-unit/projects/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",
      "parentId": "8755",
      "resources": [
        {
          "gpu": {
            "deserved": 2,
            "limit": 2,
            "overQuotaWeight": 2
          }
        }
      ]
    }
  ],
  "failed": [
    {
      "payload": {
        "orgUnitId": "577",
        "nodePoolId": "12",
        "resources": [
          {
            "gpu": {
              "deserved": 2,
              "limit": 2,
              "overQuotaWeight": 2
            }
          }
        ]
      },
      "code": 400,
      "message": "bad request"
    }
  ],
  "totalRequested": 2,
  "totalSuccessful": 1,
  "totalFailed": 1
}