REST Web Services API Reference and Download

Overview

The Secret Server REST API guides are version specific. In fact, they are automatically generated when a Secret Server version is created. Thus, to ensure you have the correct guides for your Secret Server version, it is best (but not required) to access the documentation from that version of Secret Server; however there are many reasons why this might not be practical, so we provide download links below.

Accessing the Guides

To access the guides:

1. For Secret Server versions 10.5.3 and later with the new user interface, click the icon in the top right of the dashboard and click Secret Server REST API Guide. The Secret Server REST API Guide page appears.

2. Accessing Secret Server through the API and scripts can be powerful mechanism but ensure you are following best practices with the account and access for any script connecting to Secret Server. The Secret Server Software Development Kit for DevOps is recommended for all automated or machine-to-machine scripts. If not using the SDK, creating an application account for the script access and limiting the permissions both from Role perspective and on Secret themselves is security best practice.

3. On the Secret Server REST API page of your instance, click the link for one of the three guides:

   • Documentation for REST API using bearer token authentication: Hyperlinked documentation for REST API access using token authentication.
   • Documentation for token authentication: Instructions for getting an authentication token.
   • Documentation for REST API using Windows integrated authentication: Hyperlinked documentation for REST API access using Integrated Windows Authentication (IWA).

Downloading the Guides

Current Version

Click the icon in the top right of the dashboard and click Secret Server REST API Guide. The Secret Server REST API Guide page appears.

Version Archive

• Secret Server 11.6.000003 REST API Guide
• Secret Server 11.5.000002 REST API Guide
• Secret Server 11.4.000031 REST API Guide
• Secret Server 11.4.000002 REST API Guide
• Secret Server 11.3.000003 REST API Guide
• Secret Server 11.1.000007 REST API Guide
• Secret Server 11.0.000008 REST API Guide
• Secret Server 11.0.000007 REST API Guide
• Secret Server 11.0.000006 REST API Guide
• Secret Server 10.9.000064 REST API Guide
• Secret Server 10.9.000033 REST API Guide
• Secret Server 10.8.000000 REST API Guide
• Secret Server 10.7.000000 REST API Guide
• Secret Server 10.6.000000 REST API Guide
• Secret Server 10.5.000000 REST API Guide
• Secret Server 10.4.000000 REST API Guide
• Secret Server 10.3.000000 REST API Guide
• Secret Server 10.2.000000 REST API Guide
• Secret Server 10.1.000000 REST API Guide