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.

Delete a network interface (port)

DELETE
/scopes/{scopeId}/network/network-interfaces/{networkInterfaceId}

Deletes the selected Network Interface after a type-the-name confirmation in the UI. Deletion releases the reserved fixed IP back to the subnet pool, disassociates (but does not release) any floating IP, and removes the port from the scoped list. A port with a bound device cannot be deleted — the UI states "Detach the device before deleting this port" — so the device association is a hard dependency blocker. Failure leaves the port in a recoverable, queryable state. Validation: the port must exist and be visible in scopeId → ERR_NOT_FOUND otherwise; device must be null (no instance / load balancer / router / DHCP binding) → ERR_DEPENDENCY_BLOCKED when a device is still attached; destructive-action permission (owner|admin|contributor) is enforced; resource locks and retention rules are checked before acceptance. Async & state: Asynchronous — 202 with an Operation record. Port status transitions current → deleting → removed; resource.updated SSE frames carry the status patch and a terminal resource-removed frame once the read model drops the port. The Operation transitions queued → running → succeeded|failed. Errors: 401 unauthenticated; 403 when the caller lacks destructive-action permission on the scope; 404 unknown port; 409 DEPENDENCY_BLOCKED while a device is attached or a lock/retention rule blocks deletion; 412 when If-Match does not match the current ETag; 500 on backend failure. Idempotency/Concurrency: Idempotency-Key recommended — replaying the same key returns the original 202 Operation. If-Match recommended; a stale ETag yields 412 PRECONDITION_FAILED. Deleting an already-deleting port replays the in-flight Operation rather than erroring.

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

Optional; recommended for safe retries. When sent, the same key+body within 24h replays the original result and the same key with a different body is 409 CONFLICT; keys are unique per tenant. When an API token or service-account (bearer) caller omits it, the request is applied once with no replay protection (a retry may apply it again). A console session gets one from the edge.

Formatuuid
If-Match?string

ETag for optimistic concurrency on mutations/deletes; mismatch results in 412.

Response Body

Deletion accepted; returns the long-running Operation tracking port removal.

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 DELETE "https://example.com/scopes/string/network/network-interfaces/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"}