DNS

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

Operation	Method	Summary
getDnsCacheList	GET	Get DNS cache list
clearDnsCacheList	POST	Clear DNS cache list
getDdnsGrid	GET	Get Dynamic DNS list
createDdns	POST	Create a new Dynamic DNS entry
deleteDdns	DELETE	Delete an exist Dynamic DNS entry
modifyDdns	PATCH	Modify an exist Dynamic DNS entry
getDnsCacheSetting	GET	Get DNS cache
modifyDnsCacheSetting	PUT	Modify DNS cache setting
getDnsProxy	GET	Get DNS proxy setting
modifyDnsProxy	PATCH	Modify DNS proxy setting

getDnsCacheList

GET /openapi/v1/{omadacId}/sites/{siteId}/setting/dns-cache-data

Get DNS cache 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)
`dnsCacheQueryVO`	query	DnsCacheQueryOpenApiV2VO	no	Object: its fields (currentPage, currentPageSize, type) are sent as separate query parameters.

json

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

Details, permissions and error codes

Get DNS cache list of the site with the given omadacId and siteId.
The interface requires one of the permissions:
Site Settings Manager View Only
Device Config Page View Only
Site Device Manager View Only
The possible error code for the interface in the returned body is one of the following error codes (non generic error codes):
-33000 - This site does not exist.
-33004 - Operation failed because other operations (site copying, restoring, template synchronizing, etc.) are being performed on this site. Please wait and try again later.

clearDnsCacheList

POST /openapi/v1/{omadacId}/sites/{siteId}/setting/dns-cache-data/clear

Clear DNS cache 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)

json

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

Details, permissions and error codes

Clear DNS cache list with the given params.
The interface requires one of the permissions:
Site Settings Manager Modify
Device Config Page Modify
Site Device Manager Modify
The possible error code for the interface in the returned body is one of the following error codes (non generic error codes):
-33000 - This site does not exist.
-33004 - Operation failed because other operations (site copying, restoring, template synchronizing, etc.) are being performed on this site. Please wait and try again later.

getDdnsGrid

GET /openapi/v1/{omadacId}/sites/{siteId}/setting/service/ddns

Get Dynamic DNS 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)
`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. (default 100)
`sorts.service`	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
`sorts.updateInterval`	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
`sorts.status`	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

json

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

Details, permissions and error codes

Get Dynamic DNS list of the site with the given omadacId and siteId.
The interface requires one of the permissions:
Site Settings Manager View Only
Device Config Page View Only
Site Device Manager View Only
The possible error code for the interface in the returned body is one of the following error codes (non generic error codes):
-33000 - This site does not exist.
-33004 - Operation failed because other operations (site copying, restoring, template synchronizing, etc.) are being performed on this site. Please wait and try again later.

createDdns

POST /openapi/v1/{omadacId}/sites/{siteId}/setting/service/ddns

Create a new Dynamic DNS entry

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 CreateDdnsOpenApiVO

Field	Type	Required	Description
`service`	integer	yes	Dynamic DNS service type. Service should be a value as follows: 0: DynDNS, 1: NO-IP, 2: Peanuthull, 3: Comexe, 4: Custom, 5: TP-Link DDNS
`status`	boolean	yes	Dynamic DNS enable status
`interfacePortId`	string	yes	This field represents interface Port ID
`username`	string	yes	Dynamic DNS username. Username should contain 1 to 128 characters
`password`	string	yes	Dynamic DNS password. Password should contain 1 to 128 characters
`domainName`	string	no	Dynamic DNS domainName, valid when parameter [service] is 0, 1 or 4
`interval`	DdnsIntervalOpenApiVO	no	(DdnsIntervalOpenApiVO not expanded; call omada_get_schema "DdnsIntervalOpenApiVO")
`updateUrl`	string	no	Dynamic DNS updateUrl, valid when parameter [service] is 4. Update URL must contain [USERNAME], [PASSWORD] and [DOMAIN], and Update-URL will be applied to all custom entries

json

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

Details, permissions and error codes

Create a new Dynamic DNS entry with the given params.
The interface requires one of the permissions:
Site Settings Manager Modify
Device Config Page Modify
Site Device Manager Modify
The possible error code for the interface in the returned body is one of the following error codes (non generic error codes):
-33000 - This site does not exist.
-33004 - Operation failed because other operations (site copying, restoring, template synchronizing, etc.) are being performed on this site. Please wait and try again later.
-33474 - This feature is not supported for the DS-Lite or Map-E WAN connection types.
-34500 - Dynamic DNS Entries can be created with only one service provider for one WAN port.
-34510 - The domain name and service provider of different Dynamic DNS Entries should be different.
-34516 - The username already exists under the selected service provider.
-34563 - Only one TP-Link Dynamic DNS is allowed for one site.
-34564 - The TP-Link Dynamic DNS domain name cannot contain sensitive fields such as email, tp-link, tplink, and www.
-34565 - The TP-Link Dynamic DNS domain name should end with ".tplinkdns.com".
-34566 - The TP-Link Dynamic DNS domain name is invalid.

deleteDdns

DELETE /openapi/v1/{omadacId}/sites/{siteId}/setting/service/ddns/{ddnsId}

Delete an exist Dynamic DNS entry

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)
`ddnsId`	path	string	yes	Dynamic DNS entry ID

json

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

Details, permissions and error codes

Delete an exist Dynamic DNS entry with the given params.
The interface requires one of the permissions:
Site Settings Manager Modify
Device Config Page Modify
Site Device Manager Modify
The possible error code for the interface in the returned body is one of the following error codes (non generic error codes):
-33000 - This site does not exist.
-33004 - Operation failed because other operations (site copying, restoring, template synchronizing, etc.) are being performed on this site. Please wait and try again later.

modifyDdns

PATCH /openapi/v1/{omadacId}/sites/{siteId}/setting/service/ddns/{ddnsId}

Modify an exist Dynamic DNS entry

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)
`ddnsId`	path	string	yes	Dynamic DNS entry ID

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

Field	Type	Required	Description
`service`	integer	yes	Dynamic DNS service type. Service should be a value as follows: 0: DynDNS, 1: NO-IP, 2: Peanuthull, 3: Comexe, 4: Custom, 5: TP-Link DDNS
`status`	boolean	yes	Dynamic DNS enable status
`interfacePortId`	string	yes	This field represents interface Port ID
`username`	string	yes	Dynamic DNS username. Username should contain 1 to 128 characters
`password`	string	yes	Dynamic DNS password. Password should contain 1 to 128 characters
`domainName`	string	no	Dynamic DNS domainName, valid when parameter [service] is 0, 1 or 4
`interval`	DdnsIntervalOpenApiVO	no	(DdnsIntervalOpenApiVO not expanded; call omada_get_schema "DdnsIntervalOpenApiVO")
`updateUrl`	string	no	Dynamic DNS updateUrl, valid when parameter [service] is 4. Update URL must contain [USERNAME], [PASSWORD] and [DOMAIN], and Update-URL will be applied to all custom entries

json

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

Details, permissions and error codes

Modify an exist Dynamic DNS entry with the given params.
The interface requires one of the permissions:
Site Settings Manager Modify
Device Config Page Modify
Site Device Manager Modify
The possible error code for the interface in the returned body is one of the following error codes (non generic error codes):
-33000 - This site does not exist.
-33004 - Operation failed because other operations (site copying, restoring, template synchronizing, etc.) are being performed on this site. Please wait and try again later.
-33474 - This feature is not supported for the DS-Lite or Map-E WAN connection types.
-34500 - Dynamic DNS Entries can be created with only one service provider for one WAN port.
-34510 - The domain name and service provider of different Dynamic DNS Entries should be different.
-34516 - The username already exists under the selected service provider.
-34564 - The TP-Link Dynamic DNS domain name cannot contain sensitive fields such as email, tp-link, tplink, and www.
-34565 - The TP-Link Dynamic DNS domain name should end with ".tplinkdns.com".
-34566 - The TP-Link Dynamic DNS domain name is invalid.

getDnsCacheSetting

GET /openapi/v1/{omadacId}/sites/{siteId}/setting/service/dns-cache

Get DNS cache

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)

json

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

Details, permissions and error codes

Get DNS cache setting of the site with the given omadacId and siteId.
The interface requires one of the permissions:
Site Settings Manager View Only
Device Config Page View Only
Site Device Manager View Only
The possible error code for the interface in the returned body is one of the following error codes (non generic error codes):
-33004 - Operation failed because other operations (site copying, restoring, template synchronizing, etc.) are being performed on this site. Please wait and try again later.

modifyDnsCacheSetting

PUT /openapi/v1/{omadacId}/sites/{siteId}/setting/service/dns-cache

Modify DNS cache 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 DnsCacheOpenApiVO

Field	Type	Required	Description
`enable`	boolean	no	Whether to enable DNS Cache. Options: 'true' or 'false'.
`ttl`	integer	no	TTL should be within the range of 1 or 86400.

json

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

Details, permissions and error codes

Modify DNS cache setting
The interface requires one of the permissions:
Site Settings Manager Modify
Device Config Page Modify
Site Device Manager Modify
The possible error code for the interface in the returned body is one of the following error codes (non generic error codes):
-33004 - Operation failed because other operations (site copying, restoring, template synchronizing, etc.) are being performed on this site. Please wait and try again later.

getDnsProxy

GET /openapi/v1/{omadacId}/sites/{siteId}/setting/service/dns-proxy

Get DNS proxy 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)

json

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

Details, permissions and error codes

Get DNS proxy setting of the site with the given omadacId and siteId.
The interface requires one of the permissions:
Site Settings Manager View Only
Device Config Page View Only
Site Device Manager View Only
The possible error code for the interface in the returned body is one of the following error codes (non generic error codes):
-33000 - This site does not exist.
-33004 - Operation failed because other operations (site copying, restoring, template synchronizing, etc.) are being performed on this site. Please wait and try again later.

modifyDnsProxy

PATCH /openapi/v1/{omadacId}/sites/{siteId}/setting/service/dns-proxy

Modify DNS proxy 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 DnsProxySettingOpenApiVO

Field	Type	Required	Description
`enable`	boolean	yes	DNS proxy setting enable status
`type`	integer	no	DNS proxy setting type. Type should be a value as follows: 0: DNSSEC, 1: DoH, 2: DoT, 3: DNS Override
`dnsSecSetting`	DnsSecSettingOpenApiVO	no	(DnsSecSettingOpenApiVO not expanded; call omada_get_schema "DnsSecSettingOpenApiVO")
`dohSetting`	DohSettingOpenApiVO	no	(DohSettingOpenApiVO not expanded; call omada_get_schema "DohSettingOpenApiVO")
`dotSetting`	DotSettingOpenApiVO	no	(DotSettingOpenApiVO not expanded; call omada_get_schema "DotSettingOpenApiVO")
`dnsOverrideSetting`	DnsOverrideSettingOpenApiVO	no	(DnsOverrideSettingOpenApiVO not expanded; call omada_get_schema "DnsOverrideSettingOpenApiVO")

json

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

Details, permissions and error codes

Modify DNS proxy setting info of the site with the given params.
The interface requires one of the permissions:
Site Settings Manager Modify
Device Config Page Modify
Site Device Manager Modify
The possible error code for the interface in the returned body is one of the following error codes (non generic error codes):
-33000 - This site does not exist.
-33004 - Operation failed because other operations (site copying, restoring, template synchronizing, etc.) are being performed on this site. Please wait and try again later.
-34536 - Please enable at least one DNS Sec server.
-34538 - The number of custom DNS servers has reached the limit.
-34539 - Please enable at least one DoH server.
-34540 - Please enable at least one DoT server.
-34578 - The Gateway dose not support the type Override
-34579 - The Gateway dose not support DNS proxy
-34588 - Please select a network.
-34589 - The selected network ID does not exist.
-34590 - Invalid IP address in DNS Server.

DNS ​

getDnsCacheList ​

clearDnsCacheList ​

getDdnsGrid ​

createDdns ​

deleteDdns ​

modifyDdns ​

getDnsCacheSetting ​

modifyDnsCacheSetting ​

getDnsProxy ​

modifyDnsProxy ​

DNS

getDnsCacheList

clearDnsCacheList

getDdnsGrid

createDdns

deleteDdns

modifyDdns

getDnsCacheSetting

modifyDnsCacheSetting

getDnsProxy

modifyDnsProxy