Skip to content

LogAPI

All URIs are relative to https://use1-omada-northbound.tplinkcloud.com

Method HTTP request Description
DeleteAlertLogsForGlobal Delete /openapi/v1/{omadacId}/logs/alerts/delete Delete global alert log
DeleteAlertLogsForSite Delete /openapi/v1/{omadacId}/sites/{siteId}/logs/alerts/delete Delete site alert log
DeleteEventLogsForGlobal Delete /openapi/v1/{omadacId}/logs/events/delete Delete global event log
DeleteEventLogsForSite Delete /openapi/v1/{omadacId}/sites/{siteId}/logs/events/delete Delete site event log
ExportLogListForGlobal Post /openapi/v1/{omadacId}/logs/export Export log list in global view
GetAlertLogsForGlobal Get /openapi/v1/{omadacId}/logs/alerts Get global alert log list
GetAlertLogsForSite Get /openapi/v1/{omadacId}/sites/{siteId}/logs/alerts Get site alert log list
GetEventLogsForGlobal Get /openapi/v1/{omadacId}/logs/events Get global event log list
GetEventLogsForSite Get /openapi/v1/{omadacId}/sites/{siteId}/logs/events Get site event log list
GetLogSettingForGlobal Get /openapi/v1/{omadacId}/log-notification Get global log notification
GetLogSettingForGlobalV2 Get /openapi/v2/{omadacId}/log-notification Get global log notification v2
GetLogSettingForSite Get /openapi/v1/{omadacId}/sites/{siteId}/site/log-notification Get site log notification
GetLogSettingForSiteV2 Get /openapi/v2/{omadacId}/sites/{siteId}/site/log-notification Get site log notification v2
GetRemoteLoggingSettingTip Get /openapi/v1/{omadacId}/sites/{siteId}/remote-logging/tip Get site remote logging setting tip
GetRemoteLoggingTip Get /openapi/v1/{omadacId}/global/controller/setting/syslog/tip Get customer remote logging tip
ModifyLogSettingGlobal Patch /openapi/v1/{omadacId}/log-notification Modify global log notification
ModifyLogSettingGlobalV2 Patch /openapi/v2/{omadacId}/log-notification Modify global log notification v2
ModifyLogSettingSite Patch /openapi/v1/{omadacId}/sites/{siteId}/site/log-notification Modify site log notification
ModifyLogSettingSiteV2 Patch /openapi/v2/{omadacId}/sites/{siteId}/site/log-notification Modify site log notification v2
ResetLogSettingGlobal Post /openapi/v1/{omadacId}/reset/log-notification Reset global log notification
ResetLogSettingSite Post /openapi/v1/{omadacId}/sites/{siteId}/site/reset/log-notification Reset site log notification
ResolveAlertForSite Post /openapi/v1/{omadacId}/sites/{siteId}/logs/alerts/resolve Resolve site alert log

DeleteAlertLogsForGlobal

OperationResponseWithoutResult DeleteAlertLogsForGlobal(ctx, omadacId).DeleteGlobalAlertLogListOpenApiVO(deleteGlobalAlertLogListOpenApiVO).Execute()

Delete global alert log

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    deleteGlobalAlertLogListOpenApiVO := *openapiclient.NewDeleteGlobalAlertLogListOpenApiVO(int64(123), "SelectType_example", int64(123)) // DeleteGlobalAlertLogListOpenApiVO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LogAPI.DeleteAlertLogsForGlobal(context.Background(), omadacId).DeleteGlobalAlertLogListOpenApiVO(deleteGlobalAlertLogListOpenApiVO).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LogAPI.DeleteAlertLogsForGlobal``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DeleteAlertLogsForGlobal`: OperationResponseWithoutResult
    fmt.Fprintf(os.Stdout, "Response from `LogAPI.DeleteAlertLogsForGlobal`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId string Omada ID

Other Parameters

Other parameters are passed through a pointer to a apiDeleteAlertLogsForGlobalRequest struct via the builder pattern

Name Type Description Notes

deleteGlobalAlertLogListOpenApiVO | DeleteGlobalAlertLogListOpenApiVO | |

Return type

OperationResponseWithoutResult

Authorization

AccessToken

HTTP request headers

  • Content-Type: application/json
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteAlertLogsForSite

OperationResponseWithoutResult DeleteAlertLogsForSite(ctx, omadacId, siteId).DeleteSiteAlertLogListOpenApiVO(deleteSiteAlertLogListOpenApiVO).Execute()

Delete site alert log

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    deleteSiteAlertLogListOpenApiVO := *openapiclient.NewDeleteSiteAlertLogListOpenApiVO(int64(123), "SelectType_example", int64(123)) // DeleteSiteAlertLogListOpenApiVO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LogAPI.DeleteAlertLogsForSite(context.Background(), omadacId, siteId).DeleteSiteAlertLogListOpenApiVO(deleteSiteAlertLogListOpenApiVO).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LogAPI.DeleteAlertLogsForSite``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DeleteAlertLogsForSite`: OperationResponseWithoutResult
    fmt.Fprintf(os.Stdout, "Response from `LogAPI.DeleteAlertLogsForSite`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId string Omada ID
siteId string Site ID

Other Parameters

Other parameters are passed through a pointer to a apiDeleteAlertLogsForSiteRequest struct via the builder pattern

Name Type Description Notes

deleteSiteAlertLogListOpenApiVO | DeleteSiteAlertLogListOpenApiVO | |

Return type

OperationResponseWithoutResult

Authorization

AccessToken

HTTP request headers

  • Content-Type: application/json
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteEventLogsForGlobal

OperationResponseWithoutResult DeleteEventLogsForGlobal(ctx, omadacId).DeleteGlobalEventLogListOpenApiVO(deleteGlobalEventLogListOpenApiVO).Execute()

Delete global event log

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    deleteGlobalEventLogListOpenApiVO := *openapiclient.NewDeleteGlobalEventLogListOpenApiVO(int64(123), "SelectType_example", int64(123)) // DeleteGlobalEventLogListOpenApiVO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LogAPI.DeleteEventLogsForGlobal(context.Background(), omadacId).DeleteGlobalEventLogListOpenApiVO(deleteGlobalEventLogListOpenApiVO).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LogAPI.DeleteEventLogsForGlobal``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DeleteEventLogsForGlobal`: OperationResponseWithoutResult
    fmt.Fprintf(os.Stdout, "Response from `LogAPI.DeleteEventLogsForGlobal`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId string Omada ID

Other Parameters

Other parameters are passed through a pointer to a apiDeleteEventLogsForGlobalRequest struct via the builder pattern

Name Type Description Notes

deleteGlobalEventLogListOpenApiVO | DeleteGlobalEventLogListOpenApiVO | |

Return type

OperationResponseWithoutResult

Authorization

AccessToken

HTTP request headers

  • Content-Type: application/json
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteEventLogsForSite

OperationResponseWithoutResult DeleteEventLogsForSite(ctx, omadacId, siteId).DeleteSiteEventLogListOpenApiVO(deleteSiteEventLogListOpenApiVO).Execute()

Delete site event log

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    deleteSiteEventLogListOpenApiVO := *openapiclient.NewDeleteSiteEventLogListOpenApiVO(int64(123), "SelectType_example", int64(123)) // DeleteSiteEventLogListOpenApiVO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LogAPI.DeleteEventLogsForSite(context.Background(), omadacId, siteId).DeleteSiteEventLogListOpenApiVO(deleteSiteEventLogListOpenApiVO).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LogAPI.DeleteEventLogsForSite``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DeleteEventLogsForSite`: OperationResponseWithoutResult
    fmt.Fprintf(os.Stdout, "Response from `LogAPI.DeleteEventLogsForSite`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId string Omada ID
siteId string Site ID

Other Parameters

Other parameters are passed through a pointer to a apiDeleteEventLogsForSiteRequest struct via the builder pattern

Name Type Description Notes

deleteSiteEventLogListOpenApiVO | DeleteSiteEventLogListOpenApiVO | |

Return type

OperationResponseWithoutResult

Authorization

AccessToken

HTTP request headers

  • Content-Type: application/json
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ExportLogListForGlobal

OperationResponse ExportLogListForGlobal(ctx, omadacId).ExportLogOpenApiVO(exportLogOpenApiVO).Execute()

Export log list in global view

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    exportLogOpenApiVO := *openapiclient.NewExportLogOpenApiVO(int32(123), []string{"SiteIds_example"}) // ExportLogOpenApiVO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LogAPI.ExportLogListForGlobal(context.Background(), omadacId).ExportLogOpenApiVO(exportLogOpenApiVO).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LogAPI.ExportLogListForGlobal``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ExportLogListForGlobal`: OperationResponse
    fmt.Fprintf(os.Stdout, "Response from `LogAPI.ExportLogListForGlobal`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId string Omada ID

Other Parameters

Other parameters are passed through a pointer to a apiExportLogListForGlobalRequest struct via the builder pattern

Name Type Description Notes

exportLogOpenApiVO | ExportLogOpenApiVO | |

Return type

OperationResponse

Authorization

AccessToken

HTTP request headers

  • Content-Type: application/json
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAlertLogsForGlobal

OperationResponseAlertLogGridVOAlertLogOpenApiVO GetAlertLogsForGlobal(ctx, omadacId).Page(page).PageSize(pageSize).FiltersTimeStart(filtersTimeStart).FiltersTimeEnd(filtersTimeEnd).FiltersModule(filtersModule).FiltersResolved(filtersResolved).Execute()

Get global alert log list

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    page := int32(56) // int32 | Start page number. Start from 1.
    pageSize := int32(56) // int32 | Number of entries per page. It should be within the range of 1–1000.(value:10,15,20,30,50,100)
    filtersTimeStart := int64(789) // int64 | Filter query parameters, support field 1679297710438
    filtersTimeEnd := int64(789) // int64 | Filter query parameters, support field 1681889710438
    filtersModule := "filtersModule_example" // string | Filter query parameters, support field module, it should be a value as follows: System, Device (optional)
    filtersResolved := true // bool | Filter query parameters, support field resolved, it should be a value as follows: true, false (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LogAPI.GetAlertLogsForGlobal(context.Background(), omadacId).Page(page).PageSize(pageSize).FiltersTimeStart(filtersTimeStart).FiltersTimeEnd(filtersTimeEnd).FiltersModule(filtersModule).FiltersResolved(filtersResolved).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LogAPI.GetAlertLogsForGlobal``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetAlertLogsForGlobal`: OperationResponseAlertLogGridVOAlertLogOpenApiVO
    fmt.Fprintf(os.Stdout, "Response from `LogAPI.GetAlertLogsForGlobal`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId string Omada ID

Other Parameters

Other parameters are passed through a pointer to a apiGetAlertLogsForGlobalRequest struct via the builder pattern

Name Type Description Notes

page | int32 | Start page number. Start from 1. | pageSize | int32 | Number of entries per page. It should be within the range of 1–1000.(value:10,15,20,30,50,100) | filtersTimeStart | int64 | Filter query parameters, support field 1679297710438 | filtersTimeEnd | int64 | Filter query parameters, support field 1681889710438 | filtersModule | string | Filter query parameters, support field module, it should be a value as follows: System, Device | filtersResolved | bool | Filter query parameters, support field resolved, it should be a value as follows: true, false |

Return type

OperationResponseAlertLogGridVOAlertLogOpenApiVO

Authorization

AccessToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAlertLogsForSite

OperationResponseAlertLogGridVOAlertLogOpenApiVO GetAlertLogsForSite(ctx, omadacId, siteId).Page(page).PageSize(pageSize).FiltersTimeStart(filtersTimeStart).FiltersTimeEnd(filtersTimeEnd).FiltersModule(filtersModule).FiltersResolved(filtersResolved).Execute()

Get site alert log list

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    page := int32(56) // int32 | Start page number. Start from 1.
    pageSize := int32(56) // int32 | Number of entries per page. It should be within the range of 1–1000.(value:10,15,20,30,50,100)
    filtersTimeStart := int64(789) // int64 | Filter query parameters, support field 1679297710438
    filtersTimeEnd := int64(789) // int64 | Filter query parameters, support field 1681889710438
    filtersModule := "filtersModule_example" // string | Filter query parameters, support field module, it should be a value as follows: System, Device, Client (optional)
    filtersResolved := true // bool | Filter query parameters, support field resolved, it should be a value as follows: true, false (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LogAPI.GetAlertLogsForSite(context.Background(), omadacId, siteId).Page(page).PageSize(pageSize).FiltersTimeStart(filtersTimeStart).FiltersTimeEnd(filtersTimeEnd).FiltersModule(filtersModule).FiltersResolved(filtersResolved).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LogAPI.GetAlertLogsForSite``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetAlertLogsForSite`: OperationResponseAlertLogGridVOAlertLogOpenApiVO
    fmt.Fprintf(os.Stdout, "Response from `LogAPI.GetAlertLogsForSite`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId string Omada ID
siteId string Site ID

Other Parameters

Other parameters are passed through a pointer to a apiGetAlertLogsForSiteRequest struct via the builder pattern

Name Type Description Notes

page | int32 | Start page number. Start from 1. | pageSize | int32 | Number of entries per page. It should be within the range of 1–1000.(value:10,15,20,30,50,100) | filtersTimeStart | int64 | Filter query parameters, support field 1679297710438 | filtersTimeEnd | int64 | Filter query parameters, support field 1681889710438 | filtersModule | string | Filter query parameters, support field module, it should be a value as follows: System, Device, Client | filtersResolved | bool | Filter query parameters, support field resolved, it should be a value as follows: true, false |

Return type

OperationResponseAlertLogGridVOAlertLogOpenApiVO

Authorization

AccessToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetEventLogsForGlobal

OperationResponseEventLogGridVOEventLogOpenApiVO GetEventLogsForGlobal(ctx, omadacId).Page(page).PageSize(pageSize).FiltersTimeStart(filtersTimeStart).FiltersTimeEnd(filtersTimeEnd).FiltersModule(filtersModule).Execute()

Get global event log list

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    page := int32(56) // int32 | Start page number. Start from 1.
    pageSize := int32(56) // int32 | Number of entries per page. It should be within the range of 1–1000.(value:10,15,20,30,50,100)
    filtersTimeStart := int64(789) // int64 | Filter query parameters, support field 1679297710438
    filtersTimeEnd := int64(789) // int64 | Filter query parameters, support field 1681889710438
    filtersModule := "filtersModule_example" // string | Filter query parameters, support field module, it should be a value as follows: System, Device (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LogAPI.GetEventLogsForGlobal(context.Background(), omadacId).Page(page).PageSize(pageSize).FiltersTimeStart(filtersTimeStart).FiltersTimeEnd(filtersTimeEnd).FiltersModule(filtersModule).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LogAPI.GetEventLogsForGlobal``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetEventLogsForGlobal`: OperationResponseEventLogGridVOEventLogOpenApiVO
    fmt.Fprintf(os.Stdout, "Response from `LogAPI.GetEventLogsForGlobal`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId string Omada ID

Other Parameters

Other parameters are passed through a pointer to a apiGetEventLogsForGlobalRequest struct via the builder pattern

Name Type Description Notes

page | int32 | Start page number. Start from 1. | pageSize | int32 | Number of entries per page. It should be within the range of 1–1000.(value:10,15,20,30,50,100) | filtersTimeStart | int64 | Filter query parameters, support field 1679297710438 | filtersTimeEnd | int64 | Filter query parameters, support field 1681889710438 | filtersModule | string | Filter query parameters, support field module, it should be a value as follows: System, Device |

Return type

OperationResponseEventLogGridVOEventLogOpenApiVO

Authorization

AccessToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetEventLogsForSite

OperationResponseEventLogGridVOEventLogOpenApiVO GetEventLogsForSite(ctx, omadacId, siteId).Page(page).PageSize(pageSize).FiltersTimeStart(filtersTimeStart).FiltersTimeEnd(filtersTimeEnd).FiltersModule(filtersModule).Execute()

Get site event log list

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    page := int32(56) // int32 | Start page number. Start from 1.
    pageSize := int32(56) // int32 | Number of entries per page. It should be within the range of 1–1000.(value:10,15,20,30,50,100)
    filtersTimeStart := int64(789) // int64 | Filter query parameters, support field 1679297710438
    filtersTimeEnd := int64(789) // int64 | Filter query parameters, support field 1681889710438
    filtersModule := "filtersModule_example" // string | Filter query parameters, support field module, it should be a value as follows: System, Device, Client (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LogAPI.GetEventLogsForSite(context.Background(), omadacId, siteId).Page(page).PageSize(pageSize).FiltersTimeStart(filtersTimeStart).FiltersTimeEnd(filtersTimeEnd).FiltersModule(filtersModule).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LogAPI.GetEventLogsForSite``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetEventLogsForSite`: OperationResponseEventLogGridVOEventLogOpenApiVO
    fmt.Fprintf(os.Stdout, "Response from `LogAPI.GetEventLogsForSite`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId string Omada ID
siteId string Site ID

Other Parameters

Other parameters are passed through a pointer to a apiGetEventLogsForSiteRequest struct via the builder pattern

Name Type Description Notes

page | int32 | Start page number. Start from 1. | pageSize | int32 | Number of entries per page. It should be within the range of 1–1000.(value:10,15,20,30,50,100) | filtersTimeStart | int64 | Filter query parameters, support field 1679297710438 | filtersTimeEnd | int64 | Filter query parameters, support field 1681889710438 | filtersModule | string | Filter query parameters, support field module, it should be a value as follows: System, Device, Client |

Return type

OperationResponseEventLogGridVOEventLogOpenApiVO

Authorization

AccessToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetLogSettingForGlobal

OperationResponseLogNotificationSettingOpenApiVO GetLogSettingForGlobal(ctx, omadacId).Execute()

Get global log notification

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LogAPI.GetLogSettingForGlobal(context.Background(), omadacId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LogAPI.GetLogSettingForGlobal``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetLogSettingForGlobal`: OperationResponseLogNotificationSettingOpenApiVO
    fmt.Fprintf(os.Stdout, "Response from `LogAPI.GetLogSettingForGlobal`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId string Omada ID

Other Parameters

Other parameters are passed through a pointer to a apiGetLogSettingForGlobalRequest struct via the builder pattern

Name Type Description Notes

Return type

OperationResponseLogNotificationSettingOpenApiVO

Authorization

AccessToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetLogSettingForGlobalV2

OperationResponseLogNotificationSettingOpenApiVO GetLogSettingForGlobalV2(ctx, omadacId).Execute()

Get global log notification v2

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LogAPI.GetLogSettingForGlobalV2(context.Background(), omadacId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LogAPI.GetLogSettingForGlobalV2``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetLogSettingForGlobalV2`: OperationResponseLogNotificationSettingOpenApiVO
    fmt.Fprintf(os.Stdout, "Response from `LogAPI.GetLogSettingForGlobalV2`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId string Omada ID

Other Parameters

Other parameters are passed through a pointer to a apiGetLogSettingForGlobalV2Request struct via the builder pattern

Name Type Description Notes

Return type

OperationResponseLogNotificationSettingOpenApiVO

Authorization

AccessToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetLogSettingForSite

OperationResponseLogNotificationSettingOpenApiVO GetLogSettingForSite(ctx, omadacId, siteId).Execute()

Get site log notification

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LogAPI.GetLogSettingForSite(context.Background(), omadacId, siteId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LogAPI.GetLogSettingForSite``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetLogSettingForSite`: OperationResponseLogNotificationSettingOpenApiVO
    fmt.Fprintf(os.Stdout, "Response from `LogAPI.GetLogSettingForSite`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId string Omada ID
siteId string Site ID

Other Parameters

Other parameters are passed through a pointer to a apiGetLogSettingForSiteRequest struct via the builder pattern

Name Type Description Notes

Return type

OperationResponseLogNotificationSettingOpenApiVO

Authorization

AccessToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetLogSettingForSiteV2

OperationResponseLogNotificationSettingOpenApiVO GetLogSettingForSiteV2(ctx, omadacId, siteId).Execute()

Get site log notification v2

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LogAPI.GetLogSettingForSiteV2(context.Background(), omadacId, siteId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LogAPI.GetLogSettingForSiteV2``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetLogSettingForSiteV2`: OperationResponseLogNotificationSettingOpenApiVO
    fmt.Fprintf(os.Stdout, "Response from `LogAPI.GetLogSettingForSiteV2`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId string Omada ID
siteId string Site ID

Other Parameters

Other parameters are passed through a pointer to a apiGetLogSettingForSiteV2Request struct via the builder pattern

Name Type Description Notes

Return type

OperationResponseLogNotificationSettingOpenApiVO

Authorization

AccessToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetRemoteLoggingSettingTip

OperationResponseSiteRemoteLoggingSetting GetRemoteLoggingSettingTip(ctx, omadacId, siteId).Execute()

Get site remote logging setting tip

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | site_id

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LogAPI.GetRemoteLoggingSettingTip(context.Background(), omadacId, siteId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LogAPI.GetRemoteLoggingSettingTip``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetRemoteLoggingSettingTip`: OperationResponseSiteRemoteLoggingSetting
    fmt.Fprintf(os.Stdout, "Response from `LogAPI.GetRemoteLoggingSettingTip`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId string Omada ID
siteId string site_id

Other Parameters

Other parameters are passed through a pointer to a apiGetRemoteLoggingSettingTipRequest struct via the builder pattern

Name Type Description Notes

Return type

OperationResponseSiteRemoteLoggingSetting

Authorization

AccessToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetRemoteLoggingTip

OperationResponseCustomerRemoteLogTipOpenApiVO GetRemoteLoggingTip(ctx, omadacId).Execute()

Get customer remote logging tip

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LogAPI.GetRemoteLoggingTip(context.Background(), omadacId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LogAPI.GetRemoteLoggingTip``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetRemoteLoggingTip`: OperationResponseCustomerRemoteLogTipOpenApiVO
    fmt.Fprintf(os.Stdout, "Response from `LogAPI.GetRemoteLoggingTip`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId string Omada ID

Other Parameters

Other parameters are passed through a pointer to a apiGetRemoteLoggingTipRequest struct via the builder pattern

Name Type Description Notes

Return type

OperationResponseCustomerRemoteLogTipOpenApiVO

Authorization

AccessToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ModifyLogSettingGlobal

OperationResponseWithoutResult ModifyLogSettingGlobal(ctx, omadacId).LogNotificationSettingEditOpenApiVO(logNotificationSettingEditOpenApiVO).Execute()

Modify global log notification

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    logNotificationSettingEditOpenApiVO := *openapiclient.NewLogNotificationSettingEditOpenApiVO([]openapiclient.LogNotificationEditOpenApiVO{*openapiclient.NewLogNotificationEditOpenApiVO(false, true, true, "LOGIN_OK")}) // LogNotificationSettingEditOpenApiVO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LogAPI.ModifyLogSettingGlobal(context.Background(), omadacId).LogNotificationSettingEditOpenApiVO(logNotificationSettingEditOpenApiVO).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LogAPI.ModifyLogSettingGlobal``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ModifyLogSettingGlobal`: OperationResponseWithoutResult
    fmt.Fprintf(os.Stdout, "Response from `LogAPI.ModifyLogSettingGlobal`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId string Omada ID

Other Parameters

Other parameters are passed through a pointer to a apiModifyLogSettingGlobalRequest struct via the builder pattern

Name Type Description Notes

logNotificationSettingEditOpenApiVO | LogNotificationSettingEditOpenApiVO | |

Return type

OperationResponseWithoutResult

Authorization

AccessToken

HTTP request headers

  • Content-Type: application/json
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ModifyLogSettingGlobalV2

OperationResponseWithoutResult ModifyLogSettingGlobalV2(ctx, omadacId).LogNotificationSettingEditOpenApiV2VO(logNotificationSettingEditOpenApiV2VO).Execute()

Modify global log notification v2

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    logNotificationSettingEditOpenApiV2VO := *openapiclient.NewLogNotificationSettingEditOpenApiV2VO() // LogNotificationSettingEditOpenApiV2VO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LogAPI.ModifyLogSettingGlobalV2(context.Background(), omadacId).LogNotificationSettingEditOpenApiV2VO(logNotificationSettingEditOpenApiV2VO).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LogAPI.ModifyLogSettingGlobalV2``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ModifyLogSettingGlobalV2`: OperationResponseWithoutResult
    fmt.Fprintf(os.Stdout, "Response from `LogAPI.ModifyLogSettingGlobalV2`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId string Omada ID

Other Parameters

Other parameters are passed through a pointer to a apiModifyLogSettingGlobalV2Request struct via the builder pattern

Name Type Description Notes

logNotificationSettingEditOpenApiV2VO | LogNotificationSettingEditOpenApiV2VO | |

Return type

OperationResponseWithoutResult

Authorization

AccessToken

HTTP request headers

  • Content-Type: application/json
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ModifyLogSettingSite

OperationResponseWithoutResult ModifyLogSettingSite(ctx, omadacId, siteId).LogNotificationSettingEditOpenApiVO(logNotificationSettingEditOpenApiVO).Execute()

Modify site log notification

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    logNotificationSettingEditOpenApiVO := *openapiclient.NewLogNotificationSettingEditOpenApiVO([]openapiclient.LogNotificationEditOpenApiVO{*openapiclient.NewLogNotificationEditOpenApiVO(false, true, true, "LOGIN_OK")}) // LogNotificationSettingEditOpenApiVO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LogAPI.ModifyLogSettingSite(context.Background(), omadacId, siteId).LogNotificationSettingEditOpenApiVO(logNotificationSettingEditOpenApiVO).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LogAPI.ModifyLogSettingSite``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ModifyLogSettingSite`: OperationResponseWithoutResult
    fmt.Fprintf(os.Stdout, "Response from `LogAPI.ModifyLogSettingSite`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId string Omada ID
siteId string Site ID

Other Parameters

Other parameters are passed through a pointer to a apiModifyLogSettingSiteRequest struct via the builder pattern

Name Type Description Notes

logNotificationSettingEditOpenApiVO | LogNotificationSettingEditOpenApiVO | |

Return type

OperationResponseWithoutResult

Authorization

AccessToken

HTTP request headers

  • Content-Type: application/json
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ModifyLogSettingSiteV2

OperationResponseWithoutResult ModifyLogSettingSiteV2(ctx, omadacId, siteId).LogNotificationSettingEditOpenApiV2VO(logNotificationSettingEditOpenApiV2VO).Execute()

Modify site log notification v2

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    logNotificationSettingEditOpenApiV2VO := *openapiclient.NewLogNotificationSettingEditOpenApiV2VO() // LogNotificationSettingEditOpenApiV2VO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LogAPI.ModifyLogSettingSiteV2(context.Background(), omadacId, siteId).LogNotificationSettingEditOpenApiV2VO(logNotificationSettingEditOpenApiV2VO).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LogAPI.ModifyLogSettingSiteV2``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ModifyLogSettingSiteV2`: OperationResponseWithoutResult
    fmt.Fprintf(os.Stdout, "Response from `LogAPI.ModifyLogSettingSiteV2`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId string Omada ID
siteId string Site ID

Other Parameters

Other parameters are passed through a pointer to a apiModifyLogSettingSiteV2Request struct via the builder pattern

Name Type Description Notes

logNotificationSettingEditOpenApiV2VO | LogNotificationSettingEditOpenApiV2VO | |

Return type

OperationResponseWithoutResult

Authorization

AccessToken

HTTP request headers

  • Content-Type: application/json
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ResetLogSettingGlobal

OperationResponseWithoutResult ResetLogSettingGlobal(ctx, omadacId).Execute()

Reset global log notification

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LogAPI.ResetLogSettingGlobal(context.Background(), omadacId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LogAPI.ResetLogSettingGlobal``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ResetLogSettingGlobal`: OperationResponseWithoutResult
    fmt.Fprintf(os.Stdout, "Response from `LogAPI.ResetLogSettingGlobal`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId string Omada ID

Other Parameters

Other parameters are passed through a pointer to a apiResetLogSettingGlobalRequest struct via the builder pattern

Name Type Description Notes

Return type

OperationResponseWithoutResult

Authorization

AccessToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ResetLogSettingSite

OperationResponseWithoutResult ResetLogSettingSite(ctx, omadacId, siteId).Execute()

Reset site log notification

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LogAPI.ResetLogSettingSite(context.Background(), omadacId, siteId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LogAPI.ResetLogSettingSite``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ResetLogSettingSite`: OperationResponseWithoutResult
    fmt.Fprintf(os.Stdout, "Response from `LogAPI.ResetLogSettingSite`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId string Omada ID
siteId string Site ID

Other Parameters

Other parameters are passed through a pointer to a apiResetLogSettingSiteRequest struct via the builder pattern

Name Type Description Notes

Return type

OperationResponseWithoutResult

Authorization

AccessToken

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ResolveAlertForSite

OperationResponseWithoutResult ResolveAlertForSite(ctx, omadacId, siteId).ResolveSiteLogListOpenApiVO(resolveSiteLogListOpenApiVO).Execute()

Resolve site alert log

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/Tohaker/omada-go-sdk/omada"
)

func main() {
    omadacId := "omadacId_example" // string | Omada ID
    siteId := "siteId_example" // string | Site ID
    resolveSiteLogListOpenApiVO := *openapiclient.NewResolveSiteLogListOpenApiVO(int64(123), "SelectType_example", int64(123)) // ResolveSiteLogListOpenApiVO | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.LogAPI.ResolveAlertForSite(context.Background(), omadacId, siteId).ResolveSiteLogListOpenApiVO(resolveSiteLogListOpenApiVO).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `LogAPI.ResolveAlertForSite``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ResolveAlertForSite`: OperationResponseWithoutResult
    fmt.Fprintf(os.Stdout, "Response from `LogAPI.ResolveAlertForSite`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
omadacId string Omada ID
siteId string Site ID

Other Parameters

Other parameters are passed through a pointer to a apiResolveAlertForSiteRequest struct via the builder pattern

Name Type Description Notes

resolveSiteLogListOpenApiVO | ResolveSiteLogListOpenApiVO | |

Return type

OperationResponseWithoutResult

Authorization

AccessToken

HTTP request headers

  • Content-Type: application/json
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]