Konnect Cloud Gateways (2.0.0)

Download OpenAPI specification:Download

URL: https://cloud.konghq.com

Konnect API for managing cloud-gateways infrastructure.

Networks

List Networks

Returns a paginated list of networks.

Authorizations:

konnectAccessTokenpersonalAccessTokensystemAccountAccessToken

query Parameters

	object (NetworksFilterParameters) Filters supported for networks.
page[size]	integer Example: page[size]=10 The maximum number of items to include per page. The last page of a collection may include fewer items.
page[number]	integer Example: page[number]=1 Determines which page of the entities to retrieve.

Responses

Response samples

200
400
401
403

Content type

application/json

{"meta": {"page": {"number": 1,
"size": 10,
"total": 100
}
},
"data": [{"id": "36ae63d3-efd1-4bec-b246-62aa5d3f5695",
"name": "us-east-2 network",
"default": false,
"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/8",
"firewall": {"allowed_cidr_blocks": ["10.0.0.0/8"
],
"denied_cidr_blocks": ["10.100.0.0/16"
]
},
"ddos_protection": false,
"state": "created",
"provider_metadata": {"vpc_id": "string",
"subnet_ids": ["string"
]
},
"transit_gateway_count": 0,
"configuration_reference_count": 0,
"entity_version": 1,
"created_at": "2022-11-04T20:10:06.927Z",
"updated_at": "2022-11-04T20:10:06.927Z"
}
]
}

Create Network

Creates a new network for a given provider account.

Authorizations:

konnectAccessTokenpersonalAccessTokensystemAccountAccessToken

Request Body schema: application/json

name required	string (Network Name) Human-readable name of the network.
cloud_gateway_provider_account_id required	string <uuid> (ProviderAccountId)
region required	string (Provider Region ID) Region ID for cloud provider region.
availability_zones required	Array of strings (NetworkAvailabilityZones) List of availability zones that the network is attached to.
cidr_block required	string (Network CIDR Block) CIDR block configuration for the network.
	object (Network Firewall Config) Firewall configuration for a network.
ddos_protection	boolean (Network DDOS Protection) Whether DDOS protection is enabled for the network.
state	string (Network Create State) Default: "initializing" Enum: "initializing" "offline" Initial state for creating a network.

Responses

Request samples

Payload

Content type

application/json

{"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/8",
"firewall": {"allowed_cidr_blocks": ["10.0.0.0/8"
],
"denied_cidr_blocks": ["10.100.0.0/16"
]
},
"ddos_protection": false,
"state": "initializing"
}

Response samples

201
400
401
403
409

Content type

application/json

{"id": "36ae63d3-efd1-4bec-b246-62aa5d3f5695",
"name": "us-east-2 network",
"default": false,
"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/8",
"firewall": {"allowed_cidr_blocks": ["10.0.0.0/8"
],
"denied_cidr_blocks": ["10.100.0.0/16"
]
},
"ddos_protection": false,
"state": "created",
"provider_metadata": {"vpc_id": "string",
"subnet_ids": ["string"
]
},
"transit_gateway_count": 0,
"configuration_reference_count": 0,
"entity_version": 1,
"created_at": "2022-11-04T20:10:06.927Z",
"updated_at": "2022-11-04T20:10:06.927Z"
}

Update Network

Updates a network by ID.

Authorizations:

konnectAccessTokenpersonalAccessTokensystemAccountAccessToken

path Parameters

networkId

required

string <uuid> (NetworkId)

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

The network to operate on.

Request Body schema: application/json

name	string (Network Name) Human-readable name of the network.
	object (Network Firewall Config) Firewall configuration for a network.

Responses

Request samples

Payload

Content type

application/json

{"name": "us-east-2 network",
"firewall": {"allowed_cidr_blocks": ["10.0.0.0/8"
],
"denied_cidr_blocks": ["10.100.0.0/16"
]
}
}

Response samples

Content type

application/json

{"id": "36ae63d3-efd1-4bec-b246-62aa5d3f5695",
"name": "us-east-2 network",
"default": false,
"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/8",
"firewall": {"allowed_cidr_blocks": ["10.0.0.0/8"
],
"denied_cidr_blocks": ["10.100.0.0/16"
]
},
"ddos_protection": false,
"state": "created",
"provider_metadata": {"vpc_id": "string",
"subnet_ids": ["string"
]
},
"transit_gateway_count": 0,
"configuration_reference_count": 0,
"entity_version": 1,
"created_at": "2022-11-04T20:10:06.927Z",
"updated_at": "2022-11-04T20:10:06.927Z"
}

Private DNS

List Private DNS

Returns a paginated collection of Private DNS for a given network.

Authorizations:

konnectAccessTokenpersonalAccessTokensystemAccountAccessToken

path Parameters

networkId

required

string <uuid> (NetworkId)

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

The network to operate on.

query Parameters

	object (PrivateDnsFilterParameters) Filters supported for Private DNS.
page[size]	integer Example: page[size]=10 The maximum number of items to include per page. The last page of a collection may include fewer items.
page[number]	integer Example: page[number]=1 Determines which page of the entities to retrieve.

Responses

Response samples

200
400
401
403
404

Content type

application/json

{"meta": {"page": {"number": 1,
"size": 10,
"total": 100
}
},
"data": [{"name": "us-east-2 private dns",
"private_dns_attachment_config": {"kind": "aws-private-hosted-zone-attachment",
"hosted_zone_id": "string"
},
"id": "1850820b-c69f-4a2a-b9be-bbcdbc5cd618",
"state": "created",
"entity_version": 1,
"created_at": "2022-11-04T20:10:06.927Z",
"updated_at": "2022-11-04T20:10:06.927Z"
}
]
}

Create Private DNS

Creates a new Private DNS for a given network.

Authorizations:

konnectAccessTokenpersonalAccessTokensystemAccountAccessToken

path Parameters

networkId

required

string <uuid> (NetworkId)

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

The network to operate on.

Request Body schema: application/json

One of

name required	string (Private DNS Name) Human-readable name of the Private DNS.
required	object (AWS Private Hosted Zone Attachment Config)

Responses

Request samples

Payload

Content type

application/json

{"name": "us-east-2 private dns",
"private_dns_attachment_config": {"kind": "aws-private-hosted-zone-attachment",
"hosted_zone_id": "string"
}
}

Response samples

Content type

application/json

{"name": "us-east-2 private dns",
"private_dns_attachment_config": {"kind": "aws-private-hosted-zone-attachment",
"hosted_zone_id": "string"
},
"id": "1850820b-c69f-4a2a-b9be-bbcdbc5cd618",
"state": "created",
"entity_version": 1,
"created_at": "2022-11-04T20:10:06.927Z",
"updated_at": "2022-11-04T20:10:06.927Z"
}

Get Private DNS

Retrieves a Private DNS by ID for a given network.

Authorizations:

konnectAccessTokenpersonalAccessTokensystemAccountAccessToken

path Parameters

networkId required	string <uuid> (NetworkId) Example: 36ae63d3-efd1-4bec-b246-62aa5d3f5695 The network to operate on.
privateDnsId required	string <uuid> (PrivateDnsId) Example: 1850820b-c69f-4a2a-b9be-bbcdbc5cd618 The ID of the Private DNS to operate on.

Responses

Response samples

200
401
403
404

Content type

application/json

{"name": "us-east-2 private dns",
"private_dns_attachment_config": {"kind": "aws-private-hosted-zone-attachment",
"hosted_zone_id": "string"
},
"id": "1850820b-c69f-4a2a-b9be-bbcdbc5cd618",
"state": "created",
"entity_version": 1,
"created_at": "2022-11-04T20:10:06.927Z",
"updated_at": "2022-11-04T20:10:06.927Z"
}

Delete Private DNS

Deletes a Private DNS by ID for a given network.

Authorizations:

konnectAccessTokenpersonalAccessTokensystemAccountAccessToken

path Parameters

networkId required	string <uuid> (NetworkId) Example: 36ae63d3-efd1-4bec-b246-62aa5d3f5695 The network to operate on.
privateDnsId required	string <uuid> (PrivateDnsId) Example: 1850820b-c69f-4a2a-b9be-bbcdbc5cd618 The ID of the Private DNS to operate on.

Responses

Response samples

400
401
403
404

Content type

application/problem+json

Example

Network Name Length Exceeded

{"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
}
]
}

Resource Availability

Get Resource Availability JSON

Get Cloud Gateways Availability JSON document for describing cloud provider and region availability, pricing, gateway version availability, and instance type information.

Responses

Response samples

200

Content type

application/json

{"versions": ["3.2"
],
"instance_types": [{"name": "small",
"hourly_cost": "1.00",
"v_cpu": "2",
"gb_memory": "2"
}
],
"providers": [{"provider": "aws",
"regions": [{"region": "us-east-2",
"name": "N. Virginia",
"availability_zones": ["use2-az1",
"use2-az2",
"use2-az3"
],
"cidr_blocks": ["10.0.0.0/8",
"100.64.0.0/10",
"172.16.0.0/12",
"192.168.0.0/16",
"198.18.0.0/15"
],
"reserved_cidr_blocks": ["10.100.0.0/16",
"172.17.0.0/16"
]
}
]
}
]
}