API Endpoints

​

Endpoint Categories

The Fluxer API is organized into the following categories:

​

Authentication Endpoints

Manage user authentication and sessions.

​

SSO (Single Sign-On)

• GET /v1/auth/sso/status - Get SSO status
• POST /v1/auth/sso/start - Start SSO session
• POST /v1/auth/sso/complete - Complete SSO authentication

​

Login & Registration

• POST /v1/auth/login - User login
• POST /v1/auth/register - User registration
• POST /v1/auth/logout - Logout current session
• GET /v1/auth/username-suggestions - Get username suggestions

​

Multi-Factor Authentication

• POST /v1/auth/mfa/totp - Verify TOTP code
• POST /v1/auth/mfa/sms - Verify SMS code
• POST /v1/auth/mfa/webauthn - Verify WebAuthn credential

​

WebAuthn / Passkeys

• POST /v1/auth/webauthn/authenticate/options - Get authentication options
• POST /v1/auth/webauthn/authenticate - Complete WebAuthn authentication

​

Password Management

• POST /v1/auth/forgot-password - Request password reset
• POST /v1/auth/reset-password - Reset password with token

​

Session Management

• GET /v1/auth/sessions - List active sessions
• POST /v1/auth/sessions/logout - Logout specific sessions

​

Advanced Authentication

• POST /v1/auth/sudo/verify - Enter sudo mode for sensitive operations
• POST /v1/auth/handoff/initiate - Initiate connection handoff
• GET /v1/auth/handoff/:code/status - Check handoff status
• POST /v1/auth/handoff/:code/complete - Complete handoff
• POST /v1/auth/authorize-ip - Authorize new IP address
• GET /v1/auth/authorize-ip/poll - Poll IP authorization status

​

User Endpoints

Manage user profiles and settings.

• GET /v1/users/@me - Get current user
• PATCH /v1/users/@me - Update current user
• DELETE /v1/users/@me - Delete current user account
• GET /v1/users/:id - Get user by ID
• GET /v1/users/@me/guilds - Get current user’s guilds
• GET /v1/users/@me/connections - Get user connections (social accounts)
• POST /v1/users/@me/connections - Add connection
• DELETE /v1/users/@me/connections/:id - Remove connection

​

Guild Endpoints

Manage guilds (servers) and their members.

• GET /v1/guilds/:guild_id - Get guild information
• POST /v1/guilds - Create new guild
• PATCH /v1/guilds/:guild_id - Update guild
• DELETE /v1/guilds/:guild_id - Delete guild
• GET /v1/guilds/:guild_id/members - List guild members
• GET /v1/guilds/:guild_id/members/:user_id - Get guild member
• PATCH /v1/guilds/:guild_id/members/:user_id - Update guild member
• DELETE /v1/guilds/:guild_id/members/:user_id - Remove guild member
• GET /v1/guilds/:guild_id/bans - List guild bans
• PUT /v1/guilds/:guild_id/bans/:user_id - Ban guild member
• DELETE /v1/guilds/:guild_id/bans/:user_id - Unban guild member

​

Channel Endpoints

Manage channels within guilds.

• GET /v1/channels/:channel_id - Get channel
• POST /v1/guilds/:guild_id/channels - Create channel
• PATCH /v1/channels/:channel_id - Update channel
• DELETE /v1/channels/:channel_id - Delete channel
• GET /v1/channels/:channel_id/messages - Get channel messages
• POST /v1/channels/:channel_id/typing - Trigger typing indicator

​

Gateway Endpoints

Get WebSocket gateway connection information.

• GET /v1/gateway - Get gateway URL
• GET /v1/gateway/bot - Get gateway URL for bots

​

Search Endpoints

Search across messages, guilds, and users.

• GET /v1/search/messages - Search messages
• GET /v1/search/guilds - Search guilds
• GET /v1/search/users - Search users

​

OAuth2 Endpoints

Manage OAuth2 applications and authorizations.

• GET /v1/oauth2/applications - List OAuth2 applications
• POST /v1/oauth2/applications - Create OAuth2 application
• GET /v1/oauth2/applications/:id - Get OAuth2 application
• PATCH /v1/oauth2/applications/:id - Update OAuth2 application
• DELETE /v1/oauth2/applications/:id - Delete OAuth2 application
• GET /v1/oauth2/authorize - OAuth2 authorization endpoint
• POST /v1/oauth2/token - OAuth2 token endpoint

​

Instance Endpoints

Get instance information and configuration.

• GET /v1/instance - Get instance information
• GET /v1/instance/config - Get public instance configuration

​

Download Endpoints

Generate download archives for user data.

• POST /v1/download/request - Request data download
• GET /v1/download/status/:request_id - Check download status

​

Other Endpoints

​

Invites

• GET /v1/invites/:code - Get invite information
• POST /v1/invites/:code - Accept invite
• DELETE /v1/invites/:code - Delete invite

​

Webhooks

• POST /v1/channels/:channel_id/webhooks - Create webhook
• GET /v1/channels/:channel_id/webhooks - List webhooks
• GET /v1/webhooks/:webhook_id - Get webhook
• PATCH /v1/webhooks/:webhook_id - Update webhook
• DELETE /v1/webhooks/:webhook_id - Delete webhook

​

Reports

• POST /v1/reports - Submit content report

​

Themes

• GET /v1/themes - List available themes
• GET /v1/themes/:id - Get theme by ID

​

GIF Integrations

• GET /v1/tenor/search - Search Tenor GIFs
• GET /v1/klipy/search - Search Klipy GIFs

​

Donations (Official Instance Only)

• POST /v1/donations - Create donation
• GET /v1/donations/status - Get donation status

​

Stripe (Official Instance Only)

• POST /v1/stripe/webhook - Stripe webhook endpoint

​

Admin Endpoints

Admin endpoints are prefixed with /v1/admin/ and include:

• User management and moderation
• Guild management
• Content moderation
• Instance configuration
• Audit logs
• Analytics and reports
• CSAM detection management
• Ban management
• Discovery configuration

See the admin documentation for detailed information on administrative operations.

​

Internal Endpoints

Internal endpoints are used for service-to-service communication and require special authentication:

• GET /internal/telemetry - Service telemetry information
• GET /_health - Health check endpoint

​

Response Types

All endpoints return JSON responses with appropriate HTTP status codes:

• 200 OK - Successful request
• 201 Created - Resource created
• 204 No Content - Successful request with no response body
• 400 Bad Request - Invalid request
• 401 Unauthorized - Authentication required
• 403 Forbidden - Insufficient permissions
• 404 Not Found - Resource not found
• 429 Too Many Requests - Rate limit exceeded
• 500 Internal Server Error - Server error

​

Middleware

Endpoints may use the following middleware:

• Authentication - Requires valid session or OAuth token
• Rate Limiting - Enforces request rate limits
• CORS - Allows cross-origin requests from approved origins
• Request ID - Assigns unique ID to each request for tracing
• Validation - Validates request parameters and body
• Captcha - Requires captcha verification (registration, password reset)
• Sudo Mode - Requires recent re-authentication

​

Next Steps