Skip to content

CIDRs a new VPC in this project must avoid (+ optional suggestion).

GET
/v1/projects/{projectId}/network/reserved-cidrs
Code sample: Shell / cURL
curl --request GET \
--url https://stratum.example.com/v1/projects/example/network/reserved-cidrs \
--header 'Authorization: Bearer <token>'

The project-scoped answer to “what must my new VPC CIDR avoid?”. Returns the globally reserved ranges (reserved infra, transit/CGNAT, FIP supernets) plus THIS project’s own VPC/subnet/FIP CIDRs — never other tenants’ details. With suggestSize it also returns a free block carved from supernet (default 10.0.0.0/8) that avoids the set. Unlike the install-scoped address map (network:GetAddressMap), this is gated on the project-scoped network:ListVPCs a VPC-creator already holds. Reserves nothing; VPC-create re-validates overlap.

projectId
required
string
/^p-[a-z0-9-]+$/
suggestSize
integer

When set (a prefix length, e.g. 24), also return a free block of that size.

supernet
string

IPv4 supernet to carve the suggestion from (default 10.0.0.0/8).

count
integer

How many free blocks to suggest (default 1, capped at 256).

The project-scoped avoid-set (+ optional suggestion).

Media typeapplication/json

project-scoped avoid-set: the reserved + own-project CIDRs a new VPC must not overlap, plus an optional carved suggestion.

object
projectId
required
string
reserved
required

Globally reserved ranges + this project’s own CIDRs to avoid.

Array<object>

One CIDR (or single host address as /32) in the global address map.

object
cidr
required

The CIDR; single host addresses are rendered as /32.

string
kind
required

What the entry is.

string
Allowed values: reserved-infra transit-cidr transit-ip vpc-cidr vpc-secondary-cidr subnet fip-pool meta-fip-pool project-fip-pool floating-ip
purpose
required

Human-readable description.

string
owner
required

A projectId, or infra for Stratum-owned ranges.

string
scope
required
string
Allowed values: global project
state

Lifecycle state where applicable.

string
region
string
refs

Cross-references (vpcId, subnetId, poolId, fipId,…).

object
key
additional properties
string
capacity

utilization roll-up, present only on entries with a countable address space (subnets + floating-IP pools). Absent on infra ranges and single-IP entries. Feeds the IPAM utilization bars.

object
total
required

Addresses in the CIDR / pool size.

integer
allocated
required

Addresses in use.

integer
free
required

Addresses still assignable.

integer
truncated
required

True when an underlying list hit the row ceiling (avoid-set may be incomplete).

boolean
suggestion

IPAM planner result — free block(s) inside a supernet.

object
supernet
required

The canonicalized supernet the blocks were carved from.

string
prefixLen
required

The requested block prefix length.

integer
candidates
required

Up to count free CIDR blocks, in ascending address order.

Array<string>
exhausted
required

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.

boolean

Example

{
"reserved": [
{
"kind": "reserved-infra",
"scope": "global"
}
]
}

Bad request.

Media typeapplication/problem+json
object
type
required
string format: uri
title
required
string
status
required
integer
>= 400 <= 599
detail
string
instance
string format: uri-reference
requestId
required
string
code
required
string
issues

The findings of a rejected IAM policy document (custom and resource policies).

Array<object>

One finding of a rejected IAM policy document. A rejection lists every finding, so the author fixes the document in one round trip.

object
code
required

The finding, e.g. INVALID_DOCUMENT, UNKNOWN_ACTION, ACTION_NOT_APPLICABLE.

string
statement
required

Index of the statement at fault; -1 for the document as a whole.

integer
>= -1
detail
required
string
action

The offending action, where one is at fault (ACTION_NOT_APPLICABLE).

string
errors

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.

Array<object>

One field’s problem, the stage-2 installer API’s shape. field is the field’s path, message what is wrong with it.

object
field
required

The field’s path, e.g. links[0].interface, disks[1].confirm, mgmt.address or role; empty for the whole request.

string
message
required
string
details

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
key
additional properties
any

Example

{
"issues": [
{
"code": "ACTION_NOT_APPLICABLE",
"action": "compute:CreateVpc"
}
]
}

Authenticated but not authorized.

Media typeapplication/problem+json
object
type
required
string format: uri
title
required
string
status
required
integer
>= 400 <= 599
detail
string
instance
string format: uri-reference
requestId
required
string
code
required
string
issues

The findings of a rejected IAM policy document (custom and resource policies).

Array<object>

One finding of a rejected IAM policy document. A rejection lists every finding, so the author fixes the document in one round trip.

object
code
required

The finding, e.g. INVALID_DOCUMENT, UNKNOWN_ACTION, ACTION_NOT_APPLICABLE.

string
statement
required

Index of the statement at fault; -1 for the document as a whole.

integer
>= -1
detail
required
string
action

The offending action, where one is at fault (ACTION_NOT_APPLICABLE).

string
errors

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.

Array<object>

One field’s problem, the stage-2 installer API’s shape. field is the field’s path, message what is wrong with it.

object
field
required

The field’s path, e.g. links[0].interface, disks[1].confirm, mgmt.address or role; empty for the whole request.

string
message
required
string
details

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
key
additional properties
any

Example

{
"issues": [
{
"code": "ACTION_NOT_APPLICABLE",
"action": "compute:CreateVpc"
}
]
}