{ "opencollection": "1.0.0", "info": { "name": "Secret Server Rest Activations Secrets API", "version": "11.7.2" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "Secrets", "type": "folder" }, "items": [ { "info": { "name": "Update Secret", "type": "http" }, "http": { "method": "PUT", "url": "/SecretServer/api/v1/secrets/:id", "params": [ { "name": "autoCheckIn", "value": "", "type": "query", "description": "Automatically check in a secret after finding or updating." }, { "name": "autoCheckout", "value": "", "type": "query", "description": "Automatically check out secret before finding or updating." }, { "name": "autoComment", "value": "", "type": "query", "description": "Leave a comment when checking in or out." }, { "name": "forceCheckIn", "value": "", "type": "query", "description": "If secret is checked out, then force a check in." }, { "name": "id", "value": "", "type": "path", "description": "Secret ID" }, { "name": "secretPath", "value": "", "type": "query", "description": "A full path including folder and secret name can be passed as a query string parameter when the secret ID is set to 0. This will lookup the secret ID by path." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a single secret by ID" }, { "info": { "name": "Deactivate a Secret", "type": "http" }, "http": { "method": "DELETE", "url": "/SecretServer/api/v1/secrets/:id", "params": [ { "name": "autoCheckIn", "value": "", "type": "query", "description": "Automatically check in a secret after finding or updating." }, { "name": "autoCheckout", "value": "", "type": "query", "description": "Automatically check out secret before finding or updating." }, { "name": "autoComment", "value": "", "type": "query", "description": "Leave a comment when checking in or out." }, { "name": "forceCheckIn", "value": "", "type": "query", "description": "If secret is checked out, then force a check in." }, { "name": "id", "value": "", "type": "path", "description": "Secret ID" }, { "name": "secretPath", "value": "", "type": "query", "description": "A full path including folder and secret name can be passed as a query string parameter when the secret ID is set to 0. This will lookup the secret ID by path." } ] }, "docs": "A deactivated secret is hidden from users who do not have a role containing the View Inactive Secrets permission. Secret Server uses these \"soft deletes\" to maintain the audit history for all data. However, deactivated secrets are still accessible by administrators (like a permanent Recycle Bin) to ensure that audit history is maintained and to support recovery. A user must have the \"View Inactive Secrets\" permission in addition to Owner permission on a secret to access the secret View page for " }, { "info": { "name": "Get Secret List Field List Data", "type": "http" }, "http": { "method": "GET", "url": "/SecretServer/api/v1/secrets/:id/fields/:slug/listdetails", "params": [ { "name": "autoCheckIn", "value": "", "type": "query", "description": "Automatically check in a secret after finding or updating." }, { "name": "autoCheckout", "value": "", "type": "query", "description": "Automatically check out secret before finding or updating." }, { "name": "autoComment", "value": "", "type": "query", "description": "Leave a comment when checking in or out." }, { "name": "forceCheckIn", "value": "", "type": "query", "description": "If secret is checked out, then force a check in." }, { "name": "id", "value": "", "type": "path", "description": "Secret ID" }, { "name": "skip", "value": "", "type": "query", "description": "Number of records to skip before taking results" }, { "name": "sortBy[0].direction", "value": "", "type": "query", "description": "Sort direction" }, { "name": "sortBy[0].name", "value": "", "type": "query", "description": "Sort field name" }, { "name": "sortBy[0].priority", "value": "", "type": "query", "description": "Priority index. Sorts with lower values are executed earlier" }, { "name": "take", "value": "", "type": "query", "description": "Maximum number of records to include in results" }, { "name": "slug", "value": "", "type": "path", "description": "The field slug name of the list field. This is the fieldSlugName property of the SecretField object. By default, it is the lower-case field name with all spaces replaced with dashes (-)." } ] }, "docs": "Get the lists associated to a secret list data field" }, { "info": { "name": "Update Secret List Field List Data", "type": "http" }, "http": { "method": "PUT", "url": "/SecretServer/api/v1/secrets/:id/fields/:slug/listdetails", "params": [ { "name": "autoCheckIn", "value": "", "type": "query", "description": "Automatically check in a secret after finding or updating." }, { "name": "autoCheckout", "value": "", "type": "query", "description": "Automatically check out secret before finding or updating." }, { "name": "autoComment", "value": "", "type": "query", "description": "Leave a comment when checking in or out." }, { "name": "forceCheckIn", "value": "", "type": "query", "description": "If secret is checked out, then force a check in." }, { "name": "id", "value": "", "type": "path", "description": "Secret ID" }, { "name": "slug", "value": "", "type": "path", "description": "Secret field name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the lists associated to a secret list data field" }, { "info": { "name": "Delete Secret List Field List Data", "type": "http" }, "http": { "method": "DELETE", "url": "/SecretServer/api/v1/secrets/:id/fields/:slug/listdetails", "params": [ { "name": "autoCheckIn", "value": "", "type": "query", "description": "Automatically check in a secret after finding or updating." }, { "name": "autoCheckout", "value": "", "type": "query", "description": "Automatically check out secret before finding or updating." }, { "name": "autoComment", "value": "", "type": "query", "description": "Leave a comment when checking in or out." }, { "name": "forceCheckIn", "value": "", "type": "query", "description": "If secret is checked out, then force a check in." }, { "name": "id", "value": "", "type": "path", "description": "Secret ID" }, { "name": "listGuid", "value": "", "type": "query", "description": "Secret options" }, { "name": "slug", "value": "", "type": "path", "description": "Secret field name" } ] }, "docs": "Deletes the lists associated to a secret list data field" }, { "info": { "name": "Search Secrets", "type": "http" }, "http": { "method": "GET", "url": "/SecretServer/api/v2/secrets", "params": [ { "name": "filter.allowDoubleLocks", "value": "", "type": "query", "description": "Whether to allow DoubleLocks as part of the search. True by default." }, { "name": "filter.doNotCalculateTotal", "value": "", "type": "query", "description": "Whether to return the total number of secrets matching the filters. False by default. If false, the total can be retrieved separately by calling /v1/secrets/search-total with the same arguments used in the search." }, { "name": "filter.doubleLockId", "value": "", "type": "query", "description": "Only include Secrets with this DoubleLock ID assigned in the search results." }, { "name": "filter.extendedFields", "value": "", "type": "query", "description": "An array of names of Secret Template fields to return. Only exposed fields can be returned. This parameter will be ignored if ExtFieldsCombined is sent." }, { "name": "filter.extendedTypeId", "value": "", "type": "query", "description": "If not null, return only secrets matching the specified extended mapping type as defined on the secret’s template." }, { "name": "filter.extFieldsCombined", "value": "", "type": "query", "description": "A comma delimited list of all extended fields to return. All fields must be marked as exposed for display. When populated this value will be used instead of ExtendedFields[]. Combining the fields decreases the size of the GET URL to avoid the 2048 character length restriction in IIS." }, { "name": "filter.folderId", "value": "", "type": "query", "description": "If not null, returns only secrets within the specified folder." }, { "name": "filter.hasLauncher", "value": "", "type": "query", "description": "Whether to only return secrets with or without launchers. If null, returns secrets regardless of whether they have launchers." }, { "name": "filter.heartbeatStatus", "value": "", "type": "query", "description": "If not null, returns only secrets with a certain heartbeat status." }, { "name": "filter.includeActive", "value": "", "type": "query", "description": "Whether to include active secrets in results (when excluded equals true)." }, { "name": "filter.includeInactive", "value": "", "type": "query", "description": "Whether to include inactive secrets in results." }, { "name": "filter.includeRestricted", "value": "", "type": "query", "description": "Whether to include restricted secrets in results. Restricted secrets are secrets that are DoubleLocked, require approval, or require a comment to view." }, { "name": "filter.includeSubFolders", "value": "", "type": "query", "description": "Whether to include secrets in subfolders of the specified folder." }, { "name": "filter.isExactMatch", "value": "", "type": "query", "description": "Whether to do an exact match of the search text or a partial match. If an exact match, the entire secret name, field value, or list option in a list field must match the search text." }, { "name": "filter.onlyCheckedOutSecrets", "value": "", "type": "query", "description": "Whether to only return secrets that are or are not checked out. If null, returns secrets regardless of whether they are checked out." }, { "name": "filter.onlyRPCEnabled", "value": "", "type": "query", "description": "Whether to only include secrets whose template has Remote Password Changing enabled." }, { "name": "filter.onlySecretsCheckedOutByUser", "value": "", "type": "query", "description": "Whether to only return secrets that are or are not checked out by the querying user. If null, returns secrets regardless of whether they are checked out." }, { "name": "filter.onlySharedWithMe", "value": "", "type": "query", "description": "When true only Secrets where you are not the owner and the Secret was shared explicitly with your user id will be returned." }, { "name": "filter.passwordTypeIds", "value": "", "type": "query", "description": "If not null, returns only secrets matching the specified password types." }, { "name": "filter.permissionRequired", "value": "", "type": "query", "description": "Specify whether to filter by List, View, Edit, or Owner permission. Default is List." }, { "name": "filter.scope", "value": "", "type": "query", "description": "Specify whether to search All, Recent, or Favorites" }, { "name": "filter.searchField", "value": "", "type": "query", "description": "If set, restricts the search to only match secrets where the value of the field specified by name contains the search text." }, { "name": "filter.searchFieldSlug", "value": "", "type": "query", "description": "If set, restricts the search to only match secrets where the value of the field specified by the slug name contains the search text. This will override SearchField." }, { "name": "filter.searchText", "value": "", "type": "query", "description": "The text to match in the secret name, field value, or list field contents." }, { "name": "filter.secretIds", "value": "", "type": "query", "description": "If not null or empty, returns only secrets matching the specified secret ids." }, { "name": "filter.secretTemplateIds", "value": "", "type": "query", "description": "If not null or empty, returns only secrets matching the specified templates." }, { "name": "filter.secretTemplateIdsCombined", "value": "", "type": "query", "description": "A comma delimited list of all secret template IDs. When populated this value will be used instead of SecretTemplateIds[]. Combining the fields decreases the size of the GET URL to avoid the 2048 character length restriction in IIS." }, { "name": "filter.siteId", "value": "", "type": "query", "description": "If not null, returns only secrets within a the specified site." }, { "name": "skip", "value": "", "type": "query", "description": "Number of records to skip before taking results" }, { "name": "sortBy[0].direction", "value": "", "type": "query", "description": "Sort direction" }, { "name": "sortBy[0].name", "value": "", "type": "query", "description": "Sort field name" }, { "name": "sortBy[0].priority", "value": "", "type": "query", "description": "Priority index. Sorts with lower values are executed earlier" }, { "name": "take", "value": "", "type": "query", "description": "Maximum number of records to include in results" } ] }, "docs": "Search, filter, sort, and page secrets" }, { "info": { "name": "Get Secret Search Total", "type": "http" }, "http": { "method": "GET", "url": "/SecretServer/api/v2/secrets/search-total", "params": [ { "name": "filter.allowDoubleLocks", "value": "", "type": "query", "description": "Whether to allow DoubleLocks as part of the search. True by default." }, { "name": "filter.doNotCalculateTotal", "value": "", "type": "query", "description": "Whether to return the total number of secrets matching the filters. False by default. If false, the total can be retrieved separately by calling /v1/secrets/search-total with the same arguments used in the search." }, { "name": "filter.doubleLockId", "value": "", "type": "query", "description": "Only include Secrets with this DoubleLock ID assigned in the search results." }, { "name": "filter.extendedFields", "value": "", "type": "query", "description": "An array of names of Secret Template fields to return. Only exposed fields can be returned. This parameter will be ignored if ExtFieldsCombined is sent." }, { "name": "filter.extendedTypeId", "value": "", "type": "query", "description": "If not null, return only secrets matching the specified extended mapping type as defined on the secret’s template." }, { "name": "filter.extFieldsCombined", "value": "", "type": "query", "description": "A comma delimited list of all extended fields to return. All fields must be marked as exposed for display. When populated this value will be used instead of ExtendedFields[]. Combining the fields decreases the size of the GET URL to avoid the 2048 character length restriction in IIS." }, { "name": "filter.folderId", "value": "", "type": "query", "description": "If not null, returns only secrets within the specified folder." }, { "name": "filter.hasLauncher", "value": "", "type": "query", "description": "Whether to only return secrets with or without launchers. If null, returns secrets regardless of whether they have launchers." }, { "name": "filter.heartbeatStatus", "value": "", "type": "query", "description": "If not null, returns only secrets with a certain heartbeat status." }, { "name": "filter.includeActive", "value": "", "type": "query", "description": "Whether to include active secrets in results (when excluded equals true)." }, { "name": "filter.includeInactive", "value": "", "type": "query", "description": "Whether to include inactive secrets in results." }, { "name": "filter.includeRestricted", "value": "", "type": "query", "description": "Whether to include restricted secrets in results. Restricted secrets are secrets that are DoubleLocked, require approval, or require a comment to view." }, { "name": "filter.includeSubFolders", "value": "", "type": "query", "description": "Whether to include secrets in subfolders of the specified folder." }, { "name": "filter.isExactMatch", "value": "", "type": "query", "description": "Whether to do an exact match of the search text or a partial match. If an exact match, the entire secret name, field value, or list option in a list field must match the search text." }, { "name": "filter.onlyCheckedOutSecrets", "value": "", "type": "query", "description": "Whether to only return secrets that are or are not checked out. If null, returns secrets regardless of whether they are checked out." }, { "name": "filter.onlyRPCEnabled", "value": "", "type": "query", "description": "Whether to only include secrets whose template has Remote Password Changing enabled." }, { "name": "filter.onlySecretsCheckedOutByUser", "value": "", "type": "query", "description": "Whether to only return secrets that are or are not checked out by the querying user. If null, returns secrets regardless of whether they are checked out." }, { "name": "filter.onlySharedWithMe", "value": "", "type": "query", "description": "When true only Secrets where you are not the owner and the Secret was shared explicitly with your user id will be returned." }, { "name": "filter.passwordTypeIds", "value": "", "type": "query", "description": "If not null, returns only secrets matching the specified password types." }, { "name": "filter.permissionRequired", "value": "", "type": "query", "description": "Specify whether to filter by List, View, Edit, or Owner permission. Default is List." }, { "name": "filter.scope", "value": "", "type": "query", "description": "Specify whether to search All, Recent, or Favorites" }, { "name": "filter.searchField", "value": "", "type": "query", "description": "If set, restricts the search to only match secrets where the value of the field specified by name contains the search text." }, { "name": "filter.searchFieldSlug", "value": "", "type": "query", "description": "If set, restricts the search to only match secrets where the value of the field specified by the slug name contains the search text. This will override SearchField." }, { "name": "filter.searchText", "value": "", "type": "query", "description": "The text to match in the secret name, field value, or list field contents." }, { "name": "filter.secretIds", "value": "", "type": "query", "description": "If not null or empty, returns only secrets matching the specified secret ids." }, { "name": "filter.secretTemplateIds", "value": "", "type": "query", "description": "If not null or empty, returns only secrets matching the specified templates." }, { "name": "filter.secretTemplateIdsCombined", "value": "", "type": "query", "description": "A comma delimited list of all secret template IDs. When populated this value will be used instead of SecretTemplateIds[]. Combining the fields decreases the size of the GET URL to avoid the 2048 character length restriction in IIS." }, { "name": "filter.siteId", "value": "", "type": "query", "description": "If not null, returns only secrets within a the specified site." }, { "name": "skip", "value": "", "type": "query", "description": "Number of records to skip before taking results" }, { "name": "sortBy[0].direction", "value": "", "type": "query", "description": "Sort direction" }, { "name": "sortBy[0].name", "value": "", "type": "query", "description": "Sort field name" }, { "name": "sortBy[0].priority", "value": "", "type": "query", "description": "Priority index. Sorts with lower values are executed earlier" }, { "name": "take", "value": "", "type": "query", "description": "Maximum number of records to include in results" } ] }, "docs": "Gets the total number of secrets matching the secret search filter" }, { "info": { "name": "Lookup Secrets with Search", "type": "http" }, "http": { "method": "GET", "url": "/SecretServer/api/v1/secrets/lookup", "params": [ { "name": "filter.allowDoubleLocks", "value": "", "type": "query", "description": "Whether to allow DoubleLocks as part of the search. True by default." }, { "name": "filter.doNotCalculateTotal", "value": "", "type": "query", "description": "Whether to return the total number of secrets matching the filters. False by default. If false, the total can be retrieved separately by calling /v1/secrets/search-total with the same arguments used in the search." }, { "name": "filter.doubleLockId", "value": "", "type": "query", "description": "Only include Secrets with this DoubleLock ID assigned in the search results." }, { "name": "filter.extendedFields", "value": "", "type": "query", "description": "An array of names of Secret Template fields to return. Only exposed fields can be returned." }, { "name": "filter.extendedTypeId", "value": "", "type": "query", "description": "If not null, return only secrets matching the specified extended mapping type as defined on the secret’s template." }, { "name": "filter.folderId", "value": "", "type": "query", "description": "If not null, returns only secrets within the specified folder." }, { "name": "filter.heartbeatStatus", "value": "", "type": "query", "description": "If not null, returns only secrets with a certain heartbeat status." }, { "name": "filter.includeActive", "value": "", "type": "query", "description": "Whether to include active secrets in results (when excluded equals true)." }, { "name": "filter.includeInactive", "value": "", "type": "query", "description": "Whether to include inactive secrets in results." }, { "name": "filter.includeRestricted", "value": "", "type": "query", "description": "Whether to include restricted secrets in results. Restricted secrets are secrets that are DoubleLocked, require approval, or require a comment to view." }, { "name": "filter.includeSubFolders", "value": "", "type": "query", "description": "Whether to include secrets in subfolders of the specified folder." }, { "name": "filter.isExactMatch", "value": "", "type": "query", "description": "Whether to do an exact match of the search text or a partial match. If an exact match, the entire secret name, field value, or list option in a list field must match the search text." }, { "name": "filter.onlyRPCEnabled", "value": "", "type": "query", "description": "Whether to only include secrets whose template has Remote Password Changing enabled." }, { "name": "filter.onlySecretsCheckedOutByUser", "value": "", "type": "query", "description": "Whether to only return secrets that are or are not checked out by the querying user. If null, returns secrets regardless of whether they are checked out." }, { "name": "filter.onlySharedWithMe", "value": "", "type": "query", "description": "When true only Secrets where you are not the owner and the Secret was shared explicitly with your user id will be returned." }, { "name": "filter.passwordTypeIds", "value": "", "type": "query", "description": "If not null, returns only secrets matching the specified password types." }, { "name": "filter.permissionRequired", "value": "", "type": "query", "description": "Specify whether to filter by List, View, Edit, or Owner permission. Default is List." }, { "name": "filter.scope", "value": "", "type": "query", "description": "Specify whether to search All, Recent, or Favorites" }, { "name": "filter.searchField", "value": "", "type": "query", "description": "If set, restricts the search to only match secrets where the value of the field specified by name contains the search text." }, { "name": "filter.searchFieldSlug", "value": "", "type": "query", "description": "If set, restricts the search to only match secrets where the value of the field specified by the slug name contains the search text. This will override SearchField." }, { "name": "filter.searchText", "value": "", "type": "query", "description": "The text to match in the secret name, field value, or list field contents." }, { "name": "filter.secretTemplateId", "value": "", "type": "query", "description": "If not null, returns only secrets matching the specified template." }, { "name": "filter.siteId", "value": "", "type": "query", "description": "If not null, returns only secrets within a the specified site." }, { "name": "skip", "value": "", "type": "query", "description": "Number of records to skip before taking results" }, { "name": "sortBy[0].direction", "value": "", "type": "query", "description": "Sort direction" }, { "name": "sortBy[0].name", "value": "", "type": "query", "description": "Sort field name" }, { "name": "sortBy[0].priority", "value": "", "type": "query", "description": "Priority index. Sorts with lower values are executed earlier" }, { "name": "take", "value": "", "type": "query", "description": "Maximum number of records to include in results" } ] }, "docs": "Search, filter, sort, and page secrets, returning only secret ID and name" }, { "info": { "name": "Lookup Secret", "type": "http" }, "http": { "method": "GET", "url": "/SecretServer/api/v1/secrets/lookup/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Secret ID" }, { "name": "secretPath", "value": "", "type": "query", "description": "A full path including folder and secret name can be passed as a query string parameter when the secret ID is set to 0. This will lookup the secret ID by path." } ] }, "docs": "Look up secret by ID and return secret name and ID" }, { "info": { "name": "Get Secret Stub", "type": "http" }, "http": { "method": "GET", "url": "/SecretServer/api/v1/secrets/stub", "params": [ { "name": "folderId", "value": "", "type": "query", "description": "Containing folder ID. May be null unless secrets are required to be in folders." }, { "name": "secretTemplateId", "value": "", "type": "query", "description": "Secret template ID" } ] }, "docs": "Return the default values for a new secret" }, { "info": { "name": "Get Secret", "type": "http" }, "http": { "method": "GET", "url": "/SecretServer/api/v2/secrets/:id", "params": [ { "name": "includeInactive", "value": "", "type": "query", "description": "Whether to include inactive secrets in the results" }, { "name": "noAutoCheckout", "value": "", "type": "query", "description": "Don't check out the secret if needed" }, { "name": "autoCheckIn", "value": "", "type": "query", "description": "Automatically check in a secret after finding or updating." }, { "name": "autoCheckout", "value": "", "type": "query", "description": "Automatically check out secret before finding or updating." }, { "name": "autoComment", "value": "", "type": "query", "description": "Leave a comment when checking in or out." }, { "name": "forceCheckIn", "value": "", "type": "query", "description": "If secret is checked out, then force a check in." }, { "name": "id", "value": "", "type": "path", "description": "Secret ID" }, { "name": "secretPath", "value": "", "type": "query", "description": "A full path including folder and secret name can be passed as a query string parameter when the secret ID is set to 0. This will lookup the secret ID by path." } ] }, "docs": "Get a single secret by ID" }, { "info": { "name": "Get Secret Preview", "type": "http" }, "http": { "method": "GET", "url": "/SecretServer/api/v1/secrets/:id/preview", "params": [ { "name": "autoCheckIn", "value": "", "type": "query", "description": "Automatically check in a secret after finding or updating." }, { "name": "autoCheckout", "value": "", "type": "query", "description": "Automatically check out secret before finding or updating." }, { "name": "autoComment", "value": "", "type": "query", "description": "Leave a comment when checking in or out." }, { "name": "forceCheckIn", "value": "", "type": "query", "description": "If secret is checked out, then force a check in." }, { "name": "id", "value": "", "type": "path", "description": "Secret ID" }, { "name": "secretPath", "value": "", "type": "query", "description": "A full path including folder and secret name can be passed as a query string parameter when the secret ID is set to 0. This will lookup the secret ID by path." } ] }, "docs": "Get a preview of an unrestricted secret by ID. Restricted secrets will return an AccessDeniedException." }, { "info": { "name": "Get Secret Summary", "type": "http" }, "http": { "method": "GET", "url": "/SecretServer/api/v1/secrets/:id/summary", "params": [ { "name": "autoCheckIn", "value": "", "type": "query", "description": "Automatically check in a secret after finding or updating." }, { "name": "autoCheckout", "value": "", "type": "query", "description": "Automatically check out secret before finding or updating." }, { "name": "autoComment", "value": "", "type": "query", "description": "Leave a comment when checking in or out." }, { "name": "forceCheckIn", "value": "", "type": "query", "description": "If secret is checked out, then force a check in." }, { "name": "id", "value": "", "type": "path", "description": "Secret ID" }, { "name": "secretPath", "value": "", "type": "query", "description": "A full path including folder and secret name can be passed as a query string parameter when the secret ID is set to 0. This will lookup the secret ID by path." } ] }, "docs": "Get the summary for a secret" }, { "info": { "name": "Get Secret Field", "type": "http" }, "http": { "method": "GET", "url": "/SecretServer/api/v1/secrets/:id/fields/:slug", "params": [ { "name": "includeInactive", "value": "", "type": "query", "description": "Whether to include inactive secrets in the results" }, { "name": "noAutoCheckout", "value": "", "type": "query", "description": "Don't check out the secret if needed" }, { "name": "autoCheckIn", "value": "", "type": "query", "description": "Automatically check in a secret after finding or updating." }, { "name": "autoCheckout", "value": "", "type": "query", "description": "Automatically check out secret before finding or updating." }, { "name": "autoComment", "value": "", "type": "query", "description": "Leave a comment when checking in or out." }, { "name": "forceCheckIn", "value": "", "type": "query", "description": "If secret is checked out, then force a check in." }, { "name": "id", "value": "", "type": "path", "description": "Secret ID" }, { "name": "secretPath", "value": "", "type": "query", "description": "A full path including folder and secret name can be passed as a query string parameter when the secret ID is set to 0. This will lookup the secret ID by path." }, { "name": "slug", "value": "", "type": "path", "description": "Secret field name" } ] }, "docs": "Get a secret data field" }, { "info": { "name": "Update Secret Field", "type": "http" }, "http": { "method": "PUT", "url": "/SecretServer/api/v1/secrets/:id/fields/:slug", "params": [ { "name": "autoCheckIn", "value": "", "type": "query", "description": "Automatically check in a secret after finding or updating." }, { "name": "autoCheckout", "value": "", "type": "query", "description": "Automatically check out secret before finding or updating." }, { "name": "autoComment", "value": "", "type": "query", "description": "Leave a comment when checking in or out." }, { "name": "forceCheckIn", "value": "", "type": "query", "description": "If secret is checked out, then force a check in." }, { "name": "id", "value": "", "type": "path", "description": "Secret ID" }, { "name": "secretPath", "value": "", "type": "query", "description": "A full path including folder and secret name can be passed as a query string parameter when the secret ID is set to 0. This will lookup the secret ID by path." }, { "name": "slug", "value": "", "type": "path", "description": "Secret field name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a secret data field" }, { "info": { "name": "Get Secret List Field", "type": "http" }, "http": { "method": "GET", "url": "/SecretServer/api/v1/secrets/:id/fields/:slug/list", "params": [ { "name": "autoCheckIn", "value": "", "type": "query", "description": "Automatically check in a secret after finding or updating." }, { "name": "autoCheckout", "value": "", "type": "query", "description": "Automatically check out secret before finding or updating." }, { "name": "autoComment", "value": "", "type": "query", "description": "Leave a comment when checking in or out." }, { "name": "forceCheckIn", "value": "", "type": "query", "description": "If secret is checked out, then force a check in." }, { "name": "id", "value": "", "type": "path", "description": "Secret ID" }, { "name": "slug", "value": "", "type": "path", "description": "Secret field name" } ] }, "docs": "Get the items associated to a secret list data field" }, { "info": { "name": "List a User's Favorite Secrets", "type": "http" }, "http": { "method": "GET", "url": "/SecretServer/api/v1/secrets/favorite" }, "docs": "Returns a list of secrets which the user has favorited." }, { "info": { "name": "Get secret password transition history", "type": "http" }, "http": { "method": "GET", "url": "/SecretServer/api/v1/secrets/:secretId/transition-history", "params": [ { "name": "skip", "value": "", "type": "query", "description": "Number of records to skip before taking results" }, { "name": "sortBy[0].direction", "value": "", "type": "query", "description": "Sort direction" }, { "name": "sortBy[0].name", "value": "", "type": "query", "description": "Sort field name" }, { "name": "sortBy[0].priority", "value": "", "type": "query", "description": "Priority index. Sorts with lower values are executed earlier" }, { "name": "take", "value": "", "type": "query", "description": "Maximum number of records to include in results" }, { "name": "secretId", "value": "", "type": "path", "description": "secretId" } ] }, "docs": "Returns the secret password that will be used next during an actual rotation." }, { "info": { "name": "Get Secret Audits by Filter", "type": "http" }, "http": { "method": "GET", "url": "/SecretServer/api/v1/secrets/:id/audits", "params": [ { "name": "id", "value": "", "type": "path", "description": "id" }, { "name": "isExporting", "value": "", "type": "query", "description": "isExporting" }, { "name": "filter.includePasswordChangeLog", "value": "", "type": "query", "description": "Whether or not to include password changes in data" }, { "name": "skip", "value": "", "type": "query", "description": "Number of records to skip before taking results" }, { "name": "sortBy[0].direction", "value": "", "type": "query", "description": "Sort direction" }, { "name": "sortBy[0].name", "value": "", "type": "query", "description": "Sort field name" }, { "name": "sortBy[0].priority", "value": "", "type": "query", "description": "Priority index. Sorts with lower values are executed earlier" }, { "name": "take", "value": "", "type": "query", "description": "Maximum number of records to include in results" }, { "name": "secretPath", "value": "", "type": "query", "description": "A full path including folder and secret name can be passed as a query string parameter when the secret ID is set to 0. This will lookup the secret ID by path." } ] }, "docs": "Get audits for a particular Secret for the given filter." }, { "info": { "name": "Get Secret State", "type": "http" }, "http": { "method": "GET", "url": "/SecretServer/api/v1/secrets/:id/state", "params": [ { "name": "autoCheckIn", "value": "", "type": "query", "description": "Automatically check in a secret after finding or updating." }, { "name": "autoCheckout", "value": "", "type": "query", "description": "Automatically check out secret before finding or updating." }, { "name": "autoComment", "value": "", "type": "query", "description": "Leave a comment when checking in or out." }, { "name": "forceCheckIn", "value": "", "type": "query", "description": "If secret is checked out, then force a check in." }, { "name": "id", "value": "", "type": "path", "description": "id" }, { "name": "secretPath", "value": "", "type": "query", "description": "A full path including folder and secret name can be passed as a query string parameter when the secret ID is set to 0. This will lookup the secret ID by path." } ] }, "docs": "Retrieve state about a Secret such as whether it requires approval, doublelock, checkout, or other restricted actions to be performed before calling the get the secret." }, { "info": { "name": "Get Secret Detail General", "type": "http" }, "http": { "method": "GET", "url": "/SecretServer/api/v1/secrets/secret-detail/:id/general/:isEditMode?/:loadReadOnlyFlags?", "params": [ { "name": "id", "value": "", "type": "path", "description": "id" }, { "name": "isEditMode", "value": "", "type": "query", "description": "isEditMode" }, { "name": "loadReadOnlyFlags", "value": "", "type": "query", "description": "loadReadOnlyFlags" }, { "name": "secretPath", "value": "", "type": "query", "description": "A full path including folder and secret name can be passed as a query string parameter when the secret ID is set to 0. This will lookup the secret ID by path." } ] }, "docs": "Retrieve details about a secret." }, { "info": { "name": "Get Secret Settings", "type": "http" }, "http": { "method": "GET", "url": "/SecretServer/api/v1/secrets/:id/settings", "params": [ { "name": "autoCheckIn", "value": "", "type": "query", "description": "Automatically check in a secret after finding or updating." }, { "name": "autoCheckout", "value": "", "type": "query", "description": "Automatically check out secret before finding or updating." }, { "name": "autoComment", "value": "", "type": "query", "description": "Leave a comment when checking in or out." }, { "name": "forceCheckIn", "value": "", "type": "query", "description": "If secret is checked out, then force a check in." }, { "name": "id", "value": "", "type": "path", "description": "id" }, { "name": "secretPath", "value": "", "type": "query", "description": "A full path including folder and secret name can be passed as a query string parameter when the secret ID is set to 0. This will lookup the secret ID by path." } ] }, "docs": "Get Secret Settings" }, { "info": { "name": "Get Secret Launcher Sessions By Id", "type": "http" }, "http": { "method": "GET", "url": "/SecretServer/api/v1/secrets/launcher-sessions", "params": [ { "name": "filter.secretId", "value": "", "type": "query", "description": "The Id of the associated Secret." }, { "name": "skip", "value": "", "type": "query", "description": "Number of records to skip before taking results" }, { "name": "sortBy[0].direction", "value": "", "type": "query", "description": "Sort direction" }, { "name": "sortBy[0].name", "value": "", "type": "query", "description": "Sort field name" }, { "name": "sortBy[0].priority", "value": "", "type": "query", "description": "Priority index. Sorts with lower values are executed earlier" }, { "name": "take", "value": "", "type": "query", "description": "Maximum number of records to include in results" } ] }, "docs": "Get secret launcher sessions" }, { "info": { "name": "Update Secret Launcher Sessions", "type": "http" }, "http": { "method": "PATCH", "url": "/SecretServer/api/v1/secrets/launcher-sessions", "body": { "type": "json", "data": "{}" } }, "docs": "Update or Terminate Secret Launcher Sessions" }, { "info": { "name": "Get SSH Command Restrictions on a Secret", "type": "http" }, "http": { "method": "GET", "url": "/SecretServer/api/v1/secrets/:id/ssh-restricted-commands", "params": [ { "name": "autoCheckIn", "value": "", "type": "query", "description": "Automatically check in a secret after finding or updating." }, { "name": "autoCheckout", "value": "", "type": "query", "description": "Automatically check out secret before finding or updating." }, { "name": "autoComment", "value": "", "type": "query", "description": "Leave a comment when checking in or out." }, { "name": "forceCheckIn", "value": "", "type": "query", "description": "If secret is checked out, then force a check in." }, { "name": "id", "value": "", "type": "path", "description": "id" } ] }, "docs": "Gets the SSH command restrictions for a Secret" }, { "info": { "name": "Export Secrets Job Status", "type": "http" }, "http": { "method": "GET", "url": "/SecretServer/api/v2/secrets/export/job/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "jobId" } ] }, "docs": "Exports secrets Job Status" }, { "info": { "name": "Export Secrets Job Details", "type": "http" }, "http": { "method": "GET", "url": "/SecretServer/api/v2/secrets/export/:jobId/details", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "jobId" } ] }, "docs": "Exports Secret Job Details" }, { "info": { "name": "Export Bulk Export Secrets", "type": "http" }, "http": { "method": "GET", "url": "/SecretServer/api/v2/secrets/export", "params": [ { "name": "jobId", "value": "", "type": "query", "description": "jobId" } ] }, "docs": "Exports Secrets from Storage" }, { "info": { "name": "Update Secret General Information", "type": "http" }, "http": { "method": "PATCH", "url": "/SecretServer/api/v1/secrets/:id/general", "params": [ { "name": "autoCheckIn", "value": "", "type": "query", "description": "Automatically check in a secret after finding or updating." }, { "name": "autoCheckout", "value": "", "type": "query", "description": "Automatically check out secret before finding or updating." }, { "name": "autoComment", "value": "", "type": "query", "description": "Leave a comment when checking in or out." }, { "name": "forceCheckIn", "value": "", "type": "query", "description": "If secret is checked out, then force a check in." }, { "name": "id", "value": "", "type": "path", "description": "id" }, { "name": "secretPath", "value": "", "type": "query", "description": "A full path including folder and secret name can be passed as a query string parameter when the secret ID is set to 0. This will lookup the secret ID by path." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update Secret General Information" }, { "info": { "name": "Update User Secret Email Settings", "type": "http" }, "http": { "method": "PATCH", "url": "/SecretServer/api/v1/secrets/:id/email", "params": [ { "name": "autoCheckIn", "value": "", "type": "query", "description": "Automatically check in a secret after finding or updating." }, { "name": "autoCheckout", "value": "", "type": "query", "description": "Automatically check out secret before finding or updating." }, { "name": "autoComment", "value": "", "type": "query", "description": "Leave a comment when checking in or out." }, { "name": "forceCheckIn", "value": "", "type": "query", "description": "If secret is checked out, then force a check in." }, { "name": "id", "value": "", "type": "path", "description": "id" }, { "name": "secretPath", "value": "", "type": "query", "description": "A full path including folder and secret name can be passed as a query string parameter when the secret ID is set to 0. This will lookup the secret ID by path." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update User Secret Email Settings" }, { "info": { "name": "Update Secret Security General Options", "type": "http" }, "http": { "method": "PATCH", "url": "/SecretServer/api/v1/secrets/:id/security-general", "params": [ { "name": "autoCheckIn", "value": "", "type": "query", "description": "Automatically check in a secret after finding or updating." }, { "name": "autoCheckout", "value": "", "type": "query", "description": "Automatically check out secret before finding or updating." }, { "name": "autoComment", "value": "", "type": "query", "description": "Leave a comment when checking in or out." }, { "name": "forceCheckIn", "value": "", "type": "query", "description": "If secret is checked out, then force a check in." }, { "name": "id", "value": "", "type": "path", "description": "id" }, { "name": "secretPath", "value": "", "type": "query", "description": "A full path including folder and secret name can be passed as a query string parameter when the secret ID is set to 0. This will lookup the secret ID by path." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update Secret Security General Options" }, { "info": { "name": "Update Secret General Information", "type": "http" }, "http": { "method": "PATCH", "url": "/SecretServer/api/v2/secrets/:id/general", "params": [ { "name": "autoCheckIn", "value": "", "type": "query", "description": "Automatically check in a secret after finding or updating." }, { "name": "autoCheckout", "value": "", "type": "query", "description": "Automatically check out secret before finding or updating." }, { "name": "autoComment", "value": "", "type": "query", "description": "Leave a comment when checking in or out." }, { "name": "forceCheckIn", "value": "", "type": "query", "description": "If secret is checked out, then force a check in." }, { "name": "id", "value": "", "type": "path", "description": "id" }, { "name": "secretPath", "value": "", "type": "query", "description": "A full path including folder and secret name can be passed as a query string parameter when the secret ID is set to 0. This will lookup the secret ID by path." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update Secret General Information" }, { "info": { "name": "Update User Secret Email Settings", "type": "http" }, "http": { "method": "PATCH", "url": "/SecretServer/api/v2/secrets/:id/email", "params": [ { "name": "autoCheckIn", "value": "", "type": "query", "description": "Automatically check in a secret after finding or updating." }, { "name": "autoCheckout", "value": "", "type": "query", "description": "Automatically check out secret before finding or updating." }, { "name": "autoComment", "value": "", "type": "query", "description": "Leave a comment when checking in or out." }, { "name": "forceCheckIn", "value": "", "type": "query", "description": "If secret is checked out, then force a check in." }, { "name": "id", "value": "", "type": "path", "description": "id" }, { "name": "secretPath", "value": "", "type": "query", "description": "A full path including folder and secret name can be passed as a query string parameter when the secret ID is set to 0. This will lookup the secret ID by path." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update User Secret Email Settings" }, { "info": { "name": "Update Secret Security Checkout Options", "type": "http" }, "http": { "method": "PATCH", "url": "/SecretServer/api/v3/secrets/:id/security-checkout", "params": [ { "name": "autoCheckIn", "value": "", "type": "query", "description": "Automatically check in a secret after finding or updating." }, { "name": "autoCheckout", "value": "", "type": "query", "description": "Automatically check out secret before finding or updating." }, { "name": "autoComment", "value": "", "type": "query", "description": "Leave a comment when checking in or out." }, { "name": "forceCheckIn", "value": "", "type": "query", "description": "If secret is checked out, then force a check in." }, { "name": "id", "value": "", "type": "path", "description": "id" }, { "name": "secretPath", "value": "", "type": "query", "description": "A full path including folder and secret name can be passed as a query string parameter when the secret ID is set to 0. This will lookup the secret ID by path." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update Secret Security Checkout Options" }, { "info": { "name": "Update Secret Security Multifactor Authentication Options", "type": "http" }, "http": { "method": "PATCH", "url": "/SecretServer/api/v1/secrets/:id/security-multifactor-authentication", "params": [ { "name": "autoCheckIn", "value": "", "type": "query", "description": "Automatically check in a secret after finding or updating." }, { "name": "autoCheckout", "value": "", "type": "query", "description": "Automatically check out secret before finding or updating." }, { "name": "autoComment", "value": "", "type": "query", "description": "Leave a comment when checking in or out." }, { "name": "forceCheckIn", "value": "", "type": "query", "description": "If secret is checked out, then force a check in." }, { "name": "id", "value": "", "type": "path", "description": "id" }, { "name": "secretPath", "value": "", "type": "query", "description": "A full path including folder and secret name can be passed as a query string parameter when the secret ID is set to 0. This will lookup the secret ID by path." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update Secret Security Multifactor Authentication Options" }, { "info": { "name": "Update Secret Security General Options", "type": "http" }, "http": { "method": "PATCH", "url": "/SecretServer/api/v2/secrets/:id/security-general", "params": [ { "name": "autoCheckIn", "value": "", "type": "query", "description": "Automatically check in a secret after finding or updating." }, { "name": "autoCheckout", "value": "", "type": "query", "description": "Automatically check out secret before finding or updating." }, { "name": "autoComment", "value": "", "type": "query", "description": "Leave a comment when checking in or out." }, { "name": "forceCheckIn", "value": "", "type": "query", "description": "If secret is checked out, then force a check in." }, { "name": "id", "value": "", "type": "path", "description": "id" }, { "name": "secretPath", "value": "", "type": "query", "description": "A full path including folder and secret name can be passed as a query string parameter when the secret ID is set to 0. This will lookup the secret ID by path." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update Secret Security General Options" }, { "info": { "name": "Secret Search Extended Details", "type": "http" }, "http": { "method": "POST", "url": "/SecretServer/api/v1/secrets/extended-search-details", "body": { "type": "json", "data": "{}" } }, "docs": "Pass an array of secret IDs, presumably the results of a secret search and get extended details such as has launchers or is favorite." }, { "info": { "name": "Get Restricted Secret", "type": "http" }, "http": { "method": "POST", "url": "/SecretServer/api/v1/secrets/:id/restricted", "params": [ { "name": "autoCheckIn", "value": "", "type": "query", "description": "Automatically check in a secret after finding or updating." }, { "name": "autoCheckout", "value": "", "type": "query", "description": "Automatically check out secret before finding or updating." }, { "name": "autoComment", "value": "", "type": "query", "description": "Leave a comment when checking in or out." }, { "name": "forceCheckIn", "value": "", "type": "query", "description": "If secret is checked out, then force a check in." }, { "name": "id", "value": "", "type": "path", "description": "Secret ID" }, { "name": "secretPath", "value": "", "type": "query", "description": "A full path including folder and secret name can be passed as a query string parameter when the secret ID is set to 0. This will lookup the secret ID by path." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Get a restricted secret" }, { "info": { "name": "Create Secret", "type": "http" }, "http": { "method": "POST", "url": "/SecretServer/api/v1/secrets", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new secret" }, { "info": { "name": "Run Secret Heartbeat", "type": "http" }, "http": { "method": "POST", "url": "/SecretServer/api/v1/secrets/:id/heartbeat", "params": [ { "name": "autoCheckIn", "value": "", "type": "query", "description": "Automatically check in a secret after finding or updating." }, { "name": "autoCheckout", "value": "", "type": "query", "description": "Automatically check out secret before finding or updating." }, { "name": "autoComment", "value": "", "type": "query", "description": "Leave a comment when checking in or out." }, { "name": "forceCheckIn", "value": "", "type": "query", "description": "If secret is checked out, then force a check in." }, { "name": "id", "value": "", "type": "path", "description": "Secret ID" }, { "name": "secretPath", "value": "", "type": "query", "description": "A full path including folder and secret name can be passed as a query string parameter when the secret ID is set to 0. This will lookup the secret ID by path." } ] }, "docs": "Check if secret is still valid" }, { "info": { "name": "Expire Secret", "type": "http" }, "http": { "method": "POST", "url": "/SecretServer/api/v1/secrets/:id/expire", "params": [ { "name": "autoCheckIn", "value": "", "type": "query", "description": "Automatically check in a secret after finding or updating." }, { "name": "autoCheckout", "value": "", "type": "query", "description": "Automatically check out secret before finding or updating." }, { "name": "autoComment", "value": "", "type": "query", "description": "Leave a comment when checking in or out." }, { "name": "forceCheckIn", "value": "", "type": "query", "description": "If secret is checked out, then force a check in." }, { "name": "id", "value": "", "type": "path", "description": "Secret ID" }, { "name": "secretPath", "value": "", "type": "query", "description": "A full path including folder and secret name can be passed as a query string parameter when the secret ID is set to 0. This will lookup the secret ID by path." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Expire a secret" }, { "info": { "name": "Change Secret Password", "type": "http" }, "http": { "method": "POST", "url": "/SecretServer/api/v1/secrets/:id/change-password", "params": [ { "name": "autoCheckIn", "value": "", "type": "query", "description": "Automatically check in a secret after finding or updating." }, { "name": "autoCheckout", "value": "", "type": "query", "description": "Automatically check out secret before finding or updating." }, { "name": "autoComment", "value": "", "type": "query", "description": "Leave a comment when checking in or out." }, { "name": "forceCheckIn", "value": "", "type": "query", "description": "If secret is checked out, then force a check in." }, { "name": "id", "value": "", "type": "path", "description": "Secret ID" }, { "name": "secretPath", "value": "", "type": "query", "description": "A full path including folder and secret name can be passed as a query string parameter when the secret ID is set to 0. This will lookup the secret ID by path." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Change a secret's password" }, { "info": { "name": "Check In Secret", "type": "http" }, "http": { "method": "POST", "url": "/SecretServer/api/v1/secrets/:id/check-in", "params": [ { "name": "id", "value": "", "type": "path", "description": "Secret ID" }, { "name": "secretPath", "value": "", "type": "query", "description": "A full path including folder and secret name can be passed as a query string parameter when the secret ID is set to 0. This will lookup the secret ID by path." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Check in a secret. Checking a secret ends exclusive access to the secret and allows other users to check-out and view or edit it." }, { "info": { "name": "Check Out Secret", "type": "http" }, "http": { "method": "POST", "url": "/SecretServer/api/v1/secrets/:id/check-out", "params": [ { "name": "id", "value": "", "type": "path", "description": "Secret ID" }, { "name": "secretPath", "value": "", "type": "query", "description": "A full path including folder and secret name can be passed as a query string parameter when the secret ID is set to 0. This will lookup the secret ID by path." } ] }, "docs": "Check Out a secret" }, { "info": { "name": "Extend Check Out", "type": "http" }, "http": { "method": "POST", "url": "/SecretServer/api/v1/secrets/:id/extend-check-out", "params": [ { "name": "id", "value": "", "type": "path", "description": "id" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Extend remaining check out time." }, { "info": { "name": "Get Restricted Secret Field", "type": "http" }, "http": { "method": "POST", "url": "/SecretServer/api/v1/secrets/:id/restricted/fields/:slug", "params": [ { "name": "autoCheckIn", "value": "", "type": "query", "description": "Automatically check in a secret after finding or updating." }, { "name": "autoCheckout", "value": "", "type": "query", "description": "Automatically check out secret before finding or updating." }, { "name": "autoComment", "value": "", "type": "query", "description": "Leave a comment when checking in or out." }, { "name": "forceCheckIn", "value": "", "type": "query", "description": "If secret is checked out, then force a check in." }, { "name": "id", "value": "", "type": "path", "description": "Secret ID" }, { "name": "secretPath", "value": "", "type": "query", "description": "A full path including folder and secret name can be passed as a query string parameter when the secret ID is set to 0. This will lookup the secret ID by path." }, { "name": "slug", "value": "", "type": "path", "description": "Secret field name" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Get a restricted secret data field" }, { "info": { "name": "Get RDP Proxy Information", "type": "http" }, "http": { "method": "POST", "url": "/SecretServer/api/v1/secrets/rdpproxy", "params": [ { "name": "autoCheckIn", "value": "", "type": "query", "description": "Automatically check in a secret after finding or updating." }, { "name": "autoCheckout", "value": "", "type": "query", "description": "Automatically check out secret before finding or updating." }, { "name": "autoComment", "value": "", "type": "query", "description": "Leave a comment when checking in or out." }, { "name": "forceCheckIn", "value": "", "type": "query", "description": "If secret is checked out, then force a check in." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Get RDP Proxy Information" }, { "info": { "name": "Get SSH Proxy Information", "type": "http" }, "http": { "method": "POST", "url": "/SecretServer/api/v1/secrets/sshproxy", "params": [ { "name": "autoCheckIn", "value": "", "type": "query", "description": "Automatically check in a secret after finding or updating." }, { "name": "autoCheckout", "value": "", "type": "query", "description": "Automatically check out secret before finding or updating." }, { "name": "autoComment", "value": "", "type": "query", "description": "Leave a comment when checking in or out." }, { "name": "forceCheckIn", "value": "", "type": "query", "description": "If secret is checked out, then force a check in." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Get SSH Proxy Information" }, { "info": { "name": "Get SSH Terminal Details", "type": "http" }, "http": { "method": "POST", "url": "/SecretServer/api/v1/secrets/sshterminal", "params": [ { "name": "autoCheckIn", "value": "", "type": "query", "description": "Automatically check in a secret after finding or updating." }, { "name": "autoCheckout", "value": "", "type": "query", "description": "Automatically check out secret before finding or updating." }, { "name": "autoComment", "value": "", "type": "query", "description": "Leave a comment when checking in or out." }, { "name": "forceCheckIn", "value": "", "type": "query", "description": "If secret is checked out, then force a check in." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Get SSH Terminal Details" }, { "info": { "name": "Favorite a Secret", "type": "http" }, "http": { "method": "POST", "url": "/SecretServer/api/v1/secrets/:secretId/favorite", "params": [ { "name": "secretId", "value": "", "type": "path", "description": "The secret to favorite or unfavorite." }, { "name": "secretPath", "value": "", "type": "query", "description": "A full path including folder and secret name can be passed as a query string parameter when the secret ID is set to 0. This will lookup the secret ID by path." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Used to favorite or unfavorite an individual Secret" }, { "info": { "name": "Attempt to stop a password change", "type": "http" }, "http": { "method": "POST", "url": "/SecretServer/api/v1/secrets/:id/stop-password-change", "params": [ { "name": "id", "value": "", "type": "path", "description": "id" }, { "name": "secretPath", "value": "", "type": "query", "description": "A full path including folder and secret name can be passed as a query string parameter when the secret ID is set to 0. This will lookup the secret ID by path." } ] }, "docs": "Attempt to stop a password change" }, { "info": { "name": "Convert Secret Template", "type": "http" }, "http": { "method": "POST", "url": "/SecretServer/api/v1/secrets/convert-template", "body": { "type": "json", "data": "{}" } }, "docs": "Convert the specificed Secrets to a different Secret Template" }, { "info": { "name": "Get Convert Template Information", "type": "http" }, "http": { "method": "POST", "url": "/SecretServer/api/v1/secrets/get-convert-info", "body": { "type": "json", "data": "{}" } }, "docs": "Retrieve information about the requested conversion such as which fields exist on the target template." }, { "info": { "name": "Export Secrets", "type": "http" }, "http": { "method": "POST", "url": "/SecretServer/api/v1/secrets/export", "body": { "type": "json", "data": "{}" } }, "docs": "Exports secrets" }, { "info": { "name": "Export Secrets File Job Creation", "type": "http" }, "http": { "method": "POST", "url": "/SecretServer/api/v2/secrets/export/job", "body": { "type": "json", "data": "{}" } }, "docs": "Export Secrets File Job Creation" }, { "info": { "name": "Update which Secrets are available for RPC scripts", "type": "http" }, "http": { "method": "PUT", "url": "/SecretServer/api/v1/secrets/:id/rpc-script-secrets", "params": [ { "name": "autoCheckIn", "value": "", "type": "query", "description": "Automatically check in a secret after finding or updating." }, { "name": "autoCheckout", "value": "", "type": "query", "description": "Automatically check out secret before finding or updating." }, { "name": "autoComment", "value": "", "type": "query", "description": "Leave a comment when checking in or out." }, { "name": "forceCheckIn", "value": "", "type": "query", "description": "If secret is checked out, then force a check in." }, { "name": "id", "value": "", "type": "path", "description": "id" }, { "name": "secretPath", "value": "", "type": "query", "description": "A full path including folder and secret name can be passed as a query string parameter when the secret ID is set to 0. This will lookup the secret ID by path." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update which Secrets are available for RPC scripts" }, { "info": { "name": "Undelete a Secret", "type": "http" }, "http": { "method": "PUT", "url": "/SecretServer/api/v1/secrets/:id/activate", "params": [ { "name": "id", "value": "", "type": "path", "description": "id" }, { "name": "secretPath", "value": "", "type": "query", "description": "A full path including folder and secret name can be passed as a query string parameter when the secret ID is set to 0. This will lookup the secret ID by path." } ] }, "docs": "Undelete a Secret" }, { "info": { "name": "Update which Secrets are available for RPC scripts", "type": "http" }, "http": { "method": "PUT", "url": "/SecretServer/api/v2/secrets/:id/rpc-script-secrets", "params": [ { "name": "autoCheckIn", "value": "", "type": "query", "description": "Automatically check in a secret after finding or updating." }, { "name": "autoCheckout", "value": "", "type": "query", "description": "Automatically check out secret before finding or updating." }, { "name": "autoComment", "value": "", "type": "query", "description": "Leave a comment when checking in or out." }, { "name": "forceCheckIn", "value": "", "type": "query", "description": "If secret is checked out, then force a check in." }, { "name": "id", "value": "", "type": "path", "description": "id" }, { "name": "secretPath", "value": "", "type": "query", "description": "A full path including folder and secret name can be passed as a query string parameter when the secret ID is set to 0. This will lookup the secret ID by path." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update which Secrets are available for RPC scripts" }, { "info": { "name": "Update Secret Security Approval Options", "type": "http" }, "http": { "method": "PUT", "url": "/SecretServer/api/v3/secrets/:id/security-approval", "params": [ { "name": "autoCheckIn", "value": "", "type": "query", "description": "Automatically check in a secret after finding or updating." }, { "name": "autoCheckout", "value": "", "type": "query", "description": "Automatically check out secret before finding or updating." }, { "name": "autoComment", "value": "", "type": "query", "description": "Leave a comment when checking in or out." }, { "name": "forceCheckIn", "value": "", "type": "query", "description": "If secret is checked out, then force a check in." }, { "name": "id", "value": "", "type": "path", "description": "id" }, { "name": "secretPath", "value": "", "type": "query", "description": "A full path including folder and secret name can be passed as a query string parameter when the secret ID is set to 0. This will lookup the secret ID by path." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update Secret Security Approval Options" }, { "info": { "name": "Undelete a Secret", "type": "http" }, "http": { "method": "PUT", "url": "/SecretServer/api/v2/secrets/:id/activate", "params": [ { "name": "id", "value": "", "type": "path", "description": "id" }, { "name": "secretPath", "value": "", "type": "query", "description": "A full path including folder and secret name can be passed as a query string parameter when the secret ID is set to 0. This will lookup the secret ID by path." } ] }, "docs": "Undelete a Secret" }, { "info": { "name": "Update a Secret expiration", "type": "http" }, "http": { "method": "PUT", "url": "/SecretServer/api/v1/secrets/:id/expiration", "params": [ { "name": "autoCheckIn", "value": "", "type": "query", "description": "Automatically check in a secret after finding or updating." }, { "name": "autoCheckout", "value": "", "type": "query", "description": "Automatically check out secret before finding or updating." }, { "name": "autoComment", "value": "", "type": "query", "description": "Leave a comment when checking in or out." }, { "name": "forceCheckIn", "value": "", "type": "query", "description": "If secret is checked out, then force a check in." }, { "name": "id", "value": "", "type": "path", "description": "id" }, { "name": "secretPath", "value": "", "type": "query", "description": "A full path including folder and secret name can be passed as a query string parameter when the secret ID is set to 0. This will lookup the secret ID by path." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a Secret expiration" }, { "info": { "name": "Update Restricted SSH Commands on a Secret", "type": "http" }, "http": { "method": "PUT", "url": "/SecretServer/api/v1/secrets/:secretId/update-ssh-restricted-commands", "params": [ { "name": "autoCheckIn", "value": "", "type": "query", "description": "Automatically check in a secret after finding or updating." }, { "name": "autoCheckout", "value": "", "type": "query", "description": "Automatically check out secret before finding or updating." }, { "name": "autoComment", "value": "", "type": "query", "description": "Leave a comment when checking in or out." }, { "name": "forceCheckIn", "value": "", "type": "query", "description": "If secret is checked out, then force a check in." }, { "name": "secretId", "value": "", "type": "path", "description": "secretId" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the restricted SSH commands configured on a Secret" }, { "info": { "name": "Update Jumpbox Route Selection", "type": "http" }, "http": { "method": "PUT", "url": "/SecretServer/api/v1/secret-detail/:secretId/jumpbox-route-selection", "params": [ { "name": "secretId", "value": "", "type": "path", "description": "secretId" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update Jumpbox Route Selection" } ] } ], "bundled": true }