# Canary Limits
Canary limits let you cap how many Birds can be commissioned into a given Flock.
Endpoints
# Enable Flock Canary Limit
POST /api/v1/flock/settings/devices/limit/enable
Enable Canary limits for a Flock. If the limit is already set, the current limit is unchanged.
Required Parameters
auth_token string
A valid global admin auth token
flock_id string
A valid flock_id
Response
A JSON structure with result indicator and the current limit.
Example
Response
{
"limit": 5,
"result": "success"
}
1
2
3
4
2
3
4
# Disable Flock Canary Limit
POST /api/v1/flock/settings/devices/limit/disable
Disable Canary limits for a Flock.
Required Parameters
auth_token string
A valid global admin auth token
flock_id string
A valid flock_id
Response
A JSON structure with result indicator.
Example
Response
{
"result": "success"
}
1
2
3
2
3
# Set Flock Canary Limit
POST /api/v1/flock/settings/devices/limit/set
Set the current Canary limit for a Flock.
Required Parameters
auth_token string
A valid global admin auth token
flock_id string
A valid flock_id
limit integer
A non-negative integer limit to set for the Flock
Response
A JSON structure with result indicator.
Example
Response
{
"result": "success"
}
1
2
3
2
3
# Get Flock Canary Limit
GET /api/v1/flock/settings/devices/limit
Fetch the current Canary limit for a Flock.
Required Parameters
auth_token string
A valid auth token
flock_id string
A valid flock_id
Response
A JSON structure with the current limit ('null' if the limit is disabled).
Example
Response
{
"limit": 5,
"result": "success"
}
1
2
3
4
2
3
4