Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/N3XT3R1337/RiftCE/llms.txt

Use this file to discover all available pages before exploring further.

Rift CE includes an optional local HTTP server that you can enable from Settings → Web Server. When running, it listens on localhost:7963 (or a custom port you configure) and accepts plain HTTP GET requests, returning JSON responses. All responses use Content-Type: application/json.

Base URL

http://localhost:7963
The port is configurable via WebServerPort in Settings. By default the server only accepts connections from localhost. Enable WebServerAllowExternal to bind on all interfaces (http://+:{port}/), which is required for requests from other machines on your network.
The web server is disabled by default. Toggle Enable Web Server on in Settings → Web Server before making any requests.

Authentication

Every request is validated before reaching any endpoint. Supply your configured password using the X-Rift-Password header or the ?password= query parameter. A missing or incorrect password returns 401 Unauthorized. See the authentication guide for full details and examples.

Endpoint summary

All endpoints use HTTP GET. There are no POST, PUT, or DELETE methods.
EndpointPermission flagDescription
GET /runningNoneServer status, version, and account count
GET /getaccountsWebServerAllowGetAccountsList all accounts with metadata
GET /getcookieWebServerAllowGetCookieGet the raw .ROBLOSECURITY cookie for an account
GET /launchaccountWebServerAllowLaunchTrigger a Roblox launch for an account
GET /setaliasWebServerAllowEditingSet the alias on an account
GET /setdescriptionWebServerAllowEditingSet the description on an account
GET /setgroupWebServerAllowEditingSet the group on an account
GET /getfieldWebServerAllowEditingRead one or all custom fields on an account
GET /setfieldWebServerAllowEditingWrite a custom field on an account
GET /removefieldWebServerAllowEditingDelete a custom field from an account

Common error codes

StatusMeaning
401Wrong or missing password
403Required permission flag is disabled in Settings
404Account not found, or unknown endpoint
500Unexpected server-side error
Error responses always follow this shape:
{ "error": "Description of the problem" }

Status check

GET /running requires no authentication and no parameters. Use it to verify the server is up before issuing further requests.
{ "running": true, "version": "1.0.0", "accounts": 5 }

Explore the reference

Authentication

How to pass your password and which permission flags gate each endpoint.

Account endpoints

List accounts, check status, and retrieve cookies.

Launch endpoint

Trigger Roblox launches with optional place and server targeting.

Custom field endpoints

Read and write arbitrary key-value metadata on any account.

Build docs developers (and LLMs) love