NodeRings Docs

List Prefixes

GET
/v1/ipam/prefixes
Authorization<token>

Bearer token

In: header

X-Organization-ID<token>

Tenant or organization identifier

In: header

Query Parameters

page?integer
Formatint32
pageSize?integer
Formatint32
filterNetworkId?string

Response Body

application/json

curl -X GET "https://api.nrings.io/v1/ipam/prefixes?page&pageSize&filterNetworkId" \  -H "Authorization: Bearer {your_token}" \  -H "X-Organization-ID: {your_org_id}"
{
  "prefixes": [
    {
      "id": "string",
      "cidr": "string",
      "gateway": "string",
      "reservedIps": [
        "string"
      ],
      "allocationStrategy": "ALLOCATION_STRATEGY_UNSPECIFIED",
      "description": "string",
      "networkId": "string",
      "organizationId": "string",
      "metadata": {},
      "timestamps": {
        "createTime": "2019-08-24T14:15:22Z",
        "updateTime": "2019-08-24T14:15:22Z"
      },
      "vmAssignmentPrefixLength": 0,
      "reservedPrefixes": [
        "string"
      ]
    }
  ],
  "total": 0
}