Projects

This page shows you how to interact with your projects using our API

Quick Tips

Project names cannot exceed a length of 30 and they must have a minimum length of 3, they also cannot contain any special characters

The allowed_exploits object is structured as the following: { synapse_x: Boolean, script_ware: Boolean, synapse_v3: Boolean }

Get Projects

GET https://api.luashield.com/projects/

This will return all projects you own.

Headers

Name	Type	Description
LuaShield-API-Key*	String	API Key

200: OK Success

[
	{
		"id": "1e23e699-d4b1-458e-add0-1745b733e7ab",
		"Executions": 1,
		"CrackAttempts": 0,
		"Users": 1,
		"Name": "Test23",
		"SuccessWebhook": "https://discord.com/api/webhooks/107954407617...",
		"BlacklistWebhook": "https://discord.com/api/webhooks/107954414352...",
		"UnauthorizedWebhook": "https://discord.com/api/webhooks/107954420517...",
		"Online": true,
		"SynapseX": true,
		"ScriptWare": false,
		"SynapseV3": true,
		"Scripts": [
			{
				"id": "a4954534-6e03-4095-8a4a-90f0d831e614",
				"Name": "dsf likes men",
				"ProjectID": "1e23e699-d4b1-458e-add0-1745b733e7ab",
				"Version": "v1.0.0",
				"Versions": [
					"v1.0.0"
				]
			}
		]
	},
	{
		"id": "44536b5a-74ad-461a-a36e-001518022321",
		"Executions": 0,
		"CrackAttempts": 0,
		"Users": 0,
		"Name": "LuaShield Internal",
		"SuccessWebhook": "https://discord.com/api/webhooks/107954407617...",
		"BlacklistWebhook": "https://discord.com/api/webhooks/107954...",
		"UnauthorizedWebhook": "https://discord.com/api/webhooks/107954420517...",
		"Online": true,
		"SynapseX": true,
		"ScriptWare": false,
		"SynapseV3": true,
		"Scripts": []
	}
]

401: Unauthorized Invalid API Key

{
    "error": "Invalid API Key"
}

402: Payment Required Subscription Expired

{
    "error": "Your subscription has expired"
}

Get Project

GET https://api.luashield.com/projects/:project_id

Get information about a specific project

Path Parameters

Name	Type	Description
project_id*	String	The ID of the project

Headers

Name	Type	Description
LuaShield-API-Key*	String	API Key

200: OK Success

{
	"id": "3851df88-139e-4e1d-8229-02ed58595e9b",
	"Executions": 0,
	"CrackAttempts": 0,
	"Users": 0,
	"Name": "LuaShield Internal",
	"SuccessWebhook": "https://discord.com/api/webhooks/...",
	"BlacklistWebhook": "https://discord.com/api/webhooks/10...vbx0z0mN0KyEt7lqLMk-Rxee3z",
	"UnauthorizedWebhook": "https://discord.com/api/webhooks/10...ssGCapVSR1P3uGfFrOC",
	"Online": true,
	"SynapseX": true,
	"ScriptWare": false,
	"SynapseV3": true,
	"Scripts": []
}

401: Unauthorized Invalid API Key

{
    "error": "Invalid API Key"
}

404: Not Found Project doesn't exist

{
    "error": "This project doesn't exist"
}

403: Forbidden You don't own this project

{
    "error": "You don't own this project"
}

402: Payment Required Subscription Expired

{
    "error": "Your subscription has expired"
}

Make Project

This endpoint has a limit of 5 requests per minute

POST https://api.luashield.com/projects

Make a project

Headers

Name	Type	Description
LuaShield-API-Key*	String	API Key

Request Body

Name	Type	Description
name*	String	Project Name
success_webhook*	String	Success Webhook
blacklist_webhook*	String	Blacklist Webhook
unauthorized_webhook*	String	Unauthorized Webhook
allowed_exploits*	Object	Choose what exploits to limit your project to

200: OK Created project

{
	"id": "3851df88-139e-4e1d-8229-02ed58595e9b",
	"Executions": 0,
	"CrackAttempts": 0,
	"Users": 0,
	"Name": "LuaShield Internal",
	"SuccessWebhook": "https://discord.com/api/webhooks/1079544076178829412/SLB0",
	"BlacklistWebhook": "https://discord.com/api/webhooks/1079544143526760470/nmRxee3z",
	"UnauthorizedWebhook": "https://discord.com/api/webhooks//Ej4LbEluR5JssGCapVSR1P3uGfFrOC",
	"Online": true,
	"SynapseX": true,
	"ScriptWare": false,
	"SynapseV3": true
}

403: Forbidden Reached maximum projects

{
    "error": "You have reached your maximum amount of projects for your account"
}

402: Payment Required Subscription Expired

{
    "error": "Your subscription has expired"
}

Update Project

This endpoint has a limit of 5 requests per minute

PATCH https://api.luashield.com/projects/:project_id

Update a project

Path Parameters

Name	Type	Description
project_id*	String	ID of the project

Headers

Name	Type	Description
LuaShield-API-Key*	String	API Key

Request Body

Name	Type	Description
name*	String	Project Name
success_webhook	String	Success Webhook
blacklist_webhook	String	Blacklist Webhook
unauthorized_webhook	String	Unauthorized Webhook
allowed_exploits	Object	Choose which exploits have access
Online	Boolean	Project Online

200: OK Successfully updated

{
	"id": "3851df88-139e-4e1d-8229-02ed58595e9b",
	"Executions": 0,
	"CrackAttempts": 0,
	"Users": 0,
	"Name": "LuaShield Internal",
	"SuccessWebhook": "https://discord.com/api/webhooks/1079544076178829412/SLB0",
	"BlacklistWebhook": "https://discord.com/api/webhooks/1079544143526760470/nmRxee3z",
	"UnauthorizedWebhook": "https://discord.com/api/webhooks//Ej4LbEluR5JssGCapVSR1P3uGfFrOC",
	"Online": true,
	"SynapseX": true,
	"ScriptWare": false,
	"SynapseV3": true
}

404: Not Found Project doesn't exist

{
    "error": "This project doesn't exist"
}

403: Forbidden Project isn't owned by you

{
    "error": "This project isn't owned by you"
}

402: Payment Required Subscription Expired

{
    "error": "Your subscription has expired"
}

Delete Project

DELETE https://api.luashield.com/projects/:project_id

Delete a project

Headers

Name	Type	Description
LuaShield-API-Key*	String	API Key

200: OK Success

{
	"success": true
}

404: Not Found Project doesn't exist

{
    "error": "This project doesn't exist"
}

403: Forbidden Project isn't owned by you

{
    "error": "This project isn't owned by you"
}

402: Payment Required Subscription Expired

{
    "error": "Your subscription has expired"
}