ThreatJammer.com User API
The public API open to the users. [Read the docs and learn more.](https://threatjammer.com/docs). General information Description Threat Jammer supports two…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
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 Unauthorizederror if the token is not valid, or does not belong to the region. - a
401 Unauthorizederror if the token does not exist. - a
401 Unauthorizederror if the token is malformed. - a
403 Forbiddenerror if the subscription level is not enough. Some endpoints are only available for paid subscription levels.
And these temporary errors:
- a
429 Too Many Requestserror 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
FREEaccount. The limit is reset every month. - a quota limit of 10 requests per minute for the
FREEaccount. The limit is reset every minute and implements a sliding window mechanism.
Endpoints 96
Allowlist data query and management
- POSTCreates a new private allowlist binded to the user.
/v1/allowlist/privateWhat Creates a new allowlist with the information given and binded to the current user. The parameters are: name description tags expiry Time to Live (TTL)… - GETGet the set of private allowlists of the user.
/v1/allowlist/private/allWhat Obtain the set of private allow lists of the user available in the service. Parameters No parameters Result The result is a JSON object with a list of… - GETGet the set of private allowlists of the user by resource type.
/v1/allowlist/private/all/:resource_typeWhat Obtain the set of private allow lists of the user available in the service filtering by resource type. It can be CIDR, AS, COUNTRY, CONTINENT or… - GETGet the different private allowlists where the IP address was found.
/v1/allowlist/private/ip/:addressWhat Obtain the list of all the different private allowlists where the IP address entered by the user. The allowlisted forbidden datasets are the ones… - GETGet the details of a specific private allowlist of the user.
/v1/allowlist/private/:allowlist_idWhat Obtain the details of the private allow list of the user available in the service. Parameters Pass the private allowlist ID as query parameter. Result… - PUTUpdate the information of an existing private allowlist of the user.
/v1/allowlist/private/:allowlist_idWhat Updates the information that describes the allowlist of the user in the system. The parameters that can be modified are: name description tags expiry… - DELETEDelete all the bindings between a user and a private allowlist.
/v1/allowlist/private/:allowlist_idWhat Delete all the bindings between a user and a private allowlist. This will remove the content of the allowlist, the allowlist from the user and also all… - GETGet the content of a private allowlist of the user.
/v1/allowlist/private/:allowlist_id/contentWhat Returns the content of the private allowlist of the user. The content can be CIDRs, ASNs, countries, continents or datacenter IDs. Parameters Pass the… - PUTAdd or remove content of a private allowlist of the user.
/v1/allowlist/private/:allowlist_id/contentWhat Add or remove content of a private allowlist of the user. The content can be CIDRs, ASNs, countries, continents or datacenter IDs. The number of elements… - DELETEDelete all the content of a private allowlist of the user.
/v1/allowlist/private/:allowlist_id/contentWhat Delete all the content of a private allowlist of the user. This will remove all the elements, and there is no way to recover them. Parameters Pass the… - PUTToogle the status of the origin in an allow list.
/v1/allowlist/private/:allowlist_id/originWhat Change the status of the origin of an allow list to ACTIVE, INACTIVE or DELETED. An ACTIVE origin will apply the allow list to the protocol and domain of… - GETGet the set of public allowlists.
/v1/allowlist/public/allWhat Obtain the set of public allow lists available in the service and also which ones are already selected by the user and wich ones are not. Parameters No… - GETGet the set of public allowlists by resource type.
/v1/allowlist/public/all/:resource_typeWhat Obtain the set of public allow lists available in the service and also which ones are already selected by the user and wich ones are not filtering by the… - GETGet the different public allowlists where the IP address was found.
/v1/allowlist/public/ip/:addressWhat Obtain the list of all the different public allowlists where the IP address entered by the user is. The public allowlists are the ones activated by the… - GETGet the set of owned allowlists.
/v1/allowlist/public/ownedWhat Obtain the set of public allow lists available in the service selected by the user. Parameters No parameters Result The result is a JSON object with a… - GETGet the set of public allowlists of a user by resource type.
/v1/allowlist/public/owned/:resource_typeWhat Obtain the set of public allow lists selected by the user and wich ones are not filtering by the resource type. Parameters The resource type to filter.… - GETGet the details of the allowlist.
/v1/allowlist/public/:allowlist_idWhat Obtain the details of an allow list available in the service. Parameters No parameters Result The result is a JSON object with a list of the following… - PUTToogle the status of an allow list.
/v1/allowlist/public/:allowlist_idWhat Change the status of an allow list to ACTIVE or INACTIVE. An INACTIVE list will not be used by the service. An ACTIVE list will be used by the service.… - DELETEDelete all the bindings between a user and an allowlist.
/v1/allowlist/public/:allowlist_idWhat Delete all the bindings between a user and an allowlist. This will remove the allowlist from the user and also all the origins that are using the… - PUTToogle the status of the origin in an allow list.
/v1/allowlist/public/:allowlist_id/originWhat Change the status of the origin of an allow list to ACTIVE, INACTIVE or DELETED. An ACTIVE origin will apply the allow list to the protocol and domain of…
Autonomous Systems information
- GETGet the IPv4 or IPv6 prefix of the IP address given.
/v1/asn/ip/:ip_addressWhat Obtain the IPv4 or IPv6 prefix and the Autonomous System information of the IP address passed as a parameter. Parameters The endpoint accepts only the… - POSTGet the IPv4 or IPv6 prefix of the CIDR given.
/v1/asn/prefixWhat Obtain the IPv4 or IPv6 prefix and the Autonomous System information of the CIDR passed in the body as a POST method. This endpoint works around the… - GETGet the list of the Regional Internet Registries (RIRs) entities worldwide.
/v1/asn/registry/allWhat Obtain the list of Regional Internet Registries (RIRs) entities worldwide. Parameters No parameters are required. Result The result is a JSON object with… - GETGet the information of a Regional Internet Registries (RIRs) given.
/v1/asn/registry/:codeWhat Obtain the information about the Regional Internet Registries (RIRs) given as a parameter. Parameters The endpoint accepts only the following parameter… - GETGet the list of status of an object in a registry.
/v1/asn/status/allWhat Obtain the list of status of an object can be in a registry. Parameters No parameters are required. Result The result is a JSON object with a list of the… - GETGet the information of a status given.
/v1/asn/status/:codeWhat Obtain the information about the status of an object in the registry as a parameter. Parameters The endpoint accepts only the following parameter in the… - GETGet the Autonomous System details of the AS number given.
/v1/asn/:numberWhat Obtain the full details of the Autonomous System Number (ASN) passed as a parameter. Parameters The endpoint accepts only the following parameter in the… - GETGet the list of IPv4 and IPv6 prefixes of the AS number given.
/v1/asn/:number/prefixesWhat Obtain the full list of IPv4 and IPv6 prefixes of the Autonomous System Number (ASN) passed as a parameter. Parameters The endpoint accepts only the…
Data assessment
- POSTGet the risk score of all IP address passed in the body and other data signals.
/v1/assess/ipWhat Obtain a numerical score and a risk assessment of all the IP addresses passed as argument. Parameters A list of public IPv4 or IPv6 addresses is required… - POSTGet the risk score of all IP address uploaded and other data signals.
/v1/assess/ip/csv?strict_parse=falseWhat Obtain a numerical score and a risk assessment of all the IP addresses uploaded with a text file. Parameters A text file with a list of public IPv4 or… - GETGet a risk score of the IP address and different data signals.
/v1/assess/ip/:ip_addressWhat Obtain a numerical score and a risk assessment of the IP address passed as argument. Parameters The only argument accepted in the query string is a…
Datacenter information
- GETGet the IPv4 or IPv6 prefix of the IP address given.
/v1/datacenter/ip/:ip_addressWhat Obtain the IPv4 or IPv6 prefix and the Datacenter information of the IP address passed as a parameter. Parameters The endpoint accepts only the following… - POSTGet the IPv4 or IPv6 prefix of the CIDR given.
/v1/datacenter/prefixWhat Obtain the IPv4 or IPv6 prefix and the Datacenter information of the CIDR passed in the body as a POST method. This endpoint works around the problem of… - GETGet the Datacenter details of datacente given.
/v1/datacenter/:datacenter_idWhat Obtain the details of the Datacenter ID passed as a parameter. Parameters The endpoint accepts only the following parameter in the path: datacenter_id:… - GETGet the list of IPv4 and IPv6 prefixes of the Datacenter given.
/v1/datacenter/:datacenter_id/prefixesWhat Obtain the full list of IPv4 and IPv6 prefixes of the Datacenter passed as a parameter. Parameters The endpoint accepts only the following parameter in…
Platform datasets
- GETGet the list of all the datasets available in the platform.
/v1/dataset/ipWhat Obtain the list of all the datasets available in the platform. A dataset is a collection of different data sources that are related to a specific topic.… - GETGet the detailed information of the dataset queried.
/v1/dataset/ip/:nameWhat Get the detailed information of the dataset queried by the name. A dataset is a collection of different data sources that are related to a specific…
Denylist data query and management
- POSTCreates a new private denylist binded to the user.
/v1/denylist/privateWhat Creates a new denylist with the information given and binded to the current user. The parameters are: name description tags expiry Time to Live (TTL)… - GETGet the set of private denylists of the user.
/v1/denylist/private/allWhat Obtain the set of private deny lists of the user available in the service. These lists are different datasets: Lists that are part of the automatically… - GETGet the set of private denylists of the user by resource type.
/v1/denylist/private/all/:resource_typeWhat Obtain the set of private deny lists of the user available in the service filtering by resource type. It can be CIDR, AS, COUNTRY, CONTINENT or… - GETGet the different denylists where the IP address was found.
/v1/denylist/private/ip/:addressWhat Obtain the list of all the different denylists where the IP address entered by the user. The denylisted forbidden datasets are the ones submitted… - GETGet the details of a specific private denylist of the user.
/v1/denylist/private/:denylist_idWhat Obtain the details of the private deny list of the user available in the service. Parameters Pass the private denylist ID as query parameter. Result The… - PUTUpdate the information of an existing private denylist of the user.
/v1/denylist/private/:denylist_idWhat Updates the information that describes the denylist of the user in the system. The parameters that can be modified are: name description tags expiry This… - DELETEDelete all the bindings between a user and a private denylist.
/v1/denylist/private/:denylist_idWhat Delete all the bindings between a user and a private denylist. This will remove the content of the denylist, the denylist from the user and also all the… - GETGet the content of a private denylist of the user.
/v1/denylist/private/:denylist_id/contentWhat Returns the content of the private denylist of the user. The content can be CIDRs, ASNs, countries, continents or datacenter IDs. Parameters Pass the… - PUTAdd or remove content of a private denylist of the user.
/v1/denylist/private/:denylist_id/contentWhat Add or remove content of a private denylist of the user. The content can be CIDRs, ASNs, countries, continents or datacenter IDs. The number of elements… - DELETEDelete all the content of a private denylist of the user.
/v1/denylist/private/:denylist_id/contentWhat Delete all the content of a private denylist of the user. This will remove all the elements, and there is no way to recover them. Parameters Pass the… - PUTToogle the status of the origin in a deny list.
/v1/denylist/private/:denylist_id/originWhat Change the status of the origin of a deny list to ACTIVE, INACTIVE or DELETED. An ACTIVE origin will apply the deny list to the protocol and domain of… - GETGet the set of public denylists.
/v1/denylist/public/allWhat Obtain the set of public deny lists available in the service and also which ones are already selected by the user and wich ones are not. Parameters No… - GETGet the set of public denylists by resource type.
/v1/denylist/public/all/:resource_typeWhat Obtain the set of public deny lists available in the service and also which ones are already selected by the user and wich ones are not filtering by the… - GETGet the different public denylists where the IP address was found.
/v1/denylist/public/ip/:addressWhat Obtain the list of all the different public denylists where the IP address entered by the user is. The public denylists are the ones activated by the… - GETGet the set of owned denylists.
/v1/denylist/public/ownedWhat Obtain the set of public deny lists available in the service selected by the user. Parameters No parameters Result The result is a JSON object with a… - GETGet the set of public denylists of a user by resource type.
/v1/denylist/public/owned/:resource_typeWhat Obtain the set of public deny lists selected by the user and wich ones are not filtering by the resource type. Parameters The resource type to filter.… - GETGet the details of the denylist.
/v1/denylist/public/:denylist_idWhat Obtain the details of an deny list available in the service. Parameters No parameters Result The result is a JSON object with a list of the following… - PUTToogle the status of an deny list.
/v1/denylist/public/:denylist_idWhat Change the status of an deny list to ACTIVE or INACTIVE. An INACTIVE list will not be used by the service. An ACTIVE list will be used by the service. As… - DELETEDelete all the bindings between a user and an denylist.
/v1/denylist/public/:denylist_idWhat Delete all the bindings between a user and an denylist. This will remove the denylist from the user and also all the origins that are using the denylist.… - PUTToogle the status of the origin in a deny list.
/v1/denylist/public/:denylist_id/originWhat Change the status of the origin of a deny list to ACTIVE, INACTIVE or DELETED. An ACTIVE origin will apply the deny list to the protocol and domain of… - GETGet the list of automatically reported IP addresses by the user.
/v1/denylist/reported/ip?dataset=string&reported_before=0&reported_after=0&expires_before=0&expires_after=0&greater_than=0&less_than=0&ip_protocol_version=ALL&output_format=JSONWhat Obtain the list of all the IPv4 or IPv6 addresses that have been automatically reported by the user. A user can report automatically an IP address with… - DELETEDelete all the automatically reported IP addresses by the user.
/v1/denylist/reported/ip/allWhat Delete all the IP addresses that have been automatically reported by the user. This option cannot be reverted. Parameters No parameters are required.… - GETGet the details of an automatically reported IP addresses by the user.
/v1/denylist/reported/ip/:ip_addressWhat Obtain the details of an IPv4 or IPv6 addresses that have been automatically reported by the user. A user can report automatically an IP address with the… - DELETEDelete the automatically reported IP address by the user.
/v1/denylist/reported/ip/:ip_addressWhat Delete an IP address that was automatically reported by the user. This option cannot be reverted. Parameters The endpoint accepts the following…
Geolocation
- POSTGet the geolocation data of the IP addresses set.
/v1/geoWhat Get the geo location data of all the IP addresses passed as argument. This information includes: Latitude and longitude Time zone Accuracy radius Postal… - POSTGet the geolocation data of all the IP addresses uploaded.
/v1/geo/csv?strict_parse=falseWhat Get the geo location data of all the IP addresses uploaded in a text file. This information includes: Latitude and longitude Time zone Accuracy radius… - GETGet the geo location data of the IP address.
/v1/geo/:ip_addressWhat Get the geo location data of the IP address passed as argument. This information includes: Latitude and longitude Time zone Accuracy radius Postal code…
Data logging
- GETGet a log event.
/v1/log/ip/id/:logchange_idWhat Obtain the full detail of a specific log change. Parameters The endpoint accepts only the following parameters in the path: logchange_id: (Mandatory) A… - GETGet the changes logged in the different datasets of an IP address.
/v1/log/ip/:ip_address?dataset=string&logged_after=0What Obtain a list of changes logged in the different datasets of the IP address given. Parameters The endpoint accepts the following parameters in the path:…
Origin management in this region
- GETGet the information of an origin of the user in the region.
/v1/origin?query=stringWhat Obtain the attributes of the origin of the user passed as argument in the selected region. The purpose of this function is to display the information of… - PUTUpdate the configuration of an origin of the user in the region.
/v1/originWhat Modify the configuration metadata of the origin of the user in the selected region. The origin is a combination of protocol and domain (Ex:… - GETGet the address status of the origin of the user in the region.
/v1/origin/addresses?query=string&page=1&page_size=20What Obtain the status that trigger the change in the status of the origin of a specific IP address. The status will also describe the current state of the… - GETGet the information of the origins of the user in the region.
/v1/origin/allWhat Obtain the attributes of all the origins of the user in the selected region. The purpose of this function is to display the information of configuration… - GETGet the type of clients of the trafffic of the origin.
/v1/origin/client/analysis?query=string&interval=HOURLY&from_timestamp=0&to_timestamp=0What Obtain the type of clients of trhe traffic in the specified time range and interval. Thequery will return the number of requests and the different type… - GETGet the tracking cookie ID status of the origin of the user in the region.
/v1/origin/cookies?query=string&page=1&page_size=20What Obtain the status that trigger the change in the status of the origin of the cookie ID used to track the users. The status will also describe the current… - GETGet the code snippets of an origin of the user in the region.
/v1/origin/scripts?query=stringWhat Obtain the code snippets of the origin of the user passed as argument in the selected region. The purpose of this function is to help the user to… - POSTGet the current cookie ID and IP address status of the origin of user in the region.
/v1/origin/status?query=stringWhat Obtain the current status of the origin for a given IP address and/or cookie ID. The values can be correlated, but they are not required to be. The… - GETGet detail of a status available in the platform.
/v1/origin/status/detail/:status_idWhat Obtain the description of a status available in the platform. Parameters A status_id parameter in the path of the request: PASS BLOCK CHALLENGE BYPASS… - GETGet the list of different status available in the platform.
/v1/origin/status/detailsWhat Obtain the full list and description of the different status available in the platform. Parameters No parameters needed. Result The result is a JSON list… - GETGet the traffic analysis of the origin.
/v1/origin/traffic/analysis?query=string&interval=HOURLY&from_timestamp=0&to_timestamp=0What Obtain the traffic analysis of the origin in the specified time range and interval. Theanalysis will return the number of requests and the anomalies…
Origin Token management in this region
- POSTGet the information of an origin token of the user in the region.
/v1/origin_tokenWhat Obtain the attributes of the given origin token of the user in the selected region. The purpose of this function is to show what protocol and domain is… - DELETEDelete an origin token of the user in the region.
/v1/origin_tokenWhat Deletes the origin token passed as argument of the user in the selected region. Once the token is deleted, it will no longer be valid and the protocol… - GETGet the information of the origin tokens of the user in the region.
/v1/origin_token/allWhat Obtain the attributes of all the origin tokens of the user in the selected region. The purpose of this function is to show what protocol and domain is… - PUTDisable a enabled origin token of the user in the region.
/v1/origin_token/disableWhat Disable an enabled origin token passed as argument of the user in the selected region. When a token is enabled, it will participate in the protection of… - PUTEnable a disabled origin token of the user in the region.
/v1/origin_token/enableWhat Enable a disabled origin token passed as argument of the user in the selected region. When a token is enabled, it will participate in the protection of… - POSTCreate an origin token of the user in the region.
/v1/origin_token/newWhat Creates a new origin token for the user passing as argument the origin. The origin parameter is the protocol and the domain where the origin token is…
Data sources
- GETGet the full information of all the source lists for the subscription level given.
/v1/source/ipWhat Obtain the full meta information of all the source lists available for the subscription level of the user. A source list is a collection of resources… - GETGet the full information of the source list given as argument.
/v1/source/ip/:sourceWhat Obtain the full meta information of the source list given as argument. A source list is a collection of resources combined together with other sources to… - GETGet the information of the source list given for a specific time range.
/v1/source/ip/:source/range/:time_rangeWhat Obtain the meta information of the source list and the time range given as arguments. A source list is a collection of resources combined together with…
Authentication Token management in this region
- GETGet the information of the user's token in the region.
/v1/tokenWhat Obtain the list of all the token attributes of the current user in the selected region. The purpose of this function is to show the current values of the… - GETGet the activity information of the token in the region.
/v1/token/activity?page=1&page_size=20What Obtain the list of all the activity events of the current user in the selected region. The purpose of this function is to show what actions performed a…
User Agent
- POSTGet the information found in a set of User Agents.
/v1/uaWhat Get the information found in the list of User Agents passed as argument. This information includes: Type Render Engine Version Vendor Operating System… - POSTGet the information found in the set of User Agents uploaded.
/v1/ua/csvWhat Get the information found in the list of User Agents uploaded as a CSV file. This information includes: Type Render Engine Version Vendor Operating… - GETGet the information of the device of a user agent.
/v1/ua/device/:codeWhat Obtain the details of a device of a User Agent. Parameters The endpoint accepts only the following parameter in the path: code: (Mandatory) The code that… - GETGet the information of the family of a user agent.
/v1/ua/family/:codeWhat Obtain the details of a family of a User Agent. Parameters The endpoint accepts only the following parameter in the path: code: (Mandatory) The code that… - GETGet the information of the Operating System of a user agent.
/v1/ua/os/:codeWhat Obtain the details of the Operating System of a User Agent. Parameters The endpoint accepts only the following parameter in the path: code: (Mandatory)… - GETGet the information of the type of a user agent.
/v1/ua/type/:codeWhat Obtain the details of a type of a User Agent. Parameters The endpoint accepts only the following parameter in the path: code: (Mandatory) The code that… - GETGet the information of the vendor of a user agent.
/v1/ua/vendor/:codeWhat Obtain the details of a vendor of a User Agent. Parameters The endpoint accepts only the following parameter in the path: code: (Mandatory) The code that… - GETGet the information found in an User Agent.
/v1/ua/:user_agent_urlencodedWhat Get the information found in the User Agent passed as argument. This information includes: Type Render Engine Version Vendor Operating System Device How…
API details
- Authentication
- A bearer token in the Authorization header
- Operations
- 96 operations on 81 pathsGET 61PUT 13POST 13DELETE 9
- Main resources
- Denylist data query and management 24Allowlist data query and management 20Origin management in this region 11Autonomous Systems information 8User Agent 8Origin Token management in this region 6Datacenter information 4Data assessment 3Data sources 3Geolocation 3
- Response formats
application/json- Description format
- OpenAPI 3.0.2, API version
1.2.20 - Links
- Documentation · OpenAPI document · Support
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the ThreatJammer.com User API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the ThreatJammer.com User API collection, without the publisher's secrets.
- Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Creates a new private allowlist binded to the user.” (POST /v1/allowlist/private), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the ThreatJammer.com User API?
The public API open to the users. [Read the docs and learn more.](https://threatjammer.com/docs). General information Description Threat Jammer supports two… It is listed under Other and has 96 endpoints.
Who publishes the ThreatJammer.com User API?
It is listed from Threatjammer's public API description (an OpenAPI document), not published by Threatjammer on Swastik Codes. Anyone who controls threatjammer.com can claim the profile by adding a DNS TXT record.
How do I authenticate with the ThreatJammer.com User API?
With A bearer token in the Authorization header.
How many endpoints does the ThreatJammer.com User API have?
96 operations on 81 paths (61 GET, 13 PUT, 13 POST, 9 DELETE). The largest groups are Denylist data query and management, Allowlist data query and management, Origin management in this region, Autonomous Systems information.
Is forking the ThreatJammer.com User API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.