Networks
List Network Configuration References
Returns a paginated list of data plane group configurations that reference a given network. Use this to determine which control planes are using a network before renaming or deleting it.
get/v2/cloud-gateways/networks/{networkId}/configuration-references
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.
Query parameters
page[size]integer
Example:10
The maximum number of items to include per page. The last page of a collection may include fewer items.
page[number]integer
Example:1
Determines which page of the entities to retrieve.
Response
A paginated list for a collection of configurations that reference a network.
Example response
{
"meta": {
"page": {
"number": 1,
"size": 10,
"total": 100
}
},
"data": [
{
"id": "edaf40f9-9fb0-4ffe-bb74-4e763a6bd471",
"version": "3.10",
"api_access": "private+public",
"dataplane_group_config": [
{
"provider": "aws",
"region": "us-east-2",
"cloud_gateway_network_id": "36ae63d3-efd1-4bec-b246-62aa5d3f5695",
"autoscale": {
"requested_instances": 3
},
"environment": [
{
"name": "KONG_LOG_LEVEL",
"value": "info"
}
]
}
],
"dataplane_groups": [
{
"id": "cbb8872a-1f83-4806-bf69-fdf0b4783c7e",
"provider": "aws",
"region": "us-east-2",
"autoscale": {
"requested_instances": 3
},
"environment": [
{
"name": "KONG_LOG_LEVEL",
"value": "info"
}
],
"cloud_gateway_network_id": "36ae63d3-efd1-4bec-b246-62aa5d3f5695",
"state_metadata": {
"reported_status": "ERROR",
"reason": "Dataplane group could not be deployed due to insufficient cloud provider compute instances.\n"
},
"private_ip_addresses": [
"192.168.248.132",
"192.168.66.81",
"192.168.137.135"
],
"egress_ip_addresses": [
"71.78.149.75",
"91.149.112.244",
"51.235.15.121"
],
"created_at": "2022-11-04T20:10:06.927Z",
"updated_at": "2022-11-04T20:10:06.927Z"
}
],
"entity_version": 1,
"created_at": "2022-11-04T20:10:06.927Z",
"updated_at": "2022-11-04T20:10:06.927Z",
"control_plane_id": "0949471e-b759-45ba-87ab-ee63fb781388"
}
]
}