Package com.ngrok.services
Class IpPolicies
java.lang.Object
com.ngrok.services.IpPolicies
IP Policies are reusable groups of CIDR ranges with an
allow
or
deny
action. They can be attached to endpoints via the Endpoint Configuration IP
Policy module. They can also be used with IP Restrictions to control source
IP ranges that can start tunnel sessions and connect to the API and dashboard.
See also https://ngrok.com/docs/api#api-ip-policies.-
Nested Class Summary
Modifier and TypeClassDescriptionclass
A builder object encapsulating state for an unsent Create API call.class
A builder object encapsulating state for an unsent Delete API call.class
A builder object encapsulating state for an unsent Get API call.class
A builder object encapsulating state for an unsent List API call.class
A builder object encapsulating state for an unsent Update API call. -
Constructor Summary
ConstructorDescriptionIpPolicies
(NgrokApiClient apiClient) Creates a new sub-client for IpPolicies. -
Method Summary
Modifier and TypeMethodDescriptioncreate()
Create a new IP policy.Delete an IP policy.Get detailed information about an IP policy by ID.list()
List all IP policies on this account See also https://ngrok.com/docs/api#api-ip-policies-list.Update attributes of an IP policy by ID See also https://ngrok.com/docs/api#api-ip-policies-update.
-
Constructor Details
-
IpPolicies
Creates a new sub-client for IpPolicies.- Parameters:
apiClient
- an instance ofNgrokApiClient
-
-
Method Details
-
create
Create a new IP policy. It will not apply to any traffic until you associate to a traffic source via an endpoint configuration or IP restriction. See also https://ngrok.com/docs/api#api-ip-policies-create.- Returns:
- a call builder for this API call
-
delete
Delete an IP policy. If the IP policy is referenced by another object for the purposes of traffic restriction it will be treated as if the IP policy remains but has zero rules. See also https://ngrok.com/docs/api#api-ip-policies-delete.- Parameters:
id
- a resource identifier- Returns:
- a call builder for this API call
-
get
Get detailed information about an IP policy by ID. See also https://ngrok.com/docs/api#api-ip-policies-get.- Parameters:
id
- a resource identifier- Returns:
- a call builder for this API call
-
list
List all IP policies on this account See also https://ngrok.com/docs/api#api-ip-policies-list.- Returns:
- a call builder for this API call
-
update
Update attributes of an IP policy by ID See also https://ngrok.com/docs/api#api-ip-policies-update.- Parameters:
id
- the value of theid
parameter as aString
- Returns:
- a call builder for this API call
-