Revoke a share link

Revoke a Blob Storage share link with DELETE /v1/shares using its share id. The link answers 404 from then on, and the file itself is kept in storage.

DELETE /v1/shares

cURL

curl --request DELETE \
  --url 'https://blob.squarecloud.app/v1/shares' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{ "id": "q8Zr2LwX7nT0vKc4Hs1YbA" }'

{
  "status": "success"
}

Authorization · string · required

The API key for your account. You can find this in your account settings.

Delete Share revokes a share link. The link answers 404 from then on, and the file itself is kept. Requires the blob:write scope.

Parameters

id · string · required

The share id, from Create Share or List Shares.

Response

status · string

“success” if successful, “error” if not.

cURL

curl --request DELETE \
  --url 'https://blob.squarecloud.app/v1/shares' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{ "id": "q8Zr2LwX7nT0vKc4Hs1YbA" }'

{
  "status": "success"
}

Errors

Code	HTTP	When
INVALID_SHARE	400	id is missing or malformed.
SHARE_NOT_FOUND	404	The link doesn’t exist, expired or was already revoked.

Related

• Blob SDK: blob.shares.revoke()