PilotFoxDocs

Revoke a share link

DELETE
/api/v1/sites/{siteId}/share-links/{id}

The link's token is refused from the next request on.

Requires shareLink:write on the site (an API key, or a signed-in member's role). Share links: 401.

Authorization

headerx-api-key<token>

An organization API key (ak_…), with the permissions and the sites it was created with. For servers and scripts: no cookie and no Origin check. Also accepted as Authorization: Bearer ak_… (apiKeyBearer). A request carries one credential: a key sent with a share token or a live session cookie is 400 (details.reason: ambiguous_credentials).

Scope: shareLink:write

Path Parameters

siteId*string
id*string

Response Body

OK

application/json
  1. response
data*
Example Request
curl -X DELETE 'https://pilotfox.app/api/v1/sites/string/share-links/string'
Example Response200
{  "data": {    "deleted": true  }}