Class Actions

Actions API

Actions show the results and progress of asynchronous requests to the API. https://docs.hetzner.cloud/#actions

Hierarchy (View Summary)

BaseAPI
- Actions

Index

Constructors

Properties

Methods

get getAll request

Constructors

constructor

new Actions(token: string, baseUrl?: string): Actions
Parameters
- token: string
- OptionalbaseUrl: string
Returns Actions
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: Action; success: true }
    | { response: APIError; success: false },
>
Returns a specific Action object.
Parameters
- id: number
Returns Promise<
| { response: Action; success: true }
| { response: APIError; success: false },
>
- Defined in actions/actions.ts:28

getAll

getAll(
    id: number,
): Promise<
    | { response: ActionsResponse; success: true }
    | { response: APIError; success: false },
>
Returns a list of Action objects, filtered by the provided ID. The API may return an array, even if the ID matches a single action.
Parameters
- id: number
Returns Promise<
| { response: ActionsResponse; success: true }
| { response: APIError; success: false },
>
- Defined in actions/actions.ts:17

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