Sign in
Projects

List all projects for authenticated user

Changed on

Returns projects that are not deleting or deleted, newest first. Supports two mutually exclusive pagination modes. Offset mode uses page and limit. Cursor mode uses cursor or ending_before with limit, returns next_cursor/prev_cursor, and supports a bounded offset past the cursor anchor. Supplying limit without page selects cursor mode. search applies a case-insensitive project-name filter in either mode. include optionally expands each returned project with its Git connection and/or aggregate health summary using git_connection and health. Sending page with cursor or ending_before, or sending both cursor directions, returns 400.

get/projects

Request

  • Base URL: https://api.volcano.dev
  • URL: https://api.volcano.dev/projects
  • Auth: HTTP bearer

Query parameters

pageinteger

Page number (1-indexed) for offset pagination. Declares no schema default so the request validator does not inject one: handlers that omit page see it unset (nil) and default to 1 in code, while cursor-first endpoints (e.g. the project deployments feed) can detect its absence to stay in keyset/search mode. Supplying page selects offset pagination.

limitinteger

Number of items per page (max 100)

cursorstring

Opaque keyset pagination cursor from a previous response's next_cursor — pages forward. Mutually exclusive with page and ending_before; combining them returns 400. When supplied, the request's search and limit must match the values bound to the cursor or the request returns 400.

ending_beforestring

Opaque keyset pagination cursor from a previous response's prev_cursor — pages backward (the page immediately preceding this cursor). Mutually exclusive with page and cursor; combining them returns 400. search and limit must match the values bound to the cursor or the request returns 400.

offsetinteger

Bounded row offset past the keyset anchor named by cursor (forward) or ending_before (backward) — the hybrid jump. Seek to the anchor, then skip this many rows within. Used for numbered jump-to-page: from the current page, seek to its next/prev cursor and offset the remaining pages. Only honored on the cursor pagination path; ignored otherwise.

searchstring

Case-insensitive substring match on the resource name. See the endpoint description for supported pagination modes.

includestring[]

Optional comma-separated project metadata expansions.

Response

Successful response

pageinteger required

Current page number (1-indexed)

limitinteger required

Number of items per page

totalinteger required

Total number of items across all pages

has_moreboolean required

Whether there are more pages available

nextstring

URL path to next page (offset pagination only; present if has_more is true)

next_cursorstring

Opaque cursor for the next page (cursor pagination only; present if has_more is true)

prev_cursorstring

Opaque cursor for the previous page (cursor pagination only; present when a previous page exists). Send as ending_before.

status'provisioning' | 'active' | 'failed'

Latest project variable propagation status.

current_sync_idstring uuid

Identifier of the latest variable propagation sync.

provisioning_started_atstring date-time

Timestamp when the current variable propagation phase started.

Example response

{
  "data": [
    {
      "logo_url": "/projects/3fa85f64-5717-4562-b3fc-2c963f66afa6/logo?v=1718524800"
    }
  ]
}

Changes

  • 23e7875e7c4cRevision changes
    • ●

      removed the optional property // from the response with the status

    • ○

      added the optional property // to the response with the status

  • e4c43efdab33Revision changes
    • ○

      removed the FREE enum value from the // response property for the response status

    • ○

      removed the PRO enum value from the // response property for the response status