Authenticate connection

WebSocket message — Usually not needed.

Authentication happens automatically via the X-API-Key header on connect. This message is only needed if you want to re-authenticate on an existing connection.

{"type":"auth","api_key":"your-api-key-here"}
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum
required

Must be "auth"

Allowed:
string
required

Your API key. Usually not needed — authentication happens via the X-API-Key header on connect.

Response

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json