cloudmersive-validate-api-client 2.1.1 → 2.1.6
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 +34 -4
- data/docs/AddressApi.md +55 -0
- data/docs/BotCheckResponse.md +8 -0
- data/docs/DateTimeApi.md +222 -0
- data/docs/DateTimeNaturalLanguageParseRequest.md +8 -0
- data/docs/DateTimeNowResult.md +10 -0
- data/docs/DateTimeStandardizedParseRequest.md +9 -0
- data/docs/DateTimeStandardizedParseResponse.md +16 -0
- data/docs/DomainApi.md +168 -3
- data/docs/EmailApi.md +3 -3
- data/docs/GetPublicHolidaysRequest.md +9 -0
- data/docs/IPAddressApi.md +169 -4
- data/docs/IPIntelligenceResponse.md +16 -0
- data/docs/IPReverseDNSLookupResponse.md +9 -0
- data/docs/NormalizeAddressResponse.md +18 -0
- data/docs/PublicHolidayOccurrence.md +12 -0
- data/docs/PublicHolidaysResponse.md +9 -0
- data/docs/TextInputApi.md +57 -2
- 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/XssProtectionBatchRequest.md +8 -0
- data/docs/XssProtectionBatchResponse.md +8 -0
- data/docs/XssProtectionRequestItem.md +8 -0
- data/lib/cloudmersive-validate-api-client.rb +19 -0
- data/lib/cloudmersive-validate-api-client/api/address_api.rb +54 -0
- data/lib/cloudmersive-validate-api-client/api/date_time_api.rb +231 -0
- data/lib/cloudmersive-validate-api-client/api/domain_api.rb +165 -3
- data/lib/cloudmersive-validate-api-client/api/email_api.rb +3 -3
- data/lib/cloudmersive-validate-api-client/api/ip_address_api.rb +166 -4
- data/lib/cloudmersive-validate-api-client/api/text_input_api.rb +56 -2
- data/lib/cloudmersive-validate-api-client/models/bot_check_response.rb +186 -0
- data/lib/cloudmersive-validate-api-client/models/date_time_natural_language_parse_request.rb +186 -0
- data/lib/cloudmersive-validate-api-client/models/date_time_now_result.rb +206 -0
- data/lib/cloudmersive-validate-api-client/models/date_time_standardized_parse_request.rb +196 -0
- data/lib/cloudmersive-validate-api-client/models/date_time_standardized_parse_response.rb +266 -0
- data/lib/cloudmersive-validate-api-client/models/geolocate_response.rb +1 -1
- data/lib/cloudmersive-validate-api-client/models/get_public_holidays_request.rb +196 -0
- data/lib/cloudmersive-validate-api-client/models/ip_intelligence_response.rb +266 -0
- data/lib/cloudmersive-validate-api-client/models/ip_reverse_dns_lookup_response.rb +196 -0
- data/lib/cloudmersive-validate-api-client/models/normalize_address_response.rb +286 -0
- data/lib/cloudmersive-validate-api-client/models/public_holiday_occurrence.rb +226 -0
- data/lib/cloudmersive-validate-api-client/models/public_holidays_response.rb +198 -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/xss_protection_batch_request.rb +188 -0
- data/lib/cloudmersive-validate-api-client/models/xss_protection_batch_response.rb +188 -0
- data/lib/cloudmersive-validate-api-client/models/xss_protection_request_item.rb +186 -0
- data/lib/cloudmersive-validate-api-client/version.rb +1 -1
- data/spec/api/address_api_spec.rb +12 -0
- data/spec/api/date_time_api_spec.rb +82 -0
- data/spec/api/domain_api_spec.rb +36 -0
- data/spec/api/ip_address_api_spec.rb +36 -0
- data/spec/api/text_input_api_spec.rb +12 -0
- data/spec/models/bot_check_response_spec.rb +41 -0
- data/spec/models/date_time_natural_language_parse_request_spec.rb +41 -0
- data/spec/models/date_time_now_result_spec.rb +53 -0
- data/spec/models/date_time_standardized_parse_request_spec.rb +47 -0
- data/spec/models/date_time_standardized_parse_response_spec.rb +89 -0
- data/spec/models/get_public_holidays_request_spec.rb +47 -0
- data/spec/models/ip_intelligence_response_spec.rb +89 -0
- data/spec/models/ip_reverse_dns_lookup_response_spec.rb +47 -0
- data/spec/models/normalize_address_response_spec.rb +101 -0
- data/spec/models/public_holiday_occurrence_spec.rb +65 -0
- data/spec/models/public_holidays_response_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/xss_protection_batch_request_spec.rb +41 -0
- data/spec/models/xss_protection_batch_response_spec.rb +41 -0
- data/spec/models/xss_protection_request_item_spec.rb +41 -0
- metadata +59 -2
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# CloudmersiveValidateApiClient::DateTimeNowResult
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**successful** | **BOOLEAN** | True if successful, false otherwise | [optional]
|
|
7
|
+
**now** | **DateTime** | Current date, time, and time zone in standard JSON date format | [optional]
|
|
8
|
+
**now_gmt** | **DateTime** | Current GMT-time-zone date, time, and time zone in standard JSON date format | [optional]
|
|
9
|
+
|
|
10
|
+
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# CloudmersiveValidateApiClient::DateTimeStandardizedParseRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**raw_date_time_input** | **String** | Raw string input of a standard-formatted date and time for parsing | [optional]
|
|
7
|
+
**country_code** | **String** | Optional: specify the two-letter country code to optimzie date formatting; default is US | [optional]
|
|
8
|
+
|
|
9
|
+
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# CloudmersiveValidateApiClient::DateTimeStandardizedParseResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**successful** | **BOOLEAN** | True if successful, false otherwise | [optional]
|
|
7
|
+
**parsed_date_result** | **DateTime** | Result of performing a date time parsing | [optional]
|
|
8
|
+
**year** | **Integer** | Year of the parsed date time result | [optional]
|
|
9
|
+
**month** | **Integer** | Month of the parsed date time result | [optional]
|
|
10
|
+
**day** | **Integer** | Day of the parsed date time result | [optional]
|
|
11
|
+
**hour** | **Integer** | Hour of the parsed date time result (24-hour) | [optional]
|
|
12
|
+
**minute** | **Integer** | Minute of the parsed date time result | [optional]
|
|
13
|
+
**second** | **Integer** | Second of the parsed date time result | [optional]
|
|
14
|
+
**day_of_week** | **String** | Day of week | [optional]
|
|
15
|
+
|
|
16
|
+
|
data/docs/DomainApi.md
CHANGED
|
@@ -5,8 +5,11 @@ 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
|
|
8
9
|
[**domain_post**](DomainApi.md#domain_post) | **POST** /validate/domain/whois | Get WHOIS information for a domain
|
|
9
10
|
[**domain_quality_score**](DomainApi.md#domain_quality_score) | **POST** /validate/domain/quality-score | Validate a domain name's quality score
|
|
11
|
+
[**domain_ssrf_check**](DomainApi.md#domain_ssrf_check) | **POST** /validate/domain/url/ssrf-threat-check | Check a URL for SSRF threats
|
|
12
|
+
[**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
13
|
[**domain_url_full**](DomainApi.md#domain_url_full) | **POST** /validate/domain/url/full | Validate a URL fully
|
|
11
14
|
[**domain_url_syntax_only**](DomainApi.md#domain_url_syntax_only) | **POST** /validate/domain/url/syntax-only | Validate a URL syntactically
|
|
12
15
|
|
|
@@ -60,7 +63,61 @@ Name | Type | Description | Notes
|
|
|
60
63
|
|
|
61
64
|
### HTTP request headers
|
|
62
65
|
|
|
63
|
-
- **Content-Type**:
|
|
66
|
+
- **Content-Type**: application/json, text/json
|
|
67
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
# **domain_get_top_level_domain_from_url**
|
|
72
|
+
> ValidateUrlResponseSyntaxOnly domain_get_top_level_domain_from_url(request)
|
|
73
|
+
|
|
74
|
+
Get top-level domain name from URL
|
|
75
|
+
|
|
76
|
+
Gets the top-level domain name from a URL, such as mydomain.com.
|
|
77
|
+
|
|
78
|
+
### Example
|
|
79
|
+
```ruby
|
|
80
|
+
# load the gem
|
|
81
|
+
require 'cloudmersive-validate-api-client'
|
|
82
|
+
# setup authorization
|
|
83
|
+
CloudmersiveValidateApiClient.configure do |config|
|
|
84
|
+
# Configure API key authorization: Apikey
|
|
85
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
86
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
87
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
88
|
+
end
|
|
89
|
+
|
|
90
|
+
api_instance = CloudmersiveValidateApiClient::DomainApi.new
|
|
91
|
+
|
|
92
|
+
request = CloudmersiveValidateApiClient::ValidateUrlRequestSyntaxOnly.new # ValidateUrlRequestSyntaxOnly | Input URL information
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
begin
|
|
96
|
+
#Get top-level domain name from URL
|
|
97
|
+
result = api_instance.domain_get_top_level_domain_from_url(request)
|
|
98
|
+
p result
|
|
99
|
+
rescue CloudmersiveValidateApiClient::ApiError => e
|
|
100
|
+
puts "Exception when calling DomainApi->domain_get_top_level_domain_from_url: #{e}"
|
|
101
|
+
end
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
### Parameters
|
|
105
|
+
|
|
106
|
+
Name | Type | Description | Notes
|
|
107
|
+
------------- | ------------- | ------------- | -------------
|
|
108
|
+
**request** | [**ValidateUrlRequestSyntaxOnly**](ValidateUrlRequestSyntaxOnly.md)| Input URL information |
|
|
109
|
+
|
|
110
|
+
### Return type
|
|
111
|
+
|
|
112
|
+
[**ValidateUrlResponseSyntaxOnly**](ValidateUrlResponseSyntaxOnly.md)
|
|
113
|
+
|
|
114
|
+
### Authorization
|
|
115
|
+
|
|
116
|
+
[Apikey](../README.md#Apikey)
|
|
117
|
+
|
|
118
|
+
### HTTP request headers
|
|
119
|
+
|
|
120
|
+
- **Content-Type**: application/json, text/json
|
|
64
121
|
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
65
122
|
|
|
66
123
|
|
|
@@ -114,7 +171,7 @@ Name | Type | Description | Notes
|
|
|
114
171
|
|
|
115
172
|
### HTTP request headers
|
|
116
173
|
|
|
117
|
-
- **Content-Type**:
|
|
174
|
+
- **Content-Type**: application/json, text/json
|
|
118
175
|
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
119
176
|
|
|
120
177
|
|
|
@@ -168,7 +225,115 @@ Name | Type | Description | Notes
|
|
|
168
225
|
|
|
169
226
|
### HTTP request headers
|
|
170
227
|
|
|
171
|
-
- **Content-Type**:
|
|
228
|
+
- **Content-Type**: application/json, text/json
|
|
229
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
230
|
+
|
|
231
|
+
|
|
232
|
+
|
|
233
|
+
# **domain_ssrf_check**
|
|
234
|
+
> UrlSsrfResponseFull domain_ssrf_check(request)
|
|
235
|
+
|
|
236
|
+
Check a URL for SSRF threats
|
|
237
|
+
|
|
238
|
+
Checks if an input URL is at risk of being an SSRF (Server-side request forgery) threat or attack.
|
|
239
|
+
|
|
240
|
+
### Example
|
|
241
|
+
```ruby
|
|
242
|
+
# load the gem
|
|
243
|
+
require 'cloudmersive-validate-api-client'
|
|
244
|
+
# setup authorization
|
|
245
|
+
CloudmersiveValidateApiClient.configure do |config|
|
|
246
|
+
# Configure API key authorization: Apikey
|
|
247
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
248
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
249
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
250
|
+
end
|
|
251
|
+
|
|
252
|
+
api_instance = CloudmersiveValidateApiClient::DomainApi.new
|
|
253
|
+
|
|
254
|
+
request = CloudmersiveValidateApiClient::UrlSsrfRequestFull.new # UrlSsrfRequestFull | Input URL request
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
begin
|
|
258
|
+
#Check a URL for SSRF threats
|
|
259
|
+
result = api_instance.domain_ssrf_check(request)
|
|
260
|
+
p result
|
|
261
|
+
rescue CloudmersiveValidateApiClient::ApiError => e
|
|
262
|
+
puts "Exception when calling DomainApi->domain_ssrf_check: #{e}"
|
|
263
|
+
end
|
|
264
|
+
```
|
|
265
|
+
|
|
266
|
+
### Parameters
|
|
267
|
+
|
|
268
|
+
Name | Type | Description | Notes
|
|
269
|
+
------------- | ------------- | ------------- | -------------
|
|
270
|
+
**request** | [**UrlSsrfRequestFull**](UrlSsrfRequestFull.md)| Input URL request |
|
|
271
|
+
|
|
272
|
+
### Return type
|
|
273
|
+
|
|
274
|
+
[**UrlSsrfResponseFull**](UrlSsrfResponseFull.md)
|
|
275
|
+
|
|
276
|
+
### Authorization
|
|
277
|
+
|
|
278
|
+
[Apikey](../README.md#Apikey)
|
|
279
|
+
|
|
280
|
+
### HTTP request headers
|
|
281
|
+
|
|
282
|
+
- **Content-Type**: application/json, text/json
|
|
283
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
284
|
+
|
|
285
|
+
|
|
286
|
+
|
|
287
|
+
# **domain_ssrf_check_batch**
|
|
288
|
+
> UrlSsrfResponseBatch domain_ssrf_check_batch(request)
|
|
289
|
+
|
|
290
|
+
Check a URL for SSRF threats in batches
|
|
291
|
+
|
|
292
|
+
Batch-checks if input URLs are at risk of being an SSRF (Server-side request forgery) threat or attack.
|
|
293
|
+
|
|
294
|
+
### Example
|
|
295
|
+
```ruby
|
|
296
|
+
# load the gem
|
|
297
|
+
require 'cloudmersive-validate-api-client'
|
|
298
|
+
# setup authorization
|
|
299
|
+
CloudmersiveValidateApiClient.configure do |config|
|
|
300
|
+
# Configure API key authorization: Apikey
|
|
301
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
302
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
303
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
304
|
+
end
|
|
305
|
+
|
|
306
|
+
api_instance = CloudmersiveValidateApiClient::DomainApi.new
|
|
307
|
+
|
|
308
|
+
request = CloudmersiveValidateApiClient::UrlSsrfRequestBatch.new # UrlSsrfRequestBatch | Input URL request as a batch of multiple URLs
|
|
309
|
+
|
|
310
|
+
|
|
311
|
+
begin
|
|
312
|
+
#Check a URL for SSRF threats in batches
|
|
313
|
+
result = api_instance.domain_ssrf_check_batch(request)
|
|
314
|
+
p result
|
|
315
|
+
rescue CloudmersiveValidateApiClient::ApiError => e
|
|
316
|
+
puts "Exception when calling DomainApi->domain_ssrf_check_batch: #{e}"
|
|
317
|
+
end
|
|
318
|
+
```
|
|
319
|
+
|
|
320
|
+
### Parameters
|
|
321
|
+
|
|
322
|
+
Name | Type | Description | Notes
|
|
323
|
+
------------- | ------------- | ------------- | -------------
|
|
324
|
+
**request** | [**UrlSsrfRequestBatch**](UrlSsrfRequestBatch.md)| Input URL request as a batch of multiple URLs |
|
|
325
|
+
|
|
326
|
+
### Return type
|
|
327
|
+
|
|
328
|
+
[**UrlSsrfResponseBatch**](UrlSsrfResponseBatch.md)
|
|
329
|
+
|
|
330
|
+
### Authorization
|
|
331
|
+
|
|
332
|
+
[Apikey](../README.md#Apikey)
|
|
333
|
+
|
|
334
|
+
### HTTP request headers
|
|
335
|
+
|
|
336
|
+
- **Content-Type**: application/json, text/json
|
|
172
337
|
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
173
338
|
|
|
174
339
|
|
data/docs/EmailApi.md
CHANGED
|
@@ -58,7 +58,7 @@ Name | Type | Description | Notes
|
|
|
58
58
|
|
|
59
59
|
### HTTP request headers
|
|
60
60
|
|
|
61
|
-
- **Content-Type**:
|
|
61
|
+
- **Content-Type**: application/json, text/json
|
|
62
62
|
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
63
63
|
|
|
64
64
|
|
|
@@ -112,7 +112,7 @@ Name | Type | Description | Notes
|
|
|
112
112
|
|
|
113
113
|
### HTTP request headers
|
|
114
114
|
|
|
115
|
-
- **Content-Type**:
|
|
115
|
+
- **Content-Type**: application/json, text/json
|
|
116
116
|
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
117
117
|
|
|
118
118
|
|
|
@@ -166,7 +166,7 @@ Name | Type | Description | Notes
|
|
|
166
166
|
|
|
167
167
|
### HTTP request headers
|
|
168
168
|
|
|
169
|
-
- **Content-Type**:
|
|
169
|
+
- **Content-Type**: application/json, text/json
|
|
170
170
|
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
171
171
|
|
|
172
172
|
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# CloudmersiveValidateApiClient::GetPublicHolidaysRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**raw_country_input** | **String** | Two-letter code (FIPS 10-4 or ISO 3166-1) of the country; if not specified, defaults to United States | [optional]
|
|
7
|
+
**year** | **Integer** | Optional - the year in which to retrieve the holidays; if left blank (0) it will default to the current year | [optional]
|
|
8
|
+
|
|
9
|
+
|
data/docs/IPAddressApi.md
CHANGED
|
@@ -5,9 +5,12 @@ All URIs are relative to *https://api.cloudmersive.com*
|
|
|
5
5
|
Method | HTTP request | Description
|
|
6
6
|
------------- | ------------- | -------------
|
|
7
7
|
[**i_p_address_geolocate_street_address**](IPAddressApi.md#i_p_address_geolocate_street_address) | **POST** /validate/ip/geolocate/street-address | Geolocate an IP address to a street address
|
|
8
|
+
[**i_p_address_ip_intelligence**](IPAddressApi.md#i_p_address_ip_intelligence) | **POST** /validate/ip/intelligence | Get intelligence on an IP address
|
|
9
|
+
[**i_p_address_is_bot**](IPAddressApi.md#i_p_address_is_bot) | **POST** /validate/ip/is-bot | Check if IP address is a Bot client
|
|
8
10
|
[**i_p_address_is_threat**](IPAddressApi.md#i_p_address_is_threat) | **POST** /validate/ip/is-threat | Check if IP address is a known threat
|
|
9
11
|
[**i_p_address_is_tor_node**](IPAddressApi.md#i_p_address_is_tor_node) | **POST** /validate/ip/is-tor-node | Check if IP address is a Tor node server
|
|
10
12
|
[**i_p_address_post**](IPAddressApi.md#i_p_address_post) | **POST** /validate/ip/geolocate | Geolocate an IP address
|
|
13
|
+
[**i_p_address_reverse_domain_lookup**](IPAddressApi.md#i_p_address_reverse_domain_lookup) | **POST** /validate/ip/reverse-domain-lookup | Perform a reverse domain name (DNS) lookup on an IP address
|
|
11
14
|
|
|
12
15
|
|
|
13
16
|
# **i_p_address_geolocate_street_address**
|
|
@@ -59,7 +62,115 @@ Name | Type | Description | Notes
|
|
|
59
62
|
|
|
60
63
|
### HTTP request headers
|
|
61
64
|
|
|
62
|
-
- **Content-Type**:
|
|
65
|
+
- **Content-Type**: application/json, text/json
|
|
66
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
# **i_p_address_ip_intelligence**
|
|
71
|
+
> IPIntelligenceResponse i_p_address_ip_intelligence(value)
|
|
72
|
+
|
|
73
|
+
Get intelligence on an IP address
|
|
74
|
+
|
|
75
|
+
Identify key intelligence about an IP address, including if it is a known threat IP, known bot, Tor exit node, as well as the location of the IP address.
|
|
76
|
+
|
|
77
|
+
### Example
|
|
78
|
+
```ruby
|
|
79
|
+
# load the gem
|
|
80
|
+
require 'cloudmersive-validate-api-client'
|
|
81
|
+
# setup authorization
|
|
82
|
+
CloudmersiveValidateApiClient.configure do |config|
|
|
83
|
+
# Configure API key authorization: Apikey
|
|
84
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
85
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
86
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
87
|
+
end
|
|
88
|
+
|
|
89
|
+
api_instance = CloudmersiveValidateApiClient::IPAddressApi.new
|
|
90
|
+
|
|
91
|
+
value = 'value_example' # String | IP address to process, e.g. \"55.55.55.55\". The input is a string so be sure to enclose it in double-quotes.
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
begin
|
|
95
|
+
#Get intelligence on an IP address
|
|
96
|
+
result = api_instance.i_p_address_ip_intelligence(value)
|
|
97
|
+
p result
|
|
98
|
+
rescue CloudmersiveValidateApiClient::ApiError => e
|
|
99
|
+
puts "Exception when calling IPAddressApi->i_p_address_ip_intelligence: #{e}"
|
|
100
|
+
end
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
### Parameters
|
|
104
|
+
|
|
105
|
+
Name | Type | Description | Notes
|
|
106
|
+
------------- | ------------- | ------------- | -------------
|
|
107
|
+
**value** | **String**| IP address to process, e.g. \"55.55.55.55\". The input is a string so be sure to enclose it in double-quotes. |
|
|
108
|
+
|
|
109
|
+
### Return type
|
|
110
|
+
|
|
111
|
+
[**IPIntelligenceResponse**](IPIntelligenceResponse.md)
|
|
112
|
+
|
|
113
|
+
### Authorization
|
|
114
|
+
|
|
115
|
+
[Apikey](../README.md#Apikey)
|
|
116
|
+
|
|
117
|
+
### HTTP request headers
|
|
118
|
+
|
|
119
|
+
- **Content-Type**: application/json, text/json
|
|
120
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
|
|
124
|
+
# **i_p_address_is_bot**
|
|
125
|
+
> BotCheckResponse i_p_address_is_bot(value)
|
|
126
|
+
|
|
127
|
+
Check if IP address is a Bot client
|
|
128
|
+
|
|
129
|
+
Check if the input IP address is a Bot, robot, or otherwise a non-user entity. Leverages real-time signals to check against known high-probability bots..
|
|
130
|
+
|
|
131
|
+
### Example
|
|
132
|
+
```ruby
|
|
133
|
+
# load the gem
|
|
134
|
+
require 'cloudmersive-validate-api-client'
|
|
135
|
+
# setup authorization
|
|
136
|
+
CloudmersiveValidateApiClient.configure do |config|
|
|
137
|
+
# Configure API key authorization: Apikey
|
|
138
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
139
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
140
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
141
|
+
end
|
|
142
|
+
|
|
143
|
+
api_instance = CloudmersiveValidateApiClient::IPAddressApi.new
|
|
144
|
+
|
|
145
|
+
value = 'value_example' # String | IP address to check, e.g. \"55.55.55.55\". The input is a string so be sure to enclose it in double-quotes.
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
begin
|
|
149
|
+
#Check if IP address is a Bot client
|
|
150
|
+
result = api_instance.i_p_address_is_bot(value)
|
|
151
|
+
p result
|
|
152
|
+
rescue CloudmersiveValidateApiClient::ApiError => e
|
|
153
|
+
puts "Exception when calling IPAddressApi->i_p_address_is_bot: #{e}"
|
|
154
|
+
end
|
|
155
|
+
```
|
|
156
|
+
|
|
157
|
+
### Parameters
|
|
158
|
+
|
|
159
|
+
Name | Type | Description | Notes
|
|
160
|
+
------------- | ------------- | ------------- | -------------
|
|
161
|
+
**value** | **String**| IP address to check, e.g. \"55.55.55.55\". The input is a string so be sure to enclose it in double-quotes. |
|
|
162
|
+
|
|
163
|
+
### Return type
|
|
164
|
+
|
|
165
|
+
[**BotCheckResponse**](BotCheckResponse.md)
|
|
166
|
+
|
|
167
|
+
### Authorization
|
|
168
|
+
|
|
169
|
+
[Apikey](../README.md#Apikey)
|
|
170
|
+
|
|
171
|
+
### HTTP request headers
|
|
172
|
+
|
|
173
|
+
- **Content-Type**: application/json, text/json
|
|
63
174
|
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
64
175
|
|
|
65
176
|
|
|
@@ -113,7 +224,7 @@ Name | Type | Description | Notes
|
|
|
113
224
|
|
|
114
225
|
### HTTP request headers
|
|
115
226
|
|
|
116
|
-
- **Content-Type**:
|
|
227
|
+
- **Content-Type**: application/json, text/json
|
|
117
228
|
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
118
229
|
|
|
119
230
|
|
|
@@ -167,7 +278,7 @@ Name | Type | Description | Notes
|
|
|
167
278
|
|
|
168
279
|
### HTTP request headers
|
|
169
280
|
|
|
170
|
-
- **Content-Type**:
|
|
281
|
+
- **Content-Type**: application/json, text/json
|
|
171
282
|
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
172
283
|
|
|
173
284
|
|
|
@@ -221,7 +332,61 @@ Name | Type | Description | Notes
|
|
|
221
332
|
|
|
222
333
|
### HTTP request headers
|
|
223
334
|
|
|
224
|
-
- **Content-Type**:
|
|
335
|
+
- **Content-Type**: application/json, text/json
|
|
336
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
337
|
+
|
|
338
|
+
|
|
339
|
+
|
|
340
|
+
# **i_p_address_reverse_domain_lookup**
|
|
341
|
+
> IPReverseDNSLookupResponse i_p_address_reverse_domain_lookup(value)
|
|
342
|
+
|
|
343
|
+
Perform a reverse domain name (DNS) lookup on an IP address
|
|
344
|
+
|
|
345
|
+
Gets the domain name, if any, associated with the IP address.
|
|
346
|
+
|
|
347
|
+
### Example
|
|
348
|
+
```ruby
|
|
349
|
+
# load the gem
|
|
350
|
+
require 'cloudmersive-validate-api-client'
|
|
351
|
+
# setup authorization
|
|
352
|
+
CloudmersiveValidateApiClient.configure do |config|
|
|
353
|
+
# Configure API key authorization: Apikey
|
|
354
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
355
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
356
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
357
|
+
end
|
|
358
|
+
|
|
359
|
+
api_instance = CloudmersiveValidateApiClient::IPAddressApi.new
|
|
360
|
+
|
|
361
|
+
value = 'value_example' # String | IP address to check, e.g. \"55.55.55.55\". The input is a string so be sure to enclose it in double-quotes.
|
|
362
|
+
|
|
363
|
+
|
|
364
|
+
begin
|
|
365
|
+
#Perform a reverse domain name (DNS) lookup on an IP address
|
|
366
|
+
result = api_instance.i_p_address_reverse_domain_lookup(value)
|
|
367
|
+
p result
|
|
368
|
+
rescue CloudmersiveValidateApiClient::ApiError => e
|
|
369
|
+
puts "Exception when calling IPAddressApi->i_p_address_reverse_domain_lookup: #{e}"
|
|
370
|
+
end
|
|
371
|
+
```
|
|
372
|
+
|
|
373
|
+
### Parameters
|
|
374
|
+
|
|
375
|
+
Name | Type | Description | Notes
|
|
376
|
+
------------- | ------------- | ------------- | -------------
|
|
377
|
+
**value** | **String**| IP address to check, e.g. \"55.55.55.55\". The input is a string so be sure to enclose it in double-quotes. |
|
|
378
|
+
|
|
379
|
+
### Return type
|
|
380
|
+
|
|
381
|
+
[**IPReverseDNSLookupResponse**](IPReverseDNSLookupResponse.md)
|
|
382
|
+
|
|
383
|
+
### Authorization
|
|
384
|
+
|
|
385
|
+
[Apikey](../README.md#Apikey)
|
|
386
|
+
|
|
387
|
+
### HTTP request headers
|
|
388
|
+
|
|
389
|
+
- **Content-Type**: application/json, text/json
|
|
225
390
|
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
226
391
|
|
|
227
392
|
|