cloudmersive-validate-api-client 2.1.5 → 2.2.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +31 -4
- data/docs/DomainApi.md +330 -0
- data/docs/IsAdminPathResponse.md +9 -0
- data/docs/PhishingCheckRequest.md +8 -0
- data/docs/PhishingCheckResponse.md +9 -0
- data/docs/SqlInjectionCheckBatchRequest.md +9 -0
- data/docs/SqlInjectionCheckBatchResponse.md +8 -0
- data/docs/SqlInjectionCheckRequestItem.md +8 -0
- data/docs/SqlInjectionDetectionResult.md +10 -0
- data/docs/TextInputApi.md +233 -1
- data/docs/UrlSafetyCheckRequestFull.md +8 -0
- data/docs/UrlSafetyCheckResponseFull.md +9 -0
- data/docs/UrlSsrfRequestBatch.md +8 -0
- data/docs/UrlSsrfRequestFull.md +9 -0
- data/docs/UrlSsrfResponseBatch.md +8 -0
- data/docs/UrlSsrfResponseFull.md +9 -0
- data/docs/ValidateUrlResponseSyntaxOnly.md +1 -0
- data/docs/XxeDetectionBatchRequest.md +8 -0
- data/docs/XxeDetectionBatchResponse.md +8 -0
- data/docs/XxeDetectionRequestItem.md +11 -0
- data/docs/XxeDetectionResult.md +9 -0
- data/lib/cloudmersive-validate-api-client.rb +17 -0
- data/lib/cloudmersive-validate-api-client/api/domain_api.rb +324 -0
- data/lib/cloudmersive-validate-api-client/api/text_input_api.rb +230 -2
- data/lib/cloudmersive-validate-api-client/models/is_admin_path_response.rb +196 -0
- data/lib/cloudmersive-validate-api-client/models/phishing_check_request.rb +186 -0
- data/lib/cloudmersive-validate-api-client/models/phishing_check_response.rb +196 -0
- data/lib/cloudmersive-validate-api-client/models/sql_injection_check_batch_request.rb +198 -0
- data/lib/cloudmersive-validate-api-client/models/sql_injection_check_batch_response.rb +188 -0
- data/lib/cloudmersive-validate-api-client/models/sql_injection_check_request_item.rb +186 -0
- data/lib/cloudmersive-validate-api-client/models/sql_injection_detection_result.rb +206 -0
- data/lib/cloudmersive-validate-api-client/models/url_safety_check_request_full.rb +186 -0
- data/lib/cloudmersive-validate-api-client/models/url_safety_check_response_full.rb +196 -0
- data/lib/cloudmersive-validate-api-client/models/url_ssrf_request_batch.rb +188 -0
- data/lib/cloudmersive-validate-api-client/models/url_ssrf_request_full.rb +198 -0
- data/lib/cloudmersive-validate-api-client/models/url_ssrf_response_batch.rb +188 -0
- data/lib/cloudmersive-validate-api-client/models/url_ssrf_response_full.rb +196 -0
- data/lib/cloudmersive-validate-api-client/models/validate_url_response_syntax_only.rb +14 -4
- data/lib/cloudmersive-validate-api-client/models/xxe_detection_batch_request.rb +188 -0
- data/lib/cloudmersive-validate-api-client/models/xxe_detection_batch_response.rb +188 -0
- data/lib/cloudmersive-validate-api-client/models/xxe_detection_request_item.rb +220 -0
- data/lib/cloudmersive-validate-api-client/models/xxe_detection_result.rb +196 -0
- data/lib/cloudmersive-validate-api-client/version.rb +1 -1
- data/spec/api/domain_api_spec.rb +72 -0
- data/spec/api/text_input_api_spec.rb +53 -1
- data/spec/models/is_admin_path_response_spec.rb +47 -0
- data/spec/models/phishing_check_request_spec.rb +41 -0
- data/spec/models/phishing_check_response_spec.rb +47 -0
- data/spec/models/sql_injection_check_batch_request_spec.rb +47 -0
- data/spec/models/sql_injection_check_batch_response_spec.rb +41 -0
- data/spec/models/sql_injection_check_request_item_spec.rb +41 -0
- data/spec/models/sql_injection_detection_result_spec.rb +53 -0
- data/spec/models/url_safety_check_request_full_spec.rb +41 -0
- data/spec/models/url_safety_check_response_full_spec.rb +47 -0
- data/spec/models/url_ssrf_request_batch_spec.rb +41 -0
- data/spec/models/url_ssrf_request_full_spec.rb +47 -0
- data/spec/models/url_ssrf_response_batch_spec.rb +41 -0
- data/spec/models/url_ssrf_response_full_spec.rb +47 -0
- data/spec/models/validate_url_response_syntax_only_spec.rb +6 -0
- data/spec/models/xxe_detection_batch_request_spec.rb +41 -0
- data/spec/models/xxe_detection_batch_response_spec.rb +41 -0
- data/spec/models/xxe_detection_request_item_spec.rb +59 -0
- data/spec/models/xxe_detection_result_spec.rb +47 -0
- metadata +53 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 4a5d849be72f0460fb5087353a35c3c135c399728d5c20ad9eb73a6ad7314f02
|
|
4
|
+
data.tar.gz: caf6a09893146d0826ccaf1be78b231797e87b2f889060a343f8b78f3ef27cbd
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 1d1c337167f8e1f54c9b277c1247552517bb87c3b6eab3e49ed695bff3efaaf718b1f569064325f25b4bab59520861d477fcc1720424c187530ea859454bd346
|
|
7
|
+
data.tar.gz: 3b462325435212058db781798ae6fb84df3ea921cca9c90bdd94305925defd0599cd989ed45fd0ec5419e19cea783f10ca9f694c1052ff8d3b4f27dfe7e359f9
|
data/README.md
CHANGED
|
@@ -7,7 +7,7 @@ The validation APIs help you validate data. Check if an E-mail address is real.
|
|
|
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.
|
|
10
|
+
- Package version: 2.2.2
|
|
11
11
|
- Build package: io.swagger.codegen.languages.RubyClientCodegen
|
|
12
12
|
|
|
13
13
|
## Installation
|
|
@@ -23,15 +23,15 @@ gem build cloudmersive-validate-api-client.gemspec
|
|
|
23
23
|
Then either install the gem locally:
|
|
24
24
|
|
|
25
25
|
```shell
|
|
26
|
-
gem install ./cloudmersive-validate-api-client-2.
|
|
26
|
+
gem install ./cloudmersive-validate-api-client-2.2.2.gem
|
|
27
27
|
```
|
|
28
|
-
(for development, run `gem install --dev ./cloudmersive-validate-api-client-2.
|
|
28
|
+
(for development, run `gem install --dev ./cloudmersive-validate-api-client-2.2.2.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-validate-api-client', '~> 2.
|
|
34
|
+
gem 'cloudmersive-validate-api-client', '~> 2.2.2'
|
|
35
35
|
|
|
36
36
|
### Install from Git
|
|
37
37
|
|
|
@@ -102,8 +102,14 @@ Class | Method | HTTP request | Description
|
|
|
102
102
|
*CloudmersiveValidateApiClient::DateTimeApi* | [**date_time_parse_natural_language_date_time**](docs/DateTimeApi.md#date_time_parse_natural_language_date_time) | **POST** /validate/date-time/parse/date-time/natural-language | Parses a free-form natural language date and time string into a date and time
|
|
103
103
|
*CloudmersiveValidateApiClient::DateTimeApi* | [**date_time_parse_standard_date_time**](docs/DateTimeApi.md#date_time_parse_standard_date_time) | **POST** /validate/date-time/parse/date-time/structured | Parses a standardized date and time string into a date and time
|
|
104
104
|
*CloudmersiveValidateApiClient::DomainApi* | [**domain_check**](docs/DomainApi.md#domain_check) | **POST** /validate/domain/check | Validate a domain name
|
|
105
|
+
*CloudmersiveValidateApiClient::DomainApi* | [**domain_get_top_level_domain_from_url**](docs/DomainApi.md#domain_get_top_level_domain_from_url) | **POST** /validate/domain/url/get-top-level-domain | Get top-level domain name from URL
|
|
106
|
+
*CloudmersiveValidateApiClient::DomainApi* | [**domain_is_admin_path**](docs/DomainApi.md#domain_is_admin_path) | **POST** /validate/domain/url/is-admin-path | Check if path is a high-risk server administration path
|
|
107
|
+
*CloudmersiveValidateApiClient::DomainApi* | [**domain_phishing_check**](docs/DomainApi.md#domain_phishing_check) | **POST** /validate/domain/url/phishing-threat-check | Check a URL for Phishing threats
|
|
105
108
|
*CloudmersiveValidateApiClient::DomainApi* | [**domain_post**](docs/DomainApi.md#domain_post) | **POST** /validate/domain/whois | Get WHOIS information for a domain
|
|
106
109
|
*CloudmersiveValidateApiClient::DomainApi* | [**domain_quality_score**](docs/DomainApi.md#domain_quality_score) | **POST** /validate/domain/quality-score | Validate a domain name's quality score
|
|
110
|
+
*CloudmersiveValidateApiClient::DomainApi* | [**domain_safety_check**](docs/DomainApi.md#domain_safety_check) | **POST** /validate/domain/url/safety-threat-check | Check a URL for safety threats
|
|
111
|
+
*CloudmersiveValidateApiClient::DomainApi* | [**domain_ssrf_check**](docs/DomainApi.md#domain_ssrf_check) | **POST** /validate/domain/url/ssrf-threat-check | Check a URL for SSRF threats
|
|
112
|
+
*CloudmersiveValidateApiClient::DomainApi* | [**domain_ssrf_check_batch**](docs/DomainApi.md#domain_ssrf_check_batch) | **POST** /validate/domain/url/ssrf-threat-check/batch | Check a URL for SSRF threats in batches
|
|
107
113
|
*CloudmersiveValidateApiClient::DomainApi* | [**domain_url_full**](docs/DomainApi.md#domain_url_full) | **POST** /validate/domain/url/full | Validate a URL fully
|
|
108
114
|
*CloudmersiveValidateApiClient::DomainApi* | [**domain_url_syntax_only**](docs/DomainApi.md#domain_url_syntax_only) | **POST** /validate/domain/url/syntax-only | Validate a URL syntactically
|
|
109
115
|
*CloudmersiveValidateApiClient::EmailApi* | [**email_address_get_servers**](docs/EmailApi.md#email_address_get_servers) | **POST** /validate/email/address/servers | Partially check whether an email address is valid
|
|
@@ -123,8 +129,12 @@ Class | Method | HTTP request | Description
|
|
|
123
129
|
*CloudmersiveValidateApiClient::NameApi* | [**name_validate_full_name**](docs/NameApi.md#name_validate_full_name) | **POST** /validate/name/full-name | Parse and validate a full name
|
|
124
130
|
*CloudmersiveValidateApiClient::NameApi* | [**name_validate_last_name**](docs/NameApi.md#name_validate_last_name) | **POST** /validate/name/last | Validate a last name
|
|
125
131
|
*CloudmersiveValidateApiClient::PhoneNumberApi* | [**phone_number_syntax_only**](docs/PhoneNumberApi.md#phone_number_syntax_only) | **POST** /validate/phonenumber/basic | Validate phone number (basic)
|
|
132
|
+
*CloudmersiveValidateApiClient::TextInputApi* | [**text_input_check_sql_injection**](docs/TextInputApi.md#text_input_check_sql_injection) | **POST** /validate/text-input/check/sql-injection | Check text input for SQL Injection (SQLI) attacks
|
|
133
|
+
*CloudmersiveValidateApiClient::TextInputApi* | [**text_input_check_sql_injection_batch**](docs/TextInputApi.md#text_input_check_sql_injection_batch) | **POST** /validate/text-input/check/sql-injection/batch | Check and protect multiple text inputs for SQL Injection (SQLI) attacks in batch
|
|
126
134
|
*CloudmersiveValidateApiClient::TextInputApi* | [**text_input_check_xss**](docs/TextInputApi.md#text_input_check_xss) | **POST** /validate/text-input/check/xss | Check text input for Cross-Site-Scripting (XSS) attacks
|
|
127
135
|
*CloudmersiveValidateApiClient::TextInputApi* | [**text_input_check_xss_batch**](docs/TextInputApi.md#text_input_check_xss_batch) | **POST** /validate/text-input/check-and-protect/xss/batch | Check and protect multiple text inputs for Cross-Site-Scripting (XSS) attacks in batch
|
|
136
|
+
*CloudmersiveValidateApiClient::TextInputApi* | [**text_input_check_xxe**](docs/TextInputApi.md#text_input_check_xxe) | **POST** /validate/text-input/check/xxe | Protect text input from XML External Entity (XXE) attacks
|
|
137
|
+
*CloudmersiveValidateApiClient::TextInputApi* | [**text_input_check_xxe_batch**](docs/TextInputApi.md#text_input_check_xxe_batch) | **POST** /validate/text-input/check/xxe/batch | Protect text input from XML External Entity (XXE) attacks
|
|
128
138
|
*CloudmersiveValidateApiClient::TextInputApi* | [**text_input_protect_xss**](docs/TextInputApi.md#text_input_protect_xss) | **POST** /validate/text-input/protect/xss | Protect text input from Cross-Site-Scripting (XSS) attacks through normalization
|
|
129
139
|
*CloudmersiveValidateApiClient::UserAgentApi* | [**user_agent_parse**](docs/UserAgentApi.md#user_agent_parse) | **POST** /validate/useragent/parse | Parse an HTTP User-Agent string, identify robots
|
|
130
140
|
*CloudmersiveValidateApiClient::VatApi* | [**vat_vat_lookup**](docs/VatApi.md#vat_vat_lookup) | **POST** /validate/vat/lookup | Validate a VAT number
|
|
@@ -158,6 +168,7 @@ Class | Method | HTTP request | Description
|
|
|
158
168
|
- [CloudmersiveValidateApiClient::IPIntelligenceResponse](docs/IPIntelligenceResponse.md)
|
|
159
169
|
- [CloudmersiveValidateApiClient::IPReverseDNSLookupResponse](docs/IPReverseDNSLookupResponse.md)
|
|
160
170
|
- [CloudmersiveValidateApiClient::IPThreatResponse](docs/IPThreatResponse.md)
|
|
171
|
+
- [CloudmersiveValidateApiClient::IsAdminPathResponse](docs/IsAdminPathResponse.md)
|
|
161
172
|
- [CloudmersiveValidateApiClient::LastNameValidationRequest](docs/LastNameValidationRequest.md)
|
|
162
173
|
- [CloudmersiveValidateApiClient::LastNameValidationResponse](docs/LastNameValidationResponse.md)
|
|
163
174
|
- [CloudmersiveValidateApiClient::LeadEnrichmentRequest](docs/LeadEnrichmentRequest.md)
|
|
@@ -165,14 +176,26 @@ Class | Method | HTTP request | Description
|
|
|
165
176
|
- [CloudmersiveValidateApiClient::NormalizeAddressResponse](docs/NormalizeAddressResponse.md)
|
|
166
177
|
- [CloudmersiveValidateApiClient::ParseAddressRequest](docs/ParseAddressRequest.md)
|
|
167
178
|
- [CloudmersiveValidateApiClient::ParseAddressResponse](docs/ParseAddressResponse.md)
|
|
179
|
+
- [CloudmersiveValidateApiClient::PhishingCheckRequest](docs/PhishingCheckRequest.md)
|
|
180
|
+
- [CloudmersiveValidateApiClient::PhishingCheckResponse](docs/PhishingCheckResponse.md)
|
|
168
181
|
- [CloudmersiveValidateApiClient::PhoneNumberValidateRequest](docs/PhoneNumberValidateRequest.md)
|
|
169
182
|
- [CloudmersiveValidateApiClient::PhoneNumberValidationResponse](docs/PhoneNumberValidationResponse.md)
|
|
170
183
|
- [CloudmersiveValidateApiClient::PublicHolidayOccurrence](docs/PublicHolidayOccurrence.md)
|
|
171
184
|
- [CloudmersiveValidateApiClient::PublicHolidaysResponse](docs/PublicHolidaysResponse.md)
|
|
172
185
|
- [CloudmersiveValidateApiClient::ReverseGeocodeAddressRequest](docs/ReverseGeocodeAddressRequest.md)
|
|
173
186
|
- [CloudmersiveValidateApiClient::ReverseGeocodeAddressResponse](docs/ReverseGeocodeAddressResponse.md)
|
|
187
|
+
- [CloudmersiveValidateApiClient::SqlInjectionCheckBatchRequest](docs/SqlInjectionCheckBatchRequest.md)
|
|
188
|
+
- [CloudmersiveValidateApiClient::SqlInjectionCheckBatchResponse](docs/SqlInjectionCheckBatchResponse.md)
|
|
189
|
+
- [CloudmersiveValidateApiClient::SqlInjectionCheckRequestItem](docs/SqlInjectionCheckRequestItem.md)
|
|
190
|
+
- [CloudmersiveValidateApiClient::SqlInjectionDetectionResult](docs/SqlInjectionDetectionResult.md)
|
|
174
191
|
- [CloudmersiveValidateApiClient::Timezone](docs/Timezone.md)
|
|
175
192
|
- [CloudmersiveValidateApiClient::TorNodeResponse](docs/TorNodeResponse.md)
|
|
193
|
+
- [CloudmersiveValidateApiClient::UrlSafetyCheckRequestFull](docs/UrlSafetyCheckRequestFull.md)
|
|
194
|
+
- [CloudmersiveValidateApiClient::UrlSafetyCheckResponseFull](docs/UrlSafetyCheckResponseFull.md)
|
|
195
|
+
- [CloudmersiveValidateApiClient::UrlSsrfRequestBatch](docs/UrlSsrfRequestBatch.md)
|
|
196
|
+
- [CloudmersiveValidateApiClient::UrlSsrfRequestFull](docs/UrlSsrfRequestFull.md)
|
|
197
|
+
- [CloudmersiveValidateApiClient::UrlSsrfResponseBatch](docs/UrlSsrfResponseBatch.md)
|
|
198
|
+
- [CloudmersiveValidateApiClient::UrlSsrfResponseFull](docs/UrlSsrfResponseFull.md)
|
|
176
199
|
- [CloudmersiveValidateApiClient::UserAgentValidateRequest](docs/UserAgentValidateRequest.md)
|
|
177
200
|
- [CloudmersiveValidateApiClient::UserAgentValidateResponse](docs/UserAgentValidateResponse.md)
|
|
178
201
|
- [CloudmersiveValidateApiClient::ValidateAddressRequest](docs/ValidateAddressRequest.md)
|
|
@@ -198,6 +221,10 @@ Class | Method | HTTP request | Description
|
|
|
198
221
|
- [CloudmersiveValidateApiClient::XssProtectionBatchResponse](docs/XssProtectionBatchResponse.md)
|
|
199
222
|
- [CloudmersiveValidateApiClient::XssProtectionRequestItem](docs/XssProtectionRequestItem.md)
|
|
200
223
|
- [CloudmersiveValidateApiClient::XssProtectionResult](docs/XssProtectionResult.md)
|
|
224
|
+
- [CloudmersiveValidateApiClient::XxeDetectionBatchRequest](docs/XxeDetectionBatchRequest.md)
|
|
225
|
+
- [CloudmersiveValidateApiClient::XxeDetectionBatchResponse](docs/XxeDetectionBatchResponse.md)
|
|
226
|
+
- [CloudmersiveValidateApiClient::XxeDetectionRequestItem](docs/XxeDetectionRequestItem.md)
|
|
227
|
+
- [CloudmersiveValidateApiClient::XxeDetectionResult](docs/XxeDetectionResult.md)
|
|
201
228
|
|
|
202
229
|
|
|
203
230
|
## Documentation for Authorization
|
data/docs/DomainApi.md
CHANGED
|
@@ -5,8 +5,14 @@ All URIs are relative to *https://api.cloudmersive.com*
|
|
|
5
5
|
Method | HTTP request | Description
|
|
6
6
|
------------- | ------------- | -------------
|
|
7
7
|
[**domain_check**](DomainApi.md#domain_check) | **POST** /validate/domain/check | Validate a domain name
|
|
8
|
+
[**domain_get_top_level_domain_from_url**](DomainApi.md#domain_get_top_level_domain_from_url) | **POST** /validate/domain/url/get-top-level-domain | Get top-level domain name from URL
|
|
9
|
+
[**domain_is_admin_path**](DomainApi.md#domain_is_admin_path) | **POST** /validate/domain/url/is-admin-path | Check if path is a high-risk server administration path
|
|
10
|
+
[**domain_phishing_check**](DomainApi.md#domain_phishing_check) | **POST** /validate/domain/url/phishing-threat-check | Check a URL for Phishing threats
|
|
8
11
|
[**domain_post**](DomainApi.md#domain_post) | **POST** /validate/domain/whois | Get WHOIS information for a domain
|
|
9
12
|
[**domain_quality_score**](DomainApi.md#domain_quality_score) | **POST** /validate/domain/quality-score | Validate a domain name's quality score
|
|
13
|
+
[**domain_safety_check**](DomainApi.md#domain_safety_check) | **POST** /validate/domain/url/safety-threat-check | Check a URL for safety threats
|
|
14
|
+
[**domain_ssrf_check**](DomainApi.md#domain_ssrf_check) | **POST** /validate/domain/url/ssrf-threat-check | Check a URL for SSRF threats
|
|
15
|
+
[**domain_ssrf_check_batch**](DomainApi.md#domain_ssrf_check_batch) | **POST** /validate/domain/url/ssrf-threat-check/batch | Check a URL for SSRF threats in batches
|
|
10
16
|
[**domain_url_full**](DomainApi.md#domain_url_full) | **POST** /validate/domain/url/full | Validate a URL fully
|
|
11
17
|
[**domain_url_syntax_only**](DomainApi.md#domain_url_syntax_only) | **POST** /validate/domain/url/syntax-only | Validate a URL syntactically
|
|
12
18
|
|
|
@@ -65,6 +71,168 @@ Name | Type | Description | Notes
|
|
|
65
71
|
|
|
66
72
|
|
|
67
73
|
|
|
74
|
+
# **domain_get_top_level_domain_from_url**
|
|
75
|
+
> ValidateUrlResponseSyntaxOnly domain_get_top_level_domain_from_url(request)
|
|
76
|
+
|
|
77
|
+
Get top-level domain name from URL
|
|
78
|
+
|
|
79
|
+
Gets the top-level domain name from a URL, such as mydomain.com.
|
|
80
|
+
|
|
81
|
+
### Example
|
|
82
|
+
```ruby
|
|
83
|
+
# load the gem
|
|
84
|
+
require 'cloudmersive-validate-api-client'
|
|
85
|
+
# setup authorization
|
|
86
|
+
CloudmersiveValidateApiClient.configure do |config|
|
|
87
|
+
# Configure API key authorization: Apikey
|
|
88
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
89
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
90
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
91
|
+
end
|
|
92
|
+
|
|
93
|
+
api_instance = CloudmersiveValidateApiClient::DomainApi.new
|
|
94
|
+
|
|
95
|
+
request = CloudmersiveValidateApiClient::ValidateUrlRequestSyntaxOnly.new # ValidateUrlRequestSyntaxOnly | Input URL information
|
|
96
|
+
|
|
97
|
+
|
|
98
|
+
begin
|
|
99
|
+
#Get top-level domain name from URL
|
|
100
|
+
result = api_instance.domain_get_top_level_domain_from_url(request)
|
|
101
|
+
p result
|
|
102
|
+
rescue CloudmersiveValidateApiClient::ApiError => e
|
|
103
|
+
puts "Exception when calling DomainApi->domain_get_top_level_domain_from_url: #{e}"
|
|
104
|
+
end
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
### Parameters
|
|
108
|
+
|
|
109
|
+
Name | Type | Description | Notes
|
|
110
|
+
------------- | ------------- | ------------- | -------------
|
|
111
|
+
**request** | [**ValidateUrlRequestSyntaxOnly**](ValidateUrlRequestSyntaxOnly.md)| Input URL information |
|
|
112
|
+
|
|
113
|
+
### Return type
|
|
114
|
+
|
|
115
|
+
[**ValidateUrlResponseSyntaxOnly**](ValidateUrlResponseSyntaxOnly.md)
|
|
116
|
+
|
|
117
|
+
### Authorization
|
|
118
|
+
|
|
119
|
+
[Apikey](../README.md#Apikey)
|
|
120
|
+
|
|
121
|
+
### HTTP request headers
|
|
122
|
+
|
|
123
|
+
- **Content-Type**: application/json, text/json
|
|
124
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
# **domain_is_admin_path**
|
|
129
|
+
> IsAdminPathResponse domain_is_admin_path(value)
|
|
130
|
+
|
|
131
|
+
Check if path is a high-risk server administration path
|
|
132
|
+
|
|
133
|
+
Check if the input URL or relative path is a server Administration Path, and therefore a risk for remote access.
|
|
134
|
+
|
|
135
|
+
### Example
|
|
136
|
+
```ruby
|
|
137
|
+
# load the gem
|
|
138
|
+
require 'cloudmersive-validate-api-client'
|
|
139
|
+
# setup authorization
|
|
140
|
+
CloudmersiveValidateApiClient.configure do |config|
|
|
141
|
+
# Configure API key authorization: Apikey
|
|
142
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
143
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
144
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
145
|
+
end
|
|
146
|
+
|
|
147
|
+
api_instance = CloudmersiveValidateApiClient::DomainApi.new
|
|
148
|
+
|
|
149
|
+
value = 'value_example' # String | URL or relative path to check, e.g. \"/admin/login\". The input is a string so be sure to enclose it in double-quotes.
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
begin
|
|
153
|
+
#Check if path is a high-risk server administration path
|
|
154
|
+
result = api_instance.domain_is_admin_path(value)
|
|
155
|
+
p result
|
|
156
|
+
rescue CloudmersiveValidateApiClient::ApiError => e
|
|
157
|
+
puts "Exception when calling DomainApi->domain_is_admin_path: #{e}"
|
|
158
|
+
end
|
|
159
|
+
```
|
|
160
|
+
|
|
161
|
+
### Parameters
|
|
162
|
+
|
|
163
|
+
Name | Type | Description | Notes
|
|
164
|
+
------------- | ------------- | ------------- | -------------
|
|
165
|
+
**value** | **String**| URL or relative path to check, e.g. \"/admin/login\". The input is a string so be sure to enclose it in double-quotes. |
|
|
166
|
+
|
|
167
|
+
### Return type
|
|
168
|
+
|
|
169
|
+
[**IsAdminPathResponse**](IsAdminPathResponse.md)
|
|
170
|
+
|
|
171
|
+
### Authorization
|
|
172
|
+
|
|
173
|
+
[Apikey](../README.md#Apikey)
|
|
174
|
+
|
|
175
|
+
### HTTP request headers
|
|
176
|
+
|
|
177
|
+
- **Content-Type**: application/json, text/json
|
|
178
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
# **domain_phishing_check**
|
|
183
|
+
> PhishingCheckResponse domain_phishing_check(request)
|
|
184
|
+
|
|
185
|
+
Check a URL for Phishing threats
|
|
186
|
+
|
|
187
|
+
Checks if an input URL is at risk of being an Phishing (fake login page, or other page designed to collect information via social engineering) threat or attack.
|
|
188
|
+
|
|
189
|
+
### Example
|
|
190
|
+
```ruby
|
|
191
|
+
# load the gem
|
|
192
|
+
require 'cloudmersive-validate-api-client'
|
|
193
|
+
# setup authorization
|
|
194
|
+
CloudmersiveValidateApiClient.configure do |config|
|
|
195
|
+
# Configure API key authorization: Apikey
|
|
196
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
197
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
198
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
199
|
+
end
|
|
200
|
+
|
|
201
|
+
api_instance = CloudmersiveValidateApiClient::DomainApi.new
|
|
202
|
+
|
|
203
|
+
request = CloudmersiveValidateApiClient::PhishingCheckRequest.new # PhishingCheckRequest | Input URL request
|
|
204
|
+
|
|
205
|
+
|
|
206
|
+
begin
|
|
207
|
+
#Check a URL for Phishing threats
|
|
208
|
+
result = api_instance.domain_phishing_check(request)
|
|
209
|
+
p result
|
|
210
|
+
rescue CloudmersiveValidateApiClient::ApiError => e
|
|
211
|
+
puts "Exception when calling DomainApi->domain_phishing_check: #{e}"
|
|
212
|
+
end
|
|
213
|
+
```
|
|
214
|
+
|
|
215
|
+
### Parameters
|
|
216
|
+
|
|
217
|
+
Name | Type | Description | Notes
|
|
218
|
+
------------- | ------------- | ------------- | -------------
|
|
219
|
+
**request** | [**PhishingCheckRequest**](PhishingCheckRequest.md)| Input URL request |
|
|
220
|
+
|
|
221
|
+
### Return type
|
|
222
|
+
|
|
223
|
+
[**PhishingCheckResponse**](PhishingCheckResponse.md)
|
|
224
|
+
|
|
225
|
+
### Authorization
|
|
226
|
+
|
|
227
|
+
[Apikey](../README.md#Apikey)
|
|
228
|
+
|
|
229
|
+
### HTTP request headers
|
|
230
|
+
|
|
231
|
+
- **Content-Type**: application/json, text/json
|
|
232
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
233
|
+
|
|
234
|
+
|
|
235
|
+
|
|
68
236
|
# **domain_post**
|
|
69
237
|
> WhoisResponse domain_post(domain)
|
|
70
238
|
|
|
@@ -173,6 +341,168 @@ Name | Type | Description | Notes
|
|
|
173
341
|
|
|
174
342
|
|
|
175
343
|
|
|
344
|
+
# **domain_safety_check**
|
|
345
|
+
> UrlSafetyCheckResponseFull domain_safety_check(request)
|
|
346
|
+
|
|
347
|
+
Check a URL for safety threats
|
|
348
|
+
|
|
349
|
+
Checks if an input URL is at risk of being a safety threat through malware, unwanted software, or social engineering threats.
|
|
350
|
+
|
|
351
|
+
### Example
|
|
352
|
+
```ruby
|
|
353
|
+
# load the gem
|
|
354
|
+
require 'cloudmersive-validate-api-client'
|
|
355
|
+
# setup authorization
|
|
356
|
+
CloudmersiveValidateApiClient.configure do |config|
|
|
357
|
+
# Configure API key authorization: Apikey
|
|
358
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
359
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
360
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
361
|
+
end
|
|
362
|
+
|
|
363
|
+
api_instance = CloudmersiveValidateApiClient::DomainApi.new
|
|
364
|
+
|
|
365
|
+
request = CloudmersiveValidateApiClient::UrlSafetyCheckRequestFull.new # UrlSafetyCheckRequestFull | Input URL request
|
|
366
|
+
|
|
367
|
+
|
|
368
|
+
begin
|
|
369
|
+
#Check a URL for safety threats
|
|
370
|
+
result = api_instance.domain_safety_check(request)
|
|
371
|
+
p result
|
|
372
|
+
rescue CloudmersiveValidateApiClient::ApiError => e
|
|
373
|
+
puts "Exception when calling DomainApi->domain_safety_check: #{e}"
|
|
374
|
+
end
|
|
375
|
+
```
|
|
376
|
+
|
|
377
|
+
### Parameters
|
|
378
|
+
|
|
379
|
+
Name | Type | Description | Notes
|
|
380
|
+
------------- | ------------- | ------------- | -------------
|
|
381
|
+
**request** | [**UrlSafetyCheckRequestFull**](UrlSafetyCheckRequestFull.md)| Input URL request |
|
|
382
|
+
|
|
383
|
+
### Return type
|
|
384
|
+
|
|
385
|
+
[**UrlSafetyCheckResponseFull**](UrlSafetyCheckResponseFull.md)
|
|
386
|
+
|
|
387
|
+
### Authorization
|
|
388
|
+
|
|
389
|
+
[Apikey](../README.md#Apikey)
|
|
390
|
+
|
|
391
|
+
### HTTP request headers
|
|
392
|
+
|
|
393
|
+
- **Content-Type**: application/json, text/json
|
|
394
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
395
|
+
|
|
396
|
+
|
|
397
|
+
|
|
398
|
+
# **domain_ssrf_check**
|
|
399
|
+
> UrlSsrfResponseFull domain_ssrf_check(request)
|
|
400
|
+
|
|
401
|
+
Check a URL for SSRF threats
|
|
402
|
+
|
|
403
|
+
Checks if an input URL is at risk of being an SSRF (Server-side request forgery) threat or attack.
|
|
404
|
+
|
|
405
|
+
### Example
|
|
406
|
+
```ruby
|
|
407
|
+
# load the gem
|
|
408
|
+
require 'cloudmersive-validate-api-client'
|
|
409
|
+
# setup authorization
|
|
410
|
+
CloudmersiveValidateApiClient.configure do |config|
|
|
411
|
+
# Configure API key authorization: Apikey
|
|
412
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
413
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
414
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
415
|
+
end
|
|
416
|
+
|
|
417
|
+
api_instance = CloudmersiveValidateApiClient::DomainApi.new
|
|
418
|
+
|
|
419
|
+
request = CloudmersiveValidateApiClient::UrlSsrfRequestFull.new # UrlSsrfRequestFull | Input URL request
|
|
420
|
+
|
|
421
|
+
|
|
422
|
+
begin
|
|
423
|
+
#Check a URL for SSRF threats
|
|
424
|
+
result = api_instance.domain_ssrf_check(request)
|
|
425
|
+
p result
|
|
426
|
+
rescue CloudmersiveValidateApiClient::ApiError => e
|
|
427
|
+
puts "Exception when calling DomainApi->domain_ssrf_check: #{e}"
|
|
428
|
+
end
|
|
429
|
+
```
|
|
430
|
+
|
|
431
|
+
### Parameters
|
|
432
|
+
|
|
433
|
+
Name | Type | Description | Notes
|
|
434
|
+
------------- | ------------- | ------------- | -------------
|
|
435
|
+
**request** | [**UrlSsrfRequestFull**](UrlSsrfRequestFull.md)| Input URL request |
|
|
436
|
+
|
|
437
|
+
### Return type
|
|
438
|
+
|
|
439
|
+
[**UrlSsrfResponseFull**](UrlSsrfResponseFull.md)
|
|
440
|
+
|
|
441
|
+
### Authorization
|
|
442
|
+
|
|
443
|
+
[Apikey](../README.md#Apikey)
|
|
444
|
+
|
|
445
|
+
### HTTP request headers
|
|
446
|
+
|
|
447
|
+
- **Content-Type**: application/json, text/json
|
|
448
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
449
|
+
|
|
450
|
+
|
|
451
|
+
|
|
452
|
+
# **domain_ssrf_check_batch**
|
|
453
|
+
> UrlSsrfResponseBatch domain_ssrf_check_batch(request)
|
|
454
|
+
|
|
455
|
+
Check a URL for SSRF threats in batches
|
|
456
|
+
|
|
457
|
+
Batch-checks if input URLs are at risk of being an SSRF (Server-side request forgery) threat or attack.
|
|
458
|
+
|
|
459
|
+
### Example
|
|
460
|
+
```ruby
|
|
461
|
+
# load the gem
|
|
462
|
+
require 'cloudmersive-validate-api-client'
|
|
463
|
+
# setup authorization
|
|
464
|
+
CloudmersiveValidateApiClient.configure do |config|
|
|
465
|
+
# Configure API key authorization: Apikey
|
|
466
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
467
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
468
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
469
|
+
end
|
|
470
|
+
|
|
471
|
+
api_instance = CloudmersiveValidateApiClient::DomainApi.new
|
|
472
|
+
|
|
473
|
+
request = CloudmersiveValidateApiClient::UrlSsrfRequestBatch.new # UrlSsrfRequestBatch | Input URL request as a batch of multiple URLs
|
|
474
|
+
|
|
475
|
+
|
|
476
|
+
begin
|
|
477
|
+
#Check a URL for SSRF threats in batches
|
|
478
|
+
result = api_instance.domain_ssrf_check_batch(request)
|
|
479
|
+
p result
|
|
480
|
+
rescue CloudmersiveValidateApiClient::ApiError => e
|
|
481
|
+
puts "Exception when calling DomainApi->domain_ssrf_check_batch: #{e}"
|
|
482
|
+
end
|
|
483
|
+
```
|
|
484
|
+
|
|
485
|
+
### Parameters
|
|
486
|
+
|
|
487
|
+
Name | Type | Description | Notes
|
|
488
|
+
------------- | ------------- | ------------- | -------------
|
|
489
|
+
**request** | [**UrlSsrfRequestBatch**](UrlSsrfRequestBatch.md)| Input URL request as a batch of multiple URLs |
|
|
490
|
+
|
|
491
|
+
### Return type
|
|
492
|
+
|
|
493
|
+
[**UrlSsrfResponseBatch**](UrlSsrfResponseBatch.md)
|
|
494
|
+
|
|
495
|
+
### Authorization
|
|
496
|
+
|
|
497
|
+
[Apikey](../README.md#Apikey)
|
|
498
|
+
|
|
499
|
+
### HTTP request headers
|
|
500
|
+
|
|
501
|
+
- **Content-Type**: application/json, text/json
|
|
502
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
503
|
+
|
|
504
|
+
|
|
505
|
+
|
|
176
506
|
# **domain_url_full**
|
|
177
507
|
> ValidateUrlResponseFull domain_url_full(request)
|
|
178
508
|
|