Skip to main content

Detach Public IP

POST/api/v1/reserve_ips/public_reserveip_actions/

Query parameters

  • project_idQuerystringoptional

    Identifier of the project to scope the request to. Optional; if omitted, the account's default project is used.

    • optional
    • if omitted, the request is applied to the default project
    example{{project_id}}
  • apikeyQuerystringoptional

    API key used to authorize the detach public IP request

    • required
    • non-empty string
    example{{base_url}}
  • locationQuerystringoptional

    E2E Myaccount region where the public IP is located

    • must be a valid E2E Myaccount region name (e.g., eastus, westus2)
    • cannot be empty
    example{{location}}

Request body

application/json

string

JSON-formatted string specifying the public IP to detach, the operation type, and the target VM ID

example{ "public_ip": {{public_ip}}, "type": "detach", "vm_id": {{vm_id}} }
  • must be valid JSON
  • must contain a "public_ip" field
  • must contain a "type" field set to "detach"
  • must contain a "vm_id" field

Responses

200Successful response
object
codeinteger

HTTP status code of the detach operation

example200
  • integer
  • value between 100 and 599
dataobject
errorsobject
messagestring

Status message indicating the result of the detach public IP operation.

exampleIP Detached Successfully.
  • Must be a non-empty string
  • Maximum length of 255 characters