IP addresses

Reserve IP address

POST/v1/networking/ip-blocks/{id}/addresses/{address}/reserve

Reserves a free address of the IP block so nothing else takes it.

curl --request POST \
  --url https://api.serverside.com/v1/networking/ip-blocks/{id}/addresses/{address}/reserve \
  --header 'Authorization: Bearer <api-key>'

{
  "success": true,
  "data": {
    "address": "203.0.113.10",
    "rdns": "<string>",
    "state": "FREE",
    "serviceAssignments": [
      {
        "serviceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      }
    ]
  }
}

Autorisierung

Authorizationstringheadererforderlich
Organization API key (org_...), created in the cloud console at https://cloud.serverside.com and shown once, sent as Authorization: Bearer <key>. It authenticates as the organization.

Erforderliche Berechtigung: organization.networking.addresses.manage

Pfadparameter

idstring<uuid>erforderlich
addressstringerforderlich

Antwort

200 · application/json

OK

successbooleanerforderlich
Zulässige Werte:true
dataobject | nullerforderlich