Skip to main content

Reserve a LoadBalancer IP

Reserves a new public IP for the cluster's LoadBalancer IP pool. The reserved IP can then be attached to a cluster node (see Attach LB IP). The request body is empty. The number of IPs a customer may reserve is capped (customer_max_limit). Use the cluster service_id.

POST/api/v1/reserve_ips/k8s_ip/{service_id}/

Path parameters

  • service_idPathintegerrequired

    The cluster service_id, as returned by List.

    • required
    • must be a valid cluster service ID
    example12345

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
    • non-empty string
    example{{api_key}}
  • locationQuerystringrequired

    Region of the cluster.

    • required
    • must be a valid region name (e.g., Delhi, Chennai)
    example{{location}}

Request body

application/json

object

Reserving an IP takes an empty request body.

Responses

200Successful response
object
codeinteger
example200
dataobject
errorsobject
messagestring
exampleIP Reserved Successfully.
is_limit_availableboolean
exampletrue
reserved_ip_detailsobject
reserve_ip_pricestring
exampleINR 199.0 (excluding GST)
currencystring
exampleINR