Script endpoints

Endpoints relating to users

Getting a user

GET /users/:user_key

Params:

Key	Description
user_key	The users key

Response:

success

{
  "success": true,
  "user": {
    "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, // ms unix timestamp
    "last_reset": 1770624500000 OR null, // ms unix timestamp
    "total_fingerprint_resets": 0,
    "note": "NOTE" OR null,
    "blacklisted": false,
    "blacklist_reason": "NOTE" OR null,
    "blacklist_expires": 1770624500000 OR null, // ms unix timestamp
    "total_sessions": 0,
    "total_instances": 0,
    "luaauth_fingerprint": "⬛⬛⬛⬛⬛⬛ -> ip\n⬛⬛⬛⬛⬛⬛ -> fingerprint\n⬛⬛⬛⬛⬛⬛ -> executor"
  }
}

Editing a user

POST /users/:user_key/edit

Params:

Key	Description
user_key	The users key

Payload:

Editing blacklist_expires and blacklist_reason requires the user to be blacklisted first, leave null if they are not

Key	Type	Required
discord_id	`String`	`False`
key_expires	`Number`	`False`
note	`String`	`False`
max_instances	`Number`	`False`
max_executions	`Number`	`False`
use_fingerprint	`Boolean`	`False`
blacklist_expires	`Number`	`False`
blacklist_reason	`String`	`False`

Response:

success Error

{ "success": true }

Code	Message
0	account expired
1	key already exists with this discord
2	cannot edit nothing
3	tier missing advanced key control feature
4	cannot edit blacklist data when user isnt blacklisted

Blacklisting a user

POST /users/:user_key/blacklist

Params:

Key	Description
user_key	The users key

Payload:

Key	Type	Required
expires	`Number`	`True`
reason	`String`	`False`

Response:

success Error

{ "success": true }

Code	Message
0	user already blacklisted
1	account expired

Unblacklisting a user

POST /users/:user_key/unblacklist

Params:

Key	Description
user_key	The users key

Response:

success Error

{ "success": true }

Code	Message
0	user not blacklisted
1	account expired

Resetting a users fingerprint

POST /users/:user_key/reset

Params:

Key	Description
user_key	The users key

Payload:

Key	Type	Required
force	`Boolean`	`True`

Response:

success Error

{ "success": true }

Code	Message	Extra
0	account expired
1	user doesnt have an assigned fingerprint
2	project has resetting fingerprints disabled
3	must wait before resetting fingerprint	`{ "cooldown_remaining": 0 }`

Linking a users discord account

POST /users/:user_key/link

Params:

Key	Description
user_key	The users key

Payload:

Key	Type	Required
discord_id	`String`	`True`
force	`Boolean`	`True`

Response:

success Error

{ "success": true }

Code	Message
0	account expired
1	key already has a discord assigned to it
2	a key already exists with this discord

Deleting a user

POST /users/:user_key/remove

Params:

Key	Description
user_key	The users key

Response:

success

{ "success": true }

Getting sessions

GET /users/:user_key/sessions

Params:

Key	Description
user_key	The users key

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 /users/:user_key/sessions/filter

Params:

Key	Description
user_key	The users key

Queries:

Key	Type	Required	Default
from	`Number`	`False`	`0`
limit	`Number`	`False`	`∞`
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
  }]
}

Code	Message
0	must filter something

Script endpoints Getting a user Editing a user Blacklisting a user Unblacklisting a user Resetting a users fingerprint Linking a users discord account Deleting a user Getting sessions Filtering sessions