⚠️ Forwarder Healthcheck
GET {{cb_url}}/data_forwarder/v1/orgs/{{cb_org_key}}/configs/{{cb_forwarder_id}}/health_check
This call can be used to run a healthcheck on an Forwarder to determine if the forwarder is able to write to the specified S3 Bucket using the existing configuration. The healthcheck can indicate if the bucket is misconfigured (i.e. incorrect permissions, principle arn, etc.), if the configuration is incorrect (i.e. bucket prefix doesn’t match path specified in policy), or if the forwarder is working as expected. If successful, the healthcheck will write a test message called healthcheck.json to your S3 bucket and respond with a 200, regardless of whether the API was able to write to the bucket.
RBAC Permissions Required
| Permission (.notation name) | Operation(s) |
|---|---|
| event-forwarder.settings | READ |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string |