The DNS Check API is used to request data for either a specific DNS record or all records in a DNS record group.
URL
https://www.dnscheck.co/api/v1/groups/:group_uuid/:record_id?api_key=KEY
Parameters
All of the parameters described below are required.
| Parameter | Description | Example Value |
|---|---|---|
| api_key | The secret key that's used to authenticate the connecting application. See the Generating an API Key page for details. | abcdefghbcdefghbcdefghbcdefgh |
| group_uuid | The UUID of the DNS record group. When viewing a DNS record or record group, this is the 36-character string that follows "/tests/" in the URL. This DNS record group's UUID is the example value in the next column. Specify a group_uuid of "all" to show information for all of your account's DNS record groups. | ea883d67-d9f6-45e3-b3a1-844dd1857824 |
| record_id | The ID of the DNS record. When viewing the URL of a DNS record's details or history page, this is the integer that follows the UUID in the URL. For example, this DNS record has a record_id of "4". Specify a record_id of "all" to show information for all DNS records in a DNS record group. | 1 |
Example Request
The following API call returns data for the www.dnscheck.co A record in this example DNS Record Group:
GET https://www.dnscheck.co/api/v1/groups/ea883d67-d9f6-45e3-b3a1-844dd1857824/5529?api_key=KEY
The above DNS record group is unique in that accessing it does not require a valid API key. This is done so that it can serve as a live example for API documentation.
Example Response
{
"dns_record": {
"id": 5529,
"name": "www.dnscheck.co.",
"record_type": "A",
"value": "104.131.72.189",
"exclusive": true,
"created_at": "2015-07-02T11:04:54-04:00",
"updated_at": "2015-11-08T12:37:16-05:00",
"status": "pass",
"fail_count": 0,
"url": "https://www.dnscheck.co/tests/ea883d67-d9f6-45e3-b3a1-844dd1857824/5529"
}
}
Response Definitions
| Parameter | Description | Type |
|---|---|---|
| id | A unique identifier for the DNS record | Integer |
| name | The fully qualified domain name of the DNS record. For example, "example.com." | String |
| record_type | The type of DNS record. Valid values are "A", "AAAA", "ALIAS", "CNAME", "MX", "NS", "PTR", "SOA", "SRV", "SPF" and "TXT" | String |
| value | The expected value of the DNS record. For example, "104.131.72.189" | String |
| exclusive | Indicates whether this DNS record must be the only record of this name / record_type combination | Boolean (true or false) |
| created_at | The time and date that this DNS record group was created | An ISO 8601 value |
| updated_at | The time and date that this DNS record group was last updated | An ISO 8601 value |
| status | The pass/fail status of the DNS record. Valid values are "pass", "fail", and "unknown" | String |
| fail_count | If the DNS record is failing, this field indicates how many consecutive checks have failed | Integer |
| url | The URL of the DNS record's details page | String |