Class FirewallActions

Firewall Actions API

Returns all Actions for Firewalls. https://docs.hetzner.cloud/#firewalls-actions

Hierarchy (View Summary)

BaseAPI
- FirewallActions

Index

Constructors

constructor

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

Properties

`Protected`baseUrl

baseUrl: string

`Protected`token

token: string

Methods

applyToResources

applyToResources(
    firewallId: number,
    resources: FirewallResource[],
): Promise<
    | { response: { action: FirewallAction }; success: true }
    | { response: APIError; success: false },
>
Apply firewall to resources
Parameters
- firewallId: number
- resources: FirewallResource[]
Returns Promise<
| { response: { action: FirewallAction }; success: true }
| { response: APIError; success: false },
>
- Defined in firewalls/actions.ts:63

get

get(
    firewallId: number,
    actionId: number,
): Promise<
    | { response: { action: FirewallAction }; success: true }
    | { response: APIError; success: false },
>
Get a specific action for a firewall
Parameters
- firewallId: number
- actionId: number
Returns Promise<
| { response: { action: FirewallAction }; success: true }
| { response: APIError; success: false },
>
- Defined in firewalls/actions.ts:51

getAll

getAll(
    params?: {
        id?: number;
        page?: number;
        per_page?: number;
        sort?: SortOption;
        status?: ActionStatus;
    },
): Promise<
    | { response: FirewallActionsResponse; success: true }
    | { response: APIError; success: false },
>
List all actions for firewalls
Parameters
- Optionalparams: {
      id?: number;
      page?: number;
      per_page?: number;
      sort?: SortOption;
      status?: ActionStatus;
  }
  Optional parameters for filtering and pagination
Returns Promise<
| { response: FirewallActionsResponse; success: true }
| { response: APIError; success: false },
>
- Defined in firewalls/actions.ts:24

getFirewallAction

getFirewallAction(
    firewallId: number,
    actionId: number,
): Promise<
    | { response: { action: FirewallAction }; success: true }
    | { response: APIError; success: false },
>
Returns a specific Action for a Firewall.
Parameters
- firewallId: number
- actionId: number
Returns Promise<
| { response: { action: FirewallAction }; success: true }
| { response: APIError; success: false },
>
- Defined in firewalls/actions.ts:143

getFirewallActions

getFirewallActions(
    firewallId: number,
    params?: {
        page?: number;
        per_page?: number;
        sort?: SortOption;
        status?: ActionStatus;
    },
): Promise<
    | { response: FirewallActionsResponse; success: true }
    | { response: APIError; success: false },
>
Get all actions for a specific firewall
Parameters
- firewallId: number
- Optionalparams: { page?: number; per_page?: number; sort?: SortOption; status?: ActionStatus }
Returns Promise<
| { response: FirewallActionsResponse; success: true }
| { response: APIError; success: false },
>
- Defined in firewalls/actions.ts:114

removeFromResources

removeFromResources(
    firewallId: number,
    resources: FirewallResource[],
): Promise<
    | { response: { action: FirewallAction }; success: true }
    | { response: APIError; success: false },
>
Remove firewall from resources
Parameters
- firewallId: number
- resources: FirewallResource[]
Returns Promise<
| { response: { action: FirewallAction }; success: true }
| { response: APIError; success: false },
>
- Defined in firewalls/actions.ts:81

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

setRules

setRules(
    firewallId: number,
    rules: FirewallRule[] | [],
): Promise<
    | { response: { action: FirewallAction }; success: true }
    | { response: APIError; success: false },
>
Set firewall rules
Parameters
- firewallId: number
- rules: FirewallRule[] | []
Returns Promise<
| { response: { action: FirewallAction }; success: true }
| { response: APIError; success: false },
>
- Defined in firewalls/actions.ts:99

Class FirewallActions

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns FirewallActions

Properties

ProtectedbaseUrl

Protectedtoken

Methods

applyToResources

Parameters

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

get

Parameters

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

getAll

Parameters

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

getFirewallAction

Parameters

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

getFirewallActions

Parameters

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

removeFromResources

Parameters

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

request

Type Parameters

Parameters

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

setRules

Parameters

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

Settings

On This Page

`Protected`baseUrl

`Protected`token

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

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

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

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

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

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

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