Update a Data Forwarder for an Organization

PUT /api/0/organizations/{organization_id_or_slug}/forwarding/{data_forwarder_id}/

Updates a data forwarder for an organization or update a project-specific override. Updates to the data forwarder's configuration require org:write permissions, and the entire configuration to be provided, including the project_ids field.

To configure project-specific overrides, specify only the following fields:

'project_id': The ID of the project to create/modify the override for.
'overrides': Follows the same format as config but all provider fields are optional, since only specified fields are overridden.
'is_enabled': To enable/disable the forwarder for events on the specific project.

Overrides can be performed with project:write permissions on the project being modified.

Path Parameters

organization_id_or_slug (string) REQUIRED: The ID or slug of the organization the resource belongs to.
data_forwarder_id (integer) REQUIRED: The ID of the data forwarder you'd like to query.

Body Parameters

organization_id (integer) REQUIRED

The ID of the organization related to the data forwarder.

provider (string) REQUIRED

The provider of the data forwarder. One of "segment", "sqs", or "splunk".

segment - Segment
sqs - Amazon SQS
splunk - Splunk

is_enabled (boolean)

Whether the data forwarder is enabled.

enroll_new_projects (boolean)

Whether to enroll new projects automatically, after they're created.

config (object)

The configuration for the data forwarder, specific to the provider type. For a 'sqs' provider, the required keys are queue_url, region, access_key, secret_key. If using a FIFO queue, you must also provide a message_group_id, though s3_bucket is optional. For a 'segment' provider, the required keys are write_key. For a 'splunk' provider, the required keys are instance_url, index, source, token.

project_ids (array(integer))

The IDs of the projects connected to the data forwarder. Missing project IDs will be unenrolled if previously enrolled.

Scopes

You need to authenticate via bearer auth token.

<auth_token> requires one of the following scopes:

org:write

Copied

curl https://sentry.io/api/0/organizations/{organization_id_or_slug}/forwarding/{data_forwarder_id}/ \
 -H 'Authorization: Bearer <auth_token>' \
 -X PUT \
 -H 'Content-Type: application/json' \
 -d '{}'

RESPONSESCHEMA

Copied
{
  "id": "1",
  "organizationId": "1",
  "isEnabled": true,
  "enrollNewProjects": true,
  "enrolledProjects": [],
  "provider": "sqs",
  "config": {
    "region": "us-east-1",
    "queue_url": "https://sqs.us-east-1.amazonaws.com/01234567890/sentry-errors.fifo",
    "s3_bucket": "sentry-errors-bucket",
    "access_key": "AKIAIOSFODNN7EXAMPLE",
    "secret_key": "wJalrXUtnFEMI1K7MDENGSbPxRfiCYEXAMPLEKEY",
    "message_group_id": "sentry-errors"
  },
  "projectConfigs": [],
  "dateAdded": "2025-11-01T00:00:00.000000Z",
  "dateUpdated": "2025-11-01T00:00:00.000000Z"
}

Was this helpful?