ThreatJammer.com User API

The public API open to the users. Read the docs and learn more..

General information

Description

Threat Jammer supports two end-user REST APIs: the User API and the Report API. The end-user uses the User API to interact with the different databases, heuristics, and machine learning processes. Devices use the Report API to interact with Threat Jammer. This document will explain how to use the User API and interact with the different services, create a token, interpret the quota information, and create the HTTP request to interact with the User API.

Authentication

The API is protected by a Bearer authentication schema. Bearer authentication (also called token authentication) is an HTTP authentication scheme that involves security tokens called bearer tokens. It is used to authenticate the user. All the different endpoints expect a Bearer token in the Authorization header.

Example:

curl -X 'GET'
  'https://dublin.api.threatjammer.com/test'
  -H 'accept: application/json'
  -H 'Authorization: Bearer YOUR_API_KEY'

You can obtain a token after registering on the ThreatJammer.com website for free.

Region specific tokens

All the Bearer tokens contain information about the authorized region. The developers have to use a token created for the region they want to use. A token used in a different region will return a 401 Unauthorized error.

Global errors

The API will return the following permanent errors:

• a 401 Unauthorized error if the token is not valid, or does not belong to the region.
• a 401 Unauthorized error if the token does not exist.
• a 401 Unauthorized error if the token is malformed.
• a 403 Forbidden error if the subscription level is not enough. Some endpoints are only available for paid subscription levels.

And these temporary errors:

• a 429 Too Many Requests error if the quota is exceeded (see below).

Quota limits

Every request to the User API will consume one (1) quota point.

The API has two rate limiting processes:

• a quota limit of 5000 requests per month for the FREE account. The limit is reset every month.
• a quota limit of 10 requests per minute for the FREE account. The limit is reset every minute and implements a sliding window mechanism.

Use this page to mock ThreatJammer.com User API in your testing and development.

Run our mock API sample using the open source WireMock library, or in the free edition of WireMock Cloud. You'll have a working API server simulating the behavior of ThreatJammer.com User API, which will allow you to keep building and testing even if the actual API you isn't currently available.