k0rdent AI Docs

List projects

Visibility: internal · public ( OpenAPI Custom Extension: x-visibility )

List all projects accessible to authenticated user.

GET
/v1/regions/global/projects

Authorization

bearerAuth
AuthorizationBearer <token>

Bearer token authentication using OAuth2/OIDC tokens

In: header

Query Parameters

organizationId?string

Filter projects by organization ID

pageToken?string

Opaque cursor token returned in the previous response's nextPageToken. Pass to retrieve the next page of results.

Use for: Frequently updated resources (sessions, servers, clusters, API keys, instances, networks, addresses) where cursor pagination prevents items from being skipped or duplicated when the dataset changes between requests.

Mutually exclusive with offset — include one or the other, not both.

pageSize?integer

Maximum number of items to return per page. Applies to both cursor-based and offset-based pagination.

Range: 1–500. Default: 50.

Default50
Range1 <= value <= 500
offset?integer

Number of items to skip before returning results.

Use for: Stable resources that change infrequently (roles, organizations, providers, policies, groups, projects) where offset pagination enables page-number UIs and total-count displays.

When using offset, the response includes a total field with the full item count. Mutually exclusive with pageToken — include one or the other, not both.

Default0
Range0 <= value

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://api.k0rdent.ai/v1/regions/global/projects"
{
  "projects": [
    {
      "selfLink": "/v1/regions/global/projects/project-x9y8z7",
      "uid": "07cc67f4-45d6-494b-adac-09b5cbc7e2b5",
      "id": "project-x9y8z7",
      "displayName": "string",
      "description": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "organizationId": "string"
    }
  ],
  "nextPageToken": "string",
  "total": 0
}
{
  "error": {
    "code": 0,
    "message": "string",
    "details": [
      {}
    ]
  }
}
{
  "error": {
    "code": 0,
    "message": "string",
    "details": [
      {}
    ]
  }
}
{
  "error": {
    "code": 0,
    "message": "string",
    "details": [
      {}
    ]
  }
}

How is this guide?

On this page

No Headings