Networks
List Networks
Returns a paginated list of Cloud Gateway networks visible to the caller. Filter by state to narrow results — for example, poll for state=ready to find networks available for data plane group configurations.
get/v2/cloud-gateways/networks
Query parameters
Filters supported for networks.
page[size]integer
Example:100
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 networks.
Example response
{
"meta": {
"page": {
"number": 1,
"size": 10,
"total": 100
}
},
"data": [
{
"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"
}
]
}