Canary API Docs

# Auto Commissioning

Certain Canary platform types (currently Container Canaries) support Auto Commissioning into a Flock. Auto Commissioning means that when the Canary starts up, it knows which Flock it should be commissioned into, and does not require any manual intervention to have the bird show up in a Flock. This is in contrast to other platforms which still require a manual commission step.

Auto Commission is entirely optional, and configurable on a per-Flock basis.

Endpoints
POST /api/v1/flock/settings/devices/autocommission/enable
POST /api/v1/flock/settings/devices/autocommission/disable
GET /api/v1/flock/settings/devices/autocommission/token
GET /api/v1/flock/settings/devices/autocommission/generate
DELETE /api/v1/flock/settings/devices/autocommission/remove_token

# Enable Flock Auto Commission

POST /api/v1/flock/settings/devices/autocommission/enable

Enable the Auto Commission feature on a given Flock.

Required Parameters

auth_token string
A valid auth token
flock_id string
A valid flock_id

Response

A JSON structure with result indicator.

Example

curl https://EXAMPLE.canary.tools/api/v1/flock/settings/devices/autocommission/enable \
  -d auth_token=EXAMPLE_AUTH_TOKEN \
  -d flock_id=EXAMPLE_FLOCK_ID 

  
        Copied!
1
2
3
Response
{
  "autocommission_token": "<Auto Commission Token>",
  "result": "success"
}

  
        Copied!
1
2
3
4

# Disable Flock Auto Commission

POST /api/v1/flock/settings/devices/autocommission/disable

Disable the Auto Commission feature on a given Flock.

Required Parameters

auth_token string
A valid auth token
flock_id string
A valid flock_id

Response

A JSON structure with result indicator.

Example

curl https://EXAMPLE.canary.tools/api/v1/flock/settings/devices/autocommission/disable \
  -d auth_token=EXAMPLE_AUTH_TOKEN \
  -d flock_id=EXAMPLE_FLOCK_ID 

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

  
        Copied!
1
2
3

# Retrieve Flock Auto Commission Token

GET /api/v1/flock/settings/devices/autocommission/token

Fetch the Auto Commission token for a particular flock.

Required Parameters

auth_token string
A valid auth token
flock_id string
A valid flock_id

Response

A JSON structure with the enabled state.

Example

curl https://EXAMPLE.canary.tools/api/v1/flock/settings/devices/autocommission/token \
  -d auth_token=EXAMPLE_AUTH_TOKEN \
  -d flock_id=EXAMPLE_FLOCK_ID \
  -G

  
        Copied!
1
2
3
4
Response
{
  "autocommission_token": "<Flock Auto Commission Token>",
  "result": "success"
}

  
        Copied!
1
2
3
4

# Generate a Flock Auto Commission Token

GET /api/v1/flock/settings/devices/autocommission/generate

Create a new Auto Commission Token for a Flock (discarding the previous token).

Required Parameters

auth_token string
A valid auth token
flock_id string
A valid flock_id

Response

A JSON structure with the enabled state.

Example

curl https://EXAMPLE.canary.tools/api/v1/flock/settings/devices/autocommission/generate_token \
  -d auth_token=EXAMPLE_AUTH_TOKEN \
  -d flock_id=EXAMPLE_FLOCK_ID 

  
        Copied!
1
2
3
Response
{
  "autocommission_token": "<Flock Auto Commission Token>",
  "result": "success"
}

  
        Copied!
1
2
3
4

# Remove a Flock Auto Commission Token

DELETE /api/v1/flock/settings/devices/autocommission/remove_token

Remove token and disable Auto Commission on a Flock.

Required Parameters

auth_token string
A valid auth token
flock_id string
A valid flock_id

Response

A JSON structure with the enabled state.

Example

curl -X DELETE https://EXAMPLE.canary.tools/api/v1/flock/settings/devices/autocommission/remove_token \
  -d auth_token=EXAMPLE_AUTH_TOKEN \
  -d flock_id=EXAMPLE_FLOCK_ID 

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

  
        Copied!
1
2
3

← Flock API Keys →