class NgrokAPI::Services::EdgesTLSClient

ngrok.com/docs/api#api-edges-tls

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/edges_tls_client.rb, line 15
def initialize(client:)
  @client = client
end

Public Instance Methods

create(description: "", metadata: "", hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil) click to toggle source

Create a TLS Edge

@param [string] description human-readable description of what this edge will be used for; optional, max 255 bytes. @param [string] metadata arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes. @param [List<string>] hostports hostports served by this edge @param [EndpointBackendMutate] backend edge modules @param [EndpointIPPolicyMutate] ip_restriction @param [EndpointMutualTLSMutate] mutual_tls @param [EndpointTLSTermination] tls_termination @return [NgrokAPI::Models::TLSEdge] result from the API request

ngrok.com/docs/api#api-edges-tls-create

# File lib/ngrokapi/services/edges_tls_client.rb, line 32
def create(description: "", metadata: "", hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil)
  path = '/edges/tls'
  replacements = {
  }
  data = {}
  data[:description] = description if description
  data[:metadata] = metadata if metadata
  data[:hostports] = hostports if hostports
  data[:backend] = backend if backend
  data[:ip_restriction] = ip_restriction if ip_restriction
  data[:mutual_tls] = mutual_tls if mutual_tls
  data[:tls_termination] = tls_termination if tls_termination
  result = @client.post(path % replacements, data: data)
  NgrokAPI::Models::TLSEdge.new(client: self, attrs: result)
end
create!(description: "", metadata: "", hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil) click to toggle source

Create a TLS Edge Throws an exception if API error.

@param [string] description human-readable description of what this edge will be used for; optional, max 255 bytes. @param [string] metadata arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes. @param [List<string>] hostports hostports served by this edge @param [EndpointBackendMutate] backend edge modules @param [EndpointIPPolicyMutate] ip_restriction @param [EndpointMutualTLSMutate] mutual_tls @param [EndpointTLSTermination] tls_termination @return [NgrokAPI::Models::TLSEdge] result from the API request

ngrok.com/docs/api#api-edges-tls-create

# File lib/ngrokapi/services/edges_tls_client.rb, line 62
def create!(description: "", metadata: "", hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil)
  path = '/edges/tls'
  replacements = {
  }
  data = {}
  data[:description] = description if description
  data[:metadata] = metadata if metadata
  data[:hostports] = hostports if hostports
  data[:backend] = backend if backend
  data[:ip_restriction] = ip_restriction if ip_restriction
  data[:mutual_tls] = mutual_tls if mutual_tls
  data[:tls_termination] = tls_termination if tls_termination
  result = @client.post(path % replacements, data: data, danger: true)
  NgrokAPI::Models::TLSEdge.new(client: self, attrs: result)
end
delete(id: "") click to toggle source

Delete a TLS Edge by ID

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

ngrok.com/docs/api#api-edges-tls-delete

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

Delete a TLS Edge 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-edges-tls-delete

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

Get a TLS Edge by ID

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

ngrok.com/docs/api#api-edges-tls-get

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

Get a TLS Edge by ID Throws an exception if API error.

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

ngrok.com/docs/api#api-edges-tls-get

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

Returns a list of all TLS Edges on 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-edges-tls-list

# File lib/ngrokapi/services/edges_tls_client.rb, line 122
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::TLSEdge
  )
end
list!(before_id: nil, limit: nil, url: nil) click to toggle source

Returns a list of all TLS Edges on 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-edges-tls-list

# File lib/ngrokapi/services/edges_tls_client.rb, line 148
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::TLSEdge,
    danger: true
  )
end
update(id: "", description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil) click to toggle source

Updates a TLS Edge by ID. If a module is not specified in the update, it will not be modified. However, each module configuration that is specified will completely replace the existing value. There is no way to delete an existing module via this API, instead use the delete module API.

@param [string] id unique identifier of this edge @param [string] description human-readable description of what this edge will be used for; optional, max 255 bytes. @param [string] metadata arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes. @param [List<string>] hostports hostports served by this edge @param [EndpointBackendMutate] backend edge modules @param [EndpointIPPolicyMutate] ip_restriction @param [EndpointMutualTLSMutate] mutual_tls @param [EndpointTLSTermination] tls_termination @return [NgrokAPI::Models::TLSEdge] result from the API request

ngrok.com/docs/api#api-edges-tls-update

# File lib/ngrokapi/services/edges_tls_client.rb, line 183
def update(id: "", description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil)
  path = '/edges/tls/%{id}'
  replacements = {
    id: id,
  }
  data = {}
  data[:description] = description if description
  data[:metadata] = metadata if metadata
  data[:hostports] = hostports if hostports
  data[:backend] = backend if backend
  data[:ip_restriction] = ip_restriction if ip_restriction
  data[:mutual_tls] = mutual_tls if mutual_tls
  data[:tls_termination] = tls_termination if tls_termination
  result = @client.patch(path % replacements, data: data)
  NgrokAPI::Models::TLSEdge.new(client: self, attrs: result)
end
update!(id: "", description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil) click to toggle source

Updates a TLS Edge by ID. If a module is not specified in the update, it will not be modified. However, each module configuration that is specified will completely replace the existing value. There is no way to delete an existing module via this API, instead use the delete module API. Throws an exception if API error.

@param [string] id unique identifier of this edge @param [string] description human-readable description of what this edge will be used for; optional, max 255 bytes. @param [string] metadata arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes. @param [List<string>] hostports hostports served by this edge @param [EndpointBackendMutate] backend edge modules @param [EndpointIPPolicyMutate] ip_restriction @param [EndpointMutualTLSMutate] mutual_tls @param [EndpointTLSTermination] tls_termination @return [NgrokAPI::Models::TLSEdge] result from the API request

ngrok.com/docs/api#api-edges-tls-update

# File lib/ngrokapi/services/edges_tls_client.rb, line 218
def update!(id: "", description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil)
  path = '/edges/tls/%{id}'
  replacements = {
    id: id,
  }
  data = {}
  data[:description] = description if description
  data[:metadata] = metadata if metadata
  data[:hostports] = hostports if hostports
  data[:backend] = backend if backend
  data[:ip_restriction] = ip_restriction if ip_restriction
  data[:mutual_tls] = mutual_tls if mutual_tls
  data[:tls_termination] = tls_termination if tls_termination
  result = @client.patch(path % replacements, data: data, danger: true)
  NgrokAPI::Models::TLSEdge.new(client: self, attrs: result)
end