Shield SVG

Get
/api/v1/shield.svg

A simple method, requires no authentication, that returns the shield svg(badge) to add in your website. It must have API_Enable_Shields enabled.

Changelog

Version Description
0.55.0 Added
Query parameters
type
string

Can either be online, user, channel

Exampleonline
icon
string
ExampleFalse
channel
stringRequired

Name of the channel

Examplegeneral
name
stringRequired

Name to show

ExampleRocket.Chat
Responses
200

OK

Headers
Content-Type
string
image/svg+xml;charset=utf-8
Exampleimage/svg+xml;charset=utf-8
Example
"               Rocket Rocket JOIN CHAT JOIN CHAT  "
object