The following endpoint provides a Swagger UI to visualize and interact with the CA Gateway REST API. 

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

See the table below for a description of each field.

Field

Value

​{host}

The hostname or IP address of the CA Gateway host server

{port}

The port of the CA Gateway service

{server.servlet.context-path}

The value of the server.servlet.context-path configuration parameter

CA Gateway includes this UI to assist developers with API integrations, but it is not for, nor will it be supported for, production use. It is not a substitute for an administrator UI. We recommend using Entrust Certificate Hub 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 tenant or integrator credential.

  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.