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

Update a Check-In

PUT /api/0/organizations/{organization_slug}/monitors/{monitor_slug}/checkins/{checkin_id}/

Updates a check-in.

Once a check-in is finished (indicated via an ok or error status) it can no longer be changed.

If you simply wish to update that the task is still running, you can simply send an empty payload.

You may use latest for the checkin_id parameter in order to retrieve the most recent (by creation date) check-in which is still mutable (not marked as finished).

Path Parameters

organization_slug (string)
REQUIRED

The slug of the organization the resource belongs to.

monitor_slug (string)
REQUIRED

The slug of the monitor.

checkin_id (string)
REQUIRED

The ID of the check-in.

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/{checkin_id}/ \
 -H 'Authorization: Bearer <auth_token>' \
 -X PUT \
 -H 'Content-Type: application/json' \
 -d '{}'
RESPONSESCHEMA
.