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.

Allocate a new floating IP for the port

POST
/scopes/{scopeId}/network/network-interfaces/{networkInterfaceId}/actions/allocate

Allocates a brand-new floating IP from the external (provider) network pool — the "Allocate new IP" action on the Floating IP tab — and associates it with this port's fixed IP, making the port reachable from the internet. This differs from the attach action, which associates an already-allocated address from the available pool: allocate first carves a new address out of ext-net, then binds it. The association becomes visible on the port (floatingIp field) and in subsequent reads once the operation completes. Validation: the port must exist and be visible in scopeId → ERR_NOT_FOUND otherwise; the port's current state must permit allocation — it must not already have an associated floating IP and must not sit on a public (provider) network, since floating IPs cannot be associated to ports on public networks → ERR_CONFLICT; poolNetworkId, when given, must reference an external network → ERR_VALIDATION (422); the external pool must have free addresses → ERR_CAPACITY when exhausted. Async & state: Asynchronous — 202 with an Operation record. The floating IP is allocated then associated; on success a resource.updated SSE frame patches floatingIp from null to the new address on this network-interface resource. The Operation transitions queued → running → succeeded|failed; failure rolls back the allocation so no orphaned address is billed. Errors: 401 unauthenticated; 403 when the caller lacks contributor/admin rights on the scope; 404 unknown port; 409 CAPACITY_UNAVAILABLE when the external pool has no free addresses (a port that already holds a floating IP or sits on a public network also rejects with 409); 422 on an invalid pool reference; 500 on allocation-control failure. Idempotency/Concurrency: Idempotency-Key required — the UI can retry, and replaying the same key returns the original 202 Operation without allocating a second address.

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.

networkInterfaceId*string

Network interface (port) identifier.

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

Optional body for the "Allocate new IP" action; defaults allocate from the ext-net pool and associate immediately.

poolNetworkId?string

External (provider) network to allocate from; defaults to the region's ext-net.

Response Body

Allocation accepted; returns the long-running Operation tracking allocate + associate.

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/string/actions/allocate" \  -H "Idempotency-Key: 497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'
{  "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"}