Purpose

The Admin Portal is the application provided to end-users to configure their ThreatSTOP Platform account, such as device configuration, policies or custom lists.

This document provides a description and reference for the API associated with the account configuration - the ThreatSTOP Platform API.

Documentation Layout

The API documentation includes the following sections, accessible using the menu on the left:

Section Description
Technical Overview Technical description of this API
Data Model Overview of the objects managed by the Portal and the relationships between them
Service Features Description of the features available in each service
Reference Syntax of each API operation
Models Schema of the requests and response objects associated with each service
Tutorials Examples for typical API use-cases
Tables Lists of settings and values
Appendix Additional information

The ThreatSTOP Admin Portal

The ThreatSTOP Admin Portal is a web application, reachable at https://admin.threatstop.com.

Access to the Admin Portal is provided to ThreatSTOP’s customers and to the customers of ThreatSTOP’s partners so to configure accounts settings.

Configuration changes performed using the API will be reflected in the Admin Portal application, and vice-versa.

The configuration settings managed using the ThreatSTOP Admin Portal are:

  • Account global settings
  • Device configuration
  • Policy configuration
  • User-defined List management
  • SIEM Integration settings
  • Users and roles

Additionally, the API supports access to ThreatSTOP’s Check IOC feature to retrieve the Threat Intelligence data for IP addresses and domains in ThreatSTOP’s systems.

API Access

Access to the API is an optional feature of the ThreatSTOP platform. Access can be granted for the configuration services and to the Check IOC service independently.

Partner Portal API

ThreatSTOP provides an different REST API for managing the provisioning of new accounts. While both API share similar designs, they are separate systems. This includes different access rules and different API keys.

If you are looking for the Partner Portal API, its documentation is located here.