Explore documentation
  1. Welcome to Errors 👋
  2. Collecting errors
    1. Integrating using an AI prompt
    2. Sentry SDK
  3. Using the product
    1. Exception grouping
    2. Fix with AI
    3. Releases
  4. Integrations
    1. Reporting incidents
    2. Slack
    3. Microsoft Teams
    4. Linear
    5. Jira
  5. Errors API
    1. Getting an API token
    2. Applications API
      1. List all applications GET
      2. Get a single application GET
      3. Create an application POST
      4. Update an application PUT
      5. Remove an application DELETE
    3. Application groups API

Create an application

Creates a new error tracking application.

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

Headers

Authorization
required string

Bearer $TOKEN

Content-Type
required string

application/json

Body parameters

name
required string

Application name. Must be unique within your team.

platform
required string

The platform type for the application. This helps configure appropriate SDKs and integrations. Examples: ruby_errors, python_errors, javascript_errors. Must be suffixed with _errors.

data_region
string

Data region or cluster name where application data will be stored. If omitted, the default data region for your team will be used (e.g., us-east-9).

errors_retention
integer

Error data retention period in days. Default retention is 90 days.

application_group_id
string

ID of the application group this application belongs to.

201

Returns the newly created application.

Response body

{
  "data": {
    "id": "1234",
    "type": "application",
    "attributes": {
      "application_group_id": null,
      "team_id": 123456,
      "team_name": "example-team",
      "name": "new-web-app",
      "table_name": "new_web_app",
      "token": "abc123def456ghi789",
      "ingesting_paused": false,
      "ingesting_host": "s1234.us-east-9.betterstackdata.com",
      "created_at": "2025-01-15T10:30:00.000Z",
      "updated_at": "2025-01-15T10:30:00.000Z",
      "errors_retention": 90,
      "data_region": "us-east-9",
      "custom_bucket": null
    }
  }
}
401

Unauthorized

Response body

{
  "errors": "Invalid authentication"
}
400

Bad Request - Missing Required Attributes

Response body

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

Unprocessable Entity - Validation Errors

Response body

{
  "errors": [
    "platform must be suffixed with \"_errors\" for Errors applications"
  ],
  "invalid_attributes": [
    "platform"
  ]
}

Example cURL

Example
curl --request POST \
  --url https://errors.betterstack.com/api/v1/applications \
  --header "Authorization: Bearer $TOKEN" \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "new-web-app",
    "platform": "ruby_errors",
    "errors_retention": 90,
    "data_region": "us-east-9"
  }'

Previous article

Get a single application

Next article

Update an application