Class HetznerAPI

Hierarchy (View Summary)

BaseAPI
- HetznerAPI

Index

Constructors

Properties

Accessors

actions billing certificates datacenters firewalls floatingIps loadBalancers locations networks servers sshKeys volumes

Methods

Constructors

constructor

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

Properties

`Protected`baseUrl

baseUrl: string

`Protected`token

token: string

Accessors

actions

get actions(): Actions
Returns Actions
- Defined in index.ts:13

billing

get billing(): Billing
Returns Billing
- Defined in index.ts:17

certificates

get certificates(): Certificates
Returns Certificates
- Defined in index.ts:21

datacenters

get datacenters(): Datacenters
Returns Datacenters
- Defined in index.ts:25

firewalls

get firewalls(): Firewalls
Returns Firewalls
- Defined in index.ts:29

floatingIps

get floatingIps(): FloatingIPs
Returns FloatingIPs
- Defined in index.ts:33

loadBalancers

get loadBalancers(): LoadBalancers
Returns LoadBalancers
- Defined in index.ts:37

locations

get locations(): Locations
Returns Locations
- Defined in index.ts:41

networks

get networks(): Networks
Returns Networks
- Defined in index.ts:45

servers

get servers(): Servers
Returns Servers
- Defined in index.ts:49

sshKeys

get sshKeys(): SSHKeys
Returns SSHKeys
- Defined in index.ts:53

volumes

get volumes(): Volumes
Returns Volumes
- Defined in index.ts:57

Methods

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