HomeGuidesAPI Reference
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In
API Reference
GuidesAPI ReferenceGitHubAirheads Developer Community

List Notifications

get
https://{api-base-url}/central/v1/notifications

Get notifications. You can only specify one of group, label parameters.
Possible error_codes for the error responses are

  1. 0001 - General Error.
  2. 0003 - Validation Error. Unsupported query combination
  3. 0004 - Validation Error. Invalid value for a query parameter
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

MSP user can filter notifications based on customer id

string

Used to filter the notification types based on group name

string

Used to filter the notification types based on Label name

string

Used to filter the result based on serial number of the device

string

Used to filter the notification types based on Site name

int32

1)start of duration within which alerts are raised
2)described using Unix Epoch time in seconds

int32

1)end of duration within which alerts are raised
2)described using Unix Epoch time in seconds

string

Used to filter the notification types based on severity

string

Used to filter the notification types based on notification type name

string

term used to search in name, category of the alert

boolean

Whether to count total items in the response

boolean

Filter acknowledged or unacknowledged notifications. When query parameter is not specified, both acknowledged and unacknowledged notifications are included

string

Comma separated list of fields to be returned

int32

Pagination offset

int32
≤ 1000
Defaults to 100

Pagination limit. Default is 100 and max is 1000

Responses

401

Unauthorized access. Authentication failed or was not provided

403

Access denied

413

Request-size limit exceeded

417

Request-size limit exceeded

429

API Rate limit exceeded

Updated about 2 years ago

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 years ago