DigitalOcean API (unofficial showcase)
POST/v2/monitoring/sinks/destinations

Create a logging destination

Creates a logging destination for sending logs to a managed or externally managed OpenSearch cluster. Supply type and config, including the cluster endpoint; include credentials unless you provide a managed cluster's cluster_uuid. A 200 response returns the created destination.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

3 body fields

Logging destination configuration. Include the required type and config fields.

namestringoptional
destination name
typestringrequired
The destination type. `opensearch_dbaas` for a DigitalOcean managed OpenSearch cluster or `opensearch_ext` for an externally managed one.
Allowed:opensearch_dbaasopensearch_ext
configobjectrequired
OpenSearch connection settings. Include the cluster `endpoint`; credentials are optional when you provide `cluster_uuid`.

6 status codes
200Returns a destination object containing the created destination's identifier, name, type, and configuration.
destinationobjectoptional
401Returned when authentication fails because the supplied credentials are invalid.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.
404Returned when a referenced resource is not found.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.
429Returned when the API rate limit has been exceeded.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.
500Returned when a server error occurs.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.
defaultThere was an unexpected error.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.

Error handling

A 401 is returned when authentication credentials are invalid. A 404 is returned when a referenced resource is not found, and a 429 is returned when the API rate limit is exceeded. A 500 indicates a server error; type must be opensearch_dbaas or opensearch_ext, and config must include endpoint.