Skip to content
Docs

Drains

Configure Drains to send your Edgenivo observability data to an external destination. You can inspect existing Drains, update their configuration, and test delivery before relying on them.

Create a new Drain.

Parameters

ParameterTypeRequiredDescription
teamIdstringNoTeam ID to use for this operation.
slugstringNoTeam slug to use for this operation. Use instead of teamId.
requestBodyobjectNoRequest body for this tool.

Find a Drain by id.

Parameters

ParameterTypeRequiredDescription
idstringYesThe drain ID.
teamIdstringNoTeam ID to use for this operation.
slugstringNoTeam slug to use for this operation. Use instead of teamId.

Retrieve a list of all Drains.

Parameters

ParameterTypeRequiredDescription
projectIdstringNoThe project ID.
includeMetadatabooleanNoDefault: false.
teamIdstringNoTeam ID to use for this operation.
slugstringNoTeam slug to use for this operation. Use instead of teamId.

Validate Drain delivery configuration.

Parameters

ParameterTypeRequiredDescription
teamIdstringNoTeam ID to use for this operation.
slugstringNoTeam slug to use for this operation. Use instead of teamId.
requestBodyobjectNoRequest body for this tool.

Update an existing Drain.

Parameters

ParameterTypeRequiredDescription
idstringYesThe drain ID.
teamIdstringNoTeam ID to use for this operation.
slugstringNoTeam slug to use for this operation. Use instead of teamId.
requestBodyobjectNoRequest body for this tool.

Was this helpful?

supported.