Skip to main content
POST
Test a cluster log source

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-ankra-organisation-id
string

PAT organisation override.

Path Parameters

cluster_id
string<uuid>
required

Body

application/json

A log store to probe. Name a stored credential with credential_name, or send a new one in credential; nothing is stored.

provider
string | null
endpoint
string | null
credential_name
string | null
tenant_id
string | null
index_pattern
string | null
credential
object | null
verify_ssl
boolean
default:false

Response

The probe outcome.

The outcome of a read-only connection probe through the cluster's agent.

ok
boolean
required
message
string
required
sample_count
integer

Series or log lines the probe read; present when ok.

error_code
string

Why the probe failed; present when not ok.

upstream_status_code
integer | null

The status the source answered with, when it answered.