cloudmersive-virus-scan-api-client 2.0.3 → 2.0.7
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +10 -4
- data/docs/CloudStorageAdvancedVirusScanResult.md +19 -0
- data/docs/ScanApi.md +4 -0
- data/docs/ScanCloudStorageApi.md +393 -0
- data/docs/VirusScanAdvancedResult.md +2 -0
- data/lib/cloudmersive-virus-scan-api-client/api/scan_api.rb +6 -0
- data/lib/cloudmersive-virus-scan-api-client/api/scan_cloud_storage_api.rb +477 -0
- data/lib/cloudmersive-virus-scan-api-client/models/cloud_storage_advanced_virus_scan_result.rb +298 -0
- data/lib/cloudmersive-virus-scan-api-client/models/virus_scan_advanced_result.rb +21 -1
- data/lib/cloudmersive-virus-scan-api-client/version.rb +1 -1
- data/lib/cloudmersive-virus-scan-api-client.rb +1 -0
- data/spec/api/scan_api_spec.rb +2 -0
- data/spec/api/scan_cloud_storage_api_spec.rb +106 -0
- data/spec/models/cloud_storage_advanced_virus_scan_result_spec.rb +107 -0
- data/spec/models/virus_scan_advanced_result_spec.rb +12 -0
- metadata +5 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 3fdcb9abb84157588a2d7ac8fa456d7c5044aefec34b4019313e115714ec0556
|
4
|
+
data.tar.gz: 341629a0efaf466be326a2e95e39d6117b96a5f92e7524723cc667028f9ab182
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 9f85f82827d3b6b9114060c760ad402bed18fcee9789906ba7fb6538d6cd532be0a100024c14a0fef03a58c67285642a3d710923d3336744631270985385dd86
|
7
|
+
data.tar.gz: 559a7cf44416d36b05d563bcd99884ac90656311262c3c9c4c79b7771e74c2d0c9ee5e2a1e50e935a83c5f6edf2cf01b3ea9330270c6bb329588292e2b0d2b56
|
data/README.md
CHANGED
@@ -7,7 +7,7 @@ The Cloudmersive Virus Scan API lets you scan files and content for viruses and
|
|
7
7
|
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
8
8
|
|
9
9
|
- API version: v1
|
10
|
-
- Package version: 2.0.
|
10
|
+
- Package version: 2.0.7
|
11
11
|
- Build package: io.swagger.codegen.languages.RubyClientCodegen
|
12
12
|
|
13
13
|
## Installation
|
@@ -23,15 +23,15 @@ gem build cloudmersive-virus-scan-api-client.gemspec
|
|
23
23
|
Then either install the gem locally:
|
24
24
|
|
25
25
|
```shell
|
26
|
-
gem install ./cloudmersive-virus-scan-api-client-2.0.
|
26
|
+
gem install ./cloudmersive-virus-scan-api-client-2.0.7.gem
|
27
27
|
```
|
28
|
-
(for development, run `gem install --dev ./cloudmersive-virus-scan-api-client-2.0.
|
28
|
+
(for development, run `gem install --dev ./cloudmersive-virus-scan-api-client-2.0.7.gem` to install the development dependencies)
|
29
29
|
|
30
30
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
31
31
|
|
32
32
|
Finally add this to the Gemfile:
|
33
33
|
|
34
|
-
gem 'cloudmersive-virus-scan-api-client', '~> 2.0.
|
34
|
+
gem 'cloudmersive-virus-scan-api-client', '~> 2.0.7'
|
35
35
|
|
36
36
|
### Install from Git
|
37
37
|
|
@@ -87,12 +87,18 @@ Class | Method | HTTP request | Description
|
|
87
87
|
*CloudmersiveVirusScanApiClient::ScanApi* | [**scan_file_advanced**](docs/ScanApi.md#scan_file_advanced) | **POST** /virus/scan/file/advanced | Advanced Scan a file for viruses
|
88
88
|
*CloudmersiveVirusScanApiClient::ScanApi* | [**scan_website**](docs/ScanApi.md#scan_website) | **POST** /virus/scan/website | Scan a website for malicious content and threats
|
89
89
|
*CloudmersiveVirusScanApiClient::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
|
90
|
+
*CloudmersiveVirusScanApiClient::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
|
90
91
|
*CloudmersiveVirusScanApiClient::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
|
92
|
+
*CloudmersiveVirusScanApiClient::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
|
91
93
|
*CloudmersiveVirusScanApiClient::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
|
94
|
+
*CloudmersiveVirusScanApiClient::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
|
95
|
+
*CloudmersiveVirusScanApiClient::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
|
96
|
+
*CloudmersiveVirusScanApiClient::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
|
92
97
|
|
93
98
|
|
94
99
|
## Documentation for Models
|
95
100
|
|
101
|
+
- [CloudmersiveVirusScanApiClient::CloudStorageAdvancedVirusScanResult](docs/CloudStorageAdvancedVirusScanResult.md)
|
96
102
|
- [CloudmersiveVirusScanApiClient::CloudStorageVirusFound](docs/CloudStorageVirusFound.md)
|
97
103
|
- [CloudmersiveVirusScanApiClient::CloudStorageVirusScanResult](docs/CloudStorageVirusScanResult.md)
|
98
104
|
- [CloudmersiveVirusScanApiClient::VirusFound](docs/VirusFound.md)
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# CloudmersiveVirusScanApiClient::CloudStorageAdvancedVirusScanResult
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**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]
|
7
|
+
**clean_result** | **BOOLEAN** | True if the scan contained no viruses, false otherwise | [optional]
|
8
|
+
**contains_executable** | **BOOLEAN** | True if the scan contained an executable (application code), which can be a significant risk factor | [optional]
|
9
|
+
**contains_invalid_file** | **BOOLEAN** | True if the scan contained an invalid file (such as a PDF that is not a valid PDF, Word Document that is not a valid Word Document, etc.), which can be a significant risk factor | [optional]
|
10
|
+
**contains_script** | **BOOLEAN** | True if the scan contained a script (such as a PHP script, Python script, etc.) which can be a significant risk factor | [optional]
|
11
|
+
**contains_password_protected_file** | **BOOLEAN** | True if the scan contained a password protected or encrypted file, which can be a significant risk factor | [optional]
|
12
|
+
**contains_restricted_file_format** | **BOOLEAN** | True if the uploaded file is of a type that is not allowed based on the optional restrictFileTypes parameter, false otherwise; if restrictFileTypes is not set, this will always be false | [optional]
|
13
|
+
**contains_macros** | **BOOLEAN** | True if the uploaded file contains embedded Macros of other embedded threats within the document, which can be a significant risk factor | [optional]
|
14
|
+
**verified_file_format** | **String** | For file format verification-supported file formats, the contents-verified file format of the file. Null indicates that the file format is not supported for contents verification. If a Virus or Malware is found, this field will always be set to Null. | [optional]
|
15
|
+
**found_viruses** | [**Array<CloudStorageVirusFound>**](CloudStorageVirusFound.md) | Array of viruses found, if any | [optional]
|
16
|
+
**error_detailed_description** | **String** | Detailed error message if the operation was not successful | [optional]
|
17
|
+
**file_size** | **Integer** | Size in bytes of the file that was retrieved and scanned | [optional]
|
18
|
+
|
19
|
+
|
data/docs/ScanApi.md
CHANGED
@@ -91,6 +91,8 @@ opts = {
|
|
91
91
|
allow_invalid_files: true, # BOOLEAN | Set to false to block invalid files, such as a PDF file that is not really a valid PDF file, or a Word Document that is not a valid Word Document. Default is false (recommended).
|
92
92
|
allow_scripts: true, # BOOLEAN | Set to false to block script files, such as a PHP files, Python scripts, and other malicious content or security threats that can be embedded in the file. Set to true to allow these file types. Default is false (recommended).
|
93
93
|
allow_password_protected_files: true, # BOOLEAN | Set to false to block password protected and encrypted files, such as encrypted zip and rar files, and other files that seek to circumvent scanning through passwords. Set to true to allow these file types. Default is false (recommended).
|
94
|
+
allow_macros: true, # BOOLEAN | Set to false to block macros and other threats embedded in document files, such as Word, Excel and PowerPoint embedded Macros, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).
|
95
|
+
allow_xml_external_entities: true, # BOOLEAN | Set to false to block XML External Entities and other threats embedded in XML files, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).
|
94
96
|
restrict_file_types: 'restrict_file_types_example' # String | Specify a restricted set of file formats to allow as clean as a comma-separated list of file formats, such as .pdf,.docx,.png would allow only PDF, PNG and Word document files. All files must pass content verification against this list of file formats, if they do not, then the result will be returned as CleanResult=false. Set restrictFileTypes parameter to null or empty string to disable; default is disabled.
|
95
97
|
}
|
96
98
|
|
@@ -112,6 +114,8 @@ Name | Type | Description | Notes
|
|
112
114
|
**allow_invalid_files** | **BOOLEAN**| Set to false to block invalid files, such as a PDF file that is not really a valid PDF file, or a Word Document that is not a valid Word Document. Default is false (recommended). | [optional]
|
113
115
|
**allow_scripts** | **BOOLEAN**| Set to false to block script files, such as a PHP files, Python scripts, and other malicious content or security threats that can be embedded in the file. Set to true to allow these file types. Default is false (recommended). | [optional]
|
114
116
|
**allow_password_protected_files** | **BOOLEAN**| Set to false to block password protected and encrypted files, such as encrypted zip and rar files, and other files that seek to circumvent scanning through passwords. Set to true to allow these file types. Default is false (recommended). | [optional]
|
117
|
+
**allow_macros** | **BOOLEAN**| Set to false to block macros and other threats embedded in document files, such as Word, Excel and PowerPoint embedded Macros, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended). | [optional]
|
118
|
+
**allow_xml_external_entities** | **BOOLEAN**| Set to false to block XML External Entities and other threats embedded in XML files, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended). | [optional]
|
115
119
|
**restrict_file_types** | **String**| Specify a restricted set of file formats to allow as clean as a comma-separated list of file formats, such as .pdf,.docx,.png would allow only PDF, PNG and Word document files. All files must pass content verification against this list of file formats, if they do not, then the result will be returned as CleanResult=false. Set restrictFileTypes parameter to null or empty string to disable; default is disabled. | [optional]
|
116
120
|
|
117
121
|
### Return type
|
data/docs/ScanCloudStorageApi.md
CHANGED
@@ -5,8 +5,13 @@ All URIs are relative to *https://api.cloudmersive.com*
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
7
|
[**scan_cloud_storage_scan_aws_s3_file**](ScanCloudStorageApi.md#scan_cloud_storage_scan_aws_s3_file) | **POST** /virus/scan/cloud-storage/aws-s3/single | Scan an AWS S3 file for viruses
|
8
|
+
[**scan_cloud_storage_scan_aws_s3_file_advanced**](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
|
8
9
|
[**scan_cloud_storage_scan_azure_blob**](ScanCloudStorageApi.md#scan_cloud_storage_scan_azure_blob) | **POST** /virus/scan/cloud-storage/azure-blob/single | Scan an Azure Blob for viruses
|
10
|
+
[**scan_cloud_storage_scan_azure_blob_advanced**](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
|
9
11
|
[**scan_cloud_storage_scan_gcp_storage_file**](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
|
12
|
+
[**scan_cloud_storage_scan_gcp_storage_file_advanced**](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
|
13
|
+
[**scan_cloud_storage_scan_share_point_online_file**](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
|
14
|
+
[**scan_cloud_storage_scan_share_point_online_file_advanced**](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
|
10
15
|
|
11
16
|
|
12
17
|
# **scan_cloud_storage_scan_aws_s3_file**
|
@@ -75,6 +80,88 @@ Name | Type | Description | Notes
|
|
75
80
|
|
76
81
|
|
77
82
|
|
83
|
+
# **scan_cloud_storage_scan_aws_s3_file_advanced**
|
84
|
+
> CloudStorageAdvancedVirusScanResult scan_cloud_storage_scan_aws_s3_file_advanced(access_key, secret_key, bucket_region, bucket_name, key_name, opts)
|
85
|
+
|
86
|
+
Advanced Scan an AWS S3 file for viruses
|
87
|
+
|
88
|
+
Advanced Scan the contents of a single AWS S3 file and its content for viruses and threats. Advanced Scan files with 360-degree Content Protection across Viruses and Malware, executables, invalid files, scripts, and even restrictions on accepted file types with complete content verification. Customize threat rules to your needs. 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. Block threats beyond viruses including executables, scripts, invalid files, and more. Optionally limit input files to a specific set of file types (e.g. PDF and Word Documents only). 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.
|
89
|
+
|
90
|
+
### Example
|
91
|
+
```ruby
|
92
|
+
# load the gem
|
93
|
+
require 'cloudmersive-virus-scan-api-client'
|
94
|
+
# setup authorization
|
95
|
+
CloudmersiveVirusScanApiClient.configure do |config|
|
96
|
+
# Configure API key authorization: Apikey
|
97
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
98
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
99
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
100
|
+
end
|
101
|
+
|
102
|
+
api_instance = CloudmersiveVirusScanApiClient::ScanCloudStorageApi.new
|
103
|
+
|
104
|
+
access_key = 'access_key_example' # String | AWS S3 access key for the S3 bucket; you can get this from My Security Credentials in the AWS console
|
105
|
+
|
106
|
+
secret_key = 'secret_key_example' # String | AWS S3 secret key for the S3 bucket; you can get this from My Security Credentials in the AWS console
|
107
|
+
|
108
|
+
bucket_region = 'bucket_region_example' # String | Name of the region of the S3 bucket, such as 'US-East-1'
|
109
|
+
|
110
|
+
bucket_name = 'bucket_name_example' # String | Name of the S3 bucket
|
111
|
+
|
112
|
+
key_name = 'key_name_example' # String | Key name (also called file name) of the file in S3 that you wish to scan for viruses
|
113
|
+
|
114
|
+
opts = {
|
115
|
+
allow_executables: true, # BOOLEAN | Set to false to block executable files (program code) from being allowed in the input file. Default is false (recommended).
|
116
|
+
allow_invalid_files: true, # BOOLEAN | Set to false to block invalid files, such as a PDF file that is not really a valid PDF file, or a Word Document that is not a valid Word Document. Default is false (recommended).
|
117
|
+
allow_scripts: true, # BOOLEAN | Set to false to block script files, such as a PHP files, Python scripts, and other malicious content or security threats that can be embedded in the file. Set to true to allow these file types. Default is false (recommended).
|
118
|
+
allow_password_protected_files: true, # BOOLEAN | Set to false to block password protected and encrypted files, such as encrypted zip and rar files, and other files that seek to circumvent scanning through passwords. Set to true to allow these file types. Default is false (recommended).
|
119
|
+
allow_macros: true, # BOOLEAN | Set to false to block macros and other threats embedded in document files, such as Word, Excel and PowerPoint embedded Macros, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).
|
120
|
+
allow_xml_external_entities: true, # BOOLEAN | Set to false to block XML External Entities and other threats embedded in XML files, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).
|
121
|
+
restrict_file_types: 'restrict_file_types_example' # String | Specify a restricted set of file formats to allow as clean as a comma-separated list of file formats, such as .pdf,.docx,.png would allow only PDF, PNG and Word document files. All files must pass content verification against this list of file formats, if they do not, then the result will be returned as CleanResult=false. Set restrictFileTypes parameter to null or empty string to disable; default is disabled.
|
122
|
+
}
|
123
|
+
|
124
|
+
begin
|
125
|
+
#Advanced Scan an AWS S3 file for viruses
|
126
|
+
result = api_instance.scan_cloud_storage_scan_aws_s3_file_advanced(access_key, secret_key, bucket_region, bucket_name, key_name, opts)
|
127
|
+
p result
|
128
|
+
rescue CloudmersiveVirusScanApiClient::ApiError => e
|
129
|
+
puts "Exception when calling ScanCloudStorageApi->scan_cloud_storage_scan_aws_s3_file_advanced: #{e}"
|
130
|
+
end
|
131
|
+
```
|
132
|
+
|
133
|
+
### Parameters
|
134
|
+
|
135
|
+
Name | Type | Description | Notes
|
136
|
+
------------- | ------------- | ------------- | -------------
|
137
|
+
**access_key** | **String**| AWS S3 access key for the S3 bucket; you can get this from My Security Credentials in the AWS console |
|
138
|
+
**secret_key** | **String**| AWS S3 secret key for the S3 bucket; you can get this from My Security Credentials in the AWS console |
|
139
|
+
**bucket_region** | **String**| Name of the region of the S3 bucket, such as 'US-East-1' |
|
140
|
+
**bucket_name** | **String**| Name of the S3 bucket |
|
141
|
+
**key_name** | **String**| Key name (also called file name) of the file in S3 that you wish to scan for viruses |
|
142
|
+
**allow_executables** | **BOOLEAN**| Set to false to block executable files (program code) from being allowed in the input file. Default is false (recommended). | [optional]
|
143
|
+
**allow_invalid_files** | **BOOLEAN**| Set to false to block invalid files, such as a PDF file that is not really a valid PDF file, or a Word Document that is not a valid Word Document. Default is false (recommended). | [optional]
|
144
|
+
**allow_scripts** | **BOOLEAN**| Set to false to block script files, such as a PHP files, Python scripts, and other malicious content or security threats that can be embedded in the file. Set to true to allow these file types. Default is false (recommended). | [optional]
|
145
|
+
**allow_password_protected_files** | **BOOLEAN**| Set to false to block password protected and encrypted files, such as encrypted zip and rar files, and other files that seek to circumvent scanning through passwords. Set to true to allow these file types. Default is false (recommended). | [optional]
|
146
|
+
**allow_macros** | **BOOLEAN**| Set to false to block macros and other threats embedded in document files, such as Word, Excel and PowerPoint embedded Macros, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended). | [optional]
|
147
|
+
**allow_xml_external_entities** | **BOOLEAN**| Set to false to block XML External Entities and other threats embedded in XML files, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended). | [optional]
|
148
|
+
**restrict_file_types** | **String**| Specify a restricted set of file formats to allow as clean as a comma-separated list of file formats, such as .pdf,.docx,.png would allow only PDF, PNG and Word document files. All files must pass content verification against this list of file formats, if they do not, then the result will be returned as CleanResult=false. Set restrictFileTypes parameter to null or empty string to disable; default is disabled. | [optional]
|
149
|
+
|
150
|
+
### Return type
|
151
|
+
|
152
|
+
[**CloudStorageAdvancedVirusScanResult**](CloudStorageAdvancedVirusScanResult.md)
|
153
|
+
|
154
|
+
### Authorization
|
155
|
+
|
156
|
+
[Apikey](../README.md#Apikey)
|
157
|
+
|
158
|
+
### HTTP request headers
|
159
|
+
|
160
|
+
- **Content-Type**: multipart/form-data
|
161
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
162
|
+
|
163
|
+
|
164
|
+
|
78
165
|
# **scan_cloud_storage_scan_azure_blob**
|
79
166
|
> CloudStorageVirusScanResult scan_cloud_storage_scan_azure_blob(connection_string, container_name, blob_path)
|
80
167
|
|
@@ -135,6 +222,82 @@ Name | Type | Description | Notes
|
|
135
222
|
|
136
223
|
|
137
224
|
|
225
|
+
# **scan_cloud_storage_scan_azure_blob_advanced**
|
226
|
+
> CloudStorageAdvancedVirusScanResult scan_cloud_storage_scan_azure_blob_advanced(connection_string, container_name, blob_path, opts)
|
227
|
+
|
228
|
+
Advanced Scan an Azure Blob for viruses
|
229
|
+
|
230
|
+
Advanced Scan the contents of a single Azure Blob and its content for viruses and threats. Advanced Scan files with 360-degree Content Protection across Viruses and Malware, executables, invalid files, scripts, and even restrictions on accepted file types with complete content verification. Customize threat rules to your needs. 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. Block threats beyond viruses including executables, scripts, invalid files, and more. Optionally limit input files to a specific set of file types (e.g. PDF and Word Documents only). 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.
|
231
|
+
|
232
|
+
### Example
|
233
|
+
```ruby
|
234
|
+
# load the gem
|
235
|
+
require 'cloudmersive-virus-scan-api-client'
|
236
|
+
# setup authorization
|
237
|
+
CloudmersiveVirusScanApiClient.configure do |config|
|
238
|
+
# Configure API key authorization: Apikey
|
239
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
240
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
241
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
242
|
+
end
|
243
|
+
|
244
|
+
api_instance = CloudmersiveVirusScanApiClient::ScanCloudStorageApi.new
|
245
|
+
|
246
|
+
connection_string = 'connection_string_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.
|
247
|
+
|
248
|
+
container_name = 'container_name_example' # String | Name of the Blob container within the Azure Blob Storage account
|
249
|
+
|
250
|
+
blob_path = 'blob_path_example' # String | Path to the blob within the container, such as 'hello.pdf' or '/folder/subfolder/world.pdf'
|
251
|
+
|
252
|
+
opts = {
|
253
|
+
allow_executables: true, # BOOLEAN | Set to false to block executable files (program code) from being allowed in the input file. Default is false (recommended).
|
254
|
+
allow_invalid_files: true, # BOOLEAN | Set to false to block invalid files, such as a PDF file that is not really a valid PDF file, or a Word Document that is not a valid Word Document. Default is false (recommended).
|
255
|
+
allow_scripts: true, # BOOLEAN | Set to false to block script files, such as a PHP files, Python scripts, and other malicious content or security threats that can be embedded in the file. Set to true to allow these file types. Default is false (recommended).
|
256
|
+
allow_password_protected_files: true, # BOOLEAN | Set to false to block password protected and encrypted files, such as encrypted zip and rar files, and other files that seek to circumvent scanning through passwords. Set to true to allow these file types. Default is false (recommended).
|
257
|
+
allow_macros: true, # BOOLEAN | Set to false to block macros and other threats embedded in document files, such as Word, Excel and PowerPoint embedded Macros, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).
|
258
|
+
allow_xml_external_entities: true, # BOOLEAN | Set to false to block XML External Entities and other threats embedded in XML files, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).
|
259
|
+
restrict_file_types: 'restrict_file_types_example' # String | Specify a restricted set of file formats to allow as clean as a comma-separated list of file formats, such as .pdf,.docx,.png would allow only PDF, PNG and Word document files. All files must pass content verification against this list of file formats, if they do not, then the result will be returned as CleanResult=false. Set restrictFileTypes parameter to null or empty string to disable; default is disabled.
|
260
|
+
}
|
261
|
+
|
262
|
+
begin
|
263
|
+
#Advanced Scan an Azure Blob for viruses
|
264
|
+
result = api_instance.scan_cloud_storage_scan_azure_blob_advanced(connection_string, container_name, blob_path, opts)
|
265
|
+
p result
|
266
|
+
rescue CloudmersiveVirusScanApiClient::ApiError => e
|
267
|
+
puts "Exception when calling ScanCloudStorageApi->scan_cloud_storage_scan_azure_blob_advanced: #{e}"
|
268
|
+
end
|
269
|
+
```
|
270
|
+
|
271
|
+
### Parameters
|
272
|
+
|
273
|
+
Name | Type | Description | Notes
|
274
|
+
------------- | ------------- | ------------- | -------------
|
275
|
+
**connection_string** | **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. |
|
276
|
+
**container_name** | **String**| Name of the Blob container within the Azure Blob Storage account |
|
277
|
+
**blob_path** | **String**| Path to the blob within the container, such as 'hello.pdf' or '/folder/subfolder/world.pdf' |
|
278
|
+
**allow_executables** | **BOOLEAN**| Set to false to block executable files (program code) from being allowed in the input file. Default is false (recommended). | [optional]
|
279
|
+
**allow_invalid_files** | **BOOLEAN**| Set to false to block invalid files, such as a PDF file that is not really a valid PDF file, or a Word Document that is not a valid Word Document. Default is false (recommended). | [optional]
|
280
|
+
**allow_scripts** | **BOOLEAN**| Set to false to block script files, such as a PHP files, Python scripts, and other malicious content or security threats that can be embedded in the file. Set to true to allow these file types. Default is false (recommended). | [optional]
|
281
|
+
**allow_password_protected_files** | **BOOLEAN**| Set to false to block password protected and encrypted files, such as encrypted zip and rar files, and other files that seek to circumvent scanning through passwords. Set to true to allow these file types. Default is false (recommended). | [optional]
|
282
|
+
**allow_macros** | **BOOLEAN**| Set to false to block macros and other threats embedded in document files, such as Word, Excel and PowerPoint embedded Macros, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended). | [optional]
|
283
|
+
**allow_xml_external_entities** | **BOOLEAN**| Set to false to block XML External Entities and other threats embedded in XML files, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended). | [optional]
|
284
|
+
**restrict_file_types** | **String**| Specify a restricted set of file formats to allow as clean as a comma-separated list of file formats, such as .pdf,.docx,.png would allow only PDF, PNG and Word document files. All files must pass content verification against this list of file formats, if they do not, then the result will be returned as CleanResult=false. Set restrictFileTypes parameter to null or empty string to disable; default is disabled. | [optional]
|
285
|
+
|
286
|
+
### Return type
|
287
|
+
|
288
|
+
[**CloudStorageAdvancedVirusScanResult**](CloudStorageAdvancedVirusScanResult.md)
|
289
|
+
|
290
|
+
### Authorization
|
291
|
+
|
292
|
+
[Apikey](../README.md#Apikey)
|
293
|
+
|
294
|
+
### HTTP request headers
|
295
|
+
|
296
|
+
- **Content-Type**: multipart/form-data
|
297
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
298
|
+
|
299
|
+
|
300
|
+
|
138
301
|
# **scan_cloud_storage_scan_gcp_storage_file**
|
139
302
|
> CloudStorageVirusScanResult scan_cloud_storage_scan_gcp_storage_file(bucket_name, object_name, json_credential_file)
|
140
303
|
|
@@ -195,3 +358,233 @@ Name | Type | Description | Notes
|
|
195
358
|
|
196
359
|
|
197
360
|
|
361
|
+
# **scan_cloud_storage_scan_gcp_storage_file_advanced**
|
362
|
+
> CloudStorageAdvancedVirusScanResult scan_cloud_storage_scan_gcp_storage_file_advanced(bucket_name, object_name, json_credential_file, opts)
|
363
|
+
|
364
|
+
Advanced Scan an Google Cloud Platform (GCP) Storage file for viruses
|
365
|
+
|
366
|
+
Advanced Scan the contents of a single Google Cloud Platform (GCP) Storage file and its content for viruses and threats. Advanced Scan files with 360-degree Content Protection across Viruses and Malware, executables, invalid files, scripts, and even restrictions on accepted file types with complete content verification. Customize threat rules to your needs. 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. Block threats beyond viruses including executables, scripts, invalid files, and more. Optionally limit input files to a specific set of file types (e.g. PDF and Word Documents only). 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.
|
367
|
+
|
368
|
+
### Example
|
369
|
+
```ruby
|
370
|
+
# load the gem
|
371
|
+
require 'cloudmersive-virus-scan-api-client'
|
372
|
+
# setup authorization
|
373
|
+
CloudmersiveVirusScanApiClient.configure do |config|
|
374
|
+
# Configure API key authorization: Apikey
|
375
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
376
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
377
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
378
|
+
end
|
379
|
+
|
380
|
+
api_instance = CloudmersiveVirusScanApiClient::ScanCloudStorageApi.new
|
381
|
+
|
382
|
+
bucket_name = 'bucket_name_example' # String | Name of the bucket in Google Cloud Storage
|
383
|
+
|
384
|
+
object_name = 'object_name_example' # String | Name of the object or file in Google Cloud Storage
|
385
|
+
|
386
|
+
json_credential_file = File.new('/path/to/file.txt') # File | Service Account credential for Google Cloud stored in a JSON file.
|
387
|
+
|
388
|
+
opts = {
|
389
|
+
allow_executables: true, # BOOLEAN | Set to false to block executable files (program code) from being allowed in the input file. Default is false (recommended).
|
390
|
+
allow_invalid_files: true, # BOOLEAN | Set to false to block invalid files, such as a PDF file that is not really a valid PDF file, or a Word Document that is not a valid Word Document. Default is false (recommended).
|
391
|
+
allow_scripts: true, # BOOLEAN | Set to false to block script files, such as a PHP files, Python scripts, and other malicious content or security threats that can be embedded in the file. Set to true to allow these file types. Default is false (recommended).
|
392
|
+
allow_password_protected_files: true, # BOOLEAN | Set to false to block password protected and encrypted files, such as encrypted zip and rar files, and other files that seek to circumvent scanning through passwords. Set to true to allow these file types. Default is false (recommended).
|
393
|
+
allow_macros: true, # BOOLEAN | Set to false to block macros and other threats embedded in document files, such as Word, Excel and PowerPoint embedded Macros, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).
|
394
|
+
allow_xml_external_entities: true, # BOOLEAN | Set to false to block XML External Entities and other threats embedded in XML files, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).
|
395
|
+
restrict_file_types: 'restrict_file_types_example' # String | Specify a restricted set of file formats to allow as clean as a comma-separated list of file formats, such as .pdf,.docx,.png would allow only PDF, PNG and Word document files. All files must pass content verification against this list of file formats, if they do not, then the result will be returned as CleanResult=false. Set restrictFileTypes parameter to null or empty string to disable; default is disabled.
|
396
|
+
}
|
397
|
+
|
398
|
+
begin
|
399
|
+
#Advanced Scan an Google Cloud Platform (GCP) Storage file for viruses
|
400
|
+
result = api_instance.scan_cloud_storage_scan_gcp_storage_file_advanced(bucket_name, object_name, json_credential_file, opts)
|
401
|
+
p result
|
402
|
+
rescue CloudmersiveVirusScanApiClient::ApiError => e
|
403
|
+
puts "Exception when calling ScanCloudStorageApi->scan_cloud_storage_scan_gcp_storage_file_advanced: #{e}"
|
404
|
+
end
|
405
|
+
```
|
406
|
+
|
407
|
+
### Parameters
|
408
|
+
|
409
|
+
Name | Type | Description | Notes
|
410
|
+
------------- | ------------- | ------------- | -------------
|
411
|
+
**bucket_name** | **String**| Name of the bucket in Google Cloud Storage |
|
412
|
+
**object_name** | **String**| Name of the object or file in Google Cloud Storage |
|
413
|
+
**json_credential_file** | **File**| Service Account credential for Google Cloud stored in a JSON file. |
|
414
|
+
**allow_executables** | **BOOLEAN**| Set to false to block executable files (program code) from being allowed in the input file. Default is false (recommended). | [optional]
|
415
|
+
**allow_invalid_files** | **BOOLEAN**| Set to false to block invalid files, such as a PDF file that is not really a valid PDF file, or a Word Document that is not a valid Word Document. Default is false (recommended). | [optional]
|
416
|
+
**allow_scripts** | **BOOLEAN**| Set to false to block script files, such as a PHP files, Python scripts, and other malicious content or security threats that can be embedded in the file. Set to true to allow these file types. Default is false (recommended). | [optional]
|
417
|
+
**allow_password_protected_files** | **BOOLEAN**| Set to false to block password protected and encrypted files, such as encrypted zip and rar files, and other files that seek to circumvent scanning through passwords. Set to true to allow these file types. Default is false (recommended). | [optional]
|
418
|
+
**allow_macros** | **BOOLEAN**| Set to false to block macros and other threats embedded in document files, such as Word, Excel and PowerPoint embedded Macros, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended). | [optional]
|
419
|
+
**allow_xml_external_entities** | **BOOLEAN**| Set to false to block XML External Entities and other threats embedded in XML files, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended). | [optional]
|
420
|
+
**restrict_file_types** | **String**| Specify a restricted set of file formats to allow as clean as a comma-separated list of file formats, such as .pdf,.docx,.png would allow only PDF, PNG and Word document files. All files must pass content verification against this list of file formats, if they do not, then the result will be returned as CleanResult=false. Set restrictFileTypes parameter to null or empty string to disable; default is disabled. | [optional]
|
421
|
+
|
422
|
+
### Return type
|
423
|
+
|
424
|
+
[**CloudStorageAdvancedVirusScanResult**](CloudStorageAdvancedVirusScanResult.md)
|
425
|
+
|
426
|
+
### Authorization
|
427
|
+
|
428
|
+
[Apikey](../README.md#Apikey)
|
429
|
+
|
430
|
+
### HTTP request headers
|
431
|
+
|
432
|
+
- **Content-Type**: multipart/form-data
|
433
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
434
|
+
|
435
|
+
|
436
|
+
|
437
|
+
# **scan_cloud_storage_scan_share_point_online_file**
|
438
|
+
> CloudStorageVirusScanResult scan_cloud_storage_scan_share_point_online_file(client_id, client_secret, sharepoint_domain_name, site_id, file_path, opts)
|
439
|
+
|
440
|
+
Virus Scan a file in a SharePoint Online Site Drive
|
441
|
+
|
442
|
+
Virus Scan the contents of a single SharePoint Online Site Drive 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. To get the Client ID and Client Secret, follow these steps: (1) Navigate to the Azure Portal and click on Azure Active Directory, (2) click on App Registrations on the left hand side, (3) click on Register Application, (4) Name the application CloudmersiveAntiVirus and click on Register, (5) Get the client ID by clicking on Overview and copying the value labeled Application (client) ID, (6) click on Certificates and Secrets, (7) click on New client secret, choose a longer expiration and give the secret a name, (8) copy the secret value to the clipboard and save it securely, this is your Client Secret, (9) Now we need to grant permissions to SharePOint; click on API Permissions on the left hand side, (10) click on Add a permission and choose Microsoft Graph, (11) click on Application Permissions, (12) search for Sites.FullControl.All, (13) Click on Add Permissions, (14) now navigate back to Azure Active Directory and click on Enterprise Applications, click on CloudmersiveAntiVirus and click on Permissions, and (15) click on Grant Admin Consent.
|
443
|
+
|
444
|
+
### Example
|
445
|
+
```ruby
|
446
|
+
# load the gem
|
447
|
+
require 'cloudmersive-virus-scan-api-client'
|
448
|
+
# setup authorization
|
449
|
+
CloudmersiveVirusScanApiClient.configure do |config|
|
450
|
+
# Configure API key authorization: Apikey
|
451
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
452
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
453
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
454
|
+
end
|
455
|
+
|
456
|
+
api_instance = CloudmersiveVirusScanApiClient::ScanCloudStorageApi.new
|
457
|
+
|
458
|
+
client_id = 'client_id_example' # String | Client ID access credentials; see description above for instructions on how to get the Client ID from the Azure Active Directory portal.
|
459
|
+
|
460
|
+
client_secret = 'client_secret_example' # String | Client Secret access credentials; see description above for instructions on how to get the Client Secret from the Azure Active Directory portal
|
461
|
+
|
462
|
+
sharepoint_domain_name = 'sharepoint_domain_name_example' # String | SharePoint Online domain name, such as mydomain.sharepoint.com
|
463
|
+
|
464
|
+
site_id = 'site_id_example' # String | Site ID (GUID) of the SharePoint site you wish to retrieve the file from
|
465
|
+
|
466
|
+
file_path = 'file_path_example' # String | Path to the file within the drive, such as 'hello.pdf' or '/folder/subfolder/world.pdf'
|
467
|
+
|
468
|
+
opts = {
|
469
|
+
tenant_id: 'tenant_id_example' # String | Optional; Tenant ID of your Azure Active Directory
|
470
|
+
}
|
471
|
+
|
472
|
+
begin
|
473
|
+
#Virus Scan a file in a SharePoint Online Site Drive
|
474
|
+
result = api_instance.scan_cloud_storage_scan_share_point_online_file(client_id, client_secret, sharepoint_domain_name, site_id, file_path, opts)
|
475
|
+
p result
|
476
|
+
rescue CloudmersiveVirusScanApiClient::ApiError => e
|
477
|
+
puts "Exception when calling ScanCloudStorageApi->scan_cloud_storage_scan_share_point_online_file: #{e}"
|
478
|
+
end
|
479
|
+
```
|
480
|
+
|
481
|
+
### Parameters
|
482
|
+
|
483
|
+
Name | Type | Description | Notes
|
484
|
+
------------- | ------------- | ------------- | -------------
|
485
|
+
**client_id** | **String**| Client ID access credentials; see description above for instructions on how to get the Client ID from the Azure Active Directory portal. |
|
486
|
+
**client_secret** | **String**| Client Secret access credentials; see description above for instructions on how to get the Client Secret from the Azure Active Directory portal |
|
487
|
+
**sharepoint_domain_name** | **String**| SharePoint Online domain name, such as mydomain.sharepoint.com |
|
488
|
+
**site_id** | **String**| Site ID (GUID) of the SharePoint site you wish to retrieve the file from |
|
489
|
+
**file_path** | **String**| Path to the file within the drive, such as 'hello.pdf' or '/folder/subfolder/world.pdf' |
|
490
|
+
**tenant_id** | **String**| Optional; Tenant ID of your Azure Active Directory | [optional]
|
491
|
+
|
492
|
+
### Return type
|
493
|
+
|
494
|
+
[**CloudStorageVirusScanResult**](CloudStorageVirusScanResult.md)
|
495
|
+
|
496
|
+
### Authorization
|
497
|
+
|
498
|
+
[Apikey](../README.md#Apikey)
|
499
|
+
|
500
|
+
### HTTP request headers
|
501
|
+
|
502
|
+
- **Content-Type**: multipart/form-data
|
503
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
504
|
+
|
505
|
+
|
506
|
+
|
507
|
+
# **scan_cloud_storage_scan_share_point_online_file_advanced**
|
508
|
+
> CloudStorageAdvancedVirusScanResult scan_cloud_storage_scan_share_point_online_file_advanced(client_id, client_secret, sharepoint_domain_name, site_id, file_path, opts)
|
509
|
+
|
510
|
+
Advanced Virus Scan a file in a SharePoint Online Site Drive
|
511
|
+
|
512
|
+
Advanced Virus Scan the contents of a single SharePoint Online Site Drive file and its content for viruses and threats. Advanced Scan files with 360-degree Content Protection across Viruses and Malware, executables, invalid files, scripts, and even restrictions on accepted file types with complete content verification. Customize threat rules to your needs. 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. Block threats beyond viruses including executables, scripts, invalid files, and more. Optionally limit input files to a specific set of file types (e.g. PDF and Word Documents only). 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. To get the Client ID and Client Secret, follow these steps: (1) Navigate to the Azure Portal and click on Azure Active Directory, (2) click on App Registrations on the left hand side, (3) click on Register Application, (4) Name the application CloudmersiveAntiVirus and click on Register, (5) Get the client ID by clicking on Overview and copying the value labeled Application (client) ID, (6) click on Certificates and Secrets, (7) click on New client secret, choose a longer expiration and give the secret a name, (8) copy the secret value to the clipboard and save it securely, this is your Client Secret, (9) Now we need to grant permissions to SharePOint; click on API Permissions on the left hand side, (10) click on Add a permission and choose Microsoft Graph, (11) click on Application Permissions, (12) search for Sites.FullControl.All, (13) Click on Add Permissions, (14) now navigate back to Azure Active Directory and click on Enterprise Applications, click on CloudmersiveAntiVirus and click on Permissions, and (15) click on Grant Admin Consent.
|
513
|
+
|
514
|
+
### Example
|
515
|
+
```ruby
|
516
|
+
# load the gem
|
517
|
+
require 'cloudmersive-virus-scan-api-client'
|
518
|
+
# setup authorization
|
519
|
+
CloudmersiveVirusScanApiClient.configure do |config|
|
520
|
+
# Configure API key authorization: Apikey
|
521
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
522
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
523
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
524
|
+
end
|
525
|
+
|
526
|
+
api_instance = CloudmersiveVirusScanApiClient::ScanCloudStorageApi.new
|
527
|
+
|
528
|
+
client_id = 'client_id_example' # String | Client ID access credentials; see description above for instructions on how to get the Client ID from the Azure Active Directory portal.
|
529
|
+
|
530
|
+
client_secret = 'client_secret_example' # String | Client Secret access credentials; see description above for instructions on how to get the Client Secret from the Azure Active Directory portal
|
531
|
+
|
532
|
+
sharepoint_domain_name = 'sharepoint_domain_name_example' # String | SharePoint Online domain name, such as mydomain.sharepoint.com
|
533
|
+
|
534
|
+
site_id = 'site_id_example' # String | Site ID (GUID) of the SharePoint site you wish to retrieve the file from
|
535
|
+
|
536
|
+
file_path = 'file_path_example' # String | Path to the file within the drive, such as 'hello.pdf' or '/folder/subfolder/world.pdf'
|
537
|
+
|
538
|
+
opts = {
|
539
|
+
tenant_id: 'tenant_id_example', # String | Optional; Tenant ID of your Azure Active Directory
|
540
|
+
allow_executables: true, # BOOLEAN | Set to false to block executable files (program code) from being allowed in the input file. Default is false (recommended).
|
541
|
+
allow_invalid_files: true, # BOOLEAN | Set to false to block invalid files, such as a PDF file that is not really a valid PDF file, or a Word Document that is not a valid Word Document. Default is false (recommended).
|
542
|
+
allow_scripts: true, # BOOLEAN | Set to false to block script files, such as a PHP files, Python scripts, and other malicious content or security threats that can be embedded in the file. Set to true to allow these file types. Default is false (recommended).
|
543
|
+
allow_password_protected_files: true, # BOOLEAN | Set to false to block password protected and encrypted files, such as encrypted zip and rar files, and other files that seek to circumvent scanning through passwords. Set to true to allow these file types. Default is false (recommended).
|
544
|
+
allow_macros: true, # BOOLEAN | Set to false to block macros and other threats embedded in document files, such as Word, Excel and PowerPoint embedded Macros, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).
|
545
|
+
allow_xml_external_entities: true, # BOOLEAN | Set to false to block XML External Entities and other threats embedded in XML files, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).
|
546
|
+
restrict_file_types: 'restrict_file_types_example' # String | Specify a restricted set of file formats to allow as clean as a comma-separated list of file formats, such as .pdf,.docx,.png would allow only PDF, PNG and Word document files. All files must pass content verification against this list of file formats, if they do not, then the result will be returned as CleanResult=false. Set restrictFileTypes parameter to null or empty string to disable; default is disabled.
|
547
|
+
}
|
548
|
+
|
549
|
+
begin
|
550
|
+
#Advanced Virus Scan a file in a SharePoint Online Site Drive
|
551
|
+
result = api_instance.scan_cloud_storage_scan_share_point_online_file_advanced(client_id, client_secret, sharepoint_domain_name, site_id, file_path, opts)
|
552
|
+
p result
|
553
|
+
rescue CloudmersiveVirusScanApiClient::ApiError => e
|
554
|
+
puts "Exception when calling ScanCloudStorageApi->scan_cloud_storage_scan_share_point_online_file_advanced: #{e}"
|
555
|
+
end
|
556
|
+
```
|
557
|
+
|
558
|
+
### Parameters
|
559
|
+
|
560
|
+
Name | Type | Description | Notes
|
561
|
+
------------- | ------------- | ------------- | -------------
|
562
|
+
**client_id** | **String**| Client ID access credentials; see description above for instructions on how to get the Client ID from the Azure Active Directory portal. |
|
563
|
+
**client_secret** | **String**| Client Secret access credentials; see description above for instructions on how to get the Client Secret from the Azure Active Directory portal |
|
564
|
+
**sharepoint_domain_name** | **String**| SharePoint Online domain name, such as mydomain.sharepoint.com |
|
565
|
+
**site_id** | **String**| Site ID (GUID) of the SharePoint site you wish to retrieve the file from |
|
566
|
+
**file_path** | **String**| Path to the file within the drive, such as 'hello.pdf' or '/folder/subfolder/world.pdf' |
|
567
|
+
**tenant_id** | **String**| Optional; Tenant ID of your Azure Active Directory | [optional]
|
568
|
+
**allow_executables** | **BOOLEAN**| Set to false to block executable files (program code) from being allowed in the input file. Default is false (recommended). | [optional]
|
569
|
+
**allow_invalid_files** | **BOOLEAN**| Set to false to block invalid files, such as a PDF file that is not really a valid PDF file, or a Word Document that is not a valid Word Document. Default is false (recommended). | [optional]
|
570
|
+
**allow_scripts** | **BOOLEAN**| Set to false to block script files, such as a PHP files, Python scripts, and other malicious content or security threats that can be embedded in the file. Set to true to allow these file types. Default is false (recommended). | [optional]
|
571
|
+
**allow_password_protected_files** | **BOOLEAN**| Set to false to block password protected and encrypted files, such as encrypted zip and rar files, and other files that seek to circumvent scanning through passwords. Set to true to allow these file types. Default is false (recommended). | [optional]
|
572
|
+
**allow_macros** | **BOOLEAN**| Set to false to block macros and other threats embedded in document files, such as Word, Excel and PowerPoint embedded Macros, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended). | [optional]
|
573
|
+
**allow_xml_external_entities** | **BOOLEAN**| Set to false to block XML External Entities and other threats embedded in XML files, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended). | [optional]
|
574
|
+
**restrict_file_types** | **String**| Specify a restricted set of file formats to allow as clean as a comma-separated list of file formats, such as .pdf,.docx,.png would allow only PDF, PNG and Word document files. All files must pass content verification against this list of file formats, if they do not, then the result will be returned as CleanResult=false. Set restrictFileTypes parameter to null or empty string to disable; default is disabled. | [optional]
|
575
|
+
|
576
|
+
### Return type
|
577
|
+
|
578
|
+
[**CloudStorageAdvancedVirusScanResult**](CloudStorageAdvancedVirusScanResult.md)
|
579
|
+
|
580
|
+
### Authorization
|
581
|
+
|
582
|
+
[Apikey](../README.md#Apikey)
|
583
|
+
|
584
|
+
### HTTP request headers
|
585
|
+
|
586
|
+
- **Content-Type**: multipart/form-data
|
587
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
588
|
+
|
589
|
+
|
590
|
+
|
@@ -9,6 +9,8 @@ Name | Type | Description | Notes
|
|
9
9
|
**contains_script** | **BOOLEAN** | True if the scan contained a script (such as a PHP script, Python script, etc.) which can be a significant risk factor | [optional]
|
10
10
|
**contains_password_protected_file** | **BOOLEAN** | True if the scan contained a password protected or encrypted file, which can be a significant risk factor | [optional]
|
11
11
|
**contains_restricted_file_format** | **BOOLEAN** | True if the uploaded file is of a type that is not allowed based on the optional restrictFileTypes parameter, false otherwise; if restrictFileTypes is not set, this will always be false | [optional]
|
12
|
+
**contains_macros** | **BOOLEAN** | True if the uploaded file contains embedded Macros of other embedded threats within the document, which can be a significant risk factor | [optional]
|
13
|
+
**contains_xml_external_entities** | **BOOLEAN** | True if the uploaded file contains embedded XML External Entity threats of other embedded threats within the document, which can be a significant risk factor | [optional]
|
12
14
|
**verified_file_format** | **String** | For file format verification-supported file formats, the contents-verified file format of the file. Null indicates that the file format is not supported for contents verification. If a Virus or Malware is found, this field will always be set to Null. | [optional]
|
13
15
|
**found_viruses** | [**Array<VirusFound>**](VirusFound.md) | Array of viruses found, if any | [optional]
|
14
16
|
|
@@ -82,6 +82,8 @@ module CloudmersiveVirusScanApiClient
|
|
82
82
|
# @option opts [BOOLEAN] :allow_invalid_files Set to false to block invalid files, such as a PDF file that is not really a valid PDF file, or a Word Document that is not a valid Word Document. Default is false (recommended).
|
83
83
|
# @option opts [BOOLEAN] :allow_scripts Set to false to block script files, such as a PHP files, Python scripts, and other malicious content or security threats that can be embedded in the file. Set to true to allow these file types. Default is false (recommended).
|
84
84
|
# @option opts [BOOLEAN] :allow_password_protected_files Set to false to block password protected and encrypted files, such as encrypted zip and rar files, and other files that seek to circumvent scanning through passwords. Set to true to allow these file types. Default is false (recommended).
|
85
|
+
# @option opts [BOOLEAN] :allow_macros Set to false to block macros and other threats embedded in document files, such as Word, Excel and PowerPoint embedded Macros, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).
|
86
|
+
# @option opts [BOOLEAN] :allow_xml_external_entities Set to false to block XML External Entities and other threats embedded in XML files, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).
|
85
87
|
# @option opts [String] :restrict_file_types Specify a restricted set of file formats to allow as clean as a comma-separated list of file formats, such as .pdf,.docx,.png would allow only PDF, PNG and Word document files. All files must pass content verification against this list of file formats, if they do not, then the result will be returned as CleanResult=false. Set restrictFileTypes parameter to null or empty string to disable; default is disabled.
|
86
88
|
# @return [VirusScanAdvancedResult]
|
87
89
|
def scan_file_advanced(input_file, opts = {})
|
@@ -97,6 +99,8 @@ module CloudmersiveVirusScanApiClient
|
|
97
99
|
# @option opts [BOOLEAN] :allow_invalid_files Set to false to block invalid files, such as a PDF file that is not really a valid PDF file, or a Word Document that is not a valid Word Document. Default is false (recommended).
|
98
100
|
# @option opts [BOOLEAN] :allow_scripts Set to false to block script files, such as a PHP files, Python scripts, and other malicious content or security threats that can be embedded in the file. Set to true to allow these file types. Default is false (recommended).
|
99
101
|
# @option opts [BOOLEAN] :allow_password_protected_files Set to false to block password protected and encrypted files, such as encrypted zip and rar files, and other files that seek to circumvent scanning through passwords. Set to true to allow these file types. Default is false (recommended).
|
102
|
+
# @option opts [BOOLEAN] :allow_macros Set to false to block macros and other threats embedded in document files, such as Word, Excel and PowerPoint embedded Macros, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).
|
103
|
+
# @option opts [BOOLEAN] :allow_xml_external_entities Set to false to block XML External Entities and other threats embedded in XML files, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).
|
100
104
|
# @option opts [String] :restrict_file_types Specify a restricted set of file formats to allow as clean as a comma-separated list of file formats, such as .pdf,.docx,.png would allow only PDF, PNG and Word document files. All files must pass content verification against this list of file formats, if they do not, then the result will be returned as CleanResult=false. Set restrictFileTypes parameter to null or empty string to disable; default is disabled.
|
101
105
|
# @return [Array<(VirusScanAdvancedResult, Fixnum, Hash)>] VirusScanAdvancedResult data, response status code and response headers
|
102
106
|
def scan_file_advanced_with_http_info(input_file, opts = {})
|
@@ -123,6 +127,8 @@ module CloudmersiveVirusScanApiClient
|
|
123
127
|
header_params[:'allowInvalidFiles'] = opts[:'allow_invalid_files'] if !opts[:'allow_invalid_files'].nil?
|
124
128
|
header_params[:'allowScripts'] = opts[:'allow_scripts'] if !opts[:'allow_scripts'].nil?
|
125
129
|
header_params[:'allowPasswordProtectedFiles'] = opts[:'allow_password_protected_files'] if !opts[:'allow_password_protected_files'].nil?
|
130
|
+
header_params[:'allowMacros'] = opts[:'allow_macros'] if !opts[:'allow_macros'].nil?
|
131
|
+
header_params[:'allowXmlExternalEntities'] = opts[:'allow_xml_external_entities'] if !opts[:'allow_xml_external_entities'].nil?
|
126
132
|
header_params[:'restrictFileTypes'] = opts[:'restrict_file_types'] if !opts[:'restrict_file_types'].nil?
|
127
133
|
|
128
134
|
# form parameters
|