Skip to main content
PATCH
/
network
/
reserved_ips
/
{reserved_ip_id}
Update reserved IP (rename or attach/detach VM)
curl --request PATCH \
  --url https://api.cloud.onidel.com/network/reserved_ips/{reserved_ip_id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "team_id": "<string>",
  "name": "<string>",
  "anchor_ip": "<string>"
}'
{
  "name": "<string>"
}

Authorizations

Authorization
string
header
required

Provide the value as: Token <your-api-token>

Path Parameters

reserved_ip_id
string<uuid>
required

Reserved IP ID

Example:

"d3c0dc7b-6ca4-4b35-8f3c-a00adc3993d5"

Body

application/json
team_id
string

Team ID to verify ownership. If not provided, uses the user's primary team

name
string

New name for the reserved IP (set to empty string to use IP address as name)

Maximum length: 64
anchor_ip
string | null

Anchor IP to route to. Use null to detach the current VM.

Response

Successfully updated

  • Option 1
  • Option 2
name
string

Updated name (returned when renaming)