---
title: "List Network Configuration References"
url: "https://nov18-dev.movespot.fyi/apis/konnect-cloud-gateways-2/versions/b826cacf-03b8-4340-bb4e-daa3648a655b/operations/list-network-configurations"
---

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

# List Network Configuration References

`GET` `/cloud-gateways/networks/{networkId}/configuration-references`

Operation ID: `list-network-configurations`

Returns a paginated collection of configurations that reference a network.

## Path parameters

- `networkId` (string, uuid, required) - The network to operate on.

## 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.

## Responses

- `200` - A paginated list for a collection of configurations that reference a network.
- `400` - Bad Request
- `401` - Unauthorized
- `403` - Forbidden
- `404` - Not Found

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Konnect Cloud Gateways
  version: 2.0.0
servers:
  - url: https://global.api.konghq.com/v2
    description: Base URL for the global region
paths:
  /cloud-gateways/networks/{networkId}/configuration-references:
    get:
      operationId: list-network-configurations
      summary: List Network Configuration References
      description: >
        Returns a paginated collection of configurations that reference a
        network.
      parameters:
        - $ref: "#/components/parameters/NetworkId"
        - $ref: "#/components/parameters/PageSize"
        - $ref: "#/components/parameters/PageNumber"
      responses:
        "200":
          $ref: "#/components/responses/ListNetworkConfigurationReferencesResponse"
        "400":
          $ref: "#/components/responses/CloudGatewaysBadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
      tags:
        - Networks
security:
  - konnectAccessToken: []
  - personalAccessToken: []
  - systemAccountAccessToken: []
components:
  parameters:
    NetworkId:
      name: networkId
      in: path
      description: The network to operate on.
      required: true
      schema:
        $ref: "#/components/schemas/NetworkId"
    PageSize:
      name: page[size]
      description: The maximum number of items to include per page. The last page of a
        collection may include fewer items.
      required: false
      in: query
      allowEmptyValue: true
      schema:
        type: integer
        example: 10
    PageNumber:
      name: page[number]
      description: Determines which page of the entities to retrieve.
      required: false
      in: query
      allowEmptyValue: true
      schema:
        type: integer
        example: 1
  responses:
    ListNetworkConfigurationReferencesResponse:
      description: A paginated list for a collection of configurations that reference
        a network.
      content:
        application/json:
          schema:
            type: object
            properties:
              meta:
                $ref: "#/components/schemas/PaginatedMeta"
              data:
                type: array
                items:
                  $ref: "#/components/schemas/NetworkConfigurationReference"
            required:
              - meta
              - data
            title: ListNetworkConfigurationReferencesResponse
    CloudGatewaysBadRequest:
      description: Bad Request
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/BadRequestError"
          examples:
            Network Name Length Exceeded:
              $ref: "#/components/examples/NetworkNameLengthCheckBadRequestExample"
            Transit Gateway Name Length Exceeded:
              $ref: "#/components/examples/TransitGatewayNameLengthCheckBadRequestExample"
            Custom Domain Domain Length Too Short:
              $ref: "#/components/examples/CustomDomainLengthCheckBadRequestExample"
            Configuration Api Access Enum Validation:
              $ref: "#/components/examples/ConfigurationApiAccessBadRequestExample"
            Configuration Data-Plane Group Static Request Instances Minimum:
              $ref: "#/components/examples/ConfigurationDataPlaneGroupStaticRequestedInstance\
                sBadRequestExample"
            Configuration Data-Plane Group Autopilot Base RPS Minimum:
              $ref: "#/components/examples/ConfigurationDataPlaneGroupAutopilotBaseRpsBadRequ\
                estExample"
    Unauthorized:
      description: Unauthorized
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/UnauthorizedError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/UnauthorizedExample"
    Forbidden:
      description: Forbidden
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/ForbiddenError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/ForbiddenExample"
    NotFound:
      description: Not Found
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/NotFoundError"
          examples:
            NotFoundExample:
              $ref: "#/components/examples/NotFoundExample"
  schemas:
    NetworkId:
      description: The network ID to operate on. For serverless.v1 kind of cloud
        gateways, this field should be omitted.
      type: string
      format: uuid
      example: 36ae63d3-efd1-4bec-b246-62aa5d3f5695
    PaginatedMeta:
      description: returns the pagination information
      type: object
      properties:
        page:
          $ref: "#/components/schemas/PageMeta"
      required:
        - page
      title: PaginatedMeta
    NetworkConfigurationReference:
      $ref: "#/components/schemas/ConfigurationManifest"
    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
    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
    ConfigurationManifest:
      description: Object containing information about a control-plane's
        cloud-gateways configuration.
      type: object
      properties:
        id:
          $ref: "#/components/schemas/ConfigurationId"
        version:
          $ref: "#/components/schemas/GatewayVersion"
        api_access:
          $ref: "#/components/schemas/ApiAccess"
        dataplane_group_config:
          description: Object that describes where data-planes will be deployed to, along
            with how many instances.
          type: array
          items:
            $ref: "#/components/schemas/ConfigurationDataPlaneGroupConfig"
          title: Configuration Data-Plane Group Configs
        dataplane_groups:
          description: >
            List of data-plane groups that describe where data-planes will be
            deployed to, along with how many

            instances.
          type: array
          items:
            $ref: "#/components/schemas/ConfigurationDataPlaneGroup"
          format: set
        kind:
          $ref: "#/components/schemas/ConfigurationKind"
        entity_version:
          description: >
            Positive, monotonically increasing version integer, to serialize
            configuration changes.
          type: number
          example: 1
          readOnly: true
        created_at:
          description: An RFC-3339 timestamp representation of configuration creation date.
          type: string
          format: date-time
          example: 2022-11-04T20:10:06.927Z
          readOnly: true
        updated_at:
          description: An RFC-3339 timestamp representation of configuration update date.
          type: string
          format: date-time
          example: 2022-11-04T20:10:06.927Z
          readOnly: true
        control_plane_id:
          $ref: "#/components/schemas/ControlPlaneId"
        control_plane_geo:
          $ref: "#/components/schemas/ControlPlaneGeo"
      required:
        - id
        - control_plane_id
        - control_plane_geo
        - dataplane_group_config
        - dataplane_groups
        - entity_version
        - created_at
        - updated_at
      title: 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
    ConfigurationId:
      type: string
      format: uuid
      example: edaf40f9-9fb0-4ffe-bb74-4e763a6bd471
      readOnly: true
    GatewayVersion:
      description: Supported gateway version. For serverless.v1 kind of cloud
        gateways, this field should be omitted.
      type: string
      example: "3.2"
      title: Gateway Version
    ApiAccess:
      description: Type of API access data-plane groups will support for a configuration.
      type: string
      example: private+public
      default: private+public
      enum:
        - private
        - public
        - private+public
    ConfigurationDataPlaneGroupConfig:
      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/ProviderName"
        region:
          $ref: "#/components/schemas/ProviderRegionId"
        cloud_gateway_network_id:
          $ref: "#/components/schemas/NetworkId"
        autoscale:
          $ref: "#/components/schemas/ConfigurationDataPlaneGroupAutoscale"
        environment:
          $ref: "#/components/schemas/ConfigurationDataPlaneGroupEnvironment"
      additionalProperties: false
      required:
        - provider
        - region
      title: Configuration Data-Plane Group Config Item
    ConfigurationDataPlaneGroup:
      description: Object that describes the set of data-plane groups currently
        pointed to this configuration.
      type: object
      properties:
        id:
          $ref: "#/components/schemas/DataPlaneGroupId"
        provider:
          $ref: "#/components/schemas/ProviderName"
        region:
          $ref: "#/components/schemas/ProviderRegionId"
        autoscale:
          $ref: "#/components/schemas/ConfigurationDataPlaneGroupAutoscale"
        environment:
          $ref: "#/components/schemas/ConfigurationDataPlaneGroupEnvironment"
        cloud_gateway_network_id:
          $ref: "#/components/schemas/NetworkId"
        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.
        private_ip_addresses:
          description: >
            List of private IP addresses of the internal load balancer that
            proxies traffic to this data-plane group.
          type: array
          items:
            type: string
          example:
            - 192.168.248.132
            - 192.168.66.81
            - 192.168.137.135
        egress_ip_addresses:
          description: >
            List of egress IP addresses for the network that this data-plane
            group runs on.
          type: array
          items:
            type: string
          example:
            - 71.78.149.75
            - 91.149.112.244
            - 51.235.15.121
        created_at:
          description: An RFC-3339 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 RFC-3339 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: Cloud Gateway Configuration Data-Plane Group
    ConfigurationKind:
      description: >-
        **Pre-release Feature**

        This feature is currently in beta and is subject to change.


        Kind of the Cloud Gateway deployment. If serverless.v1 is specified, the
        following fields

        should be omitted (will be ignored if provided): autoscale,
        cloud_gateway_network_id, version.
      type: string
      default: dedicated.v0
      enum:
        - dedicated.v0
        - serverless.v1
      title: ConfigurationKind
    ControlPlaneId:
      type: string
      format: uuid
      example: 0949471e-b759-45ba-87ab-ee63fb781388
    ControlPlaneGeo:
      description: Set of control-plane geos supported for deploying cloud-gateways
        configurations.
      type: string
      enum:
        - us
        - eu
        - au
        - me
        - in
        - sg
      title: Control-Plane Geo
    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
    ProviderName:
      description: Name of cloud provider.
      type: string
      example: aws
      enum:
        - aws
        - azure
        - gcp
      title: Provider Name
    ProviderRegionId:
      description: Region ID for cloud provider region.
      type: string
      example: us-east-2
      title: Provider Region ID
    ConfigurationDataPlaneGroupAutoscale:
      oneOf:
        - $ref: "#/components/schemas/ConfigurationDataPlaneGroupAutoscaleStatic"
        - $ref: "#/components/schemas/ConfigurationDataPlaneGroupAutoscaleAutopilot"
    ConfigurationDataPlaneGroupEnvironment:
      description: Array of environment variables to set for a data-plane group.
      type: array
      items:
        $ref: "#/components/schemas/ConfigurationDataPlaneGroupEnvironmentField"
      title: Configuration Data-Plane Group Environment
    DataPlaneGroupId:
      description: ID of the data-plane group that represents a deployment target for
        a set of data-planes.
      type: string
      format: uuid
      example: cbb8872a-1f83-4806-bf69-fdf0b4783c7e
      readOnly: true
    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
    ConfigurationDataPlaneGroupAutoscaleStatic:
      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. For serverless.v1 kind of cloud
        gateways, this field should be omitted.
      type: object
      properties:
        kind:
          type: string
          enum:
            - static
        instance_type:
          $ref: "#/components/schemas/InstanceTypeName"
        requested_instances:
          description: Number of data-planes the deployment target will contain.
          type: integer
          example: 3
      additionalProperties: false
      deprecated: true
      required:
        - kind
        - instance_type
        - requested_instances
      title: Configuration Autoscale Static
    ConfigurationDataPlaneGroupAutoscaleAutopilot:
      description: Object that describes the autopilot autoscaling strategy. For
        serverless.v1 kind of cloud gateways, this field should be omitted.
      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: Configuration Autoscale Autopilot
    ConfigurationDataPlaneGroupEnvironmentField:
      description: Environment variable name and value to set for a data-plane group.
      type: object
      properties:
        name:
          description: >
            Name of the environment variable field to set for the data-plane
            group. Must be prefixed by KONG_.
          type: string
          format: ^KONG_[a-zA-Z_]+[a-zA-Z0-9_]*
          example: KONG_LOG_LEVEL
          maxLength: 120
          minLength: 6
        value:
          description: Value assigned to the environment variable field for the data-plane
            group.
          type: string
          example: info
          maxLength: 120
          minLength: 1
      required:
        - name
        - value
      title: Configuration Data-Plane Group Environment Field
    InstanceTypeName:
      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
    NotFoundExample:
      value:
        status: 404
        title: Not Found
        instance: kong:trace:6816496025408232265
        detail: Not Found
  securitySchemes:
    konnectAccessToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        The Konnect access token is meant to be used by the Konnect dashboard
        and the decK CLI authenticate with.
    personalAccessToken:
      type: http
      scheme: bearer
      bearerFormat: Token
      description: >
        The personal access token is meant to be used as an alternative to
        basic-auth when accessing Konnect via APIs.

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

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

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

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

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

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