Class SshKeyService

SSH key service

Hierarchy (View Summary)

BaseService
- SshKeyService

Index

Constructors

Properties

apiClient axiosInstance

Methods

createSshKeys deleteKey getKey list listKeyTypes

Constructors

constructor

new SshKeyService(apiClient: Client): SshKeyService
Constructor
Parameters
- apiClient: Client
  API client
Returns SshKeyService
Inherited from BaseService.constructor
- Defined in services/BaseService.ts:42

Properties

`Protected` `Readonly`apiClient

apiClient: Client

`Protected` `Readonly`axiosInstance

axiosInstance: AxiosInstance

Methods

createSshKeys

createSshKeys(keys: SshKeyCreate[]): Promise<SshKeyCreated>
Creates SSH keys
Parameters
- keys: SshKeyCreate[]
  SSh keys
Returns Promise<SshKeyCreated>
Created SSH keys info
- Defined in services/Security/SshKeyService.ts:77

deleteKey

deleteKey(id: number): Promise<void>
Removes SSH public key
Parameters
- id: number
  Key ID
Returns Promise<void>
- Defined in services/Security/SshKeyService.ts:68

getKey

getKey(id: number): Promise<SshKeyInfo>
Retrieves SSH public key
Parameters
- id: number
  Key ID
Returns Promise<SshKeyInfo>
SSH key
- Defined in services/Security/SshKeyService.ts:58

list

list(): Promise<SshKeyInfo[]>
Retrieves all SSH keys

Returns Promise<SshKeyInfo[]>
List of SSH keys
- Defined in services/Security/SshKeyService.ts:47

listKeyTypes

listKeyTypes(): Promise<string[]>
Retrieves all supported SSH key types

Returns Promise<string[]>
Supported SSH key types
- Defined in services/Security/SshKeyService.ts:37