Login
Contents x
Shield SVG
  • Print
  • Dark
    Light
  • PDF
Contents

Shield SVG

  • Print
  • Dark
    Light
  • PDF
Article summary

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
Was this article helpful?
What's Next
Rocket.Chat versions receive support for six months after release.
Change password!
Changing your password will log you out immediately. Use the new password to log back in.
Change profile
Success!
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.
Logout