Lookup Schedules
A lookup schedule specifies the rules for lookup on a specified group of domains. You can create lookup schedules for a group of domains. This means that it is possible to lookup a small subset of your portfolio more often than the rest. You can also specify how often the lookups should happen for the group of domains specified in a schedule.
Here is a typical lookup schedule
| Parameter | Notes |
|---|---|
| lutype | The type of lookup. This is typically an integer
|
| lunits | Lookup frequency mode (0: Every minute, 1: Hourly, 2: Daily, 3: Weekly, 4: Monthly, 5: Whenever). The whenever
setting is used for special internal checks and shouldn't be used for normal domain lookups.
|
| frequency | The lookup frequency. If you set this to 30 and the lunits to 1 (hourly), the data will be refreshed every 30 hours.
|
| enabled | If set to 0, the lookups will be disabled. |
| query | An SQL query fragment that is used to pick the exact domains that form part of this schedule. For example,
registry_expiry LE ?.
|
| params | The SQL query parameters as required by the query value. For example, [TODAY+30]
|
| last_runat | The last time this lookup schedule was successfully processed. |
list
| Parameter | Notes |
|---|---|
| c | admin
|
| t | schedule
|
| oper | list
|
?c=admin&t=schedule&oper=list
{
"status": "ok",
"error": "",
"validate": 0,
"schedules": [
{
"id": "1",
"name": "Whois",
"lutype": "1",
"lunits": "2",
"frequency": "90",
"last_runat": "2019-02-07 09:08:01",
"next_runat": null,
"enabled": "1",
"query": null,
"params": null
},
{
"id": "2",
"name": "Root DNS",
"lutype": "2",
"lunits": "2",
"frequency": "30",
"last_runat": "2019-02-07 09:08:01",
"next_runat": null,
"enabled": "1",
"query": null,
"params": null
},
{
"id": "3",
"name": "SSL",
"lutype": "64",
"lunits": "2",
"frequency": "30",
"last_runat": "2019-02-07 09:08:01",
"next_runat": null,
"enabled": "0",
"query": null,
"params": null
},
{
"id": "4",
"name": "Extended DNS",
"lutype": "512",
"lunits": "2",
"frequency": "30",
"last_runat": "2019-02-07 09:08:01",
"next_runat": null,
"enabled": "0",
"query": null,
"params": null
},
{
"id": "5",
"name": "Home Page",
"lutype": "4",
"lunits": "2",
"frequency": "30",
"last_runat": "2019-02-07 09:08:01",
"next_runat": null,
"enabled": "0",
"query": null,
"params": null
},
{
"id": "6",
"name": "Alexa",
"lutype": "16",
"lunits": "2",
"frequency": "30",
"last_runat": "2019-02-07 09:08:01",
"next_runat": null,
"enabled": "0",
"query": null,
"params": null
},
{
"id": "7",
"name": "Ping",
"lutype": "32",
"lunits": "1",
"frequency": "30",
"last_runat": "2019-02-07 09:08:01",
"next_runat": null,
"enabled": "0",
"query": null,
"params": null
},
{
"id": "8",
"name": "IP Whois",
"lutype": "128",
"lunits": "2",
"frequency": "30",
"last_runat": "2019-02-07 09:08:01",
"next_runat": null,
"enabled": "0",
"query": null,
"params": null
},
{
"id": "9",
"name": "Google Index",
"lutype": "1024",
"lunits": "2",
"frequency": "30",
"last_runat": "2019-02-07 09:08:01",
"next_runat": null,
"enabled": "0",
"query": null,
"params": null
},
{
"id": "10",
"name": "Domains Nearing Expiry",
"lutype": "1",
"lunits": "1",
"frequency": "24",
"last_runat": "2019-02-07 09:08:01",
"next_runat": null,
"enabled": "1",
"query": "d.registrar_expiry LE ? OR d.registry_expiry LE ?",
"params": "[TODAY+30],[TODAY+30]"
},
{
"id": "11",
"name": "SSLs Nearing Expiry",
"lutype": "64",
"lunits": "1",
"frequency": "24",
"last_runat": "2019-02-07 09:08:01",
"next_runat": null,
"enabled": "1",
"query": "s.ssl_valid_to LE ?",
"params": "[TODAY+30]"
},
{
"id": "12",
"name": "SSL for Newly Added Subdomains",
"lutype": "64",
"lunits": "-1",
"frequency": "30",
"last_runat": "2019-02-07 09:08:01",
"next_runat": null,
"enabled": "1",
"query": "s.auto_added=0 AND s.added_on > d.ssl_checked_at AND d.ssl_checked_at IS NOT NULL",
"params": null
},
{
"id": "13",
"name": "Extended DNS for Newly Added Subdomains",
"lutype": "512",
"lunits": "-1",
"frequency": "30",
"last_runat": "2019-02-07 09:08:01",
"next_runat": null,
"enabled": "1",
"query": "s.auto_added=0 AND s.added_on > d.subdomains_checked_at AND d.subdomains_checked_at IS NOT NULL",
"params": null
}
]
}
get
| Parameter | Notes |
|---|---|
| c | admin
|
| t | schedule
|
| oper | get
|
| name | Name of the schedule to get |
?c=admin&t=schedule&oper=get&name=Whois
{
"status": "ok",
"error": "",
"validate": 0,
"id": "1",
"name": "Whois",
"lutype": "1",
"lunits": "2",
"frequency": "90",
"last_runat": "2019-02-07 09:10:01",
"enabled": "1",
"query": null,
"params": null
}
add
| Parameter | Notes |
|---|---|
| c | admin
|
| t | schedule
|
| oper | add
|
| name | Name of the schedule to add. |
?c=admin&t=schedule&oper=add&name=Whois
{
"status": "notok",
"error": "A schedule with same name already exists.",
"validate": 0
}
?c=admin&t=schedule&oper=add&name=Daily Whois
{
"status": "ok",
"error": "",
"validate": 0,
"updated": false,
"categories": 0
}
set
| Parameter | Notes |
|---|---|
| c | admin
|
| t | schedule
|
| oper | set
|
| name | Name of the schedule to get |
| lutype | Lookup type code |
| frequency | Lookup frequency |
| lunits | Lookup frequency mode |
| enabled | Set to 1 for enabling the schedule, 0 to disable. |
| query | Optional query string |
| params | Parameters for the query, if any. |
?c=admin&t=schedule&oper=set&name=Daily%20Whois&lutype=32&enabled=1
{
"status": "ok",
"error": "",
"validate": 0,
"updated": true,
"categories": 0
}
del
| Parameter | Notes |
|---|---|
| c | admin
|
| t | schedule
|
| oper | del
|
| id | The id of the schedule to delete |
| name | The name of the schedule to delete (ignored if the id is specified)
|
?c=admin&t=schedule&oper=del&name=Daily%20Whois
{
"status": "ok",
"error": "",
"validate": 0
}