Kong · Schema

Network

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

API GatewayAI GatewayAI ConnectivityAgent GatewayEvent GatewayMCP RegistryService MeshLLMKafkaKonnectOpen Source

Properties

Name Type Description
id object
name object
default boolean 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_id object
region object
availability_zones object
cidr_block object
state object
state_metadata object
provider_metadata object
transit_gateway_count integer The number of transit gateways attached to this network.
configuration_reference_count integer The number of configurations that reference this network.
entity_version integer Monotonically-increasing version count of the network, to indicate the order of updates to the network.
created_at string An RFC-3339 timestamp representation of network creation date.
updated_at string An RFC-3339 timestamp representation of network update date.
View JSON Schema on GitHub

JSON Schema

kong-network-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Network",
  "title": "Network",
  "x-speakeasy-entity": "CloudGatewayNetwork",
  "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\nautomatically by Konnect when an organization is linked to a provider account.\n",
      "type": "boolean",
      "example": false,
      "x-speakeasy-param-suppress-computed-diff": true
    },
    "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,
      "x-speakeasy-param-suppress-computed-diff": true
    },
    "configuration_reference_count": {
      "description": "The number of configurations that reference this network.",
      "type": "integer",
      "example": 0,
      "readOnly": true,
      "x-speakeasy-param-suppress-computed-diff": true
    },
    "entity_version": {
      "description": "Monotonically-increasing version count of the network, to indicate the order of updates to the network.\n",
      "type": "integer",
      "example": 1,
      "readOnly": true,
      "x-speakeasy-param-suppress-computed-diff": 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,
      "x-speakeasy-param-suppress-computed-diff": 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,
      "x-speakeasy-param-suppress-computed-diff": 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"
  ]
}