Skip to main content

Website

The existence of a specific path on the server can be checked by appending a path after the domain name, e.g. https://img.shields.io/website?url=http%3A//www.website.com/path/to/page.html.

The messages and colors for the up and down states can also be customized.

A site will be classified as "down" if it fails to respond within 3.5 seconds.

Query Parameters
url string — REQUIRED

Example: https://shields.io

up_message string

Example: online

up_color string

Example: blue

down_message string

Example: offline

down_color string

Example: lightgrey

style string

Possible values: [flat, flat-square, plastic, for-the-badge, social]

If not specified, the default style for this badge is "flat".

Example: flat

logo string

Icon slug from simple-icons. You can click the icon title on simple-icons to copy the slug or they can be found in the slugs.md file in the simple-icons repository. Further info.

Example: appveyor

logoColor string

The color of the logo (hex, rgb, rgba, hsl, hsla and css named colors supported). Supported for simple-icons logos but not for custom logos.

Example: violet

logoSize string

Make icons adaptively resize by setting auto. Useful for some wider logos like amd and amg. Supported for simple-icons logos but not for custom logos.

Example: auto

label string

Override the default left-hand-side text (URL-Encoding needed for spaces or special characters!)

Example: healthiness

labelColor string

Background color of the left part (hex, rgb, rgba, hsl, hsla and css named colors supported).

Example: abcdef

color string

Background color of the right part (hex, rgb, rgba, hsl, hsla and css named colors supported).

Example: fedcba

cacheSeconds string

HTTP cache lifetime (rules are applied to infer a default value on a per-badge basis, any values specified below the default will be ignored).

Example: 3600

link string[]

Specify what clicking on the left/right of a badge should do. Note that this only works when integrating your badge in an <object> HTML tag, but not an <img> tag or a markup language.