Skip to content
StratumStratum Docs

Describe a subnet.

GET
/v1/projects/{projectId}/network/subnets/{subnetId}
Code sample: Shell / cURL
curl --request GET \
  --url https://stratum.example.com/v1/projects/example/network/subnets/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-]+$/
subnetId
required
string
/^subnet-[a-z0-9-]+$/

Responses

Section titled “Responses”

200

Section titled “200”

The subnet.

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
id
required
string
/^subnet-[a-z0-9-]+$/
projectId
required
string
/^p-[a-z0-9-]+$/
vpcId
required
string
/^vpc-[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

IPv4 CIDR inside the parent VPC’s range; /16-/28; non-overlapping with siblings.

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

AZ within the subnet’s region.

string
routeTableId
required
string
/^rtb-[a-z0-9-]+$/
type
required

public subnets route 0/0 via the VPC’s IGW; instances can have floating IPs. private subnets route 0/0 via a NAT Gateway (no inbound from the internet).

string
Allowed values: public private
availableIPs

Usable IPs remaining after subtracting the 12 reserved entries and current allocations.

integer
state
required
string
Allowed values: creating available deleting deleted error
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
resolverAddress

The VPC resolver’s address on this subnet, its .3: what DHCP hands instances as their DNS server. Absent when no resolver answers there: the VPC has DNS resolution off, or the install runs no per-VPC resolver. A DHCP option set with its own domainNameServers changes what instances are told, not whether this address answers.

string

Example 

{
  "ownedBy": {
    "kind": "auto-scaling-group"
  },
  "cidrBlock": "10.0.1.0/24",
  "type": "public",
  "state": "creating",
  "resolverAddress": "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"
    }
  ]
}