-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
2c68b1a
commit f855173
Showing
22 changed files
with
974 additions
and
22 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| # CloudmersiveVirusApiClient.CloudStorageVirusFound | ||
|
|
||
| ## Properties | ||
| Name | Type | Description | Notes | ||
| ------------ | ------------- | ------------- | ------------- | ||
| **fileName** | **String** | Name of the file containing the virus | [optional] | ||
| **virusName** | **String** | Name of the virus that was found | [optional] | ||
|
|
||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| # CloudmersiveVirusApiClient.CloudStorageVirusScanResult | ||
|
|
||
| ## Properties | ||
| Name | Type | Description | Notes | ||
| ------------ | ------------- | ------------- | ------------- | ||
| **successful** | **Boolean** | True if the operation of retrieving the file, and scanning it were successfully completed, false if the file could not be downloaded from cloud storage, or if the file could not be scanned. Note that successful completion does not mean the file is clean; for the output of the virus scanning operation itself, use the CleanResult and FoundViruses parameters. | [optional] | ||
| **cleanResult** | **Boolean** | True if the scan contained no viruses, false otherwise | [optional] | ||
| **foundViruses** | [**[CloudStorageVirusFound]**](CloudStorageVirusFound.md) | Array of viruses found, if any | [optional] | ||
| **errorDetailedDescription** | **String** | Detailed error message if the operation was not successful | [optional] | ||
| **fileSize** | **Number** | Size in bytes of the file that was retrieved and scanned | [optional] | ||
|
|
||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,194 @@ | ||
| # CloudmersiveVirusApiClient.ScanCloudStorageApi | ||
|
|
||
| All URIs are relative to *https://api.cloudmersive.com* | ||
|
|
||
| Method | HTTP request | Description | ||
| ------------- | ------------- | ------------- | ||
| [**scanCloudStorageScanAwsS3File**](ScanCloudStorageApi.md#scanCloudStorageScanAwsS3File) | **POST** /virus/scan/cloud-storage/aws-s3/single | Scan an AWS S3 file for viruses | ||
| [**scanCloudStorageScanAzureBlob**](ScanCloudStorageApi.md#scanCloudStorageScanAzureBlob) | **POST** /virus/scan/cloud-storage/azure-blob/single | Scan an Azure Blob for viruses | ||
| [**scanCloudStorageScanGcpStorageFile**](ScanCloudStorageApi.md#scanCloudStorageScanGcpStorageFile) | **POST** /virus/scan/cloud-storage/gcp-storage/single | Scan an Google Cloud Platform (GCP) Storage file for viruses | ||
|
|
||
|
|
||
| <a name="scanCloudStorageScanAwsS3File"></a> | ||
| # **scanCloudStorageScanAwsS3File** | ||
| > CloudStorageVirusScanResult scanCloudStorageScanAwsS3File(accessKey, secretKey, bucketRegion, bucketName, keyName) | ||
| Scan an AWS S3 file for viruses | ||
|
|
||
| Scan the contents of a single AWS S3 file and its content for viruses. Leverage continuously updated signatures for millions of threats, and advanced high-performance scanning capabilities. Over 17 million virus and malware signatures. Continuous cloud-based updates. Wide file format support including Office, PDF, HTML, Flash. Zip support including .Zip, .Rar, .DMG, .Tar, and other archive formats. Multi-threat scanning across viruses, malware, trojans, ransomware, and spyware. High-speed in-memory scanning delivers subsecond typical response time. | ||
|
|
||
| ### Example | ||
| ```javascript | ||
| var CloudmersiveVirusApiClient = require('cloudmersive-virus-api-client'); | ||
| var defaultClient = CloudmersiveVirusApiClient.ApiClient.instance; | ||
|
|
||
| // Configure API key authorization: Apikey | ||
| var Apikey = defaultClient.authentications['Apikey']; | ||
| Apikey.apiKey = 'YOUR API KEY'; | ||
| // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) | ||
| //Apikey.apiKeyPrefix = 'Token'; | ||
|
|
||
| var apiInstance = new CloudmersiveVirusApiClient.ScanCloudStorageApi(); | ||
|
|
||
| var accessKey = "accessKey_example"; // String | AWS S3 access key for the S3 bucket; you can get this from My Security Credentials in the AWS console | ||
|
|
||
| var secretKey = "secretKey_example"; // String | AWS S3 secret key for the S3 bucket; you can get this from My Security Credentials in the AWS console | ||
|
|
||
| var bucketRegion = "bucketRegion_example"; // String | Name of the region of the S3 bucket, such as 'US-East-1' | ||
|
|
||
| var bucketName = "bucketName_example"; // String | Name of the S3 bucket | ||
|
|
||
| var keyName = "keyName_example"; // String | Key name (also called file name) of the file in S3 that you wish to scan for viruses | ||
|
|
||
|
|
||
| var callback = function(error, data, response) { | ||
| if (error) { | ||
| console.error(error); | ||
| } else { | ||
| console.log('API called successfully. Returned data: ' + data); | ||
| } | ||
| }; | ||
| apiInstance.scanCloudStorageScanAwsS3File(accessKey, secretKey, bucketRegion, bucketName, keyName, callback); | ||
| ``` | ||
|
|
||
| ### Parameters | ||
|
|
||
| Name | Type | Description | Notes | ||
| ------------- | ------------- | ------------- | ------------- | ||
| **accessKey** | **String**| AWS S3 access key for the S3 bucket; you can get this from My Security Credentials in the AWS console | | ||
| **secretKey** | **String**| AWS S3 secret key for the S3 bucket; you can get this from My Security Credentials in the AWS console | | ||
| **bucketRegion** | **String**| Name of the region of the S3 bucket, such as 'US-East-1' | | ||
| **bucketName** | **String**| Name of the S3 bucket | | ||
| **keyName** | **String**| Key name (also called file name) of the file in S3 that you wish to scan for viruses | | ||
|
|
||
| ### Return type | ||
|
|
||
| [**CloudStorageVirusScanResult**](CloudStorageVirusScanResult.md) | ||
|
|
||
| ### Authorization | ||
|
|
||
| [Apikey](../README.md#Apikey) | ||
|
|
||
| ### HTTP request headers | ||
|
|
||
| - **Content-Type**: multipart/form-data | ||
| - **Accept**: application/json, text/json, application/xml, text/xml | ||
|
|
||
| <a name="scanCloudStorageScanAzureBlob"></a> | ||
| # **scanCloudStorageScanAzureBlob** | ||
| > CloudStorageVirusScanResult scanCloudStorageScanAzureBlob(connectionString, containerName, blobPath) | ||
| Scan an Azure Blob for viruses | ||
|
|
||
| Scan the contents of a single Azure Blob and its content for viruses. Leverage continuously updated signatures for millions of threats, and advanced high-performance scanning capabilities. Over 17 million virus and malware signatures. Continuous cloud-based updates. Wide file format support including Office, PDF, HTML, Flash. Zip support including .Zip, .Rar, .DMG, .Tar, and other archive formats. Multi-threat scanning across viruses, malware, trojans, ransomware, and spyware. High-speed in-memory scanning delivers subsecond typical response time. | ||
|
|
||
| ### Example | ||
| ```javascript | ||
| var CloudmersiveVirusApiClient = require('cloudmersive-virus-api-client'); | ||
| var defaultClient = CloudmersiveVirusApiClient.ApiClient.instance; | ||
|
|
||
| // Configure API key authorization: Apikey | ||
| var Apikey = defaultClient.authentications['Apikey']; | ||
| Apikey.apiKey = 'YOUR API KEY'; | ||
| // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) | ||
| //Apikey.apiKeyPrefix = 'Token'; | ||
|
|
||
| var apiInstance = new CloudmersiveVirusApiClient.ScanCloudStorageApi(); | ||
|
|
||
| var connectionString = "connectionString_example"; // String | Connection string for the Azure Blob Storage Account; you can get this connection string from the Access Keys tab of the Storage Account blade in the Azure Portal. | ||
|
|
||
| var containerName = "containerName_example"; // String | Name of the Blob container within the Azure Blob Storage account | ||
|
|
||
| var blobPath = "blobPath_example"; // String | Path to the blob within the container, such as 'hello.pdf' or '/folder/subfolder/world.pdf' | ||
|
|
||
|
|
||
| var callback = function(error, data, response) { | ||
| if (error) { | ||
| console.error(error); | ||
| } else { | ||
| console.log('API called successfully. Returned data: ' + data); | ||
| } | ||
| }; | ||
| apiInstance.scanCloudStorageScanAzureBlob(connectionString, containerName, blobPath, callback); | ||
| ``` | ||
|
|
||
| ### Parameters | ||
|
|
||
| Name | Type | Description | Notes | ||
| ------------- | ------------- | ------------- | ------------- | ||
| **connectionString** | **String**| Connection string for the Azure Blob Storage Account; you can get this connection string from the Access Keys tab of the Storage Account blade in the Azure Portal. | | ||
| **containerName** | **String**| Name of the Blob container within the Azure Blob Storage account | | ||
| **blobPath** | **String**| Path to the blob within the container, such as 'hello.pdf' or '/folder/subfolder/world.pdf' | | ||
|
|
||
| ### Return type | ||
|
|
||
| [**CloudStorageVirusScanResult**](CloudStorageVirusScanResult.md) | ||
|
|
||
| ### Authorization | ||
|
|
||
| [Apikey](../README.md#Apikey) | ||
|
|
||
| ### HTTP request headers | ||
|
|
||
| - **Content-Type**: multipart/form-data | ||
| - **Accept**: application/json, text/json, application/xml, text/xml | ||
|
|
||
| <a name="scanCloudStorageScanGcpStorageFile"></a> | ||
| # **scanCloudStorageScanGcpStorageFile** | ||
| > CloudStorageVirusScanResult scanCloudStorageScanGcpStorageFile(bucketName, objectName, jsonCredentialFile) | ||
| Scan an Google Cloud Platform (GCP) Storage file for viruses | ||
|
|
||
| Scan the contents of a single Google Cloud Platform (GCP) Storage file and its content for viruses. Leverage continuously updated signatures for millions of threats, and advanced high-performance scanning capabilities. Over 17 million virus and malware signatures. Continuous cloud-based updates. Wide file format support including Office, PDF, HTML, Flash. Zip support including .Zip, .Rar, .DMG, .Tar, and other archive formats. Multi-threat scanning across viruses, malware, trojans, ransomware, and spyware. High-speed in-memory scanning delivers subsecond typical response time. | ||
|
|
||
| ### Example | ||
| ```javascript | ||
| var CloudmersiveVirusApiClient = require('cloudmersive-virus-api-client'); | ||
| var defaultClient = CloudmersiveVirusApiClient.ApiClient.instance; | ||
|
|
||
| // Configure API key authorization: Apikey | ||
| var Apikey = defaultClient.authentications['Apikey']; | ||
| Apikey.apiKey = 'YOUR API KEY'; | ||
| // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) | ||
| //Apikey.apiKeyPrefix = 'Token'; | ||
|
|
||
| var apiInstance = new CloudmersiveVirusApiClient.ScanCloudStorageApi(); | ||
|
|
||
| var bucketName = "bucketName_example"; // String | Name of the bucket in Google Cloud Storage | ||
|
|
||
| var objectName = "objectName_example"; // String | Name of the object or file in Google Cloud Storage | ||
|
|
||
| var jsonCredentialFile = "/path/to/file.txt"; // File | Service Account credential for Google Cloud stored in a JSON file. | ||
|
|
||
|
|
||
| var callback = function(error, data, response) { | ||
| if (error) { | ||
| console.error(error); | ||
| } else { | ||
| console.log('API called successfully. Returned data: ' + data); | ||
| } | ||
| }; | ||
| apiInstance.scanCloudStorageScanGcpStorageFile(bucketName, objectName, jsonCredentialFile, callback); | ||
| ``` | ||
|
|
||
| ### Parameters | ||
|
|
||
| Name | Type | Description | Notes | ||
| ------------- | ------------- | ------------- | ------------- | ||
| **bucketName** | **String**| Name of the bucket in Google Cloud Storage | | ||
| **objectName** | **String**| Name of the object or file in Google Cloud Storage | | ||
| **jsonCredentialFile** | **File**| Service Account credential for Google Cloud stored in a JSON file. | | ||
|
|
||
| ### Return type | ||
|
|
||
| [**CloudStorageVirusScanResult**](CloudStorageVirusScanResult.md) | ||
|
|
||
| ### Authorization | ||
|
|
||
| [Apikey](../README.md#Apikey) | ||
|
|
||
| ### HTTP request headers | ||
|
|
||
| - **Content-Type**: multipart/form-data | ||
| - **Accept**: application/json, text/json, application/xml, text/xml | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -32,7 +32,7 @@ | |
|
|
||
| /** | ||
| * @module ApiClient | ||
| * @version 1.1.8 | ||
| * @version 1.1.9 | ||
| */ | ||
|
|
||
| /** | ||
|
|
||
Oops, something went wrong.