Class PlacementGroup

Placement Groups API

Placement groups help you to manage your servers in a specific datacenter. https://docs.hetzner.cloud/#placement-groups

Hierarchy (View Summary)

BaseAPI
- PlacementGroup

Index

Constructors

Properties

Methods

create delete get getAll request update

Constructors

constructor

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

Properties

`Protected`baseUrl

baseUrl: string

`Protected`token

token: string

Methods

create

create(
    params: CreatePlacementGroupParams,
): Promise<
    | { response: { placement_group: PlacementGroup }; success: true }
    | { response: APIError; success: false },
>
Create a placement group
Parameters
- params: CreatePlacementGroupParams
  The parameters for creating the placement group
Returns Promise<
| { response: { placement_group: PlacementGroup }; success: true }
| { response: APIError; success: false },
>
- Defined in servers/placement-groups/placement-group.ts:83

delete

delete(
    id: number,
): Promise<
    | { response: Action; success: true }
    | { response: APIError; success: false },
>
Delete a placement group
Parameters
- id: number
  The id of the placement group
Returns Promise<
| { response: Action; success: true }
| { response: APIError; success: false },
>
- Defined in servers/placement-groups/placement-group.ts:117

get

get(
    id: number,
): Promise<
    | { response: { placement_group: PlacementGroup }; success: true }
    | { response: APIError; success: false },
>
Get a placement group by id
Parameters
- id: number
  The id of the placement group
Returns Promise<
| { response: { placement_group: PlacementGroup }; success: true }
| { response: APIError; success: false },
>
- Defined in servers/placement-groups/placement-group.ts:70

getAll

getAll(
    params?: ListPlacementGroupsParams,
): Promise<
    | { response: ListPlacementGroupsResponse; success: true }
    | { response: APIError; success: false },
>
List all placement groups with optional filtering and pagination
Parameters
- Optionalparams: ListPlacementGroupsParams
  Optional parameters for filtering and pagination
Returns Promise<
| { response: ListPlacementGroupsResponse; success: true }
| { response: APIError; success: false },
>
- Defined in servers/placement-groups/placement-group.ts:46

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: UpdatePlacementGroupParams,
): Promise<
    | { response: { placement_group: PlacementGroup }; success: true }
    | { response: APIError; success: false },
>
Update a placement group
Parameters
- id: number
  The id of the placement group
- params: UpdatePlacementGroupParams
  The parameters for updating the placement group
Returns Promise<
| { response: { placement_group: PlacementGroup }; success: true }
| { response: APIError; success: false },
>
- Defined in servers/placement-groups/placement-group.ts:100