Публичные бейджи показывают живой статус чека или тега — в
README, на статус-странице, в вики. Авторизация не нужна:
доступ по badge_key проекта.
Бейдж на чек и агрегированный бейдж на тег:
https://app.cronalive.com/badge/<badge_key>/<uuid>.<формат> https://app.cronalive.com/badge/<badge_key>/tag/<тег>.<формат>
Формат — svg,
json или
shields. Готовые URL показаны на
странице чека в дашборде.
badge_key — отдельный ключ проекта:
он не совпадает ни с ping-key, ни с API-ключами, поэтому бейдж
не раскрывает адреса пингов и не даёт доступа к API. Если ключ
утёк, его можно перевыпустить в настройках проекта
(Проекты → Ключ статус-бейджей) — старые URL бейджей
перестанут работать сразу.
SVG — готовая картинка (имя чека + статус цветом), для Markdown:
JSON — для своих виджетов:
{"label": "nightly backup", "status": "up"} shields — endpoint-формат shields.io, чтобы рисовать бейдж в стиле shields:
{"schemaVersion": 1, "label": "nightly backup", "message": "up", "color": "3fb950"}
# подключение через shields.io:
https://img.shields.io/endpoint?url=https://app.cronalive.com/badge/<badge_key>/<uuid>.shields | Статус | Цвет |
|---|---|
| up | #3fb950 зелёный |
| late | #d29922 жёлтый |
| down | #f85149 красный |
| paused | #8b949e серый |
| new | #58a6ff синий |
Значения статусов — жизненный цикл чека.
Тег-бейдж агрегирует все чеки проекта с этим тегом и показывает худший статус по приоритету down → late → new → paused → up: один упавший чек — и весь тег красный. Тег без чеков — 404.
Ответы кэшируются на 60 секунд
(Cache-Control: public, max-age=60) —
статус на бейдже почти живой, но не создаёт нагрузку от
частых перерисовок README.