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
      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
    4. Releases API

Update an application

Updates an existing error tracking application. Send only the parameters you wish to change.

PATCH https://errors.betterstack.com/api/v2/applications/{id}

URL parameters

id
required string

The ID of the application to update.

Headers

Authorization
required string

Bearer $TOKEN

Content-Type
required string

application/json

Body parameters

name
string

New application name. Must be unique within your team.

errors_retention
integer

New error data retention period in days.

ingesting_paused
boolean

Set to true to pause error ingestion, false to resume.

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. To disconnect a repository, provide an empty string or null.

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.

vrl_transformation_exceptions
string

The VRL code that groups incoming exceptions into errors. Send null to reset to the default grouping for the application's platform, or an empty string to remove the grouping program entirely. Read more about exception grouping.

vrl_transformation_replays
string

The VRL code applied to session replays during ingestion. Send an empty string to remove the transformation.

vrl_transformation_web_events
string

The VRL code applied to web events like page views and web vitals during ingestion. Send null to reset to the default web events transformation, or an empty string to remove it.

vrl_transformation_logs
string

The VRL code applied to logs during ingestion. Send an empty string to remove the transformation. Read more about VRL transformations.

vrl_transformation_spans
string

The VRL code applied to traces (spans) during ingestion. Send an empty string to remove the transformation.

custom_bucket
object

Rotates the key pair of the custom bucket the application already uses. Send only access_key_id and secret_access_key. We verify the new pair against the bucket first; if that fails, the whole request is rejected with a 422 and nothing is changed. A bucket shared by several applications is rotated for all of them. Send the new pair before deactivating the old one to rotate without downtime. A custom bucket can only be added when creating an application.

200

Returns the updated application.

Response body

{
  "data": {
    "id": "1234",
    "type": "application",
    "attributes": {
      "application_group_id": 5678,
      "correlate_with_source_id": 9876,
      "github_repository_name": "better-stack/my-app",
      "team_id": 123456,
      "team_name": "example-team",
      "name": "updated-web-app",
      "platform": "ruby_errors",
      "table_name": "updated_web_app",
      "token": "abc123def456ghi789",
      "js_tag_token": "pMq7kR3nXwT9bY2sF6hJ4dLc",
      "ingesting_paused": false,
      "ingesting_host": "s1234.us-east-9.betterstackdata.com",
      "created_at": "2025-01-15T10:30:00.000Z",
      "updated_at": "2025-01-15T10:35: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/",
      "vrl_transformation_exceptions": "._pattern = slice!(sha2(to_string!(.summary.type)), 0, 24)\n.",
      "vrl_transformation_replays": "",
      "vrl_transformation_web_events": ".payload.meta.path = parse_url!(.payload.meta.url).path\n.",
      "vrl_transformation_logs": "",
      "vrl_transformation_spans": ""
    }
  }
}
401

Unauthorized

Response body

{
  "errors": "Invalid authentication"
}
404

Not Found

Response body

{
  "errors": "Resource with the provided ID was not found"
}
422

Unprocessable Entity - Validation Errors

Response body

{
  "errors": "Validation errors",
  "invalid_attributes": {
    "name": [
      "already taken"
    ]
  }
}
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 PATCH \
  --url https://errors.betterstack.com/api/v2/applications/1234 \
  --header "Authorization: Bearer $TOKEN" \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "updated-web-app",
    "ingesting_paused": false,
    "github_repository_name": "better-stack/my-app",
    "code_mapping_stack_root": "/usr/src/app/",
    "code_mapping_source_root": "apps/backend/",
    "vrl_transformation_exceptions": "._pattern = slice!(sha2(to_string!(.summary.type)), 0, 24)"
  }'


Previous article

Create an application

Next article

Remove an application