Sign in
Frontends

List all custom domains in a project

Changed on

Project-scoped custom-domain list. Returns every active custom domain across every frontend in the project (excludes soft-deleted rows). Each item inlines the linked frontend's id and name so the UI does not need a second fetch to render the "Linked to" column.

get/projects/{id}/domains

Request

  • Base URL: https://api.volcano.dev
  • URL: https://api.volcano.dev/projects/{id}/domains
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

idstring uuid required

Project ID

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.

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 (only present if has_more is true)

Changes

  • 23e7875e7c4cRevision changes
    • ○

      the endpoint scheme security ProjectAccessToken was added to the API

  • f0670c84c817Revision changes
    • ▲

      the ////// response's property type changed from object to no type for status

    • ▲

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

    • ▲

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

    • ▲

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

    • ●

      added the new failed enum value to the ////// response property for the response status

    • ○

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

    • ○

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

    • ○

      added to the ////// response property allOf list for the response status

    • ○

      response property data/items/allOf[FrontendCustomDomainResponse]/required_routing_record deprecated