Skip to main content

Attach AddOn IPv4

POST/api/v1/reserve_ips/{addon_ip}/actions/

Path parameters

  • addon_ipPathstringrequired

    Path parameter addon_ip.

Query parameters

  • project_idQueryintegerrequired

    Identifier of the project to scope the request to. Required integer project ID.

    • required
    • must be a valid integer project ID
    example{{project_id}}
  • apikeyQuerystringrequired

    API key used to authenticate the request

    • required
    • must be a valid non-empty string
    example{{api_key}}
  • locationQuerystringrequired

    Specifies the target location for attaching the IPv4 add-on.

    • required
    • must be a non-empty string
    example{{location}}

Request body

application/json

string

JSON string with parameters to attach an IPv4 add-on to a VM

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

Responses

200Successful response
object
codeinteger

HTTP status code of the response

example200
  • integer between 100 and 599
  • non-negative
dataobject
errorsobject
messagestring

Status message indicating the result of the IPv4 attachment operation.

exampleIP assigned Successfully.
  • must be a non-empty string
  • maximum length of 255 characters