GET
/
v1
/
badges
/
checks
/
{checkId}
cURL
curl --request GET \
  --url https://api.checklyhq.com/v1/badges/checks/{checkId} \
  --header 'Authorization: <api-key>'
"<string>"

​
Overview

The Get Check Status Badge endpoint generates status badges (SVG images) that display the current health status of a specific check. Use these badges in documentation, dashboards, and status displays. Common Use Cases:
  • Documentation Status Display
  • README Badge Integration
  • Dashboard Widgets
  • Public Status Communication
Response Format: SVG image
Status badges update automatically based on check results. Embed badge URLs directly in markdown, HTML, or documentation platforms for live status updates.

Authorizations

​
Authorization
string
header
required

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

​
checkId
string
required

Query Parameters

​
style
enum<string>
default:flat
Available options:
flat,
plastic,
flat-square,
for-the-badge,
social
​
theme
enum<string>
default:default
Available options:
light,
dark,
default
​
responseTime
boolean
default:false

Response

200 - application/json

Successful

The response is of type string.