Script endpoints

Endpoints relating to scripts

Getting a script

GET /scripts/:script_id

Params:

Key	Description
script_id	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

Params:

Key	Description
script_id	The scripts id

Response:

Success

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

Editing a script

POST /scripts/:script_id/edit

Params:

Key	Description
script_id	The scripts id

Payload:

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

Response:

Success Error

{ "success": true }

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

Deleting a script

POST /scripts/:script_id/remove

Params:

Key	Description
script_id	The scripts id

Response:

Success

{ "success": true }

Updating a script

POST /scripts/:script_id/update

Params:

Key	Description
script_id	The scripts id

Payload:

Key	Type	Required
script	`String`	`True`

Response:

Success Error

{ "success": true }

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

Params:

Key	Description
script_id	The scripts id

Payload:

Key	Type	Required
state	`Boolean`	`True`

Response:

Success Error

{ "success": true }

Code	Message
0	account expired
1	script update required

Getting sessions

GET /scripts/:script_id/sessions

Params:

Key	Description
script_id	The scripts 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 /scripts/:script_id/sessions/filter

Params:

Key	Description
script_id	The scripts id

Queries:

Key	Type	Required	Default
from	`Number`	`False`	`0`
limit	`Number`	`False`	`∞`
key	`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 script Getting executions Editing a script Deleting a script Updating a script Toggling a script Getting sessions Filtering sessions