Skip to main content

Drain service (v1)

Download OpenAPI specification:Download

push

Push new events to drain

header Parameters
X-Scope-OrgID
string

Tenant header

Api-Version
string

API version

Content-Encoding
string

Content encoding: 'snappy' or empty for Promtail payload, 'cobrick' for DRAIN-based compressed payload

Request Body schema: application/x-protobuf
required

Binary representation of the events to be pushed

One of
string <byte>

Responses

Request samples

Content type
application/x-protobuf
null

Response samples

Content type
application/json
null

regex

Get the preparser regular expressions list

header Parameters
Api-Version
string

API version

Responses

Response samples

Content type
application/json
null

merge

Store and merge log templates

path Parameters
required
string or string

Service name

query Parameters
string or string

Container name

header Parameters
X-Scope-OrgID
string

Tenant header

Api-Version
string

API version

Request Body schema: application/json
required

A JSON array with the log templates to be stored

One of
Array
tokens
required
Array of strings
identifier
required
integer <int64>
name
required
string
hitCounter
required
integer <int64>
container
required
string
service
required
string
namespace
required
string

Responses

Request samples

Content type
application/json
null

Response samples

Content type
application/json
null