Delinea Secret Server

App · 23 actions

Use Delinea Secret Server's privileged secrets in workflows: find and read secrets, store new ones, check them out and in, change and check passwords, see who used them, and manage folders, users and groups. Start workflows when a secret is added, its password changes or a change or heartbeat fails, a secret is checked out, or a folder or user is added or locked out.

Actions

ActionWhat it does
Add user to groupAdd a user to a group, giving them whatever the group is shared, such as when someone joins a team.
Change passwordChange a secret's password on the account it belongs to, such as a Windows or database account, and in Secret Server: to the password given, or one Secret Server generates by the template's rules.
Check in secretCheck a secret back in so others can check it out.
Check out secretCheck out a secret that needs it, so only the connected account can use it until it is checked in or the check-out time runs out.
Create folderCreate a folder for secrets, at the top level or inside another folder, whose permissions it takes unless you say otherwise.
Create secretStore a new secret from a template, such as a Windows Account or a Password, in a folder, with its field values such as the user name and password.
Create userCreate a local Secret Server user, or an application account that can only use the API.
Delete folderDelete an empty folder.
Delete secretDelete (deactivate) a secret.
Delete userDelete a Secret Server user, such as when someone leaves.
Expire secretMark a secret expired now, so its password is due to be changed, automatically if the secret changes it on a schedule.
Get connected accountSee which Secret Server account the connection signs in as, and the role permissions it has.
Get folderGet a folder's name, path and parent, the templates its secrets may use, and optionally its subfolders.
Get secretGet a secret's details and the values of its fields, such as its machine and user name, by slug in 'fields'.
Get secret auditSee who viewed, edited, checked out or launched a secret, and when, newest first, optionally with its password changes.
Get secret fieldRead one field's value from a secret, such as its password, to use in a later step.
List foldersList the folders the connected account can see, with their paths, optionally by name or inside one folder.
List groupsList Secret Server groups, with how many members each has and whether it is synced from Active Directory.
List secret templatesList the secret templates (the kinds of secret, such as Windows Account or SQL Server Account) and whether each can run a heartbeat.
List usersList Secret Server users, matched on user name, display name or email, with whether each is enabled, locked out or an application account.
Run heartbeatAsk Secret Server to check now that a secret's credentials still work on the account they belong to.
Search secretsFind secrets by name, folder, template or heartbeat status, or only those checked out, with each one's folder, template, check-out and heartbeat state.
Update secret fieldSet one field of a secret, such as its password after it was changed elsewhere, or its notes.

Add user to group

Add a user to a group, giving them whatever the group is shared, such as when someone joins a team.

Inputs

Groupgroup_idtextRequired
The group. Pick one, or give its id from 'List groups'.
UserusertextRequired
The user. Pick one, or give their id from 'List users'.

Outputs

membershipobject
The new membership
Example output
{
  "membership": {
    "groupId": 8,
    "groupName": "Server Admins",
    "userId": 37,
    "userName": "jsmith"
  }
}

Change password

Change a secret's password on the account it belongs to, such as a Windows or database account, and in Secret Server: to the password given, or one Secret Server generates by the template's rules. The change runs in the background; the secret shows if it failed.

Inputs

Secretsecret_idtextRequired
The secret. Pick one, or give its id from 'Search secrets'.
New passwordnew_passwordtext
The new password. Leave empty to have Secret Server generate one.

Outputs

password_generatedtrue/false
True when Secret Server generated the password
secretobject
The secret
Example output
{
  "password_generated": true,
  "secret": {
    "active": true,
    "autoChangeEnabled": true,
    "checkOutEnabled": true,
    "checkOutUserId": -1,
    "checkOutUserName": "",
    "checkedOut": false,
    "createDate": "2026-10-02T14:21:07",
    "daysUntilExpiration": 21,
    "folderId": 12,
    "folderPath": "\\IT\\Servers",
    "hasLauncher": true,
    "id": 1042,
    "isOutOfSync": false,
    "isRestricted": true,
    "lastAccessed": "2026-11-10T09:15:44",
    "lastHeartBeatStatus": "Success",
    "lastPasswordChangeAttempt": "2026-11-01T02:00:13",
    "name": "web01 local admin",
    "outOfSyncReason": "",
    "requiresApproval": false,
    "requiresComment": false,
    "secretTemplateId": 6003,
    "secretTemplateName": "Windows Account",
    "siteId": 1
  }
}

Check in secret

Check a secret back in so others can check it out. If its template changes the password on check-in, Secret Server does so.

Inputs

Secretsecret_idtextRequired
The secret. Pick one, or give its id from 'Search secrets'.
Force check-inforcetrue/false
Check it in even if someone else has it checked out. Needs the Force Check In permission.

Outputs

secretobject
The secret, as it is now
Example output
{
  "secret": {
    "active": true,
    "autoChangeEnabled": true,
    "checkOutEnabled": true,
    "checkOutUserId": -1,
    "checkOutUserName": "",
    "checkedOut": false,
    "createDate": "2026-10-02T14:21:07",
    "daysUntilExpiration": 21,
    "folderId": 12,
    "folderPath": "\\IT\\Servers",
    "hasLauncher": true,
    "id": 1042,
    "isOutOfSync": false,
    "isRestricted": true,
    "lastAccessed": "2026-11-10T09:15:44",
    "lastHeartBeatStatus": "Success",
    "lastPasswordChangeAttempt": "2026-11-01T02:00:13",
    "name": "web01 local admin",
    "outOfSyncReason": "",
    "requiresApproval": false,
    "requiresComment": false,
    "secretTemplateId": 6003,
    "secretTemplateName": "Windows Account",
    "siteId": 1
  }
}

Check out secret

Check out a secret that needs it, so only the connected account can use it until it is checked in or the check-out time runs out.

Inputs

Secretsecret_idtextRequired
The secret. Pick one, or give its id from 'Search secrets'.

Outputs

checked_outtrue/false
True once it is checked out
response_codeslist
Any notes Secret Server answered with
secret_idnumber
The secret's id
Example output
{
  "checked_out": true,
  "response_codes": [],
  "secret_id": 1042
}

Create folder

Create a folder for secrets, at the top level or inside another folder, whose permissions it takes unless you say otherwise.

Inputs

Folder namenametextRequired
The new folder's name, such as Network Devices.
Inside folderparent_folder_idtext
The folder to create it in. Leave empty for the top level. Pick one, or give its id from 'List folders'.
Inherit permissionsinherit_permissionstrue/false
Give it the permissions of the folder it is in. On by default; a top-level folder has none to inherit.Default: true.

Outputs

folderobject
The new folder
Example output
{
  "folder": {
    "folderName": "Servers",
    "folderPath": "\\IT\\Servers",
    "id": 12,
    "inheritPermissions": true,
    "inheritSecretPolicy": true,
    "parentFolderId": 4,
    "secretPolicyId": -1
  }
}

Create secret

Store a new secret from a template, such as a Windows Account or a Password, in a folder, with its field values such as the user name and password.

Inputs

Secret templatesecret_template_idtextRequired
The kind of secret, such as Windows Account or Password. Pick one, or give its id from 'List secret templates'.
Secret namenametextRequired
The name to list the secret by, such as web01 admin.
Folderfolder_idtext
The folder to store it in. Pick one, or give its id from 'List folders'.
Fieldsfieldsobject
A value for each of the template's fields, such as Username and Password. Fields left empty keep the template's default.

Outputs

secretobject
The secret
Example output
{
  "secret": {
    "active": true,
    "autoChangeEnabled": true,
    "checkOutEnabled": true,
    "checkOutIntervalMinutes": 30,
    "checkOutMinutesRemaining": 0,
    "checkOutUserDisplayName": "",
    "checkOutUserId": -1,
    "checkedOut": false,
    "failedPasswordChangeAttempts": 0,
    "fields": {
      "machine": "web01.example.com",
      "username": "Administrator"
    },
    "folderId": 12,
    "id": 1042,
    "isOutOfSync": false,
    "isRestricted": true,
    "items": [
      {
        "fieldDescription": "The server or location of the Windows machine.",
        "fieldId": 108,
        "fieldName": "Machine",
        "filename": "",
        "isFile": false,
        "isList": false,
        "isNotes": false,
        "isPassword": false,
        "itemId": 5001,
        "itemValue": "web01.example.com",
        "slug": "machine",
        "valueHidden": false
      },
      {
        "fieldDescription": "The Windows account's user name.",
        "fieldId": 109,
        "fieldName": "Username",
        "filename": "",
        "isFile": false,
        "isList": false,
        "isNotes": false,
        "isPassword": false,
        "itemId": 5002,
        "itemValue": "Administrator",
        "slug": "username",
        "valueHidden": false
      },
      {
        "fieldDescription": "The password of the Windows account.",
        "fieldId": 110,
        "fieldName": "Password",
        "filename": "",
        "isFile": false,
        "isList": false,
        "isNotes": false,
        "isPassword": true,
        "itemId": 5003,
        "itemValue": "",
        "slug": "password",
        "valueHidden": true
      }
    ],
    "lastHeartBeatCheck": "2026-11-12T03:00:02",
    "lastHeartBeatStatus": "Success",
    "lastPasswordChangeAttempt": "2026-11-01T02:00:13",
    "name": "web01 local admin",
    "outOfSyncReason": "",
    "requiresComment": false,
    "secretPolicyId": -1,
    "secretTemplateId": 6003,
    "secretTemplateName": "Windows Account",
    "siteId": 1
  }
}

Create user

Create a local Secret Server user, or an application account that can only use the API. Needs the Administer Users permission.

Inputs

User nameusernametextRequired
The name they sign in with, such as jsmith.
Display namedisplay_nametext
Their name as Secret Server shows it. Defaults to the user name.
PasswordpasswordtextRequired
Their first password. It must meet your Secret Server's password rules.
Emailemailtext
Their email address, for Secret Server's notices.
Application accountapplication_accounttrue/false
Make it an application account, which can use the API but can't sign in to Secret Server.
Enabledenabledtrue/false
Whether they can sign in now. On by default.Default: true.

Outputs

userobject
The new user
Example output
{
  "user": {
    "created": "2026-09-14T16:02:55",
    "displayName": "Jane Smith",
    "domainId": -1,
    "domainName": "",
    "emailAddress": "jane.smith@example.com",
    "enabled": true,
    "id": 37,
    "isApplicationAccount": false,
    "isLockedOut": false,
    "lastLogin": "2026-11-11T08:41:20",
    "loginFailures": 0,
    "userName": "jsmith"
  }
}

Delete folder

Delete an empty folder. Secret Server refuses a folder that still holds secrets or folders.

Inputs

Folderfolder_idtextRequired
The folder. Pick one, or give its id from 'List folders'.

Outputs

deletedtrue/false
True once Secret Server has deleted it
idnumber
The id of what was deleted
object_typetext
What was deleted, such as Secret
Example output
{
  "deleted": true,
  "id": 12,
  "object_type": "Folder"
}

Delete secret

Delete (deactivate) a secret. Secret Server keeps it and its audit trail, hidden from users, and an administrator can bring it back.

Inputs

Secretsecret_idtextRequired
The secret. Pick one, or give its id from 'Search secrets'.

Outputs

deletedtrue/false
True once Secret Server has deleted it
idnumber
The id of what was deleted
object_typetext
What was deleted, such as Secret
Example output
{
  "deleted": true,
  "id": 1042,
  "object_type": "Secret"
}

Delete user

Delete a Secret Server user, such as when someone leaves. Needs the Administer Users permission.

Inputs

UserusertextRequired
The user. Pick one, or give their id from 'List users'.

Outputs

deletedtrue/false
True once Secret Server has deleted it
idnumber
The id of what was deleted
object_typetext
What was deleted, such as Secret
Example output
{
  "deleted": true,
  "id": 37,
  "object_type": "User"
}

Expire secret

Mark a secret expired now, so its password is due to be changed, automatically if the secret changes it on a schedule.

Inputs

Secretsecret_idtextRequired
The secret. Pick one, or give its id from 'Search secrets'.

Outputs

secretobject
The secret, as it is now
Example output
{
  "secret": {
    "active": true,
    "autoChangeEnabled": true,
    "checkOutEnabled": true,
    "checkOutUserId": -1,
    "checkOutUserName": "",
    "checkedOut": false,
    "createDate": "2026-10-02T14:21:07",
    "daysUntilExpiration": 0,
    "folderId": 12,
    "folderPath": "\\IT\\Servers",
    "hasLauncher": true,
    "id": 1042,
    "isOutOfSync": false,
    "isRestricted": true,
    "lastAccessed": "2026-11-10T09:15:44",
    "lastHeartBeatStatus": "Success",
    "lastPasswordChangeAttempt": "2026-11-01T02:00:13",
    "name": "web01 local admin",
    "outOfSyncReason": "",
    "requiresApproval": false,
    "requiresComment": false,
    "secretTemplateId": 6003,
    "secretTemplateName": "Windows Account",
    "siteId": 1
  }
}

Get connected account

See which Secret Server account the connection signs in as, and the role permissions it has.

Inputs

None.

Outputs

userobject
The account
Example output
{
  "user": {
    "displayName": "Lodol",
    "emailAddress": "",
    "id": 41,
    "permission_names": [
      "View Secret",
      "Add Secret",
      "Edit Secret"
    ],
    "userName": "lodol-app"
  }
}

Get folder

Get a folder's name, path and parent, the templates its secrets may use, and optionally its subfolders.

Inputs

Folderfolder_idtextRequired
The folder. Pick one, or give its id from 'List folders'.
Include subfoldersinclude_subfolderstrue/false
Also list every folder inside it.

Outputs

folderobject
The folder
Example output
{
  "folder": {
    "childFolders": [
      {
        "folderName": "Linux",
        "folderPath": "\\IT\\Servers\\Linux",
        "id": 13,
        "inheritPermissions": true,
        "inheritSecretPolicy": true,
        "parentFolderId": 12,
        "secretPolicyId": -1
      }
    ],
    "folderName": "Servers",
    "folderPath": "\\IT\\Servers",
    "id": 12,
    "inheritPermissions": true,
    "inheritSecretPolicy": true,
    "parentFolderId": 4,
    "secretPolicyId": -1,
    "secretTemplates": [
      {
        "active": true,
        "heartbeatEnabled": true,
        "id": 6003,
        "name": "Windows Account",
        "passwordTypeId": 2,
        "passwordTypeReady": true
      }
    ]
  }
}

Get secret

Get a secret's details and the values of its fields, such as its machine and user name, by slug in 'fields'. Password fields are listed without their values; 'Get secret field' reads one.

Inputs

Secretsecret_idtextRequired
The secret. Pick one, or give its id from 'Search secrets'.

Outputs

secretobject
The secret
Example output
{
  "secret": {
    "active": true,
    "autoChangeEnabled": true,
    "checkOutEnabled": true,
    "checkOutIntervalMinutes": 30,
    "checkOutMinutesRemaining": 0,
    "checkOutUserDisplayName": "",
    "checkOutUserId": -1,
    "checkedOut": false,
    "failedPasswordChangeAttempts": 0,
    "fields": {
      "machine": "web01.example.com",
      "username": "Administrator"
    },
    "folderId": 12,
    "id": 1042,
    "isOutOfSync": false,
    "isRestricted": true,
    "items": [
      {
        "fieldDescription": "The server or location of the Windows machine.",
        "fieldId": 108,
        "fieldName": "Machine",
        "filename": "",
        "isFile": false,
        "isList": false,
        "isNotes": false,
        "isPassword": false,
        "itemId": 5001,
        "itemValue": "web01.example.com",
        "slug": "machine",
        "valueHidden": false
      },
      {
        "fieldDescription": "The Windows account's user name.",
        "fieldId": 109,
        "fieldName": "Username",
        "filename": "",
        "isFile": false,
        "isList": false,
        "isNotes": false,
        "isPassword": false,
        "itemId": 5002,
        "itemValue": "Administrator",
        "slug": "username",
        "valueHidden": false
      },
      {
        "fieldDescription": "The password of the Windows account.",
        "fieldId": 110,
        "fieldName": "Password",
        "filename": "",
        "isFile": false,
        "isList": false,
        "isNotes": false,
        "isPassword": true,
        "itemId": 5003,
        "itemValue": "",
        "slug": "password",
        "valueHidden": true
      }
    ],
    "lastHeartBeatCheck": "2026-11-12T03:00:02",
    "lastHeartBeatStatus": "Success",
    "lastPasswordChangeAttempt": "2026-11-01T02:00:13",
    "name": "web01 local admin",
    "outOfSyncReason": "",
    "requiresComment": false,
    "secretPolicyId": -1,
    "secretTemplateId": 6003,
    "secretTemplateName": "Windows Account",
    "siteId": 1
  }
}

Get secret audit

See who viewed, edited, checked out or launched a secret, and when, newest first, optionally with its password changes.

Inputs

Secretsecret_idtextRequired
The secret. Pick one, or give its id from 'Search secrets'.
Include password changesinclude_password_changestrue/false
Also list the secret's password changes.
Taketakenumber
How many to return, 1 to 1,000. Defaults to 50.From 1 to 1000.
Skipskipnumber
How many to skip, to read on. Use 'next_skip' from an earlier result. Defaults to 0.At least 0.

Outputs

auditslist
The audit entries on this page
countnumber
How many are on this page
has_moretrue/false
Whether there are more
next_skipnumber
The 'Skip' that reads the next page
secret_idnumber
The secret's id
skipnumber
How many were skipped
totalnumber
How many match in all
Example output
{
  "audits": [
    {
      "action": "VIEW",
      "actionForDisplay": "View",
      "byUserDisplayName": "Jane Smith",
      "dateRecorded": "2026-11-12T09:31:05",
      "id": 99812,
      "notes": "",
      "status": "",
      "ticketNumber": "",
      "username": "jsmith"
    }
  ],
  "count": 1,
  "has_more": false,
  "next_skip": 1,
  "secret_id": 1042,
  "skip": 0,
  "total": 1
}

Get secret field

Read one field's value from a secret, such as its password, to use in a later step. Secret Server records the view in its audit trail. The value is in the step's result for later steps, so anyone who can see this workflow's runs can see it; the run's summary doesn't print it.

Inputs

Secretsecret_idtextRequired
The secret. Pick one, or give its id from 'Search secrets'.
FieldfieldtextRequired
The field, such as Password or Username. Pick one, or give its slug, such as password.

Outputs

fieldtext
The field's slug
secret_idnumber
The secret's id
valuetext
The field's value
Example output
{
  "field": "password",
  "secret_id": 1042,
  "value": "k8#Qz!v2Lm9r"
}

List folders

List the folders the connected account can see, with their paths, optionally by name or inside one folder.

Inputs

Search forsearch_texttext
Only those whose name contains this. Leave empty for all.
Inside folderparent_folder_idtext
Only folders inside this one. Pick one, or give its id from 'List folders'.
Direct subfolders onlydirect_children_onlytrue/false
With a folder, list only the folders directly in it.
Taketakenumber
How many to return, 1 to 1,000. Defaults to 50.From 1 to 1000.
Skipskipnumber
How many to skip, to read on. Use 'next_skip' from an earlier result. Defaults to 0.At least 0.

Outputs

countnumber
How many are on this page
folderslist
The folders on this page
has_moretrue/false
Whether there are more
next_skipnumber
The 'Skip' that reads the next page
skipnumber
How many were skipped
totalnumber
How many match in all
Example output
{
  "count": 1,
  "folders": [
    {
      "folderName": "Servers",
      "folderPath": "\\IT\\Servers",
      "id": 12,
      "inheritPermissions": true,
      "inheritSecretPolicy": true,
      "parentFolderId": 4,
      "secretPolicyId": -1
    }
  ],
  "has_more": false,
  "next_skip": 1,
  "skip": 0,
  "total": 1
}

List groups

List Secret Server groups, with how many members each has and whether it is synced from Active Directory.

Inputs

Search forsearch_texttext
Only those whose name contains this. Leave empty for all.
Include inactiveinclude_inactivetrue/false
Also list ones that were deleted or disabled.
Taketakenumber
How many to return, 1 to 1,000. Defaults to 50.From 1 to 1000.
Skipskipnumber
How many to skip, to read on. Use 'next_skip' from an earlier result. Defaults to 0.At least 0.

Outputs

countnumber
How many are on this page
groupslist
The groups on this page
has_moretrue/false
Whether there are more
next_skipnumber
The 'Skip' that reads the next page
skipnumber
How many were skipped
totalnumber
How many match in all
Example output
{
  "count": 1,
  "groups": [
    {
      "created": "2026-03-02T10:00:00",
      "domainId": -1,
      "domainName": "",
      "enabled": true,
      "id": 8,
      "memberCount": 6,
      "name": "Server Admins",
      "synchronized": false
    }
  ],
  "has_more": false,
  "next_skip": 1,
  "skip": 0,
  "total": 1
}

List secret templates

List the secret templates (the kinds of secret, such as Windows Account or SQL Server Account) and whether each can run a heartbeat.

Inputs

Search forsearch_texttext
Only those whose name contains this. Leave empty for all.
Include inactiveinclude_inactivetrue/false
Also list ones that were deleted or disabled.
Taketakenumber
How many to return, 1 to 1,000. Defaults to 50.From 1 to 1000.
Skipskipnumber
How many to skip, to read on. Use 'next_skip' from an earlier result. Defaults to 0.At least 0.

Outputs

countnumber
How many are on this page
has_moretrue/false
Whether there are more
next_skipnumber
The 'Skip' that reads the next page
skipnumber
How many were skipped
templateslist
The templates on this page
totalnumber
How many match in all
Example output
{
  "count": 1,
  "has_more": false,
  "next_skip": 1,
  "skip": 0,
  "templates": [
    {
      "active": true,
      "heartbeatEnabled": true,
      "id": 6003,
      "name": "Windows Account",
      "passwordTypeId": 2,
      "passwordTypeReady": true
    }
  ],
  "total": 1
}

List users

List Secret Server users, matched on user name, display name or email, with whether each is enabled, locked out or an application account.

Inputs

Search forsearch_texttext
Only those whose name contains this. Leave empty for all.
Include inactiveinclude_inactivetrue/false
Also list ones that were deleted or disabled.
Taketakenumber
How many to return, 1 to 1,000. Defaults to 50.From 1 to 1000.
Skipskipnumber
How many to skip, to read on. Use 'next_skip' from an earlier result. Defaults to 0.At least 0.

Outputs

countnumber
How many are on this page
has_moretrue/false
Whether there are more
next_skipnumber
The 'Skip' that reads the next page
skipnumber
How many were skipped
totalnumber
How many match in all
userslist
The users on this page
Example output
{
  "count": 1,
  "has_more": false,
  "next_skip": 1,
  "skip": 0,
  "total": 1,
  "users": [
    {
      "created": "2026-09-14T16:02:55",
      "displayName": "Jane Smith",
      "domainId": -1,
      "domainName": "",
      "emailAddress": "jane.smith@example.com",
      "enabled": true,
      "id": 37,
      "isApplicationAccount": false,
      "isLockedOut": false,
      "lastLogin": "2026-11-11T08:41:20",
      "loginFailures": 0,
      "userName": "jsmith"
    }
  ]
}

Run heartbeat

Ask Secret Server to check now that a secret's credentials still work on the account they belong to. The result shows on the secret as its heartbeat status.

Inputs

Secretsecret_idtextRequired
The secret. Pick one, or give its id from 'Search secrets'.

Outputs

secretobject
The secret, as it is now
Example output
{
  "secret": {
    "active": true,
    "autoChangeEnabled": true,
    "checkOutEnabled": true,
    "checkOutUserId": -1,
    "checkOutUserName": "",
    "checkedOut": false,
    "createDate": "2026-10-02T14:21:07",
    "daysUntilExpiration": 21,
    "folderId": 12,
    "folderPath": "\\IT\\Servers",
    "hasLauncher": true,
    "id": 1042,
    "isOutOfSync": false,
    "isRestricted": true,
    "lastAccessed": "2026-11-10T09:15:44",
    "lastHeartBeatStatus": "Processing",
    "lastPasswordChangeAttempt": "2026-11-01T02:00:13",
    "name": "web01 local admin",
    "outOfSyncReason": "",
    "requiresApproval": false,
    "requiresComment": false,
    "secretTemplateId": 6003,
    "secretTemplateName": "Windows Account",
    "siteId": 1
  }
}

Search secrets

Find secrets by name, folder, template or heartbeat status, or only those checked out, with each one's folder, template, check-out and heartbeat state. Values aren't read.

Inputs

Search forsearch_texttext
Only those whose name contains this. Leave empty for all.
Folderfolder_idtext
Only secrets in this folder. Pick one, or give its id from 'List folders'.
Include subfoldersinclude_subfolderstrue/false
With a folder, also search the folders inside it.
Secret templatesecret_template_idtext
Only secrets of this kind.
Heartbeat statusheartbeat_statustext
Only secrets whose last heartbeat had this result.One of: Success, Failed, UnableToConnect (Unable to connect), AccountLockedOut (Account locked out), AccessDenied (Access denied), UnknownError (Unknown error), IncompatibleHost (Incompatible host), DnsMismatch (DNS mismatch), UnableToValidateServerPublicKey (Unable to validate server public key), ArgumentError (Argument error), and 3 more.
Only checked outonly_checked_outtrue/false
Only secrets someone has checked out now.
Include inactiveinclude_inactivetrue/false
Also list ones that were deleted or disabled.
Taketakenumber
How many to return, 1 to 1,000. Defaults to 50.From 1 to 1000.
Skipskipnumber
How many to skip, to read on. Use 'next_skip' from an earlier result. Defaults to 0.At least 0.

Outputs

countnumber
How many are on this page
has_moretrue/false
Whether there are more
next_skipnumber
The 'Skip' that reads the next page
secretslist
The secrets on this page
skipnumber
How many were skipped
totalnumber
How many match in all
Example output
{
  "count": 1,
  "has_more": false,
  "next_skip": 1,
  "secrets": [
    {
      "active": true,
      "autoChangeEnabled": true,
      "checkOutEnabled": true,
      "checkOutUserId": -1,
      "checkOutUserName": "",
      "checkedOut": false,
      "createDate": "2026-10-02T14:21:07",
      "daysUntilExpiration": 21,
      "folderId": 12,
      "folderPath": "\\IT\\Servers",
      "hasLauncher": true,
      "id": 1042,
      "isOutOfSync": false,
      "isRestricted": true,
      "lastAccessed": "2026-11-10T09:15:44",
      "lastHeartBeatStatus": "Success",
      "lastPasswordChangeAttempt": "2026-11-01T02:00:13",
      "name": "web01 local admin",
      "outOfSyncReason": "",
      "requiresApproval": false,
      "requiresComment": false,
      "secretTemplateId": 6003,
      "secretTemplateName": "Windows Account",
      "siteId": 1
    }
  ],
  "skip": 0,
  "total": 1
}

Update secret field

Set one field of a secret, such as its password after it was changed elsewhere, or its notes. Only Secret Server's record changes, not the account it belongs to: 'Change password' does that.

Inputs

Secretsecret_idtextRequired
The secret. Pick one, or give its id from 'Search secrets'.
FieldfieldtextRequired
The field, such as Password or Username. Pick one, or give its slug, such as password.
New valuevaluetextRequired
The field's new value.

Outputs

fieldtext
The field's slug
secret_idnumber
The secret's id
updatedtrue/false
True once Secret Server saved it
Example output
{
  "field": "notes",
  "secret_id": 1042,
  "updated": true
}

On this page