Rest list projects

Get a list of all Run:AI Projects

General¶

URL: http://<service-url>/api/v1/projects

Method: GET

Headers

Authorization: Bearer <ACCESS-TOKEN>

Request¶

Response¶

{
    "data": Array<Project>
}

Project:

{
    "name": "<Project Name>",
    "createdAt": "<Project creation time>",
    "deservedGpus": "<GPUs>",
    "interactiveJobTimeLimitSecs": "<TTL for Interactive Jobs>",
    "trainNodeAffinity": "Array<Affinity Group>",
    "interactiveNodeAffinity": "Array<Affinity Group>",
    "departmentName": "default"
}

deservedGpus GPU deserved quota for this Project.
createdAt Project Creation time in a UNIX timestamp format (in milliseconds).
trainNodeAffinity Scheduler training Jobs only on these node groups.
interactiveNodeAffinity - Scheduler interactive Jobs only on these node groups.

For more information see Working with Projects.

Example¶

Request:

curl --location --request GET 'http://www.example.com/api/v1/projects' \
    --header 'Authorization: Bearer <ACCESS-TOKEN>'

Response:

{
    "data": [
        {
            "name": "team-a",
            "createdAt": 1609183432000,
            "deservedGpus": 2,
            "interactiveJobTimeLimitSecs": 0,
            "trainNodeAffinity": null,
            "interactiveNodeAffinity": null,
            "departmentName": "default"
        },
        {
            "name": "team-b",
            "createdAt": 1609183432000,
            "deservedGpus": 2,
            "interactiveJobTimeLimitSecs": 0,
            "trainNodeAffinity": [
                "gpu2",
                "gpu1"
            ],
            "interactiveNodeAffinity": null,
            "departmentName": "default"
        }
    ]
}

Last update: November 22, 2021