Skip to content

Log (Template) ​

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

OperationMethodSummary
getLogSettingForSiteTemplateGETGet site template log notification
modifyLogSettingSiteTemplatePATCHModify site template log notification
resetLogSettingSiteTemplatePOSTReset site template log notification

getLogSettingForSiteTemplate ​

GET /openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/site/log-notification

Get site template log notification

ParameterInTypeRequiredDescription
omadacIdpathstringautoOmada ID (filled in automatically)
siteTemplateIdpathstringyesSite Template ID
json
// omada_call_operation
{
  "operationId": "getLogSettingForSiteTemplate",
  "params": {
    "siteTemplateId": "<siteTemplateId>"
  }
}
Details, permissions and error codes

Get site template log notification.
The interface requires one of the permissions:
Global Site Template Manager View Only

modifyLogSettingSiteTemplate ​

PATCH /openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/site/log-notification

Modify site template log notification

ParameterInTypeRequiredDescription
omadacIdpathstringautoOmada ID (filled in automatically)
siteTemplateIdpathstringyesSite Template ID

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

FieldTypeRequiredDescription
webhookConfigWebhookConfigEditOpenApiVOno(WebhookConfigEditOpenApiVO not expanded; call omada_get_schema "WebhookConfigEditOpenApiVO")
logNotificationsarray<LogNotificationEditOpenApiVO>yesLog Notification List
alertEmailSettingLogAlertEmailOpenApiVOno(LogAlertEmailOpenApiVO not expanded; call omada_get_schema "LogAlertEmailOpenApiVO")
json
// omada_call_operation
{
  "operationId": "modifyLogSettingSiteTemplate",
  "params": {
    "siteTemplateId": "<siteTemplateId>"
  },
  "body": "{...}"
}
Details, permissions and error codes

Modify site template log notification.
The interface requires one of the permissions:
Global Site Template Manager Modify

resetLogSettingSiteTemplate ​

POST /openapi/v1/{omadacId}/sitetemplates/{siteTemplateId}/site/reset/log-notification

Reset site template log notification

ParameterInTypeRequiredDescription
omadacIdpathstringautoOmada ID (filled in automatically)
siteTemplateIdpathstringyesSite Template ID
json
// omada_call_operation
{
  "operationId": "resetLogSettingSiteTemplate",
  "params": {
    "siteTemplateId": "<siteTemplateId>"
  }
}
Details, permissions and error codes

Reset site template log notification.
The interface requires one of the permissions:
Global Site Template Manager Modify

Released under the MIT License. Not affiliated with or endorsed by TP-Link.