Alerts

List alert events

get

Returns alert events divided into pages. Allows to specify page number and page size.

Authorizations
AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters
environmentstringRequired
Query parameters
pageintegerOptional

The page number to be returned, must be greater than zero. Defaults to 1.

Example: 1
pageSizeintegerRequired

The elements amount on a single page, must be greater than zero.

Example: 25
summarystringOptional

Allows to filter results by partial summary text

Example: active controllers
categorystringOptional

Allows to filter results by category. Accepted values are: 'Infrastructure', 'Consumers', 'Kafka Connect', 'Topics' )

Example: Infrastructure
levelstringOptional

Allows to filter results by level

Example: INFO
alertIdintegerOptional

Allows to filter results by alert id

Example: 1000
Responses
200Success
application/json
get
/api/v1/environments/{environment}/proxy/api/v1/alert/events

Get alert condition details

get
Authorizations
AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters
environmentstringRequired
alert_setting_idinteger · enumRequiredExample: 5000Possible values:
condition_idstring · uuidRequired
Responses
200Success
application/json
get
/api/v1/environments/{environment}/proxy/api/v1/alert/settings/{alert_setting_id}/conditions/{condition_id}

Update alert condition

put
Authorizations
AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters
environmentstringRequired
alert_setting_idinteger · enumRequired

The Alert ID to enable

Example: 2000Possible values:
condition_idstring · uuidRequired

The condition unique identifier

Example: 8ce90f4a-514b-45fc-a12e-268bc69525f5
Body
conditionone ofRequired
objectOptional

JSON Schema representation of the configuration properties

or
stringOptional
channelsstring[]Optional
Responses
200Success

No content

put
/api/v1/environments/{environment}/proxy/api/v1/alert/settings/{alert_setting_id}/conditions/{condition_id}

No content

Delete alert condition

delete
Authorizations
AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters
environmentstringRequired
alert_setting_idinteger · enumRequired

The Alert ID to enable

Example: 2000Possible values:
condition_idstring · uuidRequired

The condition unique identifier

Example: 8ce90f4a-514b-45fc-a12e-268bc69525f5
Responses
200Success

No content

delete
/api/v1/environments/{environment}/proxy/api/v1/alert/settings/{alert_setting_id}/conditions/{condition_id}

No content

Get alert settings

get
Authorizations
AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters
environmentstringRequired
Responses
200Success
application/json
get
/api/v1/environments/{environment}/proxy/api/v2/alert/settings

Update alert settings

put

update of a fixed alert setting

Authorizations
AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters
environmentstringRequired
alert_setting_idinteger · enumRequired

The Alert ID to enable

Example: 1000Possible values:
Body
enabledbooleanRequired
channelsstring[]Optional
configobjectOptional

JSON Schema representation of the configuration properties

Responses
200Success
application/json
put
/api/v1/environments/{environment}/proxy/api/v2/alert/settings/{alert_setting_id}

Partially update alert settings

patch

partial update of a fixed alert setting

Authorizations
AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters
environmentstringRequired
alert_setting_idinteger · enumRequired

The Alert ID to enable

Example: 1000Possible values:
Body
enabledbooleanOptional
channelsstring[]Optional
configobjectOptional

JSON Schema representation of the configuration properties

Responses
200Success
application/json
patch
/api/v1/environments/{environment}/proxy/api/v2/alert/settings/{alert_setting_id}

Create alert condition

post
Authorizations
AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters
environmentstringRequired
alert_setting_idinteger · enumRequired

The Alert ID to enable

Example: 2000Possible values:
Body
conditionone ofRequired
objectOptional

JSON Schema representation of the configuration properties

or
stringOptional
channelsstring[]Optional
Responses
post
/api/v1/environments/{environment}/proxy/api/v1/alert/settings/{alert_setting_id}/conditions

List alert channels

get

Lists alert channels ordered by their creation time (most recent first)

Authorizations
AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters
environmentstringRequired
Query parameters
pageintegerOptional

The page number to be returned, must be greater than zero. Defaults to 1.

Example: 1
pageSizeintegerRequired

The elements amount on a single page, must be greater than zero.

Example: 25
templateNamestringOptional

Filter by channel template name

channelNamestringOptional

Matches channels by name

sortFieldstring · enumOptional

The field to sort results by

Possible values:
sortOrderstring · enumOptional

Sorting order. Defaults to ascending

Possible values:
Responses
200Success
application/json
get
/api/v1/environments/{environment}/proxy/api/v1/alert/channels

Create alert channel

post

The JSON object representing the properties to set this channel with

Authorizations
AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters
environmentstringRequired
Body
namestringRequired
templateNamestringRequired
connectionNamestringRequired
propertiesObjectobjectOptional

JSON Schema representation of the configuration properties

Responses
post
/api/v1/environments/{environment}/proxy/api/v1/alert/channels

Get alert channel details

get

Get the alert channel details

Authorizations
AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters
environmentstringRequired
idstring · uuidRequired

The channel id

Example: 2c1fc20d-59b4-4f67-8982-6e0377e8fdbd
Responses
200Success
application/json
get
/api/v1/environments/{environment}/proxy/api/v1/alert/channels/{id}

Update alert channel

put

Update alert channel

Authorizations
AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters
environmentstringRequired
idstring · uuidRequired

The channel id

Example: 2c1fc20d-59b4-4f67-8982-6e0377e8fdbd
Body
namestringRequired
connectionNamestringRequired
enabledbooleanOptional
propertiesObjectobjectOptional

JSON Schema representation of the configuration properties

Responses
200Success

No content

put
/api/v1/environments/{environment}/proxy/api/v1/alert/channels/{id}

No content

Delete a channel

delete

Permanently delete a channel

Authorizations
AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters
environmentstringRequired
idstring · uuidRequired

The channel id

Example: 2c1fc20d-59b4-4f67-8982-6e0377e8fdbd
Responses
delete
/api/v1/environments/{environment}/proxy/api/v1/alert/channels/{id}

No content

Patch alert channel

patch

Patch an alert channel

Authorizations
AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters
environmentstringRequired
idstring · uuidRequired

The channel id

Example: 2c1fc20d-59b4-4f67-8982-6e0377e8fdbd
Body
namestringOptional
connectionNamestringOptional
enabledbooleanOptional
propertiesObjectobjectOptional

JSON Schema representation of the configuration properties

Responses
200Success

No content

patch
/api/v1/environments/{environment}/proxy/api/v1/alert/channels/{id}

No content

List alert channel templates

get

List channel templates and their applicable connections

Authorizations
AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters
environmentstringRequired
Responses
200Success
application/json
get
/api/v1/environments/{environment}/proxy/api/v1/alert/channel-templates

Last updated

Was this helpful?