---
updatedAt: 2025-03-08T01:23:29.000Z
agentTools:
  projectIndex: https://docs.cybercloudnetworks.net/v1.1/llms.txt
---

# Get the status of an scanned file

Get the current scanning status for the file referenced by the provided dataid

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "description": "API Scan",
    "version": "1.0.0",
    "title": "API Scan"
  },
  "paths": {
    "/getstatus": {
      "get": {
        "summary": "Get the status of an scanned file",
        "description": "Get the current scanning status for the file referenced by the provided dataid",
        "operationId": "getstatus",
        "parameters": [
          {
            "in": "header",
            "name": "apikey",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "header",
            "name": "responsetype",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "header",
            "name": "dataid",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Upload success confirmation",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/FinalStatusObject"
                }
              }
            }
          },
          "401": {
            "description": "Invalid credentials (actual http code is 200)",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/401ErrorObject"
                }
              }
            }
          }
        }
      }
    }
  },
  "servers": [
    {
      "url": "https://clouddmax.cybercloudnetworks.net:9012"
    }
  ],
  "components": {
    "schemas": {
      "FinalStatusObject": {
        "type": "object",
        "properties": {
          "status": {
            "type": "integer",
            "description": "Value is always 100 because the method only responses when n further action is possible",
            "default": 100
          },
          "result": {
            "type": "integer",
            "description": "Return code 0 meaning success, 2000 blocked, and 3000 failed. It also can reply an http code for invalid credentials, request or internal server error."
          },
          "cdr": {
            "type": "boolean",
            "description": "Return true only if the file was moved to CDR"
          },
          "description": {
            "type": "string",
            "description": "Error|Not threat detected| \\<Reason for being blocked\\> (string)"
          },
          "filename": {
            "type": "string",
            "description": "Filename if available, empty string otherwise"
          }
        }
      },
      "ErrorObject": {
        "type": "object",
        "properties": {
          "status": {
            "type": "integer",
            "description": "100",
            "default": 100
          },
          "result": {
            "type": "integer",
            "description": "Returns the http error code",
            "default": "401 (401, 404, 500, etc, the error code)"
          },
          "description": {
            "type": "string",
            "description": "Error",
            "default": "Error"
          },
          "filename": {
            "type": "string",
            "description": "",
            "default": ""
          }
        }
      },
      "401ErrorObject": {
        "allOf": [
          {
            "$ref": "#/components/schemas/ErrorObject"
          }
        ],
        "properties": {
          "result": {
            "type": "integer",
            "description": "Returns the http error code",
            "default": 401
          }
        }
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```