Types
GetSshKeysIdResponse = object
GetSshKeysResponse = object
PostSshKeysResponse = object
PutSshKeysIdResponse = object
SshKeySortOption = enum sortId = "id", sortIdAsc = "id:asc", sortIdDesc = "id:desc", sortName = "name", sortNameAsc = "name:asc", sortNameDesc = "name:desc"
Procs
proc deleteSshKeysId(client: HetznerClient; id: string): Future[AsyncResponse] {. ...stackTrace: false, raises: [Exception, ValueError, HttpRequestError, LibraryError, SslError, OSError, IOError, ProtocolError, KeyError], tags: [RootEffect, ReadIOEffect, TimeEffect], forbids: [].}
- Deletes an SSH key. It cannot be used anymore.
proc getSshKeys(client: HetznerClient; sort: set[SshKeySortOption] = {}; name: string = default(string); fingerprint: string = default(string); labelSelector: string = default(string)): Future[ GetSshKeysResponse] {....stackTrace: false, raises: [Exception, ValueError, KeyError, HttpRequestError, LibraryError, SslError, OSError, IOError, ProtocolError, OpenParserJsonError, HetznerClientError], tags: [RootEffect, ReadIOEffect, TimeEffect], forbids: [].}
- Returns all SSH key objects.
proc getSshKeysId(client: HetznerClient; id: int64): Future[GetSshKeysIdResponse] {. ...stackTrace: false, raises: [Exception, ValueError, HttpRequestError, LibraryError, SslError, OSError, IOError, ProtocolError, KeyError, OpenParserJsonError, HetznerClientError], tags: [RootEffect, ReadIOEffect, TimeEffect], forbids: [].}
- Returns a specific SSH key object.
proc postSshKeys(client: HetznerClient; body: PostSshKeysRequest): Future[ PostSshKeysResponse] {....stackTrace: false, raises: [Exception, ValueError, HttpRequestError, LibraryError, SslError, OSError, IOError, ProtocolError, KeyError, OpenParserJsonError, HetznerClientError], tags: [RootEffect, ReadIOEffect, TimeEffect], forbids: [].}
- Creates a new SSH key with the given name and public_key. Once an SSH key is created, it can be used in other calls such as creating Servers.
proc putSshKeysId(client: HetznerClient; id: string; body: PutSshKeysIdRequest): Future[ PutSshKeysIdResponse] {....stackTrace: false, raises: [Exception, ValueError, HttpRequestError, LibraryError, SslError, OSError, IOError, ProtocolError, KeyError, OpenParserJsonError, HetznerClientError], tags: [RootEffect, ReadIOEffect, TimeEffect], forbids: [].}
-
Updates an SSH key. You can update an SSH key name and an SSH key labels.
Please note that when updating labels, the SSH key current set of labels will be replaced with the labels provided in the request body. So, for example, if you want to add a new label, you have to provide all existing labels plus the new label in the request body.