Domain names

Retrieve all

GET https://health-test.toffeelive.com/api/domain-names/
curl --request GET \
--url 'https://health-test.toffeelive.com/api/domain-names/' \
--header 'Authorization: Bearer {api_key}' \
Parameters Details Description
page Optional Integer The page number that you want results from. Defaults to 1.
results_per_page Optional Integer How many results you want per page. Allowed values are: 10 , 25 , 50 , 100 , 250 , 500 , 1000. Defaults to 25.
{ "data": [ { "id": 1, "project_id": 0, "name": "AltumCode.Com", "target": "altumcode.com", "whois": { "start_datetime": "2019-12-15 18:03:36", "updated_datetime": "2020-05-24 15:37:15", "end_datetime": "2022-12-15 18:03:36", "registrar": "NAMECHEAP INC", "nameservers": [ "ns1.digitalocean.com", "ns2.digitalocean.com", "ns3.digitalocean.com" ] }, "whois_notifications": null, "ssl": { "organization": "Let's Encrypt", "common_name": "R3", "start_datetime": "2021-06-05 14:40:13", "end_datetime": "2021-09-03 14:40:13" }, "ssl_notifications": null, "total_checks": 25, "last_check_datetime": "2021-07-01 14:42:14", "next_check_datetime": "2021-07-04 14:42:15", "is_enabled": true, "last_datetime": null, "datetime": "2021-03-09 11:30:20" } ], "meta": { "page": 1, "results_per_page": 25, "total": 1, "total_pages": 1 }, "links": { "first": "https://health-test.toffeelive.com/api/domain-names?&page=1", "last": "https://health-test.toffeelive.com/api/domain-names?&page=1", "next": null, "prev": null, "self": "https://health-test.toffeelive.com/api/domain-names?&page=1" } }

Retrieve one

GET https://health-test.toffeelive.com/api/domain-names/{domain_name_id}
curl --request GET \
--url 'https://health-test.toffeelive.com/api/domain-names/{domain_name_id}' \
--header 'Authorization: Bearer {api_key}' \
{ "data": { "id": 1, "project_id": 0, "name": "AltumCode.Com", "target": "altumcode.com", "whois": { "start_datetime": "2019-12-15 18:03:36", "updated_datetime": "2020-05-24 15:37:15", "end_datetime": "2022-12-15 18:03:36", "registrar": "NAMECHEAP INC", "nameservers": [ "ns1.digitalocean.com", "ns2.digitalocean.com", "ns3.digitalocean.com" ] }, "whois_notifications": null, "ssl": { "organization": "Let's Encrypt", "common_name": "R3", "start_datetime": "2021-06-05 14:40:13", "end_datetime": "2021-09-03 14:40:13" }, "ssl_notifications": null, "total_checks": 25, "last_check_datetime": "2021-07-01 14:42:14", "next_check_datetime": "2021-07-04 14:42:15", "is_enabled": true, "last_datetime": null, "datetime": "2021-03-09 11:30:20" } }

Create

POST https://health-test.toffeelive.com/api/domain-names
Parameters Details Description
name Required String -
target Required String -
project_id Optional Integer -
whois_notifications Optional Array Notification handler ids
whois_notifications_timing Optional Integer Allowed values: 1, 2, 3, 7, 14, 30, 60 (days)
ssl_notifications Optional Array Notification handler ids
ssl_notifications_timing Optional Integer Allowed values: 1, 2, 3, 7, 14, 30, 60 (days)
is_enabled Optional Boolean -
curl --request POST \
--url 'https://health-test.toffeelive.com/api/domain-names' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example' \
--form 'target=example.com' \
{ "data": { "id": 1 } }

Update

POST https://health-test.toffeelive.com/api/domain-names/{domain_name_id}
Parameters Details Description
name Optional String -
target Optional String -
project_id Optional Integer -
whois_notifications Optional Array Notification handler ids
whois_notifications_timing Optional Integer Allowed values: 1, 2, 3, 7, 14, 30, 60 (days)
ssl_notifications Optional Array Notification handler ids
ssl_notifications_timing Optional Integer Allowed values: 1, 2, 3, 7, 14, 30, 60 (days)
is_enabled Optional Boolean -
curl --request POST \
--url 'https://health-test.toffeelive.com/api/domain-names/{domain_name_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example' \
{ "data": { "id": 1 } }

Delete

DELETE https://health-test.toffeelive.com/api/domain-names/{domain_name_id}
curl --request DELETE \
--url 'https://health-test.toffeelive.com/api/domain-names/{domain_name_id}' \
--header 'Authorization: Bearer {api_key}' \