Class Volumes

Volumes API

Volumes can be used to store data on a server. https://docs.hetzner.cloud/#volumes

Hierarchy (View Summary)

BaseAPI
- Volumes

Index

Constructors

Properties

Accessors

Methods

create delete get getAll request update

Constructors

constructor

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

Properties

`Protected`baseUrl

baseUrl: string

`Protected`token

token: string

Accessors

actions

get actions(): VolumeActions
Returns VolumeActions
- Defined in volumes/volumes.ts:105

Methods

create

create(
    params: CreateVolumeParams,
): Promise<
    | { response: { action?: BaseAction; volume: Volume }; success: true }
    | { response: APIError; success: false },
>
Create a new Volume
Parameters
- params: CreateVolumeParams
  Parameters for creating the Volume
Returns Promise<
| { response: { action?: BaseAction; volume: Volume }; success: true }
| { response: APIError; success: false },
>
- Defined in volumes/volumes.ts:63

delete

delete(
    id: number,
): Promise<
    | { response: null; success: true }
    | { response: APIError; success: false },
>
Delete a Volume
Parameters
- id: number
  The Volume ID
Returns Promise<
| { response: null; success: true }
| { response: APIError; success: false },
>
- Defined in volumes/volumes.ts:97

get

get(
    id: number,
): Promise<
    | { response: { volume: Volume }; success: true }
    | { response: APIError; success: false },
>
Get a specific Volume by ID
Parameters
- id: number
  The Volume ID
Returns Promise<
| { response: { volume: Volume }; success: true }
| { response: APIError; success: false },
>
- Defined in volumes/volumes.ts:51

getAll

getAll(
    params?: ListVolumesParams,
): Promise<
    | { response: VolumesResponse; success: true }
    | { response: APIError; success: false },
>
List all Volumes with optional filtering and pagination
Parameters
- Optionalparams: ListVolumesParams
  Optional parameters for filtering and pagination
Returns Promise<
| { response: VolumesResponse; success: true }
| { response: APIError; success: false },
>
- Defined in volumes/volumes.ts:26

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: UpdateVolumeParams,
): Promise<
    | { response: { volume: Volume }; success: true }
    | { response: APIError; success: false },
>
Update a Volume's properties
Parameters
- id: number
  The Volume ID
- params: UpdateVolumeParams
  Parameters to update
Returns Promise<
| { response: { volume: Volume }; success: true }
| { response: APIError; success: false },
>
- Defined in volumes/volumes.ts:81