---
title: "List Custom Domains"
url: "https://nov18-dev.movespot.fyi/apis/konnect-cloud-gateways-2/versions/b826cacf-03b8-4340-bb4e-daa3648a655b/operations/list-custom-domains"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-cloud-gateways-2/versions/b826cacf-03b8-4340-bb4e-daa3648a655b.md

# List Custom Domains

`GET` `/cloud-gateways/custom-domains`

Operation ID: `list-custom-domains`

Returns a paginated collection of custom domains across control-planes for an organization (restricted by permitted control-plane reads).

## Query parameters

- `filter` (object, optional) - Filters supported for custom domains on the global API.
- `page[size]` (integer, optional) - The maximum number of items to include per page. The last page of a collection may include fewer items.
- `page[number]` (integer, optional) - Determines which page of the entities to retrieve.

## Responses

- `200` - A paginated list for a collection of custom domains.
- `400` - Bad Request
- `401` - Unauthorized
- `403` - Forbidden
- `404` - Not Found

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Konnect Cloud Gateways
  version: 2.0.0
servers:
  - url: https://global.api.konghq.com/v2
    description: Base URL for the global region
paths:
  /cloud-gateways/custom-domains:
    get:
      operationId: list-custom-domains
      summary: List Custom Domains
      description: >
        Returns a paginated collection of custom domains across control-planes
        for an organization (restricted by

        permitted control-plane reads).
      parameters:
        - $ref: "#/components/parameters/CustomDomainsFilter"
        - $ref: "#/components/parameters/PageSize"
        - $ref: "#/components/parameters/PageNumber"
      responses:
        "200":
          $ref: "#/components/responses/ListCustomDomainsResponse"
        "400":
          $ref: "#/components/responses/CloudGatewaysBadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
      tags:
        - Custom Domains
security:
  - konnectAccessToken: []
  - personalAccessToken: []
  - systemAccountAccessToken: []
components:
  parameters:
    CustomDomainsFilter:
      name: filter
      description: Filters supported for custom domains on the global API.
      required: false
      in: query
      schema:
        $ref: "#/components/schemas/CustomDomainsFilterParameters"
      style: deepObject
    PageSize:
      name: page[size]
      description: The maximum number of items to include per page. The last page of a
        collection may include fewer items.
      required: false
      in: query
      allowEmptyValue: true
      schema:
        type: integer
        example: 10
    PageNumber:
      name: page[number]
      description: Determines which page of the entities to retrieve.
      required: false
      in: query
      allowEmptyValue: true
      schema:
        type: integer
        example: 1
  responses:
    ListCustomDomainsResponse:
      description: A paginated list for a collection of custom domains.
      content:
        application/json:
          schema:
            type: object
            properties:
              meta:
                $ref: "#/components/schemas/PaginatedMeta"
              data:
                type: array
                items:
                  $ref: "#/components/schemas/CustomDomain"
            required:
              - meta
              - data
            title: ListGlobalCustomDomainsResponse
    CloudGatewaysBadRequest:
      description: Bad Request
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/BadRequestError"
          examples:
            Network Name Length Exceeded:
              $ref: "#/components/examples/NetworkNameLengthCheckBadRequestExample"
            Transit Gateway Name Length Exceeded:
              $ref: "#/components/examples/TransitGatewayNameLengthCheckBadRequestExample"
            Custom Domain Domain Length Too Short:
              $ref: "#/components/examples/CustomDomainLengthCheckBadRequestExample"
            Configuration Api Access Enum Validation:
              $ref: "#/components/examples/ConfigurationApiAccessBadRequestExample"
            Configuration Data-Plane Group Static Request Instances Minimum:
              $ref: "#/components/examples/ConfigurationDataPlaneGroupStaticRequestedInstance\
                sBadRequestExample"
            Configuration Data-Plane Group Autopilot Base RPS Minimum:
              $ref: "#/components/examples/ConfigurationDataPlaneGroupAutopilotBaseRpsBadRequ\
                estExample"
    Unauthorized:
      description: Unauthorized
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/UnauthorizedError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/UnauthorizedExample"
    Forbidden:
      description: Forbidden
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/ForbiddenError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/ForbiddenExample"
    NotFound:
      description: Not Found
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/NotFoundError"
          examples:
            NotFoundExample:
              $ref: "#/components/examples/NotFoundExample"
  schemas:
    CustomDomainsFilterParameters:
      type: object
      properties:
        control_plane_id:
          $ref: "#/components/schemas/IDFieldFilter"
        control_plane_geo:
          $ref: "#/components/schemas/ControlPlaneGeoFieldFilter"
        domain:
          $ref: "#/components/schemas/CloudGatewaysStringFieldFilterOverride"
        state:
          $ref: "#/components/schemas/CustomDomainStateFieldFilter"
      additionalProperties: false
      title: CustomDomainsFilterParameters
    PaginatedMeta:
      description: returns the pagination information
      type: object
      properties:
        page:
          $ref: "#/components/schemas/PageMeta"
      required:
        - page
      title: PaginatedMeta
    CustomDomain:
      description: Object containing information about a custom domain for a control-plane.
      type: object
      properties:
        id:
          $ref: "#/components/schemas/CustomDomainId"
        control_plane_id:
          $ref: "#/components/schemas/ControlPlaneId"
        control_plane_geo:
          $ref: "#/components/schemas/ControlPlaneGeo"
        domain:
          $ref: "#/components/schemas/CustomDomainName"
        certificate_id:
          description: >
            Certificate ID for the certificate representing this domain and
            stored on data-planes for this

            control-plane. Can be retrieved via the control-planes API for this
            custom domain's control-plane.
          type: string
          format: uuid
          example: 3b7cbeee-fbec-440e-a5ef-89e7dec3b9d0
          nullable: true
          readOnly: true
        sni_id:
          description: >
            Server Name Indication ID for this domain and stored on data-planes
            for this control-plane. Can be retrieved

            via the control-planes API for this custom domain's control-plane.
          type: string
          format: uuid
          example: a8f11ea8-af09-4422-9735-5d4f8910aba1
          nullable: true
          readOnly: true
        state:
          $ref: "#/components/schemas/CustomDomainState"
        state_metadata:
          description: >
            Metadata describing the backing state of the custom domain and why
            it may be in an erroneous state.
          type: object
          additionalProperties: false
          properties:
            reported_status:
              description: Reported status of the custom domain from backing infrastructure.
              type: string
              example: INVALID
            reason:
              description: >
                Reason why the custom domain may be in an erroneous state,
                reported from backing infrastructure.
              type: string
              example: >
                CNAME points to '_acme-challenge.<prefix>.gateways.konghq.tech.'
                instead of '_acme-challenge.<prefix>.acme.gateways.konghq.tech.'
          readOnly: true
          title: CustomDomainStateMetadata
        entity_version:
          description: >
            Monotonically-increasing version count of the custom domain, to
            indicate the order of updates to the custom

            domain.
          type: integer
          example: 1
          readOnly: true
        created_at:
          description: An RFC-3339 timestamp representation of custom domain creation date.
          type: string
          format: date-time
          example: 2022-11-04T20:10:06.927Z
          readOnly: true
        updated_at:
          description: An RFC-3339 timestamp representation of custom domain update date.
          type: string
          format: date-time
          example: 2022-11-04T20:10:06.927Z
          readOnly: true
        kind:
          $ref: "#/components/schemas/CustomDomainKind"
      required:
        - id
        - control_plane_id
        - control_plane_geo
        - domain
        - state
        - state_metadata
        - entity_version
        - created_at
        - updated_at
      title: Custom Domain
    BadRequestError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          required:
            - invalid_parameters
          properties:
            invalid_parameters:
              $ref: "#/components/schemas/InvalidParameters"
    UnauthorizedError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 401
            title:
              example: Unauthorized
            type:
              example: https://httpstatuses.com/401
            instance:
              example: kong:trace:1234567890
            detail:
              example: Invalid credentials
    ForbiddenError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 403
            title:
              example: Forbidden
            type:
              example: https://httpstatuses.com/403
            instance:
              example: kong:trace:1234567890
            detail:
              example: Forbidden
    NotFoundError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 404
            title:
              example: Not Found
            type:
              example: https://httpstatuses.com/404
            instance:
              example: kong:trace:1234567890
            detail:
              example: Not found
    IDFieldFilter:
      description: "Filter using **one** of the following operators: `eq`, `oeq`, `neq`"
      type: object
      properties:
        eq:
          description: The field exactly matches the provided value.
          type: string
          example: ?filter[field_name_here][eq]=foo
        neq:
          description: The field does not match the provided value.
          type: string
          example: ?filter[field_name_here][neq]=bar
        oeq:
          description: The field matches any of the provided values.
          type: string
          example: ?filter[field_name_here][oeq]=foo,bar
      additionalProperties: false
      x-examples:
        example-1:
          neq: not-this-value
          oeq: some-value,some-other-value
        example-2:
          eq: some-value
    ControlPlaneGeoFieldFilter:
      oneOf:
        - $ref: "#/components/schemas/ControlPlaneGeoFieldEqualsFilter"
        - $ref: "#/components/schemas/ControlPlaneGeoFieldNotEqualsFilter"
        - $ref: "#/components/schemas/ControlPlaneGeoFieldOrEqualityFilter"
      title: ControlPlaneGeoFieldFilter
    CloudGatewaysStringFieldFilterOverride:
      description: "Filter using **one** of the following operators: `eq`, `oeq`,
        `neq`, `contains`, `ocontains`"
      type: object
      properties:
        eq:
          description: The field exactly matches the provided value.
          type: string
          example: ?filter[field_name_here][eq]=foo
        contains:
          description: The field contains the provided value.
          type: string
          example: ?filter[field_name_here][contains]=foo
        neq:
          description: The field does not match the provided value.
          type: string
          example: ?filter[field_name_here][neq]=bar
        oeq:
          description: The field matches any of the provided values.
          type: string
          example: ?filter[field_name_here][oeq]=foo,bar
        ocontains:
          description: The field contains any of the provided values.
          type: string
          example: ?filter[field_name_here][ocontains]=foo,bar
      additionalProperties: false
      x-examples:
        example-1:
          contains: some-value
          neq: not-this-value
          oeq: some-value,some-other-value
          ocontains: this-value,or-that-value
        example-2:
          eq: some-value
    CustomDomainStateFieldFilter:
      oneOf:
        - $ref: "#/components/schemas/CustomDomainStateFieldEqualsFilter"
        - $ref: "#/components/schemas/CustomDomainStateFieldNotEqualsFilter"
        - $ref: "#/components/schemas/CustomDomainStateFieldOrEqualityFilter"
      title: CustomDomainStateFieldFilter
    PageMeta:
      description: Contains pagination query parameters and the total number of
        objects returned.
      type: object
      properties:
        number:
          type: number
          example: 1
        size:
          type: number
          example: 10
        total:
          type: number
          example: 100
      required:
        - number
        - size
        - total
    CustomDomainId:
      type: string
      format: uuid
      example: 39ed3790-085d-4605-9627-f96d86aaf425
      readOnly: true
    ControlPlaneId:
      type: string
      format: uuid
      example: 0949471e-b759-45ba-87ab-ee63fb781388
    ControlPlaneGeo:
      description: Set of control-plane geos supported for deploying cloud-gateways
        configurations.
      type: string
      enum:
        - us
        - eu
        - au
        - me
        - in
        - sg
      title: Control-Plane Geo
    CustomDomainName:
      description: Domain name of the custom domain.
      type: string
      example: example.com
      title: Custom Domain Name
    CustomDomainState:
      description: State of the custom domain.
      type: string
      enum:
        - created
        - initializing
        - ready
        - terminating
        - terminated
        - error
      readOnly: true
      title: Custom Domain State
    CustomDomainKind:
      description: |-
        **Pre-release Feature**
        This feature is currently in beta and is subject to change.

        Kind of the custom domain based on Cloud Gateway deployment.
      type: string
      default: dedicated.v0
      enum:
        - dedicated.v0
        - serverless.v1
      title: CustomDomainKind
    BaseError:
      description: standard error
      type: object
      properties:
        status:
          description: >
            The HTTP status code of the error. Useful when passing the response

            body to child properties in a frontend UI. Must be returned as an
            integer.
          type: integer
          readOnly: true
        title:
          description: |
            A short, human-readable summary of the problem. It should not
            change between occurences of a problem, except for localization.
            Should be provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
        type:
          description: The error type.
          type: string
          readOnly: true
        instance:
          description: |
            Used to return the correlation ID back to the user, in the format
            kong:trace:<correlation_id>. This helps us find the relevant logs
            when a customer reports an issue.
          type: string
          readOnly: true
        detail:
          description: >
            A human readable explanation specific to this occurence of the
            problem.

            This field may contain request/entity data to help the user
            understand

            what went wrong. Enclose variable values in square brackets. Should
            be

            provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
      required:
        - status
        - title
        - instance
        - detail
      title: Error
    InvalidParameters:
      description: invalid parameters
      type: array
      items:
        oneOf:
          - $ref: "#/components/schemas/InvalidParameterStandard"
          - $ref: "#/components/schemas/InvalidParameterMinimumLength"
          - $ref: "#/components/schemas/InvalidParameterMaximumLength"
          - $ref: "#/components/schemas/InvalidParameterChoiceItem"
          - $ref: "#/components/schemas/InvalidParameterDependentItem"
      minItems: 1
      nullable: false
      uniqueItems: true
    ControlPlaneGeoFieldEqualsFilter:
      description: Filter a control-plane geo by exact match.
      oneOf:
        - $ref: "#/components/schemas/ControlPlaneGeo"
        - type: object
          title: ControlPlaneGeoFieldEqualsComparison
          properties:
            eq:
              $ref: "#/components/schemas/ControlPlaneGeo"
          required:
            - eq
      title: ControlPlaneGeoFieldEqualsFilter
      x-examples:
        example-1: us
        example-2:
          eq: us
    ControlPlaneGeoFieldNotEqualsFilter:
      description: Filter a control-plane geo by inequality match.
      type: object
      properties:
        neq:
          $ref: "#/components/schemas/ControlPlaneGeo"
      required:
        - neq
      title: ControlPlaneGeoFieldNotEqualsFilter
      x-examples:
        example-1:
          neq: us
    ControlPlaneGeoFieldOrEqualityFilter:
      description: >
        Filter a control-plane geo by determining if the value is equal to any
        in a set of values, where the set is a

        comma-delimited list.
      type: object
      properties:
        oeq:
          type: string
      required:
        - oeq
      title: ControlPlaneGeoFieldOrEqualityFilter
      x-examples:
        example-1:
          oeq: us,eu
    CustomDomainStateFieldEqualsFilter:
      description: Filter custom domain state by exact match.
      oneOf:
        - $ref: "#/components/schemas/CustomDomainState"
        - type: object
          title: CustomDomainStateFieldEqualsComparison
          properties:
            eq:
              $ref: "#/components/schemas/CustomDomainState"
          required:
            - eq
      title: CustomDomainStateFieldEqualsFilter
    CustomDomainStateFieldNotEqualsFilter:
      description: Filter custom domain state by inequality match.
      type: object
      properties:
        neq:
          $ref: "#/components/schemas/CustomDomainState"
      required:
        - neq
      title: CustomDomainStateFieldNotEqualsFilter
      x-examples:
        example-1:
          neq: ready
    CustomDomainStateFieldOrEqualityFilter:
      description: >
        Filter custom domain state by determining if the value is equal to any
        in a set of values, where the set is a

        comma-delimited list.
      type: object
      properties:
        oeq:
          type: string
      required:
        - oeq
      title: CustomDomainStateFieldOrEqualityFilter
      x-examples:
        example-1:
          oeq: ready,initializing
    InvalidParameterStandard:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          $ref: "#/components/schemas/InvalidRules"
        source:
          type: string
          example: body
        reason:
          type: string
          example: is a required field
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
    InvalidParameterMinimumLength:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - min_length
            - min_digits
            - min_lowercase
            - min_uppercase
            - min_symbols
            - min_items
            - min
          nullable: false
          readOnly: true
        minimum:
          type: integer
          example: 8
        source:
          type: string
          example: body
        reason:
          type: string
          example: must have at least 8 characters
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - minimum
    InvalidParameterMaximumLength:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - max_length
            - max_items
            - max
          nullable: false
          readOnly: true
        maximum:
          type: integer
          example: 8
        source:
          type: string
          example: body
        reason:
          type: string
          example: must not have more than 8 characters
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - maximum
    InvalidParameterChoiceItem:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - enum
          nullable: false
          readOnly: true
        reason:
          type: string
          example: is a required field
          readOnly: true
        choices:
          type: array
          items: {}
          minItems: 1
          nullable: false
          readOnly: true
          uniqueItems: true
        source:
          type: string
          example: body
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - choices
    InvalidParameterDependentItem:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - dependent_fields
          nullable: true
          readOnly: true
        reason:
          type: string
          example: is a required field
          readOnly: true
        dependents:
          type: array
          items: {}
          nullable: true
          readOnly: true
          uniqueItems: true
        source:
          type: string
          example: body
      additionalProperties: false
      required:
        - field
        - rule
        - reason
        - dependents
    InvalidRules:
      description: invalid parameters rules
      type: string
      enum:
        - required
        - is_array
        - is_base64
        - is_boolean
        - is_date_time
        - is_integer
        - is_null
        - is_number
        - is_object
        - is_string
        - is_uuid
        - is_fqdn
        - is_arn
        - unknown_property
        - missing_reference
        - is_label
        - matches_regex
        - invalid
        - is_supported_network_availability_zone_list
        - is_supported_network_cidr_block
        - is_supported_provider_region
        - type
      nullable: true
      readOnly: true
  examples:
    NetworkNameLengthCheckBadRequestExample:
      value:
        status: 400
        title: Invalid Request
        instance: konnect:trace:2822394689570210664
        detail: Invalid Parameters
        invalid_parameters:
          - field: name
            rule: max_length
            reason: name must be shorter than or equal to 120 characters
            maximum: 120
    TransitGatewayNameLengthCheckBadRequestExample:
      value:
        status: 400
        title: Invalid Request
        instance: konnect:trace:2822394689570210664
        detail: Invalid Parameters
        invalid_parameters:
          - field: name
            rule: max_length
            reason: name must be shorter than or equal to 120 characters
            maximum: 120
    CustomDomainLengthCheckBadRequestExample:
      value:
        status: 400
        title: Invalid Request
        instance: konnect:trace:2822394689570210664
        detail: Invalid Parameters
        invalid_parameters:
          - field: domain
            rule: min_length
            minimum: 1
            reason: domain must be longer than or equal to 1 characters
    ConfigurationApiAccessBadRequestExample:
      value:
        status: 400
        title: Invalid Request
        instance: konnect:trace:2822394689570210664
        detail: Invalid Parameters
        invalid_parameters:
          - field: api_access
            rule: enum
            choices:
              - private
              - public
              - private+public
            reason: "api_access must be one of the following values: private, public,
              private+public"
    ConfigurationDataPlaneGroupStaticRequestedInstancesBadRequestExample:
      value:
        status: 400
        title: Invalid Request
        instance: konnect:trace:2822394689570210664
        detail: Invalid Parameters
        invalid_parameters:
          - field: dataplane_groups.0.autoscale.requested_instances
            rule: is_integer
            reason: dataplane_groups.0.autoscale.requested_instances must be an integer
              number
    ConfigurationDataPlaneGroupAutopilotBaseRpsBadRequestExample:
      value:
        status: 400
        title: Invalid Request
        instance: konnect:trace:2822394689570210664
        detail: Invalid Parameters
        invalid_parameters:
          - field: dataplane_groups.0.autoscale.base_rps
            rule: is_integer
            reason: dataplane_groups.0.autoscale.base_rps must be an integer number
    UnauthorizedExample:
      value:
        status: 401
        title: Unauthorized
        instance: kong:trace:8347343766220159418
        detail: Unauthorized
    ForbiddenExample:
      value:
        status: 403
        title: Forbidden
        instance: kong:trace:2723154947768991354
        detail: You do not have permission to perform this action
    NotFoundExample:
      value:
        status: 404
        title: Not Found
        instance: kong:trace:6816496025408232265
        detail: Not Found
  securitySchemes:
    konnectAccessToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        The Konnect access token is meant to be used by the Konnect dashboard
        and the decK CLI authenticate with.
    personalAccessToken:
      type: http
      scheme: bearer
      bearerFormat: Token
      description: >
        The personal access token is meant to be used as an alternative to
        basic-auth when accessing Konnect via APIs.

        You can generate a Personal Access Token (PAT) from the [personal access
        token page](https://cloud.konghq.com/global/account/tokens/) in the
        Konnect dashboard.

        The PAT token must be passed in the header of a request, for example:

        `curl -X GET 'https://global.api.konghq.com/v2/users/' --header
        'Authorization: Bearer kpat_xgfT...'`
    systemAccountAccessToken:
      type: http
      scheme: bearer
      bearerFormat: Token
      description: >
        The system account access token is meant for automations and
        integrations that are not directly associated with a human identity.

        You can generate a system account Access Token by creating a system
        account and then obtaining a system account access token for that
        account.

        The access token must be passed in the header of a request, for example:

        `curl -X GET 'https://global.api.konghq.com/v2/users/' --header
        'Authorization: Bearer spat_i2Ej...'`
```
