API: Network

Generated from the API's OpenAPI schema. Paths are relative to https://cloud.tebibhost.com. Authentication, errors, pagination and idempotency are on the API overview.

GET/api/v1/projects/{project_id}/nat-gateways

List Nat Gateways (listNatGateways)

IAM action: network:DescribeNatGateway

Parameter	In	Type
`project_id` required	path	string
`limit`	query	integer (nullable)
`cursor`	query	string (nullable)

Responses

200 OK (Page_NatGatewayOut_)
400 Invalid request (ErrorOut)
401 Not authenticated (ErrorOut)
403 Access denied: the error names the action and the resource (ErrorOut)
404 Not found (also: the resource belongs to another organization) (ErrorOut)
409 Conflict or quota exceeded (ErrorOut)
422 Idempotency key reused for a different request (ErrorOut)
429 Rate limited (ErrorOut)

Fields of Page_NatGatewayOut_

Field	Type	Description
`items`	array of NatGatewayOut
`next_cursor`	string (nullable)

POST/api/v1/projects/{project_id}/nat-gateways

Create Nat Gateway (createNatGateway)

IAM action: network:CreateNatGateway

Parameter	In	Type	Description
`project_id` required	path	string

Request body (JSON, NatGatewayIn)

Field	Type	Description
`description`	string	Default: `""`.
`name` required	string
`public_ip_id`	string (nullable)	An allocated public IP for outbound SNAT (optional)
`subnet_id` required	string	Where the gateway's LAN leg sits (any subnet of the VPC)
`tags`	object

Responses

202 Accepted (NatGatewayOut)
400 Invalid request (ErrorOut)
401 Not authenticated (ErrorOut)
403 Access denied: the error names the action and the resource (ErrorOut)
404 Not found (also: the resource belongs to another organization) (ErrorOut)
409 Conflict or quota exceeded (ErrorOut)
422 Idempotency key reused for a different request (ErrorOut)
429 Rate limited (ErrorOut)

Fields of NatGatewayOut

Field	Type	Description
`created_at`	string (date-time)
`description`	string
`id`	string
`lan_ip`	string
`name`	string
`project_id`	string
`public_address`	string (nullable)
`public_ip_id`	string (nullable)
`state`	string
`status_message`	string
`subnet_id`	string
`tags`	object
`trn`	string
`updated_at`	string (date-time)
`vpc_id`	string

GET/api/v1/projects/{project_id}/nat-gateways/{nat_id}

Get Nat Gateway (getNatGateway)

IAM action: network:DescribeNatGateway

Parameter	In	Type	Description
`project_id` required	path	string
`nat_id` required	path	string

Responses

200 OK (NatGatewayOut)
400 Invalid request (ErrorOut)
401 Not authenticated (ErrorOut)
403 Access denied: the error names the action and the resource (ErrorOut)
404 Not found (also: the resource belongs to another organization) (ErrorOut)
409 Conflict or quota exceeded (ErrorOut)
422 Idempotency key reused for a different request (ErrorOut)
429 Rate limited (ErrorOut)

Fields of NatGatewayOut

Field	Type	Description
`created_at`	string (date-time)
`description`	string
`id`	string
`lan_ip`	string
`name`	string
`project_id`	string
`public_address`	string (nullable)
`public_ip_id`	string (nullable)
`state`	string
`status_message`	string
`subnet_id`	string
`tags`	object
`trn`	string
`updated_at`	string (date-time)
`vpc_id`	string

PATCH/api/v1/projects/{project_id}/nat-gateways/{nat_id}

Update Nat Gateway (updateNatGateway)

IAM action: network:UpdateNatGateway

Parameter	In	Type	Description
`project_id` required	path	string
`nat_id` required	path	string

Request body (JSON, TagsPatch)

Field	Type	Description
`description`	string (nullable)
`tags`	object (nullable)

Responses

200 OK (NatGatewayOut)
400 Invalid request (ErrorOut)
401 Not authenticated (ErrorOut)
403 Access denied: the error names the action and the resource (ErrorOut)
404 Not found (also: the resource belongs to another organization) (ErrorOut)
409 Conflict or quota exceeded (ErrorOut)
422 Idempotency key reused for a different request (ErrorOut)
429 Rate limited (ErrorOut)

Fields of NatGatewayOut

Field	Type	Description
`created_at`	string (date-time)
`description`	string
`id`	string
`lan_ip`	string
`name`	string
`project_id`	string
`public_address`	string (nullable)
`public_ip_id`	string (nullable)
`state`	string
`status_message`	string
`subnet_id`	string
`tags`	object
`trn`	string
`updated_at`	string (date-time)
`vpc_id`	string

DELETE/api/v1/projects/{project_id}/nat-gateways/{nat_id}

Delete Nat Gateway (deleteNatGateway)

IAM action: network:DeleteNatGateway

Parameter	In	Type	Description
`project_id` required	path	string
`nat_id` required	path	string

Responses

202 Accepted (NatGatewayOut)
400 Invalid request (ErrorOut)
401 Not authenticated (ErrorOut)
403 Access denied: the error names the action and the resource (ErrorOut)
404 Not found (also: the resource belongs to another organization) (ErrorOut)
409 Conflict or quota exceeded (ErrorOut)
422 Idempotency key reused for a different request (ErrorOut)
429 Rate limited (ErrorOut)

Fields of NatGatewayOut

Field	Type	Description
`created_at`	string (date-time)
`description`	string
`id`	string
`lan_ip`	string
`name`	string
`project_id`	string
`public_address`	string (nullable)
`public_ip_id`	string (nullable)
`state`	string
`status_message`	string
`subnet_id`	string
`tags`	object
`trn`	string
`updated_at`	string (date-time)
`vpc_id`	string

GET/api/v1/projects/{project_id}/public-ips

List Public Ips (listPublicIps)

IAM action: network:DescribePublicIp

Parameter	In	Type
`project_id` required	path	string
`limit`	query	integer (nullable)
`cursor`	query	string (nullable)

Responses

200 OK (Page_PublicIpOut_)
400 Invalid request (ErrorOut)
401 Not authenticated (ErrorOut)
403 Access denied: the error names the action and the resource (ErrorOut)
404 Not found (also: the resource belongs to another organization) (ErrorOut)
409 Conflict or quota exceeded (ErrorOut)
422 Idempotency key reused for a different request (ErrorOut)
429 Rate limited (ErrorOut)

Fields of Page_PublicIpOut_

Field	Type	Description
`items`	array of PublicIpOut
`next_cursor`	string (nullable)

POST/api/v1/projects/{project_id}/public-ips

Allocate Public Ip (allocatePublicIp)

IAM action: network:AllocatePublicIp

Parameter	In	Type	Description
`project_id` required	path	string

Request body (JSON, PublicIpIn)

Field	Type	Description
`description`	string	Default: `""`.
`name` required	string
`tags`	object

Responses

202 Accepted (PublicIpOut)
400 Invalid request (ErrorOut)
401 Not authenticated (ErrorOut)
403 Access denied: the error names the action and the resource (ErrorOut)
404 Not found (also: the resource belongs to another organization) (ErrorOut)
409 Conflict or quota exceeded (ErrorOut)
422 Idempotency key reused for a different request (ErrorOut)
429 Rate limited (ErrorOut)

Fields of PublicIpOut

Field	Type	Description
`address`	string
`association`	string
`created_at`	string (date-time)
`description`	string
`id`	string
`load_balancer_id`	string (nullable)
`name`	string
`nat_gateway_id`	string (nullable)
`project_id`	string
`state`	string
`status_message`	string
`tags`	object
`trn`	string
`updated_at`	string (date-time)
`vm_id`	string (nullable)

GET/api/v1/projects/{project_id}/public-ips/{ip_id}

Get Public Ip (getPublicIp)

IAM action: network:DescribePublicIp

Parameter	In	Type	Description
`project_id` required	path	string
`ip_id` required	path	string

Responses

200 OK (PublicIpOut)
400 Invalid request (ErrorOut)
401 Not authenticated (ErrorOut)
403 Access denied: the error names the action and the resource (ErrorOut)
404 Not found (also: the resource belongs to another organization) (ErrorOut)
409 Conflict or quota exceeded (ErrorOut)
422 Idempotency key reused for a different request (ErrorOut)
429 Rate limited (ErrorOut)

Fields of PublicIpOut

Field	Type	Description
`address`	string
`association`	string
`created_at`	string (date-time)
`description`	string
`id`	string
`load_balancer_id`	string (nullable)
`name`	string
`nat_gateway_id`	string (nullable)
`project_id`	string
`state`	string
`status_message`	string
`tags`	object
`trn`	string
`updated_at`	string (date-time)
`vm_id`	string (nullable)

PATCH/api/v1/projects/{project_id}/public-ips/{ip_id}

Update Public Ip (updatePublicIp)

IAM action: network:UpdatePublicIp

Parameter	In	Type	Description
`project_id` required	path	string
`ip_id` required	path	string

Request body (JSON, TagsPatch)

Field	Type	Description
`description`	string (nullable)
`tags`	object (nullable)

Responses

200 OK (PublicIpOut)
400 Invalid request (ErrorOut)
401 Not authenticated (ErrorOut)
403 Access denied: the error names the action and the resource (ErrorOut)
404 Not found (also: the resource belongs to another organization) (ErrorOut)
409 Conflict or quota exceeded (ErrorOut)
422 Idempotency key reused for a different request (ErrorOut)
429 Rate limited (ErrorOut)

Fields of PublicIpOut

Field	Type	Description
`address`	string
`association`	string
`created_at`	string (date-time)
`description`	string
`id`	string
`load_balancer_id`	string (nullable)
`name`	string
`nat_gateway_id`	string (nullable)
`project_id`	string
`state`	string
`status_message`	string
`tags`	object
`trn`	string
`updated_at`	string (date-time)
`vm_id`	string (nullable)

DELETE/api/v1/projects/{project_id}/public-ips/{ip_id}

Release Public Ip (releasePublicIp)

IAM action: network:ReleasePublicIp

Parameter	In	Type	Description
`project_id` required	path	string
`ip_id` required	path	string

Responses

202 Accepted (PublicIpOut)
400 Invalid request (ErrorOut)
401 Not authenticated (ErrorOut)
403 Access denied: the error names the action and the resource (ErrorOut)
404 Not found (also: the resource belongs to another organization) (ErrorOut)
409 Conflict or quota exceeded (ErrorOut)
422 Idempotency key reused for a different request (ErrorOut)
429 Rate limited (ErrorOut)

Fields of PublicIpOut

Field	Type	Description
`address`	string
`association`	string
`created_at`	string (date-time)
`description`	string
`id`	string
`load_balancer_id`	string (nullable)
`name`	string
`nat_gateway_id`	string (nullable)
`project_id`	string
`state`	string
`status_message`	string
`tags`	object
`trn`	string
`updated_at`	string (date-time)
`vm_id`	string (nullable)

POST/api/v1/projects/{project_id}/public-ips/{ip_id}/associate

Associate Public Ip (associatePublicIp)

IAM action: network:AssociatePublicIp

Parameter	In	Type	Description
`project_id` required	path	string
`ip_id` required	path	string

Request body (JSON, AssociateIn)

Field	Type	Description
`nat_gateway_id`	string (nullable)
`vm_id`	string (nullable)

Responses

202 Accepted (PublicIpOut)
400 Invalid request (ErrorOut)
401 Not authenticated (ErrorOut)
403 Access denied: the error names the action and the resource (ErrorOut)
404 Not found (also: the resource belongs to another organization) (ErrorOut)
409 Conflict or quota exceeded (ErrorOut)
422 Idempotency key reused for a different request (ErrorOut)
429 Rate limited (ErrorOut)

Fields of PublicIpOut

Field	Type	Description
`address`	string
`association`	string
`created_at`	string (date-time)
`description`	string
`id`	string
`load_balancer_id`	string (nullable)
`name`	string
`nat_gateway_id`	string (nullable)
`project_id`	string
`state`	string
`status_message`	string
`tags`	object
`trn`	string
`updated_at`	string (date-time)
`vm_id`	string (nullable)

POST/api/v1/projects/{project_id}/public-ips/{ip_id}/disassociate

Disassociate Public Ip (disassociatePublicIp)

IAM action: network:DisassociatePublicIp

Parameter	In	Type	Description
`project_id` required	path	string
`ip_id` required	path	string

Responses

202 Accepted (PublicIpOut)
400 Invalid request (ErrorOut)
401 Not authenticated (ErrorOut)
403 Access denied: the error names the action and the resource (ErrorOut)
404 Not found (also: the resource belongs to another organization) (ErrorOut)
409 Conflict or quota exceeded (ErrorOut)
422 Idempotency key reused for a different request (ErrorOut)
429 Rate limited (ErrorOut)

Fields of PublicIpOut

Field	Type	Description
`address`	string
`association`	string
`created_at`	string (date-time)
`description`	string
`id`	string
`load_balancer_id`	string (nullable)
`name`	string
`nat_gateway_id`	string (nullable)
`project_id`	string
`state`	string
`status_message`	string
`tags`	object
`trn`	string
`updated_at`	string (date-time)
`vm_id`	string (nullable)

GET/api/v1/projects/{project_id}/public-ips/{ip_id}/history

Public Ip History (publicIpHistory)

This allocation's own events (not the address's earlier holders).

IAM action: network:DescribePublicIp

Parameter	In	Type	Description
`project_id` required	path	string
`ip_id` required	path	string

Responses

200 OK (array of PublicAddressEventOut)
400 Invalid request (ErrorOut)
401 Not authenticated (ErrorOut)
403 Access denied: the error names the action and the resource (ErrorOut)
404 Not found (also: the resource belongs to another organization) (ErrorOut)
409 Conflict or quota exceeded (ErrorOut)
422 Idempotency key reused for a different request (ErrorOut)
429 Rate limited (ErrorOut)

GET/api/v1/projects/{project_id}/security-groups

List Security Groups (listSecurityGroups)

IAM action: network:DescribeSecurityGroup

Parameter	In	Type
`project_id` required	path	string
`vpc_id`	query	string (nullable)
`limit`	query	integer (nullable)
`cursor`	query	string (nullable)

Responses

200 OK (Page_SecurityGroupOut_)
400 Invalid request (ErrorOut)
401 Not authenticated (ErrorOut)
403 Access denied: the error names the action and the resource (ErrorOut)
404 Not found (also: the resource belongs to another organization) (ErrorOut)
409 Conflict or quota exceeded (ErrorOut)
422 Idempotency key reused for a different request (ErrorOut)
429 Rate limited (ErrorOut)

Fields of Page_SecurityGroupOut_

Field	Type	Description
`items`	array of SecurityGroupOut
`next_cursor`	string (nullable)

POST/api/v1/projects/{project_id}/security-groups

Create Security Group (createSecurityGroup)

IAM action: network:CreateSecurityGroup

Parameter	In	Type	Description
`project_id` required	path	string

Request body (JSON, SecurityGroupIn)

Field	Type	Description
`description`	string	Default: `""`.
`name` required	string
`tags`	object
`vpc_id` required	string

Responses

202 Accepted (SecurityGroupOut)
400 Invalid request (ErrorOut)
401 Not authenticated (ErrorOut)
403 Access denied: the error names the action and the resource (ErrorOut)
404 Not found (also: the resource belongs to another organization) (ErrorOut)
409 Conflict or quota exceeded (ErrorOut)
422 Idempotency key reused for a different request (ErrorOut)
429 Rate limited (ErrorOut)

Fields of SecurityGroupOut

Field	Type	Description
`allow_same_group`	boolean
`created_at`	string (date-time)
`description`	string
`id`	string
`is_default`	boolean
`name`	string
`project_id`	string
`rules`	array of RuleOut
`state`	string
`status_message`	string
`tags`	object
`trn`	string
`updated_at`	string (date-time)
`vpc_id`	string

GET/api/v1/projects/{project_id}/security-groups/{group_id}

Get Security Group (getSecurityGroup)

IAM action: network:DescribeSecurityGroup

Parameter	In	Type	Description
`project_id` required	path	string
`group_id` required	path	string

Responses

200 OK (SecurityGroupOut)
400 Invalid request (ErrorOut)
401 Not authenticated (ErrorOut)
403 Access denied: the error names the action and the resource (ErrorOut)
404 Not found (also: the resource belongs to another organization) (ErrorOut)
409 Conflict or quota exceeded (ErrorOut)
422 Idempotency key reused for a different request (ErrorOut)
429 Rate limited (ErrorOut)

Fields of SecurityGroupOut

Field	Type	Description
`allow_same_group`	boolean
`created_at`	string (date-time)
`description`	string
`id`	string
`is_default`	boolean
`name`	string
`project_id`	string
`rules`	array of RuleOut
`state`	string
`status_message`	string
`tags`	object
`trn`	string
`updated_at`	string (date-time)
`vpc_id`	string

PATCH/api/v1/projects/{project_id}/security-groups/{group_id}

Update Security Group (updateSecurityGroup)

IAM action: network:UpdateSecurityGroup

Parameter	In	Type	Description
`project_id` required	path	string
`group_id` required	path	string

Request body (JSON, TagsPatch)

Field	Type	Description
`description`	string (nullable)
`tags`	object (nullable)

Responses

200 OK (SecurityGroupOut)
400 Invalid request (ErrorOut)
401 Not authenticated (ErrorOut)
403 Access denied: the error names the action and the resource (ErrorOut)
404 Not found (also: the resource belongs to another organization) (ErrorOut)
409 Conflict or quota exceeded (ErrorOut)
422 Idempotency key reused for a different request (ErrorOut)
429 Rate limited (ErrorOut)

Fields of SecurityGroupOut

Field	Type	Description
`allow_same_group`	boolean
`created_at`	string (date-time)
`description`	string
`id`	string
`is_default`	boolean
`name`	string
`project_id`	string
`rules`	array of RuleOut
`state`	string
`status_message`	string
`tags`	object
`trn`	string
`updated_at`	string (date-time)
`vpc_id`	string

DELETE/api/v1/projects/{project_id}/security-groups/{group_id}

Delete Security Group (deleteSecurityGroup)

IAM action: network:DeleteSecurityGroup

Parameter	In	Type	Description
`project_id` required	path	string
`group_id` required	path	string

Responses

202 Accepted (SecurityGroupOut)
400 Invalid request (ErrorOut)
401 Not authenticated (ErrorOut)
403 Access denied: the error names the action and the resource (ErrorOut)
404 Not found (also: the resource belongs to another organization) (ErrorOut)
409 Conflict or quota exceeded (ErrorOut)
422 Idempotency key reused for a different request (ErrorOut)
429 Rate limited (ErrorOut)

Fields of SecurityGroupOut

Field	Type	Description
`allow_same_group`	boolean
`created_at`	string (date-time)
`description`	string
`id`	string
`is_default`	boolean
`name`	string
`project_id`	string
`rules`	array of RuleOut
`state`	string
`status_message`	string
`tags`	object
`trn`	string
`updated_at`	string (date-time)
`vpc_id`	string

POST/api/v1/projects/{project_id}/security-groups/{group_id}/rules

Add Rule (addRule)

IAM action: network:AuthorizeSecurityGroupIngressnetwork:AuthorizeSecurityGroupEgress

Parameter	In	Type	Description
`project_id` required	path	string
`group_id` required	path	string

Request body (JSON, RuleIn)

Field	Type	Description
`description`	string	Default: `""`.
`direction` required	"ingress" \| "egress"
`ip_version`	"ipv4" \| "ipv6" (nullable)	Taken from remote_cidr when omitted; required with remote_group_id
`port_from`	integer (nullable)
`port_to`	integer (nullable)
`protocol` required	"all" \| "tcp" \| "udp" \| "icmp"
`remote_cidr`	string (nullable)
`remote_group_id`	string (nullable)

Responses

202 Accepted (SecurityGroupOut)
400 Invalid request (ErrorOut)
401 Not authenticated (ErrorOut)
403 Access denied: the error names the action and the resource (ErrorOut)
404 Not found (also: the resource belongs to another organization) (ErrorOut)
409 Conflict or quota exceeded (ErrorOut)
422 Idempotency key reused for a different request (ErrorOut)
429 Rate limited (ErrorOut)

Fields of SecurityGroupOut

Field	Type	Description
`allow_same_group`	boolean
`created_at`	string (date-time)
`description`	string
`id`	string
`is_default`	boolean
`name`	string
`project_id`	string
`rules`	array of RuleOut
`state`	string
`status_message`	string
`tags`	object
`trn`	string
`updated_at`	string (date-time)
`vpc_id`	string

DELETE/api/v1/projects/{project_id}/security-groups/{group_id}/rules/{rule_id}

Remove Rule (removeRule)

IAM action: network:RevokeSecurityGroupIngressnetwork:RevokeSecurityGroupEgress

Parameter	In	Type
`project_id` required	path	string
`group_id` required	path	string
`rule_id` required	path	string

Responses

202 Accepted (SecurityGroupOut)
400 Invalid request (ErrorOut)
401 Not authenticated (ErrorOut)
403 Access denied: the error names the action and the resource (ErrorOut)
404 Not found (also: the resource belongs to another organization) (ErrorOut)
409 Conflict or quota exceeded (ErrorOut)
422 Idempotency key reused for a different request (ErrorOut)
429 Rate limited (ErrorOut)

Fields of SecurityGroupOut

Field	Type	Description
`allow_same_group`	boolean
`created_at`	string (date-time)
`description`	string
`id`	string
`is_default`	boolean
`name`	string
`project_id`	string
`rules`	array of RuleOut
`state`	string
`status_message`	string
`tags`	object
`trn`	string
`updated_at`	string (date-time)
`vpc_id`	string

GET/api/v1/projects/{project_id}/subnets

List Subnets (listSubnets)

IAM action: network:DescribeSubnet

Parameter	In	Type
`project_id` required	path	string
`vpc_id`	query	string (nullable)
`limit`	query	integer (nullable)
`cursor`	query	string (nullable)

Responses

200 OK (Page_SubnetOut_)
400 Invalid request (ErrorOut)
401 Not authenticated (ErrorOut)
403 Access denied: the error names the action and the resource (ErrorOut)
404 Not found (also: the resource belongs to another organization) (ErrorOut)
409 Conflict or quota exceeded (ErrorOut)
422 Idempotency key reused for a different request (ErrorOut)
429 Rate limited (ErrorOut)

Fields of Page_SubnetOut_

Field	Type	Description
`items`	array of SubnetOut
`next_cursor`	string (nullable)

POST/api/v1/projects/{project_id}/subnets

Create Subnet (createSubnet)

IAM action: network:CreateSubnet

Parameter	In	Type	Description
`project_id` required	path	string

Request body (JSON, SubnetIn)

Field	Type	Description
`cidr` required	string	IPv4 CIDR inside the VPC's, not overlapping its subnets
`description`	string	Default: `""`.
`name` required	string
`tags`	object
`vpc_id` required	string

Responses

202 Accepted (SubnetOut)
400 Invalid request (ErrorOut)
401 Not authenticated (ErrorOut)
403 Access denied: the error names the action and the resource (ErrorOut)
404 Not found (also: the resource belongs to another organization) (ErrorOut)
409 Conflict or quota exceeded (ErrorOut)
422 Idempotency key reused for a different request (ErrorOut)
429 Rate limited (ErrorOut)

Fields of SubnetOut

Field	Type	Description
`available_ipv4`	integer (nullable)
`cidr`	string
`created_at`	string (date-time)
`description`	string
`gateway`	string
`id`	string
`ipv6_cidr`	string
`ipv6_gateway`	string
`is_default`	boolean
`name`	string
`project_id`	string
`state`	string
`status_message`	string
`tags`	object
`trn`	string
`updated_at`	string (date-time)
`vpc_id`	string

GET/api/v1/projects/{project_id}/subnets/{subnet_id}

Get Subnet (getSubnet)

IAM action: network:DescribeSubnet

Parameter	In	Type	Description
`project_id` required	path	string
`subnet_id` required	path	string

Responses

200 OK (SubnetOut)
400 Invalid request (ErrorOut)
401 Not authenticated (ErrorOut)
403 Access denied: the error names the action and the resource (ErrorOut)
404 Not found (also: the resource belongs to another organization) (ErrorOut)
409 Conflict or quota exceeded (ErrorOut)
422 Idempotency key reused for a different request (ErrorOut)
429 Rate limited (ErrorOut)

Fields of SubnetOut

Field	Type	Description
`available_ipv4`	integer (nullable)
`cidr`	string
`created_at`	string (date-time)
`description`	string
`gateway`	string
`id`	string
`ipv6_cidr`	string
`ipv6_gateway`	string
`is_default`	boolean
`name`	string
`project_id`	string
`state`	string
`status_message`	string
`tags`	object
`trn`	string
`updated_at`	string (date-time)
`vpc_id`	string

PATCH/api/v1/projects/{project_id}/subnets/{subnet_id}

Update Subnet (updateSubnet)

IAM action: network:UpdateSubnet

Parameter	In	Type	Description
`project_id` required	path	string
`subnet_id` required	path	string

Request body (JSON, TagsPatch)

Field	Type	Description
`description`	string (nullable)
`tags`	object (nullable)

Responses

200 OK (SubnetOut)
400 Invalid request (ErrorOut)
401 Not authenticated (ErrorOut)
403 Access denied: the error names the action and the resource (ErrorOut)
404 Not found (also: the resource belongs to another organization) (ErrorOut)
409 Conflict or quota exceeded (ErrorOut)
422 Idempotency key reused for a different request (ErrorOut)
429 Rate limited (ErrorOut)

Fields of SubnetOut

Field	Type	Description
`available_ipv4`	integer (nullable)
`cidr`	string
`created_at`	string (date-time)
`description`	string
`gateway`	string
`id`	string
`ipv6_cidr`	string
`ipv6_gateway`	string
`is_default`	boolean
`name`	string
`project_id`	string
`state`	string
`status_message`	string
`tags`	object
`trn`	string
`updated_at`	string (date-time)
`vpc_id`	string

DELETE/api/v1/projects/{project_id}/subnets/{subnet_id}

Delete Subnet (deleteSubnet)

IAM action: network:DeleteSubnet

Parameter	In	Type	Description
`project_id` required	path	string
`subnet_id` required	path	string

Responses

202 Accepted (SubnetOut)
400 Invalid request (ErrorOut)
401 Not authenticated (ErrorOut)
403 Access denied: the error names the action and the resource (ErrorOut)
404 Not found (also: the resource belongs to another organization) (ErrorOut)
409 Conflict or quota exceeded (ErrorOut)
422 Idempotency key reused for a different request (ErrorOut)
429 Rate limited (ErrorOut)

Fields of SubnetOut

Field	Type	Description
`available_ipv4`	integer (nullable)
`cidr`	string
`created_at`	string (date-time)
`description`	string
`gateway`	string
`id`	string
`ipv6_cidr`	string
`ipv6_gateway`	string
`is_default`	boolean
`name`	string
`project_id`	string
`state`	string
`status_message`	string
`tags`	object
`trn`	string
`updated_at`	string (date-time)
`vpc_id`	string

GET/api/v1/projects/{project_id}/vpcs

List Vpcs (listVpcs)

IAM action: network:DescribeVpc

Parameter	In	Type
`project_id` required	path	string
`limit`	query	integer (nullable)
`cursor`	query	string (nullable)

Responses

200 OK (Page_VpcOut_)
400 Invalid request (ErrorOut)
401 Not authenticated (ErrorOut)
403 Access denied: the error names the action and the resource (ErrorOut)
404 Not found (also: the resource belongs to another organization) (ErrorOut)
409 Conflict or quota exceeded (ErrorOut)
422 Idempotency key reused for a different request (ErrorOut)
429 Rate limited (ErrorOut)

Fields of Page_VpcOut_

Field	Type	Description
`items`	array of VpcOut
`next_cursor`	string (nullable)

POST/api/v1/projects/{project_id}/vpcs

Create Vpc (createVpc)

IAM action: network:CreateVpc

Parameter	In	Type	Description
`project_id` required	path	string

Request body (JSON, VpcIn)

Field	Type	Description
`cidr` required	string	IPv4 CIDR from 10/8, 172.16/12 or 192.168/16, /16 to /28
`description`	string	Default: `""`.
`name` required	string
`tags`	object

Responses

202 Accepted (VpcOut)
400 Invalid request (ErrorOut)
401 Not authenticated (ErrorOut)
403 Access denied: the error names the action and the resource (ErrorOut)
404 Not found (also: the resource belongs to another organization) (ErrorOut)
409 Conflict or quota exceeded (ErrorOut)
422 Idempotency key reused for a different request (ErrorOut)
429 Rate limited (ErrorOut)

Fields of VpcOut

Field	Type	Description
`cidr`	string
`created_at`	string (date-time)
`description`	string
`dns_server`	string
`has_nat_gateway`	boolean
`id`	string
`ipv6_cidr`	string
`is_default`	boolean
`name`	string
`project_id`	string
`state`	string
`status_message`	string
`tags`	object
`trn`	string
`updated_at`	string (date-time)

GET/api/v1/projects/{project_id}/vpcs/{vpc_id}

Get Vpc (getVpc)

IAM action: network:DescribeVpc

Parameter	In	Type	Description
`project_id` required	path	string
`vpc_id` required	path	string

Responses

200 OK (VpcOut)
400 Invalid request (ErrorOut)
401 Not authenticated (ErrorOut)
403 Access denied: the error names the action and the resource (ErrorOut)
404 Not found (also: the resource belongs to another organization) (ErrorOut)
409 Conflict or quota exceeded (ErrorOut)
422 Idempotency key reused for a different request (ErrorOut)
429 Rate limited (ErrorOut)

Fields of VpcOut

Field	Type	Description
`cidr`	string
`created_at`	string (date-time)
`description`	string
`dns_server`	string
`has_nat_gateway`	boolean
`id`	string
`ipv6_cidr`	string
`is_default`	boolean
`name`	string
`project_id`	string
`state`	string
`status_message`	string
`tags`	object
`trn`	string
`updated_at`	string (date-time)

PATCH/api/v1/projects/{project_id}/vpcs/{vpc_id}

Update Vpc (updateVpc)

IAM action: network:UpdateVpc

Parameter	In	Type	Description
`project_id` required	path	string
`vpc_id` required	path	string

Request body (JSON, TagsPatch)

Field	Type	Description
`description`	string (nullable)
`tags`	object (nullable)

Responses

200 OK (VpcOut)
400 Invalid request (ErrorOut)
401 Not authenticated (ErrorOut)
403 Access denied: the error names the action and the resource (ErrorOut)
404 Not found (also: the resource belongs to another organization) (ErrorOut)
409 Conflict or quota exceeded (ErrorOut)
422 Idempotency key reused for a different request (ErrorOut)
429 Rate limited (ErrorOut)

Fields of VpcOut

Field	Type	Description
`cidr`	string
`created_at`	string (date-time)
`description`	string
`dns_server`	string
`has_nat_gateway`	boolean
`id`	string
`ipv6_cidr`	string
`is_default`	boolean
`name`	string
`project_id`	string
`state`	string
`status_message`	string
`tags`	object
`trn`	string
`updated_at`	string (date-time)

DELETE/api/v1/projects/{project_id}/vpcs/{vpc_id}

Delete Vpc (deleteVpc)

IAM action: network:DeleteVpc

Parameter	In	Type	Description
`project_id` required	path	string
`vpc_id` required	path	string

Responses

202 Accepted (VpcOut)
400 Invalid request (ErrorOut)
401 Not authenticated (ErrorOut)
403 Access denied: the error names the action and the resource (ErrorOut)
404 Not found (also: the resource belongs to another organization) (ErrorOut)
409 Conflict or quota exceeded (ErrorOut)
422 Idempotency key reused for a different request (ErrorOut)
429 Rate limited (ErrorOut)

Fields of VpcOut

Field	Type	Description
`cidr`	string
`created_at`	string (date-time)
`description`	string
`dns_server`	string
`has_nat_gateway`	boolean
`id`	string
`ipv6_cidr`	string
`is_default`	boolean
`name`	string
`project_id`	string
`state`	string
`status_message`	string
`tags`	object
`trn`	string
`updated_at`	string (date-time)