Network

• ports
  • getDetails of a Port list
  • delDelete Port
  • getPort Details
  • postAttach Security Group
  • postDetach Security Group
• public_ips
  • getTenant's public IP list
  • delDelete Public IP
  • getPublic IP Details
  • postAttach Public IP
  • postDetach Public IP
• rules
  • delDelete a Rule
  • getRule Details
• security_groups
  • getList Security Groups by Tenant
  • postCreate Security Group
  • delDelete a security group
  • getSecurity Group Details
  • getList Rules
  • postCreate Rule
• subnetpools
  • getList Subnet Pools by Tenant
  • postCreate a Subnet Pool in a tenant
  • delDelete Subnet Pool by ID
  • getGet Subnet Pool by ID
  • postBook Subnetpool
  • postUnbook Subnetpool
• subnets
  • delDelete a Subnet
  • getSubnet Details
  • patchUpdate Subnet
• vpcs
  • postV1 Create VPC
  • getList VPC
  • postCreate VPC
  • delDelete VPC
  • getVPC Details
  • getList Ports
  • postCreate Port
  • getList Public IPs
  • postCreate Public IP
  • getList Security Groups
  • postCreate Security Group
  • getList Subnets
  • postCreate Subnet
  • postV1 Create VPC

API docs by Redocly

VPC API Product (1.137.1)

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

Server for br-ne-1 region

https://api.magalu.cloud/br-ne-1/network/v0/ports

Server for br-se-1 region

https://api.magalu.cloud/br-se-1/network/v0/ports

Response samples

• 200
• 422

Content type

application/json

[

• {

  • "created_at": "2022-01-01 00:00:00",
  • "description": "port description",
  • "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  • "ip_address": [

    • {

      • "ip_address": "172.20.0.2",
      • "subnet_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

      }

    ],
  • "is_admin_state_up": true,
  • "is_port_security_enabled": true,
  • "name": "port_name",
  • "public_ip": [

    • {

      • "public_ip": "100.94.5.31",
      • "public_ip_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

      }

    ],
  • "security_groups": [

    • "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

    ],
  • "updated": "2022-01-01 00:00:00",
  • "vpc_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

  }

]

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

Server for br-ne-1 region

https://api.magalu.cloud/br-ne-1/network/v0/ports/{port_id}

Server for br-se-1 region

https://api.magalu.cloud/br-se-1/network/v0/ports/{port_id}

Response samples

• 422

Content type

application/json

{

• "detail": [

  • {

    • "loc": [

      • "string"

      ],
    • "msg": "string",
    • "type": "string"

    }

  ]

}

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

Server for br-ne-1 region

https://api.magalu.cloud/br-ne-1/network/v0/ports/{port_id}

Server for br-se-1 region

https://api.magalu.cloud/br-se-1/network/v0/ports/{port_id}

Response samples

• 200
• 422

Content type

application/json

{

• "created_at": "2022-01-01 00:00:00",
• "description": "port description",
• "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
• "ip_address": [

  • {

    • "ip_address": "172.20.0.2",
    • "subnet_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

    }

  ],
• "is_admin_state_up": true,
• "is_port_security_enabled": true,
• "name": "port_name",
• "public_ip": [

  • {

    • "public_ip": "100.94.5.31",
    • "public_ip_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

    }

  ],
• "security_groups": [

  • "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

  ],
• "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

string (X-Tenant-Id) Tenant id of the project

Responses

Server for br-ne-1 region

https://api.magalu.cloud/br-ne-1/network/v0/ports/{port_id}/attach/{security_group_id}

Server for br-se-1 region

https://api.magalu.cloud/br-se-1/network/v0/ports/{port_id}/attach/{security_group_id}

Response samples

• 200
• 422

Content type

application/json

null

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

string (X-Tenant-Id) Tenant id of the project

Responses

Server for br-ne-1 region

https://api.magalu.cloud/br-ne-1/network/v0/ports/{port_id}/detach/{security_group_id}

Server for br-se-1 region

https://api.magalu.cloud/br-se-1/network/v0/ports/{port_id}/detach/{security_group_id}

Response samples

• 200
• 422

Content type

application/json

null

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

Server for br-ne-1 region

https://api.magalu.cloud/br-ne-1/network/v0/public_ips

Server for br-se-1 region

https://api.magalu.cloud/br-se-1/network/v0/public_ips

Response samples

• 200
• 422

Content type

application/json

{

• "public_ips": [

  • {

    • "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_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    • "public_ip": "100.94.5.31",
    • "status": "created",
    • "updated": "2022-01-01 00:00:00",
    • "vpc_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

    }

  ]

}

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

Server for br-ne-1 region

https://api.magalu.cloud/br-ne-1/network/v0/public_ips/{public_ip_id}

Server for br-se-1 region

https://api.magalu.cloud/br-se-1/network/v0/public_ips/{public_ip_id}

Response samples

• 422

Content type

application/json

{

• "detail": [

  • {

    • "loc": [

      • "string"

      ],
    • "msg": "string",
    • "type": "string"

    }

  ]

}

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

Server for br-ne-1 region

https://api.magalu.cloud/br-ne-1/network/v0/public_ips/{public_ip_id}

Server for br-se-1 region

https://api.magalu.cloud/br-se-1/network/v0/public_ips/{public_ip_id}

Response samples

• 200
• 422

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",
• "public_ip": "100.94.5.31",
• "status": "created",
• "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

Server for br-ne-1 region

https://api.magalu.cloud/br-ne-1/network/v0/public_ips/{public_ip_id}/attach/{port_id}

Server for br-se-1 region

https://api.magalu.cloud/br-se-1/network/v0/public_ips/{public_ip_id}/attach/{port_id}

Response samples

• 200
• 422

Content type

application/json

null

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

Server for br-ne-1 region

https://api.magalu.cloud/br-ne-1/network/v0/public_ips/{public_ip_id}/detach/{port_id}

Server for br-se-1 region

https://api.magalu.cloud/br-se-1/network/v0/public_ips/{public_ip_id}/detach/{port_id}

Response samples

• 200
• 422

Content type

application/json

null

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

Server for br-ne-1 region

https://api.magalu.cloud/br-ne-1/network/v0/rules/{rule_id}

Server for br-se-1 region

https://api.magalu.cloud/br-se-1/network/v0/rules/{rule_id}

Response samples

• 422

Content type

application/json

{

• "detail": [

  • {

    • "loc": [

      • "string"

      ],
    • "msg": "string",
    • "type": "string"

    }

  ]

}

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

Server for br-ne-1 region

https://api.magalu.cloud/br-ne-1/network/v0/rules/{rule_id}

Server for br-se-1 region

https://api.magalu.cloud/br-se-1/network/v0/rules/{rule_id}

Response samples

• 200
• 422

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_group_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
• "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

Server for br-ne-1 region

https://api.magalu.cloud/br-ne-1/network/v0/security_groups

Server for br-se-1 region

https://api.magalu.cloud/br-se-1/network/v0/security_groups

Response samples

• 200
• 422

Content type

application/json

{

• "security_groups": [

  • {

    • "created_at": "2022-01-01 00:00:00",
    • "description": "security group description",
    • "error": "null",
    • "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    • "is_default": true,
    • "name": "security_group_name",
    • "project_type": "default",
    • "status": "created",
    • "tenant_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    • "updated": "2022-01-01 00:00:00",
    • "vpc_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

    }

  ]

}

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

	Description (string) or Description (any) (Description) Default: ""
required	Name (string) or Name (any) (Name)

Responses

Server for br-ne-1 region

https://api.magalu.cloud/br-ne-1/network/v0/security_groups

Server for br-se-1 region

https://api.magalu.cloud/br-se-1/network/v0/security_groups

Request samples

• Payload

Content type

application/json

{

• "description": "security group description",
• "name": "security_group_name"

}

Response samples

• 200
• 422

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

Server for br-ne-1 region

https://api.magalu.cloud/br-ne-1/network/v0/security_groups/{security_group_id}

Server for br-se-1 region

https://api.magalu.cloud/br-se-1/network/v0/security_groups/{security_group_id}

Response samples

• 422

Content type

application/json

{

• "detail": [

  • {

    • "loc": [

      • "string"

      ],
    • "msg": "string",
    • "type": "string"

    }

  ]

}

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

Server for br-ne-1 region

https://api.magalu.cloud/br-ne-1/network/v0/security_groups/{security_group_id}

Server for br-se-1 region

https://api.magalu.cloud/br-se-1/network/v0/security_groups/{security_group_id}

Response samples

• 200
• 422

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",
• "project_type": "default",
• "rules": [

  • {

    • "created_at": "2022-01-01 00:00:00",
    • "direction": "egress",
    • "error": "null",
    • "ethertype": "IPv4",
    • "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    • "port_range_max": 8028,
    • "port_range_min": 8028,
    • "protocol": "tcp",
    • "remote_group_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    • "remote_ip_prefix": "100.94.0.0/24",
    • "security_group_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    • "status": "created"

    }

  ],
• "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

Server for br-ne-1 region

https://api.magalu.cloud/br-ne-1/network/v0/security_groups/{security_group_id}/rules

Server for br-se-1 region

https://api.magalu.cloud/br-se-1/network/v0/security_groups/{security_group_id}/rules

Response samples

• 200
• 422

Content type

application/json

{

• "rules": [

  • {

    • "created_at": "2022-01-01 00:00:00",
    • "direction": "egress",
    • "ethertype": "IPv4",
    • "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    • "port_range_max": 8028,
    • "port_range_min": 8028,
    • "protocol": "tcp",
    • "remote_group_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    • "remote_ip_prefix": "100.94.0.0/24",
    • "security_group_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    • "status": "created"

    }

  ]

}

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

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

Responses

Server for br-ne-1 region

https://api.magalu.cloud/br-ne-1/network/v0/security_groups/{security_group_id}/rules

Server for br-se-1 region

https://api.magalu.cloud/br-se-1/network/v0/security_groups/{security_group_id}/rules

Request samples

• Payload

Content type

application/json

{

• "description": "Some rule description",
• "direction": "egress",
• "ethertype": "IPv4",
• "port_range_max": 8028,
• "port_range_min": 8028,
• "protocol": "tcp",
• "remote_group_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
• "remote_ip_prefix": "100.94.0.0/24"

}

Response samples

• 200
• 422

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:asc - created_at:asc _sort=created_at:desc - created_at:desc Name of the field wich the list must be ordered by ending with :asc or :desc

header Parameters

x-tenant-id required

any (X-Tenant-Id) Tenant id of the project

Responses

Server for br-ne-1 region

https://api.magalu.cloud/br-ne-1/network/v0/subnetpools

Server for br-se-1 region

https://api.magalu.cloud/br-se-1/network/v0/subnetpools

Response samples

• 200
• 422

Content type

application/json

{

• "meta": {

  • "links": {

    • "next": "?_offset=30&_limit=10",
    • "previous": "?_offset=10&_limit=10",
    • "self": "?_offset=30&_limit=10"

    },
  • "page": {

    • "count": 10,
    • "limit": 10,
    • "offset": 20,
    • "total": 112

    }

  },
• "results": [

  • {

    • "cidr": "172.20.0.0/16",
    • "description": "subnet pool description",
    • "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    • "name": "subnet_pool_name",
    • "tenant_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

    }

  ]

}

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.
description required	string (Description) The description for the subnet pool
name required	string (Name) The name of the subnet pool.
type	string (Type) ^(pip|default)$ Default: "default" The type of subnetpool, pip or default.

Responses

Server for br-ne-1 region

https://api.magalu.cloud/br-ne-1/network/v0/subnetpools

Server for br-se-1 region

https://api.magalu.cloud/br-se-1/network/v0/subnetpools

Request samples

• Payload

Content type

application/json

{

• "cidr": "172.26.0.0/16",
• "description": "some description",
• "name": "some_subnet_pool"

}

Response samples

• 201
• 422

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

Server for br-ne-1 region

https://api.magalu.cloud/br-ne-1/network/v0/subnetpools/{subnetpool_id}

Server for br-se-1 region

https://api.magalu.cloud/br-se-1/network/v0/subnetpools/{subnetpool_id}

Response samples

• 422

Content type

application/json

{

• "detail": [

  • {

    • "loc": [

      • "string"

      ],
    • "msg": "string",
    • "type": "string"

    }

  ]

}

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

Server for br-ne-1 region

https://api.magalu.cloud/br-ne-1/network/v0/subnetpools/{subnetpool_id}

Server for br-se-1 region

https://api.magalu.cloud/br-se-1/network/v0/subnetpools/{subnetpool_id}

Response samples

• 200
• 422

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,
• "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

Server for br-ne-1 region

https://api.magalu.cloud/br-ne-1/network/v0/subnetpools/{subnetpool_id}/book_cidr

Server for br-se-1 region

https://api.magalu.cloud/br-se-1/network/v0/subnetpools/{subnetpool_id}/book_cidr

Request samples

• Payload

Content type

application/json

Example

Example with CIDRExample with MaskExample with CIDR

{

• "cidr": "172.26.0.0/16"

}

Response samples

• 201
• 422

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

Server for br-ne-1 region

https://api.magalu.cloud/br-ne-1/network/v0/subnetpools/{subnetpool_id}/unbook_cidr

Server for br-se-1 region

https://api.magalu.cloud/br-se-1/network/v0/subnetpools/{subnetpool_id}/unbook_cidr

Request samples

• Payload

Content type

application/json

{

• "cidr": "172.26.0.0/16"

}

Response samples

• 422

Content type

application/json

{

• "detail": [

  • {

    • "loc": [

      • "string"

      ],
    • "msg": "string",
    • "type": "string"

    }

  ]

}

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

Server for br-ne-1 region

https://api.magalu.cloud/br-ne-1/network/v0/subnets/{subnet_id}

Server for br-se-1 region

https://api.magalu.cloud/br-se-1/network/v0/subnets/{subnet_id}

Response samples

• 422

Content type

application/json

{

• "detail": [

  • {

    • "loc": [

      • "string"

      ],
    • "msg": "string",
    • "type": "string"

    }

  ]

}

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

Server for br-ne-1 region

https://api.magalu.cloud/br-ne-1/network/v0/subnets/{subnet_id}

Server for br-se-1 region

https://api.magalu.cloud/br-se-1/network/v0/subnets/{subnet_id}

Response samples

• 200
• 422

Content type

application/json

{

• "cidr_block": "172.20.0.0/24",
• "created_at": "2022-01-01 00:00:00",
• "description": "vpc description",
• "dhcp_pools": [

  • {

    • "end": "172.50.0.254",
    • "start": "172.50.0.2"

    }

  ],
• "dns_nameservers": [

  • "8.8.8.8"

  ],
• "gateway_ip": "172.50.0.1",
• "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
• "ip_version": "4",
• "name": "vpc_name",
• "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

string (Subnet Id)

header Parameters

x-tenant-id required

string (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

Server for br-ne-1 region

https://api.magalu.cloud/br-ne-1/network/v0/subnets/{subnet_id}

Server for br-se-1 region

https://api.magalu.cloud/br-se-1/network/v0/subnets/{subnet_id}

Request samples

• Payload

Content type

application/json

{

• "dns_nameservers": [

  • "8.8.8.8"

  ]

}

Response samples

• 200
• 422

Content type

application/json

{

• "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

}

vpcs

Operations related to VPCs

V1 Create VPC

V1 Create a VPC

Authorizations:

OAuth2

header Parameters

x-tenant-id required

string (X-Tenant-Id) Tenant id of the project

Request Body schema: application/json

required

	Description (string) or Description (any) (Description)
name required	string (Name)

Responses

Server for br-ne-1 region

https://api.magalu.cloud/br-ne-1/network/latest/vpcs

Server for br-se-1 region

https://api.magalu.cloud/br-se-1/network/latest/vpcs

Request samples

• Payload

Content type

application/json

{

• "description": "Description",
• "name": "VPC Name"

}

Response samples

• 202
• 400
• 409
• 422
• 500
• 504

Content type

application/json

{

• "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
• "status": "pending"

}

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

Server for br-ne-1 region

https://api.magalu.cloud/br-ne-1/network/v0/vpcs

Server for br-se-1 region

https://api.magalu.cloud/br-se-1/network/v0/vpcs

Response samples

• 200
• 422

Content type

application/json

{

• "vpcs": [

  • {

    • "created_at": "2022-01-01 00:00:00",
    • "description": "DESCRIPTION",
    • "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": [

      • "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

      ],
    • "subnets": [

      • "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

      ],
    • "tenant_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    • "updated": "2022-01-01 00:00:00"

    }

  ]

}

Create VPC

Create a VPC

Authorizations:

OAuth2

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)
name required	string (Name)

Responses

Server for br-ne-1 region

https://api.magalu.cloud/br-ne-1/network/v0/vpcs

Server for br-se-1 region

https://api.magalu.cloud/br-se-1/network/v0/vpcs

Request samples

• Payload

Content type

application/json

{

• "description": "Description",
• "name": "vpc_name"

}

Response samples

• 200
• 422

Content type

application/json

{

• "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

}

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

Server for br-ne-1 region

https://api.magalu.cloud/br-ne-1/network/v0/vpcs/{vpc_id}

Server for br-se-1 region

https://api.magalu.cloud/br-se-1/network/v0/vpcs/{vpc_id}

Response samples

• 422

Content type

application/json

{

• "detail": [

  • {

    • "loc": [

      • "string"

      ],
    • "msg": "string",
    • "type": "string"

    }

  ]

}

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

Server for br-ne-1 region

https://api.magalu.cloud/br-ne-1/network/v0/vpcs/{vpc_id}

Server for br-se-1 region

https://api.magalu.cloud/br-se-1/network/v0/vpcs/{vpc_id}

Response samples

• 200
• 422

Content type

application/json

{

• "created_at": "2022-01-01 00:00:00",
• "description": "DESCRIPTION",
• "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": [

  • "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

  ],
• "subnets": [

  • "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

  ],
• "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
_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

Server for br-ne-1 region

https://api.magalu.cloud/br-ne-1/network/v0/vpcs/{vpc_id}/ports

Server for br-se-1 region

https://api.magalu.cloud/br-se-1/network/v0/vpcs/{vpc_id}/ports

Response samples

• 200
• 422

Content type

application/json

Example

PortsListSimplifiedPortsListPortsListSimplified

{

• "ports_simplified": [

  • {

    • "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    • "ip_address": [

      • {

        • "ip_address": "172.20.0.2",
        • "subnet_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

        }

      ]

    }

  ]

}

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

	Has Pip (boolean) or Has Pip (any) (Has Pip) Default: true
	Has Sg (boolean) or Has Sg (any) (Has Sg) Default: true
name required	string (Name) [ 5 .. 100 ] characters
	Array of Security Groups Id (strings) or Security Groups Id (any) (Security Groups Id) Default: []
	Array of Subnets (strings) or Subnets (any) (Subnets) Default: []

Responses

Server for br-ne-1 region

https://api.magalu.cloud/br-ne-1/network/v0/vpcs/{vpc_id}/ports

Server for br-se-1 region

https://api.magalu.cloud/br-se-1/network/v0/vpcs/{vpc_id}/ports

Request samples

• Payload

Content type

application/json

{

• "has_pip": true,
• "has_sg": true,
• "name": "port_name",
• "security_groups_id": [

  • "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

  ],
• "subnets": [

  • "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

  ]

}

Response samples

• 200
• 422

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

Server for br-ne-1 region

https://api.magalu.cloud/br-ne-1/network/v0/vpcs/{vpc_id}/public_ips

Server for br-se-1 region

https://api.magalu.cloud/br-se-1/network/v0/vpcs/{vpc_id}/public_ips

Response samples

• 200
• 422

Content type

application/json

{

• "public_ips": [

  • {

    • "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_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    • "public_ip": "100.94.5.31",
    • "status": "created",
    • "updated": "2022-01-01 00:00:00",
    • "vpc_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

    }

  ]

}

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

Server for br-ne-1 region

https://api.magalu.cloud/br-ne-1/network/v0/vpcs/{vpc_id}/public_ips

Server for br-se-1 region

https://api.magalu.cloud/br-se-1/network/v0/vpcs/{vpc_id}/public_ips

Request samples

• Payload

Content type

application/json

{

• "description": "public_ip_description"

}

Response samples

• 200
• 422

Content type

application/json

{

• "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

}

List Security Groups

Returns a list of security groups for a provided vpc_id

Authorizations:

OAuth2

path Parameters

vpc_id required

any (Vpc ID) Id of the VPC to create the Security Group in

header Parameters

x-tenant-id required

any (X-Tenant-Id) Tenant id of the project

Responses

Server for br-ne-1 region

https://api.magalu.cloud/br-ne-1/network/v0/vpcs/{vpc_id}/security_groups

Server for br-se-1 region

https://api.magalu.cloud/br-se-1/network/v0/vpcs/{vpc_id}/security_groups

Response samples

• 200
• 422

Content type

application/json

{

• "security_groups": [

  • {

    • "created_at": "2022-01-01 00:00:00",
    • "description": "security group description",
    • "error": "null",
    • "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    • "is_default": true,
    • "name": "security_group_name",
    • "project_type": "default",
    • "status": "created",
    • "tenant_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    • "updated": "2022-01-01 00:00:00",
    • "vpc_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

    }

  ]

}

Create Security Group Deprecated

Create a Security Group

Authorizations:

OAuth2

path Parameters

required

VPC Id (string) or VPC Id (any) (VPC Id) Id of the vpc to create the security group in

query Parameters

	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)
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

	Description (string) or Description (any) (Description) Default: ""
required	Name (string) or Name (any) (Name)

Responses

Server for br-ne-1 region

https://api.magalu.cloud/br-ne-1/network/v0/vpcs/{vpc_id}/security_groups

Server for br-se-1 region

https://api.magalu.cloud/br-se-1/network/v0/vpcs/{vpc_id}/security_groups

Request samples

• Payload

Content type

application/json

{

• "description": "security group description",
• "name": "security_group_name"

}

Response samples

• 200
• 422

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

Server for br-ne-1 region

https://api.magalu.cloud/br-ne-1/network/v0/vpcs/{vpc_id}/subnets

Server for br-se-1 region

https://api.magalu.cloud/br-se-1/network/v0/vpcs/{vpc_id}/subnets

Response samples

• 200
• 422

Content type

application/json

{

• "subnets": [

  • {

    • "cidr_block": "172.20.0.0/24",
    • "created_at": "2022-01-01 00:00:00",
    • "description": "vpc description",
    • "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    • "ip_version": "4",
    • "name": "vpc_name",
    • "updated": "2022-01-01 00:00:00",
    • "vpc_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    • "zone": "a"

    }

  ]

}

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

cidr_block required	string (Cidr Block)
	Description (string) or Description (any) (Description)
dns_nameservers	Array of strings <ipvanyaddress> (Dns Nameservers) [ items <ipvanyaddress > ] Default: []
ip_version required	integer (Ip Version)
name required	string (Name)
subnetpool_id required	string (Subnetpool Id)

Responses

Server for br-ne-1 region

https://api.magalu.cloud/br-ne-1/network/v0/vpcs/{vpc_id}/subnets

Server for br-se-1 region

https://api.magalu.cloud/br-se-1/network/v0/vpcs/{vpc_id}/subnets

Request samples

• Payload

Content type

application/json

Example

Example with CIDRExample with MaskExample with CIDR

{

• "cidr_block": "172.50.0.0/24",
• "description": "some_description",
• "dns_nameservers": [

  • "8.8.8.8"

  ],
• "ip_version": 4,
• "name": "subnet_name",
• "subnetpool_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

}

Response samples

• 201
• 422

Content type

application/json

{

• "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

}

V1 Create VPC

V1 Create a VPC

Authorizations:

OAuth2

header Parameters

x-tenant-id required

string (X-Tenant-Id) Tenant id of the project

Request Body schema: application/json

required

	Description (string) or Description (any) (Description)
name required	string (Name)

Responses

Server for br-ne-1 region

https://api.magalu.cloud/br-ne-1/network/v1/vpcs

Server for br-se-1 region

https://api.magalu.cloud/br-se-1/network/v1/vpcs

Request samples

• Payload

Content type

application/json

{

• "description": "Description",
• "name": "VPC Name"

}

Response samples

• 202
• 400
• 409
• 422
• 500
• 504

Content type

application/json

{

• "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
• "status": "pending"

}