{ "openapi": "3.1.0", "info": { "title": "Spacebar Server", "description": "Spacebar is a free open source selfhostable discord compatible chat, voice and video platform", "license": { "name": "AGPLV3", "url": "https://www.gnu.org/licenses/agpl-3.0.en.html" }, "version": "1.0.0" }, "externalDocs": { "description": "Spacebar Docs", "url": "https://docs.spacebar.chat" }, "servers": [ { "url": "https://old.server.spacebar.chat/api/", "description": "Official Spacebar Instance" } ], "components": { "securitySchemes": { "bearer": { "type": "http", "scheme": "bearer", "description": "Bearer/Bot prefixes are not required.", "bearerFormat": "JWT", "in": "header" } }, "schemas": { "AckBulkSchema": { "type": "object", "properties": { "read_states": { "type": "array", "items": { "type": "object", "properties": { "channel_id": { "type": "string" }, "message_id": { "type": "string" }, "read_state_type": { "type": "integer" } }, "additionalProperties": false, "required": [ "channel_id", "message_id", "read_state_type" ] } } }, "required": [ "read_states" ] }, "ApplicationAuthorizeSchema": { "type": "object", "properties": { "authorize": { "type": "boolean" }, "guild_id": { "type": "string" }, "permissions": { "type": "string" }, "captcha_key": { "type": "string" }, "code": { "type": "string" } }, "required": [ "authorize", "guild_id", "permissions" ] }, "ApplicationCreateSchema": { "type": "object", "properties": { "name": { "type": "string" }, "team_id": { "type": [ "string", "integer" ] } }, "required": [ "name" ] }, "ApplicationModifySchema": { "type": "object", "properties": { "description": { "type": "string" }, "icon": { "type": "string" }, "interactions_endpoint_url": { "type": "string" }, "max_participants": { "type": "integer", "nullable": true }, "name": { "type": "string" }, "privacy_policy_url": { "type": "string" }, "role_connections_verification_url": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "terms_of_service_url": { "type": "string" }, "bot_public": { "type": "boolean" }, "bot_require_code_grant": { "type": "boolean" }, "flags": { "type": "integer" } } }, "BackupCodesChallengeSchema": { "type": "object", "properties": { "password": { "type": "string" } }, "required": [ "password" ] }, "BanCreateSchema": { "type": "object", "properties": { "delete_message_seconds": { "type": "string" }, "delete_message_days": { "type": "string" }, "reason": { "type": "string" } } }, "BanModeratorSchema": { "type": "object", "properties": { "id": { "type": "string" }, "user_id": { "type": "string" }, "guild_id": { "type": "string" }, "executor_id": { "type": "string" }, "reason": { "type": "string" } }, "required": [ "executor_id", "guild_id", "id", "user_id" ] }, "BanRegistrySchema": { "type": "object", "properties": { "id": { "type": "string" }, "user_id": { "type": "string" }, "guild_id": { "type": "string" }, "executor_id": { "type": "string" }, "ip": { "type": "string" }, "reason": { "type": "string" } }, "required": [ "executor_id", "guild_id", "id", "user_id" ] }, "BotModifySchema": { "type": "object", "properties": { "avatar": { "type": "string" }, "username": { "type": "string" } } }, "ChannelPermissionOverwriteType": { "enum": [ 0, 1, 2 ], "type": "number" }, "ConnectedAccountTokenData": { "type": "object", "properties": { "access_token": { "type": "string" }, "token_type": { "type": "string" }, "scope": { "type": "string" }, "refresh_token": { "type": "string" }, "expires_in": { "type": "integer" }, "expires_at": { "type": "integer" }, "fetched_at": { "type": "integer" } }, "required": [ "access_token", "fetched_at" ] }, "ChannelModifySchema": { "type": "object", "properties": { "name": { "maxLength": 100, "type": "string" }, "type": { "enum": [ 0, 1, 10, 11, 12, 13, 14, 15, 2, 255, 3, 33, 34, 35, 4, 5, 6, 64, 7, 8, 9 ], "type": "number" }, "topic": { "type": "string" }, "icon": { "type": "string", "nullable": true }, "bitrate": { "type": "integer" }, "user_limit": { "type": "integer" }, "rate_limit_per_user": { "type": "integer" }, "position": { "type": "integer" }, "permission_overwrites": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "$ref": "#/components/schemas/ChannelPermissionOverwriteType" }, "allow": { "type": "string" }, "deny": { "type": "string" } }, "additionalProperties": false, "required": [ "allow", "deny", "id", "type" ] } }, "parent_id": { "type": "string" }, "id": { "type": "string" }, "nsfw": { "type": "boolean" }, "rtc_region": { "type": "string" }, "default_auto_archive_duration": { "type": "integer" }, "default_reaction_emoji": { "type": "string", "nullable": true }, "flags": { "type": "integer" }, "default_thread_rate_limit_per_user": { "type": "integer" }, "video_quality_mode": { "type": "integer" } } }, "ActivitySchema": { "type": "object", "properties": { "afk": { "type": "boolean" }, "status": { "$ref": "#/components/schemas/Status" }, "activities": { "type": "array", "items": { "$ref": "#/components/schemas/Activity" } }, "since": { "type": "integer" } }, "required": [ "status" ] }, "Status": { "enum": [ "dnd", "idle", "invisible", "offline", "online" ], "type": "string" }, "Activity": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "$ref": "#/components/schemas/ActivityType" }, "url": { "type": "string" }, "created_at": { "type": "integer" }, "timestamps": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } }, "additionalProperties": false, "required": [ "end", "start" ] }, "application_id": { "type": "string" }, "details": { "type": "string" }, "state": { "type": "string" }, "emoji": { "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "string" }, "animated": { "type": "boolean" } }, "additionalProperties": false, "required": [ "animated", "name" ] }, "party": { "type": "object", "properties": { "id": { "type": "string" }, "size": { "type": "array", "items": { "type": "integer" } } }, "additionalProperties": false }, "assets": { "type": "object", "properties": { "large_image": { "type": "string" }, "large_text": { "type": "string" }, "small_image": { "type": "string" }, "small_text": { "type": "string" } }, "additionalProperties": false }, "secrets": { "type": "object", "properties": { "join": { "type": "string" }, "spectate": { "type": "string" }, "match": { "type": "string" } }, "additionalProperties": false }, "instance": { "type": "boolean" }, "flags": { "type": "string" }, "id": { "type": "string" }, "sync_id": { "type": "string" }, "metadata": { "type": "object", "properties": { "context_uri": { "type": "string" }, "album_id": { "type": "string" }, "artist_ids": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false, "required": [ "album_id", "artist_ids" ] }, "session_id": { "type": "string" } }, "required": [ "flags", "name", "session_id", "type" ] }, "ActivityType": { "enum": [ 0, 1, 2, 4, 5 ], "type": "number" }, "Embed": { "type": "object", "properties": { "title": { "type": "string" }, "type": { "enum": [ "article", "gifv", "image", "link", "rich", "video" ], "type": "string" }, "description": { "type": "string" }, "url": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "color": { "type": "integer" }, "footer": { "type": "object", "properties": { "text": { "type": "string" }, "icon_url": { "type": "string" }, "proxy_icon_url": { "type": "string" } }, "additionalProperties": false, "required": [ "text" ] }, "image": { "$ref": "#/components/schemas/EmbedImage" }, "thumbnail": { "$ref": "#/components/schemas/EmbedImage" }, "video": { "$ref": "#/components/schemas/EmbedImage" }, "provider": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" } }, "additionalProperties": false }, "author": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" }, "icon_url": { "type": "string" }, "proxy_icon_url": { "type": "string" } }, "additionalProperties": false }, "fields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" }, "inline": { "type": "boolean" } }, "additionalProperties": false, "required": [ "name", "value" ] } } } }, "EmbedImage": { "type": "object", "properties": { "url": { "type": "string" }, "proxy_url": { "type": "string" }, "height": { "type": "integer" }, "width": { "type": "integer" } } }, "ChannelOverride": { "type": "object", "properties": { "message_notifications": { "type": "integer" }, "mute_config": { "$ref": "#/components/schemas/MuteConfig" }, "muted": { "type": "boolean" }, "channel_id": { "type": "string", "nullable": true } }, "required": [ "channel_id", "message_notifications", "mute_config", "muted" ] }, "MuteConfig": { "type": "object", "properties": { "end_time": { "type": "integer" }, "selected_time_window": { "type": "integer" } }, "required": [ "end_time", "selected_time_window" ] }, "CustomStatus": { "type": "object", "properties": { "emoji_id": { "type": "string" }, "emoji_name": { "type": "string" }, "expires_at": { "type": "integer" }, "text": { "type": "string" } } }, "FriendSourceFlags": { "type": "object", "properties": { "all": { "type": "boolean" } }, "required": [ "all" ] }, "GuildFolder": { "type": "object", "properties": { "color": { "type": "integer" }, "guild_ids": { "type": "array", "items": { "type": "string" } }, "id": { "type": "integer" }, "name": { "type": "string" } }, "required": [ "color", "guild_ids", "id", "name" ] }, "GenerateWebAuthnCredentialsSchema": { "type": "object", "properties": { "password": { "type": "string" } }, "required": [ "password" ] }, "CreateWebAuthnCredentialSchema": { "type": "object", "properties": { "credential": { "type": "string" }, "name": { "type": "string" }, "ticket": { "type": "string" } }, "required": [ "credential", "name", "ticket" ] }, "ChannelPermissionOverwriteSchema": { "type": "object", "properties": { "allow": { "type": "string" }, "deny": { "type": "string" }, "id": { "type": "string" }, "type": { "$ref": "#/components/schemas/ChannelPermissionOverwriteType" } }, "required": [ "allow", "deny", "id", "type" ] }, "ChannelReorderSchema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "position": { "type": "integer" }, "lock_permissions": { "type": "boolean" }, "parent_id": { "type": "string" } }, "additionalProperties": false, "required": [ "id" ] } }, "CodesVerificationSchema": { "type": "object", "properties": { "key": { "type": "string" }, "nonce": { "type": "string" }, "regenerate": { "type": "boolean" } }, "required": [ "key", "nonce" ] }, "ConnectedAccountSchema": { "type": "object", "properties": { "external_id": { "type": "string" }, "user_id": { "type": "string" }, "token_data": { "$ref": "#/components/schemas/ConnectedAccountTokenData" }, "friend_sync": { "type": "boolean" }, "name": { "type": "string" }, "revoked": { "type": "boolean" }, "show_activity": { "type": "integer" }, "type": { "type": "string" }, "verified": { "type": "boolean" }, "visibility": { "type": "integer" }, "integrations": { "type": "array", "items": { "type": "string" } }, "metadata_": {}, "metadata_visibility": { "type": "integer" }, "two_way_link": { "type": "boolean" } }, "required": [ "external_id", "name", "type", "user_id" ] }, "ConnectionCallbackSchema": { "type": "object", "properties": { "code": { "type": "string" }, "state": { "type": "string" }, "insecure": { "type": "boolean" }, "friend_sync": { "type": "boolean" }, "openid_params": {} }, "required": [ "friend_sync", "insecure", "state" ] }, "ConnectionUpdateSchema": { "type": "object", "properties": { "visibility": { "type": "boolean" }, "show_activity": { "type": "boolean" }, "metadata_visibility": { "type": "boolean" } } }, "DmChannelCreateSchema": { "type": "object", "properties": { "name": { "type": "string" }, "recipients": { "type": "array", "items": { "type": "string" } } }, "required": [ "recipients" ] }, "EmojiCreateSchema": { "type": "object", "properties": { "name": { "type": "string" }, "image": { "type": "string" }, "require_colons": { "type": "boolean", "nullable": true }, "roles": { "type": "array", "items": { "type": "string" } } }, "required": [ "image" ] }, "EmojiModifySchema": { "type": "object", "properties": { "name": { "type": "string" }, "roles": { "type": "array", "items": { "type": "string" } } } }, "ForgotPasswordSchema": { "type": "object", "properties": { "login": { "type": "string" }, "captcha_key": { "type": "string" } }, "required": [ "login" ] }, "GuildCreateSchema": { "type": "object", "properties": { "name": { "maxLength": 100, "type": "string" }, "region": { "type": "string" }, "icon": { "type": "string", "nullable": true }, "channels": { "type": "array", "items": { "$ref": "#/components/schemas/ChannelModifySchema" } }, "guild_template_code": { "type": "string" }, "system_channel_id": { "type": "string" }, "rules_channel_id": { "type": "string" } } }, "GuildTemplateCreateSchema": { "type": "object", "properties": { "name": { "type": "string" }, "avatar": { "type": "string", "nullable": true } }, "required": [ "name" ] }, "GuildUpdateSchema": { "type": "object", "properties": { "name": { "type": "string" }, "banner": { "type": "string", "nullable": true }, "splash": { "type": "string", "nullable": true }, "description": { "type": "string" }, "features": { "type": "array", "items": { "type": "string" } }, "verification_level": { "type": "integer" }, "default_message_notifications": { "type": "integer" }, "system_channel_flags": { "type": "integer" }, "explicit_content_filter": { "type": "integer" }, "public_updates_channel_id": { "type": "string" }, "afk_timeout": { "type": "integer" }, "afk_channel_id": { "type": "string" }, "preferred_locale": { "type": "string" }, "premium_progress_bar_enabled": { "type": "boolean" }, "discovery_splash": { "type": "string" }, "region": { "type": "string" }, "icon": { "type": "string", "nullable": true }, "guild_template_code": { "type": "string" }, "system_channel_id": { "type": "string" }, "rules_channel_id": { "type": "string" } } }, "GuildUpdateWelcomeScreenSchema": { "type": "object", "properties": { "welcome_channels": { "type": "array", "items": { "type": "object", "properties": { "channel_id": { "type": "string" }, "description": { "type": "string" }, "emoji_id": { "type": "string" }, "emoji_name": { "type": "string" } }, "additionalProperties": false, "required": [ "channel_id", "description" ] } }, "enabled": { "type": "boolean" }, "description": { "type": "string" } } }, "IdentifySchema": { "type": "object", "properties": { "token": { "type": "string" }, "properties": { "type": "object", "properties": { "os": { "type": "string" }, "os_atch": { "type": "string" }, "browser": { "type": "string" }, "device": { "type": "string" }, "$os": { "type": "string" }, "$browser": { "type": "string" }, "$device": { "type": "string" }, "browser_user_agent": { "type": "string" }, "browser_version": { "type": "string" }, "os_version": { "type": "string" }, "referrer": { "type": "string" }, "referring_domain": { "type": "string" }, "referrer_current": { "type": "string" }, "referring_domain_current": { "type": "string" }, "release_channel": { "enum": [ "canary", "dev", "ptb", "stable" ], "type": "string" }, "client_build_number": { "type": "integer" }, "client_event_source": { "type": "string" }, "client_version": { "type": "string" }, "system_locale": { "type": "string" } }, "additionalProperties": false }, "intents": { "type": "number" }, "presence": { "$ref": "#/components/schemas/ActivitySchema" }, "compress": { "type": "boolean" }, "large_threshold": { "type": "integer" }, "largeThreshold": { "type": "integer" }, "shard": { "minItems": 2, "maxItems": 2, "type": "array", "items": { "type": "number" } }, "guild_subscriptions": { "type": "boolean" }, "capabilities": { "type": "integer" }, "client_state": { "type": "object", "properties": { "guild_hashes": {}, "highest_last_message_id": { "type": [ "string", "integer" ] }, "read_state_version": { "type": "integer" }, "user_guild_settings_version": { "type": "integer" }, "user_settings_version": { "type": "integer" }, "useruser_guild_settings_version": { "type": "integer" }, "private_channels_version": { "type": "integer" }, "guild_versions": {}, "api_code_version": { "type": "integer" } }, "additionalProperties": false }, "clientState": { "type": "object", "properties": { "guildHashes": {}, "highestLastMessageId": { "type": [ "string", "integer" ] }, "readStateVersion": { "type": "integer" }, "userGuildSettingsVersion": { "type": "integer" }, "useruserGuildSettingsVersion": { "type": "integer" }, "guildVersions": {}, "apiCodeVersion": { "type": "integer" } }, "additionalProperties": false }, "v": { "type": "integer" } }, "required": [ "properties", "token" ] }, "InviteCreateSchema": { "type": "object", "properties": { "target_user_id": { "type": "string" }, "target_type": { "type": "string" }, "validate": { "type": "string" }, "max_age": { "type": "integer" }, "max_uses": { "type": "integer" }, "temporary": { "type": "boolean" }, "unique": { "type": "boolean" }, "target_user": { "type": "string" }, "target_user_type": { "type": "integer" } } }, "LazyRequestSchema": { "type": "object", "properties": { "guild_id": { "type": "string" }, "channels": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "array", "items": { "type": "integer" } } } }, "activities": { "type": "boolean" }, "threads": { "type": "boolean" }, "typing": { "enum": [ true ], "type": "boolean" }, "members": { "type": "array", "items": { "type": "string" } }, "thread_member_lists": { "type": "array", "items": {} } }, "required": [ "guild_id" ] }, "LoginSchema": { "type": "object", "properties": { "login": { "type": "string" }, "password": { "type": "string" }, "undelete": { "type": "boolean" }, "captcha_key": { "type": "string" }, "login_source": { "type": "string" }, "gift_code_sku_id": { "type": "string" } }, "required": [ "login", "password" ] }, "MemberChangeProfileSchema": { "type": "object", "properties": { "banner": { "type": "string", "nullable": true }, "nick": { "type": "string" }, "bio": { "type": "string" }, "pronouns": { "type": "string" }, "theme_colors": { "minItems": 2, "maxItems": 2, "type": "array", "items": { "type": "integer" } } } }, "MemberChangeSchema": { "type": "object", "properties": { "roles": { "type": "array", "items": { "type": "string" } }, "nick": { "type": "string" }, "avatar": { "type": "string", "nullable": true }, "bio": { "type": "string" } } }, "MessageAcknowledgeSchema": { "type": "object", "properties": { "manual": { "type": "boolean" }, "mention_count": { "type": "integer" } } }, "MessageCreateSchema": { "type": "object", "properties": { "type": { "type": "integer" }, "content": { "type": "string" }, "nonce": { "type": "string" }, "channel_id": { "type": "string" }, "tts": { "type": "boolean" }, "flags": { "type": "string" }, "embeds": { "type": "array", "items": { "$ref": "#/components/schemas/Embed" } }, "embed": { "$ref": "#/components/schemas/Embed" }, "allowed_mentions": { "type": "object", "properties": { "parse": { "type": "array", "items": { "type": "string" } }, "roles": { "type": "array", "items": { "type": "string" } }, "users": { "type": "array", "items": { "type": "string" } }, "replied_user": { "type": "boolean" } }, "additionalProperties": false }, "message_reference": { "type": "object", "properties": { "message_id": { "type": "string" }, "channel_id": { "type": "string" }, "guild_id": { "type": "string" }, "fail_if_not_exists": { "type": "boolean" } }, "additionalProperties": false, "required": [ "channel_id", "message_id" ] }, "payload_json": { "type": "string" }, "file": { "type": "object", "properties": { "filename": { "type": "string" } }, "additionalProperties": false, "required": [ "filename" ] }, "attachments": { "description": "TODO: we should create an interface for attachments\nTODO: OpenWAAO<-->attachment-style metadata conversion", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "filename": { "type": "string" } }, "additionalProperties": false, "required": [ "filename", "id" ] } }, "sticker_ids": { "type": "array", "items": { "type": "string" } } } }, "MessageEditSchema": { "type": "object", "properties": { "file": { "type": "object", "properties": { "filename": { "type": "string" } }, "additionalProperties": false, "required": [ "filename" ] }, "embed": { "$ref": "#/components/schemas/Embed" }, "flags": { "type": "string" }, "content": { "type": "string" }, "nonce": { "type": "string" }, "channel_id": { "type": "string" }, "tts": { "type": "boolean" }, "embeds": { "type": "array", "items": { "$ref": "#/components/schemas/Embed" } }, "allowed_mentions": { "type": "object", "properties": { "parse": { "type": "array", "items": { "type": "string" } }, "roles": { "type": "array", "items": { "type": "string" } }, "users": { "type": "array", "items": { "type": "string" } }, "replied_user": { "type": "boolean" } }, "additionalProperties": false }, "message_reference": { "type": "object", "properties": { "message_id": { "type": "string" }, "channel_id": { "type": "string" }, "guild_id": { "type": "string" }, "fail_if_not_exists": { "type": "boolean" } }, "additionalProperties": false, "required": [ "channel_id", "message_id" ] }, "payload_json": { "type": "string" }, "attachments": { "description": "TODO: we should create an interface for attachments\nTODO: OpenWAAO<-->attachment-style metadata conversion", "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "filename": { "type": "string" } }, "additionalProperties": false, "required": [ "filename", "id" ] } }, "sticker_ids": { "type": "array", "items": { "type": "string" } } } }, "MfaCodesSchema": { "type": "object", "properties": { "password": { "type": "string" }, "regenerate": { "type": "boolean" } }, "required": [ "password" ] }, "ModifyGuildStickerSchema": { "type": "object", "properties": { "name": { "minLength": 2, "maxLength": 30, "type": "string" }, "description": { "maxLength": 100, "type": "string" }, "tags": { "maxLength": 200, "type": "string" } }, "required": [ "name", "tags" ] }, "PasswordResetSchema": { "type": "object", "properties": { "password": { "type": "string" }, "token": { "type": "string" } }, "required": [ "password", "token" ] }, "PurgeSchema": { "type": "object", "properties": { "before": { "type": "string" }, "after": { "type": "string" } }, "required": [ "after", "before" ] }, "RegisterSchema": { "type": "object", "properties": { "username": { "minLength": 2, "maxLength": 32, "type": "string" }, "password": { "minLength": 1, "maxLength": 72, "type": "string" }, "consent": { "type": "boolean" }, "email": { "format": "email", "type": "string" }, "fingerprint": { "type": "string" }, "invite": { "type": "string" }, "date_of_birth": { "type": "string" }, "gift_code_sku_id": { "type": "string" }, "captcha_key": { "type": "string" }, "promotional_email_opt_in": { "type": "boolean" } }, "required": [ "consent", "username" ] }, "RelationshipPostSchema": { "type": "object", "properties": { "discriminator": { "type": "string" }, "username": { "type": "string" } }, "required": [ "discriminator", "username" ] }, "RelationshipPutSchema": { "type": "object", "properties": { "type": { "enum": [ 1, 2, 3, 4 ], "type": "number" } } }, "RoleModifySchema": { "type": "object", "properties": { "name": { "type": "string" }, "permissions": { "type": "string" }, "color": { "type": "integer" }, "hoist": { "type": "boolean" }, "mentionable": { "type": "boolean" }, "position": { "type": "integer" }, "icon": { "type": "string" }, "unicode_emoji": { "type": "string" } } }, "RolePositionUpdateSchema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "position": { "type": "integer" } }, "additionalProperties": false, "required": [ "id", "position" ] } }, "SelectProtocolSchema": { "type": "object", "properties": { "protocol": { "enum": [ "udp", "webrtc" ], "type": "string" }, "data": { "anyOf": [ { "type": "object", "properties": { "address": { "type": "string" }, "port": { "type": "integer" }, "mode": { "type": "string" } }, "additionalProperties": false, "required": [ "address", "mode", "port" ] }, { "type": "string" } ] }, "sdp": { "type": "string" }, "codecs": { "type": "array", "items": { "type": "object", "properties": { "name": { "enum": [ "H264", "VP8", "VP9", "opus" ], "type": "string" }, "type": { "enum": [ "audio", "video" ], "type": "string" }, "priority": { "type": "integer" }, "payload_type": { "type": "integer" }, "rtx_payload_type": { "type": [ "null", "integer" ] } }, "additionalProperties": false, "required": [ "name", "payload_type", "priority", "type" ] } }, "rtc_connection_id": { "type": "string" } }, "required": [ "data", "protocol" ] }, "TemplateCreateSchema": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" } }, "required": [ "name" ] }, "TemplateModifySchema": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" } }, "required": [ "name" ] }, "TotpDisableSchema": { "type": "object", "properties": { "code": { "type": "string" } }, "required": [ "code" ] }, "TotpEnableSchema": { "type": "object", "properties": { "password": { "type": "string" }, "code": { "type": "string" }, "secret": { "type": "string" } }, "required": [ "password" ] }, "TotpSchema": { "type": "object", "properties": { "code": { "type": "string" }, "ticket": { "type": "string" }, "gift_code_sku_id": { "type": "string", "nullable": true }, "login_source": { "type": "string", "nullable": true } }, "required": [ "code", "ticket" ] }, "UserDeleteSchema": { "type": "object", "properties": { "user_id": { "type": "string" } }, "required": [ "user_id" ] }, "UserGuildSettingsSchema": { "type": "object", "properties": { "channel_overrides": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ChannelOverride" } }, "version": { "type": "integer" }, "guild_id": { "type": "string", "nullable": true }, "flags": { "type": "integer" }, "message_notifications": { "type": "integer" }, "mobile_push": { "type": "boolean" }, "mute_config": { "anyOf": [ { "$ref": "#/components/schemas/MuteConfig" }, { "type": "null" } ] }, "muted": { "type": "boolean" }, "suppress_everyone": { "type": "boolean" }, "suppress_roles": { "type": "boolean" }, "mute_scheduled_events": { "type": "boolean" }, "hide_muted_channels": { "type": "boolean" }, "notify_highlights": { "enum": [ 0 ], "type": "number" } } }, "UserModifySchema": { "type": "object", "properties": { "username": { "minLength": 1, "maxLength": 100, "type": "string" }, "avatar": { "type": "string", "nullable": true }, "bio": { "maxLength": 1024, "type": "string" }, "accent_color": { "type": "integer" }, "banner": { "type": "string", "nullable": true }, "password": { "type": "string" }, "new_password": { "type": "string" }, "code": { "type": "string" }, "email": { "type": "string" }, "discriminator": { "minLength": 4, "maxLength": 4, "type": "string" } } }, "UserNoteUpdateSchema": { "type": "object", "properties": { "note": { "type": "string" } }, "required": [ "note" ] }, "UserProfileModifySchema": { "type": "object", "properties": { "bio": { "type": "string" }, "accent_color": { "type": "integer", "nullable": true }, "banner": { "type": "string", "nullable": true }, "pronouns": { "type": "string" }, "theme_colors": { "minItems": 2, "maxItems": 2, "type": "array", "items": { "type": "integer" } } } }, "UserSettingsSchema": { "type": "object", "properties": { "afk_timeout": { "type": "integer" }, "allow_accessibility_detection": { "type": "boolean" }, "animate_emoji": { "type": "boolean" }, "animate_stickers": { "type": "integer" }, "contact_sync_enabled": { "type": "boolean" }, "convert_emoticons": { "type": "boolean" }, "custom_status": { "anyOf": [ { "$ref": "#/components/schemas/CustomStatus" }, { "type": "null" } ] }, "default_guilds_restricted": { "type": "boolean" }, "detect_platform_accounts": { "type": "boolean" }, "developer_mode": { "type": "boolean" }, "disable_games_tab": { "type": "boolean" }, "enable_tts_command": { "type": "boolean" }, "explicit_content_filter": { "type": "integer" }, "friend_source_flags": { "$ref": "#/components/schemas/FriendSourceFlags" }, "gateway_connected": { "type": "boolean" }, "gif_auto_play": { "type": "boolean" }, "guild_folders": { "type": "array", "items": { "$ref": "#/components/schemas/GuildFolder" } }, "guild_positions": { "type": "array", "items": { "type": "string" } }, "inline_attachment_media": { "type": "boolean" }, "inline_embed_media": { "type": "boolean" }, "locale": { "type": "string" }, "message_display_compact": { "type": "boolean" }, "native_phone_integration_enabled": { "type": "boolean" }, "render_embeds": { "type": "boolean" }, "render_reactions": { "type": "boolean" }, "restricted_guilds": { "type": "array", "items": { "type": "string" } }, "show_current_game": { "type": "boolean" }, "status": { "enum": [ "dnd", "idle", "invisible", "offline", "online" ], "type": "string" }, "stream_notifications_enabled": { "type": "boolean" }, "theme": { "enum": [ "dark", "light" ], "type": "string" }, "timezone_offset": { "type": "integer" } } }, "VanityUrlSchema": { "type": "object", "properties": { "code": { "minLength": 1, "maxLength": 20, "type": "string" } } }, "VoiceIdentifySchema": { "type": "object", "properties": { "server_id": { "type": "string" }, "user_id": { "type": "string" }, "session_id": { "type": "string" }, "token": { "type": "string" }, "video": { "type": "boolean" }, "streams": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "rid": { "type": "string" }, "quality": { "type": "integer" } }, "additionalProperties": false, "required": [ "quality", "rid", "type" ] } } }, "required": [ "server_id", "session_id", "token", "user_id" ] }, "VoiceStateUpdateSchema": { "type": "object", "properties": { "guild_id": { "type": "string" }, "channel_id": { "type": "string" }, "self_mute": { "type": "boolean" }, "self_deaf": { "type": "boolean" }, "self_video": { "type": "boolean" }, "preferred_region": { "type": "string" }, "request_to_speak_timestamp": { "type": "string", "format": "date-time" }, "suppress": { "type": "boolean" } }, "required": [ "self_deaf", "self_mute" ] }, "VoiceVideoSchema": { "type": "object", "properties": { "audio_ssrc": { "type": "integer" }, "video_ssrc": { "type": "integer" }, "rtx_ssrc": { "type": "integer" }, "user_id": { "type": "string" }, "streams": { "type": "array", "items": { "type": "object", "properties": { "type": { "enum": [ "audio", "video" ], "type": "string" }, "rid": { "type": "string" }, "ssrc": { "type": "integer" }, "active": { "type": "boolean" }, "quality": { "type": "integer" }, "rtx_ssrc": { "type": "integer" }, "max_bitrate": { "type": "integer" }, "max_framerate": { "type": "integer" }, "max_resolution": { "type": "object", "properties": { "type": { "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } }, "additionalProperties": false, "required": [ "height", "type", "width" ] } }, "additionalProperties": false, "required": [ "active", "max_bitrate", "max_framerate", "max_resolution", "quality", "rid", "rtx_ssrc", "ssrc", "type" ] } } }, "required": [ "audio_ssrc", "video_ssrc" ] }, "WebAuthnPostSchema": { "anyOf": [ { "$ref": "#/components/schemas/GenerateWebAuthnCredentialsSchema" }, { "$ref": "#/components/schemas/CreateWebAuthnCredentialSchema" } ] }, "WebAuthnTotpSchema": { "type": "object", "properties": { "code": { "type": "string" }, "ticket": { "type": "string" } }, "required": [ "code", "ticket" ] }, "WebhookCreateSchema": { "type": "object", "properties": { "name": { "maxLength": 80, "type": "string" }, "avatar": { "type": "string" } }, "required": [ "name" ] }, "WidgetModifySchema": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "channel_id": { "type": "string" } }, "required": [ "channel_id", "enabled" ] }, "BulkDeleteSchema": { "type": "object", "properties": { "messages": { "type": "array", "items": { "type": "string" } } }, "required": [ "messages" ] }, "MemberNickChangeSchema": { "type": "object", "properties": { "nick": { "type": "string" } }, "required": [ "nick" ] }, "PruneSchema": { "type": "object", "properties": { "days": { "type": "integer" } }, "required": [ "days" ] }, "VerifyEmailSchema": { "type": "object", "properties": { "captcha_key": { "type": "string", "nullable": true }, "token": { "type": "string" } }, "required": [ "token" ] } } }, "tags": [ { "name": "-" }, { "name": "applications" }, { "name": "auth" }, { "name": "channels" }, { "name": "connections" }, { "name": "discoverable-guilds" }, { "name": "discovery" }, { "name": "download" }, { "name": "experiments" }, { "name": "gateway" }, { "name": "gifs" }, { "name": "guild-recommendations" }, { "name": "guilds" }, { "name": "invites" }, { "name": "oauth2" }, { "name": "outbound-promotions" }, { "name": "partners" }, { "name": "ping" }, { "name": "policies" }, { "name": "read-states" }, { "name": "scheduled-maintenances" }, { "name": "science" }, { "name": "stage-instances" }, { "name": "sticker-packs" }, { "name": "stickers" }, { "name": "stop" }, { "name": "store" }, { "name": "teams" }, { "name": "track" }, { "name": "updates" }, { "name": "users" }, { "name": "voice" } ], "paths": { "/voice/regions/": { "get": { "security": [ { "bearer": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIGuildVoiceRegion" } } } } }, "tags": [ "voice" ] } }, "/users/@me/settings/": { "patch": { "security": [ { "bearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserSettingsSchema" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserSettings" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } } }, "tags": [ "users" ] } }, "/users/@me/relationships/": { "post": { "security": [ { "bearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RelationshipPostSchema" } } } }, "responses": { "204": { "description": "No description available" }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } } }, "tags": [ "users" ] } }, "/users/@me/relationships/{id}": { "delete": { "security": [ { "bearer": [] } ], "responses": { "204": { "description": "No description available" }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "id" } ], "tags": [ "users" ] } }, "/users/@me/notes/{id}": { "put": { "security": [ { "bearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserNoteUpdateSchema" } } } }, "responses": { "204": { "description": "No description available" }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "id" } ], "tags": [ "users" ] } }, "/users/@me/mfa/webauthn/credentials/": { "post": { "security": [ { "bearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebAuthnPostSchema" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebAuthnCreateResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } } }, "tags": [ "users" ] } }, "/users/@me/mfa/webauthn/credentials/{key_id}/": { "delete": { "security": [ { "bearer": [] } ], "responses": { "204": { "description": "No description available" } }, "parameters": [ { "name": "key_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "key_id" } ], "tags": [ "users" ] } }, "/users/@me/mfa/totp/enable/": { "post": { "security": [ { "bearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TotpEnableSchema" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenWithBackupCodesResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } } }, "tags": [ "users" ] } }, "/users/@me/mfa/totp/disable/": { "post": { "security": [ { "bearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TotpDisableSchema" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenOnlyResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } } }, "tags": [ "users" ] } }, "/users/@me/mfa/codes/": { "post": { "security": [ { "bearer": [] } ], "description": "This route is replaced with users/@me/mfa/codes-verification in newer clients", "deprecated": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MfaCodesSchema" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIBackupCodeArray" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } } }, "tags": [ "users" ] } }, "/users/@me/mfa/codes-verification/": { "post": { "security": [ { "bearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CodesVerificationSchema" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIBackupCodeArray" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } } }, "tags": [ "users" ] } }, "/users/@me/library/": { "get": { "security": [ { "bearer": [] } ], "responses": { "default": { "description": "No description available" } }, "tags": [ "users" ] } }, "/users/@me/": { "patch": { "security": [ { "bearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserModifySchema" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserUpdateResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } } }, "tags": [ "users" ] } }, "/users/@me/guilds/": { "get": { "security": [ { "bearer": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIGuildArray" } } } } }, "tags": [ "users" ] } }, "/users/@me/guilds/{guild_id}": { "delete": { "security": [ { "bearer": [] } ], "responses": { "204": { "description": "No description available" }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } } }, "parameters": [ { "name": "guild_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "guild_id" } ], "tags": [ "users" ] } }, "/users/@me/guilds/premium/subscription-slots/": { "get": { "security": [ { "bearer": [] } ], "responses": { "default": { "description": "No description available" } }, "tags": [ "users" ] } }, "/users/@me/guilds/{guild_id}/settings/": { "patch": { "security": [ { "bearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserGuildSettingsSchema" } } } }, "responses": { "200": { "description": "No description available" }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } } }, "parameters": [ { "name": "guild_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "guild_id" } ], "tags": [ "users" ] } }, "/users/@me/entitlements/gifts": { "get": { "security": [ { "bearer": [] } ], "responses": { "default": { "description": "No description available" } }, "tags": [ "users" ] } }, "/users/@me/email-settings/": { "get": { "security": [ { "bearer": [] } ], "responses": { "default": { "description": "No description available" } }, "tags": [ "users" ] } }, "/users/@me/disable/": { "post": { "security": [ { "bearer": [] } ], "responses": { "204": { "description": "No description available" }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } } }, "tags": [ "users" ] } }, "/users/@me/devices/": { "post": { "security": [ { "bearer": [] } ], "responses": { "default": { "description": "No description available" } }, "tags": [ "users" ] } }, "/users/@me/delete/": { "post": { "security": [ { "bearer": [] } ], "responses": { "204": { "description": "No description available" }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } } }, "tags": [ "users" ] } }, "/users/@me/connections/": { "get": { "security": [ { "bearer": [] } ], "responses": { "default": { "description": "No description available" } }, "tags": [ "users" ] } }, "/users/@me/connections/{connection_name}/{connection_id}/": { "delete": { "security": [ { "bearer": [] } ], "responses": { "default": { "description": "No description available" } }, "parameters": [ { "name": "connection_name", "in": "path", "required": true, "schema": { "type": "string" }, "description": "connection_name" }, { "name": "connection_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "connection_id" } ], "tags": [ "users" ] } }, "/users/@me/connections/{connection_name}/{connection_id}/access-token/": { "get": { "security": [ { "bearer": [] } ], "responses": { "default": { "description": "No description available" } }, "parameters": [ { "name": "connection_name", "in": "path", "required": true, "schema": { "type": "string" }, "description": "connection_name" }, { "name": "connection_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "connection_id" } ], "tags": [ "users" ] } }, "/users/@me/channels/": { "post": { "security": [ { "bearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DmChannelCreateSchema" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DmChannelDTO" } } } } }, "tags": [ "users" ] } }, "/users/@me/billing/subscriptions/": { "get": { "security": [ { "bearer": [] } ], "responses": { "default": { "description": "No description available" } }, "tags": [ "users" ] } }, "/users/@me/billing/payment-sources/": { "get": { "security": [ { "bearer": [] } ], "responses": { "default": { "description": "No description available" } }, "tags": [ "users" ] } }, "/users/@me/billing/country-code/": { "get": { "security": [ { "bearer": [] } ], "responses": { "default": { "description": "No description available" } }, "tags": [ "users" ] } }, "/users/@me/applications/{app_id}/entitlements/": { "get": { "security": [ { "bearer": [] } ], "responses": { "default": { "description": "No description available" } }, "parameters": [ { "name": "app_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "app_id" } ], "tags": [ "users" ] } }, "/users/@me/affinities/users/": { "get": { "security": [ { "bearer": [] } ], "responses": { "default": { "description": "No description available" } }, "tags": [ "users" ] } }, "/users/@me/affinities/guilds/": { "get": { "security": [ { "bearer": [] } ], "responses": { "default": { "description": "No description available" } }, "tags": [ "users" ] } }, "/users/@me/activities/statistics/applications/": { "get": { "security": [ { "bearer": [] } ], "responses": { "default": { "description": "No description available" } }, "tags": [ "users" ] } }, "/users/{id}/relationships/": { "get": { "security": [ { "bearer": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserRelationsResponse" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "id" } ], "tags": [ "users" ] } }, "/users/{id}/profile/": { "patch": { "security": [ { "bearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserProfileModifySchema" } } } }, "responses": { "default": { "description": "No description available" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "id" } ], "tags": [ "users" ] } }, "/users/{id}/": { "get": { "security": [ { "bearer": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIPublicUser" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "id" } ], "tags": [ "users" ] } }, "/users/{id}/delete/": { "post": { "x-right-required": "MANAGE_USERS", "security": [ { "bearer": [] } ], "responses": { "204": { "description": "No description available" }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "id" } ], "tags": [ "users" ] } }, "/updates/": { "get": { "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatesResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } } }, "tags": [ "updates" ] } }, "/track/": { "post": { "responses": { "default": { "description": "No description available" } }, "tags": [ "track" ] } }, "/teams/": { "get": { "security": [ { "bearer": [] } ], "responses": { "default": { "description": "No description available" } }, "tags": [ "teams" ] } }, "/store/published-listings/skus/{id}": { "get": { "security": [ { "bearer": [] } ], "responses": { "default": { "description": "No description available" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "id" } ], "tags": [ "store" ] } }, "/store/published-listings/skus/{sku_id}/subscription-plans/": { "get": { "security": [ { "bearer": [] } ], "responses": { "default": { "description": "No description available" } }, "parameters": [ { "name": "sku_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "sku_id" } ], "tags": [ "store" ] } }, "/store/published-listings/applications/{id}": { "get": { "security": [ { "bearer": [] } ], "responses": { "default": { "description": "No description available" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "id" } ], "tags": [ "store" ] } }, "/store/published-listings/applications/{id}/subscription-plans/": { "get": { "security": [ { "bearer": [] } ], "responses": { "default": { "description": "No description available" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "id" } ], "tags": [ "store" ] } }, "/stop/": { "post": { "x-right-required": "OPERATOR", "security": [ { "bearer": [] } ], "responses": { "200": { "description": "No description available" }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } } }, "tags": [ "stop" ] } }, "/stickers/{sticker_id}/": { "get": { "security": [ { "bearer": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Sticker" } } } } }, "parameters": [ { "name": "sticker_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "sticker_id" } ], "tags": [ "stickers" ] } }, "/sticker-packs/": { "get": { "security": [ { "bearer": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIStickerPackArray" } } } } }, "tags": [ "sticker-packs" ] } }, "/stage-instances/": { "get": { "security": [ { "bearer": [] } ], "responses": { "default": { "description": "No description available" } }, "tags": [ "stage-instances" ] } }, "/science/": { "post": { "responses": { "204": { "description": "No description available" } }, "tags": [ "science" ] } }, "/scheduled-maintenances/upcoming_json/scheduled-maintenances/upcoming.json": { "get": { "security": [ { "bearer": [] } ], "responses": { "default": { "description": "No description available" } }, "tags": [ "scheduled-maintenances" ] } }, "/read-states/ack-bulk/": { "post": { "security": [ { "bearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AckBulkSchema" } } } }, "responses": { "204": { "description": "No description available" }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } } }, "tags": [ "read-states" ] } }, "/policies/stats/": { "get": { "security": [ { "bearer": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InstanceStatsResponse" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } } }, "tags": [ "policies" ] } }, "/policies/instance/limits/": { "get": { "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APILimitsConfiguration" } } } } }, "tags": [ "policies" ] } }, "/policies/instance/": { "get": { "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIGeneralConfiguration" } } } } }, "tags": [ "policies" ] } }, "/policies/instance/domains/": { "get": { "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InstanceDomainsResponse" } } } } }, "tags": [ "policies" ] } }, "/ping/": { "get": { "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InstancePingResponse" } } } } }, "tags": [ "ping" ] } }, "/partners/{guild_id}/requirements/": { "get": { "security": [ { "bearer": [] } ], "responses": { "default": { "description": "No description available" } }, "parameters": [ { "name": "guild_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "guild_id" } ], "tags": [ "partners" ] } }, "/outbound-promotions/": { "get": { "security": [ { "bearer": [] } ], "responses": { "default": { "description": "No description available" } }, "tags": [ "outbound-promotions" ] } }, "/oauth2/tokens/": { "get": { "security": [ { "bearer": [] } ], "responses": { "default": { "description": "No description available" } }, "tags": [ "oauth2" ] } }, "/oauth2/authorize/": { "post": { "security": [ { "bearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationAuthorizeSchema" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OAuthAuthorizeResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } } }, "parameters": [ { "name": "client_id", "in": "query", "schema": { "type": "string" } } ], "tags": [ "oauth2" ] } }, "/invites/{code}": { "delete": { "security": [ { "bearer": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invite" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } } }, "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" }, "description": "code" } ], "tags": [ "invites" ] } }, "/guilds/templates/{code}": { "post": { "security": [ { "bearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuildTemplateCreateSchema" } } } }, "responses": { "default": { "description": "No description available" } }, "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" }, "description": "code" } ], "tags": [ "guilds" ] } }, "/guilds/": { "post": { "x-right-required": "CREATE_GUILDS", "security": [ { "bearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuildCreateSchema" } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuildCreateResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } } }, "tags": [ "guilds" ] } }, "/guilds/{guild_id}/widget.png/": { "get": { "security": [ { "bearer": [] } ], "responses": { "200": { "description": "No description available" }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } } }, "parameters": [ { "name": "guild_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "guild_id" } ], "tags": [ "guilds" ] } }, "/guilds/{guild_id}/widget.json/": { "get": { "security": [ { "bearer": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuildWidgetJsonResponse" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } } }, "parameters": [ { "name": "guild_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "guild_id" } ], "tags": [ "guilds" ] } }, "/guilds/{guild_id}/widget/": { "patch": { "x-permission-required": "MANAGE_GUILD", "security": [ { "bearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WidgetModifySchema" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WidgetModifySchema" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } } }, "parameters": [ { "name": "guild_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "guild_id" } ], "tags": [ "guilds" ] } }, "/guilds/{guild_id}/welcome-screen/": { "patch": { "x-permission-required": "MANAGE_GUILD", "security": [ { "bearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuildUpdateWelcomeScreenSchema" } } } }, "responses": { "204": { "description": "No description available" }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } } }, "parameters": [ { "name": "guild_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "guild_id" } ], "tags": [ "guilds" ] } }, "/guilds/{guild_id}/webhooks/": { "get": { "security": [ { "bearer": [] } ], "responses": { "default": { "description": "No description available" } }, "parameters": [ { "name": "guild_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "guild_id" } ], "tags": [ "guilds" ] } }, "/guilds/{guild_id}/voice-states/{user_id}/": { "patch": { "security": [ { "bearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VoiceStateUpdateSchema" } } } }, "responses": { "204": { "description": "No description available" }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } } }, "parameters": [ { "name": "guild_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "guild_id" }, { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "user_id" } ], "tags": [ "guilds" ] } }, "/guilds/{guild_id}/vanity-url/": { "patch": { "x-permission-required": "MANAGE_GUILD", "security": [ { "bearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VanityUrlSchema" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuildVanityUrlCreateResponse" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } } }, "parameters": [ { "name": "guild_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "guild_id" } ], "tags": [ "guilds" ] } }, "/guilds/{guild_id}/templates/": { "post": { "x-permission-required": "MANAGE_GUILD", "security": [ { "bearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplateCreateSchema" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Template" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } } }, "parameters": [ { "name": "guild_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "guild_id" } ], "tags": [ "guilds" ] } }, "/guilds/{guild_id}/templates/{code}": { "patch": { "x-permission-required": "MANAGE_GUILD", "security": [ { "bearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplateModifySchema" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Template" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } } }, "parameters": [ { "name": "guild_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "guild_id" }, { "name": "code", "in": "path", "required": true, "schema": { "type": "string" }, "description": "code" } ], "tags": [ "guilds" ] } }, "/guilds/{guild_id}/stickers/": { "post": { "x-permission-required": "MANAGE_EMOJIS_AND_STICKERS", "security": [ { "bearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModifyGuildStickerSchema" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Sticker" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } } }, "parameters": [ { "name": "guild_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "guild_id" } ], "tags": [ "guilds" ] } }, "/guilds/{guild_id}/stickers/{sticker_id}": { "delete": { "x-permission-required": "MANAGE_EMOJIS_AND_STICKERS", "security": [ { "bearer": [] } ], "responses": { "204": { "description": "No description available" }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } } }, "parameters": [ { "name": "guild_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "guild_id" }, { "name": "sticker_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "sticker_id" } ], "tags": [ "guilds" ] } }, "/guilds/{guild_id}/roles/member-counts/": { "get": { "security": [ { "bearer": [] } ], "responses": { "default": { "description": "No description available" } }, "parameters": [ { "name": "guild_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "guild_id" } ], "tags": [ "guilds" ] } }, "/guilds/{guild_id}/roles/": { "patch": { "x-permission-required": "MANAGE_ROLES", "security": [ { "bearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RolePositionUpdateSchema" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIRoleArray" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } } }, "parameters": [ { "name": "guild_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "guild_id" } ], "tags": [ "guilds" ] } }, "/guilds/{guild_id}/roles/{role_id}/members/": { "patch": { "x-permission-required": "MANAGE_ROLES", "security": [ { "bearer": [] } ], "responses": { "default": { "description": "No description available" } }, "parameters": [ { "name": "guild_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "guild_id" }, { "name": "role_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "role_id" } ], "tags": [ "guilds" ] } }, "/guilds/{guild_id}/roles/{role_id}/member-ids/": { "get": { "security": [ { "bearer": [] } ], "responses": { "default": { "description": "No description available" } }, "parameters": [ { "name": "guild_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "guild_id" }, { "name": "role_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "role_id" } ], "tags": [ "guilds" ] } }, "/guilds/{guild_id}/roles/{role_id}/": { "patch": { "x-permission-required": "MANAGE_ROLES", "security": [ { "bearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoleModifySchema" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Role" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } } }, "parameters": [ { "name": "guild_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "guild_id" }, { "name": "role_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "role_id" } ], "tags": [ "guilds" ] } }, "/guilds/{guild_id}/regions/": { "get": { "security": [ { "bearer": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIGuildVoiceRegion" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } } }, "parameters": [ { "name": "guild_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "guild_id" } ], "tags": [ "guilds" ] } }, "/guilds/{guild_id}/prune/": { "post": { "x-right-required": "KICK_BAN_MEMBERS", "x-permission-required": "KICK_MEMBERS", "security": [ { "bearer": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuildPurgeResponse" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } } }, "parameters": [ { "name": "guild_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "guild_id" } ], "tags": [ "guilds" ] } }, "/guilds/{guild_id}/profile/{member_id}": { "patch": { "security": [ { "bearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemberChangeProfileSchema" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Member" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } } }, "parameters": [ { "name": "guild_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "guild_id" }, { "name": "member_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "member_id" } ], "tags": [ "guilds" ] } }, "/guilds/{guild_id}/premium/subscriptions": { "get": { "security": [ { "bearer": [] } ], "responses": { "default": { "description": "No description available" } }, "parameters": [ { "name": "guild_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "guild_id" } ], "tags": [ "guilds" ] } }, "/guilds/{guild_id}/messages/search/": { "get": { "security": [ { "bearer": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuildMessagesSearchResponse" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } }, "422": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } } }, "parameters": [ { "name": "guild_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "guild_id" } ], "tags": [ "guilds" ] } }, "/guilds/{guild_id}/members/": { "get": { "security": [ { "bearer": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIMemberArray" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } } }, "parameters": [ { "name": "guild_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "guild_id" }, { "name": "limit", "in": "query", "schema": { "type": "number" }, "description": "max number of members to return (1-1000). default 1" }, { "name": "after", "in": "query", "schema": { "type": "string" } } ], "tags": [ "guilds" ] } }, "/guilds/{guild_id}/members/{member_id}/roles/{role_id}/": { "put": { "x-permission-required": "MANAGE_ROLES", "security": [ { "bearer": [] } ], "responses": { "204": { "description": "No description available" }, "403": { "description": "No description available" } }, "parameters": [ { "name": "guild_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "guild_id" }, { "name": "member_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "member_id" }, { "name": "role_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "role_id" } ], "tags": [ "guilds" ] } }, "/guilds/{guild_id}/members/{member_id}/nick/": { "patch": { "security": [ { "bearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemberNickChangeSchema" } } } }, "responses": { "200": { "description": "No description available" }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } } }, "parameters": [ { "name": "guild_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "guild_id" }, { "name": "member_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "member_id" } ], "tags": [ "guilds" ] } }, "/guilds/{guild_id}/members/{member_id}/": { "delete": { "security": [ { "bearer": [] } ], "responses": { "204": { "description": "No description available" }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } } }, "parameters": [ { "name": "guild_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "guild_id" }, { "name": "member_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "member_id" } ], "tags": [ "guilds" ] } }, "/guilds/{guild_id}/member-verification/": { "get": { "security": [ { "bearer": [] } ], "responses": { "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } } }, "parameters": [ { "name": "guild_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "guild_id" } ], "tags": [ "guilds" ] } }, "/guilds/{guild_id}/invites/": { "get": { "x-permission-required": "MANAGE_GUILD", "security": [ { "bearer": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIInviteArray" } } } } }, "parameters": [ { "name": "guild_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "guild_id" } ], "tags": [ "guilds" ] } }, "/guilds/{guild_id}/integrations/": { "get": { "security": [ { "bearer": [] } ], "responses": { "default": { "description": "No description available" } }, "parameters": [ { "name": "guild_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "guild_id" } ], "tags": [ "guilds" ] } }, "/guilds/{guild_id}/": { "patch": { "x-permission-required": "MANAGE_GUILD", "security": [ { "bearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuildUpdateSchema" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuildUpdateSchema" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } } }, "parameters": [ { "name": "guild_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "guild_id" } ], "tags": [ "guilds" ] } }, "/guilds/{guild_id}/emojis/": { "post": { "x-permission-required": "MANAGE_EMOJIS_AND_STICKERS", "security": [ { "bearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmojiCreateSchema" } } } }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Emoji" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } } }, "parameters": [ { "name": "guild_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "guild_id" } ], "tags": [ "guilds" ] } }, "/guilds/{guild_id}/emojis/{emoji_id}": { "delete": { "x-permission-required": "MANAGE_EMOJIS_AND_STICKERS", "security": [ { "bearer": [] } ], "responses": { "204": { "description": "No description available" }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } } }, "parameters": [ { "name": "guild_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "guild_id" }, { "name": "emoji_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "emoji_id" } ], "tags": [ "guilds" ] } }, "/guilds/{guild_id}/discovery-requirements/": { "get": { "security": [ { "bearer": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuildDiscoveryRequirementsResponse" } } } } }, "parameters": [ { "name": "guild_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "guild_id" } ], "tags": [ "guilds" ] } }, "/guilds/{guild_id}/delete/": { "post": { "security": [ { "bearer": [] } ], "responses": { "204": { "description": "No description available" }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } } }, "parameters": [ { "name": "guild_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "guild_id" } ], "tags": [ "guilds" ] } }, "/guilds/{guild_id}/channels/": { "patch": { "x-permission-required": "MANAGE_CHANNELS", "security": [ { "bearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChannelReorderSchema" } } } }, "responses": { "204": { "description": "No description available" }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } } }, "parameters": [ { "name": "guild_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "guild_id" } ], "tags": [ "guilds" ] } }, "/guilds/{guild_id}/bans/": { "get": { "x-permission-required": "BAN_MEMBERS", "security": [ { "bearer": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuildBansResponse" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } } }, "parameters": [ { "name": "guild_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "guild_id" } ], "tags": [ "guilds" ] } }, "/guilds/{guild_id}/bans/{user}": { "get": { "x-permission-required": "BAN_MEMBERS", "security": [ { "bearer": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BanModeratorSchema" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } } }, "parameters": [ { "name": "guild_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "guild_id" }, { "name": "user", "in": "path", "required": true, "schema": { "type": "string" }, "description": "user" } ], "tags": [ "guilds" ] } }, "/guilds/{guild_id}/bans/{user_id}": { "delete": { "x-permission-required": "BAN_MEMBERS", "security": [ { "bearer": [] } ], "responses": { "204": { "description": "No description available" }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } } }, "parameters": [ { "name": "guild_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "guild_id" }, { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "user_id" } ], "tags": [ "guilds" ] } }, "/guilds/{guild_id}/bans/@me": { "put": { "security": [ { "bearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BanCreateSchema" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ban" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } } }, "parameters": [ { "name": "guild_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "guild_id" } ], "tags": [ "guilds" ] } }, "/guilds/{guild_id}/audit-logs/": { "get": { "security": [ { "bearer": [] } ], "responses": { "default": { "description": "No description available" } }, "parameters": [ { "name": "guild_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "guild_id" } ], "tags": [ "guilds" ] } }, "/guild-recommendations/": { "get": { "security": [ { "bearer": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuildRecommendationsResponse" } } } } }, "tags": [ "guild-recommendations" ] } }, "/gifs/trending/": { "get": { "security": [ { "bearer": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenorTrendingResponse" } } } } }, "parameters": [ { "name": "locale", "in": "query", "schema": { "type": "string" }, "description": "Locale" } ], "tags": [ "gifs" ] } }, "/gifs/trending-gifs/": { "get": { "security": [ { "bearer": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenorGifsResponse" } } } } }, "parameters": [ { "name": "media_format", "in": "query", "schema": { "type": "string" }, "description": "Media format" }, { "name": "locale", "in": "query", "schema": { "type": "string" }, "description": "Locale" } ], "tags": [ "gifs" ] } }, "/gifs/search/": { "get": { "security": [ { "bearer": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenorGifsResponse" } } } } }, "parameters": [ { "name": "q", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Search query" }, { "name": "media_format", "in": "query", "schema": { "type": "string" }, "description": "Media format" }, { "name": "locale", "in": "query", "schema": { "type": "string" }, "description": "Locale" } ], "tags": [ "gifs" ] } }, "/gateway/": { "get": { "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayResponse" } } } } }, "tags": [ "gateway" ] } }, "/gateway/bot/": { "get": { "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewayBotResponse" } } } } }, "tags": [ "gateway" ] } }, "/experiments/": { "get": { "responses": { "default": { "description": "No description available" } }, "tags": [ "experiments" ] } }, "/download/": { "get": { "responses": { "302": { "description": "No description available" }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } } }, "tags": [ "download" ] } }, "/discovery/categories": { "get": { "security": [ { "bearer": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIDiscoveryCategoryArray" } } } } }, "tags": [ "discovery" ] } }, "/discoverable-guilds/": { "get": { "security": [ { "bearer": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiscoverableGuildsResponse" } } } } }, "tags": [ "discoverable-guilds" ] } }, "/connections/{connection_name}/callback/": { "post": { "security": [ { "bearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectionCallbackSchema" } } } }, "responses": { "default": { "description": "No description available" } }, "parameters": [ { "name": "connection_name", "in": "path", "required": true, "schema": { "type": "string" }, "description": "connection_name" } ], "tags": [ "connections" ] } }, "/connections/{connection_name}/authorize/": { "get": { "security": [ { "bearer": [] } ], "responses": { "default": { "description": "No description available" } }, "parameters": [ { "name": "connection_name", "in": "path", "required": true, "schema": { "type": "string" }, "description": "connection_name" } ], "tags": [ "connections" ] } }, "/connections/{connection_name}/{connection_id}/refresh/": { "post": { "security": [ { "bearer": [] } ], "responses": { "default": { "description": "No description available" } }, "parameters": [ { "name": "connection_name", "in": "path", "required": true, "schema": { "type": "string" }, "description": "connection_name" }, { "name": "connection_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "connection_id" } ], "tags": [ "connections" ] } }, "/channels/{channel_id}/webhooks/": { "post": { "x-permission-required": "MANAGE_WEBHOOKS", "security": [ { "bearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookCreateSchema" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookCreateResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } }, "403": { "description": "No description available" } }, "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "channel_id" } ], "tags": [ "channels" ] } }, "/channels/{channel_id}/typing/": { "post": { "x-permission-required": "SEND_MESSAGES", "security": [ { "bearer": [] } ], "responses": { "204": { "description": "No description available" }, "403": { "description": "No description available" }, "404": { "description": "No description available" } }, "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "channel_id" } ], "tags": [ "channels" ] } }, "/channels/{channel_id}/recipients/{user_id}": { "delete": { "security": [ { "bearer": [] } ], "responses": { "204": { "description": "No description available" }, "404": { "description": "No description available" } }, "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "channel_id" }, { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "user_id" } ], "tags": [ "channels" ] } }, "/channels/{channel_id}/purge/": { "post": { "security": [ { "bearer": [] } ], "responses": { "204": { "description": "No description available" }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } }, "403": { "description": "No description available" }, "404": { "description": "No description available" } }, "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "channel_id" } ], "tags": [ "channels" ] } }, "/channels/{channel_id}/pins/{message_id}": { "delete": { "x-permission-required": "VIEW_CHANNEL", "security": [ { "bearer": [] } ], "responses": { "204": { "description": "No description available" }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } }, "403": { "description": "No description available" }, "404": { "description": "No description available" } }, "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "channel_id" }, { "name": "message_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "message_id" } ], "tags": [ "channels" ] } }, "/channels/{channel_id}/pins/": { "get": { "x-permission-required": [ "READ_MESSAGE_HISTORY" ], "security": [ { "bearer": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIMessageArray" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } } }, "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "channel_id" } ], "tags": [ "channels" ] } }, "/channels/{channel_id}/permissions/{overwrite_id}": { "delete": { "x-permission-required": "MANAGE_ROLES", "security": [ { "bearer": [] } ], "responses": { "204": { "description": "No description available" }, "404": { "description": "No description available" } }, "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "channel_id" }, { "name": "overwrite_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "overwrite_id" } ], "tags": [ "channels" ] } }, "/channels/{channel_id}/messages/bulk-delete/": { "post": { "security": [ { "bearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkDeleteSchema" } } } }, "responses": { "204": { "description": "No description available" }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } }, "403": { "description": "No description available" }, "404": { "description": "No description available" } }, "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "channel_id" } ], "tags": [ "channels" ] } }, "/channels/{channel_id}/messages/{message_id}/reactions/": { "delete": { "x-permission-required": "MANAGE_MESSAGES", "security": [ { "bearer": [] } ], "responses": { "204": { "description": "No description available" }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } }, "403": { "description": "No description available" }, "404": { "description": "No description available" } }, "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "channel_id" }, { "name": "message_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "message_id" } ], "tags": [ "channels" ] } }, "/channels/{channel_id}/messages/{message_id}/reactions/{emoji}": { "get": { "x-permission-required": "VIEW_CHANNEL", "security": [ { "bearer": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicUser" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } }, "403": { "description": "No description available" }, "404": { "description": "No description available" } }, "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "channel_id" }, { "name": "message_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "message_id" }, { "name": "emoji", "in": "path", "required": true, "schema": { "type": "string" }, "description": "emoji" } ], "tags": [ "channels" ] } }, "/channels/{channel_id}/messages/{message_id}/reactions/{emoji}/{user_id}": { "delete": { "security": [ { "bearer": [] } ], "responses": { "204": { "description": "No description available" }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } }, "403": { "description": "No description available" }, "404": { "description": "No description available" } }, "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "channel_id" }, { "name": "message_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "message_id" }, { "name": "emoji", "in": "path", "required": true, "schema": { "type": "string" }, "description": "emoji" }, { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "user_id" } ], "tags": [ "channels" ] } }, "/channels/{channel_id}/messages/{message_id}/": { "delete": { "security": [ { "bearer": [] } ], "responses": { "204": { "description": "No description available" }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } }, "404": { "description": "No description available" } }, "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "channel_id" }, { "name": "message_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "message_id" } ], "tags": [ "channels" ] } }, "/channels/{channel_id}/messages/{message_id}/crosspost/": { "post": { "x-permission-required": "MANAGE_MESSAGES", "security": [ { "bearer": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } } } }, "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "channel_id" }, { "name": "message_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "message_id" } ], "tags": [ "channels" ] } }, "/channels/{channel_id}/messages/{message_id}/ack/": { "post": { "security": [ { "bearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageAcknowledgeSchema" } } } }, "responses": { "200": { "description": "No description available" }, "403": { "description": "No description available" } }, "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "channel_id" }, { "name": "message_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "message_id" } ], "tags": [ "channels" ] } }, "/channels/{channel_id}/invites/": { "get": { "x-permission-required": "MANAGE_CHANNELS", "security": [ { "bearer": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIInviteArray" } } } }, "404": { "description": "No description available" } }, "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "channel_id" } ], "tags": [ "channels" ] } }, "/channels/{channel_id}/": { "patch": { "x-permission-required": "MANAGE_CHANNELS", "security": [ { "bearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChannelModifySchema" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Channel" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } }, "404": { "description": "No description available" } }, "parameters": [ { "name": "channel_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "channel_id" } ], "tags": [ "channels" ] } }, "/auth/verify/view-backup-codes-challenge/": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackupCodesChallengeSchema" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackupCodesChallengeResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } } }, "tags": [ "auth" ] } }, "/auth/verify/resend/": { "post": { "x-right-required": "RESEND_VERIFICATION_EMAIL", "responses": { "204": { "description": "No description available" }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } } }, "tags": [ "auth" ] } }, "/auth/verify/": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerifyEmailSchema" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorOrCaptchaResponse" } } } } }, "tags": [ "auth" ] } }, "/auth/reset/": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PasswordResetSchema" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenOnlyResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorOrCaptchaResponse" } } } } }, "tags": [ "auth" ] } }, "/auth/register/": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegisterSchema" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenOnlyResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorOrCaptchaResponse" } } } } }, "tags": [ "auth" ] } }, "/auth/mfa/webauthn/": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebAuthnTotpSchema" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } } }, "tags": [ "auth" ] } }, "/auth/mfa/totp/": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TotpSchema" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } } }, "tags": [ "auth" ] } }, "/auth/logout/": { "post": { "security": [ { "bearer": [] } ], "responses": { "204": { "description": "No description available" } }, "tags": [ "auth" ] } }, "/auth/login/": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoginSchema" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoginResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorOrCaptchaResponse" } } } } }, "tags": [ "auth" ] } }, "/auth/location-metadata/": { "get": { "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocationMetadataResponse" } } } } }, "tags": [ "auth" ] } }, "/auth/generate-registration-tokens/": { "get": { "x-right-required": "OPERATOR", "security": [ { "bearer": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenerateRegistrationTokensResponse" } } } } }, "parameters": [ { "name": "count", "in": "query", "schema": { "type": "number" }, "description": "The number of registration tokens to generate. Defaults to 1." }, { "name": "length", "in": "query", "schema": { "type": "number" }, "description": "The length of each registration token. Defaults to 255." } ], "tags": [ "auth" ] } }, "/auth/forgot/": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ForgotPasswordSchema" } } } }, "responses": { "204": { "description": "No description available" }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorOrCaptchaResponse" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } } }, "tags": [ "auth" ] } }, "/applications/": { "post": { "security": [ { "bearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationCreateSchema" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Application" } } } } }, "tags": [ "applications" ] } }, "/applications/detectable/": { "get": { "security": [ { "bearer": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationDetectableResponse" } } } } }, "tags": [ "applications" ] } }, "/applications/{id}/skus/": { "get": { "security": [ { "bearer": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationSkusResponse" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "id" } ], "tags": [ "applications" ] } }, "/applications/{id}/": { "patch": { "security": [ { "bearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationModifySchema" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Application" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "id" } ], "tags": [ "applications" ] } }, "/applications/{id}/delete": { "post": { "security": [ { "bearer": [] } ], "responses": { "200": { "description": "No description available" }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "id" } ], "tags": [ "applications" ] } }, "/applications/{id}/entitlements/": { "get": { "security": [ { "bearer": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationEntitlementsResponse" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "id" } ], "tags": [ "applications" ] } }, "/applications/{id}/bot/": { "patch": { "security": [ { "bearer": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BotModifySchema" } } } }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Application" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "id" } ], "tags": [ "applications" ] } }, "/applications/{id}/bot/reset": { "post": { "security": [ { "bearer": [] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TokenResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/APIErrorResponse" } } } } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "id" } ], "tags": [ "applications" ] } }, "/-/readyz/": { "get": { "responses": { "default": { "description": "No description available" } }, "tags": [ "-" ] } }, "/-/healthz/": { "get": { "responses": { "default": { "description": "No description available" } }, "tags": [ "-" ] } } } }