Skip to navigation
API ReferenceDrains

Update a drain

Beta
View as Markdown
Update a drain destination, its category filter, label or enabled state. A disabled drain keeps its place and resumes from it.

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Path parameters

drainIdstringRequired

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.
Idempotency-KeystringOptional1-200 characters

Optional retry key for this billable operation. Reusing the same key with the same request replays its stable outcome; credential-bearing results may be freshly issued for the same principal. Reusing it with a different request returns 409.

Request

This endpoint expects an object.
categorieslist of enumsOptional
destinationobjectOptional
enabledbooleanOptional
namestring or nullOptional1-200 characters

Customer-facing resource name. 1–200 characters.

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
categorieslist of enums
createdAtdatetime
RFC 3339 timestamp with a UTC offset.
destinationobject
enabledboolean
idstring
Unique drain identifier generated by BCTRL.
namestring or null1-80 characters
object"drain"
statusobject
subaccountIdstring or null
updatedAtdatetime
RFC 3339 timestamp with a UTC offset.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error