Networking

NetworkingVPCs

Create VPC

client.Networking.VPCs.New(ctx, body) (*Operation, error)

POST/v1/networking/vpcs

Get VPC Details

client.Networking.VPCs.Get(ctx, vpcID) (*VPC, error)

GET/v1/networking/vpcs/{vpc_id}

Update VPC

client.Networking.VPCs.Update(ctx, vpcID, body) (*Operation, error)

PATCH/v1/networking/vpcs/{vpc_id}

Delete VPC

client.Networking.VPCs.Delete(ctx, vpcID) (*Operation, error)

DELETE/v1/networking/vpcs/{vpc_id}

List VPCs

client.Networking.VPCs.List(ctx, query) (*Cursor[VPC], error)

GET/v1/networking/vpcs

ModelsExpand Collapse

type Subnet struct{…}

Subnet of the VPC.

ID string

Unique identifier for the Subnet.

CIDR string

CIDR block for the Subnet.

CreatedAt Time

When the Subnet was created.

formatdate-time

Name string

Name of the Subnet.

UpdatedAt Time

When the Subnet was updated.

formatdate-time

type VPC struct{…}

VPC details.

ID string

Unique identifier for the VPC.

CreatedAt Time

When the VPC was created.

formatdate-time

FirewallRuleIDs []string

IDs of the Firewall Rules associated with the VPC.

Name string

Name of the VPC.

ProjectID string

Project ID the VPC belongs to.

Region RegionName

Region the resource is in.

Status ResourceStatus

Status of the resource.

One of the following:

const ResourceStatusPending ResourceStatus = "pending"

const ResourceStatusCreating ResourceStatus = "creating"

const ResourceStatusUpdating ResourceStatus = "updating"

const ResourceStatusReady ResourceStatus = "ready"

const ResourceStatusDeleting ResourceStatus = "deleting"

const ResourceStatusDeleted ResourceStatus = "deleted"

const ResourceStatusError ResourceStatus = "error"

Subnet Subnet

Subnet of the VPC.

ID string

Unique identifier for the Subnet.

CIDR string

CIDR block for the Subnet.

CreatedAt Time

When the Subnet was created.

formatdate-time

Name string

Name of the Subnet.

UpdatedAt Time

When the Subnet was updated.

formatdate-time

Tags []string

Tags to attach to the VPC.

UpdatedAt Time

When the VPC was updated.

formatdate-time

type VPCList struct{…}

Items []VPC

ID string

Unique identifier for the VPC.

CreatedAt Time

When the VPC was created.

formatdate-time

FirewallRuleIDs []string

IDs of the Firewall Rules associated with the VPC.

Name string

Name of the VPC.

ProjectID string

Project ID the VPC belongs to.

Region RegionName

Region the resource is in.

Status ResourceStatus

Status of the resource.

One of the following:

const ResourceStatusPending ResourceStatus = "pending"

const ResourceStatusCreating ResourceStatus = "creating"

const ResourceStatusUpdating ResourceStatus = "updating"

const ResourceStatusReady ResourceStatus = "ready"

const ResourceStatusDeleting ResourceStatus = "deleting"

const ResourceStatusDeleted ResourceStatus = "deleted"

const ResourceStatusError ResourceStatus = "error"

Subnet Subnet

Subnet of the VPC.

ID string

Unique identifier for the Subnet.

CIDR string

CIDR block for the Subnet.

CreatedAt Time

When the Subnet was created.

formatdate-time

Name string

Name of the Subnet.

UpdatedAt Time

When the Subnet was updated.

formatdate-time

Tags []string

Tags to attach to the VPC.

UpdatedAt Time

When the VPC was updated.

formatdate-time

Pagination Pagination

Pagination response details.

NextCursor string

PreviousCursor string

TotalCount int64

minimum0

NetworkingVPCsAvailability

Check Create VPC Availability

client.Networking.VPCs.Availability.New(ctx, body) error

POST/v1/networking/vpcs/availability

Check Update VPC Availability

client.Networking.VPCs.Availability.Update(ctx, vpcID, body) error

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

NetworkingFirewall Rules

Create Firewall Rule

client.Networking.FirewallRules.New(ctx, vpcID, body) (*Operation, error)

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

Firewall Rule Details

client.Networking.FirewallRules.Get(ctx, vpcID, firewallRuleID) (*FirewallRule, error)

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

Update Firewall Rule

client.Networking.FirewallRules.Update(ctx, vpcID, firewallRuleID, body) (*Operation, error)

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

Delete Firewall Rule

client.Networking.FirewallRules.Delete(ctx, vpcID, firewallRuleID) (*Operation, error)

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

List Firewall Rules

client.Networking.FirewallRules.List(ctx, vpcID, query) (*Cursor[FirewallRule], error)

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

ModelsExpand Collapse

type FirewallRule struct{…}

Firewall rule details.

ID string

Unique identifier for the Firewall Rule.

CreatedAt Time

When the Firewall Rule was created.

formatdate-time

DestinationAddress string

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

DestinationPorts []string

Destination ports of the Firewall Rule.

Name string

Name of the Firewall Rule.

Protocol FirewallRuleProtocol

Protocol of the Firewall Rule.

One of the following:

const FirewallRuleProtocolTcp FirewallRuleProtocol = "tcp"

const FirewallRuleProtocolUdp FirewallRuleProtocol = "udp"

SourceAddress 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:

const ResourceStatusPending ResourceStatus = "pending"

const ResourceStatusCreating ResourceStatus = "creating"

const ResourceStatusUpdating ResourceStatus = "updating"

const ResourceStatusReady ResourceStatus = "ready"

const ResourceStatusDeleting ResourceStatus = "deleting"

const ResourceStatusDeleted ResourceStatus = "deleted"

const ResourceStatusError ResourceStatus = "error"

Tags []string

Tags to attach to the Firewall Rule.

UpdatedAt Time

When the Firewall Rule was updated.

formatdate-time

VPCID string

ID of the VPC the Firewall Rule belongs to.

type FirewallRuleList struct{…}

Items []FirewallRule

ID string

Unique identifier for the Firewall Rule.

CreatedAt Time

When the Firewall Rule was created.

formatdate-time

DestinationAddress string

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

DestinationPorts []string

Destination ports of the Firewall Rule.

Name string

Name of the Firewall Rule.

Protocol FirewallRuleProtocol

Protocol of the Firewall Rule.

One of the following:

const FirewallRuleProtocolTcp FirewallRuleProtocol = "tcp"

const FirewallRuleProtocolUdp FirewallRuleProtocol = "udp"

SourceAddress 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:

const ResourceStatusPending ResourceStatus = "pending"

const ResourceStatusCreating ResourceStatus = "creating"

const ResourceStatusUpdating ResourceStatus = "updating"

const ResourceStatusReady ResourceStatus = "ready"

const ResourceStatusDeleting ResourceStatus = "deleting"

const ResourceStatusDeleted ResourceStatus = "deleted"

const ResourceStatusError ResourceStatus = "error"

Tags []string

Tags to attach to the Firewall Rule.

UpdatedAt Time

When the Firewall Rule was updated.

formatdate-time

VPCID string

ID of the VPC the Firewall Rule belongs to.

Pagination Pagination

Pagination response details.

NextCursor string

PreviousCursor string

TotalCount int64

minimum0

NetworkingConnect

ModelsExpand Collapse

type ConnectBandwidthMbps int64

Connect Connection speed in Mbps

One of the following:

const ConnectBandwidthMbps50 ConnectBandwidthMbps = 50

const ConnectBandwidthMbps200 ConnectBandwidthMbps = 200

const ConnectBandwidthMbps500 ConnectBandwidthMbps = 500

const ConnectBandwidthMbps1000 ConnectBandwidthMbps = 1000

const ConnectBandwidthMbps2000 ConnectBandwidthMbps = 2000

type ConnectConnection struct{…}

Connect Connection details.

ID string

Unique identifier for the Connect Connection

ASN int64

ASN

AWS ConnectConnectionAWSConfig

AWS provider configuration

Region string

AWS region where the connection is established

BandwidthMbps int64

Connect Connection speed in Mbps

One of the following:

const ConnectBandwidthMbps50 ConnectBandwidthMbps = 50

const ConnectBandwidthMbps200 ConnectBandwidthMbps = 200

const ConnectBandwidthMbps500 ConnectBandwidthMbps = 500

const ConnectBandwidthMbps1000 ConnectBandwidthMbps = 1000

const ConnectBandwidthMbps2000 ConnectBandwidthMbps = 2000

CIDRs []string

CIDRs for the Connect Connection

CreatedAt Time

When the Connect Connection was created

formatdate-time

Name string

Name of the Connect Connection

ProjectID string

Project ID the Connect Connection belongs to

ProviderASN int64

Provider ASN

ProviderCIDRs []string

Provider CIDRs for the Connect Connection

ProviderRouterIP string

Provider Router IP for the Connect Connection

Region RegionName

Region the resource is in.

RouterIP string

Router IP

Status ResourceStatus

Status of the resource.

One of the following:

const ResourceStatusPending ResourceStatus = "pending"

const ResourceStatusCreating ResourceStatus = "creating"

const ResourceStatusUpdating ResourceStatus = "updating"

const ResourceStatusReady ResourceStatus = "ready"

const ResourceStatusDeleting ResourceStatus = "deleting"

const ResourceStatusDeleted ResourceStatus = "deleted"

const ResourceStatusError ResourceStatus = "error"

Tags []string

Tags to attach to the Connect Connection

UpdatedAt Time

When the Connect Connection was updated

formatdate-time

type ConnectConnectionAWSConfig struct{…}

AWS provider configuration

Region string

AWS region where the connection is established

type ConnectConnectionAWSConfigRequest struct{…}

AWS provider configuration

AccountID string

AWS account id

maxLength12

minLength12

Region string

AWS region where the connection will be established

type ConnectConnectionList struct{…}

Items []ConnectConnection

ID string

Unique identifier for the Connect Connection

ASN int64

ASN

AWS ConnectConnectionAWSConfig

AWS provider configuration

Region string

AWS region where the connection is established

BandwidthMbps int64

Connect Connection speed in Mbps

One of the following:

const ConnectBandwidthMbps50 ConnectBandwidthMbps = 50

const ConnectBandwidthMbps200 ConnectBandwidthMbps = 200

const ConnectBandwidthMbps500 ConnectBandwidthMbps = 500

const ConnectBandwidthMbps1000 ConnectBandwidthMbps = 1000

const ConnectBandwidthMbps2000 ConnectBandwidthMbps = 2000

CIDRs []string

CIDRs for the Connect Connection

CreatedAt Time

When the Connect Connection was created

formatdate-time

Name string

Name of the Connect Connection

ProjectID string

Project ID the Connect Connection belongs to

ProviderASN int64

Provider ASN

ProviderCIDRs []string

Provider CIDRs for the Connect Connection

ProviderRouterIP string

Provider Router IP for the Connect Connection

Region RegionName

Region the resource is in.

RouterIP string

Router IP

Status ResourceStatus

Status of the resource.

One of the following:

const ResourceStatusPending ResourceStatus = "pending"

const ResourceStatusCreating ResourceStatus = "creating"

const ResourceStatusUpdating ResourceStatus = "updating"

const ResourceStatusReady ResourceStatus = "ready"

const ResourceStatusDeleting ResourceStatus = "deleting"

const ResourceStatusDeleted ResourceStatus = "deleted"

const ResourceStatusError ResourceStatus = "error"

Tags []string

Tags to attach to the Connect Connection

UpdatedAt Time

When the Connect Connection was updated

formatdate-time

Pagination Pagination

Pagination response details.

NextCursor string

PreviousCursor string

TotalCount int64

minimum0

type ConnectRoute struct{…}

Routes supported for Connect.

NirvanaRegion RegionName

Region the resource is in.

Provider string

Provider name.

ProviderRegion string

Provider region name.

type ConnectRouteList struct{…}

Items []ConnectRoute

NirvanaRegion RegionName

Region the resource is in.

Provider string

Provider name.

ProviderRegion string

Provider region name.

Pagination Pagination

Pagination response details.

NextCursor string

PreviousCursor string

TotalCount int64

minimum0

NetworkingConnectConnections

Create Connect Connection

client.Networking.Connect.Connections.New(ctx, body) (*Operation, error)

POST/v1/networking/connect/connections

Get Connect Connection

client.Networking.Connect.Connections.Get(ctx, connectionID) (*ConnectConnection, error)

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

Update Connect Connection

client.Networking.Connect.Connections.Update(ctx, connectionID, body) (*Operation, error)

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

Delete Connect Connection

client.Networking.Connect.Connections.Delete(ctx, connectionID) (*Operation, error)

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

List Connect Connection

client.Networking.Connect.Connections.List(ctx, query) (*Cursor[ConnectConnection], error)

GET/v1/networking/connect/connections

NetworkingConnectRoutes

List Connect Supported Routes

client.Networking.Connect.Routes.List(ctx, query) (*Cursor[ConnectRoute], error)

GET/v1/networking/connect/routes