---
title: "Network"
url: "https://nov18-dev.movespot.fyi/apis/konnect-cloud-gateways-2/versions/b826cacf-03b8-4340-bb4e-daa3648a655b/schemas/Network"
---

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

# Network

Object containing information about a network to be used in configurations.

## 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
components:
  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
    NetworkName:
      description: Human-readable name of the network.
      type: string
      example: us-east-2 network
      title: Network Name
    ProviderAccountId:
      type: string
      format: uuid
      example: 929b2449-c69f-44c4-b6ad-9ecec6f811ae
    ProviderRegionId:
      description: Region ID for cloud provider region.
      type: string
      example: us-east-2
      title: Provider Region ID
    NetworkAvailabilityZones:
      description: List of availability zones that the network is attached to.
      type: array
      items:
        type: string
      example:
        - use2-az1
        - use2-az2
        - use2-az3
    NetworkCIDRBlock:
      description: CIDR block configuration for the network.
      type: string
      example: 10.0.0.0/8
      title: Network CIDR Block
    NetworkState:
      description: State of the network.
      enum:
        - created
        - initializing
        - offline
        - ready
        - terminating
        - terminated
      readOnly: true
      title: Network State
    NetworkStateMetadata:
      description: >
        Metadata describing the backing state of the network and why it may be
        in an erroneous state.
      type: object
      properties:
        reported_status:
          description: Reported status of the network from backing infrastructure.
          type: string
          example: INVALID
        reason:
          description: >
            Reason why the network may be in an erroneous state, reported from
            backing infrastructure.
          type: string
          example: >
            Network could not be deployed due to insufficient cloud provider
            compute instances.
      additionalProperties: false
      readOnly: true
      title: Network State Metadata
    NetworkProviderMetadata:
      description: Metadata describing attributes returned by cloud-provider for the
        network.
      type: object
      properties:
        vpc_id:
          type: string
          title: VPC ID
        subnet_ids:
          type: array
          items:
            type: string
          title: Subnet IDs
      additionalProperties: false
      readOnly: true
      title: Network Provider Metadata
    Network:
      description: Object containing information about a network to be used in
        configurations.
      type: object
      properties:
        id:
          $ref: "#/components/schemas/NetworkId"
        name:
          $ref: "#/components/schemas/NetworkName"
        default:
          description: >
            Whether the network is a default network or not. Default networks
            are Networks that are created

            automatically by Konnect when an organization is linked to a
            provider account.
          type: boolean
          example: false
        cloud_gateway_provider_account_id:
          $ref: "#/components/schemas/ProviderAccountId"
        region:
          $ref: "#/components/schemas/ProviderRegionId"
        availability_zones:
          $ref: "#/components/schemas/NetworkAvailabilityZones"
        cidr_block:
          $ref: "#/components/schemas/NetworkCIDRBlock"
        state:
          $ref: "#/components/schemas/NetworkState"
        state_metadata:
          $ref: "#/components/schemas/NetworkStateMetadata"
        provider_metadata:
          $ref: "#/components/schemas/NetworkProviderMetadata"
        transit_gateway_count:
          description: The number of transit gateways attached to this network.
          type: integer
          example: 0
          readOnly: true
        configuration_reference_count:
          description: The number of configurations that reference this network.
          type: integer
          example: 0
          readOnly: true
        entity_version:
          description: >
            Monotonically-increasing version count of the network, to indicate
            the order of updates to the network.
          type: integer
          example: 1
          readOnly: true
        created_at:
          description: An RFC-3339 timestamp representation of network 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 network update date.
          type: string
          format: date-time
          example: 2022-11-04T20:10:06.927Z
          readOnly: true
      required:
        - id
        - name
        - default
        - cloud_gateway_provider_account_id
        - region
        - availability_zones
        - cidr_block
        - provider_metadata
        - state
        - transit_gateway_count
        - configuration_reference_count
        - entity_version
        - created_at
        - updated_at
      title: Network
```
