Delinea Secrets API
View and maintain Secrets
Delinea Secrets API is one of 102 APIs that Delinea publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Secrets. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 63 operations across 58 paths, and defines 161 schemas. It is described by OpenAPI 3.0.0, at version 11.7.2.
Requests are made against a single base URL, /SecretServer/api.
63 operations
58 paths
161 schemas
2 DELETE22 GET9 PATCH19 POST11 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Delinea Secrets API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Authorization (BearerToken).
By default, every request must be authenticated.
BearerToken— Perform a POST request to /oauth2/token. It should include three form data parameters - username, password, and granttype.The granttype parameter should always…
Paths & Operations 63
Across 58 paths, the API surfaces 63 operations — 2 DELETE, 22 GET, 9 PATCH, 19 POST, 11 PUT. Each is listed below with its method, path, parameters, and response codes.
Secrets 63
View and maintain Secrets
PUT
/v1/secrets/{id}
Update Secret
DELETE
/v1/secrets/{id}
Deactivate a Secret
GET
/v1/secrets/{id}/fields/{slug}/listdetails
Get Secret List Field List Data
PUT
/v1/secrets/{id}/fields/{slug}/listdetails
Update Secret List Field List Data
DELETE
/v1/secrets/{id}/fields/{slug}/listdetails
Delete Secret List Field List Data
GET
/v2/secrets
Search Secrets
GET
/v2/secrets/search-total
Get Secret Search Total
GET
/v1/secrets/lookup
Lookup Secrets with Search
GET
/v1/secrets/lookup/{id}
Lookup Secret
GET
/v1/secrets/stub
Get Secret Stub
GET
/v2/secrets/{id}
Get Secret
GET
/v1/secrets/{id}/preview
Get Secret Preview
GET
/v1/secrets/{id}/summary
Get Secret Summary
GET
/v1/secrets/{id}/fields/{slug}
Get Secret Field
PUT
/v1/secrets/{id}/fields/{slug}
Update Secret Field
GET
/v1/secrets/{id}/fields/{slug}/list
Get Secret List Field
GET
/v1/secrets/favorite
List a User's Favorite Secrets
GET
/v1/secrets/{secretId}/transition-history
Get secret password transition history
GET
/v1/secrets/{id}/audits
Get Secret Audits by Filter
GET
/v1/secrets/{id}/state
Get Secret State
GET
/v1/secrets/secret-detail/{id}/general/{isEditMode?}/{loadReadOnlyFlags?}
Get Secret Detail General
GET
/v1/secrets/{id}/settings
Get Secret Settings
GET
/v1/secrets/launcher-sessions
Get Secret Launcher Sessions By Id
PATCH
/v1/secrets/launcher-sessions
Update Secret Launcher Sessions
GET
/v1/secrets/{id}/ssh-restricted-commands
Get SSH Command Restrictions on a Secret
GET
/v2/secrets/export/job/{jobId}
Export Secrets Job Status
GET
/v2/secrets/export/{jobId}/details
Export Secrets Job Details
GET
/v2/secrets/export
Export Bulk Export Secrets
PATCH
/v1/secrets/{id}/general
Update Secret General Information
PATCH
/v1/secrets/{id}/email
Update User Secret Email Settings
PATCH
/v1/secrets/{id}/security-general
Update Secret Security General Options
PATCH
/v2/secrets/{id}/general
Update Secret General Information
PATCH
/v2/secrets/{id}/email
Update User Secret Email Settings
PATCH
/v3/secrets/{id}/security-checkout
Update Secret Security Checkout Options
PATCH
/v1/secrets/{id}/security-multifactor-authentication
Update Secret Security Multifactor Authentication Options
PATCH
/v2/secrets/{id}/security-general
Update Secret Security General Options
POST
/v1/secrets/extended-search-details
Secret Search Extended Details
POST
/v1/secrets/{id}/restricted
Get Restricted Secret
POST
/v1/secrets
Create Secret
POST
/v1/secrets/{id}/heartbeat
Run Secret Heartbeat
POST
/v1/secrets/{id}/expire
Expire Secret
POST
/v1/secrets/{id}/change-password
Change Secret Password
POST
/v1/secrets/{id}/check-in
Check In Secret
POST
/v1/secrets/{id}/check-out
Check Out Secret
POST
/v1/secrets/{id}/extend-check-out
Extend Check Out
POST
/v1/secrets/{id}/restricted/fields/{slug}
Get Restricted Secret Field
POST
/v1/secrets/rdpproxy
Get RDP Proxy Information
POST
/v1/secrets/sshproxy
Get SSH Proxy Information
POST
/v1/secrets/sshterminal
Get SSH Terminal Details
POST
/v1/secrets/{secretId}/favorite
Favorite a Secret
POST
/v1/secrets/{id}/stop-password-change
Attempt to stop a password change
POST
/v1/secrets/convert-template
Convert Secret Template
POST
/v1/secrets/get-convert-info
Get Convert Template Information
POST
/v1/secrets/export
Export Secrets
POST
/v2/secrets/export/job
Export Secrets File Job Creation
PUT
/v1/secrets/{id}/rpc-script-secrets
Update which Secrets are available for RPC scripts
PUT
/v1/secrets/{id}/activate
Undelete a Secret
PUT
/v2/secrets/{id}/rpc-script-secrets
Update which Secrets are available for RPC scripts
PUT
/v3/secrets/{id}/security-approval
Update Secret Security Approval Options
PUT
/v2/secrets/{id}/activate
Undelete a Secret
PUT
/v1/secrets/{id}/expiration
Update a Secret expiration
PUT
/v1/secrets/{secretId}/update-ssh-restricted-commands
Update Restricted SSH Commands on a Secret
PUT
/v1/secret-detail/{secretId}/jumpbox-route-selection
Update Jumpbox Route Selection
Schemas 161
The contract defines 161 schemas that model the data the API accepts and returns. The most detailed are SecretModel (41 properties), SecretModelV2 (41 properties), SecretUpdateArgs (30 properties), SecretSummary (29 properties). Each schema is shown below with its type and property counts.
SecretDetailSecurityMultifactorUpdateModel
object
Secret Security Multifactor Authentication Update
1 property
SecretDetailSettingsModel
object
Secret Detail Settings
11 properties
HeartbeatStatus
string
Current status of heartbeat
SortDirection
string
Sort direction
SecretSshProxyModel
object
SecretSshProxyModel
4 properties
ConvertTemplateFieldModel
object
A secret field mapping for conversion
3 properties
SecretResponseCodeModel
object
SecretResponseCodeModel
1 property
UpdateFieldValueOfOptionalDateTime
object
Update when the pinned folder was last viewed
2 properties
UpdateFieldValueOfInt32Array
object
FolderIds
2 properties
SecretDetailPasswordStatus
object
Password Status
6 properties
UpdateFieldValueOfOptionalInt32
object
The minimum length required for local user passwords
2 properties
SecretDetailRpcScriptSecretsUpdateModel
object
Secrets available for RPC Scripts
1 property
SecretDetailSshCommandUpdateData
object
Secret SSH Command Data
5 properties
ViewFieldValueOfOptionalDateTime
object
Time of last heartbeat check
17 properties
SecretDetailRpcModel
object
Secret Detail RPC
15 properties
ConvertTemplateDetailsModel
object
ConvertTemplateDetailsModel
2 properties
SecretDetailRestrictedSshCommandViewModel
object
SecretDetailRestrictedSshCommandViewModel
3 properties
ViewFieldLink
object
AdditionalLinks
3 properties
DeletedModel
object
Information about an object that was deleted
3 properties
SecretRdpProxyModel
object
SecretRdpProxyModel
4 properties
SecretModel
object
Secret
41 properties
ViewFieldValueReadOnlyOfViewTemplateFieldDropDownOptionArray
object
AvailableDoubleLocks
17 properties
ExportSecretsModel
object
Data
9 properties
ViewFieldValueOfBoolean
object
When enabled, the log will be able to be viewed online
17 properties
SecretDetailGeneralModel
object
Secret Detail General
24 properties
SecretDetailStateActionsModel
object
Available Secret Detail State Actions
1 property
SecretDetailSshRestrictedCommandUpdateArgs
object
Update Secret SSH Command Arguments
1 property
UpdateFieldValueOfOptionalSecretDetailApprovalType
object
Approval Type
2 properties
SecretRestrictedArgs
object
Restricted secret update options
8 properties
SecretDetailRestrictedSshCommandMenuViewModel
object
Allowed menus
4 properties
SecretDetailConvertTemplateArgs
object
Wrapper around secret template conversion arguments
1 property
FavoriteSecretArgs
object
Arguments to favorite a secret.
1 property
CommandRestrictionType
string
Command restriction type (AllowedMenu, Blocklist)
SecretDetailJumpboxUpdateArgs
object
SecretDetailJumpboxUpdateArgs
1 property
PagingOfSecretTransitionHistorySummaryModel
object
Specify paging and sorting options for querying records and returning results
14 properties
SshKeyArgs
object
SSH key options
2 properties
Sort
object
Sort options. Multiple sort options can be provided in the query string.
3 properties
2 required
SecretSearchExtendedSummary
object
SecretSearchExtendedSummary[]
6 properties
UpdateFieldValueOfBoolean
object
Active
2 properties
SshRunLauncherType
string
Launcher Type
SecretDetailRestrictedSshCommandBlocklistViewModel
object
Blocklists
4 properties
SecretLauncherSessionSummary
object
Secret Launcher Session Summary
7 properties
SecretPasswordComplianceCode
string
Indicates if the password meets the password compliance rules setup for the secret template.
ConvertTemplateSourceModel
object
Source
3 properties
SiteModel
object
Site Model
3 properties
ViewFieldValueOfString
object
GeneratedToken
17 properties
PagingOfSecretSummary
object
Specify paging and sorting options for querying records and returning results
14 properties
SecretSecurityUpdateResponse
object
Response to indicate if the Secret security settings saved properly. If you still have access to the model the updated model will be returned. If checkout is n…
2 properties
SecretLauncherSessionActionResult
object
Secret Launcher Session Action Result
1 property
BadRequestResponse
object
Response object for invalid requests
4 properties
1 required
SecretItemUpdateArgs
object
Secret field update options
12 properties
SecretDetailSecurityGeneralUpdateModel
object
Secret General Information Update
7 properties
SecretDetailGeneralViewModel
object
Secret Detail General View Model
24 properties
ExportSecretsArgs
object
ExportSecretsArgs
1 property
SecretFieldType
string
Type
SecretLauncherSessionArgs
object
Secret Launcher Session Args
6 properties
DashboardViewSecretItem
object
items
14 properties
ConvertTemplateDetailFieldModel
object
Fields
3 properties
ViewFieldValueOfCommandRestrictionType
object
CommandRestrictionType
17 properties
SecretListFieldListArgs
object
Secret List Field List Args
1 property
ExportSecretsJobResultModel
object
ExportSecretsJobResultModel
4 properties
ExportSecretsExportJobDetails
object
ExportSecretsExportJobDetails
3 properties
AuthenticationFailedResponse
object
Response object for authentication failures
1 property
1 required
SecretDetailGeneralUpdateModel
object
Secret General Settings Update
11 properties
SecretDetailUpdateSecurityCheckoutArgs
object
Secret Security Checkout Message
1 property
SecretDetailActionType
string
Secret Detail Action Type
ViewFieldValueOfWorkflowTemplate
object
ApprovalWorkflow
17 properties
ViewFieldValueOfWorkflowTemplateArray
object
ApprovalWorkflowOptions
17 properties
SecretDetailUpdateGeneralArgs
object
Secret General Settings Update Message
1 property
SecretDetailUpdateSecurityApprovalArgs
object
Secret Update Security Approval Message
1 property
WorkflowType
string
WorkflowType
PagingOfCategorizedListSummary
object
Specify paging and sorting options for querying records and returning results
14 properties
UpdateFieldValueOfString
object
Description
2 properties
ViewFieldValueOfSecretDetailApprovalType
object
RequireApprovalType
17 properties
SecretCheckOutExtensionResponseModel
object
SecretCheckOutExtensionResponseModel
1 property
SecretAuditModel
object
Secret Audit Model
15 properties
JumpboxRouteSummaryModel
object
Query results
4 properties
Severity
string
Error severity level
SecretCreateArgs
object
Secret create options
21 properties
3 required
SecretDetailStateViewModel
object
Secret Detail State View Model
21 properties
PagingOfSecretLauncherSessionSummary
object
Specify paging and sorting options for querying records and returning results
14 properties
ConvertTemplateDestinationModel
object
Destination
1 property
SecretUpdateArgs
object
Secret update options
30 properties
3 required
UpdateFieldValueOfInt32
object
How many days until the password expires.
2 properties
SecretDetailSecurityViewModel
object
SecretDetailSecurityViewModel
26 properties
SecretDetailStopPasswordResultModel
object
SecretDetailStopPasswordResultModel
1 property
SecretSshTerminalModel
object
SecretSshTerminalModel
4 properties
SshLauncherSettingsModel
object
SSH Launcher Settings
5 properties
OneTimePasswordSettingsModel
object
One Time Password Settings
5 properties
SecretDetailExpirationType
string
Expiration Type
SecretDetailUpdateRpcScriptSecretsArgs
object
RPC Script Update Message
1 property
DashboardViewLauncherInfo
object
launchers
15 properties
ViewTemplateFieldOfString
object
Fields
22 properties
ConvertTemplateInfoModel
object
Define which secrets are being converted to what template type
2 properties
SecretDetailLauncher
object
Launchers
6 properties
SecretDetailExpirationUpdateModel
object
Data
3 properties
SecretModelV2
object
Secret V2
41 properties
ViewTemplateFieldDropDownOption
object
DropDownOptions
3 properties
SecretDetailSecurityCheckoutUpdateModel
object
Secret Security Checkout Update
3 properties
PagingOfSecretAuditModel
object
Specify paging and sorting options for querying records and returning results
14 properties
SecretChangePasswordArgs
object
Secret password change options
9 properties
SecretSearchExtendedArgs
object
SecretSearchExtendedArgs
1 property
ExportSecretsResultModelV2
object
ExportSecretsResultModelV2
2 properties
WidgetSecretModel
object
WidgetSecretModel[]
4 properties
SecretFieldListType
string
The type of list. Valid values are “None”, “Generic”, and “URL”.
CategorizedListSummary
object
Query results
5 properties
SecretsExportResultModel
object
SecretsExportResultModel
4 properties
SecretDetailUpdateExpirationArgs
object
SecretDetailUpdateExpirationArgs
1 property
SecretDetailScheduleModel
object
Secret Detail Autochange Schedule
18 properties
ViewFieldValueOfInt32
object
OrganizationId
17 properties
SecretDetailUpdateSecurityGeneralArgs
object
Secret General Information Update Message
1 property
SecretSearchExtendedData
object
Data
1 property
SecretSshTerminalArgs
object
Arguments to load the SSH proxy credentials
1 property
SecretExportErrorModel
object
Secret Export Errors
2 properties
UpdateTemplateFieldOfString
object
Update Secret Template Field
3 properties
ExportSecretJobStatus
string
Export Job Status
SecretDetailEmailUpdateModel
object
Secret Email User Settings
3 properties
SecretDetailUpdateSecurityMultifactorArgs
object
Secret Security Multifactor Authentication Options
1 property
CategorizedListItemValueResult
object
CategorizedListItemValueResult
1 property
SecretDetailExpirationUpdateType
string
Value
ViewFieldValueOfOptionalInt32
object
Maximum number of messages to keep in log. When null, it is unlimited
17 properties
SecretCheckOutExtensionModel
object
Secret Check Out Extension Model
2 properties
YesNoPreferenceOption
string
Allow Clipboard
ConvertTemplateActionModel
object
Secret template conversion model
6 properties
SecretDetailConvertTemplateInfoArgs
object
Get information used to convert a secret to a different template
1 property
SecretDetailSecurityModel
object
Secret Detail Security
22 properties
ICategorizedListItemValue
object
The restricted hosts.
2 properties
SecretProxyArgs
object
Arguments to load the proxy credentials
4 properties
SessionActions
string
Action To Take
InternalServerErrorResponse
object
Response object for internal server errors
4 properties
4 required
SecretDetailSecurityPasswordRequirements
object
PasswordRequirements
3 properties
SecretDetailHeartbeatStatus
string
Current status of heartbeat
SecretDetailApprovalType
string
Secret Security Approval Type
ViewFieldValueOfSecretDetailHeartbeatStatus
object
Current status of heartbeat
17 properties
SecretDetailRestrictedSshCommandBlocklistPermissionUpdateModel
object
Secret Detail SSH Command Blocklist Permission Update Model
2 properties
ISecretSummaryExtendedField
object
Any requested extended fields from a lookup request
2 properties
SecretCheckOutExtensionArgs
object
Secret Check Out Extension Args
1 property
ExportFileType
string
Export Job File Type
ViewFieldValueReadOnlyOfString
object
Name of the Secret.
17 properties
SecretDetailSecurityApprovalUpdateModel
object
Secret Security Approval Update
3 properties
UpdateFieldValueOfOptionalBoolean
object
Use RADIUS Username for DUO
2 properties
PasswordChangeResult
string
Status
SecretLookup
object
Simple secret representation
2 properties
SecretDetailRestrictedSshCommandMenuPermissionUpdateModel
object
Secret Detail SSH Command Menu Permission Update Model
2 properties
UpdateFieldValueOfSecretDetailExpirationUpdateType
object
ExpirationType
2 properties
RestSecretItem
object
Secret data field item
13 properties
SecretDetailUserViewModel
object
Value
3 properties
SecretTransitionHistorySummaryModel
object
Query results
2 properties
SecretDetailSecurityPasswordRequirement
object
Requirements
5 properties
WorkflowTemplate
object
Value
9 properties
RotateSshKeyArgs
object
SSH key rotation options
4 properties
DashboardViewSecret
object
DashboardViewSecret
13 properties
SecretSummary
object
Secret summary
29 properties
SecretDetailConvertTemplateModel
object
SecretDetailConvertTemplateModel
2 properties
SecretDetailUpdateEmailArgs
object
Secret User Email Update Message
1 property
SecretDetailRpcSecrets
object
Reset Secrets
5 properties
ViewFieldValueOfSecretDetailUserViewModelArray
object
Approvers
17 properties
RdpLauncherSettingsModel
object
RDP Launcher Settings
8 properties
SecretAccessRequired
string
Secret Access Required
PagingOfSecretLookup
object
Specify paging and sorting options for querying records and returning results
14 properties
ViewFieldValueOfSecretDetailApprovalTypeArray
object
AvailableRequireApprovalTypes
17 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Delinea 12
Other APIs Delinea publishes across the network.
Secret Server REST API
DevOps Secrets Vault API
Delinea Platform API
Delinea Activations API
Delinea ActiveDirectory API
Delinea AdvancedConfigSettings API
Delinea ApiToken API
Delinea AppClients API
Delinea ApplicationAccounts API
Delinea ApplicationRequest API
Delinea AppState API
Delinea BulkOperations API
#Secrets
Where this information came from
This is an independent, third-party profile of Delinea Secrets API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.