Networks

Get Network

Changed on

Retrieves a Cloud Gateway network by ID, including its current state and provider metadata.

get/v2/cloud-gateways/networks/{networkId}

Request

  • Base URL: https://global.api.konghq.com
  • URL: https://global.api.konghq.com/v2/cloud-gateways/networks/{networkId}
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Path parameters

networkIdstring uuid required

The network ID to operate on. For serverless.v1 kind of cloud gateways, this field should be omitted.

Example:36ae63d3-efd1-4bec-b246-62aa5d3f5695

The network to operate on.

Response

Response format for retrieving a network.

idstring uuid required

The network ID to operate on. For serverless.v1 kind of cloud gateways, this field should be omitted.

namestring required

Human-readable name of the network.

defaultboolean required

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.

cloud_gateway_provider_account_idstring uuid required
regionstring required

Region ID for cloud provider region.

availability_zonesstring[] required

List of availability zones that the network is attached to.

cidr_blockstring required

CIDR block for the network. Must not overlap with reserved blocks for the target region. Query the Resource Availability endpoint for valid CIDR ranges per region and provider.

state'created' | 'initializing' | 'offline' | 'ready' | 'terminating' | 'terminated' required

The current state of the network. Possible values:

  • created: The network was created, but provisioning hasn't started yet.
  • initializing: The network is being provisioned in the cloud provider.
  • offline: The network was created but isn't provisioned; no data planes can be deployed.
  • ready: The network is fully provisioned and available for data plane groups.
  • terminating: The network is being deleted and is no longer accepting new resources.
  • terminated: The network has been fully deleted and is no longer available.
transit_gateway_countinteger required

The number of transit gateways attached to this network.

configuration_reference_countinteger required

The number of configurations that reference this network.

entity_versioninteger required

Monotonically-increasing version count of the network, to indicate the order of updates to the network.

created_atstring date-time required

An RFC-3339 timestamp representation of network creation date.

updated_atstring date-time required

An RFC-3339 timestamp representation of network update date.

Example response

{
  "id": "36ae63d3-efd1-4bec-b246-62aa5d3f5695",
  "name": "us-east-2-network",
  "cloud_gateway_provider_account_id": "929b2449-c69f-44c4-b6ad-9ecec6f811ae",
  "region": "us-east-2",
  "availability_zones": [
    "use2-az1",
    "use2-az2",
    "use2-az3"
  ],
  "cidr_block": "10.0.0.0/16",
  "state_metadata": {
    "reported_status": "INVALID",
    "reason": "Network could not be deployed due to insufficient cloud provider compute instances.\n"
  },
  "entity_version": 1,
  "created_at": "2022-11-04T20:10:06.927Z",
  "updated_at": "2022-11-04T20:10:06.927Z"
}

Changes

  • 68d43091b84dRevision changes
    • warning

      added the new 403.00 enum value to the response property for the response status

    • warning

      added the new 404.00 enum value to the response property for the response status

  • f324fb7610e4Revision changes
    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to object for status

    • info

      removed subschema #2 from the response body allOf list for the response status

    • info

      removed subschema #2 from the response body allOf list for the response status

    • info

      removed subschema #2 from the response body allOf list for the response status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status