Class Images

Images API

Images are used to create servers. https://docs.hetzner.cloud/#images

Hierarchy (View Summary)

BaseAPI
- Images

Index

Constructors

Properties

Methods

delete get getAll request update

Constructors

constructor

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

Properties

`Protected`baseUrl

baseUrl: string

`Protected`token

token: string

Methods

delete

delete(
    id: number,
): Promise<
    | { response: Action; success: true }
    | { response: APIError; success: false },
>
Delete an image
Parameters
- id: number
  The id of the image
Returns Promise<
| { response: Action; success: true }
| { response: APIError; success: false },
>
- Defined in servers/images/images.ts:86

get

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

getAll

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

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: UpdateImageParams,
): Promise<
    | { response: { image: Image }; success: true }
    | { response: APIError; success: false },
>
Update an image
Parameters
- id: number
  The id of the image
- params: UpdateImageParams
  The parameters for updating the image
Returns Promise<
| { response: { image: Image }; success: true }
| { response: APIError; success: false },
>
- Defined in servers/images/images.ts:70