Class PrimaryIP

Primary Ips API

Primary IPs help you to create more flexible networking setups. https://docs.hetzner.cloud/#primary-ips

Hierarchy (View Summary)

BaseAPI
- PrimaryIP

Index

Constructors

Properties

Methods

create delete get getAll request update

Constructors

constructor

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

Properties

`Protected`baseUrl

baseUrl: string

`Protected`token

token: string

Methods

create

create(
    params: CreatePrimaryIPParams,
): Promise<
    | { response: CreatePrimaryIPResponse; success: true }
    | { response: APIError; success: false },
>
Create a primary ip
Parameters
- params: CreatePrimaryIPParams
  The parameters for creating the primary ip
Returns Promise<
| { response: CreatePrimaryIPResponse; success: true }
| { response: APIError; success: false },
>
- Defined in servers/primary-ip/primary-ip.ts:83

delete

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

get

get(
    id: number,
): Promise<
    | { response: { primary_ip: PrimaryIP }; success: true }
    | { response: APIError; success: false },
>
Get a primary ip by id
Parameters
- id: number
  The id of the primary ip
Returns Promise<
| { response: { primary_ip: PrimaryIP }; success: true }
| { response: APIError; success: false },
>
- Defined in servers/primary-ip/primary-ip.ts:70

getAll

getAll(
    params?: ListPrimaryIPsParams,
): Promise<
    | { response: ListPrimaryIPResponse; success: true }
    | { response: APIError; success: false },
>
List all primary ips with optional filtering and pagination
Parameters
- Optionalparams: ListPrimaryIPsParams
  Optional parameters for filtering and pagination
Returns Promise<
| { response: ListPrimaryIPResponse; success: true }
| { response: APIError; success: false },
>
- Defined in servers/primary-ip/primary-ip.ts:47

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: UpdatePrimaryIPParams,
): Promise<
    | { response: { primary_ip: PrimaryIP }; success: true }
    | { response: APIError; success: false },
>
Update a primary ip
Parameters
- id: number
  The id of the primary ip
- params: UpdatePrimaryIPParams
  The parameters for updating the primary ip
Returns Promise<
| { response: { primary_ip: PrimaryIP }; success: true }
| { response: APIError; success: false },
>
- Defined in servers/primary-ip/primary-ip.ts:99