Class FloatingIPs

Hierarchy (View Summary)

BaseAPI
- FloatingIPs

Index

Constructors

Properties

Accessors

Methods

create delete get getAll request update

Constructors

constructor

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

Properties

`Protected`baseUrl

baseUrl: string

`Protected`token

token: string

Accessors

actions

get actions(): FloatingIPActions
Returns FloatingIPActions
- Defined in floating-ips/floating-ips.ts:93

Methods

create

create(
    params: CreateFloatingIPParams,
): Promise<
    | { response: { floating_ip: FloatingIP }; success: true }
    | { response: APIError; success: false },
>
Create a new Floating IP
Parameters
- params: CreateFloatingIPParams
  Parameters for creating the Floating IP
Returns Promise<
| { response: { floating_ip: FloatingIP }; success: true }
| { response: APIError; success: false },
>
- Defined in floating-ips/floating-ips.ts:51

delete

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

get

get(
    id: number,
): Promise<
    | { response: FloatingIP; success: true }
    | { response: APIError; success: false },
>
Get a specific Floating IP by ID
Parameters
- id: number
  The Floating IP ID
Returns Promise<
| { response: FloatingIP; success: true }
| { response: APIError; success: false },
>
- Defined in floating-ips/floating-ips.ts:41

getAll

getAll(
    params?: ListFloatingIPsParams,
): Promise<
    | { response: FloatingIPsResponse; success: true }
    | { response: APIError; success: false },
>
List all Floating IPs with optional filtering and pagination
Parameters
- Optionalparams: ListFloatingIPsParams
  Optional parameters for filtering and pagination
Returns Promise<
| { response: FloatingIPsResponse; success: true }
| { response: APIError; success: false },
>
- Defined in floating-ips/floating-ips.ts:19

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: UpdateFloatingIPParams,
): Promise<
    | { response: { floating_ip: FloatingIP }; success: true }
    | { response: APIError; success: false },
>
Update a Floating IP's properties
Parameters
- id: number
  The Floating IP ID
- params: UpdateFloatingIPParams
  Parameters to update
Returns Promise<
| { response: { floating_ip: FloatingIP }; success: true }
| { response: APIError; success: false },
>
- Defined in floating-ips/floating-ips.ts:68