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:, owner_id: nil, owner_email: "") ⇒ NgrokAPI::Models::SSHCredential
Create a new ssh_credential from an uploaded public SSH key.
-
#create!(description: "", metadata: "", acl: [], public_key:, owner_id: nil, owner_email: "") ⇒ 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.
20 21 22 |
# File 'lib/ngrokapi/services/ssh_credentials_client.rb', line 20 def initialize(client:) @client = client end |
Instance Attribute Details
#client ⇒ Object (readonly)
Returns the value of attribute client.
18 19 20 |
# File 'lib/ngrokapi/services/ssh_credentials_client.rb', line 18 def client @client end |
Instance Method Details
#create(description: "", metadata: "", acl: [], public_key:, owner_id: nil, owner_email: "") ⇒ 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.
36 37 38 39 40 41 42 43 44 45 46 47 48 |
# File 'lib/ngrokapi/services/ssh_credentials_client.rb', line 36 def create(description: "", metadata: "", acl: [], public_key:, owner_id: nil, owner_email: "") 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 data[:owner_id] = owner_id if owner_id result = @client.post(path % replacements, data: data) NgrokAPI::Models::SSHCredential.new(client: self, attrs: result) end |
#create!(description: "", metadata: "", acl: [], public_key:, owner_id: nil, owner_email: "") ⇒ 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.
63 64 65 66 67 68 69 70 71 72 73 74 75 |
# File 'lib/ngrokapi/services/ssh_credentials_client.rb', line 63 def create!(description: "", metadata: "", acl: [], public_key:, owner_id: nil, owner_email: "") 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 data[:owner_id] = owner_id if owner_id 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
84 85 86 87 88 89 90 |
# File 'lib/ngrokapi/services/ssh_credentials_client.rb', line 84 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.
100 101 102 103 104 105 106 |
# File 'lib/ngrokapi/services/ssh_credentials_client.rb', line 100 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
115 116 117 118 119 120 121 122 123 |
# File 'lib/ngrokapi/services/ssh_credentials_client.rb', line 115 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.
133 134 135 136 137 138 139 140 141 |
# File 'lib/ngrokapi/services/ssh_credentials_client.rb', line 133 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
152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 |
# File 'lib/ngrokapi/services/ssh_credentials_client.rb', line 152 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.
182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 |
# File 'lib/ngrokapi/services/ssh_credentials_client.rb', line 182 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
214 215 216 217 218 219 220 221 222 223 224 225 |
# File 'lib/ngrokapi/services/ssh_credentials_client.rb', line 214 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.
238 239 240 241 242 243 244 245 246 247 248 249 |
# File 'lib/ngrokapi/services/ssh_credentials_client.rb', line 238 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 |