Class NetworkActions

Network Actions API

Network actions are used to manage networks. https://docs.hetzner.cloud/#networks-actions

Hierarchy (View Summary)

BaseAPI
- NetworkActions

Index

Constructors

constructor

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

Properties

`Protected`baseUrl

baseUrl: string

`Protected`token

token: string

Methods

addRoute

addRoute(
    networkId: number,
    params: AddRouteNetworkParams,
): Promise<
    | { response: { actions: BaseAction }; success: true }
    | { response: APIError; success: false },
>
Add a route to a Network
Parameters
- networkId: number
  The Network ID
- params: AddRouteNetworkParams
  Parameters for adding the route
Returns Promise<
| { response: { actions: BaseAction }; success: true }
| { response: APIError; success: false },
>
- Defined in networks/actions.ts:101

addSubnet

addSubnet(
    networkId: number,
    params: AddSubnetNetworkParams,
): Promise<
    | { response: { actions: BaseAction }; success: true }
    | { response: APIError; success: false },
>
Add a subnet to a Network
Parameters
- networkId: number
  The Network ID
- params: AddSubnetNetworkParams
  Parameters for adding the subnet
Returns Promise<
| { response: { actions: BaseAction }; success: true }
| { response: APIError; success: false },
>
- Defined in networks/actions.ts:135

changeIPRange

changeIPRange(
    networkId: number,
    params: ChangeIPRangeNetworkParams,
): Promise<
    | { response: { actions: BaseAction }; success: true }
    | { response: APIError; success: false },
>
Change the IP range of a Network
Parameters
- networkId: number
  The Network ID
- params: ChangeIPRangeNetworkParams
  Parameters for changing the IP range
Returns Promise<
| { response: { actions: BaseAction }; success: true }
| { response: APIError; success: false },
>
- Defined in networks/actions.ts:169

changeProtection

changeProtection(
    networkId: number,
    params: ChangeProtectionNetworkParams,
): Promise<
    | { response: { actions: BaseAction }; success: true }
    | { response: APIError; success: false },
>
Change the protection status of a Network
Parameters
- networkId: number
  The Network ID
- params: ChangeProtectionNetworkParams
  Parameters for changing the protection status
Returns Promise<
| { response: { actions: BaseAction }; success: true }
| { response: APIError; success: false },
>
- Defined in networks/actions.ts:186

deleteRoute

deleteRoute(
    networkId: number,
    params: DeleteRouteNetworkParams,
): Promise<
    | { response: { actions: BaseAction }; success: true }
    | { response: APIError; success: false },
>
Delete a route from a Network
Parameters
- networkId: number
  The Network ID
- params: DeleteRouteNetworkParams
  Parameters for deleting the route
Returns Promise<
| { response: { actions: BaseAction }; success: true }
| { response: APIError; success: false },
>
- Defined in networks/actions.ts:118

deleteSubnet

deleteSubnet(
    networkId: number,
    params: DeleteSubnetNetworkParams,
): Promise<
    | { response: { actions: BaseAction }; success: true }
    | { response: APIError; success: false },
>
Delete a subnet from a Network
Parameters
- networkId: number
  The Network ID
- params: DeleteSubnetNetworkParams
  Parameters for deleting the subnet
Returns Promise<
| { response: { actions: BaseAction }; success: true }
| { response: APIError; success: false },
>
- Defined in networks/actions.ts:152

get

get(
    actionId: number,
): Promise<
    | { response: { actions: BaseAction }; success: true }
    | { response: APIError; success: false },
>
Get a specific action for Networks
Parameters
- actionId: number
  The action ID
Returns Promise<
| { response: { actions: BaseAction }; success: true }
| { response: APIError; success: false },
>
- Defined in networks/actions.ts:49

getAll

getAll(
    params?: ListNetworkActionsParams,
): Promise<
    | { response: NetworkActionsResponse; success: true }
    | { response: APIError; success: false },
>
List all actions for Networks
Parameters
- Optionalparams: ListNetworkActionsParams
  Optional parameters for filtering and pagination
Returns Promise<
| { response: NetworkActionsResponse; success: true }
| { response: APIError; success: false },
>
- Defined in networks/actions.ts:26

getForNetwork

getForNetwork(
    networkId: number,
    actionId: number,
): Promise<
    | { response: { actions: BaseAction }; success: true }
    | { response: APIError; success: false },
>
Get a specific action for a specific Network
Parameters
- networkId: number
  The Network ID
- actionId: number
  The action ID
Returns Promise<
| { response: { actions: BaseAction }; success: true }
| { response: APIError; success: false },
>
- Defined in networks/actions.ts:87

listForNetwork

listForNetwork(
    networkId: number,
    params?: ListNetworkActionsParams,
): Promise<
    | { response: NetworkActionsResponse; success: true }
    | { response: APIError; success: false },
>
List actions for a specific Network
Parameters
- networkId: number
  The Network ID
- Optionalparams: ListNetworkActionsParams
  Optional parameters for filtering and pagination
Returns Promise<
| { response: NetworkActionsResponse; success: true }
| { response: APIError; success: false },
>
- Defined in networks/actions.ts:62

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

Class NetworkActions

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns NetworkActions

Properties

ProtectedbaseUrl

Protectedtoken

Methods

addRoute

Parameters

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

addSubnet

Parameters

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

changeIPRange

Parameters

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

changeProtection

Parameters

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

deleteRoute

Parameters

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

deleteSubnet

Parameters

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

get

Parameters

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

getAll

Parameters

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

getForNetwork

Parameters

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

listForNetwork

Parameters

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

request

Type Parameters

Parameters

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

Settings

On This Page

`Protected`baseUrl

`Protected`token

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

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

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

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

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

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

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

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

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

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