Get
domain report regalias users whois luq
domain
Use this to get every data associated with a specific domain, the domain columns or the domain data table.
The data corresponding to columns the current user has no access rights to will be suppressed.
| Parameter | Notes |
|---|---|
| c | get
|
| t | domain
|
| oper | unspecified, all, column, colmodel or history
|
| id | The row id (the sid column in the table) the current user has access rights to or the id of the history data row.
You can get the history data row id from the list command output with t set to domain and operoper set to history.
| set to history.
| columns | Comma separated list of columns to get data for. This is applicable only if oper=column
|
| group | Name of the display group to get data for. This is applicable only if oper=colmodel. This 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
|
The output will include the following
| Key | Notes |
|---|---|
| data | The domain table data |
| info | Information on each domain column |
| luq | Current Lookup Queue entries for this domain |
| cids | The ids of the categories the domain belongs to |
| subdomains | The subdomain table entries for the domain |
| colmodel | Details of the table columns that will appear for the specified display group. |
Examples
?c=get&t=domain&id=211
will output
{
"status": "ok",
"error": "",
"validate": 0,
"data": {
"sid": "211",
"domain": "softnik.org",
"ascii_domain": "softnik.org",
"tld": "org",
"api_profile": "",
"added_on": "2019-01-31 21:57:30",
"registry_expiry": "2019-11-29",
...
...
},
"info": {
"sid": {
"label": "sid",
"editable": "0",
"gridview": "0",
"custom": "0",
"fieldtype": "integer",
"width": "100",
"acslevel": "0"
},
"domain": {
"label": "Domain",
"editable": "0",
"gridview": "1",
"custom": "0",
"fieldtype": "string",
"width": "181",
"acslevel": "0"
},
...
...
"registrar_expiry": {
"label": "Registrar Expiry",
"editable": "1",
"gridview": "1",
"custom": "0",
"fieldtype": "date",
"width": "139",
"acslevel": "0"
},
"created_on": {
"label": "Created On",
"editable": "1",
"gridview": "1",
"custom": "0",
"fieldtype": "date",
"width": "103",
"acslevel": "0"
},
...
...
"r_h_disp": {
"label": "!",
"editable": "0",
"gridview": "1",
"custom": "0",
"fieldtype": "integer",
"width": "20",
"acslevel": "0"
},
},
"luq": [],
"cids": [],
"subdomains": [
"www"
]
}
?c=get&t=domain&id=211&oper=column&columns=domain,registry_expiry
{
"status": "ok",
"error": "",
"validate": 0,
"data": [
{
"domain": "softnik.org",
"registry_expiry": "2019-11-29"
}
]
}
?c=get&t=domain&id=211&oper=colmodel&group=date_columns_array
{
"status": "ok",
"error": "",
"validate": 0,
"colmodel": [
{
"label": "!",
"width": "20",
"name": "r_h_disp",
"classes": "dtcell r-h-disp-cell",
"formatter": "highlightFormatter",
"fixed": true,
"hidden": false,
"sortable": true,
"search": false,
"editable": false
},
{
"label": "Domain",
"width": "181",
"name": "domain",
"classes": "dtcell domain-cell",
"editoptions": {
"readonly": true,
"size": 35
},
"hidden": false,
"sortable": true,
"search": true,
"editable": true
},
{
"label": "Domain Expiry",
"width": "123",
"name": "registry_expiry",
"classes": "dtcell registry-expiry-cell",
"formatoptions": {
"srcformat": "Y-m-d",
"newformat": "Y-m-d"
},
"formatter": "date",
"sorttype": "date",
"hidden": false,
"sortable": true,
"search": true,
"editable": true
},
...
{
"label": "Secondary Whois Server",
"width": "215",
"name": "secondary_whois_server",
"classes": "dtcell secondary-whois-server-cell",
"editoptions": {
"size": 35
},
"hidden": false,
"sortable": true,
"search": true,
"editable": true
},
{
"label": "Added On",
"width": "70",
"name": "added_on",
"classes": "dtcell added-on-cell",
"formatoptions": {
"srcformat": "Y-m-d H:i:s",
"newformat": "Y-m-d H:i:s"
},
"formatter": "date",
"sorttype": "date",
"hidden": false,
"sortable": true,
"search": true,
"editable": true
}
]
}
report
Gets the column details for a specified report.
| Parameter | Notes |
|---|---|
| c | get
|
| t | report
|
| oper | colmodel
|
| group | Name of the report (unlike the display groups for the domain table the report names are created by the users). |
?c=get&t=report&group=valid%20ssl%20report&oper=colmodel
{
"status": "ok",
"error": "",
"validate": 0,
"colmodel": [
{
"label": "!!",
"width": "20",
"name": "r_h_disp",
"classes": "dtcell r-h-disp-cell",
"formatter": "highlightFormatter",
"fixed": true,
"hidden": false,
"sortable": true,
"search": false,
"editable": false
},
{
"label": "hostname",
"width": "181",
"name": "s.hostname",
"classes": "dtcell hostname-cell",
"editoptions": {
"size": 20
},
"hidden": false,
"sortable": true,
"search": false,
"editable": false
},
{
"label": "IP",
"width": "144",
"name": "ip",
"classes": "dtcell ip-cell",
"editoptions": {
"size": 35
},
"hidden": false,
"sortable": true,
"search": true,
"editable": true
},
{
"label": "SSL Valid From",
"width": "115",
"name": "s.ssl_valid_from",
"classes": "dtcell ssl-valid-from-cell",
"formatoptions": {
"srcformat": "Y-m-d",
"newformat": "Y-m-d"
},
"formatter": "date",
"sorttype": "date",
"hidden": false,
"sortable": true,
"search": true,
"editable": true
},
{
"label": "SSL Valid Till",
"width": "114",
"name": "s.ssl_valid_to",
"classes": "dtcell ssl-valid-to-cell",
"formatoptions": {
"srcformat": "Y-m-d",
"newformat": "Y-m-d"
},
"formatter": "date",
"sorttype": "date",
"hidden": false,
"sortable": true,
"search": true,
"editable": true
},
{
"label": "SSL Issued To",
"width": "189",
"name": "s.ssl_issued_to",
"classes": "dtcell ssl-issued-to-cell",
"editoptions": {
"size": 35
},
"hidden": false,
"sortable": true,
"search": true,
"editable": false
},
{
"label": "SSL Issued By",
"width": "179",
"name": "s.ssl_issued_by",
"classes": "dtcell ssl-issued-by-cell",
"editoptions": {
"size": 35
},
"hidden": false,
"sortable": true,
"search": true,
"editable": false
},
{
"label": "SSL Checked At",
"width": "166",
"name": "ssl_checked_at",
"classes": "dtcell ssl-checked-at-cell",
"formatoptions": {
"srcformat": "Y-m-d H:i:s",
"newformat": "Y-m-d H:i:s"
},
"formatter": "date",
"sorttype": "date",
"hidden": false,
"sortable": true,
"search": true,
"editable": false
},
{
"label": "SAN",
"width": "206",
"name": "s.subject_alt_name",
"classes": "dtcell subject-alt-name-cell",
"editoptions": {
"size": 20
},
"hidden": false,
"sortable": true,
"search": true,
"editable": false
},
{
"label": "Notes A (SD)",
"width": "100",
"name": "notes_a",
"classes": "dtcell notes-a-cell",
"editoptions": {
"size": 35
},
"hidden": false,
"sortable": true,
"search": true,
"editable": true
}
],
"name": "valid ssl report"
}
regalias
| Parameter | Notes |
|---|---|
| c | get
|
| t | regalias
|
| oper | column or not specified
|
| id | name of the registrar. |
?c=get&t=regalias&oper=column&id=GoDaddy.com%2C%20LLC&columns=alias
{
"status": "ok",
"error": "",
"validate": 0,
"data": [
{
"alias": "GoDaddy"
}
]
}
users
Get information about the current user
| Parameter | Notes |
|---|---|
| c | get
|
| t | users
|
| oper | info
|
{
"status": "ok",
"error": "",
"validate": 0,
"data": {
"rights": "63",
"uid": "1",
"cids": [
{
"cid": 2,
"name": "Keyword Domains"
},
{
"cid": 3,
"name": "Parked Domains"
},
{
"cid": 4,
"name": "Personal Domains"
},
{
"cid": 5,
"name": "Business Domains"
},
{
"cid": 6,
"name": "Bookmarked Domains"
},
{
"cid": 7,
"name": "High Traffic Domains"
},
{
"cid": 8,
"name": "Low Traffic Domains"
},
{
"cid": 9,
"name": "Important Domains"
},
{
"cid": 10,
"name": "Desired Domains"
},
{
"cid": 11,
"name": "GoDaddy Domains"
},
{
"cid": 12,
"name": "ResellerClub Domains"
}
],
"license": {
"License Type": "Extended Demo License",
"Licensee": "-",
"Purchase ID": "-",
"Expiry Date": "15 Feb 2019",
"Purchase Date": "16 Jan 2019"
}
}
}
whois
Gets all the related information for a TLD or whois server.
| Parameter | Notes |
|---|---|
| c | get
|
| t | whois
|
| tld | The top level domain to get the information on (eg. com)
|
| server | The whois server to get the information on (eg. com). This is ignored if the tld is specified.
|
Example
?c=get&t=whois&tld=asia&oper=server
Sample output
{
"status": "ok",
"error": "",
"validate": 0,
"set": false,
"server": "whois.nic.asia",
"query": null,
"port": "43",
"searchtoken": "",
"bannedtext": null,
"cleantoken_1": null,
"cleantoken_2": null,
"proxy": "",
"dateformat": null,
"xlate": "[*]=>*\r\nRegistrant Address:=>address\r\nRegistrant Address2:=>address\r\nRegistrant Address3:=>address\r\nRegistrant City:=>address\r\nRegistrant State\/Province:=>address\r\nRegistrant Country\/Economy:=>address\r\nRegistrant Postal Code:=>address\r\nNameservers:=>name server\r\nRegistrant Country\/Economy:=>owner_country\r\n\r\n",
"maxconnections": null,
"conninterval": null,
"stop_lookups": false,
"last_connected_at": ""
}
?c=get&t=whois&server=whois.crsnic.net&oper=server
{
"status": "ok",
"error": "",
"validate": 0,
"server": "whois.crsnic.net",
"query": "domain",
"port": "43",
"searchtoken": "",
"bannedtext": null,
"cleantoken_1": null,
"cleantoken_2": null,
"proxy": "",
"dateformat": null,
"xlate": null,
"maxconnections": null,
"conninterval": "0",
"last_connected_at": "2019-02-04 15:03:01",
"stop_lookups": "0"
}
luq
Get the lookup queue status.
| Parameter | Notes |
|---|---|
| c | get
|
| t | domain
|
| id | Optional domain row id (the sid column in the table) the current user has access rights to. If the id is provided
the lookup queue data for the domain will be included in the output.
|
The queue sizes are returned with key names like ipw_size, dw_size, etc. The possible key values are
ipw: IP whois dw: primary domain whois (registry level) ip: root DNS sdw: secondary domain whois (registrar level) ssl: SSL ping: ping alexa: alexa dns: extended DNS gi: Google Index http: home page check
Example
?c=get&t=luq&id=173
Sample Output
{
"status": "ok",
"error": "",
"validate": 0,
"luqinfo": [
{
"id": "3227",
"sid": "173",
"subid": null,
"lutype": "1",
"status": "0",
"failcount": "0",
"first_created": "2019-02-04 15:02:32",
"created_on": "2019-02-04 15:02:32",
"last_update": null,
"server": "adria.local"
},
{
"id": "3228",
"sid": "173",
"subid": null,
"lutype": "2",
"status": "0",
"failcount": "0",
"first_created": "2019-02-04 15:02:32",
"created_on": "2019-02-04 15:02:32",
"last_update": null,
"server": "adria.local"
},
{
"id": "3229",
"sid": "173",
"subid": null,
"lutype": "512",
"status": "0",
"failcount": "0",
"first_created": "2019-02-04 15:02:32",
"created_on": "2019-02-04 15:02:32",
"last_update": null,
"server": "adria.local"
}
],
"server_time": "2019-02-04 15:02:36",
"queue_size": "3",
"server_time_zone": "Asia\/Kolkata",
"last_lookup_interval": 556,
"last_seen_at": "2019-02-04 15:02:00",
"last_lookup_at": "2019-02-04 14:53:20",
"ipw_size": "0",
"dw_size": "1",
"ip_size": "1",
"sdw_size": "0",
"ssl_size": "0",
"ping_size": "0",
"alexa_size": "0",
"dns_size": "1",
"gi_size": "0",
"http_size": "0",
"timeout": 600
}