Skip to navigation
API ReferenceDrains

List drains

Beta
View as Markdown
List the drains that export Events to your own observability stack or bucket.

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Headers

BCTRL-VersionenumOptional
Dated API version. Defaults to the release pinned when the API key was created.
Allowed values:
BCTRL-SpacestringOptional
Select one authorized Space by its opaque ID or unique name. Omission uses the operation default.
BCTRL-Subaccount-IdstringOptional
Optional effective subaccount context for organization API keys. Subaccount API keys are already scoped and cannot use this header to act as another subaccount.

Query parameters

cursorstringOptional
orderenumOptional
Order by createdAt and ID. Defaults to desc.
Allowed values:
limitintegerOptional<=200Defaults to 50

Response headers

BCTRL-Request-IdstringOptional
Current request identifier, also echoed in errors.
BCTRL-VersionstringOptional
Negotiated dated API version.
RateLimit-Limitinteger

Evaluated policy limit; zero when no finite policy was evaluated.

RateLimit-Remaininginteger

Remaining policy budget; zero when no finite policy was evaluated.

RateLimit-Resetinteger

Seconds until reset; zero when no finite policy was evaluated.

Response

OK
datalist of objects
hasMorebooleanDefaults to false
nextCursorstring or null

Errors

401
Unauthorized Error
403
Forbidden Error