DevOpsACCELERATE REST API¶
The DevOpsACCELERATE REST API provides access to the functionality that is available via the DevOpsACCELERATE Web user interface (UI). Any functionality you can do in the UI is also available in the REST API. This capability allows you to automate operations that are present in the UI.
The REST API follows the latest best practices in API design. For example, the use of JSON for encapsulating objects returned by the API, the use of proper HTTP verbs and status codes, and the use of comprehensive error messages in failed requests to aid developers in diagnosing issues.
Common use cases for the DevOpsACCELERATE API include:
Interrogating your organization’s DevOpsACCELERATE account to understand what certificate issuance policies are enforced.
Requesting certificates from DevOpsACCELERATE for use by applications, such as HTTPS-enabled web servers.
Searching DevOpsACCELERATE to understand what certificates have been issued by your organization. You can also get information about certificates that have been discovered by Venafi’s global reputation system.
Building custom reports, based on certificate data and summary information, to help track key and certificate management policy compliance.
The sections that follow describe how to use the DevOpsACCELERATE REST API. To help you get started, the following table lists basic tasks. You can use this guide in conjunction with our documentation.
The Swagger documentation provides in depth descriptions and samples for all API calls.
|I want the Venafi Cloud™ REST API to ...||Visit this topic|
|Create a user account and get an API key||Registering an API user and Obtaining an API key|
|Get a certificate||Requesting certificates|
|Renew a certificate||Renewing a certificate|
|Show certificate enrollment settings||Getting policy information for a zone|
|Show certificate information||Certificate search via the API|
|Show certificate policy information||Get policy information for a zone|