Explore documentation
  1. Welcome to Errors
    1. JavaScript tag
  2. Collecting errors
    1. Integrating using an AI prompt
    2. Sentry SDK
  3. Using the product
    1. Exception grouping
    2. AI prompt
    3. Releases
    4. Uploading source maps
    5. Spike protection
  4. Integrations
    1. Reporting incidents
    2. Slack
    3. Microsoft Teams
    4. Linear
    5. Jira
    6. GitHub
    7. Outgoing webhooks
  5. Errors API
    1. Getting an API token
    2. Applications API
    3. Application groups API

Create a release

Registers a new release. A release registered at build time shows up in Better Stack immediately, before its first error arrives.

POST https://errors.betterstack.com/api/v1/releases

Headers

Authorization
required string

Bearer $TOKEN

Content-Type
required string

application/json

Body parameters

version
required string

Release version or commit reference (e.g., v1.2.3).

applications
array

Array of application IDs to attach the release to. When omitted, the release is attached to every application that already reports this version. Omitting it is the typical choice when recording a deploy.

environment
string

Environment this release was deployed to (e.g., production). Pass an array to record multiple environments.

team_id
string

ID of the team to register the release for, bare or t-prefixed (e.g., 123456 or t123456). Scopes a version-only registration to that team's applications. Needed with a global API token, which spans all your teams.

201

Returns the registered release. The releases array lists the affected release IDs, one per application.

Response body

{
  "version": "v1.2.3",
  "applications": [
    123
  ],
  "environment": "production",
  "releases": [
    {
      "id": 456,
      "application_id": 123
    }
  ]
}
401

Unauthorized

Response body

{
  "errors": "Invalid authentication"
}
422

Unprocessable Entity - Missing Required Attributes

Response body

{
  "errors": "Sorry, you are missing some required attributes",
  "required_attributes": [
    "version"
  ]
}
422

Unprocessable Entity - Unknown Application

Response body

{
  "errors": "Sorry, some values are incorrect",
  "invalid_values": {
    "applications": "Unknown applications: 999"
  }
}

Example cURL

Example
curl --request POST \
  --url https://errors.betterstack.com/api/v1/releases \
  --header "Authorization: Bearer $TOKEN" \
  --header 'Content-Type: application/json' \
  --data '{
    "version": "v1.2.3",
    "applications": [123],
    "environment": "production"
  }'