Releases let Sentry correlate errors with specific versions of your application. By tracking releases you can identify which version introduced a bug, which release resolved it, and how many new issues appeared in each deploy.
List releases for an organization
GET /api/0/organizations/{organization_id_or_slug}/releases/
project:releases
Path parameters
The ID or slug of the organization.
Query parameters
Filters releases to those whose version string starts with the given value.
Pagination cursor from the Link response header.
Example request
curl https://sentry.io/api/0/organizations/my-org/releases/ \
-H "Authorization: Bearer <token>"
Example response
[
{
"id": 2,
"version": "2.0rc2",
"shortVersion": "2.0rc2",
"ref": "6ba09a7c53235ee8a8fa5ee4c1ca8ca886e7fdbb",
"url": null,
"dateCreated": "2018-11-06T21:20:08.033Z",
"dateReleased": null,
"commitCount": 0,
"deployCount": 0,
"newGroups": 0,
"lastCommit": null,
"lastDeploy": null,
"authors": [],
"projects": [
{ "name": "Pump Station", "slug": "pump-station" }
],
"data": {}
}
]
Response fields
The internal ID of the release.
The release version string (commit hash, semver, etc.).
A shortened version of the version string for display purposes.
An optional commit reference (e.g. a branch name or tag).
An optional URL pointing to the release (e.g. a changelog or CI build).
ISO 8601 timestamp of when the release was created in Sentry.
ISO 8601 timestamp of when the release went live, if provided.
Number of commits associated with this release.
Number of deploys for this release.
Number of new issues first seen in this release.
Details of the most recent deploy for this release.
A list of projects associated with this release.
Create a release
POST /api/0/organizations/{organization_id_or_slug}/releases/
project:releases
Path parameters
The ID or slug of the organization.
Request body
A version identifier such as a commit hash, semver string, or custom version.
A list of project slugs that this release is associated with.
An optional commit reference (e.g. a branch name or tag).
An optional URL for the release (e.g. a CI build or changelog).
ISO 8601 timestamp of when the release went live. Defaults to the current time.
An optional list of commit objects to associate with the release. Each commit may include id (required), repository, message, author_name, author_email, timestamp, and patch_set.
An optional list of repository refs. Each ref requires repository and commit, and optionally previousCommit.
Example request
curl -X POST https://sentry.io/api/0/organizations/my-org/releases/ \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{
"version": "2.0rc2",
"ref": "6ba09a7c53235ee8a8fa5ee4c1ca8ca886e7fdbb",
"projects": ["pump-station"]
}'
Example response
{
"id": 2,
"version": "2.0rc2",
"shortVersion": "2.0rc2",
"ref": "6ba09a7c53235ee8a8fa5ee4c1ca8ca886e7fdbb",
"url": null,
"dateCreated": "2019-01-03T00:12:55.109Z",
"dateReleased": null,
"newGroups": 0,
"commitCount": 0,
"deployCount": 0,
"projects": [
{ "name": "Pump Station", "slug": "pump-station" }
]
}
Create a deploy
POST /api/0/organizations/{organization_id_or_slug}/releases/{version}/deploys/
project:releases
Path parameters
The ID or slug of the organization.
The version string of the release to deploy.
Request body
The environment being deployed to (e.g. production, staging).
An optional name for the deploy (e.g. a deployment pipeline name).
An optional URL that points to the deploy output.
ISO 8601 timestamp of when the deploy started.
ISO 8601 timestamp of when the deploy finished.
Example request
curl -X POST https://sentry.io/api/0/organizations/my-org/releases/2.0rc2/deploys/ \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{"environment": "production", "name": "Deploy #42"}'
Example response
{
"id": "6883490",
"name": "Deploy #42",
"url": null,
"environment": "production",
"dateStarted": null,
"dateFinished": "2019-01-03T00:12:55.109Z"
}
