IP addresses

Assign IP address

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

Assigns a free address of the IP block to a service attached to the block's network on the given segment.

curl --request POST \
  --url https://api.serverside.com/v1/networking/ip-blocks/{id}/addresses/{address}/assign \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "serviceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "segmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

{
  "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

Body

application/json

serviceIdstring<uuid>erforderlich
The service to assign the address to; it must be attached to the IP block's network.
segmentIdstring<uuid>erforderlich
The service's segment that the IP block's network is attached to.

Antwort

200 · application/json

OK

successbooleanerforderlich
Zulässige Werte:true
dataobject | nullerforderlich