Archive a share link

client.shareLinks.archive(, ?): ShareLinkArchiveResponse { id, archived, archived_at }

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

ReturnsExpand Collapse

ShareLinkArchiveResponse { id, archived, archived_at }

id: string

archived: true

archived_at: string

When the share link was first archived.

formatdate-time

Archive a share link

import Boltz from 'boltz-api';

const client = new Boltz({
  apiKey: process.env['BOLTZ_API_KEY'], // This is the default and can be omitted
});

const response = await client.shareLinks.archive('shr_qoEFr2BlPTBLuM5BinaC8x7iVPP_AwppEOmlxQjJ-eo');

console.log(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"
}