Project endpoints

Endpoints relating to projects

Getting a project

GET /projects/:project_id

Params:

Key	Description
project_id	The projects id

Response:

success

{
  "success": true,
  "project": {
    "id": "PROJECT_ID",
    "name": "PROJECT_NAME",
    "fingerprint_reset_cooldown": 86400000, // unix ms
    "allow_fingerprint_resets": true,
    "delete_expired_users": true,
    "execution_webhook": "DISCORD_WEBHOOK" OR null,
    "information_webhook": "DISCORD_WEBHOOK" OR null,
    "blacklist_webhook": "DISCORD_WEBHOOK" OR null,
    "total_executions": 0,
    "require_discord": true,
    "require_join_server": true,
    "total_sessions": 0,
    "total_instances": 0
  }
}

Editing a project

POST /projects/:project_id/edit

Params:

Key	Description
project_id	The projects id

Payload:

Key	Type	Required
name	`String`	`False`
fingerprint_reset_cooldown	`Number`	`False`
allow_fingerprint_resets	`Boolean`	`False`
delete_expired_users	`Boolean`	`False`
execution_webhook	`String`	`False`
information_webhook	`String`	`False`
blacklist_webhook	`String`	`False`
require_discord	`Boolean`	`False`
require_join_server	`Boolean`	`False`

Response:

success Error

{ "success": true }

Code	Message
0	account expired
1	cannot edit nothing
2	must setup a panel for this project to use discord options

Deleting a project

POST /projects/:project_id/remove

Params:

Key	Description
project_id	The projects id

Response:

success

{ "success": true }

Getting executions

GET /projects/:project_id/executions

Params:

Key	Description
project_id	The projects id

Response:

Success

{
  "success": true,
  "executions": {
    "total": { "01/01": 0 },
    "SCRIPT_NAME - SCRIPT_ID": { "01/01": 0 }
  }
}

Getting executors

GET /projects/:project_id/executors

Params:

Key	Description
project_id	The projects id

Response:

Success

{
  "success": true,
  "executors": { "NAME": 0 },
  "percentages": { "NAME": 100 }
}

Getting scripts

GET /projects/:project_id/scripts

Params:

Key	Description
project_id	The projects id

Response:

Success

{
  "success": true,
  "scripts": [{
    "id": "SCRIPT_ID",
    "project_id": "PROJECT_ID",
    "name": "SCRIPT_NAME",
    "free_for_all": false,
    "use_heartbeat": true,
    "kick_outdated": false,
    "require_sessions": false,
    "enabled": true,
    "total_executions": 0,
    "total_sessions": 0,
    "total_instances": 0
  }]
}

Creating a script

POST /projects/:project_id/scripts/new

Params:

Key	Description
project_id	The projects id

Payload:

Key	Type	Required	Default
name	`String`	`True`
script	`String`	`True`
free_for_all	`Boolean`	`False`	`False`
use_heartbeat	`Boolean`	`False`	`True`
kick_outdated	`Boolean`	`False`	`False`
require_sessions	`Boolean`	`False`	`False`
save_source	`Boolean`	`False`	`True`
silent	`Boolean`	`False`	`False`

Response:

Success Error

{
  "success": true,
  "script_id": "SCRIPT_ID"
}

Code	Message	Extra
0	max scripts reached
1	max obfuscations reached
2	account expired
3	script is invalid	`{ "parser_output": "MESSAGE" }`
4	failed to obfuscate script	`{ "luraph_errors": [{ "param": "PARAM", "message": "MESSAGE" }] }`
5	not enough obfuscations for init script
6	failed to obfuscate init script	`{ "luraph_errors": [{ "param": "PARAM", "message": "MESSAGE" }] }`
7	tier does not allow ffa mode

Getting users

GET /projects/:project_id/users

Params:

Key	Description
project_id	The projects id

Queries:

Key	Type	Required	Default
from	`Number`	`False`	`0`
limit	`Number`	`False`	`∞`

Response:

Success

{
  "success": true,
  "users": [{
    "key": "USER_KEY",
    "project_id": "PROJECT_ID",
    "discord_id": "DISCORD_ID",
    "fingerprint_assigned": true,
    "executor": "EXECUTOR" OR null,
    "executions": 0,
    "key_expires": 1770624500000 OR null, // unix ms
    "last_reset": 1770624500000 OR null, // unix ms
    "total_fingerprint_resets": 0,
    "note": "NOTE" OR null,
    "blacklisted": false,
    "blacklist_reason": "NOTE" OR null,
    "blacklist_expires": 1770624500000 OR null, // unix ms
    "total_sessions": 0,
    "total_instances": 0,
    "luaauth_fingerprint": "⬛⬛⬛⬛⬛⬛ -> ip\n⬛⬛⬛⬛⬛⬛ -> fingerprint\n⬛⬛⬛⬛⬛⬛ -> executor"
  }]
}

Filtering users

GET /projects/:project_id/users/filter

Params:

Key	Description
project_id	The projects id

Queries:

with the Boolean values, Null = return both

the search query returns users that key, discord, note, executor or blacklist reason includes that string as a substring or matches that string

Key	Type	Required	Default
from	`Number`	`False`	`0`
limit	`Number`	`False`	`∞`
key	`String`	`False`	`Null`
fingerprint_assigned	`Boolean`	`False`	`Null`
key_expires	`Boolean`	`False`	`Null`
discord_id	`String`	`False`	`Null`
executor	`String`	`False`	`Null`
note	`String`	`False`	`Null`
blacklisted	`Boolean`	`False`	`Null`
blacklist_reason	`String`	`False`	`Null`
blacklist_expires	`Boolean`	`False`	`Null`
ad_key	`Boolean`	`False`	`Null`
search	`String`	`False`	`Null`

Response:

Success Error

{
  "success": true,
  "users": [{
    "key": "USER_KEY",
    "project_id": "PROJECT_ID",
    "discord_id": "DISCORD_ID",
    "fingerprint_assigned": true,
    "executor": "EXECUTOR" OR null,
    "executions": 0,
    "key_expires": 1770624500000 OR null, // unix ms
    "last_reset": 1770624500000 OR null, // unix ms
    "total_fingerprint_resets": 0,
    "note": "NOTE" OR null,
    "blacklisted": false,
    "blacklist_reason": "NOTE" OR null,
    "blacklist_expires": 1770624500000 OR null, // unix ms
    "total_sessions": 0,
    "total_instances": 0,
    "luaauth_fingerprint": "⬛⬛⬛⬛⬛⬛ -> ip\n⬛⬛⬛⬛⬛⬛ -> fingerprint\n⬛⬛⬛⬛⬛⬛ -> executor"
  }]
}

Code	Message
0	must filter something

Creating a user

POST /projects/:project_id/users/new

Params:

Key	Description
project_id	The projects id

Payload:

max_instances, max_executions and use_fingerprint require you to have advanced_key_control, leave null if you dont have this

Key	Type	Required	Default
discord_id	`String`	`False`	`Null`
key_expires	`Number`	`True`
note	`String`	`False`	`Null`
max_instances	`Number`	`False`	`0`
max_executions	`Number`	`False`	`0`
use_fingerprint	`Boolean`	`False`	`True`

Response:

Success Error

{
  "success": true,
  "user_key": "USER_KEY"
}

Code	Message
0	max users reached
1	account expired
2	key already exists with this discord
3	tier missing advanced key control feature

Mass generating users

POST /projects/:project_id/users/generate

Params:

Key	Description
project_id	The projects id

Payload:

max_instances, max_executions and use_fingerprint require you to have advanced_key_control, leave null if you dont have this

Key	Type	Required	Default
amount	`Number`	`True`
keys_expire	`Number`	`True`
note	`String`	`False`	`Null`
max_instances	`Number`	`False`	`0`
max_executions	`Number`	`False`	`0`
use_fingerprint	`Boolean`	`False`	`True`

Response:

Success Error

{
  "success": true,
  "user_keys": [ "USER_KEY" ]
}

Code	Message
0	too many keys to generate
1	account expired
2	tier missing advanced key control feature

Importing users

POST /projects/:project_id/users/import

Params:

Key	Description
project_id	The projects id

Payload:

Key	Type	Required
users	`Array`	`True`

User JSON:

users must be an array of jsons, those jsons must be the following

the time fields can be in seconds or milliseconds

Keys	Type	Required	Default
`discord_id` OR `discord`	`String`	`False`	`Null`
`fingerprint` OR `identifier` OR `hwid`	`String`	`False`	`Null`
`auth_expire` OR `key_expires`	`Number`	`False`	`Null`
`note`	`String`	`False`	`Null`
`executor`	`String`	`False`	`Null`
`blacklisted`	`Boolean`	`False`	`False`
`blacklist_reason`	`String`	`False`	`Null`
`blacklist_expires`	`Number`	`False`	`Null`

Response:

Success Error

{
  "success": true,
  "imported": 0,
  "skipped": 0
}

Code	Message
0	too many users to import
1	account expired
2	no users given

Exporting users

POST /projects/:project_id/users/export

Params:

Key	Description
project_id	The projects id

Payload:

Key	Type	Options	Required
type	`Enum`	`text` OR `json`	`True`

Response:

Success (json) Success (text)

{
  "success": true,
  "exported": "[{ \"key\": \"USER_KEY\", \"discord_id\": \"DISCORD_ID\" OR null, \"executor\": \"EXECUTOR\" OR null, \"key_expires\": 1770624500000 OR null, \"note\": \"NOTE\" OR null, \"blacklisted\": false, \"blacklist_reason\": \"REASON\" OR null, \"blacklist_expired\": 1770624500000 OR null }]"
}

{
  "success": true,
  "exported": "--- UNUSED KEYS, format: key ---\nUSER_KEY\n--- USED KEYS, format: key, discord, executor ---\nUSER_KEY, DISCORD_ID, EXECUTOR\nUSER_KEY, N/A, N/A"
}

Resetting everyones fingerprints

POST /projects/:project_id/users/resetall

Params:

Key	Description
project_id	The projects id

Response:

Success Error

{ "success": true }

Code	Message
0	account expired

Deleting every unused user

POST /projects/:project_id/users/purge

Params:

Key	Description
project_id	The projects id

Response:

Success Error

{ "success": true }

Code	Message
0	account expired

Deleting every user

POST /projects/:project_id/users/clear

Params:

Key	Description
project_id	The projects id

Response:

Success Error

{ "success": true }

Code	Message
0	account expired

Compensate users

POST /projects/:project_id/users/compensate

Params:

Key	Description
project_id	The projects id

Payload:

Key	Type	Required
duration	`Number`	`True`
compensate_expired	`Boolean`	`True`

Response:

Success Error

{ "success": true }

Code	Message
0	account expired

Getting sessions

GET /projects/:project_id/sessions

Params:

Key	Description
project_id	The projects id

Queries:

Key	Type	Required	Default
from	`Number`	`False`	`0`
limit	`Number`	`False`	`∞`

Response:

Success

{
  "success": true,
  "sessions": [{
    "id": "SESSION_ID",
    "user_key": "USER_KEY" OR null,
    "script_id": "SCRIPT_ID",
    "roblox_id": 10373477521,
    "place_id": 606849621,
    "job_id": "JOB_ID",
    "created_at": 1770624500000
  }]
}

Filtering sessions

GET /projects/:project_id/sessions/filter

Params:

Key	Description
project_id	The projects id

Queries:

Key	Type	Required	Default
from	`Number`	`False`	`0`
limit	`Number`	`False`	`∞`
key	`String`	`False`	`Null`
script_id	`String`	`False`	`Null`
roblox_id	`String`	`False`	`Null`
place_id	`String`	`False`	`Null`
job_id	`String`	`False`	`Null`

Response:

Success Error

{
  "success": true,
  "sessions": [{
    "id": "SESSION_ID",
    "user_key": "USER_KEY" OR null,
    "script_id": "SCRIPT_ID",
    "roblox_id": 10373477521,
    "place_id": 606849621,
    "job_id": "JOB_ID",
    "created_at": 1770624500000
  }]
}