Skip to main content
GET
List organization custom domains

Authorizations

Authorization
string
header
required

JWT tokens should be used with OIDC account (human to machine). JWT tokens used by the Qovery console to communicate with the API have a TTL. Curl Example ' curl https://console.qovery.com/organization -H "Authorization: Bearer $qovery_token" '

Path Parameters

organizationId
string<uuid>
required

Organization ID

Query Parameters

projectId
string<uuid>

Only list the domains of this project. A project of another organization gives an empty list.

environmentId
string<uuid>

Only list the domains of this environment. An environment of another organization gives an empty list.

Only list the domains whose name contains this text, ignoring case. The text is trimmed and matched literally, with no wildcard. A blank value does not filter.

page
integer
default:1

The page to return, starting at 1. A page after the last one has no results.

Required range: x >= 1
pageSize
integer
default:20

The number of domains per page.

Required range: 1 <= x <= 100

Response

List organization custom domains

page
number
required
Example:

1

page_size
number
required
Example:

20

results
object[]
required
total_count
integer
required

The number of domains matching the query, on all pages.