# cloudmersive_virus_api_client
The Cloudmersive Virus Scan API lets you scan files and content for viruses and identify security issues with content.
This Python package provides a native API client for [Cloudmersive Anti-Virus Scan API](https://www.cloudmersive.com/virus-api)
- API version: v1
- Package version: 3.2.0
- Build package: io.swagger.codegen.languages.PythonClientCodegen
## Requirements.
Python 2.7 and 3.4+
## Installation & Usage
### pip install
If the python package is hosted on Github, you can install directly from Github
```sh
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)
Then import the package:
```python
import cloudmersive_virus_api_client
```
### Setuptools
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)
Then import the package:
```python
import cloudmersive_virus_api_client
```
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
from __future__ import print_function
import time
import cloudmersive_virus_api_client
from cloudmersive_virus_api_client.rest import ApiException
from pprint import pprint
# Configure API key authorization: Apikey
configuration = cloudmersive_virus_api_client.Configuration()
configuration.api_key['Apikey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Apikey'] = 'Bearer'
# create an instance of the API class
api_instance = cloudmersive_virus_api_client.ScanApi(cloudmersive_virus_api_client.ApiClient(configuration))
input_file = '/path/to/file.txt' # file | Input file to perform the operation on.
try:
# Scan a file for viruses
api_response = api_instance.scan_file(input_file)
pprint(api_response)
except ApiException as e:
print("Exception when calling ScanApi->scan_file: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to *https://api.cloudmersive.com*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*ScanApi* | [**scan_file**](docs/ScanApi.md#scan_file) | **POST** /virus/scan/file | Scan a file for viruses
*ScanApi* | [**scan_file_advanced**](docs/ScanApi.md#scan_file_advanced) | **POST** /virus/scan/file/advanced | Advanced Scan a file for viruses
*ScanApi* | [**scan_website**](docs/ScanApi.md#scan_website) | **POST** /virus/scan/website | Scan a website for malicious content and threats
*ScanCloudStorageApi* | [**scan_cloud_storage_scan_aws_s3_file**](docs/ScanCloudStorageApi.md#scan_cloud_storage_scan_aws_s3_file) | **POST** /virus/scan/cloud-storage/aws-s3/single | Scan an AWS S3 file for viruses
*ScanCloudStorageApi* | [**scan_cloud_storage_scan_aws_s3_file_advanced**](docs/ScanCloudStorageApi.md#scan_cloud_storage_scan_aws_s3_file_advanced) | **POST** /virus/scan/cloud-storage/aws-s3/single/advanced | Advanced Scan an AWS S3 file for viruses
*ScanCloudStorageApi* | [**scan_cloud_storage_scan_azure_blob**](docs/ScanCloudStorageApi.md#scan_cloud_storage_scan_azure_blob) | **POST** /virus/scan/cloud-storage/azure-blob/single | Scan an Azure Blob for viruses
*ScanCloudStorageApi* | [**scan_cloud_storage_scan_azure_blob_advanced**](docs/ScanCloudStorageApi.md#scan_cloud_storage_scan_azure_blob_advanced) | **POST** /virus/scan/cloud-storage/azure-blob/single/advanced | Advanced Scan an Azure Blob for viruses
*ScanCloudStorageApi* | [**scan_cloud_storage_scan_gcp_storage_file**](docs/ScanCloudStorageApi.md#scan_cloud_storage_scan_gcp_storage_file) | **POST** /virus/scan/cloud-storage/gcp-storage/single | Scan an Google Cloud Platform (GCP) Storage file for viruses
*ScanCloudStorageApi* | [**scan_cloud_storage_scan_gcp_storage_file_advanced**](docs/ScanCloudStorageApi.md#scan_cloud_storage_scan_gcp_storage_file_advanced) | **POST** /virus/scan/cloud-storage/gcp-storage/single/advanced | Advanced Scan an Google Cloud Platform (GCP) Storage file for viruses
*ScanCloudStorageApi* | [**scan_cloud_storage_scan_share_point_online_file**](docs/ScanCloudStorageApi.md#scan_cloud_storage_scan_share_point_online_file) | **POST** /virus/scan/cloud-storage/sharepoint-online/site/single | Virus Scan a file in a SharePoint Online Site Drive
*ScanCloudStorageApi* | [**scan_cloud_storage_scan_share_point_online_file_advanced**](docs/ScanCloudStorageApi.md#scan_cloud_storage_scan_share_point_online_file_advanced) | **POST** /virus/scan/cloud-storage/sharepoint-online/site/advanced | Advanced Virus Scan a file in a SharePoint Online Site Drive
## Documentation For Models
- [AdditionalAdvancedScanInformation](docs/AdditionalAdvancedScanInformation.md)
- [CloudStorageAdvancedVirusScanResult](docs/CloudStorageAdvancedVirusScanResult.md)
- [CloudStorageVirusFound](docs/CloudStorageVirusFound.md)
- [CloudStorageVirusScanResult](docs/CloudStorageVirusScanResult.md)
- [VirusFound](docs/VirusFound.md)
- [VirusScanAdvancedResult](docs/VirusScanAdvancedResult.md)
- [VirusScanResult](docs/VirusScanResult.md)
- [WebsiteScanRequest](docs/WebsiteScanRequest.md)
- [WebsiteScanResult](docs/WebsiteScanResult.md)
## Documentation For Authorization
## Apikey
- **Type**: API key
- **API key parameter name**: Apikey
- **Location**: HTTP header
## Author
Raw data
{
"_id": null,
"home_page": "https://www.cloudmersive.com/virus-api",
"name": "cloudmersive-virus-api-client",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "Swagger,virusapi",
"author": "",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/57/f0/6cf1ef7dc60c92153ce5ad0ff48fdce6168e7c0237ee40e9a624f2c2ce36/cloudmersive_virus_api_client-3.2.0.tar.gz",
"platform": null,
"description": "# cloudmersive_virus_api_client\nThe Cloudmersive Virus Scan API lets you scan files and content for viruses and identify security issues with content.\n\nThis Python package provides a native API client for [Cloudmersive Anti-Virus Scan API](https://www.cloudmersive.com/virus-api)\n\n- API version: v1\n- Package version: 3.2.0\n- Build package: io.swagger.codegen.languages.PythonClientCodegen\n\n## Requirements.\n\nPython 2.7 and 3.4+\n\n## Installation & Usage\n### pip install\n\nIf the python package is hosted on Github, you can install directly from Github\n\n```sh\npip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git\n```\n(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)\n\nThen import the package:\n```python\nimport cloudmersive_virus_api_client \n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n(or `sudo python setup.py install` to install the package for all users)\n\nThen import the package:\n```python\nimport cloudmersive_virus_api_client\n```\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\nfrom __future__ import print_function\nimport time\nimport cloudmersive_virus_api_client\nfrom cloudmersive_virus_api_client.rest import ApiException\nfrom pprint import pprint\n\n# Configure API key authorization: Apikey\nconfiguration = cloudmersive_virus_api_client.Configuration()\nconfiguration.api_key['Apikey'] = 'YOUR_API_KEY'\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['Apikey'] = 'Bearer'\n\n# create an instance of the API class\napi_instance = cloudmersive_virus_api_client.ScanApi(cloudmersive_virus_api_client.ApiClient(configuration))\ninput_file = '/path/to/file.txt' # file | Input file to perform the operation on.\n\ntry:\n # Scan a file for viruses\n api_response = api_instance.scan_file(input_file)\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling ScanApi->scan_file: %s\\n\" % e)\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://api.cloudmersive.com*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*ScanApi* | [**scan_file**](docs/ScanApi.md#scan_file) | **POST** /virus/scan/file | Scan a file for viruses\n*ScanApi* | [**scan_file_advanced**](docs/ScanApi.md#scan_file_advanced) | **POST** /virus/scan/file/advanced | Advanced Scan a file for viruses\n*ScanApi* | [**scan_website**](docs/ScanApi.md#scan_website) | **POST** /virus/scan/website | Scan a website for malicious content and threats\n*ScanCloudStorageApi* | [**scan_cloud_storage_scan_aws_s3_file**](docs/ScanCloudStorageApi.md#scan_cloud_storage_scan_aws_s3_file) | **POST** /virus/scan/cloud-storage/aws-s3/single | Scan an AWS S3 file for viruses\n*ScanCloudStorageApi* | [**scan_cloud_storage_scan_aws_s3_file_advanced**](docs/ScanCloudStorageApi.md#scan_cloud_storage_scan_aws_s3_file_advanced) | **POST** /virus/scan/cloud-storage/aws-s3/single/advanced | Advanced Scan an AWS S3 file for viruses\n*ScanCloudStorageApi* | [**scan_cloud_storage_scan_azure_blob**](docs/ScanCloudStorageApi.md#scan_cloud_storage_scan_azure_blob) | **POST** /virus/scan/cloud-storage/azure-blob/single | Scan an Azure Blob for viruses\n*ScanCloudStorageApi* | [**scan_cloud_storage_scan_azure_blob_advanced**](docs/ScanCloudStorageApi.md#scan_cloud_storage_scan_azure_blob_advanced) | **POST** /virus/scan/cloud-storage/azure-blob/single/advanced | Advanced Scan an Azure Blob for viruses\n*ScanCloudStorageApi* | [**scan_cloud_storage_scan_gcp_storage_file**](docs/ScanCloudStorageApi.md#scan_cloud_storage_scan_gcp_storage_file) | **POST** /virus/scan/cloud-storage/gcp-storage/single | Scan an Google Cloud Platform (GCP) Storage file for viruses\n*ScanCloudStorageApi* | [**scan_cloud_storage_scan_gcp_storage_file_advanced**](docs/ScanCloudStorageApi.md#scan_cloud_storage_scan_gcp_storage_file_advanced) | **POST** /virus/scan/cloud-storage/gcp-storage/single/advanced | Advanced Scan an Google Cloud Platform (GCP) Storage file for viruses\n*ScanCloudStorageApi* | [**scan_cloud_storage_scan_share_point_online_file**](docs/ScanCloudStorageApi.md#scan_cloud_storage_scan_share_point_online_file) | **POST** /virus/scan/cloud-storage/sharepoint-online/site/single | Virus Scan a file in a SharePoint Online Site Drive\n*ScanCloudStorageApi* | [**scan_cloud_storage_scan_share_point_online_file_advanced**](docs/ScanCloudStorageApi.md#scan_cloud_storage_scan_share_point_online_file_advanced) | **POST** /virus/scan/cloud-storage/sharepoint-online/site/advanced | Advanced Virus Scan a file in a SharePoint Online Site Drive\n\n\n## Documentation For Models\n\n - [AdditionalAdvancedScanInformation](docs/AdditionalAdvancedScanInformation.md)\n - [CloudStorageAdvancedVirusScanResult](docs/CloudStorageAdvancedVirusScanResult.md)\n - [CloudStorageVirusFound](docs/CloudStorageVirusFound.md)\n - [CloudStorageVirusScanResult](docs/CloudStorageVirusScanResult.md)\n - [VirusFound](docs/VirusFound.md)\n - [VirusScanAdvancedResult](docs/VirusScanAdvancedResult.md)\n - [VirusScanResult](docs/VirusScanResult.md)\n - [WebsiteScanRequest](docs/WebsiteScanRequest.md)\n - [WebsiteScanResult](docs/WebsiteScanResult.md)\n\n\n## Documentation For Authorization\n\n\n## Apikey\n\n- **Type**: API key\n- **API key parameter name**: Apikey\n- **Location**: HTTP header\n\n\n## Author",
"bugtrack_url": null,
"license": "",
"summary": "virusapi",
"version": "3.2.0",
"project_urls": {
"Homepage": "https://www.cloudmersive.com/virus-api"
},
"split_keywords": [
"swagger",
"virusapi"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "57f06cf1ef7dc60c92153ce5ad0ff48fdce6168e7c0237ee40e9a624f2c2ce36",
"md5": "398309800a2a3cce899c4c9f44d4114a",
"sha256": "b114a3040c39d8a79c283a608451cc2a83e97cfe09ae124f10f4dffa4ca683d3"
},
"downloads": -1,
"filename": "cloudmersive_virus_api_client-3.2.0.tar.gz",
"has_sig": false,
"md5_digest": "398309800a2a3cce899c4c9f44d4114a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 29651,
"upload_time": "2023-12-10T22:20:19",
"upload_time_iso_8601": "2023-12-10T22:20:19.219226Z",
"url": "https://files.pythonhosted.org/packages/57/f0/6cf1ef7dc60c92153ce5ad0ff48fdce6168e7c0237ee40e9a624f2c2ce36/cloudmersive_virus_api_client-3.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-10 22:20:19",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "cloudmersive-virus-api-client"
}
JSON