Skip to Content
kosemdocs
ReferenceAPIEnvironments

List environments

Lists a project's environments, oldest first.

GET
/v1/projects/{project}/environments

Lists a project's environments, oldest first.

Authorization

bearer
headerAuthorizationBearer <token>

An access token, or an API key.

Path Parameters

project*string

The project's ID.

Match^prj_[0-7][0-9a-hjkmnp-tv-z]{25}$

Query Parameters

pageSize?integer

Maximum number of environments to return. Defaults to 50; values above 500 are treated as 500.

Formatint32
Range0 <= value
pageToken?string

Page token from a previous response.

Response Body

OK

application/json
  1. response
environments*array<>

Environments, oldest first.

nextPageToken*string

Token for the next page; empty on the last page.

Example Request
curl -X GET 'https://api.kosem.ai/v1/projects/string/environments'
Example Response
{
  "environments": [
    {
      "createTime": "2019-08-24T14:15:22Z",
      "displayName": "string",
      "idleTimeoutSeconds": 0,
      "image": "string",
      "lastUsedTime": "2019-08-24T14:15:22Z",
      "name": "string",
      "owner": "string",
      "runner": "string",
      "runnerPool": "string",
      "runningJobs": 0,
      "size": {
        "diskGib": 0,
        "memoryMib": 0,
        "vcpus": 0
      },
      "state": "PROVISIONING",
      "stateReason": "string",
      "stoppedTtlSeconds": 0,
      "updateTime": "2019-08-24T14:15:22Z"
    }
  ],
  "nextPageToken": "string"
}