Skip to content
StratumStratum Docs

List the project's FIP CIDR carve-outs.

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

Returns the project’s per-region FIP CIDR carve-out(s). The carve is the exhaustive source of the project’s floating IPs and the CIDR-bounded quota ceiling. Gates on the network:GetProjectFipPool Cedar action.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
projectId
required
string
/^p-[a-z0-9-]+$/

Responses

Section titled “Responses”

200

Section titled “200”

The project’s carve-outs.

Media typeapplication/json

Complete: returns every floating-IP pool carved for this project.

This list is bounded by the install’s own configuration rather than by tenant activity, so it is not paginated and carries no nextPageToken. A client has the whole set in one response.

object
items
required
Array<object>

per-project FIP CIDR carve-out cut from a meta-pool — the exhaustive source of the project’s floating IPs.

object
id
required
string
/^pfip-[a-z0-9-]+$/
projectId
required
string
metaPoolId
required
string
/^metafip-[a-z0-9-]+$/
region
required
string
cidr
required

The project’s exhaustive FIP CIDR carve-out.

string
state
required
string
Allowed values: active draining
createdAt
required
string format: date-time
createdBy
string

Example 

{
  "items": [
    {
      "cidr": "198.51.100.0/24",
      "state": "active"
    }
  ]
}

403

Section titled “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"
    }
  ]
}