cloudflare
Version:
The official TypeScript library for the Cloudflare API
41 lines • 1.61 kB
text/typescript
import { APIResource } from "../../../../core/resource.mjs";
import { APIPromise } from "../../../../core/api-promise.mjs";
import { RequestOptions } from "../../../../internal/request-options.mjs";
export declare class BaseFailover extends APIResource {
static readonly _key: readonly ['zeroTrust', 'tunnels', 'warpConnector', 'failover'];
/**
* Triggers a manual failover for a specific WARP Connector Tunnel, setting the
* specified client as the active connector. The tunnel must be configured for high
* availability (HA) and the client must be linked to the tunnel.
*
* @example
* ```ts
* const failover =
* await client.zeroTrust.tunnels.warpConnector.failover.update(
* 'f70ff985-a4ef-4643-bbbc-4a0ed4fc8415',
* {
* account_id: '699d98642c564d2e855e9661899b7252',
* client_id: '1bedc50d-42b3-473c-b108-ff3d10c0d925',
* },
* );
* ```
*/
update(tunnelID: string, params: FailoverUpdateParams, options?: RequestOptions): APIPromise<FailoverUpdateResponse | null>;
}
export declare class Failover extends BaseFailover {
}
export type FailoverUpdateResponse = unknown;
export interface FailoverUpdateParams {
/**
* Path param: Cloudflare account ID
*/
account_id: string;
/**
* Body param: UUID of the Cloudflare Tunnel connector.
*/
client_id: string;
}
export declare namespace Failover {
export { type FailoverUpdateResponse as FailoverUpdateResponse, type FailoverUpdateParams as FailoverUpdateParams, };
}
//# sourceMappingURL=failover.d.mts.map