List
category domain report subdomain ui tasks
category
Obtain the category list
| Parameter | Notes |
|---|---|
| c | list
|
| t | category
|
| oper | user or domain.If oper=user, a list of categories the
current user can access will be returned.If oper=domain, a list of categories belonged to by
each of the domains referenced in the id parameter will be returned.
|
| id | Comma separated list of domain ids (sid) to get data for, valid only when oper
is set to domain. If the user has no access to a domain, the corresponding data will be suppressed.
|
Examples
?c=list&t=category&oper=user
Sample output
{
"status": "ok",
"error": "",
"validate": 0,
"ids": [
{
"name": "Keyword Domains",
"caticon": "folder-gray.png",
"sortindex": "1",
"id": "2",
"userids": [
1
]
},
{
"name": "Parked Domains",
"caticon": "folder-gray.png",
"sortindex": "2",
"id": "3",
"userids": [
1
]
},
{
"name": "Business Domains",
"caticon": "folder-gray.png",
"sortindex": "4",
"id": "5",
"userids": [
1
]
},
{
"name": "Bookmarked Domains",
"caticon": "folder-gray.png",
"sortindex": "5",
"id": "6",
"userids": [
1
]
},
{
"name": "High Traffic Domains",
"caticon": "folder-gray.png",
"sortindex": "6",
"id": "7",
"userids": [
1
]
},
{
"name": "Important Domains",
"caticon": "folder-gray.png",
"sortindex": "8",
"id": "9",
"userids": [
1
]
}
]
}
?c=list&t=category&oper=domain&id=42,1,2,3,4,41,40,43
Sample output
{
"status": "ok",
"error": "",
"validate": 0,
"categories": {
"40": [
{
"cid": 7,
"name": "High Traffic Domains"
}
],
"41": [
{
"cid": 6,
"name": "Bookmarked Domains"
},
{
"cid": 7,
"name": "High Traffic Domains"
},
{
"cid": 9,
"name": "Important Domains"
}
],
"42": [
{
"cid": 7,
"name": "High Traffic Domains"
}
]
}
}
domain
| Parameter | Notes |
|---|---|
| c | list
|
| t | domain
|
| oper | columns, colmodel or history.
|
| group | Use group=type (when oper is set to columns) to have the column insformation sorted
by type of data (string, date, datetime, boolean, integer, etc.)
The name of the display group to get data for (when oper is set to colmodel). The group name could be
one of custom01_columns_array, custom02_columns_array, custom03_columns_array, date_columns_array, http_columns_array,
registrar_columns_array, network_columns_array, sitepop_columns_array, notes_columns_array or ipdata_columns_array
If getting the history list, the ftype columns will contain the type of each historical data. (Registrar WHOIS = 1,
Root DNS = 2, Alexa Data = 16, Registrar WHOIS = 256, etc.)
|
Examples
?c=list&t=domain&oper=columns&group=type
{
"status": "ok",
"error": "",
"validate": 0,
"columns": {
"string": [
{
"name": "address",
"label": "Address"
},
...
...
],
"boolean": [
{
"name": "disable_alerts",
"label": "Disable Alerts"
},
...
...
],
"integer": [
{
"name": "alexa_rank",
"label": "Alexa Rank"
},
...
...
],
"date": [
{
"name": "created_on",
"label": "Created On"
},
...
...
],
"datetime": [
{
"name": "added_on",
"label": "Added On"
},
...
...
]
}
}
?c=list&t=domain&oper=columns
{
"status": "ok",
"error": "",
"validate": 0,
"columns": {
"added_on": {
"label": "Added On",
"editable": "1",
"gridview": "1",
"custom": "0",
"fieldtype": "datetime",
"width": "160",
"acslevel": "0"
},
...
...
"write_protect": {
"label": "Write Protect",
"editable": "1",
"gridview": "1",
"custom": "0",
"fieldtype": "boolean",
"width": "100",
"acslevel": "0"
}
}
}
?c=list&t=domain&oper=colmodel&group=date_columns_array
{
"status": "ok",
"error": "",
"validate": 0,
"colmodel": [
{
"label": "!",
"width": "20",
"name": "d.r_h_disp",
"classes": "dtcell r-h-disp-cell",
"formatter": "highlightFormatter",
"fixed": true,
"hidden": false,
"sortable": true,
"search": false,
"editable": false
},
...
...
{
"label": "TLD",
"width": "40",
"name": "d.tld",
"classes": "dtcell tld-cell",
"editoptions": {
"size": 35
},
"hidden": false,
"sortable": true,
"search": true,
"editable": false
},
...
...
{
"label": "Secondary Whois Server",
"width": "150",
"name": "d.secondary_whois_server",
"classes": "dtcell secondary-whois-server-cell",
"editoptions": {
"size": 35
},
"hidden": false,
"sortable": true,
"search": true,
"editable": true
}
]
}
?c=list&t=domain&oper=history&id=272
{
"status": "ok",
"error": "",
"validate": 0,
"history": [
{
"id": "6236",
"lookedup_at": "2021-05-25 19:49:03.000000",
"ftype": "16",
"fvalue": "0"
},
{
"id": "6235",
"lookedup_at": "2021-05-25 19:46:56.000000",
"ftype": "2",
"fvalue": "876236304"
},
{
"id": "6234",
"lookedup_at": "2021-05-25 19:46:55.000000",
"ftype": "256",
"fvalue": "0"
},
{
"id": "6233",
"lookedup_at": "2021-05-25 19:46:54.000000",
"ftype": "1",
"fvalue": "0"
}
]
}
report
| Parameter | Notes |
|---|---|
| c | list
|
| t | report
|
| oper | columns
|
| details | =1 or =0 (default is 1) |
?c=list&t=report&oper=columns
{
"status": "ok",
"error": "",
"validate": 0,
"columns": {
"s.hostname": {
"label": "Hostname",
"editable": "0",
"gridview": "1",
"custom": "0",
"fieldtype": "datetime",
"width": "178",
"acslevel": "0"
},
"d.days_to_expiry": {
"label": "Days",
"editable": "0",
"gridview": "1",
"custom": "0",
"fieldtype": "integer",
"width": "80",
"acslevel": "0"
},
...
...
"s.ttl": {
"label": "TTL",
"editable": "1",
"gridview": "1",
"custom": "0",
"fieldtype": "integer",
"width": "100",
"acslevel": "0"
}
}
}
subdomain
| Parameter | Notes |
|---|---|
| c | list
|
| t | subdomain
|
| oper | columns
|
| group | Use group=type to have the column insformation sorted
by type of data (string, date, datetime, boolean, integer, etc.)
|
| grid | Use grid=ssl or grid=dns
|
ui
Get UI Data
| Parameter | Notes |
|---|---|
| c | list
|
| t | ui
|
| oper | fonts, themes or all (default)
|
?c=list&t=ui&oper=themes
{
"status": "ok",
"error": "",
"validate": 0,
"themes": [
"Black",
"Flat",
"Gray",
"Rose",
"SkyBlueLight",
"SkyBluePale",
"White"
],
"current": "gray"
}
tasks
Get a list of background tasks that can be triggered.
| Parameter | Notes |
|---|---|
| c | list
|
| t | tasks
|
?c=list&t=tasks
{
"status": "ok",
"error": "",
"validate": 0,
"tasks": [
"set_RDAP_Servers"
]
}