Class Firewalls

Firewalls API

Firewalls can limit the network access to or from your resources. https://docs.hetzner.cloud/#firewalls

Hierarchy (View Summary)

BaseAPI
- Firewalls

Index

Constructors

Properties

Accessors

Methods

create delete get getAll request update

Constructors

constructor

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

Properties

`Protected`baseUrl

baseUrl: string

`Protected`token

token: string

Accessors

actions

get actions(): FirewallActions
Get the actions instance for managing firewall actions

Returns FirewallActions
- Defined in firewalls/firewalls.ts:54

Methods

create

create(
    params: CreateFirewallParams,
): Promise<
    | { response: FirewallCreateResponse; success: true }
    | { response: APIError; success: false },
>
Create a new firewall
Parameters
- params: CreateFirewallParams
  Parameters for creating the firewall
Returns Promise<
| { response: FirewallCreateResponse; success: true }
| { response: APIError; success: false },
>
- Defined in firewalls/firewalls.ts:87

delete

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

get

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

getAll

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

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: UpdateFirewallParams,
): Promise<
    | { response: { firewall: Firewall }; success: true }
    | { response: APIError; success: false },
>
Update a firewall's properties
Parameters
- id: number
  The firewall ID
- params: UpdateFirewallParams
  Parameters to update
Returns Promise<
| { response: { firewall: Firewall }; success: true }
| { response: APIError; success: false },
>
- Defined in firewalls/firewalls.ts:115