---
title: "List Configurations"
url: "https://nov18-dev.movespot.fyi/apis/konnect-cloud-gateways-internal-2/versions/53f44c10-7c5c-44ed-9e12-01aa08aa0a32/operations/list-configurations"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-cloud-gateways-internal-2/versions/53f44c10-7c5c-44ed-9e12-01aa08aa0a32.md

# List Configurations

`GET` `/cloud-gateways/configurations`

Operation ID: `list-configurations`

Returns a paginated collection of dedicated configurations or serverless configurations across control-planes for an organization (restricted by permitted control-plane reads).

## Query parameters

- `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.
- `filter` (object, optional) - Filters supported for configurations.

## Responses

- `200` - A paginated list for a collection of configurations.
- `400` - Bad Request
- `401` - Unauthorized
- `403` - Forbidden

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Konnect Cloud Gateways
  version: 3.0.0
servers:
  - url: https://global.api.konghq.com/v3
    description: Base URL for the global region
paths:
  /cloud-gateways/configurations:
    get:
      operationId: list-configurations
      summary: List Configurations
      description: >
        Returns a paginated collection of dedicated configurations or serverless
        configurations across control-planes

        for an organization (restricted by permitted control-plane reads).
      parameters:
        - $ref: "#/components/parameters/PageSize"
        - $ref: "#/components/parameters/PageNumber"
        - $ref: "#/components/parameters/ConfigurationsFilter"
      responses:
        "200":
          $ref: "#/components/responses/ListConfigurationsResponse"
        "400":
          $ref: "#/components/responses/CloudGatewaysBadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "403":
          $ref: "#/components/responses/Forbidden"
      tags:
        - Data-Plane Group Configurations
security:
  - konnectAccessToken: []
  - personalAccessToken: []
  - systemAccountAccessToken: []
components:
  parameters:
    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
    ConfigurationsFilter:
      name: filter
      description: Filters supported for configurations.
      required: false
      in: query
      schema:
        $ref: "#/components/schemas/ConfigurationsFilterParameters"
      style: deepObject
  responses:
    ListConfigurationsResponse:
      description: A paginated list for a collection of configurations.
      content:
        application/json:
          schema:
            type: object
            properties:
              meta:
                $ref: "#/components/schemas/PaginatedMeta"
              data:
                type: array
                items:
                  $ref: "#/components/schemas/ConfigurationManifest"
            required:
              - meta
              - data
            title: ListConfigurationsResponse
    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"
  schemas:
    ConfigurationsFilterParameters:
      type: object
      properties:
        control_plane_id:
          $ref: "#/components/schemas/UuidFieldFilter"
        control_plane_geo:
          $ref: "#/components/schemas/ControlPlaneGeoFieldFilter"
      additionalProperties: false
      title: ConfigurationsFilterParameters
    PaginatedMeta:
      description: returns the pagination information
      type: object
      properties:
        page:
          $ref: "#/components/schemas/PageMeta"
      required:
        - page
      title: PaginatedMeta
    ConfigurationManifest:
      description: Object containing information about a control-plane's
        cloud-gateways configuration.
      type: object
      oneOf:
        - $ref: "#/components/schemas/DedicatedConfigurationManifest"
        - $ref: "#/components/schemas/ServerlessConfigurationManifest"
        - $ref: "#/components/schemas/ServerlessV1ConfigurationManifest"
      title: Configuration
    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
    UuidFieldFilter:
      description: Filters on the given UUID field value by exact match.
      oneOf:
        - $ref: "#/components/schemas/StringFieldEqualsFilter"
        - $ref: "#/components/schemas/StringFieldOEQFilter"
        - $ref: "#/components/schemas/StringFieldNEQFilter"
      title: UuidFieldFilter
      x-examples:
        example-1: 3bbfd3a-e9ab-48a9-9881-ed589e4615d1
        example-2:
          eq: 3bbfd3a-e9ab-48a9-9881-ed589e4615d1
        example-3:
          oeq: 3bbfd3a-e9ab-48a9-9881-ed589e4615d1
        example-4:
          neq: 3bbfd3a-e9ab-48a9-9881-ed589e4615d1
    ControlPlaneGeoFieldFilter:
      oneOf:
        - $ref: "#/components/schemas/ControlPlaneGeoFieldEqualsFilter"
        - $ref: "#/components/schemas/ControlPlaneGeoFieldNotEqualsFilter"
        - $ref: "#/components/schemas/ControlPlaneGeoFieldOrEqualityFilter"
      title: ControlPlaneGeoFieldFilter
    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
    DedicatedConfigurationManifest:
      type: object
      allOf:
        - $ref: "#/components/schemas/BaseConfigurationManifest"
        - properties:
            kind:
              type: string
              enum:
                - dedicated.v0
            version:
              description: Gateway version the gateway configuration targets.
              type: string
              example: "3.2"
              pattern: ^(\d)+(\.(\d)+)?$
            api_access:
              $ref: "#/components/schemas/CloudGatewayApiAccess"
            dataplane_group_config:
              $ref: "#/components/schemas/DedicatedDataPlaneGroupConfig"
            dataplane_groups:
              description: List of data-plane groups that describe where dedicated gateways
                are deployed to, along with how many instances.
              type: array
              items:
                $ref: "#/components/schemas/DedicatedDataPlaneGroup"
            entity_version:
              description: Positive, monotonically increasing version integer, to serialize
                configuration changes.
              type: number
              example: 1
              readOnly: true
            created_at:
              description: An ISO-8604 timestamp representation of configuration creation
                date.
              type: string
              format: date-time
              example: 2022-11-04T20:10:06.927Z
              readOnly: true
            updated_at:
              description: An ISO-8604 timestamp representation of configuration update date.
              type: string
              format: date-time
              example: 2022-11-04T20:10:06.927Z
              readOnly: true
          required:
            - id
            - kind
            - version
            - dataplane_group_config
            - dataplane_groups
            - entity_version
            - created_at
            - updated_at
      title: Dedicated Configuration
    ServerlessConfigurationManifest:
      type: object
      allOf:
        - $ref: "#/components/schemas/BaseConfigurationManifest"
        - properties:
            kind:
              type: string
              enum:
                - serverless.v0
            dataplane_group_config:
              $ref: "#/components/schemas/ServerlessDataPlaneGroupConfig"
            dataplane_groups:
              description: List of data-plane groups describe where serverless gateways are
                deployed to, along with how many instances.
              type: array
              items:
                $ref: "#/components/schemas/ServerlessDataPlaneGroup"
            entity_version:
              description: Positive, monotonically increasing version integer, to serialize
                configuration changes.
              type: number
              example: 1
              readOnly: true
            created_at:
              description: An ISO-8604 timestamp representation of configuration creation
                date.
              type: string
              format: date-time
              example: 2022-11-04T20:10:06.927Z
              readOnly: true
            updated_at:
              description: An ISO-8604 timestamp representation of configuration update date.
              type: string
              format: date-time
              example: 2022-11-04T20:10:06.927Z
              readOnly: true
          required:
            - id
            - kind
            - dataplane_group_config
            - dataplane_groups
            - entity_version
            - created_at
            - updated_at
      title: Serverless Configuration
    ServerlessV1ConfigurationManifest:
      type: object
      allOf:
        - $ref: "#/components/schemas/BaseConfigurationManifest"
        - properties:
            kind:
              type: string
              enum:
                - serverless.v1
            dataplane_group_config:
              $ref: "#/components/schemas/ServerlessV1DataPlaneGroupConfig"
            dataplane_groups:
              description: List of data-plane groups describe where serverless v1 gateways are
                deployed to, along with how many instances.
              type: array
              items:
                $ref: "#/components/schemas/ServerlessV1DataPlaneGroup"
            entity_version:
              description: Positive, monotonically increasing version integer, to serialize
                configuration changes.
              type: number
              example: 1
              readOnly: true
            created_at:
              description: An ISO-8604 timestamp representation of configuration creation
                date.
              type: string
              format: date-time
              example: 2022-11-04T20:10:06.927Z
              readOnly: true
            updated_at:
              description: An ISO-8604 timestamp representation of configuration update date.
              type: string
              format: date-time
              example: 2022-11-04T20:10:06.927Z
              readOnly: true
          required:
            - id
            - kind
            - dataplane_group_config
            - dataplane_groups
            - entity_version
            - created_at
            - updated_at
      title: Serverless V1 Configuration
    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
    StringFieldEqualsFilter:
      description: Filters on the given string field value by exact match.
      oneOf:
        - type: string
        - type: object
          title: StringFieldEqualsComparison
          additionalProperties: false
          properties:
            eq:
              type: string
          required:
            - eq
      title: StringFieldEqualsFilter
      x-examples:
        example-1: equals-some-value
        example-2:
          eq: some-value
    StringFieldOEQFilter:
      description: Returns entities that exact match any of the comma-delimited
        phrases in the filter string.
      type: object
      properties:
        oeq:
          type: string
      additionalProperties: false
      required:
        - oeq
      title: StringFieldOEQFilter
      x-examples:
        example-1:
          oeq: some-value,some-other-value
    StringFieldNEQFilter:
      description: Filters on the given string field value by exact match inequality.
      type: object
      properties:
        neq:
          type: string
      additionalProperties: false
      required:
        - neq
      title: StringFieldNEQFilter
      x-examples:
        example-1:
          neq: not-this-value
    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
    BaseConfigurationManifest:
      type: object
      properties:
        id:
          description: ID of the configuration.
          type: string
          format: uuid
          example: f521675a-af6b-4684-be7b-43bc27b20543
          readOnly: true
        kind:
          type: string
          enum:
            - dedicated.v0
            - serverless.v0
            - serverless.v1
        control_plane_id:
          description: ID of the control-plane a configuration belongs to.
          type: string
          format: uuid
          example: b5922611-a763-499e-8d86-5643de122768
          readOnly: true
        control_plane_geo:
          $ref: "#/components/schemas/ControlPlaneGeo"
      discriminator:
        propertyName: kind
        mapping:
          serverless.v0: "#/components/schemas/ServerlessConfigurationManifest"
          dedicated.v0: "#/components/schemas/DedicatedConfigurationManifest"
          serverless.v1: "#/components/schemas/ServerlessV1ConfigurationManifest"
      required:
        - id
        - kind
        - control_plane_id
        - control_plane_geo
      title: Base Configuration
    CloudGatewayApiAccess:
      description: |
        Type of API access dataplane groups will support for a configuration.
      type: string
      default: private+public
      enum:
        - private
        - private+public
        - public
    DedicatedDataPlaneGroupConfig:
      description: Object that describes where dedicated gateways will be deployed to,
        along with how many instances.
      type: array
      items:
        $ref: "#/components/schemas/DedicatedDataPlaneGroupConfigItem"
      title: Dedicated Data-Plane Groups Configuration
    DedicatedDataPlaneGroup:
      description: Object that describes the set of dedicated data-plane groups
        currently pointed to a configuration.
      type: object
      properties:
        id:
          description: ID of the dataplane group that represents this deployment target.
          type: string
          format: uuid
          example: 14a74117-868a-4859-bf6c-eb2fe301a6ab
        provider:
          $ref: "#/components/schemas/CloudGatewaysProviderName"
        region:
          description: Region of cloud provider the cloud gateways will be deployed to.
          type: string
          example: us-east-2
        autoscale:
          $ref: "#/components/schemas/DataPlaneGroupAutoscale"
        environment:
          $ref: "#/components/schemas/DataPlaneGroupEnvironmentConfigurations"
        cloud_gateway_network_id:
          description: Network ID this dataplane group is attached to.
          type: string
          format: uuid
        state:
          description: State of the dataplane group.
          type: string
          enum:
            - created
            - initializing
            - ready
            - terminating
            - terminated
        state_metadata:
          description: >
            Metadata describing the backing state of the dataplane group and why
            it may be in an erroneous state.
          type: object
          additionalProperties: false
          properties:
            reported_status:
              description: Reported status of the dataplane group from backing infrastructure.
              type: string
              example: ERROR
            reason:
              description: >
                Reason why the dataplane group may be in an erroneous state,
                reported from backing infrastructure.
              type: string
              example: >
                Dataplane group could not be deployed due to insufficient cloud
                provider compute instances.
          readOnly: true
        private_ip_addresses:
          description: >
            List of private IP addresses of the internal load balancer that
            proxies traffic to this dataplane group.
          type: array
          items:
            type: string
        egress_ip_addresses:
          description: >
            List of egress IP addresses for the network that this dataplane
            group runs on.
          type: array
          items:
            type: string
        hostnames:
          description: List of hostnames for proxying to the data-plane group.
          type: array
          items:
            type: string
        created_at:
          description: An ISO-8604 timestamp representation of data-plane group creation
            date.
          type: string
          format: date-time
          example: 2022-11-04T20:10:06.927Z
          readOnly: true
        updated_at:
          description: An ISO-8604 timestamp representation of data-plane group update date.
          type: string
          format: date-time
          example: 2022-11-04T20:10:06.927Z
          readOnly: true
      required:
        - id
        - provider
        - region
        - autoscale
        - cloud_gateway_network_id
        - state
        - created_at
        - updated_at
      title: Dedicated Data-Plane Group
    ServerlessDataPlaneGroupConfig:
      description: Object that describes where serverless gateways will be deployed
        to, along with how many instances.
      type: array
      items:
        $ref: "#/components/schemas/ServerlessDataPlaneGroupConfigItem"
      title: Serverless Data-Plane Groups Configuration
    ServerlessDataPlaneGroup:
      description: Object that describes a serverless data-plane group, deployed for a
        control-plane.
      type: object
      properties:
        id:
          description: ID of the data-plane group that represents the deployment target.
          type: string
          format: uuid
          example: 14a74117-868a-4859-bf6c-eb2fe301a6ab
        region:
          description: Serverless region the gateway will be deployed to.
          type: string
          example: us
        state:
          description: State of the data-plane group.
          type: string
          enum:
            - created
            - initializing
            - ready
            - terminating
            - terminated
        state_metadata:
          description: >
            Metadata describing the backing state of the dataplane group and why
            it may be in an erroneous state.
          type: object
          additionalProperties: false
          properties:
            reported_status:
              description: Reported status of the dataplane group from backing infrastructure.
              type: string
              example: ERROR
            reason:
              description: >
                Reason why the dataplane group may be in an erroneous state,
                reported from backing infrastructure.
              type: string
              example: >
                Dataplane group could not be deployed due to insufficient cloud
                provider compute instances.
        hostnames:
          description: List of hostnames for proxying to the serverless data-plane group.
          type: array
          items:
            type: string
        created_at:
          description: An ISO-8604 timestamp representation of data-plane group creation
            date.
          type: string
          format: date-time
          example: 2022-11-04T20:10:06.927Z
          readOnly: true
        updated_at:
          description: An ISO-8604 timestamp representation of data-plane group update date.
          type: string
          format: date-time
          example: 2022-11-04T20:10:06.927Z
          readOnly: true
      required:
        - id
        - region
        - state
        - created_at
        - updated_at
      title: Serverless Data-Plane Group
    ServerlessV1DataPlaneGroupConfig:
      description: Object that describes where serverless v1 data-plane groups will be
        deployed to, along with how many instances.
      type: array
      items:
        $ref: "#/components/schemas/ServerlessV1DataPlaneGroupConfigItem"
      title: Serverless V1 Data-Plane Groups Configuration
    ServerlessV1DataPlaneGroup:
      description: Object that describes a serverless v1 data-plane group, deployed
        for a control-plane.
      type: object
      properties:
        id:
          description: ID of the serverless v1 dataplane group that represents this
            deployment target.
          type: string
          format: uuid
          example: 14a74117-868a-4859-bf6c-eb2fe301a6ab
        provider:
          $ref: "#/components/schemas/ServerlessV1ProviderName"
        region:
          description: Region of cloud provider the serverless v1 gateways will be
            deployed to.
          type: string
          example: us
        environment:
          $ref: "#/components/schemas/DataPlaneGroupEnvironmentConfigurations"
        state:
          description: State of the dataplane group.
          type: string
          enum:
            - created
            - initializing
            - ready
            - terminating
            - terminated
        private_ip_addresses:
          description: >
            List of private IP addresses of the internal load balancer that
            proxies traffic to this dataplane group.
          type: array
          items:
            type: string
        egress_ip_addresses:
          description: >
            List of egress IP addresses for the network that this dataplane
            group runs on.
          type: array
          items:
            type: string
        hostnames:
          description: List of hostnames for proxying to the data-plane group.
          type: array
          items:
            type: string
        created_at:
          description: An ISO-8604 timestamp representation of data-plane group creation
            date.
          type: string
          format: date-time
          example: 2022-11-04T20:10:06.927Z
          readOnly: true
        updated_at:
          description: An ISO-8604 timestamp representation of data-plane group update date.
          type: string
          format: date-time
          example: 2022-11-04T20:10:06.927Z
          readOnly: true
      required:
        - id
        - provider
        - region
        - state
        - created_at
        - updated_at
      title: Serverless V1 Data-Plane Group
    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
    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
    DedicatedDataPlaneGroupConfigItem:
      description: Object that describes where a data-plane group will be deployed to,
        along with how many instances.
      type: object
      properties:
        provider:
          $ref: "#/components/schemas/CloudGatewaysProviderName"
        region:
          description: Region of cloud provider the cloud gateways will be deployed to.
          type: string
          example: us-east-2
        cloud_gateway_network_id:
          description: Network ID this dataplane group is attached to.
          type: string
          format: uuid
        autoscale:
          $ref: "#/components/schemas/DataPlaneGroupAutoscale"
        environment:
          $ref: "#/components/schemas/DataPlaneGroupEnvironmentConfigurations"
      additionalProperties: false
      required:
        - autoscale
        - provider
        - region
        - cloud_gateway_network_id
      title: Dedicated Data-Plane Group Configuration
    CloudGatewaysProviderName:
      description: Name of cloud provider.
      type: string
      example: aws
      enum:
        - aws
        - azure
        - gcp
    DataPlaneGroupAutoscale:
      oneOf:
        - $ref: "#/components/schemas/DataPlaneGroupAutoscaleStatic"
        - $ref: "#/components/schemas/DataPlaneGroupAutoscaleAutopilot"
    DataPlaneGroupEnvironmentConfigurations:
      description: Array of environment configurations for a data-plane group.
      type: array
      items:
        $ref: "#/components/schemas/DataPlaneGroupEnvironmentConfigurationItem"
      title: Data-Plane Group Environment Configurations
    ServerlessDataPlaneGroupConfigItem:
      description: >
        Object that describes where a serverless data-plane group will be
        deployed to.
      type: object
      properties:
        region:
          description: Region of cloud provider the cloud gateways will be deployed to.
          type: string
          example: us
      additionalProperties: false
      required:
        - region
      title: Serverless Data-Plane Group Configuration
    ServerlessV1DataPlaneGroupConfigItem:
      description: >
        Object that describes where a serverless v1 data-plane group will be
        deployed to, along with how many instances.
      type: object
      properties:
        provider:
          $ref: "#/components/schemas/ServerlessV1ProviderName"
        region:
          description: Region of cloud provider the serverless v1 gateways will be
            deployed to.
          type: string
          example: us
        environment:
          $ref: "#/components/schemas/DataPlaneGroupEnvironmentConfigurations"
      additionalProperties: false
      required:
        - provider
        - region
      title: Serverless V1 Data-Plane Group Configuration
    ServerlessV1ProviderName:
      description: Name of cloud provider.
      type: string
      example: aws
      enum:
        - aws
    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
    DataPlaneGroupAutoscaleStatic:
      description: Object that describes the static autoscaling strategy. Deprecated
        in favor of the autopilot autoscaling strategy. Static autoscaling will
        be removed in a future version.
      type: object
      properties:
        kind:
          type: string
          enum:
            - static
        instance_type:
          $ref: "#/components/schemas/CloudGatewaysInstanceTypeName"
        requested_instances:
          description: Number of cloud gateways the deployment target will contain.
          type: integer
          example: 3
      additionalProperties: false
      deprecated: true
      required:
        - kind
        - instance_type
        - requested_instances
      title: Data-Plane Group Autoscale Static
    DataPlaneGroupAutoscaleAutopilot:
      description: Object that describes the autopilot autoscaling strategy.
      type: object
      properties:
        kind:
          type: string
          enum:
            - autopilot
        base_rps:
          description: Base number of requests per second that the deployment target
            should support.
          type: integer
          example: 1
        max_rps:
          description: Max number of requests per second that the deployment target should
            support. If not set, this defaults to 10x base_rps. This field is
            deprecated and shouldn't be used in new configurations as it will be
            removed in a future version. max_rps is now calculated as 10x
            base_rps.
          type: integer
          example: 1000
          deprecated: true
      additionalProperties: false
      required:
        - kind
        - base_rps
      title: Data-Plane Group Autoscale Autopilot
    DataPlaneGroupEnvironmentConfigurationItem:
      description: Object that describes the environment configurations for a
        data-plane group. Env names must be prefixed by KONG_.
      type: object
      properties:
        name:
          description: Name of environment variable. Only env names prefixed by KONG_ are
            allowed.
          type: string
          example: KONG_LOG_LEVEL
        value:
          description: Value assigned to the corresponding environment variable.
          type: string
          example: INFO
      additionalProperties: false
      required:
        - name
        - value
      title: Data-Plane Group Environment Configurations
    CloudGatewaysInstanceTypeName:
      description: Instance type name to indicate capacity.
      type: string
      enum:
        - small
        - medium
        - large
  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
  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...'`
```
