Struct Client

pub struct Client { /* private fields */ }

API Keys are used to authenticate to the ngrok API. You may use the API itself to provision and manage API Keys but you’ll need to provision your first API key from the API Keys page on your ngrok.com dashboard.

Implementations

impl Client

pub fn new(c: Client) -> Self

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

Create a new API key. The generated API key can be used to authenticate to the ngrok API.

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

Delete an API key by ID

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

Get the details of an API key by ID.

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

List all API keys owned by this account

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

Update attributes of an API key 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.