Storage

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 file share

DELETE
/scopes/{scopeId}/storage/file-shares/{fileShareId}

Soft-deletes the selected file share from the file share detail page "Delete" action. Deletion tears down the share's mount targets, stops billing for provisioned capacity, and removes the share from the scoped list; per platform policy the row is soft-deleted (deleted_at set) and excluded from all subsequent reads. Deletion is refused while unresolved dependencies exist — active mount targets serving connected clients, snapshots pinned by retention rules, or a governance lock on the resource — and the blocker is reported to the caller. Validation: fileShareId must reference a live share in the scope (→ 404 NOT_FOUND otherwise); the share must not be mid-provisioning (status CREATING) — transitional-state deletes → 409 CONFLICT; dependency blockers (attached clients/mount targets in use, retained snapshots) → 409 DEPENDENCY_BLOCKED; a management/governance lock → 409 LOCKED. RBAC: owner|admin (destructive-action permission enforced). Async & state: Asynchronous; returns 202 with an Operation resource. The share transitions AVAILABLE → (deleting) → soft-deleted; progress and the final resource.deleted notification are emitted as resource.updated SSE frames with kind "storage.file_share" until the Operation reaches succeeded|failed. Errors: 401 unauthenticated; 403 missing destructive permission; 404 unknown scopeId or fileShareId; 409 DEPENDENCY_BLOCKED unresolved dependants; 409 LOCKED resource lock; 412 If-Match ETag mismatch; 500 unexpected failure. Idempotency/Concurrency: Idempotency-Key is optional, the same contract as the bucket delete and every other async operation-return delete; replaying the same key returns the original 202 Operation. If-Match with the current ETag guards against deleting a share that changed since it was last read (mismatch → 412 PRECONDITION_FAILED).

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.

fileShareId*string

Identifier of the file share within the scope.

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 tracking Operation.

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/storage/file-shares/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"}