Class VolumeActions

Hierarchy (View Summary)

BaseAPI
- VolumeActions

Index

Constructors

constructor

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

Properties

`Protected`baseUrl

baseUrl: string

`Protected`token

token: string

Methods

attach

attach(
    volumeId: number,
    params: AttachVolumeParams,
): Promise<
    | { response: { action: BaseAction }; success: true }
    | { response: APIError; success: false },
>
Attach a Volume to a Server
Parameters
- volumeId: number
  The Volume ID
- params: AttachVolumeParams
  Parameters for attaching the volume
Returns Promise<
| { response: { action: BaseAction }; success: true }
| { response: APIError; success: false },
>
- Defined in volumes/actions.ts:100

changeProtection

changeProtection(
    volumeId: number,
    params: ChangeVolumeProtectionParams,
): Promise<
    | { response: { action: BaseAction }; success: true }
    | { response: APIError; success: false },
>
Change Volume Protection
Parameters
- volumeId: number
  The Volume ID
- params: ChangeVolumeProtectionParams
  Parameters for changing the protection status
Returns Promise<
| { response: { action: BaseAction }; success: true }
| { response: APIError; success: false },
>
- Defined in volumes/actions.ts:148

detach

detach(
    volumeId: number,
): Promise<
    | { response: { action: BaseAction }; success: true }
    | { response: APIError; success: false },
>
Detach a Volume from a Server
Parameters
- volumeId: number
  The Volume ID
Returns Promise<
| { response: { action: BaseAction }; success: true }
| { response: APIError; success: false },
>
- Defined in volumes/actions.ts:116

getAction

getAction(
    volumeId: number,
    actionId: number,
): Promise<
    | { response: { action: BaseAction }; success: true }
    | { response: APIError; success: false },
>
Get a specific action for a specific Volume
Parameters
- volumeId: number
  The Volume ID
- actionId: number
  The action ID
Returns Promise<
| { response: { action: BaseAction }; success: true }
| { response: APIError; success: false },
>
- Defined in volumes/actions.ts:86

getAll

getAll(
    params?: ListVolumeActionsParams,
): Promise<
    | { response: VolumeActionsResponse; success: true }
    | { response: APIError; success: false },
>
List all actions for Volumes (globally, not for a specific volume)
Parameters
- Optionalparams: ListVolumeActionsParams
  Optional parameters for filtering and pagination
Returns Promise<
| { response: VolumeActionsResponse; success: true }
| { response: APIError; success: false },
>
- Defined in volumes/actions.ts:16

getGlobalAction

getGlobalAction(
    actionId: number,
): Promise<
    | { response: { action: BaseAction }; success: true }
    | { response: APIError; success: false },
>
Get a specific action for Volumes (globally)
Parameters
- actionId: number
  The action ID
Returns Promise<
| { response: { action: BaseAction }; success: true }
| { response: APIError; success: false },
>
- Defined in volumes/actions.ts:43

listForVolume

listForVolume(
    volumeId: number,
    params?: ListVolumeActionsParams,
): Promise<
    | { response: VolumeActionsResponse; success: true }
    | { response: APIError; success: false },
>
List actions for a specific Volume
Parameters
- volumeId: number
  The Volume ID
- Optionalparams: ListVolumeActionsParams
  Optional parameters for filtering and pagination
Returns Promise<
| { response: VolumeActionsResponse; success: true }
| { response: APIError; success: false },
>
- Defined in volumes/actions.ts:57

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

resize

resize(
    volumeId: number,
    params: ResizeVolumeParams,
): Promise<
    | { response: { action: BaseAction }; success: true }
    | { response: APIError; success: false },
>
Resize a Volume
Parameters
- volumeId: number
  The Volume ID
- params: ResizeVolumeParams
  Parameters for resizing the volume
Returns Promise<
| { response: { action: BaseAction }; success: true }
| { response: APIError; success: false },
>
- Defined in volumes/actions.ts:131

Class VolumeActions

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns VolumeActions

Properties

ProtectedbaseUrl

Protectedtoken

Methods

attach

Parameters

Returns Promise< | { response: { action: BaseAction }; success: true } | { response: APIError; success: false },>

changeProtection

Parameters

Returns Promise< | { response: { action: BaseAction }; success: true } | { response: APIError; success: false },>

detach

Parameters

Returns Promise< | { response: { action: BaseAction }; success: true } | { response: APIError; success: false },>

getAction

Parameters

Returns Promise< | { response: { action: BaseAction }; success: true } | { response: APIError; success: false },>

getAll

Parameters

Returns Promise< | { response: VolumeActionsResponse; success: true } | { response: APIError; success: false },>

getGlobalAction

Parameters

Returns Promise< | { response: { action: BaseAction }; success: true } | { response: APIError; success: false },>

listForVolume

Parameters

Returns Promise< | { response: VolumeActionsResponse; success: true } | { response: APIError; success: false },>

request

Type Parameters

Parameters

Returns Promise<{ response: T; success: true } | { response: APIError; success: false }>

resize

Parameters

Returns Promise< | { response: { action: BaseAction }; success: true } | { response: APIError; success: false },>

Settings

On This Page

`Protected`baseUrl

`Protected`token

Returns Promise<
| { response: { action: BaseAction }; success: true }
| { response: APIError; success: false },
>

Returns Promise<
| { response: { action: BaseAction }; success: true }
| { response: APIError; success: false },
>

Returns Promise<
| { response: { action: BaseAction }; success: true }
| { response: APIError; success: false },
>

Returns Promise<
| { response: { action: BaseAction }; success: true }
| { response: APIError; success: false },
>

Returns Promise<
| { response: VolumeActionsResponse; success: true }
| { response: APIError; success: false },
>

Returns Promise<
| { response: { action: BaseAction }; success: true }
| { response: APIError; success: false },
>

Returns Promise<
| { response: VolumeActionsResponse; success: true }
| { response: APIError; success: false },
>

Returns Promise<
| { response: { action: BaseAction }; success: true }
| { response: APIError; success: false },
>