Sign in

v1

latestOpenAPI 3.0.3Apache 2.02026-07-142201861.5 MB
Integrations

Update a Data Forwarder for an Organization

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.

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

Path parameters

organization_id_or_slugstring required

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

data_forwarder_idinteger required

The ID of the data forwarder you'd like to query.

Request body

organization_idinteger required

The ID of the organization related to the data forwarder.

provider'segment' | 'sqs' | 'splunk' required

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

  • segment - Segment
  • sqs - Amazon SQS
  • splunk - Splunk
is_enabledboolean

Whether the data forwarder is enabled.

enroll_new_projectsboolean

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

configobject

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_idsinteger[]

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

Response

idstring required
organizationIdstring required
isEnabledboolean required
enrollNewProjectsboolean required
providerstring required
configobject nullable required
dateAddedstring date-time required
dateUpdatedstring date-time required