Overview

AppViewX API offers a programmatic interface to interact and perform operations on AppViewX.

This guide covers the APIs for:

  • Create
  • Renew
  • Revoke
  • Reissue
  • Regenerate
  • Suspend
  • Reinstate
  • Discover certificates from a firewall and server
  • Push and Bind a certificate to a firewall and server
  • Rollback a certificate to a firewall and server
  • Download a certificate with or without a format
  • Get/Search Certificate Inventory
  • Get Available Server Profiles
  • Download a Private Key of a certificate
  • Delete a certificate using Universal Unique Identifier (UUID)

Universal Unique Identifier(UUID) is a unique id for each certificate. This id remains the same even if we generate the certificate numerous times. It is generated on the basis of certain attributes and properties of the certificate.

You can add, update, get and delete the attributes of life-cycle-related APIs for better flexibility.

It will also explain the steps to be followed after you have completed using the life-cycle-related APIs.

The request and response structure, a sample request, and a sample response is given for each API.

The APIs are available in two modes - async and sync.

In async mode, certificate generation will be requested and request id will be provided in the response.

In sync mode, the certificate will be generated immediately and the actual content of the certificate and rescourceId(resourceId is the same as certificateId) is sent in the response.

ResourceId is the same as certificate Id and is created by mongoDB for each certificate record.

The use of sync APIs is recommended if you need to create, renew, revoke, reissue, or regenerate a certificate immediately.

To use the sync mode, you have to set the parameter "isSync" to true and the parameter "ttl" should be greater than or equal to 300. This overrides the policy for request approvals of the Certificate.

The APIs to Create, Renew, Revoke, Reissue, Regenerate options are available in async and sync mode.

The APIs to Suspend, Reinstate, Search/Get Inventory options are available in async mode only.

You can use Sync and async APIs to Push and Bind as well as Rollback certificates to ADC devices/profiles.

You can get or search inventory using the API in async mode.

Note: If Approval is not required while using async API, you must call "search API" with the unique resourceId returned by the API response. If Approval is required while using async API, you must move the work order to the next stages by following the "Approval" and "Implement" APIs. If a certificate needs to be created immediately, you must use the sync API which would return the Certificate in the response.