Skip to main content
POST
Add new secret

Authorizations

Authorization
string
header
required

Access token for authentication

Body

application/json
name
string
required

Name of the secret

Maximum string length: 512
type
enum<string>
required

Type of secret

Available options:
None,
UnixAccountSSH,
UnixAccountTelnet,
WindowsAccount,
ADAccount,
WebAccount,
MSSQLAccount
login
string
required

Login username

Maximum string length: 512
description
string

Description of the secret

Maximum string length: 2000
password
string

The password value

ssh_key
object
parent_folder_id
integer<int32>

ID of the parent folder

Required range: x >= 0
parent_folder_name
string

Name of the parent folder

Maximum string length: 512
domain
string

Domain for AD accounts

Maximum string length: 512
computer_name
string

Computer name for Windows/Unix accounts

Maximum string length: 512
url
string<uri>

URL for web accounts

Maximum string length: 2000
server
string

Server for database accounts

Maximum string length: 512
computers
string[]

List of computers

file_transfer
object
rotation
object
record_activities
boolean

Whether to record activities for this secret

check_out
object
require_approval
object
permissions
object
check_password
object

Response

Secret created successfully

id
integer<int32>
required

Unique identifier of the secret

name
string
required

Name of the secret

type
enum<string>
required

Type of secret

Available options:
None,
UnixAccountSSH,
UnixAccountTelnet,
WindowsAccount,
ADAccount,
WebAccount,
MSSQLAccount
login
string
required

Login username

description
string

Description of the secret

parent_folder_id
integer<int32>

ID of the parent folder

domain
string

Domain for AD accounts

computer_name
string

Computer name for Windows/Unix accounts

url
string

URL for web accounts

server
string

Server for database accounts

computers
string[]

List of computers

file_transfer
object
rotation
object
record_activities
boolean

Whether to record activities for this secret

check_out
object
require_approval
object
permissions
object
check_password
object
check_password_status
enum<string>

Status of the last password check (heartbeat)

Available options:
None,
Valid,
Invalid,
Failed
last_password_check_utc
string<date-time> | null

UTC timestamp of the last password check

password_rotation_status
enum<string>

Status of password rotation

Available options:
Disabled,
Enabled,
Failed
last_password_rotation_utc
string<date-time> | null

UTC timestamp of the last password rotation