Skip to content

List networks.

GET
/api/infraprotect/namespaces/{namespace}/infraprotect/networks
curl --request GET \
--url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/infraprotect/namespaces/example/infraprotect/networks \
--header 'Authorization: <Authorization>'

Returns a list available reports to be downloaded. Reports summarise an event or a mitigation in a single PDF document.

Examples of this operation.

namespace
required
string

Namespace This request is supported only in system namespace.

A successful response.

Media typeapplication/json
Networks response

Response containing all networks available to the customer.

object
networks
Networks

List of networks the customer has.

Array<object>
Network record

A single customer network record.

object
id
Network IDListNetworksResponse

ID of the network.

string
>= 1 <= 4094 <= 1024 characters
name
Network name

Name of the network.

string
>= 6 characters <= 1024 characters
prefixes
object
prefix
Prefix

IP Address prefix in string format. String must contain both prefix and prefix-length.

Array<string>
<= 256 items
primary
Primary

If true then the network is the primary customer’s network and should always be preferred. The rules governing:

  • The network is flagged as such during onboarding via the signup object->infraprotect_information
  • Customer network called %customer_name%_local - e.g. Defensenet_local
  • The only customer’s network (if customer has only one network)
boolean format: boolean
Examplegenerated
{
"networks": [
{
"id": "example",
"name": "example",
"prefixes": {
"prefix": [
"example"
]
},
"primary": true
}
]
}

Returned when operation is not authorized.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when there is no permission to access resource.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when resource is not found.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when operation on resource is conflicting with current value.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when operation has been rejected as it is happening too frequently.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when server encountered an error in processing API.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when service is unavailable temporarily.

Media typeapplication/json
string format: string
Examplegenerated
example

Returned when server timed out processing request.

Media typeapplication/json
string format: string
Examplegenerated
example