Skip to content

Create a network interface.

POST
/v1/projects/{projectId}/network/network-interfaces
Code sample: Shell / cURL
curl --request POST \
--url https://stratum.example.com/v1/projects/example/network/network-interfaces \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "subnetId": "example", "name": "example", "displayName": "example", "description": "example", "securityGroupIds": [ "example" ], "sourceDestCheck": true, "tags": { "additionalProperty": "example" }, "throughputMbps": 1 }'

Returns 202 Accepted with the NIC in state creating. The IP and MAC are allocated server-side (the caller does not supply them). The async lifecycle worker transitions to available (success) or error.

projectId
required
string
/^p-[a-z0-9-]+$/
Media typeapplication/json
object
subnetId
required
string
/^subnet-[a-z0-9-]+$/
name
required
string
/^[a-z][a-z0-9-]{1,38}[a-z0-9]$/
displayName
string
>= 1 characters <= 100 characters
description
string
securityGroupIds
Array<string>
<= 5 items
sourceDestCheck
boolean
default: true
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
throughputMbps

Per-NIC bandwidth cap in Mbps. Omit / 0 = unlimited. Customers usually let the instance-type catalog default kick in instead of setting this directly; this field is the per-NIC override hook for advanced cases

  • the custom-shape launch path.
integer

Accepted.

Media typeapplication/json
object
id
required
string
/^nic-[a-z0-9-]+$/
projectId
required
string
/^p-[a-z0-9-]+$/
subnetId
required
string
/^subnet-[a-z0-9-]+$/
vpcId
required
string
/^vpc-[a-z0-9-]+$/
region
required
string
/^[a-z][a-z0-9]+(-[a-z0-9]+)*$/
availabilityZone
required
string
name
required
string
/^[a-z][a-z0-9-]{1,38}[a-z0-9]$/
displayName
required
string
>= 1 characters <= 100 characters
description
string
macAddress
required

Server-generated QEMU 52:54:00:XX:XX:XX MAC.

string
primaryIP
required

IPv4 address allocated by Stratum IPAM.

string
secondaryIPs

Reserved for 2.x multi-IP NICs.

Array<string>
floatingIPId

0-or-1 floating IPs per NIC at v1.

string
securityGroupIds
required
Array<string>
0 <= 5 items
attachment

Embedded on a NIC when state is in-use. instanceId is the opaque Compute-side identifier; deviceIndex orders the NIC within the instance’s domain XML.

object
instanceId
required
string
deviceIndex
required
integer
attachedAt
required
string format: date-time
interfaceType

What kind of port this is. interface is a plain instance-attachable NIC; load-balancer marks a Stratum-owned LB data-plane port whose owning LB is in ownerId; nat-gateway is reserved; database is a Stratum Database endpoint port in your subnet whose owning db instance is in ownerId — it carries your security groups and is released with the instance. System-set — never accepted on create.

string
Allowed values: interface load-balancer nat-gateway resolver-inbound database
ownerId

The owning resource for non-interface kinds (e.g. the lb-... id for a load-balancer data-plane port). Absent on plain interfaces — instance attachments stay on attachment.instanceId.

string
sourceDestCheck
required

AWS-style anti-spoofing; drop packets not addressed to this NIC’s IP.

boolean
state
required
string
Allowed values: creating available attaching in-use detaching 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

Example

{
"interfaceType": "interface",
"state": "creating"
}

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

Conflicting state.

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