Sign in
Functions

List the custom domains on a branch

Changed on

Lists all custom domains registered on the branch, across every target entity.

Note: This endpoint is currently in Beta.

get/projects/{project_id}/branches/{branch_id}/custom-domains

Request

  • Base URL: https://console.neon.tech/api/v2
  • URL: https://console.neon.tech/api/v2/projects/{project_id}/branches/{branch_id}/custom-domains
  • Auth: one of:
    • HTTP bearer
    • API key in cookie zenith
    • API key in cookie keycloak_token

Query parameters

cursorstring

A cursor to use in pagination. A cursor defines your place in the data list. Include response.pagination.next in subsequent API calls to fetch next page of the list.

limitinteger

Specify a value from 1 to 1000 to limit number of domains in the response

Response

The list of custom domains

Changes

  • 48a9f51e38c8Revision changes
    • ○

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

    • ○

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

    • ○

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

    • ○

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

  • d5bff604e6a0Revision changes
    • ○

      endpoint added