Skip to main content
POST
Create Vault Share Link

Authorizations

X-Api-Key
string
header
required

Body

application/json
name
string
required
Required string length: 1 - 200
organizationId
string<uuid>
required
title
string
required
Required string length: 1 - 200
description
string
Maximum string length: 2000
fields
object[]

Inline field blueprint. Required when templateId is omitted.

kind
enum<string>

Required when templateId is omitted.

Available options:
login,
api_key,
card,
custom
steps
object[]

Inline step layout. Only valid with kind and fields; rejected with templateId.

Maximum array length: 20
templateId
string<uuid>

Org template to snapshot. Mutually exclusive with kind and fields.

Response

The request has succeeded and a new resource has been created as a result.

Create response. token is the raw link secret and is returned once; the server stores only its hash.

The created share link.

token
string
required

Raw token for the recipient URL. Returned once.