LoadNinja REST API (or LoadNinja API) is used for accessing LoadNinja data and for integration with external systems. It is available to all LoadNinja customers.
The API has a web interface that contains and describes all the available API operations and parameters, and allows you to make API calls and view the returned data.
To access the API web interface, go to:
Keep in mind that the web interface accesses and changes real-world data.
Base URL and scheme
To access the API from external tools and utilities, use the following base URL:
The LoadNinja API uses HTTPS as the transfer protocol (scheme).
Data format headers
LoadNinja API operations use the JSON data format for request bodies.
To provide the server with the correct information about the body format, append the following header to the requests that have a body:
Since most operations also return JSON data, please add the
Accept header to your requests as well:
LoadNinja API uses the following status codes for responses:
|200||The request was completed successfully. LoadNinja sent the expected response.|
|400||The request is missing the authorization header, or the authorization key is invalid.|
|500||The request was not processed due to an internal error. For example, the client tried to access a non-existing resource, or used a wrong HTTP method.|
Note: An error response may contain additional information on the error within the request body.