List virtual networks

Lists and filters virtual networks in an account.

application/json

Body

result

required

Any of

allOf {2}

array[object (virtual-network) {6}]

allOf {2}

One of

array[object (virtual-network) {6}]

object

comment

string

components-schemas-comment

required

Optional remark describing the virtual network.

Example:

Staging VPC for data science

created_at

required

Timestamp of when the virtual network was created.

deleted_at

optional

Timestamp of when the virtual network was deleted. If null, the virtual network has not been deleted.

string

vnet_id

read-onlyrequired

UUID of the virtual network.

<= 36 characters

Example:

f70ff985-a4ef-4643-bbbc-4a0ed4fc8415

is_default_network

boolean

is_default_network

required

If true, this virtual network is the default for the account.

Example:

true

name

string

vnet_name

required

A user-friendly name for the virtual network.

Example:

us-east-1-vpc

errors

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

messages

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

result_info

object

result_info

optional

count

number

optional

Total number of results for the requested service

Example:

page

number

optional

Current page within paginated list of results

Example:

per_page

number

optional

Number of results per page of results

Example:

total_count

number

optional

Total results available without any search parameters

Example:

2000

Example

{
    "errors": [],
    "messages": [],
    "result": [
        {
            "comment": "Staging VPC for data science",
            "created_at": null,
            "deleted_at": null,
            "id": "f70ff985-a4ef-4643-bbbc-4a0ed4fc8415",
            "is_default_network": true,
            "name": "us-east-1-vpc"
        }
    ],
    "success": true,
    "result_info": {
        "count": 1,
        "page": 1,
        "per_page": 20,
        "total_count": 2000
    }
}

List virtual networks

Request

Request samples

Responses