Skip to main content
POST
/
v1beta
/
secrets
Create secret
curl --request POST \
  --url https://api.example.com/v1beta/secrets \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "secret_type": "login",
  "username": "<string>",
  "password": "<string>",
  "totp_secret": "<string>",
  "value": "<string>",
  "website": "<string>"
}
'
{
  "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "secret_type": "login",
  "website": "<string>",
  "has_totp": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Enter your API key as the bearer token. Set header: Authorization to Bearer <api_key>

Body

application/json
​
name
string
required

Human-readable name for the secret.

​
secret_type
enum<string>
required

Type of secret: 'login' for credentials, 'string' for simple values.

Available options:
login,
string
​
username
string | null

Login username. Required for 'login' type.

​
password
string | null

Login password. Required for 'login' type.

​
totp_secret
string | null

Optional TOTP secret (base32 encoded). Only for 'login' type.

​
value
string | null

Secret value. Required for 'string' type.

​
website
string | null

Optional website URL for context.

Response

Successful response

​
uuid
string<uuid>
required

Unique identifier for the secret.

​
name
string
required

Human-readable name for the secret.

​
secret_type
enum<string>
required

Type of secret: 'login' or 'string'.

Available options:
login,
string
​
website
string | null
required

Optional website URL.

​
has_totp
boolean
required

Whether the secret has a TOTP configured (only applicable for login type).

​
created_at
string<date-time>
required

Timestamp when the secret was created.

​
updated_at
string<date-time>
required

Timestamp when the secret was last updated.