Canary API Docs

# Operations

These are a collection of endpoints that allow you to manage your Bird remotely.

Endpoints
POST /api/v1/device/reboot
POST /api/v1/device/update

# Reboot Bird

POST /api/v1/device/reboot

Schedule a Bird reboot.

Required Parameters

auth_token string
A valid auth token
node_id string
A valid Canary node_id

Response

JSON structure with the result indicator.

Example

curl https://EXAMPLE.canary.tools/api/v1/device/reboot \
  -d auth_token=EXAMPLE_AUTH_TOKEN \
  -d node_id=EXAMPLE_NODE_ID


  
        Copied!
1
2
3
4
Response
{
  "result": "success"
}

  
        Copied!
1
2
3

# Update Bird

TIP

By default, your Birds will automatically update. This endpoint is only useful if you have disabled automatic updates.

POST /api/v1/device/update

Schedule a Bird update.

Required Parameters

auth_token string
A valid auth token
node_id string
A valid Canary node_id
update_tag string
A tag of an update to push to Bird

Optional Parameters

req_len int
Query length for the DNS update (defaults to the Console-specified setting)
use_console_url boolean
If True, instructs the Bird to update over HTTP from the Console
url string
A url to download the update from (using HTTP)

WARNING

Specifying url or use_console_url will allow the Bird to update over HTTP. The update will complete a lot quicker, but there is a chance that the connection will be blocked by your firewall.

Response

JSON structure with the result indicator and `bundle_tag` if successful.

Example

curl https://EXAMPLE.canary.tools/api/v1/device/update \
  -d auth_token=EXAMPLE_AUTH_TOKEN \
  -d node_id=EXAMPLE_NODE_ID \
  -d update_tag=EXAMPLE_UPDATE_TAG

  
        Copied!
1
2
3
4
Response
{
  "result": "success"
}

  
        Copied!
1
2
3

← Outside Birds →