File

The File endpoint allows you to get a list of all files, and delete or retrieve details of a specific file.

Get a list of files.

GET https://api.halosecurity.com/api/v1/file/list.json

Returns a paginated list of files.

https://www.halosecurity.com/user/security/report/files

Query Parameters

Name	Type	Description
sort	Integer	0= created date (default)
sort_desc	Integer	0 = No (default) 1 = Yes

200: OK

{
    "list": [
        {
            "content_type": "application/pdf",
            "ready": 1,
            "file_name": "test.pdf",
            "file_id": "id1",
            "checksum_md5": "3cc6424d1d01d886f96770983e125fc5",
            "description": "",
            "folder": "",
            "date_created": "0000-00-00 00:00",
            "date_delete": "0000-00-00 00:00", 
            "file_size": 163637,
            "url": "https://www.halosecurity.com/static/dl?do=company-file&t=0&id=id1"
        }
    ]
}

Get the details of a file.

GET https://api.halosecurity.com/api/v1/file/get.json

Returns the details of a file.

https://www.halosecurity.com/user/security/report/files

Query Parameters

Name	Type	Description
file_id*	String
	String

200: OK

{
    "file": {
        "content_type": "application/pdf",
        "ready": 1,
        "file_name": "test.pdf",
        "file_id": "id1",
        "checksum_md5": "3cc6424d1d01d886f96770983e125fc5",
        "description": "",
        "created_date": "0000-00-00 00:00",
        "file_size": 163637,
        "url": "/static/dl?do=company-file&t=0&id=id1"
    }
}

400: Bad Request

{
    "code": 0,
    "message": "file_id required"
}

400: Bad Request

{
    "code": 0,
    "message": "file_id not valid"
}

404: Not Found

{
    "code": 0,
    "message": "file not found"
}

Delete a file

GET https://api.halosecurity.com/api/v1/file/delete.json

Returns the file deletion status.

https://www.halosecurity.com/user/security/report/files

Query Parameters

Name	Type	Description
file_id*	String

200: OK

{
    "success": 1
}

400: Bad Request

{
    "code": 0,
    "message": "file_id not valid"
}

404: Not Found

{
    "code": 0,
    "message": "file not found"
}

List Folders

GET https://api.halosecurity.com/api/v1/file/folder-list.json

Returns a list of folders.

https://www.halosecurity.com/user/security/report/folders