Incidents

21 operations. Call any of them with omada_call_operation (or, in full tool mode, as a tool named by its operationId).

Operation	Method	Summary
getInfluencingClients	GET	Get Influencing Clients by an incident
getInfluencingDevices	GET	Get Influencing Devices by an incident
getCategoryEventCount	GET	Get incident category event count
deleteIncidents	DELETE	Delete incidents
getIncidentDetail	GET	Get incident detail
modifyIncidentStatus	POST	Modify incident status
deleteAggregateIncident	DELETE	Delete aggregate incident
getGridIncidentList	GET	Get grid incident List
getIncidentsRanking	POST	Get incidents ranking cards
modifyAggregateIncidentStatus	POST	Modify aggregate incident status
getNotificationTemplate_1	GET	Get incident notification info
modifyNotification	PATCH	Set incident notification info
getIncidentDistribution	GET	Get incident overview distribution
getRankingCards	POST	Get incident overview ranking cards
getOverviewStatistics	GET	Get incident overview statistics
getAnomalyEventSettingForSite	GET	Get site incident event setting
modifyAnomalyEventSettingForSite	PATCH	Modify site incident event setting
getUnresolvedIncidentCount	GET	Get unresolved incident count
getObjectHealthIncident	GET	Get device/client health incidents
getGridDeviceIncidentList	GET	Get grid device incident List
getGridStackIncidentList	GET	Get grid stack incident list

getInfluencingClients

GET /openapi/v1/{omadacId}/sites/{siteId}/anomaly/{mac}/influencing-clients

Get Influencing Clients by an incident

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)
mac	path	string	yes	Client MAC address, like AA-BB-CC-DD-EE-FF
anomalyCode	query	string	yes	Anomaly Code
startTime	query	integer	no	Start time of the query range, in milliseconds (epoch). If both startTime and endTime are omitted, the server defaults to the last 30 days.
endTime	query	integer	no	End time of the query range, in milliseconds (epoch). If both startTime and endTime are omitted, the server defaults to the last 30 days.
status	query	integer	no	Status of the incident. 0: unresolved, 1: resolved, 2: ignored, 3: ongoing, null: all
page	query	integer	no	Start page number. Start from 1. (default 1)
pageSize	query	integer	no	Number of entries per page. It should be within the range of 1–100. (default 100)
sorts.name	query	string	no	Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect
filters.active	query	string	no	Filter query parameters, support field active: true/false.
searchKey	query	string	no	Fuzzy query parameters, support field clientName,mac,ip.

// omada_call_operation
{
  "operationId": "getInfluencingClients",
  "params": {
    "siteId": "<siteId>",
    "mac": "<mac>",
    "anomalyCode": "<anomalyCode>"
  }
}

Details, permissions and error codes

Get Influencing Clients by an incident
The interface requires one of the permissions:
Incidents Page View Only

getInfluencingDevices

GET /openapi/v1/{omadacId}/sites/{siteId}/anomaly/{mac}/influencing-devices

Get Influencing Devices by an incident

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)
mac	path	string	yes	Device MAC address, like AA-BB-CC-DD-EE-FF
anomalyCode	query	string	yes	Anomaly Code
startTime	query	integer	no	Start time of the query range, in milliseconds. If both startTime and endTime are omitted, the server defaults to the last 30 days.
endTime	query	integer	no	End time of the query range, in milliseconds. If both startTime and endTime are omitted, the server defaults to the last 30 days.
status	query	integer	no	Status of the incident. 0: unresolved, 1: resolved, 2: ignored, 3: ongoing, null: all
page	query	integer	no	Start page number. Start from 1. (default 1)
pageSize	query	integer	no	Number of entries per page. It should be within the range of 1–100. (default 100)
sorts.name	query	string	no	Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect
filters.status	query	string	no	Filter query parameters, support field status
searchKey	query	string	no	Fuzzy query parameters, support field deviceName,mac,ip.

// omada_call_operation
{
  "operationId": "getInfluencingDevices",
  "params": {
    "siteId": "<siteId>",
    "mac": "<mac>",
    "anomalyCode": "<anomalyCode>"
  }
}

Details, permissions and error codes

Get Influencing Devices by an incident
The interface requires one of the permissions:
Incidents Page View Only

getCategoryEventCount

GET /openapi/v1/{omadacId}/sites/{siteId}/anomaly/category

Get incident category event count

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)
filters.startTime	query	integer	yes	Start time in milliseconds
filters.endTime	query	integer	yes	End time in milliseconds
category	query	integer	yes	Incident category (11-19)

// omada_call_operation
{
  "operationId": "getCategoryEventCount",
  "params": {
    "siteId": "<siteId>",
    "filters.startTime": "<filters.startTime>",
    "filters.endTime": "<filters.endTime>",
    "category": "<category>"
  }
}

Details, permissions and error codes

Get incident category event count statistics.
The interface requires one of the permissions:
Incidents Page View Only

deleteIncidents

DELETE /openapi/v1/{omadacId}/sites/{siteId}/anomaly/incident

Delete incidents

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)

Request body — application/json (required) — schema DeleteAnomalyListSettingVO

Field	Type	Required	Description
incidents	array<string>	no	List of anomaly event IDs to operate on.
selectAll	boolean	no	Whether to select all incidents. If true, 'incidents' list items are excluded; otherwise only listed items are processed.
object	string	no	Device or client MAC, multiple MACs separated by comma. Required when selectAll is true.
anomalyCode	string	no	Anomaly event code. Required when selectAll is true.
start	integer	no	Start time in seconds. If both start and end are omitted, the server defaults to the last 30 days.
end	integer	no	End time in seconds. If both start and end are omitted, the server defaults to the last 30 days.
status	integer	no	Current event status. 0: Unresolved, 1: Resolved, 2: Ignored. 3：Ongoing

// omada_call_operation
{
  "operationId": "deleteIncidents",
  "params": {
    "siteId": "<siteId>"
  },
  "body": "{...}"
}

Details, permissions and error codes

Delete incidents from the incident list. For select-all operations, if both start and end are omitted, the server defaults to the last 30 days; a supplied time range is preserved.
The interface requires one of the permissions:
Incidents Page Modify

getIncidentDetail

GET /openapi/v1/{omadacId}/sites/{siteId}/anomaly/incident/{incidentId}

Get incident detail

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)
incidentId	path	string	yes	Incident ID

// omada_call_operation
{
  "operationId": "getIncidentDetail",
  "params": {
    "siteId": "<siteId>",
    "incidentId": "<incidentId>"
  }
}

Details, permissions and error codes

Get incident detail
The interface requires one of the permissions:
Incidents Page View Only

modifyIncidentStatus

POST /openapi/v1/{omadacId}/sites/{siteId}/anomaly/incident/status

Modify incident status

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)

Request body — application/json (required) — schema AnomalyListSettingVO

Field	Type	Required	Description
incidents	array<string>	no	List of anomaly event IDs to operate on. IDs are from 'Get grid incident List' API.
selectAll	boolean	no	Whether to select all incidents. If true, 'incidents' list items are excluded; otherwise only listed items are processed.
object	string	no	Device or client MAC, multiple MACs separated by comma. Required when selectAll is true.
anomalyCode	string	no	Anomaly event code. Required when selectAll is true.
start	integer	no	Start time in seconds. If both start and end are omitted, the server defaults to the last 30 days.
end	integer	no	End time in seconds. If both start and end are omitted, the server defaults to the last 30 days.
status	integer	no	Current event status. 0: Unresolved, 1: Resolved, 2: Ignored. 3：Ongoing
targetStatus	integer	no	Target event status for modification. 0: Unresolved 1: Resolved, 2: Ignored. Not required for deletion.

// omada_call_operation
{
  "operationId": "modifyIncidentStatus",
  "params": {
    "siteId": "<siteId>"
  },
  "body": "{...}"
}

Details, permissions and error codes

Modify the status of incidents. For select-all operations, if both start and end are omitted, the server defaults to the last 30 days; a supplied time range is preserved.
The interface requires one of the permissions:
Incidents Page Modify

deleteAggregateIncident

DELETE /openapi/v1/{omadacId}/sites/{siteId}/anomaly/incidents

Delete aggregate incident

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)

Request body — application/json (required) — schema AnomalyTimerSettingVO

Field	Type	Required	Description
incidents	array<AnomalyBriefQueryVO>	no	List of anomaly event objects to operate on, identified by anomaly code and MAC.
selectAll	boolean	no	Whether to select all incidents. If true, 'incidents' list items are excluded; otherwise only listed items are processed.
searchKey	string	no	Search keyword for event content, device name/MAC/IP. Required when selectAll is true.
level	integer	no	Event severity level filter. 0: Critical, 1: Error, 2: Warning, 3: Info.
category	string	no	Event category filter, comma-separated. Required when selectAll is true.
objectType	string	no	Object type filter, comma-separated (e.g. 'ap,wirelessClient'). Required when selectAll is true.
status	integer	yes	Current event status. 0: Unresolved, 1: Resolved, 2: Ignored. 3: Ongoing
targetStatus	integer	no	Target event status for modification. 0: Unresolved 1: Resolved, 2: Ignored. Not required for deletion.
start	integer	no	Start time in seconds (Unix timestamp).
end	integer	no	End time in seconds (Unix timestamp).
startTime	integer	yes	Start time in milliseconds (Unix timestamp).
endTime	integer	yes	End time in milliseconds (Unix timestamp).

// omada_call_operation
{
  "operationId": "deleteAggregateIncident",
  "params": {
    "siteId": "<siteId>"
  },
  "body": "{...}"
}

Details, permissions and error codes

Delete aggregate incidents.
The interface requires one of the permissions:
Incidents Page Modify

getGridIncidentList

GET /openapi/v1/{omadacId}/sites/{siteId}/anomaly/incidents

Get grid incident List

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)
filters.status	query	integer	no	Incident status filter
page	query	integer	no	Start page number. Start from 1. (default 1)
pageSize	query	integer	no	Number of entries per page. It should be within the range of 1–1000.(value:10,15,20,30,50,100) (default 100)
filters.startTime	query	integer	yes	Start time in milliseconds
filters.endTime	query	integer	yes	End time in milliseconds
filters.category	query	string	no	Incident category filter
filters.anomalyCode	query	string	no	Anomaly code filter

// omada_call_operation
{
  "operationId": "getGridIncidentList",
  "params": {
    "siteId": "<siteId>",
    "filters.startTime": "<filters.startTime>",
    "filters.endTime": "<filters.endTime>"
  }
}

Details, permissions and error codes

Get incident list.
The interface requires one of the permissions:
Incidents Page View Only

getIncidentsRanking

POST /openapi/v1/{omadacId}/sites/{siteId}/anomaly/incidents/ranking-cards

Get incidents ranking cards

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)

Request body — application/json (required) — schema IncidentRankingQueryVO

Field	Type	Required	Description
startTime	integer	yes	Start time in milliseconds
endTime	integer	yes	End time in milliseconds
topK	integer	no	Number of top items to return. Defaults to 5 if not provided, maximum to 20.
anomalyCode	integer	yes	For the values of Anomaly event code, refer to section 5.7.2.1 of the Open API Access

// omada_call_operation
{
  "operationId": "getIncidentsRanking",
  "params": {
    "siteId": "<siteId>"
  },
  "body": "{...}"
}

Details, permissions and error codes

Get incidents ranking cards.
The interface requires one of the permissions:
Incidents Page View Only

modifyAggregateIncidentStatus

POST /openapi/v1/{omadacId}/sites/{siteId}/anomaly/incidents/status

Modify aggregate incident status

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)

Request body — application/json (required) — schema AnomalyTimerSettingVO

Field	Type	Required	Description
incidents	array<AnomalyBriefQueryVO>	no	List of anomaly event objects to operate on, identified by anomaly code and MAC.
selectAll	boolean	no	Whether to select all incidents. If true, 'incidents' list items are excluded; otherwise only listed items are processed.
searchKey	string	no	Search keyword for event content, device name/MAC/IP. Required when selectAll is true.
level	integer	no	Event severity level filter. 0: Critical, 1: Error, 2: Warning, 3: Info.
category	string	no	Event category filter, comma-separated. Required when selectAll is true.
objectType	string	no	Object type filter, comma-separated (e.g. 'ap,wirelessClient'). Required when selectAll is true.
status	integer	yes	Current event status. 0: Unresolved, 1: Resolved, 2: Ignored. 3: Ongoing
targetStatus	integer	no	Target event status for modification. 0: Unresolved 1: Resolved, 2: Ignored. Not required for deletion.
start	integer	no	Start time in seconds (Unix timestamp).
end	integer	no	End time in seconds (Unix timestamp).
startTime	integer	yes	Start time in milliseconds (Unix timestamp).
endTime	integer	yes	End time in milliseconds (Unix timestamp).

// omada_call_operation
{
  "operationId": "modifyAggregateIncidentStatus",
  "params": {
    "siteId": "<siteId>"
  },
  "body": "{...}"
}

Details, permissions and error codes

Modify the status of aggregate incidents.
The interface requires one of the permissions:
Incidents Page Modify

getNotificationTemplate_1

GET /openapi/v1/{omadacId}/sites/{siteId}/anomaly/notification

Get incident notification info

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)

// omada_call_operation
{
  "operationId": "getNotificationTemplate_1",
  "params": {
    "siteId": "<siteId>"
  }
}

Details, permissions and error codes

Get incident notification info.
The interface requires one of the permissions:
Incidents Page View Only

modifyNotification

PATCH /openapi/v1/{omadacId}/sites/{siteId}/anomaly/notification

Set incident notification info

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)

Request body — application/json (required) — schema SetNotificationOpenApiVO

Field	Type	Required	Description
alertEmailSetting	AlertEmailSettingVO	yes	(AlertEmailSettingVO not expanded; call omada_get_schema "AlertEmailSettingVO")
email	NotificationConfigurationOpenApiVO	yes	(NotificationConfigurationOpenApiVO not expanded; call omada_get_schema "NotificationConfigurationOpenApiVO")

// omada_call_operation
{
  "operationId": "modifyNotification",
  "params": {
    "siteId": "<siteId>"
  },
  "body": "{...}"
}

Details, permissions and error codes

Set incident notification info.
The interface requires one of the permissions:
Incidents Page Modify

getIncidentDistribution

GET /openapi/v1/{omadacId}/sites/{siteId}/anomaly/overview/incident-distribution

Get incident overview distribution

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)
filters.startTime	query	integer	yes	Start time in milliseconds
filters.endTime	query	integer	yes	End time in milliseconds

// omada_call_operation
{
  "operationId": "getIncidentDistribution",
  "params": {
    "siteId": "<siteId>",
    "filters.startTime": "<filters.startTime>",
    "filters.endTime": "<filters.endTime>"
  }
}

Details, permissions and error codes

Get incident overview distribution.
The interface requires one of the permissions:
Incidents Page View Only

getRankingCards

POST /openapi/v1/{omadacId}/sites/{siteId}/anomaly/overview/ranking-cards

Get incident overview ranking cards

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)

Request body — application/json (required) — schema IncidentRankingQueryVO

Field	Type	Required	Description
startTime	integer	yes	Start time in milliseconds
endTime	integer	yes	End time in milliseconds
topK	integer	no	Number of top items to return. Defaults to 5 if not provided, maximum to 20.
anomalyCode	integer	yes	For the values of Anomaly event code, refer to section 5.7.2.1 of the Open API Access

// omada_call_operation
{
  "operationId": "getRankingCards",
  "params": {
    "siteId": "<siteId>"
  },
  "body": "{...}"
}

Details, permissions and error codes

Get incident overview ranking cards.
The interface requires one of the permissions:
Incidents Page View Only

getOverviewStatistics

GET /openapi/v1/{omadacId}/sites/{siteId}/anomaly/overview/statistics

Get incident overview statistics

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)
filters.startTime	query	integer	yes	Query start time, in milliseconds
filters.endTime	query	integer	yes	Query end time, in milliseconds

// omada_call_operation
{
  "operationId": "getOverviewStatistics",
  "params": {
    "siteId": "<siteId>",
    "filters.startTime": "<filters.startTime>",
    "filters.endTime": "<filters.endTime>"
  }
}

Details, permissions and error codes

Get incident overview statistics for the pie chart.
The interface requires one of the permissions:
Incidents Page View Only

getAnomalyEventSettingForSite

GET /openapi/v1/{omadacId}/sites/{siteId}/anomaly/setting

Get site incident event setting

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)
page	query	integer	no	Start page number. Start from 1. (default 1)
pageSize	query	integer	no	Number of entries per page. It should be within the range of 1–1000.(value:10,15,20,30,50,100) (default 100)
filters.enable	query	integer	no	Filter query parameters, support field enable, it should be a value as follows: 0:enable, 1:disable, example:0.
filters.level	query	integer	no	Filter query parameters, support field level, it should be a value as follows: 0:Critical, 1:Error, 2:Warning, 3: Info, example:1.
filters.category	query	string	no	Filter query parameters, support field category, one or more categories, each category should be a value as follows: 11:Access, 12:Authentication, 13:Roaming, 14:Wireless Network, 15:Wired Network, 16:Link, 17:WAN and Services, 18:Device Status, 19:Security, example: 11 Or 12,13,14

// omada_call_operation
{
  "operationId": "getAnomalyEventSettingForSite",
  "params": {
    "siteId": "<siteId>"
  }
}

Details, permissions and error codes

Get site incident event setting.
The interface requires one of the permissions:
Incidents Page View Only

modifyAnomalyEventSettingForSite

PATCH /openapi/v1/{omadacId}/sites/{siteId}/anomaly/setting/modify

Modify site incident event setting

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)

Request body — application/json (required) — schema AnomalyEventSettingEditOpenApiVO

Field	Type	Required	Description
anomalyCode	string	yes	For the values of Anomaly event code, refer to section 5.7.2.1 of the Open API Access
enable	boolean	no	Whether to detect anomaly events
level	integer	no	Anomaly event level, it should be a value as follows: 0:Critical, 1:Error, 2:Warning, 3: Info
params	object	no	For the values of Anomaly event params, refer to section 5.7.2.1 of the Open API Access

// omada_call_operation
{
  "operationId": "modifyAnomalyEventSettingForSite",
  "params": {
    "siteId": "<siteId>"
  },
  "body": "{...}"
}

Details, permissions and error codes

Modify site incident event setting.
The interface requires one of the permissions:
Incidents Page Modify

getUnresolvedIncidentCount

GET /openapi/v1/{omadacId}/sites/{siteId}/anomaly/unresolved-incidents

Get unresolved incident count

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)

// omada_call_operation
{
  "operationId": "getUnresolvedIncidentCount",
  "params": {
    "siteId": "<siteId>"
  }
}

Details, permissions and error codes

Get unresolved incident count.
The interface requires one of the permissions:
Incidents Page View Only

getObjectHealthIncident

GET /openapi/v1/{omadacId}/sites/{siteId}/health/incident/{mac}

Get device/client health incidents

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)
mac	path	string	yes
filters.startTime	query	integer	yes	Start time in milliseconds
filters.endTime	query	integer	yes	End time in milliseconds

// omada_call_operation
{
  "operationId": "getObjectHealthIncident",
  "params": {
    "siteId": "<siteId>",
    "mac": "<mac>",
    "filters.startTime": "<filters.startTime>",
    "filters.endTime": "<filters.endTime>"
  }
}

Details, permissions and error codes

Get incident list for device/client health detail page.
The interface requires one of the permissions:
Incidents Page View Only

getGridDeviceIncidentList

GET /openapi/v1/{omadacId}/sites/{siteId}/incident/{mac}

Get grid device incident List

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)
mac	path	string	yes
filters.status	query	integer	no	Incident status filter
page	query	integer	no	Start page number. Start from 1. (default 1)
pageSize	query	integer	no	Number of entries per page. It should be within the range of 1–1000.(value:10,15,20,30,50,100) (default 100)
filters.startTime	query	integer	no	Start time in milliseconds
filters.endTime	query	integer	no	End time in milliseconds

// omada_call_operation
{
  "operationId": "getGridDeviceIncidentList",
  "params": {
    "siteId": "<siteId>",
    "mac": "<mac>"
  }
}

Details, permissions and error codes

Get device incident list.
The interface requires one of the permissions:
Incidents Page View Only

getGridStackIncidentList

GET /openapi/v1/{omadacId}/sites/{siteId}/incident/stack/{stackId}

Get grid stack incident list

Parameter	In	Type	Required	Description
omadacId	path	string	auto	Omada ID (filled in automatically)
siteId	path	string	yes	Site ID (site ID or site name)
stackId	path	string	yes	Stack ID
filters.status	query	integer	no	Incident status filter. 0: unresolved, 1: resolved, 2: ignored, 3: ongoing, null: all
page	query	integer	no	Start page number. Start from 1. (default 1)
pageSize	query	integer	no	Number of entries per page. It should be within the range of 1–1000.(value:10,15,20,30,50,100) (default 100)
filters.startTime	query	integer	no	Start time in milliseconds
filters.endTime	query	integer	no	End time in milliseconds

// omada_call_operation
{
  "operationId": "getGridStackIncidentList",
  "params": {
    "siteId": "<siteId>",
    "stackId": "<stackId>"
  }
}

Details, permissions and error codes

Get incident list for a stack detail page.
The interface requires one of the permissions:
Incidents Page View Only