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

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

# Configuration

Object containing information about a control-plane's cloud-gateways configuration.

## 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
components:
  schemas:
    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
    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
    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
    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
    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
```
