diff --git a/apiary.apib b/apiary.apib index 494c147..7b8d439 100644 --- a/apiary.apib +++ b/apiary.apib @@ -71,10 +71,11 @@ This API controls the metrics on your dashboard + description (required, string) - A descriptive text for the current state of the metric + status (required, enum[string]) - One of: OK, Warning, Critical, Unknown + expires: 604800 (optional, number) - Time in seconds when to remove the metric if there is no update (Valid: `0 < x < 604800`) - + freshness: 3600 (optional, number) - Time in seconds when to switch to `Unkown` state of there is no update (Valid: `0 < x < 604800`) + + freshness: 3600 (optional, number) - Time in seconds when to switch to stale state of there is no update (Valid: `0 < x < 604800`) + ignore_mad: false (optional, boolean) - If set to true the status passed in the update will be used instead of the median absolute deviation + hide_mad: false (optional, boolean) - If set to true the median absolute deviation is hidden on the dashboard for this metric + hide_value: false (optional, boolean) - If set to true the current value will not be shown on the dashboard (useful for checks not having values) + + staleness_status: Unknown (optional, string) - If set this status will be set when the metric gets stale (no updates within freshness time range + Response 200 (text/plain)