Skip to main content

Attach Floating IPv4

PUT/api/v1/reserve_ips/floating-ip/attach/

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 for authenticating the request

    • required
    • must be a valid alphanumeric API key
    example{{api_key}}
  • locationQuerystringrequired

    Specifies the target location for attaching the floating IPv4 address.

    • Must be a non-empty string
    • Should match a supported location identifier (e.g., region code)
    example{{location}}

Request body

application/json

string

JSON payload to attach a floating IPv4 address to one or more nodes

example{ "ip_address": {{floating_ip}}, "node_ids": [ {{node_id}} ] }
  • must be a valid JSON string
  • requires "ip_address" field containing an IPv4 address
  • "node_ids" must be a non-empty array of node identifiers

Responses

200Successful response
object
codeinteger

HTTP status code indicating the result of the attach operation

example200
  • must be an integer
  • must be a valid HTTP status code (e.g., 200, 201, 400, 404, 500)
dataobject
errorsobject
messagestring

Human-readable status message indicating the result of the attach operation.

exampleFloating IP is attached successfully.
  • Must be a non-empty string
  • Typically concise (under 200 characters)