SigSentry Documentation

REST endpoints for analyses, configuration, and integrations — everything callable with a SigSentry API key

The SigSentry API is a REST API over HTTPS. JSON in, JSON out, every response wrapped in a consistent envelope. Endpoints are tenant-scoped via your API key.

Base URL

https://api.sigsentry.com/v1

All paths in this reference are relative to that base.

Quick start

Get an API key

Create one in the dashboard at Project → API Keys → New key. Copy the key — you'll only see it once. See API Keys → Creating.

Send an authenticated request

Pass the key in the Authorization header:

curl https://api.sigsentry.com/v1/analyses \
  -H "Authorization: Bearer ss_secret_..."

Read the response envelope

Every response uses the same shape:

{
  "success": true,
  "data": { /* resource */ }
}

On error:

{
  "success": false,
  "error": { "code": "VALIDATION_ERROR", "message": "..." }
}

What's documented here

Authentication

API key format, headers, and project scoping

Analyses

Create, fetch, list, and follow up on diagnoses

Log Sources

Configure log connectors programmatically

Code Repos

Connected repositories and cache management

Notification Channels

Slack, Teams, webhooks, and channel preferences

Watchdog

Monitoring rules — CRUD, dry-run, activity feed

Projects

Create and manage projects within your organization

Access List

Per-project user access control for chat triggers

API Keys

Manage keys via API — list, create, revoke

Usage

Current quota status and consumption

Outgoing webhooks

Payload reference for webhooks SigSentry sends to your channels

What lives in the dashboard

A handful of actions are managed in the SigSentry web app rather than through the API — usually because they belong to a signed-in human identity:

API key minting and revocation — see API Keys
Billing — checkout, plan changes, cancellation
Team management — invitations, role changes, member removal
Per-user notification preferences (mute, severity floor, snooze)
Master watchdog switch at Project → Watchdog → Settings
Login, signup, OAuth flows

If you have a use case that needs one of the above exposed programmatically, talk to us at support@sigsentry.com.

API Reference