Embeddable Build Status Icon

Jenkins exposes the current status of your build as an image in a fixed URL. You can put this URL into other sites (such as GitHub README) so that people can see the current state of the build.
For each variant there are two URLs available for inclusion:

• protected exposes the badge to users having at least Read permission on the job
• unprotected exposes the badge to users having at least ViewStatus permission on the job

If you want the status icons to be public readable/accessible, just grant the ViewStatus permission globally to anonymous.

Note

If you are using Multibranch Pipelines the branch within the job path or name needs to be URL encoded twice.

Example:
?job=path/to/job/branch/path
would become
?job=path%2Fto%2Fjob%2Fbranch%252Fpath

See examples below!

Configuration

Please read the documentation to configure and customize your badge.

Examples

(Hover badge to see custom configuration)

flat

flat-square

plastic

ball-size

Links

Plain link

Protected
https://dev.me1312.net/jenkins/job/SubServers%20Platform/123/badge/icon

Unprotected
https://dev.me1312.net/jenkins/buildStatus/icon?job=SubServers+Platform&build=123

Markdown

Protected
[](https://dev.me1312.net/jenkins/job/SubServers%20Platform/123/)

Unprotected
[](https://dev.me1312.net/jenkins/job/SubServers%20Platform/123/)

HTML

Protected
<a href='https://dev.me1312.net/jenkins/job/SubServers%20Platform/123/'><img src='https://dev.me1312.net/jenkins/job/SubServers%20Platform/123/badge/icon'></a>

Unprotected
<a href='https://dev.me1312.net/jenkins/job/SubServers%20Platform/123/'><img src='https://dev.me1312.net/jenkins/buildStatus/icon?job=SubServers+Platform&build=123'></a>

Asciidoc

Protected
image:https://dev.me1312.net/jenkins/job/SubServers%20Platform/123/badge/icon[link='https://dev.me1312.net/jenkins/job/SubServers%20Platform/123/']

Unprotected
image:https://dev.me1312.net/jenkins/buildStatus/icon?job=SubServers+Platform&build=123)[link='https://dev.me1312.net/jenkins/job/SubServers%20Platform/123/']

Confluence

Protected
[!https://dev.me1312.net/jenkins/job/SubServers%20Platform/123/badge/icon!|https://dev.me1312.net/jenkins/job/SubServers%20Platform/123/]

Unprotected
[!https://dev.me1312.net/jenkins/buildStatus/icon?job=SubServers+Platform&build=123!|https://dev.me1312.net/jenkins/job/SubServers%20Platform/123/]

XWiki

Protected
[[image:https://dev.me1312.net/jenkins/job/SubServers%20Platform/123/badge/icon>>https://dev.me1312.net/jenkins/job/SubServers%20Platform/123/||target='__new']]

Unprotected
[[image:https://dev.me1312.net/jenkins/buildStatus/icon?job=SubServers+Platform&build=123>>https://dev.me1312.net/jenkins/job/SubServers%20Platform/123/||target='__new']]

RDoc

Protected
{<img src='https://dev.me1312.net/jenkins/job/SubServers%20Platform/123/badge/icon'/>}[https://dev.me1312.net/jenkins/job/SubServers%20Platform/123/]

Unprotected
{<img src='https://dev.me1312.net/jenkins/buildStatus/icon?job=SubServers+Platform&build=123'/>}[https://dev.me1312.net/jenkins/job/SubServers%20Platform/123/]

Textile

Protected
"!https://dev.me1312.net/jenkins/job/SubServers%20Platform/123/badge/icon!":https://dev.me1312.net/jenkins/job/SubServers%20Platform/123/

Unprotected
"!https://dev.me1312.net/jenkins/buildStatus/icon?job=SubServers+Platform&build=123!":https://dev.me1312.net/jenkins/job/SubServers%20Platform/123/

Bitbucket

Protected
[Build Status](https://dev.me1312.net/jenkins/job/SubServers%20Platform/123/badge/icon "https://dev.me1312.net/jenkins/job/SubServers%20Platform/123/")

Unprotected
[Build Status](https://dev.me1312.net/jenkins/buildStatus/icon?job=SubServers+Platform&build=123 "https://dev.me1312.net/jenkins/job/SubServers%20Platform/123/")

Embeddable Build Status Text

Jenkins also exposes the current status of your build in plain text. You can use this in external scripts for easier interpretation of the current state of the build. Similar to the badge there are both protected, as well as unprotected variants.

Text Only

Protected
https://dev.me1312.net/jenkins/job/SubServers%20Platform/123/badge/text

Unprotected
https://dev.me1312.net/jenkins/buildStatus/text?job=SubServers+Platform&build=123