cURL
Badges
Get badge for a group
Get group status badge. You can enable the badges feature in account settings
GET
cURL
Authorizations
The Checkly Public API uses API keys to authenticate requests. You can get the API Key here. Your API key is like a password: keep it secure!
Authentication to the API is performed using the Bearer auth method in the Authorization header and using the account ID.
For example, set Authorization header while using cURL: curl -H "Authorization: Bearer [apiKey]" "X-Checkly-Account: [accountId]"
Path Parameters
Required range:
x > 0Query Parameters
Available options:
flat, plastic, flat-square, for-the-badge, social Available options:
light, dark, default Response
Successful
An SVG image containing the current Checkly check or group status.
Pattern:
(<svg)([^<]*|[^>]*)