Get badge for a check

Get check status badge. You can enable the badges feature in account settings

GET /v1/badges/checks/{checkId}

cURL

cURL

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

200

"<string>"

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.

Pattern: (<svg)([^<]*|[^>]*)