---
title: "Create Configuration"
url: "https://nov18-dev.movespot.fyi/apis/konnect-cloud-gateways-internal-2/versions/53f44c10-7c5c-44ed-9e12-01aa08aa0a32/operations/create-configuration"
---

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

# Create Configuration

`PUT` `/cloud-gateways/configurations`

Operation ID: `create-configuration`

Creates a new dedicated or serverless configuration for a control-plane (restricted by permitted control-plane permissions for configurations). This request will replace any existing configuration for the requested control_plane_id and control_plane_geo by performing a diff. From this diff, new resources detected in the requested configuration will be added, resources not found in the request configuration but in the previous will be deleted, and resources found in both will be updated to the requested configuration. Networks referenced in this request that are in an offline state will automatically initialize (i.e. move to an initializing state).

## Request body (required)

Content types: `application/json`

## Responses

- `200` - Response format for creating a configuration.
- `400` - Bad Request
- `401` - Unauthorized
- `403` - Forbidden
- `404` - Not Found
- `409` - Conflict

## 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:
    put:
      operationId: create-configuration
      summary: Create Configuration
      description: >
        Creates a new dedicated or serverless configuration for a control-plane
        (restricted by permitted control-plane

        permissions for configurations). This request will replace any existing
        configuration for the requested

        control_plane_id and control_plane_geo by performing a diff. From this
        diff, new resources detected in the

        requested configuration will be added, resources not found in the
        request configuration but in the previous will

        be deleted, and resources found in both will be updated to the requested
        configuration. Networks referenced in

        this request that are in an offline state will automatically initialize
        (i.e. move to an initializing state).
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateConfigurationRequest"
      responses:
        "200":
          $ref: "#/components/responses/CreateConfigurationResponse"
        "400":
          $ref: "#/components/responses/CloudGatewaysBadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "403":
          $ref: "#/components/responses/CloudGatewaysForbidden"
        "404":
          $ref: "#/components/responses/NotFound"
        "409":
          $ref: "#/components/responses/CloudGatewaysConflict"
      tags:
        - Data-Plane Group Configurations
security:
  - konnectAccessToken: []
  - personalAccessToken: []
  - systemAccountAccessToken: []
components:
  schemas:
    CreateConfigurationRequest:
      description: Request schema for creating a configuration.
      type: object
      oneOf:
        - $ref: "#/components/schemas/DedicatedCreateConfigurationRequest"
        - $ref: "#/components/schemas/ServerlessCreateConfigurationRequest"
        - $ref: "#/components/schemas/ServerlessV1CreateConfigurationRequest"
      title: CreateConfigurationRequest
    DedicatedCreateConfigurationRequest:
      type: object
      allOf:
        - $ref: "#/components/schemas/BaseCreateConfigurationRequest"
        - properties:
            kind:
              description: |
                Provisioning backend to use for deploying data-plane groups.
              type: string
              enum:
                - dedicated.v0
            version:
              description: Gateway version to configure data-plane groups with.
              type: string
              example: "3.2"
              pattern: ^(\d)+(\.(\d)+)?$
            dataplane_groups:
              description: List of data-plane groups that describe where to deploy instances,
                along with how many instances.
              type: array
              items:
                $ref: "#/components/schemas/DedicatedCreateDataPlaneGroup"
            api_access:
              $ref: "#/components/schemas/CloudGatewayApiAccess"
          required:
            - version
            - dataplane_groups
    ServerlessCreateConfigurationRequest:
      type: object
      allOf:
        - $ref: "#/components/schemas/BaseCreateConfigurationRequest"
        - properties:
            kind:
              description: |
                Provisioning backend to use for deploying data-plane groups.
              type: string
              enum:
                - serverless.v0
            dataplane_groups:
              description: >
                List of data-plane groups that describe where to deploy
                serverless instances, along with how many

                instances. As part of serverless business logic, the max number
                of data-plane groups a serverless

                configuration can have is 1.
              type: array
              items:
                $ref: "#/components/schemas/ServerlessCreateDataPlaneGroup"
              maxLength: 1
          required:
            - dataplane_groups
    ServerlessV1CreateConfigurationRequest:
      type: object
      allOf:
        - $ref: "#/components/schemas/BaseCreateConfigurationRequest"
        - properties:
            kind:
              description: |
                Provisioning backend to use for deploying data-plane groups.
              type: string
              enum:
                - serverless.v1
            dataplane_groups:
              description: List of data-plane groups that describe where to deploy instances,
                along with how many instances.
              type: array
              items:
                $ref: "#/components/schemas/ServerlessV1CreateDataPlaneGroup"
          required:
            - dataplane_groups
    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
    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
    ConflictError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 409
            title:
              example: Conflict
            type:
              example: https://httpstatuses.com/409
            instance:
              example: kong:trace:1234567890
            detail:
              example: Conflict
    BaseCreateConfigurationRequest:
      type: object
      properties:
        kind:
          description: |
            Provisioning backend to use for deploying data-plane groups.
          type: string
          enum:
            - dedicated.v0
            - serverless.v0
            - serverless.v1
        control_plane_id:
          description: ID of the control-plane this configuration belongs to.
          type: string
          format: uuid
          example: b5922611-a763-499e-8d86-5643de122768
        control_plane_geo:
          $ref: "#/components/schemas/ControlPlaneGeo"
      discriminator:
        propertyName: kind
        mapping:
          serverless.v0: "#/components/schemas/ServerlessCreateConfigurationRequest"
          dedicated.v0: "#/components/schemas/DedicatedCreateConfigurationRequest"
          serverless.v1: "#/components/schemas/ServerlessV1CreateConfigurationRequest"
      required:
        - kind
        - control_plane_id
        - control_plane_geo
      title: Base Create Configuration Request
    DedicatedCreateDataPlaneGroup:
      description: Object that describes where to deploy a dedicated gateway, along
        with how many instances.
      type: object
      properties:
        provider:
          $ref: "#/components/schemas/CloudGatewaysProviderName"
        region:
          description: Region of cloud provider to deploy dedicated gateways to.
          type: string
          example: us-east-2
        cloud_gateway_network_id:
          description: Network ID data-plane group will be 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: CreateCloudGatewayConfigurationDataplaneGroup
    CloudGatewayApiAccess:
      description: |
        Type of API access dataplane groups will support for a configuration.
      type: string
      default: private+public
      enum:
        - private
        - private+public
        - public
    ServerlessCreateDataPlaneGroup:
      type: object
      properties:
        region:
          description: Region to deploy serverless gateways to.
          type: string
          example: us
      additionalProperties: false
      required:
        - region
    ServerlessV1CreateDataPlaneGroup:
      description: Object that describes where to deploy a serverless v1 gateway,
        along with how many instances.
      type: object
      properties:
        provider:
          $ref: "#/components/schemas/ServerlessV1ProviderName"
        region:
          description: Region of cloud provider to deploy serverless v1 gateways to.
          type: string
          example: us
        environment:
          $ref: "#/components/schemas/DataPlaneGroupEnvironmentConfigurations"
      additionalProperties: false
      required:
        - provider
        - region
      title: CreateCloudGatewayConfigurationServerlessV1DataplaneGroup
    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
    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
    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
    ServerlessV1ProviderName:
      description: Name of cloud provider.
      type: string
      example: aws
      enum:
        - aws
    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
    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
    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
    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
    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
    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
    CloudGatewaysInstanceTypeName:
      description: Instance type name to indicate capacity.
      type: string
      enum:
        - small
        - medium
        - large
  responses:
    CreateConfigurationResponse:
      description: Response format for creating a configuration.
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/ConfigurationManifest"
    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"
    CloudGatewaysForbidden:
      description: Forbidden
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/ForbiddenError"
          examples:
            Permission Denied:
              $ref: "#/components/examples/PermissionDeniedExample"
            Quota Exceeded:
              $ref: "#/components/examples/QuotaExceededExample"
    NotFound:
      description: Not Found
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/NotFoundError"
          examples:
            NotFoundExample:
              $ref: "#/components/examples/NotFoundExample"
    CloudGatewaysConflict:
      description: Conflict
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/ConflictError"
          examples:
            Configuration Conflict:
              $ref: "#/components/examples/ConfigurationConflictExample"
  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
    PermissionDeniedExample:
      value:
        status: 403
        title: Forbidden
        instance: konnect:trace:2822394689570210664
        detail: You do not have permission to perform this action.
    QuotaExceededExample:
      value:
        status: 403
        title: Quota Exceeded
        instance: konnect:trace:2822394689570210664
        detail: "Maximum number of <quota name> exceeded. Max allowed: <quota value>."
    NotFoundExample:
      value:
        status: 404
        title: Not Found
        instance: kong:trace:6816496025408232265
        detail: Not Found
    ConfigurationConflictExample:
      value:
        status: 409
        title: Conflict
        instance: konnect:trace:2822394689570210664
        detail: Proposed cloud gateway configuration and current cloud gateway
          configuration are identical.
  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...'`
```
