Feeling bold?
Sentry's Docs BotAsk A Bot
Product
API
Changelog
Sandbox
Sign In

Create a New Check-In

POST /api/0/organizations/{organization_slug}/monitors/{monitor_slug}/checkins/

Creates a new check-in for a monitor.

If status is not present, it will be assumed that the check-in is starting, and be marked as in_progress.

To achieve a ping-like behavior, you can simply define status and optionally duration and this check-in will be automatically marked as finished.

Note: If a DSN is utilized for authentication, the response will be limited in details.

Path Parameters

organization_slug (string)
REQUIRED

The slug of the organization the resource belongs to.

monitor_slug (string)
REQUIRED

The slug of the monitor.

Body Parameters

status (string)
REQUIRED

The status of the job run.

  • ok - 1
  • error - 2
  • in_progress - 3
duration (integer)

Duration of the job run, in milliseconds.

environment (string)

Name of the environment.

Scopes

<auth_token> requires one of the following scopes:
  • project:admin
  • project:read
  • project:write
curl https://sentry.io/api/0/organizations/{organization_slug}/monitors/{monitor_slug}/checkins/ \
 -H 'Authorization: Bearer <auth_token>' \
 -H 'Content-Type: application/json' \
 -d '{}'
RESPONSESCHEMA
.