Notes on the API
This API allows you to interact with one of the canaries you own, as well as subscribe/unsubscribe to another canaries email list. This API is very simple, and accepts both get and post requests. All of the requests will be made to the base url: https://warrantcanaries.com/api and will require your api token which can be found on this page once you log in. Below you will find all of the methods available and examples of how to use each method. It should be relatively straight forward to get it working.
How to create a canary
URL
https://warrantcanaries.com/api/canary/create

Parameters
api_token:
name: (string)
description: (string)
status: (enum: alive, expired)
refresh_type: (enum: manual, one_week, two_weeks, one_month, two_months, four_months, six_months, one_year, two_years, three_years, five_years)
website: (string, no spaces)

Example
https://warrantcanaries.com/api/canary/create?api_token=xxx&status=alive&name=canary_name&description=this_is_the_description&refresh_type=one_week&website=https://yourbusinesseswebsite.com
How to update a canary
URL
https://warrantcanaries.com/api/canary/update/{id}

Path Variable
id: (integer - required - found on the dashboard )

Parameters
api_token:
name: (string - optional)
description: (string - required, url encoded text)
status: (enum - required: [alive, expired] )
refresh_type: (enum - required: [manual, one_week, two_weeks, one_month, two_months, four_months, six_months, one_year, two_years, three_years, five_years])
website: (string - optional)

Example
https://warrantcanaries.com/api/canary/update/43?api_token=xxx&status=alive&name=canary_name&description=this_is_the_description&refresh_type=one_week&website=https://yourbusinesseswebsite.com


this returns the canary object so you can grab the id and other attributes.
How to delete a canary
URL
https://warrantcanaries.com/api/canary/delete/{id}

Path Variable
id: (integer - required - found on the dashboard )

Parameters
api_token:
Example
https://warrantcanaries.com/api/canary/delete/64?api_token=xxx

NOTE: a published canary cannot be deleted, only expired.
How to refresh a canary
URL
https://warrantcanaries.com/api/canary/refresh/{id}

Path Variable
id: (integer - required - found on the dashboard )

Parameters
api_token:

Example
https://warrantcanaries.com/api/canary/refresh/64?api_token=xxx

How to expire a canary
URL
https://warrantcanaries.com/api/canary/expire/{id}

Path Variable
id: (integer - required - found on the dashboard )

Parameters
api_token:
Example
https://warrantcanaries.com/api/canary/expire/64?api_token=xxx

How to subscribe to a canary to be alerted by email
URL
https://warrantcanaries.com/api/canary/subscribe/{id}

Path Variable
id: (integer - required - found on the dashboard )

Parameters
api_token:
Example
https://warrantcanaries.com/api/canary/subscribe/64?api_token=xxx

How to unsubscribe to a canary to be alerted by email
URL
https://warrantcanaries.com/api/canary/unsubscribe/{id}

Path Variable
id: (integer - required - found on the dashboard )

Parameters
api_token:
Example
https://warrantcanaries.com/api/canary/unsubscribe/64?api_token=xxx