Class Locations

Locations API

Datacenters are organized by Locations. Datacenters in the same Location are connected with very low latency links. https://docs.hetzner.cloud/#locations

Hierarchy (View Summary)

BaseAPI
- Locations

Index

Constructors

constructor

new Locations(token: string, baseUrl?: string): Locations
Parameters
- token: string
- OptionalbaseUrl: string
Returns Locations
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: Location; success: true }
    | { response: APIError; success: false },
>
Get a specific location by ID
Parameters
- id: number
  The location ID
Returns Promise<
| { response: Location; success: true }
| { response: APIError; success: false },
>
- Defined in locations/locations.ts:48

getAll

getAll(
    params?: ListLocationsParams,
): Promise<
    | { response: LocationsResponse; success: true }
    | { response: APIError; success: false },
>
List all locations with optional filtering and pagination
Parameters
- Optionalparams: ListLocationsParams
  Optional parameters for filtering and pagination
Returns Promise<
| { response: LocationsResponse; success: true }
| { response: APIError; success: false },
>
- Defined in locations/locations.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

Class Locations

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Locations

Properties

`Protected`baseUrl

`Protected`token

Methods

get

Parameters

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

getAll

Parameters

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

request

Type Parameters

Parameters

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

Settings

On This Page

Class Locations

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Locations

Properties

ProtectedbaseUrl

Protectedtoken

Methods

get

Parameters

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

getAll

Parameters

Returns Promise< | { response: LocationsResponse; 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: Location; success: true }
| { response: APIError; success: false },
>

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