Next free CIDR block(s) inside a supernet (IPAM planner).
curl --request GET \ --url 'https://stratum.example.com/v1/admin/network/address-map/next-cidr?supernet=example&size=1' \ --header 'Authorization: Bearer <token>'Given a supernet you want to carve VPCs from and a target
block size (prefix length), returns the first count blocks of that
size that overlap nothing in the live address map (reserved infra,
transit, VPC primary/secondary, subnets, floating-IP pools/IPs). A
planning aid: it reserves nothing, so the VPC-create call remains the
point of record and re-validates overlap. IPv4 supernets only.
Install-scope; gates on network:GetAddressMap.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”The IPv4 supernet to carve from, e.g. 10.0.0.0/8.
Target block prefix length (e.g. 24 or /24); must fit inside the supernet.
How many free blocks to return (default 1, capped at 256).
Narrow the claimed set to one region.
Responses
Section titled “Responses”The next free block(s).
IPAM planner result — free block(s) inside a supernet.
object
The canonicalized supernet the blocks were carved from.
The requested block prefix length.
Up to count free CIDR blocks, in ascending address order.
True when the supernet’s end (or the internal scan cap) was reached before count free blocks were found — the answer may be incomplete or the supernet may simply be full.
Example generated
{ "supernet": "example", "prefixLen": 1, "candidates": [ "example" ], "exhausted": true}Bad request.
object
The findings of a rejected IAM policy document (custom and resource policies).
One finding of a rejected IAM policy document. A rejection lists every finding, so the author fixes the document in one round trip.
object
The finding, e.g. INVALID_DOCUMENT, UNKNOWN_ACTION, ACTION_NOT_APPLICABLE.
Index of the statement at fault; -1 for the document as a whole.
The offending action, where one is at fault (ACTION_NOT_APPLICABLE).
Field errors, for codes that carry them: each problem at its field
(see FieldError). Documented on the responses that set it, e.g.
approveNodeJoin’s INVALID_INPUT and JOIN_APPROVAL_REFUSED.
Absent otherwise.
One field’s problem, the stage-2 installer API’s shape.
field is the field’s path, message what is wrong with it.
object
The field’s path, e.g. links[0].interface, disks[1].confirm,
mgmt.address or role; empty for the whole request.
Structured facts about the refusal, for codes that carry them. The
shape is fixed per code and documented on the response that answers
it, e.g. IMAGE_POOL_MISMATCH (see ImagePoolMismatchDetails) and
IMAGE_IN_USE. Absent for codes that carry none.
object
Example
{ "issues": [ { "code": "ACTION_NOT_APPLICABLE", "action": "compute:CreateVpc" } ]}Authenticated but not authorized.
object
The findings of a rejected IAM policy document (custom and resource policies).
One finding of a rejected IAM policy document. A rejection lists every finding, so the author fixes the document in one round trip.
object
The finding, e.g. INVALID_DOCUMENT, UNKNOWN_ACTION, ACTION_NOT_APPLICABLE.
Index of the statement at fault; -1 for the document as a whole.
The offending action, where one is at fault (ACTION_NOT_APPLICABLE).
Field errors, for codes that carry them: each problem at its field
(see FieldError). Documented on the responses that set it, e.g.
approveNodeJoin’s INVALID_INPUT and JOIN_APPROVAL_REFUSED.
Absent otherwise.
One field’s problem, the stage-2 installer API’s shape.
field is the field’s path, message what is wrong with it.
object
The field’s path, e.g. links[0].interface, disks[1].confirm,
mgmt.address or role; empty for the whole request.
Structured facts about the refusal, for codes that carry them. The
shape is fixed per code and documented on the response that answers
it, e.g. IMAGE_POOL_MISMATCH (see ImagePoolMismatchDetails) and
IMAGE_IN_USE. Absent for codes that carry none.
object
Example
{ "issues": [ { "code": "ACTION_NOT_APPLICABLE", "action": "compute:CreateVpc" } ]}