All URIs are relative to https://console.jumpcloud.com/api/v2
| Method | HTTP request | Description |
|---|---|---|
| IplistsDelete | Delete /iplists/{id} | Delete an IP list |
| IplistsGet | Get /iplists/{id} | Get an IP list |
| IplistsList | Get /iplists | List IP Lists |
| IplistsPatch | Patch /iplists/{id} | Update an IP list |
| IplistsPost | Post /iplists | Create IP List |
| IplistsPut | Put /iplists/{id} | Replace an IP list |
IpList IplistsDelete(ctx, id, optional) Delete an IP list
Delete a specific IP list. #### Sample Request curl -X DELETE https://console.jumpcloud.com/api/v2/iplists/{id} \\ -H 'accept: application/json' \\ -H 'content-type: application/json' \\ -H 'x-api-key: {API_KEY}'
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for logging, tracing, authentication, etc. | |
| id | string | ||
| optional | map[string]interface{} | optional parameters | nil if no parameters |
Optional parameters are passed through a map[string]interface{}.
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | ||
| xOrgId | string | Organization identifier that can be obtained from console settings. |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
IpList IplistsGet(ctx, id, optional) Get an IP list
Return a specific IP list. #### Sample Request curl https://console.jumpcloud.com/api/v2/iplists/{id} \\ -H 'accept: application/json' \\ -H 'content-type: application/json' \\ -H 'x-api-key: {API_KEY}'
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for logging, tracing, authentication, etc. | |
| id | string | ||
| optional | map[string]interface{} | optional parameters | nil if no parameters |
Optional parameters are passed through a map[string]interface{}.
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | ||
| xOrgId | string | Organization identifier that can be obtained from console settings. |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
[]IpList IplistsList(ctx, optional) List IP Lists
Retrieve all IP lists. #### Sample Request curl https://console.jumpcloud.com/api/v2/iplists \\ -H 'accept: application/json' \\ -H 'content-type: application/json' \\ -H 'x-api-key: {API_KEY}'
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for logging, tracing, authentication, etc. | |
| optional | map[string]interface{} | optional parameters | nil if no parameters |
Optional parameters are passed through a map[string]interface{}.
| Name | Type | Description | Notes |
|---|---|---|---|
| xOrgId | string | Organization identifier that can be obtained from console settings. | |
| xTotalCount | int32 | ||
| limit | int32 | The number of records to return at once. Limited to 100. | [default to 10] |
| skip | int32 | The offset into the records to return. | [default to 0] |
| filter | []string | A filter to apply to the query. Filter structure: `<field>:<operator>:<value>`. field = Populate with a valid field from an endpoint response. operator = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. Note: v1 operators differ from v2 operators. value = Populate with the value you want to search for. Is case sensitive. Supports wild cards. EX: `GET /api/v2/groups?filter=name:eq:Test+Group` | |
| sort | []string | The comma separated fields used to sort the collection. Default sort is ascending, prefix with `-` to sort descending. |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
IpList IplistsPatch(ctx, id, optional) Update an IP list
Update a specific IP list. #### Sample Request curl -X PATCH https://console.jumpcloud.com/api/v2/iplists/{id} \\ -H 'accept: application/json' \\ -H 'content-type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{\"name\": \"New IP List Name\"}'
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for logging, tracing, authentication, etc. | |
| id | string | ||
| optional | map[string]interface{} | optional parameters | nil if no parameters |
Optional parameters are passed through a map[string]interface{}.
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | ||
| body | IpListRequest | ||
| xOrgId | string | Organization identifier that can be obtained from console settings. |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
IpList IplistsPost(ctx, optional) Create IP List
Create an IP list. #### Sample Request curl -X POST https://console.jumpcloud.com/api/v2/iplists \\ -H 'accept: application/json' \\ -H 'content-type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"name\": \"Sample IP List\", \"ips\": [ \"192.168.10.12\", \"192.168.10.20 - 192.168.10.30\", \"123.225.10.0/32\" ] }'
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for logging, tracing, authentication, etc. | |
| optional | map[string]interface{} | optional parameters | nil if no parameters |
Optional parameters are passed through a map[string]interface{}.
| Name | Type | Description | Notes |
|---|---|---|---|
| body | IpListRequest | ||
| xOrgId | string | Organization identifier that can be obtained from console settings. |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
IpList IplistsPut(ctx, id, optional) Replace an IP list
Replace a specific IP list. #### Sample Request curl -X PUT https://console.jumpcloud.com/api/v2/iplists/{id} \\ -H 'accept: application/json' \\ -H 'content-type: application/json' \\ -H 'x-api-key: {API_KEY}' \\ -d '{ \"name\": \"Sample IP List\", \"ips\": [ \"192.168.10.10\" ] }'
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for logging, tracing, authentication, etc. | |
| id | string | ||
| optional | map[string]interface{} | optional parameters | nil if no parameters |
Optional parameters are passed through a map[string]interface{}.
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | ||
| xOrgId | string | Organization identifier that can be obtained from console settings. | |
| body | IpListRequest |
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]