Script endpoints

info

these are endpoints relating to scripts

Getting script info

GET /scripts/:script_id

Parameters

Name	Type	Description
script_id	String	The scripts id

Response

Success

{
    "success": true,
    "script": {
        "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
    }
}

Getting executions

GET /scripts/:script_id/executions

Parameters

Name	Type	Description
script_id	String	The scripts id

Response

Success

{
    "success": true,
    "executions": { "01/01": 0 }
}

Editing a script

POST /scripts/:script_id/edit

Parameters

Name	Type	Description
script_id	String	The scripts id

Body

Name	Type	Nullable	Description
name	String	✅	Name for the script
free_for_all	Boolean	✅	Allow users to execute without a key
use_heartbeat	Boolean	✅	Continue to check users after initial verification
kick_outdated	Boolean	✅	Kick users using old version of the script
require_sessions	Boolean	✅	Prevent users without WebSockets to use the script

Response

Success

{ "success": true }

Error

Code	Message
0	account expired
1	cannot edit nothing
2	tier does not allow ffa mode

Deleting a script

POST /scripts/:script_id/remove

Parameters

Name	Type	Description
script_id	String	The scripts id

Response

Success

{ "success": true }

Updating a script

POST /scripts/:script_id/update

Parameters

Name	Type	Description
script_id	String	The scripts id

Body

Name	Type	Nullable	Description
script	String	❌	the source code of the script

Response

Success

{ "success": true }

Error

Code	Message	Extra
0	account expired
1	max obfuscations reached
2	script is invalid	parser_output: 'MESSAGE'
3	failed to obfuscate script	luraph_errors: [{ param: 'PARAM', message: 'MESSAGE' }]
4	not enough obfuscations for init script
5	failed to obfuscate init script	luraph_errors: [{ param: 'PARAM', message: 'MESSAGE' }]

Toggling a script

POST /scripts/:script_id/toggle

Parameters

Name	Type	Description
script_id	String	The scripts id

Body

Name	Type	Nullable	Description
state	Boolean	❌	script enabled state

Response

Success

{ "success": true }

Error

Code	Message
0	account expired
1	script update required

Getting sessions

POST /scripts/:script_id/sessions

Parameters

Name	Type	Description
script_id	String	The scripts id

Body

Name	Type	Nullable	Description
from	Number	✅	Start index for list
limit	Number	✅	Amount of sessions to return

Response

Success

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

Filtering sessions

GET /scripts/:script_id/sessions/filter

Parameters

Name	Type	Description
script_id	String	The scripts id

Queries

Name	Type	Nullable	Description
from	Number	✅	Start index for list
limit	Number	✅	Amount of sessions to return
key	String	✅	User key session must have
roblox_id	String	✅	Roblox id of the session
place_id	String	✅	Place id session must be in
job_id	String	✅	Job id session must be in

Response

Success

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

Error

Code	Message
0	must filter something