Alert Channels

put

Update alert channel

Path parameters

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

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

409

The supplied identifier is already being used by another resource

application/json

500

An internal server error has occurred

application/json

put

HTTPcURLJavaScriptPython

PUT /api/v1/environments/{name}/proxy/api/v1/alert/channels/{id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 127

{
  "name": "kafka-prd-health",
  "connectionName": "slack-connection",
  "properties": [
    {
      "key": "channel",
      "value": "#my-kafka-health-prd"
    }
  ]
}

No content

patch

Patch an alert channel

Path parameters

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

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

409

The supplied identifier is already being used by another resource

application/json

500

An internal server error has occurred

application/json

patch

HTTPcURLJavaScriptPython

PATCH /api/v1/environments/{name}/proxy/api/v1/alert/channels/{id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 142

{
  "name": "kafka-prd-health",
  "connectionName": "slack-connection",
  "enabled": true,
  "properties": [
    {
      "key": "channel",
      "value": "#my-kafka-health-prd"
    }
  ]
}

No content

get

Get the alert channel details

Path parameters

idstring · uuidRequired

The channel id

Example: 2c1fc20d-59b4-4f67-8982-6e0377e8fdbd

Responses

200Success

application/json

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

500

An internal server error has occurred

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/environments/{name}/proxy/api/v1/alert/channels/{id} HTTP/1.1
Host: 
Accept: */*

{
  "id": "2c1fc20d-59b4-4f67-8982-6e0377e8fdbd",
  "name": "kafka-prd-health",
  "templateName": "Slack",
  "templateVersion": 1,
  "connectionName": "slack-connection",
  "properties": [
    {
      "key": "channel",
      "value": "#my-kafka-health-prd"
    }
  ],
  "createdAt": "2021-01-01T00:00:00Z",
  "createdBy": "joe.bloggs",
  "updatedAt": "2021-01-01T00:00:00Z",
  "updatedBy": "joe.bloggs",
  "enabled": true
}

delete

Deletes alerts with timestamps before the specified value

Query parameters

timestampinteger · int64Required

Timestamp (milliseconds since the epoch), for which any alerts older than it should be deleted

Example: 1562922585000

Responses

200Success

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

500

An internal server error has occurred

application/json

delete

HTTPcURLJavaScriptPython

DELETE /api/v1/environments/{name}/proxy/api/v1/alert/events?timestamp=1 HTTP/1.1
Host: 
Accept: */*

No content

get

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

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

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

500

An internal server error has occurred

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/environments/{name}/proxy/api/v1/alert/channels?pageSize=1 HTTP/1.1
Host: 
Accept: */*

{
  "values": [
    {
      "id": "2c1fc20d-59b4-4f67-8982-6e0377e8fdbd",
      "name": "kafka-prd-health",
      "templateName": "Slack",
      "templateVersion": 1,
      "connectionName": "slack-connection",
      "properties": [
        {
          "key": "channel",
          "value": "#my-kafka-health-prd"
        }
      ],
      "createdAt": "2021-01-01T00:00:00Z",
      "createdBy": "joe.bloggs",
      "updatedAt": "2021-01-01T00:00:00Z",
      "updatedBy": "joe.bloggs",
      "enabled": true
    }
  ],
  "pagesAmount": 1,
  "totalCount": 1
}

put

update of a fixed alert setting

Path parameters

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

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

500

An internal server error has occurred

application/json

put

HTTPcURLJavaScriptPython

PUT /api/v1/environments/{name}/proxy/api/v2/alert/settings/{alert_setting_id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 124

{
  "enabled": true,
  "channels": [
    "2c1fc20d-59b4-4f67-8982-6e0377e8fdbd"
  ],
  "config": {
    "enabled": true,
    "restarts": 5,
    "gracePeriod": 60
  }
}

{
  "message": "text"
}

patch

partial update of a fixed alert setting

Path parameters

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

400

The request input was invalid

application/json

401

Authentication error

application/json

402

The purchased Lenses license does not provide access to this feature

application/json

403

Authorisation error

application/json

404

The requested resource cannot be found

application/json

500

An internal server error has occurred

application/json

patch

HTTPcURLJavaScriptPython

PATCH /api/v1/environments/{name}/proxy/api/v2/alert/settings/{alert_setting_id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 125

{
  "enabled": true,
  "channels": [
    "2c1fc20d-59b4-4f67-8982-6e0377e8fdbd"
  ],
  "config": {
    "enabled": true,
    "restarts": 3,
    "gracePeriod": 120
  }
}

{
  "message": "text"
}