Skip to main content
API docs by Redocly

VPC API Product (1.156.0)

URL: https://github.com/luizalabs

VPC Api Product

ports

Operations related to Ports

Details of a Port list

Return a detailed list of ports from the provided tenant_id

Authorizations:
OAuth2
query Parameters
port_id_list
Array of any (Port Id List)
Default: ""
header Parameters
x-tenant-id
required
any (X-Tenant-Id)

Tenant id of the project

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete Port

Delete a port from the provided tenant_id

Authorizations:
OAuth2
path Parameters
port_id
required
any (port_id)

ID of the Port to delete

header Parameters
x-tenant-id
required
any (X-Tenant-Id)

Tenant id of the project

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Port Details

Return a port details from the provided tenant_id

Authorizations:
OAuth2
path Parameters
port_id
required
any (Port Id)
header Parameters
x-tenant-id
required
any (X-Tenant-Id)

Tenant id of the project

Responses

Response samples

Content type
application/json
{
  • "created_at": "2022-01-01 00:00:00",
  • "description": "port description",
  • "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "ip_address": [
    ],
  • "is_admin_state_up": true,
  • "is_port_security_enabled": true,
  • "name": "port_name",
  • "public_ip": [
    ],
  • "security_groups": [
    ],
  • "updated": "2022-01-01 00:00:00",
  • "vpc_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}

Attach Security Group

Attach a Security Group to a Port with provided port_id, security_group_id, x-tenant-id of an specific project type

Authorizations:
OAuth2
path Parameters
port_id
required
any (port_id)

ID of the Port to attach security group

security_group_id
required
any (security_group_id)

ID of the Security Group to attach

header Parameters
x-tenant-id
required
any (X-Tenant-Id)

Tenant id of the project

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Detach Security Group

Detach a Security Group to a Port with provided port_id, security_group_id, x-tenant-id of an specific project type

Authorizations:
OAuth2
path Parameters
port_id
required
any (port_id)

ID of the Port to detach security group

security_group_id
required
any (security_group_id)

ID of the Security Group to detach

header Parameters
x-tenant-id
required
any (X-Tenant-Id)

Tenant id of the project

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

public_ips

Operations related to Public IPs

Tenant's public IP list

Return a tenant's public ip list

Authorizations:
OAuth2
header Parameters
x-tenant-id
required
any (X-Tenant-Id)

Tenant id of the project

Responses

Response samples

Content type
application/json
{
  • "public_ips": [
    ]
}

Delete Public IP

Delete a Public IP from the provided tenant_id

Authorizations:
OAuth2
path Parameters
public_ip_id
required
any (Public IP ID)

Id of the Public IP to delete

header Parameters
x-tenant-id
required
any (X-Tenant-Id)

Tenant id of the project

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Public IP Details

Return a Public IP details

Authorizations:
OAuth2
path Parameters
public_ip_id
required
any (Public IP ID)

Id of the Public IP to retrieve

header Parameters
x-tenant-id
required
any (X-Tenant-Id)

Tenant id of the project

Responses

Response samples

Content type
application/json
{
  • "created_at": "2022-01-01 00:00:00",
  • "description": "port description",
  • "error": "error",
  • "external_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "port_ip": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "project_type": "project_type",
  • "public_ip": "100.94.5.31",
  • "status": "created",
  • "tenant_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "updated": "2022-01-01 00:00:00",
  • "vpc_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}

Attach Public IP

Attach a Public IP to a Port

Authorizations:
OAuth2
path Parameters
public_ip_id
required
any (Public IP ID)

Id of the Public IP to attach port to

port_id
required
any (Port ID)

Id of the Port to attach the Public IP

header Parameters
x-tenant-id
required
any (X-Tenant-Id)

Tenant id of the project

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Detach Public IP

Detach a Public IP to a Port

Authorizations:
OAuth2
path Parameters
public_ip_id
required
any (Public IP ID)

Id of the Public IP to detach port to

port_id
required
any (Port ID)

Id of the Port to detach the Public IP

header Parameters
x-tenant-id
required
any (X-Tenant-Id)

Tenant id of the project

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

rules

Operations related to Rules

Delete a Rule

Delete a rule from the provided tenant_id

Authorizations:
OAuth2
path Parameters
rule_id
required
any (Rule ID)

Id of the Rule

header Parameters
x-tenant-id
required
any (X-Tenant-Id)

Tenant id of the project

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Rule Details

Return a rule details

Authorizations:
OAuth2
path Parameters
rule_id
required
any (Rule ID)

Id of the Rule

header Parameters
x-tenant-id
required
any (X-Tenant-Id)

Tenant id of the project

Responses

Response samples

Content type
application/json
{
  • "created_at": "2022-01-01 00:00:00",
  • "description": "Some rule description",
  • "direction": "egress",
  • "ethertype": "IPv4",
  • "external_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "port_range_max": 8028,
  • "port_range_min": 8028,
  • "protocol": "tcp",
  • "remote_ip_prefix": "100.94.0.0/24",
  • "security_group_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "status": "created"
}

security_groups

Operations related to Security Groups

List Security Groups by Tenant

Returns a list of security groups for a provided tenant_id

Authorizations:
OAuth2
header Parameters
x-tenant-id
required
any (X-Tenant-Id)

Tenant id of the project

Responses

Response samples

Content type
application/json
{
  • "security_groups": [
    ]
}

Create Security Group

Create a Security Group

Authorizations:
OAuth2
query Parameters
validate_quota
boolean (validateQuota)
Default: true

Validate the quota before creating Security Group

wait
boolean (wait)
Default: true

The request will be asynchronous. The wait parameter tells the API that you want the request to simulate synchronous behavior (to maintain endpoint compatibility). You can set an approximate timeout with the waitTimeout parameter

wait_timeout
integer (waitTimeout)
Default: 120

the approximate time in seconds you want to wait when simulating the request as synchronous (only works with wait=true)

skip_default_rules
boolean (Skip Default Rules)
Default: false

Skip creation of default security group rules

header Parameters
x-tenant-id
required
any (X-Tenant-Id)

Tenant id of the project

Request Body schema: application/json
required
required
Name (string) or Name (any) (Name)
Description (string) or Description (any) (Description)
Default: ""

Responses

Request samples

Content type
application/json
{
  • "description": "security group description",
  • "name": "security_group_name"
}

Response samples

Content type
application/json
{
  • "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}

Delete a security group

Delete a security group from the provided tenant_id

Authorizations:
OAuth2
path Parameters
security_group_id
required
any (Security Group ID)

Id of the security group to delete

header Parameters
x-tenant-id
required
any (X-Tenant-Id)

Tenant id of the project

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Security Group Details

Return a security group details

Authorizations:
OAuth2
path Parameters
security_group_id
required
any (Security Group ID)

Id of the security group to detail

header Parameters
x-tenant-id
required
any (X-Tenant-Id)

Tenant id of the project

Responses

Response samples

Content type
application/json
{
  • "created_at": "2022-01-01 00:00:00",
  • "description": "security group description",
  • "error": "null",
  • "external_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "is_default": true,
  • "name": "security_group_name",
  • "ports": [
    ],
  • "project_type": "default",
  • "rules": [
    ],
  • "status": "created",
  • "tenant_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "updated": "2022-01-01 00:00:00",
  • "vpc_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}

List Rules

Returns a list of rules for a provided security_group_id

Authorizations:
OAuth2
path Parameters
security_group_id
required
any (Security Group ID)

Id of the Security Group

header Parameters
x-tenant-id
required
any (X-Tenant-Id)

Tenant id of the project

Responses

Response samples

Content type
application/json
{
  • "rules": [
    ]
}

Create Rule

Create a Rule async, returning its ID. To monitor the creation progress, please check the status in the service message or implement polling.Either a remote_ip_prefix or a remote_group_id can be specified.With remote_ip_prefix, all IPs that match the criteria will be allowed.With remote_group_id, only the specified security group is allowed to communicatefollowing the specified protocol, direction and port_range_min/max

Authorizations:
OAuth2
path Parameters
security_group_id
required
any (Security Group ID)

Id of the Security Group

query Parameters
validate_quota
boolean (validateQuota)
Default: true

Validate the quota before creating Rule

wait (boolean) or wait (any) (wait)
Default: true

The request will be asynchronous. The wait parameter tells the API that you want the request to simulate synchronous behavior (to maintain endpoint compatibility). You can set an approximate timeout with the waitTimeout parameter

waitTimeout (integer) or waitTimeout (any) (waitTimeout)
Default: 120

the approximate time in seconds you want to wait when simulating the request as synchronous (only works with wait=true)

header Parameters
x-tenant-id
required
any (X-Tenant-Id)

Tenant id of the project

Request Body schema: application/json
required
direction
required
string (Direction)

Direction of the rule, either ingress or egress

Port Range Min (integer) or Port Range Min (any) (Port Range Min)
Port Range Max (integer) or Port Range Max (any) (Port Range Max)
Protocol (string) or Protocol (any) (Protocol)
Remote Ip Prefix (string) or Remote Ip Prefix (any) (Remote Ip Prefix)
ethertype
required
string (Ethertype)

Ethertype of the rule, either IPv4 or IPv6

Description (string) or Description (any) (Description)

Description of the security group rule

Responses

Request samples

Content type
application/json
{
  • "description": "Some rule description",
  • "direction": "egress",
  • "ethertype": "IPv4",
  • "port_range_max": 8028,
  • "port_range_min": 8028,
  • "protocol": "tcp",
  • "remote_ip_prefix": "100.94.0.0/24"
}

Response samples

Content type
application/json
{
  • "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}

subnetpools

Operations related to Subnet Pools

List Subnet Pools by Tenant

Returns a list of Subnet Pools for the current tenant's project

Authorizations:
OAuth2
query Parameters
_offset
integer (Items Offset) >= 0
Default: 0

Start item for pagination

_limit
integer (Pagination) >= 1
Default: 20

Number of items per page

_sort
string ( Sort)
Default: "created_at:desc"
Examples:
  • _sort=created_at:desc - created_at:desc
  • _sort=created_at:asc - created_at:asc

Name of the field wich the list must be ordered by ending with :asc or :desc

_az_id
string ( Az Id)
Default: "a"
header Parameters
x-tenant-id
required
any (X-Tenant-Id)

Tenant id of the project

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "results": [
    ]
}

Create a Subnet Pool in a tenant

Create a Subnet Pool

Authorizations:
OAuth2
header Parameters
x-tenant-id
required
any (X-Tenant-Id)

Tenant id of the project

Request Body schema: application/json
required
cidr
string (Cidr)
Default: "172.26.0.0/16"

The CIDR notation for the subnet pool.

name
required
string (Name)

The name of the subnet pool.

description
required
string (Description)

The description for the subnet pool

type
string (Type) ^(pip|default)$
Default: "default"

The type of subnetpool, pip or default.

Responses

Request samples

Content type
application/json
{
  • "cidr": "172.26.0.0/16",
  • "description": "some description",
  • "name": "some_subnet_pool"
}

Response samples

Content type
application/json
{
  • "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}

Delete Subnet Pool by ID

Delete one Subnet Pool by ID

Authorizations:
OAuth2
path Parameters
subnetpool_id
required
any (subnetpoolId)

Id of the Subnet Pool to delete

header Parameters
x-tenant-id
required
any (X-Tenant-Id)

Tenant id of the project

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Get Subnet Pool by ID

Get details of a specific Subnet Pool

Authorizations:
OAuth2
path Parameters
subnetpool_id
required
any (subnetpoolId)

Id of the Subnet Pool to get details

header Parameters
x-tenant-id
required
any (X-Tenant-Id)

Tenant id of the project

Responses

Response samples

Content type
application/json
{
  • "cidr": "172.26.0.0/16",
  • "created_at": "2022-01-01T00:00:00.000000Z",
  • "description": "some description",
  • "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "ip_version": 4,
  • "is_default": true,
  • "name": "some_subnet_pool",
  • "tenant_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}

Book Subnetpool

Booking a CIDR range from a subnetpool

Authorizations:
OAuth2
path Parameters
subnetpool_id
required
any (subnetpoolId)

Id of the Subnet Pool to get details

header Parameters
x-tenant-id
required
any (X-Tenant-Id)

Tenant id of the project

Request Body schema: application/json
required
Cidr (string) or Cidr (any) (Cidr)
Mask (integer) or Mask (any) (Mask)

Responses

Request samples

Content type
application/json
Example
{
  • "cidr": "172.26.0.0/16"
}

Response samples

Content type
application/json
{
  • "cidr": "172.26.0.0/16"
}

Unbook Subnetpool

Unbooking a CIDR range from a subnetpool

Authorizations:
OAuth2
path Parameters
subnetpool_id
required
any (subnetpoolId)

Id of the Subnet Pool to get details

header Parameters
x-tenant-id
required
any (X-Tenant-Id)

Tenant id of the project

Request Body schema: application/json
required
cidr
string (Cidr)
Default: "172.26.0.0/16"

The CIDR notation for the subnet pool.

Responses

Request samples

Content type
application/json
{
  • "cidr": "172.26.0.0/16"
}

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

subnets

Operations related to Subnets

Delete a Subnet

Delete a subnet from the provided tenant_id

Authorizations:
OAuth2
path Parameters
subnet_id
required
any (Subnet Id)

Id of the Subnet to delete

header Parameters
x-tenant-id
required
any (X-Tenant-Id)

Tenant id of the project

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Subnet Details

Returns a subnet details

Authorizations:
OAuth2
path Parameters
subnet_id
required
any (Subnet Id)

Id of the Subnet to detail

header Parameters
x-tenant-id
required
any (X-Tenant-Id)

Tenant id of the project

Responses

Response samples

Content type
application/json
{
  • "cidr_block": "172.20.0.0/24",
  • "created_at": "2022-01-01 00:00:00",
  • "description": "vpc description",
  • "dhcp_pools": [
    ],
  • "dns_nameservers": [
    ],
  • "gateway_ip": "172.50.0.1",
  • "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "ip_version": "4",
  • "name": "vpc_name",
  • "subnetpool_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "updated": "2022-01-01 00:00:00",
  • "vpc_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "zone": "a"
}

Update Subnet

Update a subnet from the provided tenant_id

Authorizations:
OAuth2
path Parameters
subnet_id
required
any (Subnet Id)

Id of the Subnet to update

header Parameters
x-tenant-id
required
any (X-Tenant-Id)

Tenant id of the project

Request Body schema: application/json
required
dns_nameservers
Array of strings <ipvanyaddress> (Dns Nameservers) [ items <ipvanyaddress > ]
Default: []

Responses

Request samples

Content type
application/json
{
  • "dns_nameservers": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}

vpcs

Operations related to VPCs

List VPC

Returns a list of VPCs for a provided tenant_id

Authorizations:
OAuth2
header Parameters
x-tenant-id
required
any (X-Tenant-Id)

Tenant id of the project

Responses

Response samples

Content type
application/json
{
  • "vpcs": [
    ]
}

Delete VPC

Delete a VPC from the provided tenant_id

Authorizations:
OAuth2
path Parameters
vpc_id
required
any (VPC Id)

ID of the VPC to delete

header Parameters
x-tenant-id
required
any (X-Tenant-Id)

Tenant id of the project

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

VPC Details

Return a VPC details

Authorizations:
OAuth2
path Parameters
vpc_id
required
any (VPC Id)

ID of the VPC to detail

header Parameters
x-tenant-id
required
any (X-Tenant-Id)

Tenant id of the project

Responses

Response samples

Content type
application/json
{
  • "created_at": "2022-01-01 00:00:00",
  • "description": "DESCRIPTION",
  • "error": "error",
  • "external_network": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "is_default": true,
  • "name": "vpc_name",
  • "network_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "router_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "security_groups": [
    ],
  • "status": "created",
  • "subnets": [
    ],
  • "tenant_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "updated": "2022-01-01 00:00:00"
}

List Ports

Returns a list of ports for a provided vpc_id and x-tenant-id. The list will be paginated, it means you can easily find what you need just setting the page number(_offset) and the quantity of items per page(_limit). The level of detail can also be set

Authorizations:
OAuth2
path Parameters
vpc_id
required
any (vpc_id)

ID of VPC to list ports

query Parameters
detailed
boolean (Detailed)
Default: true
Name of the port to list (string) or Name of the port to list (any) (Name of the port to list)

Filter ports results with name

_offset
integer (Page Number) >= 1
Default: 1

Page Number

_limit
integer (Items Per Page) >= 1
Default: 10

Items Per Page

port_id_list
Array of any (Port Id List)
Default: ""
header Parameters
x-tenant-id
required
any (X-Tenant-Id)

Tenant id of the project

Responses

Response samples

Content type
application/json
Example
{
  • "ports_simplified": [
    ]
}

Create Port

Create a Port with provided vpc_id and x-tenant-id. You can provide a list of security_groups_id or subnets

Authorizations:
OAuth2
path Parameters
vpc_id
required
any (vpc_id)

ID of the VPC to create port

header Parameters
x-tenant-id
required
any (X-Tenant-Id)

Tenant id of the project

X-Zone (string) or X-Zone (any) (X-Zone)
Request Body schema: application/json
required
name
required
string (Name) [ 5 .. 100 ] characters
Has Pip (boolean) or Has Pip (any) (Has Pip)
Default: true
Has Sg (boolean) or Has Sg (any) (Has Sg)
Default: true
subnets
Array of strings (Subnets)
Default: []
Array of Security Groups Id (strings) or Security Groups Id (any) (Security Groups Id)
Default: []

Responses

Request samples

Content type
application/json
{
  • "has_pip": true,
  • "has_sg": true,
  • "name": "port_name",
  • "security_groups_id": [
    ],
  • "subnets": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}

List Public IPs

Returns a list of Public IPs for a provided vpc_id

Authorizations:
OAuth2
path Parameters
vpc_id
required
any (Vpc ID)

Id of the VPC to list the Public IPs in

header Parameters
x-tenant-id
required
any (X-Tenant-Id)

Tenant id of the project

Responses

Response samples

Content type
application/json
{
  • "public_ips": [
    ]
}

Create Public IP

Create async Public IP in a VPC with provided vpc_id and x_tenant_id

Authorizations:
OAuth2
path Parameters
vpc_id
required
any (Vpc ID)

Id of the VPC to create the Public IP in

query Parameters
validate_quota
boolean (validateQuota)
Default: true

Validate the quota before creating the Public IP

wait
boolean (wait)
Default: true

The request will be asynchronous. The wait parameter tells the API that you want the request to simulate synchronous behavior (to maintain endpoint compatibility). You can set an approximate timeout with the waitTimeout parameter

waitTimeout (integer) or waitTimeout (any) (waitTimeout)
Default: 120

the approximate time in seconds you want to wait when simulating the request as synchronous (only works with wait=true)

header Parameters
x-tenant-id
required
any (X-Tenant-Id)

Tenant id of the project

Request Body schema: application/json
required
Description (string) or Description (any) (Description)
Default: ""
Any of
string (Description)
Default: ""

Responses

Request samples

Content type
application/json
{
  • "description": "public_ip_description"
}

Response samples

Content type
application/json
{
  • "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}

List Subnets

Returns a list of subnets for a provided vpc_id

Authorizations:
OAuth2
path Parameters
vpc_id
required
any (Vpc Id)

Id of the VPC to list Subnets

header Parameters
x-tenant-id
required
any (X-Tenant-Id)

Tenant id of the project

Responses

Response samples

Content type
application/json
{
  • "subnets": [
    ]
}

Create Subnet

Create a Subnet

Authorizations:
OAuth2
path Parameters
vpc_id
required
any (Vpc Id)

Id of the VPC to create Subnet

header Parameters
x-tenant-id
required
any (X-Tenant-Id)

Tenant id of the project

X-Zone (string) or X-Zone (any) (X-Zone)
Request Body schema: application/json
required
name
required
string (Name)
Description (string) or Description (any) (Description)
cidr_block
required
string (Cidr Block)
ip_version
required
integer (Ip Version)
dns_nameservers
Array of strings <ipvanyaddress> (Dns Nameservers) [ items <ipvanyaddress > ]
Default: []
Subnetpool Id (string) or Subnetpool Id (any) (Subnetpool Id)

Responses

Request samples

Content type
application/json
Example
{
  • "name": "subnet_name",
  • "description": "some_description",
  • "subnetpool_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "cidr_block": "24",
  • "ip_version": 4,
  • "dns_nameservers": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}

Create a new Virtual Private Cloud (VPC)

Create a new Virtual Private Cloud (VPC).

Authorizations:
OAuth2
header Parameters
x-tenant-id
required
string (X-Tenant-Id)

Tenant id of the project

Request Body schema: application/json
required
name
required
string (Name)
Description (string) or Description (any) (Description)

Responses

Request samples

Content type
application/json
{
  • "description": "Description",
  • "name": "VPC Name"
}

Response samples

Content type
application/json
{
  • "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "status": "pending"
}

nat_gateways

Operations related to Nat Gateway

List the NAT Gateways from a VPC

List the NAT (Network Address Translation) Gateways from a VPC.

Authorizations:
OAuth2
query Parameters
vpc_id
required
string (Vpc Id)
Sort (string) or Sort (any) (Sort)
Default: "name:asc"
page
integer (Page) >= 1
Default: 1
items_per_page
integer (Items Per Page) [ 1 .. 100 ]
Default: 10
header Parameters
x-tenant-id
required
string (X-Tenant-Id)

Tenant id of the project

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "result": [
    ]
}

Create a new NAT Gateway resource

Create a new NAT (Network Address Translation) Gateway for a specified VPC and zone.

Authorizations:
OAuth2
header Parameters
x-tenant-id
required
string (X-Tenant-Id)

Tenant id of the project

Request Body schema: application/json
required
name
required
string (Name)
Description (string) or Description (any) (Description)
zone
required
string (Zone)
vpc_id
required
string (Vpc Id)

Responses

Request samples

Content type
application/json
{
  • "description": "Description",
  • "name": "NatGateway Name",
  • "vpc_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "zone": "a"
}

Response samples

Content type
application/json
{
  • "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "status": "pending"
}

Delete a NAT Gateway from a VPC

Delete a NAT (Network Address Translation) Gateway from a VPC.

Authorizations:
OAuth2
path Parameters
nat_gateway_id
required
string (Nat Gateway Id)
header Parameters
x-tenant-id
required
string (X-Tenant-Id)

Tenant id of the project

Responses

Response samples

Content type
application/json
null

Detail a NAT Gateway from a VPC

Detail a NAT (Network Address Translation) Gateway from a VPC.

Authorizations:
OAuth2
path Parameters
nat_gateway_id
required
string (Nat Gateway Id)
header Parameters
x-tenant-id
required
string (X-Tenant-Id)

Tenant id of the project

Responses

Response samples

Content type
application/json
{
  • "created_at": "YYYY-MM-DD HH:mm:SS",
  • "description": "NatGateway description",
  • "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "name": "NatGateway Name",
  • "nat_gateway_ip": "127.0.0.1",
  • "status": "created",
  • "updated": "YYYY-MM-DD HH:mm:SS",
  • "vpc_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "zone": "zone"
}