---
title: "List Transit Gateways"
url: "https://nov18-dev.movespot.fyi/apis/konnect-cloud-gateways-2/versions/b826cacf-03b8-4340-bb4e-daa3648a655b/operations/list-transit-gateways"
---

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

# List Transit Gateways

`GET` `/cloud-gateways/networks/{networkId}/transit-gateways`

Operation ID: `list-transit-gateways`

Returns a paginated collection of transit gateways for a given network.

## Path parameters

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

## Query parameters

- `filter` (object, optional) - Filters supported for transit gateways.
- `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 transit gateways for 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}/transit-gateways:
    get:
      operationId: list-transit-gateways
      summary: List Transit Gateways
      description: Returns a paginated collection of transit gateways for a given network.
      parameters:
        - $ref: "#/components/parameters/NetworkId"
        - $ref: "#/components/parameters/TransitGatewaysFilter"
        - $ref: "#/components/parameters/PageSize"
        - $ref: "#/components/parameters/PageNumber"
      responses:
        "200":
          $ref: "#/components/responses/ListTransitGatewaysResponse"
        "400":
          $ref: "#/components/responses/CloudGatewaysBadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
      tags:
        - Transit Gateways
security:
  - konnectAccessToken: []
  - personalAccessToken: []
  - systemAccountAccessToken: []
components:
  parameters:
    NetworkId:
      name: networkId
      in: path
      description: The network to operate on.
      required: true
      schema:
        $ref: "#/components/schemas/NetworkId"
    TransitGatewaysFilter:
      name: filter
      description: Filters supported for transit gateways.
      required: false
      in: query
      schema:
        $ref: "#/components/schemas/TransitGatewaysFilterParameters"
      style: deepObject
    PageSize:
      name: page[size]
      description: The maximum number of items to include per page. The last page of a
        collection may include fewer items.
      required: false
      in: query
      allowEmptyValue: true
      schema:
        type: integer
        example: 10
    PageNumber:
      name: page[number]
      description: Determines which page of the entities to retrieve.
      required: false
      in: query
      allowEmptyValue: true
      schema:
        type: integer
        example: 1
  responses:
    ListTransitGatewaysResponse:
      description: A paginated list for a collection of transit gateways for a network.
      content:
        application/json:
          schema:
            type: object
            properties:
              meta:
                $ref: "#/components/schemas/PaginatedMeta"
              data:
                type: array
                items:
                  $ref: "#/components/schemas/TransitGatewayResponse"
            required:
              - meta
              - data
            title: ListTransitGatewaysResponse
    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
    TransitGatewaysFilterParameters:
      type: object
      properties:
        name:
          $ref: "#/components/schemas/CloudGatewaysStringFieldFilterOverride"
        state:
          $ref: "#/components/schemas/TransitGatewayStateFieldFilter"
      additionalProperties: false
      title: TransitGatewaysFilterParameters
    PaginatedMeta:
      description: returns the pagination information
      type: object
      properties:
        page:
          $ref: "#/components/schemas/PageMeta"
      required:
        - page
      title: PaginatedMeta
    TransitGatewayResponse:
      oneOf:
        - $ref: "#/components/schemas/AwsTransitGatewayResponse"
        - $ref: "#/components/schemas/AwsVpcPeeringGatewayResponse"
        - $ref: "#/components/schemas/AzureTransitGatewayResponse"
        - $ref: "#/components/schemas/AzureVHubPeeringGatewayResponse"
        - $ref: "#/components/schemas/GCPVPCPeeringGatewayResponse"
        - $ref: "#/components/schemas/AwsResourceEndpointGatewayResponse"
    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
    CloudGatewaysStringFieldFilterOverride:
      description: "Filter using **one** of the following operators: `eq`, `oeq`,
        `neq`, `contains`, `ocontains`"
      type: object
      properties:
        eq:
          description: The field exactly matches the provided value.
          type: string
          example: ?filter[field_name_here][eq]=foo
        contains:
          description: The field contains the provided value.
          type: string
          example: ?filter[field_name_here][contains]=foo
        neq:
          description: The field does not match the provided value.
          type: string
          example: ?filter[field_name_here][neq]=bar
        oeq:
          description: The field matches any of the provided values.
          type: string
          example: ?filter[field_name_here][oeq]=foo,bar
        ocontains:
          description: The field contains any of the provided values.
          type: string
          example: ?filter[field_name_here][ocontains]=foo,bar
      additionalProperties: false
      x-examples:
        example-1:
          contains: some-value
          neq: not-this-value
          oeq: some-value,some-other-value
          ocontains: this-value,or-that-value
        example-2:
          eq: some-value
    TransitGatewayStateFieldFilter:
      oneOf:
        - $ref: "#/components/schemas/TransitGatewayStateFieldEqualsFilter"
        - $ref: "#/components/schemas/TransitGatewayStateFieldNotEqualsFilter"
        - $ref: "#/components/schemas/TransitGatewayStateFieldOrEqualityFilter"
      title: TransitGatewayStateFieldFilter
    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
    AwsTransitGatewayResponse:
      type: object
      properties:
        name:
          $ref: "#/components/schemas/TransitGatewayName"
        dns_config:
          $ref: "#/components/schemas/TransitGatewayDnsConfig"
        cidr_blocks:
          $ref: "#/components/schemas/TransitGatewayCIDRBlocks"
        transit_gateway_attachment_config:
          $ref: "#/components/schemas/AwsTransitGatewayAttachmentConfigForResponse"
        id:
          $ref: "#/components/schemas/TransitGatewayId"
        state:
          $ref: "#/components/schemas/TransitGatewayState"
        state_metadata:
          description: >
            Metadata describing the backing state of the transit gateway and why
            it may be in an erroneous state.
          type: object
          additionalProperties: false
          properties:
            reported_status:
              description: Reported status of the transit gateway from backing infrastructure.
              type: string
              example: ERROR
            reason:
              description: >
                Reason why the transit gateway may be in an erroneous state,
                reported from backing infrastructure.
              type: string
              example: >
                Transit Gateway Attachment configuration could not find a
                resource with the provided ram share arn.
          readOnly: true
          title: TransitGatewayStateMetadata
        entity_version:
          description: >
            Monotonically-increasing version count of the transit gateway, to
            indicate the order of updates to the

            transit gateway.
          type: integer
          example: 1
          readOnly: true
        created_at:
          description: An RFC-3339 timestamp representation of transit gateway 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 transit gateway update date.
          type: string
          format: date-time
          example: 2022-11-04T20:10:06.927Z
          readOnly: true
      required:
        - name
        - cidr_blocks
        - transit_gateway_attachment_config
        - dns_config
        - id
        - state
        - entity_version
        - created_at
        - updated_at
      title: AWS Transit Gateway
    AwsVpcPeeringGatewayResponse:
      type: object
      properties:
        name:
          $ref: "#/components/schemas/TransitGatewayName"
        dns_config:
          $ref: "#/components/schemas/TransitGatewayDnsConfig"
        cidr_blocks:
          $ref: "#/components/schemas/TransitGatewayCIDRBlocks"
        transit_gateway_attachment_config:
          $ref: "#/components/schemas/AwsVpcPeeringGatewayAttachmentConfigForResponse"
        id:
          $ref: "#/components/schemas/TransitGatewayId"
        state:
          $ref: "#/components/schemas/TransitGatewayState"
        state_metadata:
          description: >
            Metadata describing the backing state of the transit gateway and why
            it may be in an erroneous state.
          type: object
          additionalProperties: false
          properties:
            reported_status:
              description: Reported status of the transit gateway from backing infrastructure.
              type: string
              example: ERROR
            reason:
              description: >
                Reason why the transit gateway may be in an erroneous state,
                reported from backing infrastructure.
              type: string
              example: >
                Transit Gateway Attachment configuration could not find a
                resource with the provided ram share arn.
          readOnly: true
          title: TransitGatewayStateMetadata
        entity_version:
          description: >
            Monotonically-increasing version count of the transit gateway, to
            indicate the order of updates to the

            transit gateway.
          type: integer
          example: 1
          readOnly: true
        created_at:
          description: An RFC-3339 timestamp representation of transit gateway 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 transit gateway update date.
          type: string
          format: date-time
          example: 2022-11-04T20:10:06.927Z
          readOnly: true
      required:
        - name
        - cidr_blocks
        - transit_gateway_attachment_config
        - dns_config
        - id
        - state
        - entity_version
        - created_at
        - updated_at
      title: AWS VPC Peering Gateway
    AzureTransitGatewayResponse:
      type: object
      properties:
        name:
          $ref: "#/components/schemas/TransitGatewayName"
        dns_config:
          $ref: "#/components/schemas/TransitGatewayDnsConfig"
        transit_gateway_attachment_config:
          $ref: "#/components/schemas/AzureVNETPeeringAttachmentConfig"
        id:
          $ref: "#/components/schemas/TransitGatewayId"
        state:
          $ref: "#/components/schemas/TransitGatewayState"
        state_metadata:
          description: >
            Metadata describing the backing state of the transit gateway and why
            it may be in an erroneous state.
          type: object
          additionalProperties: false
          properties:
            reported_status:
              description: Reported status of the transit gateway from backing infrastructure.
              type: string
              example: ERROR
            reason:
              description: >
                Reason why the transit gateway may be in an erroneous state,
                reported from backing infrastructure.
              type: string
              example: >
                Transit Gateway Attachment configuration could not find a
                resource with the provided ram share arn.
          readOnly: true
          title: TransitGatewayStateMetadata
        entity_version:
          description: >
            Monotonically-increasing version count of the transit gateway, to
            indicate the order of updates to the

            transit gateway.
          type: integer
          example: 1
          readOnly: true
        created_at:
          description: An RFC-3339 timestamp representation of transit gateway 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 transit gateway update date.
          type: string
          format: date-time
          example: 2022-11-04T20:10:06.927Z
          readOnly: true
      required:
        - name
        - transit_gateway_attachment_config
        - id
        - dns_config
        - state
        - entity_version
        - created_at
        - updated_at
      title: Azure Transit Gateway
    AzureVHubPeeringGatewayResponse:
      type: object
      properties:
        name:
          $ref: "#/components/schemas/TransitGatewayName"
        dns_config:
          $ref: "#/components/schemas/TransitGatewayDnsConfig"
        transit_gateway_attachment_config:
          $ref: "#/components/schemas/AzureVHubPeeringAttachmentConfig"
        id:
          $ref: "#/components/schemas/TransitGatewayId"
        state:
          $ref: "#/components/schemas/TransitGatewayState"
        state_metadata:
          description: >
            Metadata describing the backing state of the transit gateway and why
            it may be in an erroneous state.
          type: object
          additionalProperties: false
          properties:
            reported_status:
              description: Reported status of the transit gateway from backing infrastructure.
              type: string
              example: ERROR
            reason:
              description: >
                Reason why the transit gateway may be in an erroneous state,
                reported from backing infrastructure.
              type: string
              example: >
                Transit Gateway Attachment configuration could not find a
                resource with the provided ram share arn.
          readOnly: true
          title: TransitGatewayStateMetadata
        entity_version:
          description: >
            Monotonically-increasing version count of the transit gateway, to
            indicate the order of updates to the

            transit gateway.
          type: integer
          example: 1
          readOnly: true
        created_at:
          description: An RFC-3339 timestamp representation of transit gateway 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 transit gateway update date.
          type: string
          format: date-time
          example: 2022-11-04T20:10:06.927Z
          readOnly: true
      required:
        - name
        - transit_gateway_attachment_config
        - id
        - dns_config
        - state
        - entity_version
        - created_at
        - updated_at
      title: Azure Virtual Hub Peering Gateway
    GCPVPCPeeringGatewayResponse:
      type: object
      properties:
        name:
          $ref: "#/components/schemas/TransitGatewayName"
        dns_config:
          $ref: "#/components/schemas/TransitGatewayDnsConfig"
        transit_gateway_attachment_config:
          $ref: "#/components/schemas/GCPVPCPeeringAttachmentConfig"
        id:
          $ref: "#/components/schemas/TransitGatewayId"
        state:
          $ref: "#/components/schemas/TransitGatewayState"
        state_metadata:
          description: >
            Metadata describing the backing state of the transit gateway and why
            it may be in an erroneous state.
          type: object
          additionalProperties: false
          properties:
            reported_status:
              description: Reported status of the transit gateway from backing infrastructure.
              type: string
              example: ERROR
            reason:
              description: >
                Reason why the transit gateway may be in an erroneous state,
                reported from backing infrastructure.
              type: string
              example: >
                Transit Gateway Attachment configuration could not find a
                resource with the provided ram share arn.
          readOnly: true
          title: TransitGatewayStateMetadata
        entity_version:
          description: >
            Monotonically-increasing version count of the transit gateway, to
            indicate the order of updates to the

            transit gateway.
          type: integer
          example: 1
          readOnly: true
        created_at:
          description: An RFC-3339 timestamp representation of transit gateway 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 transit gateway update date.
          type: string
          format: date-time
          example: 2022-11-04T20:10:06.927Z
          readOnly: true
      required:
        - name
        - transit_gateway_attachment_config
        - id
        - dns_config
        - state
        - entity_version
        - created_at
        - updated_at
      title: GCP VPC Peering Transit Gateway
    AwsResourceEndpointGatewayResponse:
      type: object
      properties:
        name:
          $ref: "#/components/schemas/TransitGatewayName"
        dns_config:
          $ref: "#/components/schemas/TransitGatewayDnsConfig"
        transit_gateway_attachment_config:
          $ref: "#/components/schemas/AwsResourceEndpointAttachmentConfigResponse"
        id:
          $ref: "#/components/schemas/TransitGatewayId"
        state:
          $ref: "#/components/schemas/TransitGatewayState"
        state_metadata:
          description: >
            Metadata describing the backing state of the transit gateway and why
            it may be in an erroneous state.
          type: object
          additionalProperties: false
          properties:
            reported_status:
              description: Reported status of the transit gateway from backing infrastructure.
              type: string
              example: ERROR
            reason:
              description: >
                Reason why the transit gateway may be in an erroneous state,
                reported from backing infrastructure.
              type: string
              example: >
                Transit Gateway Attachment configuration could not find a
                resource with the provided ram share arn.
          readOnly: true
          title: TransitGatewayStateMetadata
        entity_version:
          description: >
            Monotonically-increasing version count of the transit gateway, to
            indicate the order of updates to the

            transit gateway.
          type: integer
          example: 1
          readOnly: true
        created_at:
          description: An RFC-3339 timestamp representation of transit gateway 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 transit gateway update date.
          type: string
          format: date-time
          example: 2022-11-04T20:10:06.927Z
          readOnly: true
      required:
        - name
        - transit_gateway_attachment_config
        - id
        - dns_config
        - state
        - entity_version
        - created_at
        - updated_at
      title: AWS Resource Endpoint Gateway
    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
    TransitGatewayStateFieldEqualsFilter:
      description: Filter transit-gateway state by exact match.
      oneOf:
        - $ref: "#/components/schemas/TransitGatewayState"
        - type: object
          title: TransitGatewayStateFieldEqualsComparison
          properties:
            eq:
              $ref: "#/components/schemas/TransitGatewayState"
          required:
            - eq
      title: TransitGatewayStateFieldEqualsFilter
      x-examples:
        example-1: ready
        example-2:
          eq: ready
    TransitGatewayStateFieldNotEqualsFilter:
      description: Filter transit-gateway state by inequality match.
      type: object
      properties:
        neq:
          $ref: "#/components/schemas/TransitGatewayState"
      required:
        - neq
      title: TransitGatewayStateFieldNotEqualsFilter
      x-examples:
        example-1:
          neq: ready
    TransitGatewayStateFieldOrEqualityFilter:
      description: >
        Filter transit-gateway state by determining if the value is equal to any
        in a set of values, where the set is a

        comma-delimited list.
      type: object
      properties:
        oeq:
          type: string
      required:
        - oeq
      title: TransitGatewayStateFieldOrEqualityFilter
      x-examples:
        example-1:
          oeq: ready,initializing
    TransitGatewayName:
      description: Human-readable name of the transit gateway.
      type: string
      example: us-east-2 transit gateway
      title: Transit Gateway Name
    TransitGatewayDnsConfig:
      description: >
        List of mappings from remote DNS server IP address sets to proxied
        internal domains, for a transit gateway

        attachment.
      type: array
      items:
        type: object
        additionalProperties: false
        properties:
          remote_dns_server_ip_addresses:
            description: Remote DNS Server IP Addresses to connect to for resolving internal
              DNS via a transit gateway.
            type: array
            items:
              type: string
            example:
              - 10.0.0.2
            title: Remote DNS Server IP Addresses
          domain_proxy_list:
            description: >
              Internal domain names to proxy for DNS resolution from the listed
              remote DNS server IP addresses,

              for a transit gateway.
            type: array
            items:
              type: string
            example:
              - foobar.com
            title: Domain Proxy List
        required:
          - remote_dns_server_ip_addresses
          - domain_proxy_list
      title: Transit Gateway DNS Config
    TransitGatewayCIDRBlocks:
      description: >
        CIDR blocks for constructing a route table for the transit gateway, when
        attaching to the owning

        network.
      type: array
      items:
        type: string
      example:
        - 10.0.0.0/8
        - 100.64.0.0/10
        - 172.16.0.0/12
      title: Transit Gateway CIDR Blocks
    AwsTransitGatewayAttachmentConfigForResponse:
      type: object
      properties:
        kind:
          enum:
            - aws-transit-gateway-attachment
          title: AWS Transit Gateway Attachment Type
        transit_gateway_id:
          description: AWS Transit Gateway ID to create attachment to.
          type: string
          title: Transit Gateway ID
        ram_share_arn:
          description: Resource Share ARN to verify request to create transit gateway
            attachment.
          type: string
          title: RAM Share ARN
        attachment_id:
          description: ID of the AWS Transit Gateway attachment.
          type: string
          title: AWS Transit Gateway Attachment ID
      additionalProperties: false
      required:
        - kind
        - transit_gateway_id
        - ram_share_arn
      title: AWS Transit Gateway Attachment Config
    TransitGatewayId:
      type: string
      format: uuid
      example: 0850820b-d153-4a2a-b9be-7d2204779139
      readOnly: true
    TransitGatewayState:
      description: >
        The current state of the Transit Gateway. Possible values:

        - `created` - The attachment has been created but is not attached to
        transit gateway.

        - `initializing` - The attachment is in the process of being initialized
        and is setting up necessary resources.

        - `pending-acceptance` The attachment request is awaiting acceptance in
        customer VPC.

        - `pending-user-action` The attachment request is awaiting user action
        in customer VPC.

        - `ready` - The transit gateway attachment is fully operational and can
        route traffic as configured.

        - `terminating` - The attachment is in the process of being deleted and
        is no longer accepting new traffic.

        - `terminated` - The attachment has been fully deleted and is no longer
        available.

        - `error` - The attachment is in an error state.
      type: string
      enum:
        - created
        - initializing
        - pending-acceptance
        - pending-user-action
        - ready
        - terminating
        - terminated
        - error
      readOnly: true
      title: Transit Gateway State
    AwsVpcPeeringGatewayAttachmentConfigForResponse:
      type: object
      properties:
        kind:
          enum:
            - aws-vpc-peering-attachment
          title: AWS VPC Peering Attachment Config
        peer_account_id:
          type: string
        peer_vpc_id:
          type: string
        peer_vpc_region:
          type: string
        peering_connection_id:
          type: string
      additionalProperties: false
      required:
        - kind
        - peer_account_id
        - peer_vpc_id
        - peer_vpc_region
      title: AWS VPC Peering Attachment Config
    AzureVNETPeeringAttachmentConfig:
      type: object
      properties:
        kind:
          enum:
            - azure-vnet-peering-attachment
          title: Azure VNET Peering Attachment Type
        tenant_id:
          description: Tenant ID for the Azure VNET Peering attachment.
          type: string
          title: Tenant ID
        subscription_id:
          description: Subscription ID for the Azure VNET Peering attachment.
          type: string
          title: Subscription ID
        resource_group_name:
          description: Resource Group Name for the Azure VNET Peering attachment.
          type: string
          title: Resource Group Name
        vnet_name:
          description: VNET Name for the Azure VNET Peering attachment.
          type: string
          title: VNET Name
      additionalProperties: false
      required:
        - kind
        - tenant_id
        - subscription_id
        - resource_group_name
        - vnet_name
      title: Azure VNET Peering Attachment Config
    AzureVHubPeeringAttachmentConfig:
      type: object
      properties:
        kind:
          enum:
            - azure-vhub-peering-attachment
          title: Azure Virtual Hub Peering Attachment Type
        tenant_id:
          description: Tenant ID of the Azure Virtual Hub resource.
          type: string
          title: Tenant ID
        subscription_id:
          description: Subscription ID of the Azure Virtual Hub resource.
          type: string
          title: Subscription ID
        resource_group_name:
          description: Resource Group Name of the Azure Virtual Hub resource.
          type: string
          title: Resource Group Name
        vhub_name:
          description: Name of the Azure Virtual Hub resource.
          type: string
          title: Virtual Hub Name
      additionalProperties: false
      required:
        - kind
        - tenant_id
        - subscription_id
        - resource_group_name
        - vhub_name
      title: Azure Virtual Hub Peering Attachment Config
    GCPVPCPeeringAttachmentConfig:
      type: object
      properties:
        kind:
          enum:
            - gcp-vpc-peering-attachment
          title: GCP VPC Peering Attachment Type
        peer_project_id:
          description: GCP Project ID of the peer account to create attachment to.
          type: string
          title: GCP Project ID
        peer_vpc_name:
          description: GCP VPC Name of the peer account to create attachment to.
          type: string
          title: GCP VPC Name
      additionalProperties: false
      required:
        - kind
        - peer_project_id
        - peer_vpc_name
      title: GCP VPC Peering Attachment Config
    AwsResourceEndpointAttachmentConfigResponse:
      type: object
      properties:
        kind:
          enum:
            - aws-resource-endpoint-attachment
          title: AWS Resource Endpoint Attachment Type
        ram_share_arn:
          description: Resource Share ARN to verify request to create transit gateway
            attachment.
          type: string
          title: RAM Share ARN
        resource_config:
          $ref: "#/components/schemas/AwsResourceEndpointConfigResponse"
      additionalProperties: false
      required:
        - kind
        - ram_share_arn
        - resource_config
      title: AWS Resource Endpoint Attachment Config Response
    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
    AwsResourceEndpointConfigResponse:
      description: |
        List of unique resource config mapping for aws resource endpoint.
      type: array
      items:
        type: object
        additionalProperties: false
        properties:
          resource_config_id:
            description: Resource Config ID to uniquely identify a resource configuration.
            type: string
            title: Resource Config ID
          domain_name:
            description: Domain Name to uniquely identify a resource configuration.
            type: string
            title: Domain Name
          state:
            $ref: "#/components/schemas/AwsResourceEndpointConfigState"
        required:
          - resource_config_id
          - domain_name
          - state
      title: AWS Resource Endpoint Config Response
    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
    AwsResourceEndpointConfigState:
      description: >
        The current state of the resource config in AWS Resource Endpoint.
        Possible values:

        - `initializing` - The config is in the process of being initialized and
        is setting up necessary resources.

        - `missing` - The config is missing and is no longer accepting new
        traffic.

        - `ready` - The config is fully operational and can route traffic as
        configured.

        - `error` - The config is in an error state, and is not operational.

        - `terminating` - The config is in the process of being deleted and is
        no longer accepting new traffic.
      type: string
      enum:
        - initializing
        - missing
        - ready
        - error
        - terminating
      readOnly: true
      title: AWS Resource Endpoint Config State
  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...'`
```
