Opening the REST API Discovery Tool

The Cherwell REST API Discovery Tool (Swagger) can be found by appending the following parameters to the CSM site name URL:

/CherwellApi/swagger/ui/index

Logging in to the Discovery Tool

To log in to the Discovery Tool, you need:

  • An API client ID. See Obtaining API Client IDs.
  • A CSM login ID and password.
  • An API Client Secret ID (reserved for Cherwell Software use only).

To log in to the Discovery Tool:

  1. Enter the key into the client_id box.
  2. Click the Authentication button for a specific operation, and then provide your CSM credentials.