Class: NgrokAPI::Services::SSHCredentialsClient
- Inherits:
-
Object
- Object
- NgrokAPI::Services::SSHCredentialsClient
- Defined in:
- lib/ngrokapi/services/ssh_credentials_client.rb
Overview
SSH Credentials are SSH public keys that can be used to start SSH tunnels via the ngrok SSH tunnel gateway.
Constant Summary collapse
- PATH =
The API path for the requests
'/ssh_credentials'
- LIST_PROPERTY =
The List Property from the resulting API for list calls
'ssh_credentials'
Instance Attribute Summary collapse
-
#client ⇒ Object
readonly
Returns the value of attribute client.
Instance Method Summary collapse
-
#create(description: "", metadata: "", acl: [], public_key:) ⇒ NgrokAPI::Models::SSHCredential
Create a new ssh_credential from an uploaded public SSH key.
-
#create!(description: "", metadata: "", acl: [], public_key:) ⇒ NgrokAPI::Models::SSHCredential
Create a new ssh_credential from an uploaded public SSH key.
-
#delete(id: "") ⇒ NgrokAPI::Models::Empty
Delete an ssh_credential by ID.
-
#delete!(id: "") ⇒ NgrokAPI::Models::Empty
Delete an ssh_credential by ID Throws an exception if API error.
-
#get(id: "") ⇒ NgrokAPI::Models::SSHCredential
Get detailed information about an ssh_credential.
-
#get!(id: "") ⇒ NgrokAPI::Models::SSHCredential
Get detailed information about an ssh_credential Throws an exception if API error.
-
#initialize(client:) ⇒ SSHCredentialsClient
constructor
A new instance of SSHCredentialsClient.
-
#list(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable
List all ssh credentials on this account.
-
#list!(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable
List all ssh credentials on this account Throws an exception if API error.
-
#update(id: "", description: nil, metadata: nil, acl: nil) ⇒ NgrokAPI::Models::SSHCredential
Update attributes of an ssh_credential by ID.
-
#update!(id: "", description: nil, metadata: nil, acl: nil) ⇒ NgrokAPI::Models::SSHCredential
Update attributes of an ssh_credential by ID Throws an exception if API error.
Constructor Details
#initialize(client:) ⇒ SSHCredentialsClient
Returns a new instance of SSHCredentialsClient.
18 19 20 |
# File 'lib/ngrokapi/services/ssh_credentials_client.rb', line 18 def initialize(client:) @client = client end |
Instance Attribute Details
#client ⇒ Object (readonly)
Returns the value of attribute client.
16 17 18 |
# File 'lib/ngrokapi/services/ssh_credentials_client.rb', line 16 def client @client end |
Instance Method Details
#create(description: "", metadata: "", acl: [], public_key:) ⇒ NgrokAPI::Models::SSHCredential
Create a new ssh_credential from an uploaded public SSH key. This ssh credential can be used to start new tunnels via ngrok's SSH gateway.
33 34 35 36 37 38 39 40 41 42 43 44 |
# File 'lib/ngrokapi/services/ssh_credentials_client.rb', line 33 def create(description: "", metadata: "", acl: [], public_key:) path = '/ssh_credentials' replacements = { } data = {} data[:description] = description if description data[:metadata] = if data[:acl] = acl if acl data[:public_key] = public_key if public_key result = @client.post(path % replacements, data: data) NgrokAPI::Models::SSHCredential.new(client: self, attrs: result) end |
#create!(description: "", metadata: "", acl: [], public_key:) ⇒ NgrokAPI::Models::SSHCredential
Create a new ssh_credential from an uploaded public SSH key. This ssh credential can be used to start new tunnels via ngrok's SSH gateway. Throws an exception if API error.
58 59 60 61 62 63 64 65 66 67 68 69 |
# File 'lib/ngrokapi/services/ssh_credentials_client.rb', line 58 def create!(description: "", metadata: "", acl: [], public_key:) path = '/ssh_credentials' replacements = { } data = {} data[:description] = description if description data[:metadata] = if data[:acl] = acl if acl data[:public_key] = public_key if public_key result = @client.post(path % replacements, data: data, danger: true) NgrokAPI::Models::SSHCredential.new(client: self, attrs: result) end |
#delete(id: "") ⇒ NgrokAPI::Models::Empty
Delete an ssh_credential by ID
78 79 80 81 82 83 84 |
# File 'lib/ngrokapi/services/ssh_credentials_client.rb', line 78 def delete(id: "") path = '/ssh_credentials/%{id}' replacements = { id: id, } @client.delete(path % replacements) end |
#delete!(id: "") ⇒ NgrokAPI::Models::Empty
Delete an ssh_credential by ID Throws an exception if API error.
94 95 96 97 98 99 100 |
# File 'lib/ngrokapi/services/ssh_credentials_client.rb', line 94 def delete!(id: "") path = '/ssh_credentials/%{id}' replacements = { id: id, } @client.delete(path % replacements, danger: true) end |
#get(id: "") ⇒ NgrokAPI::Models::SSHCredential
Get detailed information about an ssh_credential
109 110 111 112 113 114 115 116 117 |
# File 'lib/ngrokapi/services/ssh_credentials_client.rb', line 109 def get(id: "") path = '/ssh_credentials/%{id}' replacements = { id: id, } data = {} result = @client.get(path % replacements, data: data) NgrokAPI::Models::SSHCredential.new(client: self, attrs: result) end |
#get!(id: "") ⇒ NgrokAPI::Models::SSHCredential
Get detailed information about an ssh_credential Throws an exception if API error.
127 128 129 130 131 132 133 134 135 |
# File 'lib/ngrokapi/services/ssh_credentials_client.rb', line 127 def get!(id: "") path = '/ssh_credentials/%{id}' replacements = { id: id, } data = {} result = @client.get(path % replacements, data: data, danger: true) NgrokAPI::Models::SSHCredential.new(client: self, attrs: result) end |
#list(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable
List all ssh credentials on this account
146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 |
# File 'lib/ngrokapi/services/ssh_credentials_client.rb', line 146 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::SSHCredential ) end |
#list!(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable
List all ssh credentials on this account Throws an exception if API error.
172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 |
# File 'lib/ngrokapi/services/ssh_credentials_client.rb', line 172 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::SSHCredential, danger: true ) end |
#update(id: "", description: nil, metadata: nil, acl: nil) ⇒ NgrokAPI::Models::SSHCredential
Update attributes of an ssh_credential by ID
200 201 202 203 204 205 206 207 208 209 210 211 |
# File 'lib/ngrokapi/services/ssh_credentials_client.rb', line 200 def update(id: "", description: nil, metadata: nil, acl: nil) path = '/ssh_credentials/%{id}' replacements = { id: id, } data = {} data[:description] = description if description data[:metadata] = if data[:acl] = acl if acl result = @client.patch(path % replacements, data: data) NgrokAPI::Models::SSHCredential.new(client: self, attrs: result) end |
#update!(id: "", description: nil, metadata: nil, acl: nil) ⇒ NgrokAPI::Models::SSHCredential
Update attributes of an ssh_credential by ID Throws an exception if API error.
224 225 226 227 228 229 230 231 232 233 234 235 |
# File 'lib/ngrokapi/services/ssh_credentials_client.rb', line 224 def update!(id: "", description: nil, metadata: nil, acl: nil) path = '/ssh_credentials/%{id}' replacements = { id: id, } data = {} data[:description] = description if description data[:metadata] = if data[:acl] = acl if acl result = @client.patch(path % replacements, data: data, danger: true) NgrokAPI::Models::SSHCredential.new(client: self, attrs: result) end |