Upload Project

To upload a project, you need to initiate a GET request to the following URL, with 'fileName' as the input parameter. GET https://shield-api.quillai.network/api/v1/projects/upload/url

200 Project Url Fetched

{
    "uploadUrl": "https://shield-dev-project-files.s3.ap-south-1.amazonaws.com/Project-235b374cb8647ab9df9ade037f896b45-abc.zip?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIAXEQYZVJYL32YLXEH%2F20240826%2Fap-south-1%2Fs3%2Faws4_request&X-Amz-Date=20240826T080541Z&X-Amz-Expires=300&X-Amz-Signature=00a6df0911ba3025e8bcd5d31800bfb7e8bdbd904eef880e0587e58346d68849&X-Amz-SignedHeaders=host&x-id=PutObject",
    "uploadId": "Project-235b374cb8647ab9df9ade037f896b45-abc.zip"
}

400 Bad Request

{
    "message": "must have required property 'fileName'"
}

The resulting "uploadUrl" from the API is where you'll be uploading all your files to, in the form of a 'PUT' request. The files must strictly either be either zip archives or solidity contracts.

Query Parameters

Parameter	Description	Data Type	Requirement
fileName	Name of file to be uploaded along with filetype ( .sol or .zip)	String	Required

Response Codes

Responses	Description
🟢 200	Success
🟠 400	Error
🔴 401	Unauthorised

Sample Response

{
    "uploadUrl": "https://shield-dev-project-files.s3.ap-south-1.amazonaws.com/Project-235b374cb8647ab9df9ade037f896b45-abc.zip?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIAXEQYZVJYL32YLXEH%2F20240826%2Fap-south-1%2Fs3%2Faws4_request&X-Amz-Date=20240826T080541Z&X-Amz-Expires=300&X-Amz-Signature=00a6df0911ba3025e8bcd5d31800bfb7e8bdbd904eef880e0587e58346d68849&X-Amz-SignedHeaders=host&x-id=PutObject",
    "uploadId": "Project-235b374cb8647ab9df9ade037f896b45-abc.zip"
}