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. Fix with AI
    3. Releases
    4. Uploading source maps
  4. Integrations
    1. Reporting incidents
    2. Slack
    3. Microsoft Teams
    4. Linear
    5. Jira
    6. GitHub
  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 PATCH
      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.
The currently supported platforms are:
- aiohttp_errors
- android_errors
- angular_errors
- asgi_errors
- asp_dot_net_core_errors
- asp_dot_net_errors
- astro_errors
- aws_lambda_dot_net_errors
- aws_lambda_node_errors
- aws_lambda_python_errors
- azure_functions_node_errors
- bottle_errors
- bun_errors
- celery_errors
- chalice_errors
- cli_errors
- cloudflare_pages_errors
- connect_errors
- dart_errors
- deno_errors
- django_errors
- dot_net_errors
- dot_net_http_errors
- dot_net_maui_errors
- echo_errors
- electron_errors
- elixir_errors
- ember_errors
- express_errors
- falcon_errors
- fastapi_errors
- fasthttp_errors
- fastify_errors
- fiber_errors
- flask_errors
- flutter_errors
- gatsby_errors
- gin_errors
- go_errors
- godot_errors
- google_cloud_function_dot_net_errors
- google_cloud_function_node_errors
- google_cloud_function_python_errors
- hapi_errors
- ios_errors
- iris_errors
- java_errors
- javascript_errors
- koa_errors
- kotlin_errors
- laravel_errors
- log4j_errors
- logback_errors
- macos_errors
- minidump_errors
- native_errors
- negroni_errors
- nest_js_errors
- next_js_errors
- node_errors
- nuxt_errors
- php_errors
- powershell_errors
- pyramid_errors
- python_errors
- qt_errors
- quart_errors
- rack_middleware_errors
- rails_errors
- react_errors
- react_native_errors
- react_router_framework_errors
- remix_errors
- rq_errors
- ruby_errors
- rust_errors
- sanic_errors
- serverless_python_errors
- solid_errors
- solidstart_errors
- spring_boot_errors
- spring_errors
- starlette_errors
- svelte_errors
- sveltekit_errors
- symfony_errors
- tanstack_start_react_errors
- tornado_errors
- tryton_errors
- unity_errors
- unreal_engine_errors
- vue_errors
- windows_forms_errors
- wpf_errors
- wsgi_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.

correlate_with_source_id
string

ID of an existing Telemetry source to correlate errors with. This enables linking errors to logs and traces. Cannot be changed after creation.

github_repository_name
string

The full name of a GitHub repository (e.g., owner/repo) to connect to the application. The repository must be connected to your team via the GitHub integration first.

code_mapping_stack_root
string

The absolute path to the root of the stack trace on your server (e.g., /usr/src/app/). This is used to resolve source code paths for AI-assisted debugging.

code_mapping_source_root
string

The relative path from your project's root to the source code being deployed (e.g., apps/backend/). This is used to resolve source code paths for AI-assisted debugging.

201

Returns the newly created application.

Response body

{
  "data": {
    "id": "1234",
    "type": "application",
    "attributes": {
      "application_group_id": null,
      "correlate_with_source_id": "9876",
      "github_repository_name": "better-stack/my-app",
      "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,
      "code_mapping_stack_root": "/usr/src/app/",
      "code_mapping_source_root": "apps/backend/"
    }
  }
}
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"]
  }
}
422

Unprocessable Entity - GitHub Repository Not Connected

Response body

{
  "errors": {
    "github_repository_name": [
      "GitHub repository 'owner/repo' isn't connected to this team. Connect it first at https://errors.betterstack.com/team/t123/integrations/github/edit"
    ]
  }
}

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",
    "correlate_with_source_id": null,
    "github_repository_name": "better-stack/my-app",
    "code_mapping_stack_root": "/usr/src/app/",
    "code_mapping_source_root": "apps/backend/"
  }'


Previous article

Get a single application

Next article

Update an application