Retrieve Snapshot status check rules for a project

GET /api/0/projects/{organization_id_or_slug}/{project_id_or_slug}/preprod/snapshots/status-check-rules/

Retrieve the current Snapshot status check rules configured for a project.

Use this endpoint when external CI needs to evaluate the same Snapshot change-type rules that Sentry uses. The endpoint returns the current project configuration, not a historical snapshot from when a build was processed.

The response includes whether status check enforcement is enabled and the Snapshot change types that fail the status check.

This endpoint requires a bearer token with project:read access. Project distribution tokens are not supported.

Response notes:

  • enabled: false means status-check enforcement is disabled for the project.
  • rules contains one boolean per Snapshot change type.
  • failOnAdded, failOnRemoved, failOnChanged, and failOnRenamed indicate which unapproved change types fail the status check.

Path Parameters

organization_id_or_slug (string)
REQUIRED

The ID or slug of the organization the resource belongs to.

project_id_or_slug (string)
REQUIRED

The ID or slug of the project the resource belongs to.

Scopes

<auth_token> requires one of the following scopes:
  • project:admin
  • project:read
  • project:write
Copied
curl https://sentry.io/api/0/projects/{organization_id_or_slug}/{project_id_or_slug}/preprod/snapshots/status-check-rules/ \
 -H 'Authorization: Bearer <auth_token>'
RESPONSESCHEMA
Copied
{
  "enabled": true,
  "rules": {
    "failOnAdded": false,
    "failOnRemoved": true,
    "failOnChanged": true,
    "failOnRenamed": false
  }
}
Was this helpful?