Skip to content

MSP Site ​

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

OperationMethodSummary
getSiteList_1GETGet msp site list
getTags_2GETGet msp site tag list

getSiteList_1 ​

GET /openapi/v1/msp/{mspId}/sites

Get msp site list

ParameterInTypeRequiredDescription
mspIdpathstringautoMSP ID (filled in automatically)
pagequeryintegernoStart page number. Start from 1. (default 1)
pageSizequeryintegernoNumber of entries per page. It should be within the range of 1–1000. (default 100)
sorts.namequerystringnoSort 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
searchKeyquerystringnoFuzzy query parameters, support field name
filters.tagquerystringnoFilter query parameters, support field tag ID
filters.typequerystringnoFilter query parameters, support field site type. 0: basic site; 1: pro site.
json
// omada_call_operation
{
  "operationId": "getSiteList_1"
}
Details, permissions and error codes

Get msp site list
The interface requires one of the permissions:
MSP Site Manager View Only

getTags_2 ​

GET /openapi/v1/msp/{mspId}/sites/tags

Get msp site tag list

ParameterInTypeRequiredDescription
mspIdpathstringautoMSP ID (filled in automatically)
json
// omada_call_operation
{
  "operationId": "getTags_2"
}
Details, permissions and error codes

Get msp site tag list.
The interface requires one of the permissions:
MSP Site Manager View Only

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