Link Search Menu Expand Document

The Certdog REST API

All functions (including all administrative operations) can be carried out via the REST API

Swagger

The available REST API functions can be viewed using the Swagger UI as follows:

Ensure that certdog is running. Open a browser and navigate to:

https://endpoint/certdog/api/swagger-ui.html

E.g.

https://127.0.0.1/certdog/api/swagger-ui.html

If you see something like the following:

image-20210121152518748

Then everything should be working OK

Scroll down and all of the API methods should be presented

Trying out the API

Scroll down to the login-controller and expand the tab. Click Try it out

image-20210121153238903

Enter values for the username and password and click Execute. Scroll down to the response:

image-20210121153421520

Copy the value returned for token, scroll up to the top of the page and click image-20210121153547479

image-20210121153646947

Paste in the value for token copied from the response above and click Authorize then Close

You can now try out the other methods (that require authorization)