curl -X DELETE https://api.vertracloud.app/v1/templates/tpl-abc123def456/share-links/lnk-abc123def456 \
-H "Authorization: Bearer $VERTRA_API_KEY"
{
"response": {
"id": "lnk-abc123def456",
"template_id": "tpl-abc123def456",
"mode": "use",
"last4": "x9Qa",
"uses": 3,
"max_uses": 10,
"expires_at": null,
"revoked_at": "2026-10-27T16:00:00Z",
"created_at": "2026-10-27T14:02:00Z"
}
}
Share links
Revoke a Share Link
Revokes a share link of a private template so nobody can use it again, without affecting what was already created from it.
DELETE
/
v1
/
templates
/
{template_id}
/
share-links
/
{link_id}
curl -X DELETE https://api.vertracloud.app/v1/templates/tpl-abc123def456/share-links/lnk-abc123def456 \
-H "Authorization: Bearer $VERTRA_API_KEY"
{
"response": {
"id": "lnk-abc123def456",
"template_id": "tpl-abc123def456",
"mode": "use",
"last4": "x9Qa",
"uses": 3,
"max_uses": 10,
"expires_at": null,
"revoked_at": "2026-10-27T16:00:00Z",
"created_at": "2026-10-27T14:02:00Z"
}
}
This call revokes a share link: it accepts no new use and stops offering updates to what was created from it. Applications and stacks already created from the link keep running, and copies already made stay with their owners. Revoking is idempotent: revoking a revoked link answers with the link as it is.
Needs the
templates:write scope when called with an API key. Only the owner of the template can revoke its links.
string
required
The template ID.
string
required
The link ID.
string
If the template belongs to a workspace, the workspace’s ID.
curl -X DELETE https://api.vertracloud.app/v1/templates/tpl-abc123def456/share-links/lnk-abc123def456 \
-H "Authorization: Bearer $VERTRA_API_KEY"
Response
object
The link, with
revoked_at filled.Show Toggle object
Show Toggle object
string
The link ID.
string
The template the link belongs to.
string
use or full_copy.string
The last 4 characters of the token, to tell links apart.
integer
How many times the link was used.
integer | null
The maximum number of uses, or
null for no limit.string | null
When the link expires, or
null when it does not expire.string | null
When the author revoked the link, or
null.string
When the link was created.
{
"response": {
"id": "lnk-abc123def456",
"template_id": "tpl-abc123def456",
"mode": "use",
"last4": "x9Qa",
"uses": 3,
"max_uses": 10,
"expires_at": null,
"revoked_at": "2026-10-27T16:00:00Z",
"created_at": "2026-10-27T14:02:00Z"
}
}
Error Responses
string
The error code indicating the reason for the failure. Possible values:
API_KEY_SCOPE_DENIED: The API key does not have thetemplates:writescope (403).TEMPLATE_NOT_FOUND: The template does not exist or is not yours (404).SHARE_LINK_NOT_FOUND: The link does not exist in that template (404).WORKSPACE_OWNER_ONLY: Only the workspace owner revokes the links of its templates.
{
"code": "SHARE_LINK_NOT_FOUND"
}
Last modified on October 28, 2026