NodeRings Docs

List Available IPs

GET
/v1/ipam/prefixes/{prefixId}/available-ips
Authorization<token>

Bearer token

In: header

X-Organization-ID<token>

Tenant or organization identifier

In: header

Path Parameters

prefixIdstring

Query Parameters

limit?integer

Limit number of IPs returned (default: 100)

Formatint32

Response Body

application/json

curl -X GET "https://api.nrings.io/v1/ipam/prefixes/{prefixId}/available-ips?limit" \  -H "Authorization: Bearer {your_token}" \  -H "X-Organization-ID: {your_org_id}"
{
  "availableIps": [
    "string"
  ],
  "totalIps": 0,
  "allocatedCount": 0,
  "reservedCount": 0,
  "availableCount": 0
}