API reference

Every operation, grouped by what it works on. Fields for learned anomaly detection, which SignalSitter doesn’t offer, are left out of these pages. Each page’s raw contract and the OpenAPI document still include them.

Download OpenAPIAuthenticationllms-full.txt

Heartbeats

Send beats, and check a beat before it counts.

• Publish heartbeatPOST/{monitor_key}Send a beat to tell SignalSitter your job ran. Put measurements in the body to check them against your limits.
• Test a beatPOST/v1/monitors/{monitorId}/test-beatTry a beat against a monitor without recording it. Use it to check your request and measurements before going live.

Monitors

Create, configure, pause and remove monitors, and see their change history.

• List monitorsGET/v1/monitorsList your monitors with their current status, so you can see which are healthy, late or in an incident.
• Create monitorPOST/v1/monitorsCreate a monitor and set how often you expect beats. It's ready for its first beat straight away.
• Get monitorGET/v1/monitors/{monitorId}Get one monitor's settings, status and latest beat.
• Update configurationPATCH/v1/monitors/{monitorId}Change how a monitor works: how often beats are due, the grace period, its measurements and its incident settings.
• Change lifecyclePOST/v1/monitors/{monitorId}/lifecyclePause or resume a monitor, archive or restore it, or schedule a maintenance window when beats are expected to stop.
• Wait for first beatGET/v1/monitors/{monitorId}/activationCheck whether a new monitor has received its first beat, and when the next one is due. Use it to confirm a setup worked.
• List changesGET/v1/monitors/{monitorId}/changesSee the history of changes to a monitor's settings and status, newest first.
• Delete monitorDELETE/v1/monitors/{monitorId}Delete a monitor for good. Its key can't be used again.

Observations

Read the beats a monitor received and chart its measurements.

• List observationsGET/v1/monitors/{monitorId}/observationsList the beats a monitor has received, newest first, with any measurements they carried.
• Read seriesGET/v1/monitors/{monitorId}/observation-seriesGet a measurement's values over time, grouped into time buckets, ready to chart.

Rule workbench

Draft limits for a monitor, test them against its history, then apply them.

• Create draftPOST/v1/monitors/{monitorId}/rule-workbench/draftsStart drafting new limits for a monitor, tested against a snapshot of its recent history.
• Read draftPOST/v1/monitors/{monitorId}/rule-workbench/drafts/readGet a draft and the limits it proposes.
• Update draftPOST/v1/monitors/{monitorId}/rule-workbench/drafts/updateChange the limits in a draft.
• Replay draftPOST/v1/monitors/{monitorId}/rule-workbench/drafts/replaySee which past readings would have broken your current limits and your proposed ones, before you apply anything.
• Apply draftPOST/v1/monitors/{monitorId}/rule-workbench/drafts/applyMake a draft's limits live on the monitor. It's refused if the monitor or the draft changed since you last read them.
• Cancel draftPOST/v1/monitors/{monitorId}/rule-workbench/drafts/cancelThrow a draft away without changing the monitor.

Incidents

Find incidents, acknowledge, annotate and resolve them, and check their alerts.

• List all incidentsGET/v1/incidentsList incidents across all your monitors, newest first.
• List monitor incidentsGET/v1/monitors/{monitorId}/incidentsList one monitor's incidents, newest first.
• Get incidentGET/v1/monitors/{monitorId}/incidents/{incidentId}Get one incident and where it stands now.
• Get timelineGET/v1/monitors/{monitorId}/incidents/{incidentId}/timelineSee everything that happened during an incident, in order.
• Acknowledge incidentPOST/v1/monitors/{monitorId}/incidents/{incidentId}/acknowledgeLet others know you're on it. The incident stays open.
• Annotate incidentPOST/v1/monitors/{monitorId}/incidents/{incidentId}/annotationsAdd a note to an incident, such as what you found or did. Notes can't be edited later.
• Resolve incidentPOST/v1/monitors/{monitorId}/incidents/{incidentId}/resolveClose an incident yourself.
• List deliveriesGET/v1/monitors/{monitorId}/incidents/{incidentId}/deliveriesSee every alert sent for an incident, and whether each one reached its destination.
• RedeliverPOST/v1/monitors/{monitorId}/incidents/{incidentId}/deliveries/{intentId}/redeliverSend an alert again, for example after fixing your webhook.

Callbacks

Manage where alerts go, for each monitor and by default.

• List endpointsGET/v1/callbacksList the places your alerts can go: your webhooks and WhooshBang destinations.
• Create endpointPOST/v1/callbacksAdd a place to send alerts: a webhook URL, a person through WhooshBang, or everyone in your organization through WhooshBang. A webhook's signing secret is shown once, so save it.
• Get endpointGET/v1/callbacks/{endpointId}Get one alert destination.
• Update endpointPATCH/v1/callbacks/{endpointId}Rename an alert destination, change where it points, or switch it off and on.
• Rotate signing secretPOST/v1/callbacks/{endpointId}/rotateGet a new signing secret for a webhook. The old secret keeps working for a short overlap while you switch over.
• Send test deliveryPOST/v1/callbacks/{endpointId}/testSend a test alert to a destination and see what it answered.
• Remove endpointDELETE/v1/callbacks/{endpointId}Delete an alert destination for good. To stop alerts for a while, switch it off instead.
• Get monitor bindingGET/v1/monitors/{monitorId}/callbackSee where a monitor's alerts go: your default destination, a specific one, a URL of its own, or nowhere.
• Set monitor bindingPUT/v1/monitors/{monitorId}/callbackChoose where a monitor's alerts go: your default destination, a specific one, a URL of its own, or nowhere.
• Get default endpointGET/v1/organization/callback-defaultSee which destination monitors use when they're set to the default.
• Set default endpointPUT/v1/organization/callback-defaultChoose the destination monitors use when they're set to the default, or clear it.

Projects

Group monitors into projects.

• List projectsGET/v1/projectsList your organization's projects.
• Create projectPOST/v1/projectsCreate a project to group monitors.
• Get projectGET/v1/projects/{projectId}Get one project.
• Rename projectPATCH/v1/projects/{projectId}Rename a project. Its ID stays the same.
• Archive or restorePOST/v1/projects/{projectId}/lifecycleArchive a project you no longer use, or restore it.
• Delete projectDELETE/v1/projects/{projectId}Delete a project and everything in it, for good.

API credentials

Create, rotate and revoke the credentials your scripts and agents use.

• List credentialsGET/v1/credentialsList your API credentials. Secrets are never shown after creation.
• Create credentialPOST/v1/credentialsCreate an API credential for a script, service or agent. Its secret is shown once, so store it safely.
• Get credentialGET/v1/credentials/{credentialId}Get one credential's details. The secret isn't included.
• Rotate credentialPOST/v1/credentials/{credentialId}/rotateReplace a credential's secret. The new secret is shown once.
• Revoke credentialDELETE/v1/credentials/{credentialId}Revoke a credential so it stops working.

Organization

See your organization, plan and usage, choose a default region, and export your data.

• Get organizationGET/v1/organizationSee which organization and credential a request is acting as.
• Get entitlementsGET/v1/organization/entitlementsSee your plan, its limits, and how much of each you're using.
• Get usageGET/v1/organization/usageSee your organization's usage totals.
• Get default jurisdictionGET/v1/organization/default-jurisdictionSee which region new monitors are created in by default.
• Set default jurisdictionPUT/v1/organization/default-jurisdictionChoose which region new monitors are created in. Existing monitors don't move.
• Export dataGET/v1/organization/exportDownload your monitors, beats, incidents and usage. Secrets aren't included.

Billing

See your subscription status and what a plan change or cancellation does to your monitors.

• Get billing statusGET/v1/organization/billingSee your subscription status, and whether you're in a payment grace period.
• Preview cancellationGET/v1/organization/billing/cancellation-impactBefore cancelling, see what would happen to each of your monitors.
• List allotment transitionsGET/v1/organization/billing/allotment-transitionsSee which monitors were suspended or released when your plan changed.

API metadata

Download the full API description.

• Get OpenAPI documentGET/v1/openapi.jsonDownload the full API description (OpenAPI) to generate a client or hand to an agent.