API Reference

Share Links

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Archive a share link

$ boltz-api share-links archive

POST/compute/v1/share-links/{id}/archive

Archive a share link so it no longer grants public access. Metadata remains retrievable and repeated calls preserve the first archive timestamp.

ParametersExpand Collapse

--id: string

Share link ID. This value is a bearer credential and is redacted from application logs and traces.

ReturnsExpand Collapse

ShareLinkArchiveResponse: object { id, archived, archived_at }

id: string

archived: true

archived_at: string

When the share link was first archived.

Archive a share link

CLI Tool

HTTP

TypeScript

Python

Go

CLI Tool

boltz-api share-links archive \
  --api-key 'My API Key' \
  --id shr_qoEFr2BlPTBLuM5BinaC8x7iVPP_AwppEOmlxQjJ-eo

200 example

{
  "id": "shr_qoEFr2BlPTBLuM5BinaC8x7iVPP_AwppEOmlxQjJ-eo",
  "archived": true,
  "archived_at": "2019-12-27T18:11:19.117Z"
}

Returns Examples

200 example

{
  "id": "shr_qoEFr2BlPTBLuM5BinaC8x7iVPP_AwppEOmlxQjJ-eo",
  "archived": true,
  "archived_at": "2019-12-27T18:11:19.117Z"
}