curl -X POST https://api.vertracloud.app/v1/templates/tpl-abc123def456/share-links \
-H "Authorization: Bearer $VERTRA_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "mode": "use", "max_uses": 10, "expires_in_days": 7 }'
{
"response": {
"id": "lnk-abc123def456",
"template_id": "tpl-abc123def456",
"mode": "use",
"last4": "x9Qa",
"uses": 0,
"max_uses": 10,
"expires_at": "2026-11-03T14:02:00Z",
"revoked_at": null,
"created_at": "2026-10-27T14:02:00Z",
"token": "vtpl_EXAMPLE_TOKEN_SHOWN_ONLY_ONCE_x9Qa"
}
}
Share links
Create a Share Link for a Template
Creates a share link for a private template, in use mode or full-copy mode, with an optional use limit and expiry.
POST
/
v1
/
templates
/
{template_id}
/
share-links
curl -X POST https://api.vertracloud.app/v1/templates/tpl-abc123def456/share-links \
-H "Authorization: Bearer $VERTRA_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "mode": "use", "max_uses": 10, "expires_in_days": 7 }'
{
"response": {
"id": "lnk-abc123def456",
"template_id": "tpl-abc123def456",
"mode": "use",
"last4": "x9Qa",
"uses": 0,
"max_uses": 10,
"expires_at": "2026-11-03T14:02:00Z",
"revoked_at": null,
"created_at": "2026-10-27T14:02:00Z",
"token": "vtpl_EXAMPLE_TOKEN_SHOWN_ONLY_ONCE_x9Qa"
}
}
This call creates a share link for a private template and answers
201 with the link and its token. The token is shown only in this response and cannot be recovered: store it now. Only a hash of it is kept, and the response is not cached. A token starts with vtpl_.
A link has one of two modes. A use link lets whoever opens it create their own applications from the template, without copying it. A full_copy link gives them a private template of their own, independent of yours, that counts against their limit of 5 private templates. full_copy needs share.full_copy set to true in the template, and it is not available for a closed template or for a version that has env_hidden variables. Read Share links before choosing.
Needs the templates:write scope when called with an API key. Only the owner of the template can create links; in a workspace, a member cannot even list them. Receivers see the notice “Not verified by Vertra” on the preview.
string
required
The template ID.
string
If the template belongs to a workspace, the workspace’s ID.
string
use or full_copy. Default use.integer
The maximum number of uses. Without it, there is no limit. A use is counted when someone starts creating from the link; a use that is refused or undone is given back.
integer
The number of days until the link expires. Without it, the link does not expire.
curl -X POST https://api.vertracloud.app/v1/templates/tpl-abc123def456/share-links \
-H "Authorization: Bearer $VERTRA_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "mode": "use", "max_uses": 10, "expires_in_days": 7 }'
Response
object
The link.
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.
string
The full token. Shown once.
{
"response": {
"id": "lnk-abc123def456",
"template_id": "tpl-abc123def456",
"mode": "use",
"last4": "x9Qa",
"uses": 0,
"max_uses": 10,
"expires_at": "2026-11-03T14:02:00Z",
"revoked_at": null,
"created_at": "2026-10-27T14:02:00Z",
"token": "vtpl_EXAMPLE_TOKEN_SHOWN_ONLY_ONCE_x9Qa"
}
}
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, is deleted or is not yours (404).TEMPLATE_SAVE_NOT_ALLOWED:full_copywas requested and the template does not allow it (share.full_copyis nottrue) (403).TEMPLATE_CLOSED:full_copywas requested for a closed template (403).VALIDATION_ERROR:max_usesorexpires_in_daysis not a positive integer (400).WORKSPACE_OWNER_ONLY: Only the workspace owner creates links for its templates.
{
"code": "TEMPLATE_CLOSED"
}
Last modified on October 28, 2026