Class SSHKeys

SSH Keys API

SSH keys are used to authenticate with the server. https://docs.hetzner.cloud/#ssh-keys

Hierarchy (View Summary)

BaseAPI
- SSHKeys

Index

Constructors

Properties

Methods

create delete get getAll request update

Constructors

constructor

new SSHKeys(token: string, baseUrl?: string): SSHKeys
Parameters
- token: string
- OptionalbaseUrl: string
Returns SSHKeys
Inherited from BaseAPI.constructor
- Defined in base.ts:7

Properties

`Protected`baseUrl

baseUrl: string

`Protected`token

token: string

Methods

create

create(
    params: CreateSSHKeyParams,
): Promise<
    | { response: { ssh_key: SSHKey }; success: true }
    | { response: APIError; success: false },
>
Create a new SSH key
Parameters
- params: CreateSSHKeyParams
  Parameters for creating the SSH key
Returns Promise<
| { response: { ssh_key: SSHKey }; success: true }
| { response: APIError; success: false },
>
- Defined in security/security.ts:60

delete

delete(
    id: number,
): Promise<
    | { response: null; success: true }
    | { response: APIError; success: false },
>
Delete an SSH key
Parameters
- id: number
  The SSH key ID
Returns Promise<
| { response: null; success: true }
| { response: APIError; success: false },
>
- Defined in security/security.ts:88

get

get(
    id: number,
): Promise<
    | { response: { ssh_key: SSHKey }; success: true }
    | { response: APIError; success: false },
>
Get a specific SSH key by ID
Parameters
- id: number
  The SSH key ID
Returns Promise<
| { response: { ssh_key: SSHKey }; success: true }
| { response: APIError; success: false },
>
- Defined in security/security.ts:50

getAll

getAll(
    params?: ListSSHKeysParams,
): Promise<
    | { response: SSHKeysResponse; success: true }
    | { response: APIError; success: false },
>
List all SSH keys with optional filtering and pagination
Parameters
- Optionalparams: ListSSHKeysParams
  Optional parameters for filtering and pagination
Returns Promise<
| { response: SSHKeysResponse; success: true }
| { response: APIError; success: false },
>
- Defined in security/security.ts:28

request

request<T>(
    endpoint: string,
    options?: RequestInit,
): Promise<
    { response: T; success: true }
    | { response: APIError; success: false },
>
Type Parameters
- T
Parameters
- endpoint: string
- options: RequestInit = {}
Returns Promise<{ response: T; success: true } | { response: APIError; success: false }>
Inherited from BaseAPI.request
- Defined in base.ts:12

update

update(
    id: number,
    params: UpdateSSHKeyParams,
): Promise<
    | { response: { ssh_key: SSHKey }; success: true }
    | { response: APIError; success: false },
>
Update an SSH key's properties
Parameters
- id: number
  The SSH key ID
- params: UpdateSSHKeyParams
  Parameters to update
Returns Promise<
| { response: { ssh_key: SSHKey }; success: true }
| { response: APIError; success: false },
>
- Defined in security/security.ts:74