API Usage
Our API utilizes Swagger and Swashbuckle to automatically generate, update, and display documentation (which means it works automatically on self-hosted environments), is a great resource for our users that want to get their hands dirty and use Exceptionless data to roll their own tools, dashboards, etc.
-
Setup
-
Accessing the API
-
Get Your User Scoped Token
-
Get a New Token
-
Usage
-
Posting an Event
-
Get Event by Reference ID
-
Get Event via Search Filter
-
Get Organizations and Projects
-
How to Authenticate to the API
- Bearer Authentication
- Authenticate via Query String
To access the Exceptionless API, visit https://api.exceptionless.io and click on the “API Documentation” link to be taken to the API documentation.
Go to Auth controller action and enter your login credentials.
Enter JSON into the model field, or click the yellow box on the right to pre-populate the field with acceptable JSON fields. Just replace the values you want to specify and remove the fields you don’t need, like invite token.
Click “Try it out!” and generate your token. Take note of the response messages section above the button, as it details the possible codes that would be returned in the event of an error (e.g. 401 if the user name or email address was incorrect).
Take your generated token and put it in the “api_key” field at the top of the page and click “Explore.” This authorizes you via bearer authentication, authenticates you to the rest api, and allows you to call controller actions.
Now you have to get a new token for the project you want to work on and assign it a user role (scope) of “user.” We want to get a new user scoped token because we want to do more than just post events (client scoped tokens only allow you to post events), we want to retrieve them. Creating a new token also allows us to revoke the token later.
First, get your project ID from the Exceptionless Dashboard. It can be found in the URL of that project’s dashboard.
