Networking

NetworkingVPCs

Create VPC

POST/v1/networking/vpcs

Get VPC Details

GET/v1/networking/vpcs/{vpc_id}

Update VPC

PATCH/v1/networking/vpcs/{vpc_id}

Delete VPC

DELETE/v1/networking/vpcs/{vpc_id}

List VPCs

GET/v1/networking/vpcs

ModelsExpand Collapse

Subnet object { id, cidr, created_at, 2 more }

Subnet of the VPC.

id: string

Unique identifier for the Subnet.

cidr: string

CIDR block for the Subnet.

created_at: string

When the Subnet was created.

formatdate-time

Name of the Subnet.

updated_at: string

When the Subnet was updated.

formatdate-time

VPC object { id, created_at, firewall_rule_ids, 7 more }

VPC details.

id: string

Unique identifier for the VPC.

created_at: string

When the VPC was created.

formatdate-time

firewall_rule_ids: array of string

IDs of the Firewall Rules associated with the VPC.

Name of the VPC.

project_id: string

Project ID the VPC belongs to.

region: RegionName

Region the resource is in.

status: ResourceStatus

Status of the resource.

One of the following:

"pending"

"creating"

"updating"

"ready"

"deleting"

"deleted"

"error"

subnet: Subnet { id, cidr, created_at, 2 more }

Subnet of the VPC.

id: string

Unique identifier for the Subnet.

cidr: string

CIDR block for the Subnet.

created_at: string

When the Subnet was created.

formatdate-time

Name of the Subnet.

updated_at: string

When the Subnet was updated.

formatdate-time

tags: array of string

Tags to attach to the VPC.

updated_at: string

When the VPC was updated.

formatdate-time

VPCList object { items, pagination }

items: array of VPC { id, created_at, firewall_rule_ids, 7 more }

id: string

Unique identifier for the VPC.

created_at: string

When the VPC was created.

formatdate-time

firewall_rule_ids: array of string

IDs of the Firewall Rules associated with the VPC.

Name of the VPC.

project_id: string

Project ID the VPC belongs to.

region: RegionName

Region the resource is in.

status: ResourceStatus

Status of the resource.

One of the following:

"pending"

"creating"

"updating"

"ready"

"deleting"

"deleted"

"error"

subnet: Subnet { id, cidr, created_at, 2 more }

Subnet of the VPC.

id: string

Unique identifier for the Subnet.

cidr: string

CIDR block for the Subnet.

created_at: string

When the Subnet was created.

formatdate-time

Name of the Subnet.

updated_at: string

When the Subnet was updated.

formatdate-time

tags: array of string

Tags to attach to the VPC.

updated_at: string

When the VPC was updated.

formatdate-time

pagination: Pagination { next_cursor, previous_cursor, total_count }

Pagination response details.

next_cursor: string

previous_cursor: string

total_count: number

minimum0

NetworkingVPCsAvailability

Check Create VPC Availability

POST/v1/networking/vpcs/availability

Check Update VPC Availability

PATCH/v1/networking/vpcs/{vpc_id}/availability

NetworkingFirewall Rules

Create Firewall Rule

POST/v1/networking/vpcs/{vpc_id}/firewall_rules

Firewall Rule Details

GET/v1/networking/vpcs/{vpc_id}/firewall_rules/{firewall_rule_id}

Update Firewall Rule

PATCH/v1/networking/vpcs/{vpc_id}/firewall_rules/{firewall_rule_id}

Delete Firewall Rule

DELETE/v1/networking/vpcs/{vpc_id}/firewall_rules/{firewall_rule_id}

List Firewall Rules

GET/v1/networking/vpcs/{vpc_id}/firewall_rules

ModelsExpand Collapse

FirewallRule object { id, created_at, destination_address, 8 more }

Firewall rule details.

id: string

Unique identifier for the Firewall Rule.

created_at: string

When the Firewall Rule was created.

formatdate-time

destination_address: string

Destination address of the Firewall Rule. Either VPC CIDR or VM in VPC.

destination_ports: array of string

Destination ports of the Firewall Rule.

Name of the Firewall Rule.

protocol: "tcp" or "udp"

Protocol of the Firewall Rule.

One of the following:

"tcp"

"udp"

source_address: string

Source address of the Firewall Rule. Address of 0.0.0.0 requires a CIDR mask of 0.

status: ResourceStatus

Status of the resource.

One of the following:

"pending"

"creating"

"updating"

"ready"

"deleting"

"deleted"

"error"

tags: array of string

Tags to attach to the Firewall Rule.

updated_at: string

When the Firewall Rule was updated.

formatdate-time

vpc_id: string

ID of the VPC the Firewall Rule belongs to.

FirewallRuleList object { items, pagination }

items: array of FirewallRule { id, created_at, destination_address, 8 more }

id: string

Unique identifier for the Firewall Rule.

created_at: string

When the Firewall Rule was created.

formatdate-time

destination_address: string

Destination address of the Firewall Rule. Either VPC CIDR or VM in VPC.

destination_ports: array of string

Destination ports of the Firewall Rule.

Name of the Firewall Rule.

protocol: "tcp" or "udp"

Protocol of the Firewall Rule.

One of the following:

"tcp"

"udp"

source_address: string

Source address of the Firewall Rule. Address of 0.0.0.0 requires a CIDR mask of 0.

status: ResourceStatus

Status of the resource.

One of the following:

"pending"

"creating"

"updating"

"ready"

"deleting"

"deleted"

"error"

tags: array of string

Tags to attach to the Firewall Rule.

updated_at: string

When the Firewall Rule was updated.

formatdate-time

vpc_id: string

ID of the VPC the Firewall Rule belongs to.

pagination: Pagination { next_cursor, previous_cursor, total_count }

Pagination response details.

next_cursor: string

previous_cursor: string

total_count: number

minimum0

NetworkingConnect

ModelsExpand Collapse

ConnectBandwidthMbps = 50 or 200 or 500 or 2 more

Connect Connection speed in Mbps

One of the following:

200

500

1000

2000

ConnectConnection object { id, asn, aws, 13 more }

Connect Connection details.

id: string

Unique identifier for the Connect Connection

asn: number

ASN

aws: ConnectConnectionAWSConfig { region }

AWS provider configuration

region: string

AWS region where the connection is established

bandwidth_mbps: ConnectBandwidthMbps

Connect Connection speed in Mbps

One of the following:

200

500

1000

2000

cidrs: array of string

CIDRs for the Connect Connection

created_at: string

When the Connect Connection was created

formatdate-time

Name of the Connect Connection

project_id: string

Project ID the Connect Connection belongs to

provider_asn: number

Provider ASN

provider_cidrs: array of string

Provider CIDRs for the Connect Connection

provider_router_ip: string

Provider Router IP for the Connect Connection

region: RegionName

Region the resource is in.

router_ip: string

Router IP

status: ResourceStatus

Status of the resource.

One of the following:

"pending"

"creating"

"updating"

"ready"

"deleting"

"deleted"

"error"

tags: array of string

Tags to attach to the Connect Connection

updated_at: string

When the Connect Connection was updated

formatdate-time

ConnectConnectionAWSConfig object { region }

AWS provider configuration

region: string

AWS region where the connection is established

ConnectConnectionAWSConfigRequest object { account_id, region }

AWS provider configuration

account_id: string

AWS account id

maxLength12

minLength12

region: string

AWS region where the connection will be established

ConnectConnectionList object { items, pagination }

items: array of ConnectConnection { id, asn, aws, 13 more }

id: string

Unique identifier for the Connect Connection

asn: number

ASN

aws: ConnectConnectionAWSConfig { region }

AWS provider configuration

region: string

AWS region where the connection is established

bandwidth_mbps: ConnectBandwidthMbps

Connect Connection speed in Mbps

One of the following:

200

500

1000

2000

cidrs: array of string

CIDRs for the Connect Connection

created_at: string

When the Connect Connection was created

formatdate-time

Name of the Connect Connection

project_id: string

Project ID the Connect Connection belongs to

provider_asn: number

Provider ASN

provider_cidrs: array of string

Provider CIDRs for the Connect Connection

provider_router_ip: string

Provider Router IP for the Connect Connection

region: RegionName

Region the resource is in.

router_ip: string

Router IP

status: ResourceStatus

Status of the resource.

One of the following:

"pending"

"creating"

"updating"

"ready"

"deleting"

"deleted"

"error"

tags: array of string

Tags to attach to the Connect Connection

updated_at: string

When the Connect Connection was updated

formatdate-time

pagination: Pagination { next_cursor, previous_cursor, total_count }

Pagination response details.

next_cursor: string

previous_cursor: string

total_count: number

minimum0

ConnectRoute object { nirvana_region, provider, provider_region }

Routes supported for Connect.

nirvana_region: RegionName

Region the resource is in.

provider: string

Provider name.

provider_region: string

Provider region name.

ConnectRouteList object { items, pagination }

items: array of ConnectRoute { nirvana_region, provider, provider_region }

nirvana_region: RegionName

Region the resource is in.

provider: string

Provider name.

provider_region: string

Provider region name.

pagination: Pagination { next_cursor, previous_cursor, total_count }

Pagination response details.

next_cursor: string

previous_cursor: string

total_count: number

minimum0

NetworkingConnectConnections

Create Connect Connection

POST/v1/networking/connect/connections

Get Connect Connection

GET/v1/networking/connect/connections/{connection_id}

Update Connect Connection

PATCH/v1/networking/connect/connections/{connection_id}

Delete Connect Connection

DELETE/v1/networking/connect/connections/{connection_id}

List Connect Connection

GET/v1/networking/connect/connections

NetworkingConnectRoutes

List Connect Supported Routes

GET/v1/networking/connect/routes