# 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.
# Enable Flock Auto Commission
POST /api/v1/flock/settings/devices/autocommission/enable
Enable the Auto Commission feature on a given Flock.
Required Parameters
Response
A JSON structure with result indicator.
Example
{
"autocommission_token": "<Auto Commission Token>",
"result": "success"
}
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
Response
A JSON structure with result indicator.
Example
{
"result": "success"
}
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
Response
A JSON structure with the enabled state.
Example
{
"autocommission_token": "<Flock Auto Commission Token>",
"result": "success"
}
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
Response
A JSON structure with the enabled state.
Example
{
"autocommission_token": "<Flock Auto Commission Token>",
"result": "success"
}
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
Response
A JSON structure with the enabled state.
Example
{
"result": "success"
}
2
3