cloudflare/resources/user/audit-logs.d.ts

The official TypeScript library for the Cloudflare API

import * as Core from 'cloudflare/core';
import { APIResource } from 'cloudflare/resource';
import * as AuditLogsAPI from 'cloudflare/resources/user/audit-logs';
import * as Shared from 'cloudflare/resources/shared';
import { AuditLogsV4PagePaginationArray } from 'cloudflare/resources/shared';
import { type V4PagePaginationArrayParams } from 'cloudflare/pagination';
export declare class AuditLogs extends APIResource {
    /**
     * Gets a list of audit logs for a user account. Can be filtered by who made the
     * change, on which zone, and the timeframe of the change.
     */
    list(query?: AuditLogListParams, options?: Core.RequestOptions): Core.PagePromise<AuditLogsV4PagePaginationArray, Shared.AuditLog>;
    list(options?: Core.RequestOptions): Core.PagePromise<AuditLogsV4PagePaginationArray, Shared.AuditLog>;
}
export interface AuditLogListParams extends V4PagePaginationArrayParams {
    /**
     * Finds a specific log by its ID.
     */
    id?: string;
    action?: AuditLogListParams.Action;
    actor?: AuditLogListParams.Actor;
    /**
     * Limits the returned results to logs older than the specified date. This can be a
     * date string `2019-04-30` or an absolute timestamp that conforms to RFC3339.
     */
    before?: string;
    /**
     * Changes the direction of the chronological sorting.
     */
    direction?: 'desc' | 'asc';
    /**
     * Indicates that this request is an export of logs in CSV format.
     */
    export?: boolean;
    /**
     * Indicates whether or not to hide user level audit logs.
     */
    hide_user_logs?: boolean;
    /**
     * Limits the returned results to logs newer than the specified date. This can be a
     * date string `2019-04-30` or an absolute timestamp that conforms to RFC3339.
     */
    since?: string;
    zone?: AuditLogListParams.Zone;
}
export declare namespace AuditLogListParams {
    interface Action {
        /**
         * Filters by the action type.
         */
        type?: string;
    }
    interface Actor {
        /**
         * Filters by the email address of the actor that made the change.
         */
        email?: string;
        /**
         * Filters by the IP address of the request that made the change by specific IP
         * address or valid CIDR Range.
         */
        ip?: string;
    }
    interface Zone {
        /**
         * Filters by the name of the zone associated to the change.
         */
        name?: string;
    }
}
export declare namespace AuditLogs {
    export import AuditLogListParams = AuditLogsAPI.AuditLogListParams;
}
export { AuditLogsV4PagePaginationArray };
//# sourceMappingURL=audit-logs.d.ts.map