Networks

List networks

List Redpanda networks.

get/v1/networks

Request

  • Base URL: https://api.redpanda.com
  • URL: https://api.redpanda.com/v1/networks
  • Auth: OAuth 2 (implicit, authorization URL https://auth.prd.cloud.redpanda.com/oauth/authorize)

Query parameters

filter.resource_group_idstring

Resource group ID.

filter.name_containsstring

Name of network.

filter.regionstring

Name of cloud provider region.

filter.cloud_provider'CLOUD_PROVIDER_AWS' | 'CLOUD_PROVIDER_GCP' | 'CLOUD_PROVIDER_AZURE'

Cloud provider.

page_sizeinteger

Limit the paginated response to a number of items.

page_tokenstring

Value of the next_page_token field returned by the previous response. If not provided, the system assumes the first page is requested.

Response

OK

next_page_tokenstring

Example response

{
  "networks": [
    {
      "name": "development-network",
      "resource_group_id": "a0b40af9-0250-48ca-9417-783ed127ce42"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.