Skip to content

Commit 49654a6

Browse files
committed
update: readme
1 parent a77e63c commit 49654a6

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,6 @@ Based on:
5454
- [`ip-security` Usage](#ip-security-usage)
5555
- [Flags for `ip-security`](#flags-for-ip-security)
5656
- [Get Default Fields in `ip-security`](#get-default-fields-in-ip-security)
57-
- [Include Multiple Optional Fields](#include-multiple-optional-fields)
5857
- [Request with Field Filtering `ip-security`](#request-with-field-filtering-ip-security)
5958
- [`bulk-ip-security` Command](#bulk-ip-security-command)
6059
- [`bulk-ip-security` Usage](#bulk-ip-security-usage)
@@ -249,7 +248,7 @@ IP Geolocation offers two plans from billing point of view: **Developer(Free), P
249248
| `parse-bulk-user-agents` | Parse multiple User Agent String at once. |||
250249

251250
> [!TIP]
252-
> The availability of fields in every API endpoint across Free and Paid plans is provided in the **_Reference Table_** within each respective API Documentation. e.g., for IPGeolocationApi, please visit [https://ipgeolocation.io/documentation/ip-location-api.html#reference-to-ipgeolocation-api-response](https://ipgeolocation.io/documentation/ip-location-api.html#reference-to-ipgeolocation-api-response).
251+
> The availability of fields in every API endpoint across Free and Paid plans is provided in the **_Reference Table_** within each respective API Documentation. e.g., for IP Geolocation Api, please visit [IP Location API](https://ipgeolocation.io/documentation/ip-location-api.html#reference-to-ipgeolocation-api-response).
253252
254253
## Authentication Setup
255254
To authenticate API requests, you need to get an API key from [ipgeolocation.io](https://ipgeolocation.io/).
@@ -318,7 +317,7 @@ ipgeolocation ipgeo [flags]
318317
| `--output` | string | `pretty` | Output format: `pretty`, `raw`, `table`, `yaml`. |
319318

320319
> [!NOTE]
321-
> Available language options can be found here: [https://ipgeolocation.io/documentation/ip-location-api.html#response-in-multiple-languages](https://ipgeolocation.io/documentation/ip-location-api.html#response-in-multiple-languages)
320+
> Available language options can be found [here](https://ipgeolocation.io/documentation/ip-location-api.html#response-in-multiple-languages)
322321
323322
#### Developer Plan Examples
324323
Get info about your current IP:
@@ -963,9 +962,12 @@ ipgeolocation ip-security [flags]
963962
|--------------|----------|----------|----------------------------------------------------------------|
964963
| `--ip` | string | `""` | IPv4 or IPv6 address. |
965964
| `--excludes` | string[] | `[]` | Exclude fields from output. |
966-
| `--fields` | string[] | `[]` | Return only specific fields (e.g. `network.asn.organization`). |
965+
| `--fields` | string[] | `[]` | Return only specific fields (e.g. `security.threat_score`). |
967966
| `--output` | string | `pretty` | Output format: `pretty`, `raw`, `table`, `yaml`. |
968967

968+
> [!NOTE]
969+
> IP Security API is only available in the Paid Plan
970+
969971
#### Get Default Fields in `ip-security`
970972
Get info about your current IP:
971973
```bash

0 commit comments

Comments
 (0)