The following endpoint povides a Swagger UI for visualizing and interacting with the CA Gateway REST API. CA Gateway includes this UI to assist developers in API integrations.

https://{host}:84444/{server.servlet.context-path}/swagger-ui

Where:

  • {host} is the hostname or IP address of the CA Gateway host server.
  • {server.servlet.context-path} is the value of the server.servlet.context-path parameter in the application.yml configuration file. 

This UI is not for, nor will it be supported, in the production uses of CA Gateway. It is not a substitute for an administrator UI. We recommend using Entrust's Certificate Manager or an equivalent interface provided by another product.

To test CA Gateway with Swagger

  1. In the  application.yml file, configure a tenant, or an integrator.
  2. Install the tenant or integrator credential in the browser.
  3. Make sure that the certification chain of the CA Gateway TLS certificate is trusted.

  4. Navigate to the URL of the Swagger UI. For example:

    https://localhost:8444/cagw/swagger-ui
  5. When prompted by the browser, select the credential of the tenant or integrator.

  6. Use the Swagger options to generate curl commands. For example, the following command lists the CAs visible to the tenant or integrator. 

    curl --cert-type P12 --cert tentant.p12:mypassword -X GET "https://cicd-cagw.dev.entrust.local/cagw/v1/certificate-authorities" -H "accept: application/json"

    When running curl commands, some Linux versions do not support authenticating with a P12 file.