v61

latestOpenAPI 3.1.0Apache 2.0raw.githubusercontent.com2026-08-018131,3812.6 MB
Custom Domains

List Custom Domains

Returns a paginated list of custom domains across all control planes in the organization, scoped to control planes you have read access to.

get/v2/cloud-gateways/custom-domains

Query parameters

Filters supported for custom domains on the global API.

page[size]integer
Example:10

The maximum number of items to include per page. The last page of a collection may include fewer items.

page[number]integer
Example:1

Determines which page of the entities to retrieve.

Response

A paginated list for a collection of custom domains.

Example response

{
  "meta": {
    "page": {
      "number": 1,
      "size": 10,
      "total": 100
    }
  },
  "data": [
    {
      "id": "39ed3790-085d-4605-9627-f96d86aaf425",
      "control_plane_id": "0949471e-b759-45ba-87ab-ee63fb781388",
      "domain": "example.com",
      "certificate_id": "3b7cbeee-fbec-440e-a5ef-89e7dec3b9d0",
      "sni_id": "a8f11ea8-af09-4422-9735-5d4f8910aba1",
      "state_metadata": {
        "reported_status": "INVALID",
        "reason": "CNAME points to '_acme-challenge.<prefix>.gateways.konghq.tech.' instead of '_acme-challenge.<prefix>.acme.gateways.konghq.tech.'\n"
      },
      "entity_version": 1,
      "created_at": "2022-11-04T20:10:06.927Z",
      "updated_at": "2022-11-04T20:10:06.927Z"
    }
  ]
}