Raygun API Beta
Raygun's API is currently in beta to allow for thorough testing and feedback. While the API is fully stable and secure, there may still be some changes made to improve its functionality and usability.
Raygun is committed to providing a industry leading API that meets the needs of its users and welcomes any suggestions or concerns during this beta phase.
Raygun's API allows you to access your Raygun data so that you can display, manipulate and process it in other tools, scripts and applications.
Following the OpenAPI standard, you can see the full specification here and a list of endpoints below.
Access to the API is managed via Personal Access Tokens.
note: Every user on your plan can create personal access tokens for the applications they have access to.
Authentication
Raygun's API is secured using Bearer Authentication using Personal Access Tokens.
Each request must include a Personal Access Token as the Bearer token in the Authorization request header.
Authorization: Bearer <Raygun PAT>
Unauthorised requests will result in an HTTP 401 status code.
If you are seeing an HTTP 401 response you should check:
- your request includes a Personal Access Token in the
Authorizationheader - the Personal Access Token is not expired
- the Personal Access Token has the required scopes assigned for the endpoint
API rate limits
There are limits to the number of API calls your application can make.
- Minute Limit: 60 calls per minute
- Daily Limit: 5000 calls per day
Each API Response will include three response headers:
X-Rate-Limit-Limit- indicates what rate limit period is active, either 1m or 1dX-Rate-Limit-Remaining- will indicate how many requests remain in the periodX-Rate-Limit-Reset- indicates when the rate limit period will be reset
Exceeding a rate limit will result in an HTTP 429 status code in the response. You can use the response headers above to determine when the next successful call can be made.
Endpoints
Currently, the following endpoints and scopes are available:
| Name | Description | Scope required |
|---|---|---|
| Get all applications | Returns a list of all applications for the plan and the user which the token belongs to | applications:read |
| Get application by ID | Returns application details by ID, if it exists and the token provides access to the application | applications:read |
| Get application by API key | Returns application details by API key, if it exists and the token provides access to the application | applications:read |
| Regenerate API key | Regenerates the API key for the given application | applications:write |
| Get plans | Returns the plan(s) which the token belongs to | <Not Applicable> |
We are always extending our offering of endpoints and scopes. You can make a request for your most needed API endpoints here.
This is version 3 of Raygun's API. While we transition previous versions the Reporting API and RUM API will remain available.