API

Table of Contents

• Overview
  • Authentication
  • Data formats
  • Errors
  • Rate limiting
• Reference
  • Root endpoint
  • Plugins
    • Get a plugin
    • List plugin reports
    • Get a report
    • List plugin entities
    • Delete a plugin
  • User
    • Get the current user
    • List user plugins
    • List user webhooks
    • Create a webhook
    • Get a webhook
    • Delete a webhook
  • Test queue
    • List jobs in queue
    • Add a job to the queue
  • Miscellaneous
    • List plugin tables

Authentication

This site uses API keys to authenticate API requests. To create or manage API keys, log in and click the "API Keys" option in the account menu.

When making a request, add an apiKey query parameter and set it to your key. Example:
https://plugintests.com/api/v1/user?apiKey=exampleKey

Data formats

• The API always returns JSON responses.
• Endpoints that accept POST requests can handle both form-encoded and JSON-encoded request bodies.

Errors

When there is an error, the API returns a HTTP response code in the 4xx or 5xx range. The response body contains a JSON document with an error key that may provide more information about the error.

For example, if you request a non-existent plugin, you will get a 404 status code and a JSON document like this:

{
    "error": {
        "message": "Plugin not found.",
        "code": "plugin_not_found"
    }
}

Rate limiting

By default, you can make up to 60 requests per minute. Some endpoints and actions have very different rate limits. You can see the applicable rate limits in the settings of each API key.

Most responses also include special HTTP headers that provide information about the rate limit.

Header name	Description
RateLimit-Limit	The maximum number of requests during a certain time window. Example: 100, 100;w=60 100 - maximum number of requests. 100;w=60 - the applicable rate limit policy is 100 requests per 60 seconds.
Ratelimit-Remaining	How many requests you can still make in the current time window.
Ratelimit-Reset	Time until the rate limit resets, in seconds. Note that different endpoints can have separate rate limits that reset at different times.

Example:

RateLimit-Limit: 200, 200;w=3600
Ratelimit-Remaining: 198
Ratelimit-Reset: 1715

Rate limit headers may be absent if there is a 4xx/5xx error. However, those requests still count against the limit.

If you exceed the rate limit, you will receive an error response with the status code 429 (Too Many Requests).