Archive a share link

share_links.archive() -> ShareLinkArchiveResponse

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: str

ReturnsExpand Collapse

class ShareLinkArchiveResponse: …

id: str

archived: Literal[true]

archived_at: datetime

When the share link was first archived.

formatdate-time

Archive a share link

import os
from boltz_api import Boltz

client = Boltz(
    api_key=os.environ.get("BOLTZ_API_KEY"),  # This is the default and can be omitted
)
response = client.share_links.archive(
    "shr_qoEFr2BlPTBLuM5BinaC8x7iVPP_AwppEOmlxQjJ-eo",
)
print(response.id)

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

Returns Examples

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