API Documentation

This page contains the API Requests of Malwation CDR

If you have any further questions, feel free to ask it this email: [e-mail]

If you want to access Swagger docs, navigate to /docs in your CDR url. And also, if you want to get the JSON of the Swagger file, navigate to /docs-json.

Every page in this documentation, like Start Submisssion has the OpenAPI Documentation of the request and an Example Response.

Status IDs & Explanations

{
    "status": 1 // Received -> Submission is received from the server, but not finished yet
    "status": 2 // Finished -> Submission is finished and the "result" key is set with the result of the submission
}

Example Result of a Finished Submission

{
	"type": "file",
	"name": "sample.docx",
	"fileId": "58b46901099bd149b6a9c186ddd5394e2d98cfafdecd179bc428e89c01303a2b",
	"resultId": "a3d68330-4155-469c-a393-beaa645015da",
	"size": 46516,
	"hashes": {
		"sha256": "58b46901099bd149b6a9c186ddd5394e2d98cfafdecd179bc428e89c01303a2b",
		"sha1": "35d4cdeea9bf51902ca268af911c9d527af3d35e",
		"md5": "480f4b4ffb6cca1b872cf55329a8881e"
	},
	"status": 2,
	"level": 0,
	"files": [
		{
			"name": "58b46901099bd149b6a9c186ddd5394e2d98cfafdecd179bc428e89c01303a2b_sanitized.docx",
			"id": "336ccc96-286c-4a12-afce-4efe2f8fdba4"
		}
	],
	"message": "Submission is finished",
	"result": {
		"filename": "58b46901099bd149b6a9c186ddd5394e2d98cfafdecd179bc428e89c01303a2b_sanitized.docx",
		"log": {
			"description": "File sanitized successfully.",
			"removed": [
				"Metadata"
			],
			"sanitized": [
				"Image"
			],
			"processing time": "7.50170 seconds"
		}
	}
}

Start SubmissionListen SubmissionDownload Sanitized File