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 external scripts, bots, or tools can use to interact with your account vault. You can list accounts, retrieve cookies, trigger launches, and read or write custom fields — all over plain HTTP requests from the same machine or, optionally, your local network.

Enabling the web server

1

Open Settings

In Rift CE, click the Settings button in the top navigation bar.
2

Enable the server

Scroll to the Web Server section and toggle Enable Web Server on.
3

Set a port

The default port is 7963. Change it if that port is already in use on your machine. The setting is WebServerPort.
4

Set a password

Enter a password in the Password field. By default WebServerRequirePassword is enabled — all requests must supply this password. Leave the field blank only in isolated environments where no other process can reach the port.
By default the server only binds to http://localhost:{port}/. Nothing outside your machine can reach it. Enable Allow External Access (WebServerAllowExternal) only if you need requests from other devices on your network — this binds to http://+:{port}/ and may require Windows Firewall rule changes or administrator privileges.

Authentication

Every request is authenticated with a shared password. Supply it using either method:
  • Header: X-Rift-Password: your-password
  • Query parameter: ?password=your-password
Requests without a valid credential when WebServerRequirePassword is true receive a 401 Unauthorized response.

Permission flags

Each category of endpoint is independently gated by a permission flag in Settings. Calling a disabled endpoint returns 403 Forbidden.
SettingDefaultWhat it controls
WebServerAllowGetAccountstrueGET /getaccounts
WebServerAllowGetCookiefalseGET /getcookie
WebServerAllowLaunchtrueGET /launchaccount
WebServerAllowEditingfalse/setalias, /setdescription, /setgroup, /getfield, /setfield, /removefield
WebServerAllowGetCookie and WebServerAllowEditing are disabled by default because they expose sensitive data or allow vault modifications. Enable them only for trusted local automations.

Endpoints

Status

MethodPathAuth requiredPermission
GET/runningNoNone
Returns the server version and total account count. Useful as a health check from your automation before issuing further requests.

Accounts

MethodPathAuth requiredPermission
GET/getaccountsYesWebServerAllowGetAccounts
GET/getcookie?Account=YesWebServerAllowGetCookie
/getaccounts returns a JSON array of all accounts with Username, UserId, Group, Alias, Status, and LastUsed. /getcookie returns the raw .ROBLOSECURITY cookie for a single account — handle this value with care.

Launching

MethodPathAuth requiredPermission
GET/launchaccount?Account=&PlaceId=&JobId=YesWebServerAllowLaunch
Account is the Roblox username (required). PlaceId is optional — omit it to open Roblox home. JobId is optional and only applies when PlaceId is provided.

Editing

All editing endpoints require WebServerAllowEditing.
MethodPathParameters
GET/setaliasAccount, Alias
GET/setdescriptionAccount, Description
GET/setgroupAccount, Group
GET/getfieldAccount, Field (omit Field to return all fields)
GET/setfieldAccount, Field, Value
GET/removefieldAccount, Field
Custom fields (getfield / setfield / removefield) are arbitrary key-value pairs stored per account. Use them to attach metadata like farm type, proxy address, or last-run timestamps to accounts.

Response format

All responses are Content-Type: application/json. Success responses have HTTP status 200. Error responses follow this shape:
{ "error": "Description of the problem" }
StatusMeaning
200Success
400Bad request (e.g. missing required parameter)
401Wrong or missing password
403Permission flag is disabled
404Account or route not found
500Unexpected server error

Example requests

curl http://localhost:7963/running
For a complete reference of all endpoints with full request and response schemas, see the Web API reference.

Build docs developers (and LLMs) love