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 router
Deletes the selected Router (Delete action in the Routers page row/bulk actions and in the router detail page, behind a
confirmation dialog). Deletion tears down the HA pair when present, releases the external gateway address,
and removes the router from the scoped list; on failure the resource remains in a recoverable, queryable
state so the UI can surface the blocker.
Validation: router must exist and be visible to the caller → 404 NOT_FOUND; deletion must not be blocked
by unresolved dependencies — attached internal interfaces, floating IPs routed through the gateway, or locks
and retention rules → 409 DEPENDENCY_BLOCKED naming the blocking resources so the user can detach them first.
Async & state: Asynchronous — returns 202 with an Operation handle. The router transitions to a visible
deleting workflow; resource.updated SSE frames with kind: network.router track progress and a final
resource.deleted frame removes it from lists. Terminal outcomes: resource removed (soft-deleted) or
ERROR with the failure reason while remaining queryable.
Errors: 401 unauthenticated; 403 caller lacks destructive-action permission (owner|admin|contributor);
404 unknown router; 409 DEPENDENCY_BLOCKED when interfaces, floating IPs, locks, or retention rules block the
delete; 412 If-Match ETag mismatch; 500 internal failure.
Idempotency/Concurrency: Idempotency-Key replay returns the original 202 Operation rather than enqueueing
a second teardown; If-Match is honoured so a delete based on a stale view of the router fails with 412.
bearerTokenAuthorizationBearer <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.
scopeId*stringOpaque ownership+authorization scope resolving to tenant + subscription + project.
routerId*stringIdentifier of the router.
Idempotency-Key?stringOptional; 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.
uuidIf-Match?stringETag for optimistic concurrency on mutations/deletes; mismatch results in 412.
Deletion accepted; an Operation handle tracks the asynchronous teardown.
application/json- response
A long-running operation record. GET /operations/{operationId} returns its current state.
id*stringOperation identifier, unique platform-wide.
action*stringCanonical action id that started this operation, e.g. compute.instance.create.
state*OperationStateState machine for long-running operations. PENDING and RUNNING are transitional; the rest are terminal.
"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.
0 <= value <= 100error?|nullPopulated only when state is FAILED (or CANCELLED with partial rollback notes).
warning?|nullNon-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*stringupdatedAt*stringcurl -X DELETE "https://example.com/scopes/string/network/routers/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"}