Sign in

v1

latestOpenAPI 3.0.3Apache 2.02026-07-142201861.5 MB
Integrations

Create a Data Forwarder for an Organization

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.

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

Path parameters

organization_id_or_slugstring required

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

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