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

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/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"
        }
      },
      "resources": [],
      "name": "organization1",
      "clusterId": "71f69d83-ba66-4822-adf5-55ce55efd210",
      "id": 33,
      "parentId": "53a9228e-a722-420d-a102-9dc90da2efca",
      "requestedNamespace": "runai-proj1",
      "status": {
        "namespace": "runai-proj1",
        "phase": "Creating",
        "phaseMessage": "Project is ready",
        "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-02-08T07:14:02.555Z",
      "updatedAt": "2026-02-08T07:14:02.555Z",
      "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,
          "updatedAt": "2021-08-01T00:00:00Z"
        },
        "range7dData": {
          "averageGpuAllocation": 10,
          "averageGpuUtilization": 95,
          "updatedAt": "2021-08-01T00:00:00Z"
        },
        "range30dData": {
          "averageGpuAllocation": 10,
          "averageGpuUtilization": 95,
          "updatedAt": "2021-08-01T00:00:00Z"
        }
      }
    },
    null
  ],
  "next": 1
}

Create project

post

Create a project

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Body

application/json

Responses

201

Created

application/json

400

Bad request.

application/json

401

Unauthorized

application/json

403

Forbidden

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: 543

{
  "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": [],
  "name": "organization1",
  "clusterId": "71f69d83-ba66-4822-adf5-55ce55efd210",
  "requestedNamespace": "runai-proj1",
  "parentId": "53a9228e-a722-420d-a102-9dc90da2efca"
}

{
  "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": [],
  "name": "organization1",
  "clusterId": "71f69d83-ba66-4822-adf5-55ce55efd210",
  "id": 33,
  "parentId": "53a9228e-a722-420d-a102-9dc90da2efca",
  "requestedNamespace": "runai-proj1",
  "status": {
    "namespace": "runai-proj1",
    "phase": "Creating",
    "phaseMessage": "Project is ready",
    "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-02-08T07:14:02.555Z",
  "updatedAt": "2026-02-08T07:14:02.555Z",
  "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,
      "updatedAt": "2021-08-01T00:00:00Z"
    },
    "range7dData": {
      "averageGpuAllocation": 10,
      "averageGpuUtilization": 95,
      "updatedAt": "2021-08-01T00:00:00Z"
    },
    "range30dData": {
      "averageGpuAllocation": 10,
      "averageGpuUtilization": 95,
      "updatedAt": "2021-08-01T00:00:00Z"
    }
  }
}

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

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"
    }
  },
  "resources": [],
  "name": "organization1",
  "clusterId": "71f69d83-ba66-4822-adf5-55ce55efd210",
  "id": 33,
  "parentId": "53a9228e-a722-420d-a102-9dc90da2efca",
  "requestedNamespace": "runai-proj1",
  "status": {
    "namespace": "runai-proj1",
    "phase": "Creating",
    "phaseMessage": "Project is ready",
    "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-02-08T07:14:02.555Z",
  "updatedAt": "2026-02-08T07:14:02.555Z",
  "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,
      "updatedAt": "2021-08-01T00:00:00Z"
    },
    "range7dData": {
      "averageGpuAllocation": 10,
      "averageGpuUtilization": 95,
      "updatedAt": "2021-08-01T00:00:00Z"
    },
    "range30dData": {
      "averageGpuAllocation": 10,
      "averageGpuUtilization": 95,
      "updatedAt": "2021-08-01T00:00:00Z"
    }
  }
}

Update project

put

Get projects telemetry data by the given query parameters

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

projectIdstringRequired

The project id

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

Body

application/json

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/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: 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"
    }
  },
  "resources": [],
  "name": "organization1",
  "clusterId": "71f69d83-ba66-4822-adf5-55ce55efd210",
  "id": 33,
  "parentId": "53a9228e-a722-420d-a102-9dc90da2efca",
  "requestedNamespace": "runai-proj1",
  "status": {
    "namespace": "runai-proj1",
    "phase": "Creating",
    "phaseMessage": "Project is ready",
    "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-02-08T07:14:02.555Z",
  "updatedAt": "2026-02-08T07:14:02.555Z",
  "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,
      "updatedAt": "2021-08-01T00:00:00Z"
    },
    "range7dData": {
      "averageGpuAllocation": 10,
      "averageGpuUtilization": 95,
      "updatedAt": "2021-08-01T00:00:00Z"
    },
    "range30dData": {
      "averageGpuAllocation": 10,
      "averageGpuUtilization": 95,
      "updatedAt": "2021-08-01T00:00:00Z"
    }
  }
}

Delete project

delete

Delete a project

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

projectIdstringRequired

The project id

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

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

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

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

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

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

[]

[]

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

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

Deprecated

Get metrics data for all projects.

get

Retrieves data from the metrics database. \n Use in reporting and analysis tools. \n 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 projects.

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

HTTPcURLJavaScriptPython

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

{
  "data": [
    {
      "metadata": {
        "projectId": 1,
        "projectName": "project-a",
        "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"
          }
        ]
      },
      "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 data for a specific project.

get

Retrieves data from the metrics database. \n Use in reporting and analysis tools. \n 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

projectIdstringRequired

The unique project-id of the project.

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

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

HTTPcURLJavaScriptPython

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

{
  "metadata": {
    "projectId": 1,
    "projectName": "project-a",
    "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"
      }
    ]
  },
  "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 projects and their details.

get

Retrieves a list of all projects and details from a specific cluster. Use in reporting and analysis tools. Deprecated - use /api/v1/org-unit/projects instead.

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 'permissions' field. If 'true', the 'permissions' field in the returned projects is not set. If 'false', the 'permissions' field is set in the returned projects.

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 all the projects.

application/json

get

/v1/k8s/clusters/{clusterId}/projects

HTTPcURLJavaScriptPython

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

200

Successfully retrieved a list of all the projects.

[
  {
    "name": "team-a",
    "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
        }
      }
    ],
    "namespace": "ns-proj1",
    "id": 5,
    "departmentId": 2,
    "tenantId": 2,
    "clusterUuid": "71f69d83-ba66-4822-adf5-55ce55efd210",
    "departmentName": "department-a",
    "interactiveNodeAffinity": "none",
    "trainNodeAffinity": "none",
    "createdAt": "2021-12-14T16:04:15.099Z",
    "status": {
      "namespace": "runai-team-a",
      "message": "NamespaceHandlerFailed",
      "quotaStatuses": []
    },
    "phase": "Ready"
  },
  {
    "defaultNodePools": [
      "default"
    ],
    "interactiveJobTimeLimitSecs": 3600,
    "interactiveJobMaxIdleDurationSecs": 3000,
    "interactivePreemptibleJobMaxIdleDurationSecs": 3000,
    "trainingJobTimeLimitSecs": 3600,
    "trainingJobMaxIdleDurationSecs": 3000,
    "nodeAffinity": {
      "train": {
        "affinityType": "no_limit",
        "selectedTypes": []
      },
      "interactive": {
        "affinityType": "no_limit",
        "selectedTypes": []
      }
    }
  }
]

Deprecated

Create a new project.

post

Creates a new project in a specific cluster. Deprecated - use /api/v1/org-unit/projects instead.

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 permissions field. If true, the permissions field in the request body is ignored. If false, relevant access rules for the permissions field are created in the project scope.

Example: true

Body

application/json

and

Responses

200

Project created successfully.

application/json

400

Bad Project request.

409

Project creation failed.

post

/v1/k8s/clusters/{clusterId}/projects

HTTPcURLJavaScriptPython

POST /v1/k8s/clusters/{clusterId}/projects HTTP/1.1
Host: app.run.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 443

{
  "name": "team-a",
  "departmentId": 2,
  "nodePoolsResources": [],
  "namespace": "ns-proj1",
  "defaultNodePools": [
    "default"
  ],
  "interactiveJobTimeLimitSecs": 3600,
  "interactiveJobMaxIdleDurationSecs": 3000,
  "interactivePreemptibleJobMaxIdleDurationSecs": 3000,
  "trainingJobTimeLimitSecs": 3600,
  "trainingJobMaxIdleDurationSecs": 3000,
  "nodeAffinity": {
    "train": {
      "affinityType": "no_limit",
      "selectedTypes": []
    },
    "interactive": {
      "affinityType": "no_limit",
      "selectedTypes": []
    }
  }
}

{
  "name": "team-a",
  "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
      }
    }
  ],
  "namespace": "ns-proj1",
  "id": 5,
  "departmentId": 2,
  "tenantId": 2,
  "clusterUuid": "71f69d83-ba66-4822-adf5-55ce55efd210",
  "departmentName": "department-a",
  "interactiveNodeAffinity": "none",
  "trainNodeAffinity": "none",
  "createdAt": "2021-12-14T16:04:15.099Z",
  "status": {
    "namespace": "runai-team-a",
    "message": "NamespaceHandlerFailed",
    "quotaStatuses": []
  },
  "phase": "Ready",
  "defaultNodePools": [
    "default"
  ],
  "interactiveJobTimeLimitSecs": 3600,
  "interactiveJobMaxIdleDurationSecs": 3000,
  "interactivePreemptibleJobMaxIdleDurationSecs": 3000,
  "trainingJobTimeLimitSecs": 3600,
  "trainingJobMaxIdleDurationSecs": 3000,
  "nodeAffinity": {
    "train": {
      "affinityType": "no_limit",
      "selectedTypes": []
    },
    "interactive": {
      "affinityType": "no_limit",
      "selectedTypes": []
    }
  }
}

Deprecated

List details of a specific project.

get

Retrieves the details of a specific project from a specific cluster. Use for project analysis. Requires view permissions to the queried project. Deprecated - use /api/v1/org-unit/projects/{projectId} instead.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

clusterIdstringRequired

The Universally Unique Identifier (UUID) of the cluster.

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

idstringRequired

The unique project-id identifying the project.

Query parameters

excludePermissionsbooleanOptional

Backward compatibility of the 'permissions' field. If 'true', the 'permissions' field in the returned projects is not set. If 'false', the 'permissions' field is set in the returned projects.

Example: true

Responses

200

Successfully retrieved project details.

application/json

404

Project not found.

get

/v1/k8s/clusters/{clusterId}/projects/{id}

HTTPcURLJavaScriptPython

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

{
  "name": "team-a",
  "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
      }
    }
  ],
  "namespace": "ns-proj1",
  "id": 5,
  "departmentId": 2,
  "tenantId": 2,
  "clusterUuid": "71f69d83-ba66-4822-adf5-55ce55efd210",
  "departmentName": "department-a",
  "interactiveNodeAffinity": "none",
  "trainNodeAffinity": "none",
  "createdAt": "2021-12-14T16:04:15.099Z",
  "status": {
    "namespace": "runai-team-a",
    "message": "NamespaceHandlerFailed",
    "quotaStatuses": []
  },
  "phase": "Ready",
  "defaultNodePools": [
    "default"
  ],
  "interactiveJobTimeLimitSecs": 3600,
  "interactiveJobMaxIdleDurationSecs": 3000,
  "interactivePreemptibleJobMaxIdleDurationSecs": 3000,
  "trainingJobTimeLimitSecs": 3600,
  "trainingJobMaxIdleDurationSecs": 3000,
  "nodeAffinity": {
    "train": {
      "affinityType": "no_limit",
      "selectedTypes": []
    },
    "interactive": {
      "affinityType": "no_limit",
      "selectedTypes": []
    }
  }
}

Deprecated

Update a project.

put

Updates a project's details in a specific cluster. For example, node pool resources, and others. Deprecated - use /api/v1/org-unit/projects/{projectId} instead.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

idstringRequired

The unique project-id.

clusterIdstringRequired

The Universally Unique Identifier (UUID) of the cluster.

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

Query parameters

excludePermissionsbooleanOptional

Backward compatibility of the permissions field. If true, the permissions field in the returned projects is not set. If false, the permissions field is set in the returned projects.

Example: true

Body

application/json

and

Responses

200

An updated project details.

application/json

400

Bad project request.

404

Project not found.

409

Could not update the project.

put

/v1/k8s/clusters/{clusterId}/projects/{id}

HTTPcURLJavaScriptPython

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

{
  "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
      }
    }
  ],
  "defaultNodePools": [
    "default"
  ],
  "interactiveJobTimeLimitSecs": 3600,
  "interactiveJobMaxIdleDurationSecs": 3000,
  "interactivePreemptibleJobMaxIdleDurationSecs": 3000,
  "trainingJobTimeLimitSecs": 3600,
  "trainingJobMaxIdleDurationSecs": 3000,
  "nodeAffinity": {
    "train": {
      "affinityType": "no_limit",
      "selectedTypes": []
    },
    "interactive": {
      "affinityType": "no_limit",
      "selectedTypes": []
    }
  }
}

{
  "name": "team-a",
  "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
      }
    }
  ],
  "namespace": "ns-proj1",
  "id": 5,
  "departmentId": 2,
  "tenantId": 2,
  "clusterUuid": "71f69d83-ba66-4822-adf5-55ce55efd210",
  "departmentName": "department-a",
  "interactiveNodeAffinity": "none",
  "trainNodeAffinity": "none",
  "createdAt": "2021-12-14T16:04:15.099Z",
  "status": {
    "namespace": "runai-team-a",
    "message": "NamespaceHandlerFailed",
    "quotaStatuses": []
  },
  "phase": "Ready",
  "defaultNodePools": [
    "default"
  ],
  "interactiveJobTimeLimitSecs": 3600,
  "interactiveJobMaxIdleDurationSecs": 3000,
  "interactivePreemptibleJobMaxIdleDurationSecs": 3000,
  "trainingJobTimeLimitSecs": 3600,
  "trainingJobMaxIdleDurationSecs": 3000,
  "nodeAffinity": {
    "train": {
      "affinityType": "no_limit",
      "selectedTypes": []
    },
    "interactive": {
      "affinityType": "no_limit",
      "selectedTypes": []
    }
  }
}

Deprecated

Delete a project.

delete

Deletes a project from a specific cluster. Deprecated - use /api/v1/org-unit/projects/{projectId} instead.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication

Path parameters

clusterIdstringRequired

The Universally Unique Identifier (UUID) of the cluster.

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

idintegerRequired

The unique id of the project.

Example: 2

Responses

200

Project deleted successfully.

application/json

404

Project not found.

delete

/v1/k8s/clusters/{clusterId}/projects/{id}

HTTPcURLJavaScriptPython

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

{
  "name": "team-a",
  "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
      }
    }
  ],
  "namespace": "ns-proj1",
  "id": 5,
  "departmentId": 2,
  "tenantId": 2,
  "clusterUuid": "71f69d83-ba66-4822-adf5-55ce55efd210",
  "departmentName": "department-a",
  "interactiveNodeAffinity": "none",
  "trainNodeAffinity": "none",
  "createdAt": "2021-12-14T16:04:15.099Z",
  "status": {
    "namespace": "runai-team-a",
    "message": "NamespaceHandlerFailed",
    "quotaStatuses": []
  },
  "phase": "Ready",
  "defaultNodePools": [
    "default"
  ],
  "interactiveJobTimeLimitSecs": 3600,
  "interactiveJobMaxIdleDurationSecs": 3000,
  "interactivePreemptibleJobMaxIdleDurationSecs": 3000,
  "trainingJobTimeLimitSecs": 3600,
  "trainingJobMaxIdleDurationSecs": 3000,
  "nodeAffinity": {
    "train": {
      "affinityType": "no_limit",
      "selectedTypes": []
    },
    "interactive": {
      "affinityType": "no_limit",
      "selectedTypes": []
    }
  }
}