---
updatedAt: 2025-03-08T01:26:02.000Z
agentTools:
  projectIndex: https://docs.cybercloudnetworks.net/llms.txt
---

# Asynchronic scan receiving a base64 encoded file

receives a base64 encoded file, scans it and returns a file identifier

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "description": "API Scan",
    "version": "1.0.0",
    "title": "API Scan"
  },
  "paths": {
    "/avbase64": {
      "post": {
        "summary": "Asynchronic scan receiving a base64 encoded file",
        "description": "receives a base64 encoded file, scans it and returns a file identifier",
        "parameters": [
          {
            "in": "header",
            "name": "APIKEY",
            "required": true,
            "description": "",
            "schema": {
              "type": "string"
            }
          },
          {
            "in": "header",
            "name": "Content-type",
            "required": true,
            "description": "Value MUST be application/json for this to work otherwise the response will be a code 500 error",
            "schema": {
              "type": "string",
              "default": "application/json"
            }
          },
          {
            "in": "header",
            "name": "downloadonsuccess",
            "required": false,
            "description": "Except sent as true the base64 encoded file will not be returned as part od the response",
            "schema": {
              "type": "boolean",
              "default": false
            }
          }
        ],
        "requestBody": {
          "$ref": "#/components/requestBodies/File"
        },
        "responses": {
          "200": {
            "description": "Returns the data_id needed for further queries or download the clean file",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data_id": {
                      "type": "string",
                      "description": "hash for further request of the scan result"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Invalid credentials",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/401ErrorObject"
                }
              }
            }
          }
        }
      }
    }
  },
  "servers": [
    {
      "url": "https://clouddmax.cybercloudnetworks.net"
    }
  ],
  "components": {
    "requestBodies": {
      "File": {
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "required": [
                "filename",
                "file"
              ],
              "properties": {
                "filename": {
                  "type": "string",
                  "description": "Name of the file (extension included)"
                },
                "file": {
                  "type": "string",
                  "description": "Base64 encoded file"
                }
              }
            }
          }
        },
        "description": "The user to create."
      }
    },
    "schemas": {
      "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
  }
}
```