Developers

API Reference

Integrate Sentry's intelligence into your own tools and workflows. This overview covers authentication, conventions, and the main capability areas of the API.

API access is available on plans that include it. If you'd like programmatic access or a full endpoint specification for your account, contact our team.

Overview

The Sentry API is a JSON over HTTPS interface. All requests and responses use application/json, and every request must be made over TLS. The base URL for your deployment is:

https://sentry.confidion.com/api

Conventions:

Standard HTTP status codes indicate success (2xx) or failure (4xx/5xx).
Errors return a JSON body with a message field describing the problem.
Timestamps are ISO 8601 (UTC).
List endpoints support pagination via page and per_page parameters.

Authentication

Requests are authenticated with a bearer token issued to your account. Pass it in the Authorization header on every request:

curl -X GET "https://sentry.confidion.com/api/searches" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json"

Keep your token secret — treat it like a password. Tokens can be rotated at any time, and a compromised token can be revoked from your account settings or by contacting support.

Rate limits

API usage is subject to per-plan rate limits. When you exceed your limit, the API responds with 429 Too Many Requests. Throttle your client and retry after a short backoff. Higher limits are available on enterprise plans.

Core capabilities

The API mirrors the platform's main building blocks. Representative resources include:

Search (FieldQuery)

POST/api/searchesStart an OSINT search

GET/api/searches/{id}/resultsRetrieve scored results

Feeds (OverWatch)

GET/api/feedsList monitored feeds

GET/api/feeds/{id}/itemsFetch recent feed items

Profiles (Nexus)

GET/api/entities/{id}Get an entity profile

Alerts

GET/api/alertsList threat alerts

POST/api/webhooksRegister a webhook for new alerts

Exact request and response schemas are tailored to your plan and deployment. Request the full, versioned specification when you enable API access.

Ready to build?

Talk to us about API access, rate limits, and webhook delivery for your integration.

Request API access