Skip to main content

Detach IPv6

POST/api/v1/nodes/ipv6/

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 for authentication

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

    Identifier of the location for which IPv6 should be detached

    • must be a non-empty string
    • may contain only alphanumeric characters and hyphens
    example{{location}}

Request body

application/json

string

JSON-encoded request body for detaching an IPv6 address

example{ "node_id": {{vm_id}}, "action": "detach", "detach_ipv6": {{ipv6}}, "location": {{location}} }
  • must be a valid JSON string
  • must contain the keys node_id, action, detach_ipv6, and location
  • action value must be "detach"

Responses

200Successful response
object
codeinteger

HTTP status code of the detach IPv6 operation

example200
  • integer between 100 and 599
dataobject
errorsobject
messagestring

Status message indicating the result of the detach IPv6 operation.

exampleIPv6 detached successfully from the compute node.
  • must be a non-empty string
  • typically short, e.g., under 100 characters