Revoke a share link
Permanently revokes a share link by its shr_* id, or a whole share bundle by its bnd_* id (the bundle's viewer page and every per-file link it hands out).
Permanently revokes a share link by its shr_* id, or a whole share bundle by its bnd_* id (the bundle's viewer page and every per-file link it hands out). After this, every open of the viewer page or download URL returns 410 Gone. The call is idempotent — revoking an already-revoked link still succeeds — and returns no content. Requires buckets:write.
Scope: buckets:write. Send the API key as a bearer token; Scopes lists what each one reaches.
Request
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
shareLinkId | string | yes | Share-link identifier (shr_), or a share-bundle identifier (bnd_) to revoke a whole bundle. |
Response
204 Success, no body.
Errors
Every error has the same body, {"error": {"type", "code", "message", "param"}}; branch on code. Errors lists every code.
| Status | Meaning |
|---|---|
400 | The request is malformed or a value is invalid (invalid_request, invalid_domain, idempotency_key_mismatch). |
401 | The API key is missing or invalid. |
403 | The key lacks the scope this endpoint needs (scope_missing) or may not do this (not_permitted). |
404 | No such resource in this account (resource_not_found). |
429 | Rate limit, plan limit, budget or spend cap reached (rate_limited, plan_limit_reached, budget_exceeded, spend_cap_reached). |
500 | An unexpected error; retry with backoff, then contact support (internal_error). |
Create a secure share link
Mints a secure share link over one object you own and returns its shareUrl (a viewer page) and downloadUrl.
List a share link's opens
Returns open analytics for a share link: a summary block (the authoritative servedOpens, plus maxUses, revoked, and expiresAt) and the most recent opens, each with openedAt, clientIp, userAgent, and outcome.