POST /v2/monitoring/sinks/destinations

To create a new destination, send a POST request to /v2/monitoring/sinks/destinations.

Servers

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
name String No

destination name

config Object Yes
config.retention_days Integer No

Number of days to retain logs in an OpenSearch cluster.

Default value: 14

config.cluster_uuid String No

A unique identifier for a managed OpenSearch cluster.

config.cluster_name String No

Name of a managed OpenSearch cluster.

config.credentials Object No

Credentials for an OpenSearch cluster user. Optional if cluster_uuid is passed.

config.credentials.username String No
config.credentials.password String No
config.index_name String No

OpenSearch index to send logs to.

config.endpoint String Yes

host of the OpenSearch cluster

type String Yes

The destination type. opensearch_dbaas for a DigitalOcean managed OpenSearch cluster or opensearch_ext for an externally managed one.

Possible values:

  • "opensearch_dbaas"
  • "opensearch_ext"

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.