Global network address map (IPAM view).

GET

/v1/admin/network/address-map

Code sample: Shell / cURL

curl --request GET \
  --url https://stratum.example.com/v1/admin/network/address-map \
  --header 'Authorization: Bearer <token>'

• A Stratum cluster endpoint.

An aggregated, operator-facing view of every CIDR and notable host address Stratum knows about: reserved infrastructure ranges (mgmt plane, cluster plane, CGNAT transit), the per-VPC transit supernet, VPC primary and secondary CIDRs, subnets, floating-IP pools (runtime, meta, per-project), and allocated floating IPs. Each entry is labeled with a kind, a human purpose, its owner (a projectId or infra), and cross-references. Use contains to answer “what claims this address?”. Install-scope; gates on network:GetAddressMap.

Authorizations

• bearerAuth

Parameters

Query Parameters

contains

string

An IP or CIDR; returns only entries whose CIDR overlaps it.

region

string

Narrow VPC/subnet/floating-IP entries to one region.

Responses

200

The aggregated address map.

Media typeapplication/json

object

entries

required

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 one of the underlying LIST queries hit the row ceiling, so the map may be incomplete (cursor pagination is a 2.0 follow-on).

boolean

Example

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

403

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"
    }
  ]
}