Struct ngrok_api::ip_policies::Client

pub struct Client { /* private fields */ }

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.

Implementations

impl Client

pub fn new(c: Client) -> Self

pub async fn create(&self, req: &IPPolicyCreate) -> Result<IPPolicy, Error>

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.

pub async fn delete(&self, id: &str) -> Result<(), Error>

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.

pub async fn get(&self, id: &str) -> Result<IPPolicy, Error>

Get detailed information about an IP policy by ID.

pub fn list(&self, req: Paging) -> List

List all IP policies on this account

pub async fn update(&self, req: &IPPolicyUpdate) -> Result<IPPolicy, Error>

Update attributes of an IP policy by ID

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.