Networking

Preview — pending review

This reference is generated from the platform API contract and is still under review. Operations, fields, and descriptions can change before publication.

Create a network interface (port)

POST
/scopes/{scopeId}/network/network-interfaces

Creates a Network Interface in the active scope from the network interface creation form. The port reserves a fixed IP on the chosen subnet of the chosen network (automatic DHCP assignment or a manually pinned IPv4 address), receives an auto-generated MAC under the fa:16:3e OUI, and enters the build state; once provisioned it becomes down (unattached) or active. On acceptance the resource becomes discoverable in the scoped list. Optional allowedAddressPairs seeds VRRP/VIP IP+MAC entries (the UI "Add pair" flow); standard ports incur no charge and the fixed IP stays reserved until deletion. Validation: name must match ^[a-z0-9-]{1,60}$ (names are NOT unique: Neutron allows duplicate port names and every port operation addresses the port by id); description at most 255 characters; networkId must reference an accessible network and subnetName one of its subnets → ERR_NOT_FOUND when unknown; when ipAssignment=manual, fixedIp is required, must be a valid IPv4 inside the subnet CIDR, not the gateway or a DHCP-agent address, and not already allocated; securityGroups ids must resolve and are only enforced when portSecurity=true; each address pair ip must be a valid IPv4 or CIDR (its mac is optional — omitted or empty means the port's own MAC). Any violation → ERR_VALIDATION (422). Async & state: Asynchronous — 202 with an Operation record. Initial port state build → terminal down (created, unattached) or active; failure leaves no orphaned port. resource.updated SSE frames are emitted on the network-interface resource as the status patch (build → down/active) lands; the Operation transitions queued → running → succeeded|failed. Errors: 401 unauthenticated; 403 when the caller lacks contributor/admin rights on the scope; 404 when the referenced network, subnet or a security group does not exist in scope; 409 QUOTA_EXCEEDED when the port or fixed-IP quota for the subscription is exhausted; 422 on any field validation failure; 500 on provisioning-control failure. Idempotency/Concurrency: Idempotency-Key required; replaying the same key returns the original 202 Operation without creating a duplicate port.

Authorization

bearerToken
headerAuthorizationBearer <token>

An API token (pc_live_…) or a service-account key (sak_live_…), created in Identity & Access Management and sent as Authorization: Bearer <token>. Requests are rate limited per credential and per tenant: every response carries X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset, and a refused request gets 429 RATE_LIMITED with Retry-After.

Path Parameters

scopeId*string

Opaque ownership+authorization scope resolving to tenant + subscription + project.

Header Parameters

Idempotency-Key*string

Required: this operation creates a new resource asynchronously, so a retry without the key would create a second one. Same key+body within 24h replays the original result; the same key with a different body is 409 CONFLICT. Keys are unique per tenant (the same key in two tenants is two different requests). An API token or service-account (bearer) caller MUST send it -- a request without it is refused with 400 IDEMPOTENCY_KEY_REQUIRED (ErrIdempotencyKeyRequired); reuse the same key on every retry of one logical request. A console session gets one from the edge.

Formatuuid

Request Body

application/json
  1. body

The network interface creation form submission payload.

name*string

Lowercase letters, numbers and hyphens, up to 60 chars. NOT required to be unique: Neutron allows duplicate port names (ports created through the direct API or Terraform can share one), and every port operation addresses the port by id.

Match^[a-z0-9-]{1,60}$
description?string

Optional free-text description.

Lengthlength <= 255
networkId*string

Target network id (picker catalog).

subnetName*string

Subnet of the chosen network the fixed IP is reserved on. Exactly ONE subnet and ONE address per create: multi-address ports are a deliberate write-side limitation — the portal creates single-address ports, while the READ side reports every address a port actually holds, however it was created.

ipAssignment?string

Automatic (DHCP) assignment or a manually pinned address.

Default"auto"
Value in"auto""manual"
fixedIp?string

Required when ipAssignment=manual — IPv4 inside the subnet CIDR; gateway and DHCP-agent addresses are reserved. Rejected (422) when non-empty while ipAssignment=auto (the default) — auto and an explicit fixedIp are a contradiction, never silently resolved by dropping the address.

portSecurity?boolean

Enable anti-spoofing filter + security-group enforcement.

Defaulttrue
securityGroups?array<string>

Security-group ids to attach; only enforced while portSecurity=true. OMITTED (or null) with portSecurity=true attaches the project's default security group, as the OpenStack CLI / Horizon do; an explicit empty list creates a port with no security group. The UI preselects sg-default.

allowedAddressPairs?array<>

Optional initial allowed address pairs (the UI "Add pair" flow).

Response Body

Creation accepted; returns the long-running Operation tracking port provisioning.

application/json
  1. response

A long-running operation record. GET /operations/{operationId} returns its current state.

id*string

Operation identifier, unique platform-wide.

action*string

Canonical action id that started this operation, e.g. compute.instance.create.

state*OperationState

State machine for long-running operations. PENDING and RUNNING are transitional; the rest are terminal.

Value in"PENDING""RUNNING""SUCCEEDED""FAILED""CANCELLED"
resourceKind?|

Kind of the target resource (matches RealtimeEvent.kind), null for resource-less actions.

resourceId?|

Identifier of the target resource; null until the resource is allocated.

resourceName?|

Human-readable name of the target resource captured when the operation was opened; null when unknown or the resource has been deleted (clients fall back to resourceId).

principalId?|

Subject id (user id/email or service-account id) of the actor that initiated this operation, captured at the create chokepoint; null on internal/worker paths with no request-scoped principal or for historical rows. This is the real actor the Activity feed renders.

sourceIp?|

Source IP address of the request that initiated this operation; null when unavailable (internal/worker paths, historical rows).

progressPercent?|

Best-effort progress; null when the action does not report progress.

Range0 <= value <= 100
error?|null

Populated only when state is FAILED (or CANCELLED with partial rollback notes).

warning?|null

Non-fatal degradation recorded on an operation that still SUCCEEDED - the primary action completed but something explicitly requested could not be delivered (e.g. publicIp was requested at instance create but no floating IP could be assigned). On a CANCELLED create it reports that the provider resource had already been created and was kept (live and billed until deleted; details.disposition = left_in_place). Same code+message shape as error so clients render both uniformly; null when the operation ran without degradation.

startedAt?|

When the worker began executing; null while PENDING.

finishedAt?|

When a terminal state was reached; null while transitional.

createdAt*string
updatedAt*string
curl -X POST "https://example.com/scopes/string/network/network-interfaces" \  -H "Idempotency-Key: 497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "networkId": "string",    "subnetName": "string"  }'
{  "id": "string",  "action": "string",  "state": "PENDING",  "resourceKind": "string",  "resourceId": "string",  "resourceName": "string",  "principalId": "string",  "sourceIp": "string",  "progressPercent": 0,  "error": {    "code": "string",    "message": "string",    "field": "string",    "details": {},    "retryable": false  },  "warning": {    "code": "string",    "message": "string",    "field": "string",    "details": {},    "retryable": false  },  "startedAt": "string",  "finishedAt": "string",  "createdAt": "string",  "updatedAt": "string"}