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 security group
Deletes the selected security group, triggered from the detail header "Delete" action or the list view's
row/bulk "Delete" actions. Deletion is an asynchronous soft delete: the group enters a visible DELETING
workflow, its rules stop being evaluated once detachment completes, and the record is tombstoned
(deleted_at set) so every subsequent list/read excludes it. Failure leaves the group in a recoverable,
queryable state.
Validation: the security group must exist in the scope and be visible to the caller → 404 NOT_FOUND;
deletion must not be blocked by unresolved dependencies — a group with attachedPorts > 0 (ports/NICs still
referencing it) is rejected → 409 DEPENDENCY_BLOCKED with the blocking attachments listed; a management lock
on the resource or project → 409 LOCKED; destructive-action permission (contributor or higher) is
enforced → 403.
Async & state: Asynchronous — returns 202 with an Operation handle. State transitions
ACTIVE → DELETING → deleted (terminal); resource.updated SSE frames are emitted for the security-group
resource (status patch DELETING, then a removal frame) plus operation.updated frames until the operation
succeeds or fails.
Errors: 401 unauthenticated; 403 caller lacks destructive-action rights; 404 unknown or already deleted
group; 409 DEPENDENCY_BLOCKED while ports remain attached; 412 when If-Match is supplied and stale; 500 on
workflow errors.
Idempotency/Concurrency: Idempotency-Key recommended; replaying returns the original 202 Operation.
If-Match with the last-seen ETag prevents deleting a group that changed since it was read.
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.
securityGroupId*stringIdentifier of the security group to delete.
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; the security group is in the DELETING workflow. Track via the returned operation.
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/security-groups/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"}