Delinea · Example Payload

Secrets

Example API requests and responses for secrets endpoints in Delinea Secret Server REST API

Privileged Access ManagementPAMSecrets ManagementIdentity SecurityDevOpsCybersecurity

Secrets is an example object payload from Delinea, with 3 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

categorydescriptionexamples

Example Payload

Raw ↑
{
  "category": "secrets",
  "description": "Example API requests and responses for secrets endpoints in Delinea Secret Server REST API",
  "examples": [
    {
      "path": "/v1/secrets/{secretId}/share",
      "method": "PATCH",
      "operationId": "SecretPermissionsService_UpdateSecretShare",
      "summary": "Update Secret share inherit",
      "requestBody": {
        "data": {}
      },
      "responseExample": {
        "inheritPermissions": true,
        "secretId": 1
      }
    },
    {
      "path": "/v1/secrets/{id}",
      "method": "PUT",
      "operationId": "SecretsService_UpdateSecret",
      "summary": "Update Secret",
      "requestBody": {
        "accessRequestWorkflowMapId": 1,
        "active": true,
        "autoChangeEnabled": true,
        "autoChangeNextPassword": "string",
        "checkOutChangePasswordEnabled": true,
        "checkOutEnabled": true,
        "checkOutIntervalMinutes": 1,
        "comment": "string"
      },
      "responseExample": {
        "accessRequestWorkflowMapId": 1,
        "active": true,
        "allowOwnersUnrestrictedSshCommands": true,
        "autoChangeEnabled": true,
        "autoChangeNextPassword": "string",
        "checkedOut": true,
        "checkOutChangePasswordEnabled": true,
        "checkOutEnabled": true
      }
    },
    {
      "path": "/v1/secrets/{id}",
      "method": "DELETE",
      "operationId": "SecretsService_Delete",
      "summary": "Deactivate a Secret",
      "responseExample": {
        "id": 1,
        "objectType": "string",
        "responseCodes": [
          {}
        ]
      }
    },
    {
      "path": "/v1/secrets/{id}/fields/{slug}/listdetails",
      "method": "GET",
      "operationId": "SecretsService_GetListFieldListDefinitions",
      "summary": "Get Secret List Field List Data",
      "responseExample": {
        "batchCount": 1,
        "currentPage": 1,
        "hasNext": true,
        "hasPrev": true,
        "nextSkip": 1,
        "pageCount": 1,
        "prevSkip": 1,
        "records": [
          {}
        ]
      }
    },
    {
      "path": "/v1/secrets/{id}/fields/{slug}/listdetails",
      "method": "PUT",
      "operationId": "SecretsService_UpdateListFieldListDefinitions",
      "summary": "Update Secret List Field List Data",
      "requestBody": {
        "listGuids": [
          {}
        ]
      },
      "responseExample": {
        "batchCount": 1,
        "currentPage": 1,
        "hasNext": true,
        "hasPrev": true,
        "nextSkip": 1,
        "pageCount": 1,
        "prevSkip": 1,
        "records": [
          {}
        ]
      }
    },
    {
      "path": "/v1/secrets/{id}/fields/{slug}/listdetails",
      "method": "DELETE",
      "operationId": "SecretsService_DeleteListFieldListDefinitions",
      "summary": "Delete Secret List Field List Data",
      "responseExample": {
        "batchCount": 1,
        "currentPage": 1,
        "hasNext": true,
        "hasPrev": true,
        "nextSkip": 1,
        "pageCount": 1,
        "prevSkip": 1,
        "records": [
          {}
        ]
      }
    },
    {
      "path": "/v2/secrets",
      "method": "GET",
      "operationId": "SecretsService_SearchV2",
      "summary": "Search Secrets",
      "responseExample": {
        "batchCount": 1,
        "currentPage": 1,
        "hasNext": true,
        "hasPrev": true,
        "nextSkip": 1,
        "pageCount": 1,
        "prevSkip": 1,
        "records": [
          {}
        ]
      }
    },
    {
      "path": "/v2/secrets/search-total",
      "method": "GET",
      "operationId": "SecretsService_SearchTotalV2",
      "summary": "Get Secret Search Total",
      "responseExample": 1
    },
    {
      "path": "/v1/secrets/lookup",
      "method": "GET",
      "operationId": "SecretsService_SearchSecretLookup",
      "summary": "Lookup Secrets with Search",
      "responseExample": {
        "batchCount": 1,
        "currentPage": 1,
        "hasNext": true,
        "hasPrev": true,
        "nextSkip": 1,
        "pageCount": 1,
        "prevSkip": 1,
        "records": [
          {}
        ]
      }
    },
    {
      "path": "/v1/secrets/lookup/{id}",
      "method": "GET",
      "operationId": "SecretsService_GetLookup",
      "summary": "Lookup Secret",
      "responseExample": {
        "id": 1,
        "value": "string"
      }
    },
    {
      "path": "/v1/secrets/stub",
      "method": "GET",
      "operationId": "SecretsService_Stub",
      "summary": "Get Secret Stub",
      "responseExample": {
        "accessRequestWorkflowMapId": 1,
        "active": true,
        "allowOwnersUnrestrictedSshCommands": true,
        "autoChangeEnabled": true,
        "autoChangeNextPassword": "string",
        "checkedOut": true,
        "checkOutChangePasswordEnabled": true,
        "checkOutEnabled": true
      }
    },
    {
      "path": "/v2/secrets/{id}",
      "method": "GET",
      "operationId": "SecretsService_GetSecretV2",
      "summary": "Get Secret",
      "responseExample": {
        "accessRequestWorkflowMapId": 1,
        "active": true,
        "allowOwnersUnrestrictedSshCommands": true,
        "autoChangeEnabled": true,
        "autoChangeNextPassword": "string",
        "checkedOut": true,
        "checkOutChangePasswordEnabled": true,
        "checkOutEnabled": true
      }
    },
    {
      "path": "/v1/secrets/{id}/preview",
      "method": "GET",
      "operationId": "SecretsService_GetSecretPreview",
      "summary": "Get Secret Preview",
      "responseExample": {
        "errorMessage": "string",
        "favorite": true,
        "hasLauncher": true,
        "id": 1,
        "isTotpEnabled": true,
        "items": [
          {}
        ],
        "launchers": [
          {}
        ],
        "secretName": "string"
      }
    },
    {
      "path": "/v1/secrets/{id}/summary",
      "method": "GET",
      "operationId": "SecretsService_GetSummary",
      "summary": "Get Secret Summary",
      "responseExample": {
        "active": true,
        "autoChangeEnabled": true,
        "checkedOut": true,
        "checkOutEnabled": true,
        "checkOutUserId": 1,
        "checkOutUserName": "string",
        "createDate": "2024-01-15T10:30:00Z",
        "daysUntilExpiration": 1
      }
    },
    {
      "path": "/v1/secrets/{id}/fields/{slug}",
      "method": "GET",
      "operationId": "SecretsService_GetField",
      "summary": "Get Secret Field",
      "responseExample": "string"
    },
    {
      "path": "/v1/secrets/{id}/fields/{slug}",
      "method": "PUT",
      "operationId": "SecretsService_PutField",
      "summary": "Update Secret Field",
      "requestBody": {
        "comment": "string",
        "doubleLockPassword": "string",
        "file": "string",
        "fileAttachment": "string",
        "fileName": "string",
        "forceCheckIn": true,
        "includeInactive": true,
        "newPassword": "string"
      },
      "responseExample": "string"
    },
    {
      "path": "/v1/secrets/{id}/fields/{slug}/list",
      "method": "GET",
      "operationId": "SecretsService_GetListField",
      "summary": "Get Secret List Field",
      "responseExample": {
        "value": [
          {}
        ]
      }
    },
    {
      "path": "/v1/secrets/favorite",
      "method": "GET",
      "operationId": "SecretsService_GetFavorites",
      "summary": "List a User's Favorite Secrets",
      "responseExample": [
        {
          "folderId": {},
          "folderPath": {},
          "id": {},
          "secretName": {}
        }
      ]
    },
    {
      "path": "/v1/secrets/{secretId}/transition-history",
      "method": "GET",
      "operationId": "SecretsService_GetSecretTransitionHistory",
      "summary": "Get secret password transition history",
      "responseExample": {
        "batchCount": 1,
        "currentPage": 1,
        "hasNext": true,
        "hasPrev": true,
        "nextSkip": 1,
        "pageCount": 1,
        "prevSkip": 1,
        "records": [
          {}
        ]
      }
    },
    {
      "path": "/v1/secrets/{id}/audits",
      "method": "GET",
      "operationId": "SecretsService_GetSecretAudits",
      "summary": "Get Secret Audits by Filter",
      "responseExample": {
        "batchCount": 1,
        "currentPage": 1,
        "hasNext": true,
        "hasPrev": true,
        "nextSkip": 1,
        "pageCount": 1,
        "prevSkip": 1,
        "records": [
          {}
        ]
      }
    },
    {
      "path": "/v1/secrets/{id}/state",
      "method": "GET",
      "operationId": "SecretsService_GetSecretState",
      "summary": "Get Secret State",
      "responseExample": {
        "actions": [
          {}
        ],
        "approvalEnd": "2024-01-15T10:30:00Z",
        "availableActions": {},
        "checkedOutUserDisplayName": "string",
        "checkedOutUserId": 1,
        "checkOutIntervalMinutes": 1,
        "checkOutMinutesRemaining": 1,
        "folderId": 1
      }
    },
    {
      "path": "/v1/secrets/secret-detail/{id}/general/{isEditMode?}/{loadReadOnlyFlags?}",
      "method": "GET",
      "operationId": "SecretsService_GetGeneral",
      "summary": "Get Secret Detail General",
      "responseExample": {
        "active": true,
        "autoChangePassword": true,
        "canGenerateSshKey": true,
        "enableInheritSecretPolicy": true,
        "expiration": "string",
        "fields": [
          {}
        ],
        "folder": 1,
        "heartbeatEnabled": true
      }
    },
    {
      "path": "/v1/secrets/{id}/settings",
      "method": "GET",
      "operationId": "SecretsService_GetSecretSettings",
      "summary": "Get Secret Settings",
      "responseExample": {
        "expirationDate": "2024-01-15T10:30:00Z",
        "expirationDayInterval": 1,
        "expirationTemplateText": "string",
        "expirationType": {},
        "jumpboxRouteSelection": {},
        "oneTimePasswordSettings": {},
        "rdpLauncherSettings": {},
        "sendEmailWhenChanged": true
      }
    },
    {
      "path": "/v1/secrets/launcher-sessions",
      "method": "GET",
      "operationId": "SecretsService_GetActiveSecretSessions",
      "summary": "Get Secret Launcher Sessions By Id",
      "responseExample": {
        "batchCount": 1,
        "currentPage": 1,
        "hasNext": true,
        "hasPrev": true,
        "nextSkip": 1,
        "pageCount": 1,
        "prevSkip": 1,
        "records": [
          {}
        ]
      }
    },
    {
      "path": "/v1/secrets/launcher-sessions",
      "method": "PATCH",
      "operationId": "SecretsService_UpdateSecretSession",
      "summary": "Update Secret Launcher Sessions",
      "requestBody": {
        "action": {},
        "message": "string",
        "secretId": 1,
        "secretSessionId": 1,
        "secretSessionKey": "string",
        "sessionGuid": "string"
      },
      "responseExample": {
        "success": true
      }
    },
    {
      "path": "/v1/secrets/{id}/ssh-restricted-commands",
      "method": "GET",
      "operationId": "SecretsService_GetSshRestrictedCommands",
      "summary": "Get SSH Command Restrictions on a Secret",
      "responseExample": {
        "commandRestrictionType": {},
        "sshCommandBlocklists": [
          {}
        ],
        "sshCommandMenus": [
          {}
        ]
      }
    },
    {
      "path": "/v2/secrets/export/job/{jobId}",
      "method": "GET",
      "operationId": "SecretsService_RetrieveSecretJobStatus",
      "summary": "Export Secrets Job Status",
      "responseExample": {
        "exportJobId": "string",
        "fileType": {},
        "status": {},
        "tracking": "string"
      }
    },
    {
      "path": "/v2/secrets/export/{jobId}/details",
      "method": "GET",
      "operationId": "SecretsService_RetrieveExportSecretsDetails",
      "summary": "Export Secrets Job Details",
      "responseExample": {
        "errors": [
          {}
        ],
        "exportJobId": "string",
        "secretsCount": 1
      }
    },
    {
      "path": "/v2/secrets/export",
      "method": "GET",
      "operationId": "SecretsService_RetrieveSecretExport",
      "summary": "Export Bulk Export Secrets",
      "responseExample": {
        "exportedSecretsFileText": "string",
        "fileType": {}
      }
    },
    {
      "path": "/v1/secrets/{id}/general",
      "method": "PATCH",
      "operationId": "SecretsService_UpdateGeneral",
      "summary": "Update Secret General Information",
      "responseExample": {
        "active": {},
        "autoChangePassword": {},
        "canGenerateSshKey": true,
        "enableInheritSecretPolicy": {},
        "expiration": {},
        "fields": [
          {}
        ],
        "folder": {},
        "heartbeatEnabled": {}
      }
    },
    {
      "path": "/v1/secrets/{id}/email",
      "method": "PATCH",
      "operationId": "SecretsService_UpdateEmail",
      "summary": "Update User Secret Email Settings",
      "responseExample": {
        "expirationDate": "2024-01-15T10:30:00Z",
        "expirationDayInterval": 1,
        "expirationTemplateText": "string",
        "expirationType": {},
        "jumpboxRouteSelection": {},
        "oneTimePasswordSettings": {},
        "rdpLauncherSettings": {},
        "sendEmailWhenChanged": true
      }
    },
    {
      "path": "/v1/secrets/{id}/security-general",
      "method": "PATCH",
      "operationId": "SecretsService_UpdateSecurity",
      "summary": "Update Secret Security General Options",
      "responseExample": {
        "allowOwnersUnrestrictedSshCommands": {},
        "approvalWorkflow": {},
        "approvalWorkflowOptions": {},
        "approvers": {},
        "availableDoubleLocks": {},
        "availableRequireApprovalTypes": {},
        "checkOutChangePasswordEnabled": {},
        "checkOutDefaultIntervalDisplay": {}
      }
    },
    {
      "path": "/v2/secrets/{id}/general",
      "method": "PATCH",
      "operationId": "SecretsService_UpdateGeneralV2",
      "summary": "Update Secret General Information",
      "responseExample": {
        "active": true,
        "autoChangePassword": true,
        "canGenerateSshKey": true,
        "enableInheritSecretPolicy": true,
        "expiration": "string",
        "fields": [
          {}
        ],
        "folder": 1,
        "heartbeatEnabled": true
      }
    },
    {
      "path": "/v2/secrets/{id}/email",
      "method": "PATCH",
      "operationId": "SecretsService_UpdateEmailV2",
      "summary": "Update User Secret Email Settings",
      "responseExample": {
        "expirationDate": "2024-01-15T10:30:00Z",
        "expirationDayInterval": 1,
        "expirationTemplateText": "string",
        "expirationType": {},
        "jumpboxRouteSelection": {},
        "oneTimePasswordSettings": {},
        "rdpLauncherSettings": {},
        "sendEmailWhenChanged": true
      }
    },
    {
      "path": "/v3/secrets/{id}/security-checkout",
      "method": "PATCH",
      "operationId": "SecretsService_UpdateSecurityCheckoutV3",
      "summary": "Update Secret Security Checkout Options",
      "requestBody": {
        "data": {}
      },
      "responseExample": {
        "model": {},
        "success": true
      }
    },
    {
      "path": "/v1/secrets/{id}/security-multifactor-authentication",
      "method": "PATCH",
      "operationId": "SecretsService_UpdateSecurityMultifactorAuthentication",
      "summary": "Update Secret Security Multifactor Authentication Options",
      "requestBody": {
        "data": {}
      },
      "responseExample": {
        "allowOwnersUnrestrictedSshCommands": true,
        "approvalWorkflow": {},
        "approvers": [
          {}
        ],
        "checkOutChangePasswordEnabled": true,
        "checkOutDefaultIntervalDisplay": "string",
        "checkOutEnabled": true,
        "checkOutIntervalDisplay": "string",
        "checkOutIntervalMinutes": 1
      }
    },
    {
      "path": "/v2/secrets/{id}/security-general",
      "method": "PATCH",
      "operationId": "SecretsService_UpdateSecurityV2",
      "summary": "Update Secret Security General Options",
      "responseExample": {
        "allowOwnersUnrestrictedSshCommands": true,
        "approvalWorkflow": {},
        "approvers": [
          {}
        ],
        "checkOutChangePasswordEnabled": true,
        "checkOutDefaultIntervalDisplay": "string",
        "checkOutEnabled": true,
        "checkOutIntervalDisplay": "string",
        "checkOutIntervalMinutes": 1
      }
    },
    {
      "path": "/v1/secrets/extended-search-details",
      "method": "POST",
      "operationId": "SecretsService_GetSecretExtendedSearchDetails",
      "summary": "Secret Search Extended Details",
      "requestBody": {
        "data": {}
      },
      "responseExample": [
        {
          "hasLaunchers": {},
          "isFavorite": {},
          "lastAccessed": {},
          "secretId": {},
          "secretName": {},
          "totalSecretViews": {}
        }
      ]
    },
    {
      "path": "/v1/secrets/{id}/restricted",
      "method": "POST",
      "operationId": "SecretsService_GetRestricted",
      "summary": "Get Restricted Secret",
      "responseExample": {
        "accessRequestWorkflowMapId": 1,
        "active": true,
        "allowOwnersUnrestrictedSshCommands": true,
        "autoChangeEnabled": true,
        "autoChangeNextPassword": "string",
        "checkedOut": true,
        "checkOutChangePasswordEnabled": true,
        "checkOutEnabled": true
      }
    },
    {
      "path": "/v1/secrets",
      "method": "POST",
      "operationId": "SecretsService_CreateSecret",
      "summary": "Create Secret",
      "requestBody": {
        "autoChangeEnabled": true,
        "changePasswordNow": true,
        "checkOutChangePasswordEnabled": true,
        "checkOutEnabled": true,
        "checkOutIntervalMinutes": 1,
        "delayIndexing": true,
        "enableInheritPermissions": true,
        "enableInheritSecretPolicy": true
      },
      "responseExample": {
        "accessRequestWorkflowMapId": 1,
        "active": true,
        "allowOwnersUnrestrictedSshCommands": true,
        "autoChangeEnabled": true,
        "autoChangeNextPassword": "string",
        "checkedOut": true,
        "checkOutChangePasswordEnabled": true,
        "checkOutEnabled": true
      }
    },
    {
      "path": "/v1/secrets/{id}/heartbeat",
      "method": "POST",
      "operationId": "SecretsService_RunHeartBeat",
      "summary": "Run Secret Heartbeat",
      "responseExample": {
        "active": true,
        "autoChangeEnabled": true,
        "checkedOut": true,
        "checkOutEnabled": true,
        "checkOutUserId": 1,
        "checkOutUserName": "string",
        "createDate": "2024-01-15T10:30:00Z",
        "daysUntilExpiration": 1
      }
    },
    {
      "path": "/v1/secrets/{id}/expire",
      "method": "POST",
      "operationId": "SecretsService_Expire",
      "summary": "Expire Secret",
      "responseExample": {
        "active": true,
        "autoChangeEnabled": true,
        "checkedOut": true,
        "checkOutEnabled": true,
        "checkOutUserId": 1,
        "checkOutUserName": "string",
        "createDate": "2024-01-15T10:30:00Z",
        "daysUntilExpiration": 1
      }
    },
    {
      "path": "/v1/secrets/{id}/change-password",
      "method": "POST",
      "operationId": "SecretsService_ChangePassword",
      "summary": "Change Secret Password",
      "requestBody": {
        "comment": "string",
        "doubleLockPassword": "string",
        "forceCheckIn": true,
        "includeInactive": true,
        "newPassword": "string",
        "noAutoCheckout": true,
        "sshKeyArgs": {},
        "ticketNumber": "string"
      },
      "responseExample": {
        "active": true,
        "autoChangeEnabled": true,
        "checkedOut": true,
        "checkOutEnabled": true,
        "checkOutUserId": 1,
        "checkOutUserName": "string",
        "createDate": "2024-01-15T10:30:00Z",
        "daysUntilExpiration": 1
      }
    },
    {
      "path": "/v1/secrets/{id}/check-in",
      "method": "POST",
      "operationId": "SecretsService_CheckIn",
      "summary": "Check In Secret",
      "responseExample": {
        "active": true,
        "autoChangeEnabled": true,
        "checkedOut": true,
        "checkOutEnabled": true,
        "checkOutUserId": 1,
        "checkOutUserName": "string",
        "createDate": "2024-01-15T10:30:00Z",
        "daysUntilExpiration": 1
      }
    },
    {
      "path": "/v1/secrets/{id}/check-out",
      "method": "POST",
      "operationId": "SecretsService_CheckOut",
      "summary": "Check Out Secret",
      "responseExample": {
        "responseCodes": [
          {}
        ]
      }
    },
    {
      "path": "/v1/secrets/{id}/extend-check-out",
      "method": "POST",
      "operationId": "SecretsService_ExtendCheckOut",
      "summary": "Extend Check Out",
      "requestBody": {
        "data": {}
      },
      "responseExample": {
        "checkOutEndTime": "2024-01-15T10:30:00Z"
      }
    },
    {
      "path": "/v1/secrets/{id}/restricted/fields/{slug}",
      "method": "POST",
      "operationId": "SecretsService_RestrictedField",
      "summary": "Get Restricted Secret Field",
      "responseExample": "string"
    },
    {
      "path": "/v1/secrets/rdpproxy",
      "method": "POST",
      "operationId": "SecretsService_GetSecretRdpProxyInfo",
      "summary": "Get RDP Proxy Information",
      "responseExample": {
        "domain": "string",
        "host": "string",
        "password": "string",
        "username": "string"
      }
    },
    {
      "path": "/v1/secrets/sshproxy",
      "method": "POST",
      "operationId": "SecretsService_GetSecretSshProxyInfo",
      "summary": "Get SSH Proxy Information",
      "responseExample": {
        "host": "string",
        "password": "string",
        "port": 1,
        "username": "string"
      }
    },
    {
      "path": "/v1/secrets/sshterminal",
      "method": "POST",
      "operationId": "SecretsService_GetSecretSshTerminalDetails",
      "summary": "Get SSH Terminal Details",
      "requestBody": {
        "secretId": 1
      },
      "responseExample": {
        "host": "string",
        "port": 1,
        "secretId": 1,
        "username": "string"
      }
    },
    {
      "path": "/v1/secrets/{secretId}/favorite",
      "method": "POST",
      "operationId": "SecretsService_Favorite",
      "summary": "Favorite a Secret",
      "requestBody": {
        "isFavorite": true
      },
      "responseExample": true
    },
    {
      "path": "/v1/secrets/{id}/stop-password-change",
      "method": "POST",
      "operationId": "SecretsService_StopPasswordChange",
      "summary": "Attempt to stop a password change",
      "responseExample": {
        "success": true
      }
    },
    {
      "path": "/v1/secrets/convert-template",
      "method": "POST",
      "operationId": "SecretsService_ConvertTemplate",
      "summary": "Convert Secret Template",
      "requestBody": {
        "data": {}
      },
      "responseExample": {
        "secretId": 1,
        "taskId": "string"
      }
    },
    {
      "path": "/v1/secrets/get-convert-info",
      "method": "POST",
      "operationId": "SecretsService_GetConvertInfo",
      "summary": "Get Convert Template Information",
      "requestBody": {
        "data": {}
      },
      "responseExample": {
        "destination": {},
        "source": {}
      }
    },
    {
      "path": "/v1/secrets/export",
      "method": "POST",
      "operationId": "SecretsService_ExportSecrets",
      "summary": "Export Secrets",
      "responseExample": {
        "errors": [
          {}
        ],
        "exportedSecretsFileText": "string",
        "fileType": {},
        "secretsCount": 1
      }
    },
    {
      "path": "/v2/secrets/export/job",
      "method": "POST",
      "operationId": "SecretsService_ExportSecretJob",
      "summary": "Export Secrets File Job Creation",
      "responseExample": {
        "exportJobId": "string",
        "fileType": {},
        "status": {},
        "tracking": "string"
      }
    },
    {
      "path": "/v1/secrets/{id}/rpc-script-secrets",
      "method": "PUT",
      "operationId": "SecretsService_UpdateRpcScriptSecrets",
      "summary": "Update which Secrets are available for RPC scripts",
      "responseExample": {
        "autoChangeEnabled": true,
        "autoChangeSchedule": {},
        "canEnterNextPassword": true,
        "expireText": "string",
        "hasNextPassphrase": true,
        "hasNextPassword": true,
        "hasNextPrivateKey": true,
        "isValidForSshKeyRpc": true
      }
    },
    {
      "path": "/v1/secrets/{id}/activate",
      "method": "PUT",
      "operationId": "SecretsService_UndeleteSecret",
      "summary": "Undelete a Secret",
      "responseExample": {
        "active": true,
        "autoChangePassword": true,
        "canGenerateSshKey": true,
        "enableInheritSecretPolicy": true,
        "expiration": "string",
        "fields": [
          {}
        ],
        "folder": 1,
        "heartbeatEnabled": true
      }
    },
    {
      "path": "/v2/secrets/{id}/rpc-script-secrets",
      "method": "PUT",
      "operationId": "SecretsService_UpdateRpcScriptSecretsV2",
      "summary": "Update which Secrets are available for RPC scripts",
      "responseExample": {
        "autoChangeEnabled": true,
        "autoChangeSchedule": {},
        "canEnterNextPassword": true,
        "expireText": "string",
        "hasNextPassphrase": true,
        "hasNextPassword": true,
        "hasNextPrivateKey": true,
        "isValidForSshKeyRpc": true
      }
    },
    {
      "path": "/v3/secrets/{id}/security-approval",
      "method": "PUT",
      "operationId": "SecretsService_UpdateSecurityApprovalV3",
      "summary": "Update Secret Security Approval Options",
      "requestBody": {
        "data": {}
      },
      "responseExample": {
        "model": {},
        "success": true
      }
    },
    {
      "path": "/v2/secrets/{id}/activate",
      "method": "PUT",
      "operationId": "SecretsService_UndeleteSecretV2",
      "summary": "Undelete a Secret",
      "responseExample": {
        "active": true,
        "autoChangePassword": true,
        "canGenerateSshKey": true,
        "enableInheritSecretPolicy": true,
        "expiration": "string",
        "fields": [
          {}
        ],
        "folder": 1,
        "heartbeatEnabled": true
      }
    },
    {
      "path": "/v1/secrets/{id}/expiration",
      "method": "PUT",
      "operationId": "SecretsService_UpdateExpiration",
      "summary": "Update a Secret expiration",
      "requestBody": {
        "data": {}
      },
      "responseExample": {
        "expirationDate": "2024-01-15T10:30:00Z",
        "expirationDayInterval": 1,
        "expirationTemplateText": "string",
        "expirationType": {},
        "jumpboxRouteSelection": {},
        "oneTimePasswordSettings": {},
        "rdpLauncherSettings": {},
        "sendEmailWhenChanged": true
      }
    },
    {
      "path": "/v1/secrets/{secretId}/update-ssh-restricted-commands",
      "method": "PUT",
      "operationId": "SecretsService_UpdateSshRestrictedCommands",
      "summary": "Update Restricted SSH Commands on a Secret",
      "requestBody": {
        "data": {}
      },
      "responseExample": true
    }
  ]
}

Work with this as data

Every example here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for examples

4 MCP tools reach this
  • find_examplesBrowse and filter every example in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This example
curl "https://apis.io/api/v1/examples/secrets"
All examples
curl "https://apis.io/api/v1/examples?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.