edgegap 0.1.0

Auto-generated client library for the Edgegap API, used by the arbctl tool
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98

# \IpLookupApi

All URIs are relative to *http://localhost*

Method | HTTP request | Description
------------- | ------------- | -------------
[**i_p**](IpLookupApi.md#i_p) | **GET** /v1/ip | Get Your Public IP
[**i_p_lookup**](IpLookupApi.md#i_p_lookup) | **GET** /v1/ip/{ip}/lookup | Get an IP's information
[**i_ps_lookup**](IpLookupApi.md#i_ps_lookup) | **POST** /v1/ips/lookup | Get IPs Information in Bulk



## i_p

> models::IpAddressResponse i_p()
Get Your Public IP

Retrieve your public IP address.

### Parameters

This endpoint does not need any parameter.

### Return type

[**models::IpAddressResponse**](IPAddressResponse.md)

### Authorization

[apiKey](../README.md#apiKey)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## i_p_lookup

> models::IpAddressLookupResponse i_p_lookup(ip)
Get an IP's information

Lookup an IP address and return the associated information.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**ip** | **String** |  | [required] |

### Return type

[**models::IpAddressLookupResponse**](IPAddressLookupResponse.md)

### Authorization

[apiKey](../README.md#apiKey)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## i_ps_lookup

> models::IpAddressesLookupResponse i_ps_lookup(payload)
Get IPs Information in Bulk

Lookup IP addresses and return the associated information. Maximum of 20 IPs.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**payload** | [**IpAddressesLookupPayload**](IpAddressesLookupPayload.md) |  | [required] |

### Return type

[**models::IpAddressesLookupResponse**](IPAddressesLookupResponse.md)

### Authorization

[apiKey](../README.md#apiKey)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)