Class FloatingIPActions

Hierarchy (View Summary)

BaseAPI
- FloatingIPActions

Index

Constructors

constructor

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

Properties

`Protected`baseUrl

baseUrl: string

`Protected`token

token: string

Methods

assign

assign(
    floatingIpId: number,
    params: AssignFloatingIPParams,
): Promise<
    | { response: FloatingIPAction; success: true }
    | { response: APIError; success: false },
>
Assign a Floating IP to a Server
Parameters
- floatingIpId: number
  The Floating IP ID
- params: AssignFloatingIPParams
  Parameters for assigning the Floating IP
Returns Promise<
| { response: FloatingIPAction; success: true }
| { response: APIError; success: false },
>
- Defined in floating-ips/actions.ts:78

changeDNSPTR

changeDNSPTR(
    floatingIpId: number,
    params: ChangeDNSPTRParams,
): Promise<
    | { response: FloatingIPAction; success: true }
    | { response: APIError; success: false },
>
Change Reverse DNS (PTR) for a Floating IP
Parameters
- floatingIpId: number
  The Floating IP ID
- params: ChangeDNSPTRParams
  Parameters for changing the DNS PTR record
Returns Promise<
| { response: FloatingIPAction; success: true }
| { response: APIError; success: false },
>
- Defined in floating-ips/actions.ts:109

changeProtection

changeProtection(
    floatingIpId: number,
    params: ChangeProtectionParams,
): Promise<
    | { response: FloatingIPAction; success: true }
    | { response: APIError; success: false },
>
Change Floating IP Protection
Parameters
- floatingIpId: number
  The Floating IP ID
- params: ChangeProtectionParams
  Parameters for changing the protection status
Returns Promise<
| { response: FloatingIPAction; success: true }
| { response: APIError; success: false },
>
- Defined in floating-ips/actions.ts:126

get

get(
    actionId: number,
): Promise<
    | { response: FloatingIPAction; success: true }
    | { response: APIError; success: false },
>
Get a specific action for Floating IPs
Parameters
- actionId: number
  The action ID
Returns Promise<
| { response: FloatingIPAction; success: true }
| { response: APIError; success: false },
>
- Defined in floating-ips/actions.ts:40

getAll

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

getForFloatingIP

getForFloatingIP(
    floatingIpId: number,
    actionId: number,
): Promise<
    | { response: FloatingIPAction; success: true }
    | { response: APIError; success: false },
>
Get a specific action for a specific Floating IP
Parameters
- floatingIpId: number
  The Floating IP ID
- actionId: number
  The action ID
Returns Promise<
| { response: FloatingIPAction; success: true }
| { response: APIError; success: false },
>
- Defined in floating-ips/actions.ts:146

listForFloatingIP

listForFloatingIP(
    floatingIpId: number,
    params?: ListFloatingIPActionsParams,
): Promise<
    | { response: FloatingIPActionsResponse; success: true }
    | { response: APIError; success: false },
>
List actions for a specific Floating IP
Parameters
- floatingIpId: number
  The Floating IP ID
- Optionalparams: ListFloatingIPActionsParams
  Optional parameters for filtering and pagination
Returns Promise<
| { response: FloatingIPActionsResponse; success: true }
| { response: APIError; success: false },
>
- Defined in floating-ips/actions.ts:53

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

unassign

unassign(
    floatingIpId: number,
): Promise<
    | { response: FloatingIPAction; success: true }
    | { response: APIError; success: false },
>
Unassign a Floating IP
Parameters
- floatingIpId: number
  The Floating IP ID
Returns Promise<
| { response: FloatingIPAction; success: true }
| { response: APIError; success: false },
>
- Defined in floating-ips/actions.ts:94

Class FloatingIPActions

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns FloatingIPActions

Properties

ProtectedbaseUrl

Protectedtoken

Methods

assign

Parameters

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

changeDNSPTR

Parameters

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

changeProtection

Parameters

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

get

Parameters

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

getAll

Parameters

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

getForFloatingIP

Parameters

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

listForFloatingIP

Parameters

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

request

Type Parameters

Parameters

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

unassign

Parameters

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

Settings

On This Page

`Protected`baseUrl

`Protected`token

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

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

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

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

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

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

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

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