Class Networks

Networks API

Networks is a private networks feature. These Networks are optional and they coexist with the public network that every Server has by default. https://docs.hetzner.cloud/#networks

Hierarchy (View Summary)

BaseAPI
- Networks

Index

Constructors

constructor

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

Properties

`Protected`baseUrl

baseUrl: string

`Protected`token

token: string

Accessors

actions

get actions(): NetworkActions
Returns NetworkActions
- Defined in networks/networks.ts:99

Methods

create

create(
    params: CreateNetworkParams,
): Promise<
    | { response: { network: Network }; success: true }
    | { response: APIError; success: false },
>
Create a new Network
Parameters
- params: CreateNetworkParams
  Parameters for creating the Network
Returns Promise<
| { response: { network: Network }; success: true }
| { response: APIError; success: false },
>
- Defined in networks/networks.ts:47

delete

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

get

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

getAll

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

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: UpdateNetworkParams,
): Promise<
    | { response: { network: Network }; success: true }
    | { response: APIError; success: false },
>
Update a Network's properties
Parameters
- id: number
  The Network ID
- params: UpdateNetworkParams
  Parameters to update
Returns Promise<
| { response: { network: Network }; success: true }
| { response: APIError; success: false },
>
- Defined in networks/networks.ts:75

Class Networks

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Networks

Properties

`Protected`baseUrl

`Protected`token

Accessors

actions

Returns NetworkActions

Methods

create

Parameters

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

delete

Parameters

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

get

Parameters

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

getAll

Parameters

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

request

Type Parameters

Parameters

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

update

Parameters

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

Settings

On This Page

Class Networks

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Networks

Properties

ProtectedbaseUrl

Protectedtoken

Accessors

actions

Returns NetworkActions

Methods

create

Parameters

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

delete

Parameters

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

get

Parameters

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

getAll

Parameters

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

request

Type Parameters

Parameters

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

update

Parameters

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

Settings

On This Page

`Protected`baseUrl

`Protected`token

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

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

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

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

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