class NgrokAPI::Services::APIKeysClient

API Keys are used to authenticate to the [ngrok

API](https://ngrok.com/docs/api#authentication). 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](https://dashboard.ngrok.com/api/keys) on your
ngrok.com dashboard.

ngrok.com/docs/api#api-api-keys

Constants

LIST_PROPERTY

The List Property from the resulting API for list calls

PATH

The API path for the requests

Attributes

client[R]

Public Class Methods

new(client:) click to toggle source
# File lib/ngrokapi/services/api_keys_client.rb, line 21
def initialize(client:)
  @client = client
end

Public Instance Methods

create(description: "", metadata: "") click to toggle source

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

@param [string] description human-readable description of what uses the API key to authenticate. optional, max 255 bytes. @param [string] metadata arbitrary user-defined data of this API key. optional, max 4096 bytes @return [NgrokAPI::Models::APIKey] result from the API request

ngrok.com/docs/api#api-api-keys-create

# File lib/ngrokapi/services/api_keys_client.rb, line 34
def create(description: "", metadata: "")
  path = '/api_keys'
  replacements = {
  }
  data = {}
  data[:description] = description if description
  data[:metadata] = metadata if metadata
  result = @client.post(path % replacements, data: data)
  NgrokAPI::Models::APIKey.new(client: self, attrs: result)
end
create!(description: "", metadata: "") click to toggle source

Create a new API key. The generated API key can be used to authenticate to the ngrok API. Throws an exception if API error.

@param [string] description human-readable description of what uses the API key to authenticate. optional, max 255 bytes. @param [string] metadata arbitrary user-defined data of this API key. optional, max 4096 bytes @return [NgrokAPI::Models::APIKey] result from the API request

ngrok.com/docs/api#api-api-keys-create

# File lib/ngrokapi/services/api_keys_client.rb, line 55
def create!(description: "", metadata: "")
  path = '/api_keys'
  replacements = {
  }
  data = {}
  data[:description] = description if description
  data[:metadata] = metadata if metadata
  result = @client.post(path % replacements, data: data, danger: true)
  NgrokAPI::Models::APIKey.new(client: self, attrs: result)
end
delete(id: "") click to toggle source

Delete an API key by ID

@param [string] id a resource identifier @return [NgrokAPI::Models::Empty] result from the API request

ngrok.com/docs/api#api-api-keys-delete

# File lib/ngrokapi/services/api_keys_client.rb, line 73
def delete(id: "")
  path = '/api_keys/%{id}'
  replacements = {
    id: id,
  }
  @client.delete(path % replacements)
end
delete!(id: "") click to toggle source

Delete an API key by ID Throws an exception if API error.

@param [string] id a resource identifier @return [NgrokAPI::Models::Empty] result from the API request

ngrok.com/docs/api#api-api-keys-delete

# File lib/ngrokapi/services/api_keys_client.rb, line 89
def delete!(id: "")
  path = '/api_keys/%{id}'
  replacements = {
    id: id,
  }
  @client.delete(path % replacements, danger: true)
end
get(id: "") click to toggle source

Get the details of an API key by ID.

@param [string] id a resource identifier @return [NgrokAPI::Models::APIKey] result from the API request

ngrok.com/docs/api#api-api-keys-get

# File lib/ngrokapi/services/api_keys_client.rb, line 104
def get(id: "")
  path = '/api_keys/%{id}'
  replacements = {
    id: id,
  }
  data = {}
  result = @client.get(path % replacements, data: data)
  NgrokAPI::Models::APIKey.new(client: self, attrs: result)
end
get!(id: "") click to toggle source

Get the details of an API key by ID. Throws an exception if API error.

@param [string] id a resource identifier @return [NgrokAPI::Models::APIKey] result from the API request

ngrok.com/docs/api#api-api-keys-get

# File lib/ngrokapi/services/api_keys_client.rb, line 122
def get!(id: "")
  path = '/api_keys/%{id}'
  replacements = {
    id: id,
  }
  data = {}
  result = @client.get(path % replacements, data: data, danger: true)
  NgrokAPI::Models::APIKey.new(client: self, attrs: result)
end
list(before_id: nil, limit: nil, url: nil) click to toggle source

List all API keys owned by this account

@param [string] before_id @param [string] limit @param [string] url optional and mutually exclusive from before_id and limit @return [NgrokAPI::Models::Listable] result from the API request

ngrok.com/docs/api#api-api-keys-list

# File lib/ngrokapi/services/api_keys_client.rb, line 141
def list(before_id: nil, limit: nil, url: nil)
  result = @client.list(
    before_id: before_id,
    limit: limit,
    url: url,
    path: PATH
  )

  NgrokAPI::Models::Listable.new(
    client: self,
    attrs: result,
    list_property: LIST_PROPERTY,
    klass: NgrokAPI::Models::APIKey
  )
end
list!(before_id: nil, limit: nil, url: nil) click to toggle source

List all API keys owned by this account Throws an exception if API error.

@param [string] before_id @param [string] limit @param [string] url optional and mutually exclusive from before_id and limit @return [NgrokAPI::Models::Listable] result from the API request

ngrok.com/docs/api#api-api-keys-list

# File lib/ngrokapi/services/api_keys_client.rb, line 167
def list!(before_id: nil, limit: nil, url: nil)
  result = @client.list(
    before_id: before_id,
    limit: limit,
    danger: true,
    url: url,
    path: PATH
  )

  NgrokAPI::Models::Listable.new(
    client: self,
    attrs: result,
    list_property: LIST_PROPERTY,
    klass: NgrokAPI::Models::APIKey,
    danger: true
  )
end
update(id: "", description: nil, metadata: nil) click to toggle source

Update attributes of an API key by ID.

@param [string] id @param [string] description human-readable description of what uses the API key to authenticate. optional, max 255 bytes. @param [string] metadata arbitrary user-defined data of this API key. optional, max 4096 bytes @return [NgrokAPI::Models::APIKey] result from the API request

ngrok.com/docs/api#api-api-keys-update

# File lib/ngrokapi/services/api_keys_client.rb, line 194
def update(id: "", description: nil, metadata: nil)
  path = '/api_keys/%{id}'
  replacements = {
    id: id,
  }
  data = {}
  data[:description] = description if description
  data[:metadata] = metadata if metadata
  result = @client.patch(path % replacements, data: data)
  NgrokAPI::Models::APIKey.new(client: self, attrs: result)
end
update!(id: "", description: nil, metadata: nil) click to toggle source

Update attributes of an API key by ID. Throws an exception if API error.

@param [string] id @param [string] description human-readable description of what uses the API key to authenticate. optional, max 255 bytes. @param [string] metadata arbitrary user-defined data of this API key. optional, max 4096 bytes @return [NgrokAPI::Models::APIKey] result from the API request

ngrok.com/docs/api#api-api-keys-update

# File lib/ngrokapi/services/api_keys_client.rb, line 216
def update!(id: "", description: nil, metadata: nil)
  path = '/api_keys/%{id}'
  replacements = {
    id: id,
  }
  data = {}
  data[:description] = description if description
  data[:metadata] = metadata if metadata
  result = @client.patch(path % replacements, data: data, danger: true)
  NgrokAPI::Models::APIKey.new(client: self, attrs: result)
end