Skip to main content
API docs by Redocly

Saturn Monitoring API (1.0.0)

Download OpenAPI specification:Download

Saturn Support: support@saturn.example.com URL: https://saturn.example.com License: Proprietary

Saturn API for cron and scheduled job monitoring with anomaly detection.

Authentication

Use Bearer token authentication:

Authorization: Bearer <TOKEN>

Get tokens from the Saturn dashboard under Settings → Tokens.

Ping

Send pings from monitored jobs

Send start ping

Signal that a job has started execution

Authorizations:
bearerAuth
path Parameters
monitorId
required
string
Example: mon_abc123xyz

Unique monitor identifier

Responses

Response samples

Content type
application/json
{
  • "received": true,
  • "runId": "run_abc123"
}

Send success ping

Signal that a job completed successfully

Authorizations:
bearerAuth
path Parameters
monitorId
required
string
Example: mon_abc123xyz

Unique monitor identifier

Request Body schema: application/json
durationMs
integer

Job duration in milliseconds

output
string

Job output (stdout/stderr)

Responses

Request samples

Content type
application/json
{
  • "durationMs": 12456,
  • "output": "Backup completed\n5000 files processed"
}

Response samples

Content type
application/json
{
  • "received": true,
  • "runId": "run_abc123"
}

Send fail ping

Signal that a job failed

Authorizations:
bearerAuth
path Parameters
monitorId
required
string
Example: mon_abc123xyz

Unique monitor identifier

Request Body schema: application/json
exitCode
integer

Process exit code

durationMs
integer

Job duration in milliseconds

output
string

Error output

Responses

Request samples

Content type
application/json
{
  • "exitCode": 1,
  • "durationMs": 3200,
  • "output": "ERROR: Database connection failed"
}

Response samples

Content type
application/json
{
  • "received": true,
  • "runId": "run_abc123"
}

Monitors

Manage monitors

List monitors

Get all monitors for the authenticated organization

Authorizations:
bearerAuth
query Parameters
page
integer
Default: 1
limit
integer <= 100
Default: 50

Responses

Response samples

Content type
application/json
{
  • "monitors": [
    ],
  • "total": 0,
  • "page": 0,
  • "limit": 0
}

Incidents

View and manage incidents

List incidents

Get incidents for the authenticated organization

Authorizations:
bearerAuth
query Parameters
status
string
Enum: "OPEN" "ACKNOWLEDGED" "RESOLVED"
type
string
Enum: "MISSED" "LATE" "FAIL" "ANOMALY"
monitorId
string

Responses

Response samples

Content type
application/json
{
  • "incidents": [
    ]
}

Acknowledge incident

Mark an incident as acknowledged

Authorizations:
bearerAuth
path Parameters
incidentId
required
string
Request Body schema: application/json
note
string

Responses

Request samples

Content type
application/json
{
  • "note": "Investigating database connection"
}

Response samples

Content type
application/json
{
  • "id": "inc_abc123",
  • "type": "MISSED",
  • "severity": "LOW",
  • "status": "OPEN",
  • "monitorId": "mon_xyz789",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "acknowledgedAt": "2019-08-24T14:15:22Z",
  • "resolvedAt": "2019-08-24T14:15:22Z",
  • "details": { }
}

Resolve incident

Mark an incident as resolved

Authorizations:
bearerAuth
path Parameters
incidentId
required
string
Request Body schema: application/json
note
string

Responses

Request samples

Content type
application/json
{
  • "note": "Fixed database credentials"
}

Response samples

Content type
application/json
{
  • "id": "inc_abc123",
  • "type": "MISSED",
  • "severity": "LOW",
  • "status": "OPEN",
  • "monitorId": "mon_xyz789",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "acknowledgedAt": "2019-08-24T14:15:22Z",
  • "resolvedAt": "2019-08-24T14:15:22Z",
  • "details": { }
}

Webhooks

Webhook event deliveries