Rest APIs Usage

Access the REST API Swagger UI at https://[hostname]:[port]/openapi/ui/ on the server's SSL port.

Swagger UI is available at https://[hostname]:[port]/openapi/ui/ where [hostname] is the hostname of the Remote Control Server and [port] is the SSL port.

Every API is reachable from the Internet by using the hostname and the port of the Lite Web Portal. To get a new valid JWT the following endpoint can be used: https://[hostname]:[port]/oidc/endpoint/OIDCProvider/token of type GET where [hostname] is the hostname of the Lite Web Portal and [port] is the port of the Lite Web Portal.

Also send the following values as x-www-form-urlencoded (all the values are specified into the [server_installation]\BigFix\TRC\server\wlp\usr\servers\trcserver\rest_api.xml file):
  • grant_type
  • client_id
  • client_secret
  • scope
Note: Every API is able to read every session so share the client credentials only with trusted clients.