Skip to main content
GET
Get secret by ID

Authorizations

Authorization
string
header
required

Access token for authentication

Path Parameters

id
integer<int32>
required

The ID of the secret to retrieve

Required range: x >= 1

Response

Secret retrieved 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