Skip to content
StratumStratum Docs

Describe a VPC.

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

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

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

Responses

Section titled “Responses”

200

Section titled “200”

The VPC.

Media typeapplication/json
object
ownedBy

Set on a platform-owned row; absent on a tenant’s own.

object
kind
required
string
Allowed values: auto-scaling-group platform
id
required

The owner: the Auto Scaling group id, or for platform the component (front-door, pack:platform-health, default-network, operator-recipe).

string
arn

Canonical Stratum ARN for this VPC, for resource-policy targeting.

string
id
required
string
/^vpc-[a-z0-9-]+$/
projectId
required
string
/^p-[a-z0-9-]+$/
name
required
string
/^[a-z][a-z0-9-]{1,38}[a-z0-9]$/
displayName
required
string
>= 1 characters <= 100 characters
description
string
cidrBlock
required

RFC 1918 CIDR block; /16 to /28; immutable.

string
secondaryCidrBlocks

Additional IPv4 CIDR blocks associated with the VPC. Subnets may carve from the primary or any secondary block. Managed via the /actions/associate-cidr-block + /actions/disassociate-cidr-block endpoints.

Array<string>
dhcpOptionsId

Associated DHCP option set; empty means the built-in defaults. Managed via /actions/associate-dhcp-options.

string
region
required
string
/^[a-z][a-z0-9]+(-[a-z0-9]+)*$/
internetGateway
required

When true, the VPC’s logical router gets an external port + default 0.0.0.0/0 route to the upstream and a transit IP allocated from the FIP pool. Inbound reachability requires a floating IP attached to a NIC. Outbound differs from AWS. Stratum at v1 also installs an implicit-SNAT rule on the LR (source = the VPC CIDR, snat-to = the transit IP), so every VM in the VPC reaches the internet whether or not it has a floating IP — AWS would require a NAT Gateway for that. documents the delta + the 2.0 plan to restore AWS-strict semantics via the explicit NATGateway resource. Operators building isolation on “no FIP = no internet” must keep this flag false.

boolean
dnsHostnames
required
boolean
dnsResolution
required
boolean
state
required
string
Allowed values: creating available deleting deleted error
transitIp

Per-VPC transit-network IP allocated by the lifecycle worker when the OVN external LRP is wired. Empty means the LRP isn’t wired yet (desired but not yet converged) or the VPC has no IGW.

string
tags

AWS-shape resource tags. Freeform UTF-8 keys (1-128 bytes, no leading/trailing whitespace) mapped to freeform UTF-8 values (0-256 bytes). Max 50 tags per resource. Reserved prefixes (stratum.dev/, stratum.platform_health., stratum:, aws:) return 400 RESERVED_NAMESPACE on customer input. PATCH replaces the whole map..

object
<= 50 properties
key
additional properties
string
<= 256 characters
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
deletedAt
string format: date-time
nullable
createdBy
required
string
resolverAddresses

The VPC resolver’s address on each available subnet, ordered by subnet id. Empty when no resolver answers in this VPC: DNS resolution is off, or the install runs no per-VPC resolver.

Array<object>

The VPC resolver’s address on one subnet: the subnet’s .3, which DHCP hands instances as their DNS server and which forwards to the VPC’s recursor.

object
subnetId
required
string
/^subnet-[a-z0-9-]+$/
address
required

The subnet’s .3.

string

Example 

{
  "ownedBy": {
    "kind": "auto-scaling-group"
  },
  "cidrBlock": "10.0.0.0/16",
  "state": "creating",
  "resolverAddresses": [
    {
      "address": "10.0.1.3"
    }
  ]
}

404

Section titled “404”

Resource not found.

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