new cloudSshKeys(domainOrOptionsopt)
Parameters:
| Name |
Type |
Attributes |
Description |
domainOrOptions |
string
|
object
|
<optional>
|
The project domain or options object. If object, see the object's optional properties.
Properties
| Name |
Type |
Attributes |
Description |
domain |
string
|
<optional>
|
The project domain |
token |
object
|
<optional>
|
auth token - object with value property and optional headerOrQueryName and isQuery properties |
|
- Source:
Methods
addSSHKey(body)
Create a new SSH key
Parameters:
| Name |
Type |
Description |
body |
SSHKeyCreate
|
SSH key details |
- Source:
deleteSSHKey(sshKeyId)
Delete a SSH key resource
Parameters:
| Name |
Type |
Description |
sshKeyId |
string
|
Id of SSH key to be deleted |
- Source:
getSSHKeyById(sshKeyId)
Find SSH key by sshKeyId
Parameters:
| Name |
Type |
Description |
sshKeyId |
string
|
Id of SSH key to be fetched |
- Source:
getSSHKeyList(name, limit, offset)
Get a list of SSH keys.
Parameters:
| Name |
Type |
Description |
name |
string
|
SSH key name filter (exact match) |
limit |
integer
|
Number of results to display |
offset |
integer
|
The starting position of the query |
- Source:
setToken(value, headerOrQueryName, isQuery)
Set Token
Parameters:
| Name |
Type |
Description |
value |
string
|
token's value |
headerOrQueryName |
string
|
the header or query name to send the token at |
isQuery |
boolean
|
true if send the token as query param, otherwise, send as header param |
- Source: