Skip to main content
POST
/
v1
/
regions
/
{region}
/
compute
/
addresses
Allocate address
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({subnetId: '<string>', type: 'static', ip: '<string>'})
};

fetch('https://api.example.com/v1/regions/{region}/compute/addresses', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "success": true,
  "data": {
    "id": "<string>",
    "ip": "<string>",
    "subnetId": "<string>",
    "type": "static",
    "status": "available",
    "assignedTo": "<string>",
    "createdAt": "2023-11-07T05:31:56Z"
  }
}

Path Parameters

region
string
required

Region identifier

Body

application/json
subnetId
string
required
type
enum<string>
required
Available options:
static,
dynamic,
floating
ip
string | null

Specific IP to allocate (optional)

Response

201 - application/json

Address allocated

success
enum<boolean>
Available options:
true
data
object

IP address allocation (IPAM)