Struct Client

pub struct Client { /* private fields */ }

Tunnel Credentials are ngrok agent authtokens. They authorize the ngrok agent to connect the ngrok service as your account. They are installed with the ngrok config add-authtoken command or by specifying it in the ngrok.yml configuration file with the authtoken property.

Implementations

impl Client

pub fn new(c: Client) -> Self

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

Create a new tunnel authtoken credential. This authtoken credential can be used to start a new tunnel session. The response to this API call is the only time the generated token is available. If you need it for future use, you must save it securely yourself.

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

Delete a tunnel authtoken credential by ID

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

Get detailed information about a tunnel authtoken credential

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

List all tunnel authtoken credentials on this account

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

Update attributes of an tunnel authtoken credential 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.