Package com.ngrok.services

Class IpWhitelist

java.lang.Object

com.ngrok.services.IpWhitelist

public class IpWhitelist
extends Object

The IP Whitelist is deprecated and will be removed. Use an IP Restriction with an endpoints type instead. See also https://ngrok.com/docs/api#api-ip-whitelist.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	IpWhitelist.CreateCallBuilder	A builder object encapsulating state for an unsent Create API call.
class	IpWhitelist.DeleteCallBuilder	A builder object encapsulating state for an unsent Delete API call.
class	IpWhitelist.GetCallBuilder	A builder object encapsulating state for an unsent Get API call.
class	IpWhitelist.ListCallBuilder	A builder object encapsulating state for an unsent List API call.
class	IpWhitelist.UpdateCallBuilder	A builder object encapsulating state for an unsent Update API call.

Constructor Summary

Constructors

Constructor	Description
IpWhitelist(NgrokApiClient apiClient)	Creates a new sub-client for IpWhitelist.

Method Summary

Modifier and Type	Method	Description
IpWhitelist.CreateCallBuilder	create()	Create a new IP whitelist entry that will restrict traffic to all tunnel endpoints on the account.
IpWhitelist.DeleteCallBuilder	delete(String id)	Delete an IP whitelist entry.
IpWhitelist.GetCallBuilder	get(String id)	Get detailed information about an IP whitelist entry by ID.
IpWhitelist.ListCallBuilder	list()	List all IP whitelist entries on this account See also https://ngrok.com/docs/api#api-ip-whitelist-list.
IpWhitelist.UpdateCallBuilder	update(String id)	Update attributes of an IP whitelist entry by ID See also https://ngrok.com/docs/api#api-ip-whitelist-update.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

IpWhitelist

public IpWhitelist(NgrokApiClient apiClient)

Creates a new sub-client for IpWhitelist.

Parameters:

apiClient - an instance of NgrokApiClient

Method Details

create

public IpWhitelist.CreateCallBuilder create()

Create a new IP whitelist entry that will restrict traffic to all tunnel endpoints on the account. See also https://ngrok.com/docs/api#api-ip-whitelist-create.

Returns:

a call builder for this API call

delete

public IpWhitelist.DeleteCallBuilder delete(String id)

Delete an IP whitelist entry. See also https://ngrok.com/docs/api#api-ip-whitelist-delete.

Parameters:

id - a resource identifier

Returns:

a call builder for this API call

get

public IpWhitelist.GetCallBuilder get(String id)

Get detailed information about an IP whitelist entry by ID. See also https://ngrok.com/docs/api#api-ip-whitelist-get.

Parameters:

id - a resource identifier

Returns:

a call builder for this API call

list

public IpWhitelist.ListCallBuilder list()

List all IP whitelist entries on this account See also https://ngrok.com/docs/api#api-ip-whitelist-list.

Returns:

a call builder for this API call

update

public IpWhitelist.UpdateCallBuilder update(String id)

Update attributes of an IP whitelist entry by ID See also https://ngrok.com/docs/api#api-ip-whitelist-update.

Parameters:

id - the value of the id parameter as a String

Returns:

a call builder for this API call