Skip to main content

HTTP API reference › Gala Launchpad › websocket-admin

Gala Launchpad — websocket-admin

2 operations in this group.

GET /v1/connected-clients​

WebSocketAdminController_getConnectedClients

List connected WebSocket clients

Get list of currently connected users (admin/overseer only)

Authentication: apiKeyAuth, bearer

Parameters​

NameInRequiredTypeDescription
minConnectionSecondsqueryoptionalnumber
isOverseerqueryoptionalboolean
authenticatedqueryoptionalboolean
userAddressesqueryoptionalstring
userAddressqueryoptionalstring
tokenNamequeryoptionalstring
limitqueryoptionalnumber
offsetqueryoptionalnumber
roomqueryoptionalstring

Responses​

200 — Connected clients, room statistics, and offset pagination in the success envelope.​

Content type: application/json

Schema: ApiSuccessEnvelopeMetadataDto & object

FieldTypeRequiredDescription
errorboolean enum: falseyesSuccessful response marker.
messagestringyesResponse message.
statusnumberyesHTTP status code.
dataConnectedClientsResponseDtoyes

400 — Invalid query parameters​

Content type: application/json

Schema: ApiErrorEnvelope

FieldTypeRequiredDescription
errorboolean enum: trueyes
messageoneOf: string | array<string>yes
statusintegeryesHTTP status code.
messagestringyes
statusCodeintegeryesHTTP status code.

401 — Unauthorized - missing or invalid JWT/API key​

Content type: application/json

Schema: ApiErrorEnvelope

FieldTypeRequiredDescription
errorboolean enum: trueyes
messageoneOf: string | array<string>yes
statusintegeryesHTTP status code.
messagestringyes
statusCodeintegeryesHTTP status code.

403 — Forbidden - user is not admin or overseer​

Content type: application/json

Schema: ApiErrorEnvelope

FieldTypeRequiredDescription
errorboolean enum: trueyes
messageoneOf: string | array<string>yes
statusintegeryesHTTP status code.
messagestringyes
statusCodeintegeryesHTTP status code.

500 — Internal server error - failed to list clients​

Content type: application/json

Schema: ApiErrorEnvelope

FieldTypeRequiredDescription
errorboolean enum: trueyes
messageoneOf: string | array<string>yes
statusintegeryesHTTP status code.
messagestringyes
statusCodeintegeryesHTTP status code.

default — Shared error envelope for connected-client lookup failures.​

Content type: application/json

Schema: ApiErrorEnvelope

FieldTypeRequiredDescription
errorboolean enum: trueyes
messageoneOf: string | array<string>yes
statusintegeryesHTTP status code.
messagestringyes
statusCodeintegeryesHTTP status code.

Example response​

[]

POST /v1/websocket​

WebSocketAdminController_emitEvent

Emit WebSocket event to connected clients

Send a real-time event to WebSocket subscribers (admin/overseer only)

Authentication: apiKeyAuth, bearer

Request body​

Required: yes

application/json​

Schema: object

FieldTypeRequiredDescription
actionstring enum: trade_executed, balance_updated, trade_update_notify, stream_status, viewer_count, stream_countdown, recording_status, recordings_count_updated, download_ready, simulcast_status, stream_language_updated, chat_message, chat_status, typing_indicator, stream_chat_sent, stream_chat_updated, stream_chat_deleted, stream_chat_pinned, stream_chat_unpinned, stream_control_status_changed, send_stream_reaction, stream_reaction, content_reaction_added, content_reaction_removed, comment_created, comment_updated, comment_deleted, token_banned, token_unbanned, moderator_added, moderator_removed, moderator_invite_created, moderator_role_updated, overseer_added, overseer_removed, user_banned, user_unbanned, ban_enforcement, user_profile_updated, api_key_created, api_key_updated, api_key_revoked, holder_count_updated, pool_badge_assigned, pool_created, pool_metadata_updated, pool_social_links_updated, token_config_updated, ai_moderation_complete, ai_moderation_failed, content_flagged, flag_resolved, site_config_changed, feature_status, chat_global_status, streaming_global_status, comments_global_status, webhooks_global_status, ai_moderation_global_status, stats_updated, eventyes
broadcastbooleanno
payloadobjectyes
tokenNamestringno
userAddressstringno

Responses​

200 — Event was emitted; the success envelope contains an empty data object.​

Content type: application/json

Schema: ApiSuccessEnvelopeMetadataDto & object

FieldTypeRequiredDescription
errorboolean enum: falseyesSuccessful response marker.
messagestringyesResponse message.
statusnumberyesHTTP status code.
dataobject enum: [object Object]yes

400 — Invalid event DTO or validation error​

Content type: application/json

Schema: ApiErrorEnvelope

FieldTypeRequiredDescription
errorboolean enum: trueyes
messageoneOf: string | array<string>yes
statusintegeryesHTTP status code.
messagestringyes
statusCodeintegeryesHTTP status code.

401 — Unauthorized - missing or invalid JWT/API key​

Content type: application/json

Schema: ApiErrorEnvelope

FieldTypeRequiredDescription
errorboolean enum: trueyes
messageoneOf: string | array<string>yes
statusintegeryesHTTP status code.
messagestringyes
statusCodeintegeryesHTTP status code.

403 — Forbidden - user is not admin or overseer​

Content type: application/json

Schema: ApiErrorEnvelope

FieldTypeRequiredDescription
errorboolean enum: trueyes
messageoneOf: string | array<string>yes
statusintegeryesHTTP status code.
messagestringyes
statusCodeintegeryesHTTP status code.

500 — Internal server error - failed to emit event​

Content type: application/json

Schema: ApiErrorEnvelope

FieldTypeRequiredDescription
errorboolean enum: trueyes
messageoneOf: string | array<string>yes
statusintegeryesHTTP status code.
messagestringyes
statusCodeintegeryesHTTP status code.

default — Shared error envelope for event emission failures.​

Content type: application/json

Schema: ApiErrorEnvelope

FieldTypeRequiredDescription
errorboolean enum: trueyes
messageoneOf: string | array<string>yes
statusintegeryesHTTP status code.
messagestringyes
statusCodeintegeryesHTTP status code.

Example request​

[]

Example response​

[]

Previous group: Connect Proxy · Next group: content-flags