jal-co/shieldcn359

HTTPS Endpoint

Create a badge from any HTTPS endpoint that returns JSON.

GET/https/:url.svg

Path Parameters

required

Any HTTPS URL that returns JSON with label/value/color fields.

![badge](https://shieldcn.dev/https/cal-badge-icd0onfvrxx6.runkit.sh.png)
badge preview

How it works

Create an HTTPS endpoint on any platform (RunKit, Vercel, Cloudflare Workers, etc.) that returns JSON:

{
  "label": "hello",
  "value": "world",
  "color": "blue"
}

The badgen format is also supported:

{
  "subject": "hello",
  "status": "world",
  "color": "blue"
}

Then use it as a badge:

![badge](https://shieldcn.dev/https/your-endpoint.example.com/path/args)

Path arguments

Any path segments after the hostname are forwarded to the endpoint:

Badge URLFetches
/https/example.comhttps://example.com
/https/example.com/foo/barhttps://example.com/foo/bar

Response format

The endpoint must return JSON with these fields (all optional except value/status):

Endpoint response

PropType

Examples

endpoint
Default variant
endpoint
Secondary variant
endpoint
Outline variant
endpoint
Branded variant

Copy-paste examples

Default — pull badge data from any HTTPS endpoint

![https endpoint](https://shieldcn.dev/https/cal-badge-icd0onfvrxx6.runkit.sh.svg)

Secondary — softer look for README rows

![https endpoint](https://shieldcn.dev/https/cal-badge-icd0onfvrxx6.runkit.sh.svg?variant=secondary)

Caching

Endpoint responses are cached for 5 minutes.

Credits

This endpoint format is inspired by badgen.net's HTTPS endpoint feature.