{"id":16842460,"url":"https://github.com/psypherpunk/clamav-api","last_synced_at":"2026-02-25T05:33:35.135Z","repository":{"id":76756996,"uuid":"248323112","full_name":"PsypherPunk/clamav-api","owner":"PsypherPunk","description":"HTTP API to ClamAV.","archived":false,"fork":false,"pushed_at":"2025-01-14T14:05:44.000Z","size":154,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-24T12:03:57.268Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/PsypherPunk.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-03-18T19:23:37.000Z","updated_at":"2025-01-14T14:05:47.000Z","dependencies_parsed_at":"2024-02-26T06:30:01.937Z","dependency_job_id":"29dfc100-ef5f-4de7-80d8-bb6d0747fb2a","html_url":"https://github.com/PsypherPunk/clamav-api","commit_stats":null,"previous_names":[],"tags_count":59,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PsypherPunk%2Fclamav-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PsypherPunk%2Fclamav-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PsypherPunk%2Fclamav-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PsypherPunk%2Fclamav-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/PsypherPunk","download_url":"https://codeload.github.com/PsypherPunk/clamav-api/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248225658,"owners_count":21068078,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-13T12:46:14.510Z","updated_at":"2026-02-25T05:33:30.101Z","avatar_url":"https://github.com/PsypherPunk.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# `clamav-api`\n\nHTTP API on a `clamd` instance.\n\n## `docker build`\n\nTo build a Docker image:\n\n```bash\ndocker build --tag clamav-rest .\n```\n\n## `docker run`\n\nTo run the service:\n\n```bash\ndocker run \\\n    --rm \\\n    --interactive \\\n    --tty \\\n    --publish 8000:8000 \\\n    clamav-rest\n```\n\nAfter which, the service will start the `clamd` daemon and in turn,\nthe API:\n\n```bash\n[ ok ] Starting ClamAV daemon: clamd .\n[2020-03-18 13:35:58 +0000] [1] [INFO] Starting gunicorn 20.0.4\n[2020-03-18 13:35:58 +0000] [1] [INFO] Listening at: http://0.0.0.0:8000 (1)\n[2020-03-18 13:35:58 +0000] [1] [INFO] Using worker: sync\n[2020-03-18 13:35:58 +0000] [371] [INFO] Booting worker with pid: 371\n```\n\n## OpenAPI\n\nThe OpenAPI definition will be available at \u003chttp://0.0.0.0:8000/docs\u003e.\n\nThis should be largely functional, though the `/instream` endpoint\nexpects binary data and may not work with the web interface. However,\nyou can verify the behaviour with `curl` and the\n[EICAR Anti-Virus Test File](https://en.wikipedia.org/wiki/EICAR_test_file):\n\n```bash\ncurl --include \\\n    --request POST \\\n    --header 'Content-Type: application/octet-stream' \\\n    --header 'Accept: application/json' \\\n    --data @eicar_test_file.txt \\\n    http://0.0.0.0:8000/instream\n```\n\nYou should then receive a positive response:\n\n```bash\n{\n  \"output\": \"stream: Win.Test.EICAR_HDB-1 FOUND\"\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpsypherpunk%2Fclamav-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpsypherpunk%2Fclamav-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpsypherpunk%2Fclamav-api/lists"}