ipam_prefixes_available-ips_read

v1.0.0

A convenience method for returning available IP addresses within a prefix. By default, the number of IPs returned will be equivalent to PAGINATE_COUNT. An arbitrary limit (up to MAX_PAGE_SIZE, if set) may be passed, however results will not be paginated.

The advisory lock decorator uses a PostgreSQL advisory lock to prevent this API from being invoked in parallel, which results in a race condition where multiple insertions can occur.

Output

{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "address": {
        "type": "string"
      },
      "family": {
        "type": "integer"
      },
      "vrf": {
        "type": "object",
        "required": [
          "name"
        ],
        "properties": {
          "id": {
            "type": "integer"
          },
          "name": {
            "type": "string"
          },
          "prefix_count": {
            "type": "integer"
          },
          "rd": {
            "type": "string",
            "description": "Unique route distinguisher (as defined in RFC 4364)"
          },
          "url": {
            "type": "string",
            "format": "uri"
          }
        }
      }
    }
  }
}