POST /v2/databases/{database_cluster_uuid}/logsink

To create logsink for a database cluster, send a POST request to /v2/databases/$DATABASE_ID/logsink.

Servers

Path parameters

Name Type Required Description
database_cluster_uuid String Yes

A unique identifier for a database cluster.

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
sink_type String Yes

Type of logsink integration.

  • Use datadog for Datadog integration only with MongoDB clusters.
  • For non-MongoDB clusters, use rsyslog for general syslog forwarding.
  • Other supported types include elasticsearch and opensearch.

More details about the configuration can be found in the config property.

Possible values:

  • "rsyslog"
  • "elasticsearch"
  • "datadog"
  • "opensearch"
sink_name String Yes

The name of the Logsink

config Object Yes

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.