Grid

The grid commands allow you to access, delete or edit the domain, category, query, dns and SSL data. These are typically used by the main domain / DNS / SSL / Category / Auto Query tables.

The typical structure of an API call with grid comand is

?c=grid&t=domain&oper=del&id=23,24,27

Get Grid

The API will fetch the data table (get grid) if the oper parameter is not specified or set to get.

Parameter Notes
c grid
t one of domain, dns, ssl, category or query
oper get or not specified
columns Comma separated list of columns to fetch. For the domain grid you can use the prefixes d. and s. in the column names to indicate the table the data should come from. For example,
&columns=domain,s.ip,d.notes_a
page Page number (starting from 1)
rows number of rows per page
sidx Sort column name. You can use s. or d. prefixes to indicate the domain or the sub-domain table.
sord Sort Order (asc or desc)
cid Category ID, valid only if t=domain
aqid Auto Query ID, valid only if t=domain
query Additional optional query to get the grid
params Optional comma or linefeed separated data required for the additional query
_repname Name of the report to fetch (valid only if t=domain)
highlight Number of days to highlight domain expiry (valid only if t=domain)

Here are some examples

?c=grid&t=domain&columns=domain,registry_expiry,registrar_expiry,ip,ns1&page=2&rows=200&sidx=domain&sord=desc&cid=5
?c=grid&t=domain&columns=sid,r_h_disp,s.hostname,ip,s.ssl_valid_from,s.ssl_valid_to,s.ssl_issued_to,s.ssl_issued_by,ssl_checked_at,s.subject_alt_name,notes_a,&highlight=30&_repname=Valid%20SSL%20Report
?c=grid&t=domain&columns=domain,registry_expiry,registrar_expiry,ip,ns1
?c=grid&t=category&columns=name&page=1&rows=50

Here is the sample out for the last example, above.

{
    "page": 1,
    "total": 1,
    "records": "12",
    "start": 0,
    "limit": 50,
    "rows": [
        {
            "id": "1",
            "name": "All Domains"
        },
        {
            "id": "6",
            "name": "Bookmarked Domains"
        },
        {
            "id": "5",
            "name": "Business Domains"
        },
        {
            "id": "10",
            "name": "Desired Domains"
        },
        {
            "id": "11",
            "name": "GoDaddy Domains"
        },
        {
            "id": "7",
            "name": "High Traffic Domains"
        },
        {
            "id": "9",
            "name": "Important Domains"
        },
        {
            "id": "2",
            "name": "Keyword Domains"
        },
        {
            "id": "8",
            "name": "Low Traffic Domains"
        },
        {
            "id": "3",
            "name": "Parked Domains"
        },
        {
            "id": "4",
            "name": "Personal Domains"
        },
        {
            "id": "12",
            "name": "ResellerClub Domains"
        }
    ]
}

Delete Rows

Use oper=del to delete rows from the table. Deleting rows from the category or auto-query tables require administrator privileges.

Parameter Notes
t one of domain, subdomain, dns, ssl, category or query.
The dns and ssl options will delete rows from the sub-domain table that correspond to DNS record and SSL record entries.
id Comma separated list of column ids to delete.
?c=grid&t=domain&oper=del&id=23,24,27

Edit a Single Row

Use oper=edit along with id=n to edit a row whose id is n. Editing the category or auto-query tables require administrator privileges.

Parameter Notes
t one of domain, subdomain, dns, ssl, category or query.
id The id of the row to edit.
[column 01] new value for the [column 01].
[column 02] new value for the [column 02].
[column N] new value for the [column N].
?c=grid&t=domain&oper=edit&id=23&ns1=ns1.softnik.net

Add Rows

Add new rows to Category, Auto Query or Sub-domain tables. Adding rows to the category or auto-query tables require administrator privileges.