Class Isos

Isos API

Isos are used to create servers. https://docs.hetzner.cloud/#isos

Hierarchy (View Summary)

BaseAPI
- Isos

Index

Constructors

Properties

Methods

get getAll request

Constructors

constructor

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

Properties

`Protected`baseUrl

baseUrl: string

`Protected`token

token: string

Methods

get

get(
    id: number,
): Promise<
    | { response: { iso: Isos }; success: true }
    | { response: APIError; success: false },
>
Get an iso by id
Parameters
- id: number
  The id of the iso
Returns Promise<
| { response: { iso: Isos }; success: true }
| { response: APIError; success: false },
>
- Defined in servers/isos/isos.ts:45

getAll

getAll(
    params?: ListIsosParams,
): Promise<
    | { response: ListIsosResponse; success: true }
    | { response: APIError; success: false },
>
List all isos with optional filtering and pagination
Parameters
- Optionalparams: ListIsosParams
  Optional parameters for filtering and pagination
Returns Promise<
| { response: ListIsosResponse; success: true }
| { response: APIError; success: false },
>
- Defined in servers/isos/isos.ts:24

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