Sign in

v1

latestOpenAPI 3.0.02026-07-17101019.2 KB
sink

validate a sink configuration without saving it

post/sinks/validate

Request body

OR

Example request

{
  "name": "my-prom-sink",
  "description": "An example prometheus sink",
  "tags": {
    "cloud": "aws"
  },
  "backend": "prometheus",
  "config": {
    "exporter": {
      "remote_host": "my.prometheus-host.com"
    },
    "authentication": {
      "username": "dbuser"
    }
  }
}

Response

Sink object

idstring uuid required

Unique identifier (UUID)

namestring

A unique name label

descriptionstring

User description of this Sink

tagsobject

User defined key/values for organization and searching

state'active' | 'error'

State of this Sink connection to the backend

errorstring

Error message from Sink backend connection if the Sink is in error state

backendstring

The sink backend to use. Must match a backend from /features/sinks. Cannot change once created.

configobject

Object representing backend specific configuration information

config_datastring

YAML representing backend specific configuration information

format'yaml' | 'json'

Format that the config will be passed on

ts_createdstring date-time

Timestamp of creation

Example response

{
  "name": "my-prom-sink",
  "description": "An example prometheus sink",
  "tags": {
    "cloud": "aws"
  },
  "backend": "prometheus",
  "config": {
    "exporter": {
      "remote_host": "my.prometheus-host.com"
    },
    "authentication": {
      "username": "dbuser"
    }
  }
}