DESK API

Use the DESK API to automate your monitoring tasks and export different types of data into your third-party reporting and analysis tools. API communication ensures safety by using secured communication via the HTTPS protocol.

API Explorer

You can access all DESK API endpoints using the API Explorer.

1. Select Settings in the navigation menu.
2. Go to Integration > DESK API.
3. Click the DESK API Explorer link at the top of the page.

Alternatively you can access the API via direct link:

• Managed https://{your-domain}/e/{your-environment-id}/rest-api-doc/index.jsp
• SaaS https://{your-environment-id}.live.dexp.ae/api-doc/index.jsp

Authentication in the API Explorer

For every API endpoint, click the lock icon to show a dialog with information about the API tokens that secure the endpoint. Each endpoint demands a specific type of token.

You can also unlock all the endpoints, by clicking the global Authorize button. In the dialog, you can see which token permissions are necessary for all API endpoints. By entering your API token into the global Available authorizations dialog, you unlock all related API endpoints.

Try out an API call

Once you've entered your API token, you can directly execute API calls within the API explorer. A click on the Try it out button opens the parameter section of the selected API endpoint, where you can enter additional parameters and modify the request payload before executing it by clicking the Execute button.

Environment API