Logo

Alerts

List alert channels in enterprise

Returns list of alert channels

SecurityapiKey
Request
path Parameters
enterprise_id
required
string

A UUID string identifying this enterprise.

query Parameters
name
string

Filter alert channels by name.

limit
integer
Default: 20

Number of results to return per page.

offset
integer
Default: 0

Return results from this index.

Responses
200

successful operation

401

Authorization information is missing or invalid.

404

Not Found.

500

Internal server error

get/v1/enterprise/{enterprise_id}/alertchannels/
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "next": "string",
  • "previous": "string",
  • "results": [
    ]
}
Creates alert channel
Returns instance of alert channel


SecurityapiKey 
Request 
path Parameters
enterprise_id
required
string
A UUID string identifying this enterprise.


 
Request Body schema: application/json
required
id
integer
 
object
 
name
string
 
type
string
format of alert. e.g. email


 
created_on
string <date-time> 
 
updated_on
string <date-time> 
 
enterprise
string <uuid> 
 
Responses 
201
successful operation


400
Bad request


401
Authorization information is missing or invalid.


403
Forbidden, no permission to perform this action.


500
Internal server error


post/v1/enterprise/{enterprise_id}/alertchannels/
Request samples 
application/json
{
  • "id": 0,
  • "properties": {
    },
  • "name": "string",
  • "type": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "updated_on": "2019-08-24T14:15:22Z",
  • "enterprise": "796caaf9-a7de-4817-9ffa-39d04bf83de9"
}
Response samples 
application/json
{
  • "id": 0,
  • "properties": {
    },
  • "name": "string",
  • "type": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "updated_on": "2019-08-24T14:15:22Z",
  • "enterprise": "796caaf9-a7de-4817-9ffa-39d04bf83de9",
  • "linked_alerts": [
    ]
}
Get alert channel
Returns instance of alert channel


SecurityapiKey 
Request 
path Parameters
enterprise_id
required
string
A UUID string identifying this enterprise.


 
alert_id
required
integer
An integer identifying the alert channel.


 
Responses 
200
successful operation


401
Authorization information is missing or invalid.


404
Not Found.


500
Internal server error


get/v1/enterprise/{enterprise_id}/alertchannels/{alert_id}
Request samples 
Response samples 
application/json
{
  • "id": 0,
  • "properties": {
    },
  • "name": "string",
  • "type": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "updated_on": "2019-08-24T14:15:22Z",
  • "enterprise": "796caaf9-a7de-4817-9ffa-39d04bf83de9",
  • "linked_alerts": [
    ]
}
Update alert channel information
Returns alert channel instance


SecurityapiKey 
Request 
path Parameters
enterprise_id
required
string <uuid> 
A UUID string identifying the enterprise.


 
alert_id
required
integer
An integer identifying the alert channel.


 
Request Body schema: application/json
required
id
integer
 
object
 
name
string
 
type
string
format of alert. e.g. email


 
created_on
string <date-time> 
 
updated_on
string <date-time> 
 
enterprise
string <uuid> 
 
Responses 
200
successful operation


400
Invalid request.


401
Authorization information is missing or invalid.


404
Not Found.


500
Internal server error


put/v1/enterprise/{enterprise_id}/alertchannels/{alert_id}
Request samples 
application/json
{
  • "id": 0,
  • "properties": {
    },
  • "name": "string",
  • "type": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "updated_on": "2019-08-24T14:15:22Z",
  • "enterprise": "796caaf9-a7de-4817-9ffa-39d04bf83de9"
}
Response samples 
application/json
{
  • "id": 0,
  • "properties": {
    },
  • "name": "string",
  • "type": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "updated_on": "2019-08-24T14:15:22Z",
  • "enterprise": "796caaf9-a7de-4817-9ffa-39d04bf83de9",
  • "linked_alerts": [
    ]
}
Partially updates alert channel information
Returns alert channel instance


SecurityapiKey 
Request 
path Parameters
enterprise_id
required
string <uuid> 
A UUID string identifying the enterprise.


 
alert_id
required
integer
An integer identifying the alert channel.


 
Request Body schema: application/json
id
integer
 
object
 
name
string
 
type
string
format of alert. e.g. email


 
created_on
string <date-time> 
 
updated_on
string <date-time> 
 
enterprise
string <uuid> 
 
Responses 
200
successful operation


400
Invalid request.


404
Not Found.


500
Internal server error


patch/v1/enterprise/{enterprise_id}/alertchannels/{alert_id}
Request samples 
application/json
{
  • "id": 0,
  • "properties": {
    },
  • "name": "string",
  • "type": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "updated_on": "2019-08-24T14:15:22Z",
  • "enterprise": "796caaf9-a7de-4817-9ffa-39d04bf83de9"
}
Response samples 
application/json
{
  • "id": 0,
  • "properties": {
    },
  • "name": "string",
  • "type": "string",
  • "created_on": "2019-08-24T14:15:22Z",
  • "updated_on": "2019-08-24T14:15:22Z",
  • "enterprise": "796caaf9-a7de-4817-9ffa-39d04bf83de9",
  • "linked_alerts": [
    ]
}
Delete an alert channel
Empty response


SecurityapiKey 
Request 
path Parameters
enterprise_id
required
string <uuid> 
A UUID string identifying the enterprise.


 
alert_id
required
integer
An integer identifying the alert channel.


 
Responses 
204
The resource was deleted successfully.


400
Invalid request.


401
Authorization information is missing or invalid.


403
Forbidden, no permission to perform this action.


404
Not Found.


500
Internal server error


delete/v1/enterprise/{enterprise_id}/alertchannels/{alert_id}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ],
  • "message": "string",
  • "status": 0
}
➔ Next to Alarms