Create a Data Forwarder for an Organization

POST /api/0/organizations/{organization_id_or_slug}/forwarding/

Creates a new data forwarder for an organization. Only one data forwarder can be created per provider for a given organization.

Project-specific overrides can only be created after creating the data forwarder.

Path Parameters

organization_id_or_slug (string)
REQUIRED

The ID or slug of the organization the resource belongs to.

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

<auth_token> requires one of the following scopes:
  • org:write
Copied
curl https://sentry.io/api/0/organizations/{organization_id_or_slug}/forwarding/ \
 -H 'Authorization: Bearer <auth_token>' \
 -H 'Content-Type: application/json' \
 -d '{}'
RESPONSESCHEMA
Copied
.
Was this helpful?