cloudflare/resources/custom-hostnames/fallback-origin.d.ts

The official TypeScript library for the Cloudflare API

import { APIResource } from "../../core/resource.js";
import { APIPromise } from "../../core/api-promise.js";
import { RequestOptions } from "../../internal/request-options.js";
export declare class BaseFallbackOrigin extends APIResource {
    static readonly _key: readonly ['customHostnames', 'fallbackOrigin'];
    /**
     * Updates the fallback origin configuration for custom hostnames on a zone. Sets
     * the default origin server for custom hostname traffic.
     *
     * @example
     * ```ts
     * const fallbackOrigin =
     *   await client.customHostnames.fallbackOrigin.update({
     *     zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
     *     origin: 'fallback.example.com',
     *   });
     * ```
     */
    update(params: FallbackOriginUpdateParams, options?: RequestOptions): APIPromise<FallbackOriginUpdateResponse>;
    /**
     * Removes the fallback origin configuration for custom hostnames on a zone. Custom
     * hostnames without specific origins will no longer have a fallback.
     *
     * @example
     * ```ts
     * const fallbackOrigin =
     *   await client.customHostnames.fallbackOrigin.delete({
     *     zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
     *   });
     * ```
     */
    delete(params: FallbackOriginDeleteParams, options?: RequestOptions): APIPromise<FallbackOriginDeleteResponse>;
    /**
     * Retrieves the current fallback origin configuration for custom hostnames on a
     * zone. The fallback origin handles traffic when specific custom hostname origins
     * are unavailable.
     *
     * @example
     * ```ts
     * const fallbackOrigin =
     *   await client.customHostnames.fallbackOrigin.get({
     *     zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
     *   });
     * ```
     */
    get(params: FallbackOriginGetParams, options?: RequestOptions): APIPromise<FallbackOriginGetResponse>;
}
export declare class FallbackOrigin extends BaseFallbackOrigin {
}
export interface FallbackOriginUpdateResponse {
    /**
     * This is the time the fallback origin was created.
     */
    created_at?: string;
    /**
     * These are errors that were encountered while trying to activate a fallback
     * origin.
     */
    errors?: Array<string>;
    /**
     * Your origin hostname that requests to your custom hostnames will be sent to.
     */
    origin?: string;
    /**
     * Status of the fallback origin's activation.
     */
    status?: 'initializing' | 'pending_deployment' | 'pending_deletion' | 'active' | 'deployment_timed_out' | 'deletion_timed_out';
    /**
     * This is the time the fallback origin was updated.
     */
    updated_at?: string;
}
export interface FallbackOriginDeleteResponse {
    /**
     * This is the time the fallback origin was created.
     */
    created_at?: string;
    /**
     * These are errors that were encountered while trying to activate a fallback
     * origin.
     */
    errors?: Array<string>;
    /**
     * Your origin hostname that requests to your custom hostnames will be sent to.
     */
    origin?: string;
    /**
     * Status of the fallback origin's activation.
     */
    status?: 'initializing' | 'pending_deployment' | 'pending_deletion' | 'active' | 'deployment_timed_out' | 'deletion_timed_out';
    /**
     * This is the time the fallback origin was updated.
     */
    updated_at?: string;
}
export interface FallbackOriginGetResponse {
    /**
     * This is the time the fallback origin was created.
     */
    created_at?: string;
    /**
     * These are errors that were encountered while trying to activate a fallback
     * origin.
     */
    errors?: Array<string>;
    /**
     * Your origin hostname that requests to your custom hostnames will be sent to.
     */
    origin?: string;
    /**
     * Status of the fallback origin's activation.
     */
    status?: 'initializing' | 'pending_deployment' | 'pending_deletion' | 'active' | 'deployment_timed_out' | 'deletion_timed_out';
    /**
     * This is the time the fallback origin was updated.
     */
    updated_at?: string;
}
export interface FallbackOriginUpdateParams {
    /**
     * Path param: Identifier.
     */
    zone_id: string;
    /**
     * Body param: Your origin hostname that requests to your custom hostnames will be
     * sent to.
     */
    origin: string;
}
export interface FallbackOriginDeleteParams {
    /**
     * Identifier.
     */
    zone_id: string;
}
export interface FallbackOriginGetParams {
    /**
     * Identifier.
     */
    zone_id: string;
}
export declare namespace FallbackOrigin {
    export { type FallbackOriginUpdateResponse as FallbackOriginUpdateResponse, type FallbackOriginDeleteResponse as FallbackOriginDeleteResponse, type FallbackOriginGetResponse as FallbackOriginGetResponse, type FallbackOriginUpdateParams as FallbackOriginUpdateParams, type FallbackOriginDeleteParams as FallbackOriginDeleteParams, type FallbackOriginGetParams as FallbackOriginGetParams, };
}
//# sourceMappingURL=fallback-origin.d.ts.map