cloudflare/resources/zero-trust/access/keys.d.ts

The official TypeScript library for the Cloudflare API

import { APIResource } from "../../../resource.js";
import * as Core from "../../../core.js";
export declare class Keys extends APIResource {
    /**
     * Updates the Access key rotation settings for an account.
     */
    update(params: KeyUpdateParams, options?: Core.RequestOptions): Core.APIPromise<KeyUpdateResponse>;
    /**
     * Gets the Access key rotation settings for an account.
     */
    get(params: KeyGetParams, options?: Core.RequestOptions): Core.APIPromise<KeyGetResponse>;
    /**
     * Perfoms a key rotation for an account.
     */
    rotate(params: KeyRotateParams, options?: Core.RequestOptions): Core.APIPromise<KeyRotateResponse>;
}
export interface KeyUpdateResponse {
    /**
     * The number of days until the next key rotation.
     */
    days_until_next_rotation?: number;
    /**
     * The number of days between key rotations.
     */
    key_rotation_interval_days?: number;
    /**
     * The timestamp of the previous key rotation.
     */
    last_key_rotation_at?: string;
}
export interface KeyGetResponse {
    /**
     * The number of days until the next key rotation.
     */
    days_until_next_rotation?: number;
    /**
     * The number of days between key rotations.
     */
    key_rotation_interval_days?: number;
    /**
     * The timestamp of the previous key rotation.
     */
    last_key_rotation_at?: string;
}
export interface KeyRotateResponse {
    /**
     * The number of days until the next key rotation.
     */
    days_until_next_rotation?: number;
    /**
     * The number of days between key rotations.
     */
    key_rotation_interval_days?: number;
    /**
     * The timestamp of the previous key rotation.
     */
    last_key_rotation_at?: string;
}
export interface KeyUpdateParams {
    /**
     * Path param: Identifier
     */
    account_id: string;
    /**
     * Body param: The number of days between key rotations.
     */
    key_rotation_interval_days: number;
}
export interface KeyGetParams {
    /**
     * Identifier
     */
    account_id: string;
}
export interface KeyRotateParams {
    /**
     * Identifier
     */
    account_id: string;
}
export declare namespace Keys {
    export { type KeyUpdateResponse as KeyUpdateResponse, type KeyGetResponse as KeyGetResponse, type KeyRotateResponse as KeyRotateResponse, type KeyUpdateParams as KeyUpdateParams, type KeyGetParams as KeyGetParams, type KeyRotateParams as KeyRotateParams, };
}
//# sourceMappingURL=keys.d.ts.map