Sign in
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"
    }
  ]
}

Changes

Changed in 7 of the 75 revisions of this API.1334

  • c80d57ed14ab1See the full diff
    • ▲

      for the query request parameter filter, the type/format of property domain was specialized from / to object/

      request-parameter-property-type-specialized

    This revision also has 7 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 6dabb1df19ab1See the full diff
    • ○

      added the optional property data/items/kind to the response with the 200 status

      response-optional-property-added

  • 8ab3ec3ed3011See the full diff
    • ●

      added the new type enum value to the allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterStandard]/rule response property for the response status 400

      response-property-enum-value-added

  • ddf026fbd25b13See the full diff
    • ●

      added the new sg enum value to the data/items/control_plane_geo response property for the response status 200

      response-property-enum-value-added

    • ○

      added the enum value sg to the property control_plane_geo/oneOf[subschema #1: ControlPlaneGeoFieldEqualsFilter]/oneOf[subschema #1: Control-Plane Geo]/ of the query request parameter filter

      request-parameter-property-enum-value-added

    • ○

      added the enum value sg to the property control_plane_geo/oneOf[subschema #1: ControlPlaneGeoFieldEqualsFilter]/oneOf[subschema #2: ControlPlaneGeoFieldEqualsComparison]/eq of the query request parameter filter

      request-parameter-property-enum-value-added

    • ○

      added the enum value sg to the property control_plane_geo/oneOf[subschema #2: ControlPlaneGeoFieldNotEqualsFilter]/neq of the query request parameter filter

      request-parameter-property-enum-value-added

  • 3c0154b2053a11See the full diff
    • ▲

      the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterChoiceItem]/source became nullable for the status 400

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterDependentItem]/source became nullable for the status 400

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterMaximumLength]/source became nullable for the status 400

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterMinimumLength]/source became nullable for the status 400

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterStandard]/source became nullable for the status 400

      response-property-became-nullable

    • ▲

      the response property data/items/state_metadata/reason became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property data/items/state_metadata/reported_status became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property detail became nullable for the status 401

      response-property-became-nullable

    • ▲

      the response property instance became nullable for the status 401

      response-property-became-nullable

    • ▲

      the response property status became nullable for the status 401

      response-property-became-nullable

    • ▲

      the response property title became nullable for the status 401

      response-property-became-nullable

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 6333a0d3b0951See the full diff
    • ▲

      for the query request parameter filter, the type/format of property control_plane_id was specialized from / to object/

      request-parameter-property-type-specialized

    This revision also has 15 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 76b0fefddb0d1See the full diff
    • ●

      for the query request parameter filter, the type/format of property control_plane_id was changed from object/ to /

      request-parameter-property-type-changed