Skip to main content

List Reserved LoadBalancer IPs

Returns the reserved LoadBalancer IPs in the cluster's IP pool - each IP's ip_address, status (Available / Attached), reserve_id, the node it is attached to (if any), and reservation details. Also reports the customer's IP reservation limit and current count. Use the cluster service_id.

GET/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}}

Responses

200Successful response
object
codeinteger
example200
dataarray

Reserved LoadBalancer IPs.

errorsobject
messagestring
exampleSuccess
is_limit_availableboolean
exampletrue
reserved_ip_detailsobject