Skip to main content
POST
Create datasource

Restrictions

Usage

  • type_ident must be one of: prometheus, loki, mysql, oracle, postgres, clickhouse, elasticsearch, sls, victorialogs.
  • edge_cluster_name specifies which Monitors edge cluster evaluates rules using this datasource.
  • For elasticsearch, set payload.elasticsearch.deployment to cloud or self-managed.
  • Every call is recorded in the account audit log. Don’t put secrets in request fields.

Authorizations

app_key
string
query
required

App key issued from the Flashduty console under Account → APP Keys. Required on every public API call. Keep it secret — it grants the same access as the owning account.

Body

application/json

Request body for creating or updating a datasource. id is required only for update. address is required for all types except Elasticsearch with deployment=cloud.

type_ident
string
required

Datasource type identifier. Allowed: prometheus, loki, mysql, oracle, postgres, clickhouse, elasticsearch, sls, victorialogs.

name
string
required

Datasource display name.

payload
object
required

Type-specific configuration block. Must include the key matching type_ident.

edge_cluster_name
string
required

Monitors edge cluster name responsible for evaluating rules using this datasource.

id
integer<uint64>

Datasource ID. Required for update; omit for create.

note
string

Optional description.

address
string

Connection address. For Prometheus/Loki/VictoriaLogs: HTTP URL. For MySQL/Oracle/Postgres/ClickHouse: host:port. For SLS: endpoint without http/https prefix. Not required for Elasticsearch cloud deployment.

Response

Success

Success response envelope. On every 2xx response, request_id identifies the call (also mirrored in the Flashcat-Request-Id header) and data holds the endpoint-specific payload. Failure responses use a different shape — see ErrorResponse.

request_id
string
required

Unique ID for this request. Mirrored in the Flashcat-Request-Id response header. Include it when reporting issues.

Example:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object
required

A monitoring datasource.