cloudflare
Version:
The official TypeScript library for the Cloudflare API
1,171 lines • 34.2 kB
TypeScript
import * as Core from 'cloudflare/core';
import { APIResource } from 'cloudflare/resource';
import * as ConfigurationsAPI from 'cloudflare/resources/zero-trust/gateway/configurations';
export declare class Configurations extends APIResource {
/**
* Updates the current Zero Trust account configuration.
*/
update(params: ConfigurationUpdateParams, options?: Core.RequestOptions): Core.APIPromise<ConfigurationUpdateResponse>;
/**
* Patches the current Zero Trust account configuration. This endpoint can update a
* single subcollection of settings such as `antivirus`, `tls_decrypt`,
* `activity_log`, `block_page`, `browser_isolation`, `fips`, `body_scanning`, or
* `custom_certificate`, without updating the entire configuration object. Returns
* an error if any collection of settings is not properly configured.
*/
edit(params: ConfigurationEditParams, options?: Core.RequestOptions): Core.APIPromise<ConfigurationEditResponse>;
/**
* Fetches the current Zero Trust account configuration.
*/
get(params: ConfigurationGetParams, options?: Core.RequestOptions): Core.APIPromise<ConfigurationGetResponse>;
}
/**
* account settings.
*/
export interface ConfigurationUpdateResponse {
created_at?: string;
/**
* account settings.
*/
settings?: ConfigurationUpdateResponse.Settings;
updated_at?: string;
}
export declare namespace ConfigurationUpdateResponse {
/**
* account settings.
*/
interface Settings {
/**
* Activity log settings.
*/
activity_log?: Settings.ActivityLog;
/**
* Anti-virus settings.
*/
antivirus?: Settings.Antivirus;
/**
* Block page layout settings.
*/
block_page?: Settings.BlockPage;
/**
* DLP body scanning settings.
*/
body_scanning?: Settings.BodyScanning;
/**
* Browser isolation settings.
*/
browser_isolation?: Settings.BrowserIsolation;
/**
* Custom certificate settings for BYO-PKI.
*/
custom_certificate?: Settings.CustomCertificate;
/**
* Extended e-mail matching settings.
*/
extended_email_matching?: Settings.ExtendedEmailMatching;
/**
* FIPS settings.
*/
fips?: Settings.Fips;
/**
* Protocol Detection settings.
*/
protocol_detection?: Settings.ProtocolDetection;
/**
* TLS interception settings.
*/
tls_decrypt?: Settings.TLSDecrypt;
}
namespace Settings {
/**
* Activity log settings.
*/
interface ActivityLog {
/**
* Enable activity logging.
*/
enabled?: boolean;
}
/**
* Anti-virus settings.
*/
interface Antivirus {
/**
* Enable anti-virus scanning on downloads.
*/
enabled_download_phase?: boolean;
/**
* Enable anti-virus scanning on uploads.
*/
enabled_upload_phase?: boolean;
/**
* Block requests for files that cannot be scanned.
*/
fail_closed?: boolean;
/**
* Configure a message to display on the user's device when an antivirus search is
* performed.
*/
notification_settings?: Antivirus.NotificationSettings;
}
namespace Antivirus {
/**
* Configure a message to display on the user's device when an antivirus search is
* performed.
*/
interface NotificationSettings {
/**
* Set notification on
*/
enabled?: boolean;
/**
* Customize the message shown in the notification.
*/
msg?: string;
/**
* Optional URL to direct users to additional information. If not set, the
* notification will open a block page.
*/
support_url?: string;
}
}
/**
* Block page layout settings.
*/
interface BlockPage {
/**
* Block page background color in #rrggbb format.
*/
background_color?: string;
/**
* Enable only cipher suites and TLS versions compliant with FIPS 140-2.
*/
enabled?: boolean;
/**
* Block page footer text.
*/
footer_text?: string;
/**
* Block page header text.
*/
header_text?: string;
/**
* Full URL to the logo file.
*/
logo_path?: string;
/**
* Admin email for users to contact.
*/
mailto_address?: string;
/**
* Subject line for emails created from block page.
*/
mailto_subject?: string;
/**
* Block page title.
*/
name?: string;
/**
* Suppress detailed info at the bottom of the block page.
*/
suppress_footer?: boolean;
}
/**
* DLP body scanning settings.
*/
interface BodyScanning {
/**
* Set the inspection mode to either `deep` or `shallow`.
*/
inspection_mode?: string;
}
/**
* Browser isolation settings.
*/
interface BrowserIsolation {
/**
* Enable non-identity onramp support for Browser Isolation.
*/
non_identity_enabled?: boolean;
/**
* Enable Clientless Browser Isolation.
*/
url_browser_isolation_enabled?: boolean;
}
/**
* Custom certificate settings for BYO-PKI.
*/
interface CustomCertificate {
/**
* Enable use of custom certificate authority for signing Gateway traffic.
*/
enabled: boolean;
/**
* UUID of certificate (ID from MTLS certificate store).
*/
id?: string;
/**
* Certificate status (internal).
*/
binding_status?: string;
updated_at?: string;
}
/**
* Extended e-mail matching settings.
*/
interface ExtendedEmailMatching {
/**
* Enable matching all variants of user emails (with + or . modifiers) used as
* criteria in Firewall policies.
*/
enabled?: boolean;
}
/**
* FIPS settings.
*/
interface Fips {
/**
* Enable only cipher suites and TLS versions compliant with FIPS 140-2.
*/
tls?: boolean;
}
/**
* Protocol Detection settings.
*/
interface ProtocolDetection {
/**
* Enable detecting protocol on initial bytes of client traffic.
*/
enabled?: boolean;
}
/**
* TLS interception settings.
*/
interface TLSDecrypt {
/**
* Enable inspecting encrypted HTTP traffic.
*/
enabled?: boolean;
}
}
}
/**
* account settings.
*/
export interface ConfigurationEditResponse {
created_at?: string;
/**
* account settings.
*/
settings?: ConfigurationEditResponse.Settings;
updated_at?: string;
}
export declare namespace ConfigurationEditResponse {
/**
* account settings.
*/
interface Settings {
/**
* Activity log settings.
*/
activity_log?: Settings.ActivityLog;
/**
* Anti-virus settings.
*/
antivirus?: Settings.Antivirus;
/**
* Block page layout settings.
*/
block_page?: Settings.BlockPage;
/**
* DLP body scanning settings.
*/
body_scanning?: Settings.BodyScanning;
/**
* Browser isolation settings.
*/
browser_isolation?: Settings.BrowserIsolation;
/**
* Custom certificate settings for BYO-PKI.
*/
custom_certificate?: Settings.CustomCertificate;
/**
* Extended e-mail matching settings.
*/
extended_email_matching?: Settings.ExtendedEmailMatching;
/**
* FIPS settings.
*/
fips?: Settings.Fips;
/**
* Protocol Detection settings.
*/
protocol_detection?: Settings.ProtocolDetection;
/**
* TLS interception settings.
*/
tls_decrypt?: Settings.TLSDecrypt;
}
namespace Settings {
/**
* Activity log settings.
*/
interface ActivityLog {
/**
* Enable activity logging.
*/
enabled?: boolean;
}
/**
* Anti-virus settings.
*/
interface Antivirus {
/**
* Enable anti-virus scanning on downloads.
*/
enabled_download_phase?: boolean;
/**
* Enable anti-virus scanning on uploads.
*/
enabled_upload_phase?: boolean;
/**
* Block requests for files that cannot be scanned.
*/
fail_closed?: boolean;
/**
* Configure a message to display on the user's device when an antivirus search is
* performed.
*/
notification_settings?: Antivirus.NotificationSettings;
}
namespace Antivirus {
/**
* Configure a message to display on the user's device when an antivirus search is
* performed.
*/
interface NotificationSettings {
/**
* Set notification on
*/
enabled?: boolean;
/**
* Customize the message shown in the notification.
*/
msg?: string;
/**
* Optional URL to direct users to additional information. If not set, the
* notification will open a block page.
*/
support_url?: string;
}
}
/**
* Block page layout settings.
*/
interface BlockPage {
/**
* Block page background color in #rrggbb format.
*/
background_color?: string;
/**
* Enable only cipher suites and TLS versions compliant with FIPS 140-2.
*/
enabled?: boolean;
/**
* Block page footer text.
*/
footer_text?: string;
/**
* Block page header text.
*/
header_text?: string;
/**
* Full URL to the logo file.
*/
logo_path?: string;
/**
* Admin email for users to contact.
*/
mailto_address?: string;
/**
* Subject line for emails created from block page.
*/
mailto_subject?: string;
/**
* Block page title.
*/
name?: string;
/**
* Suppress detailed info at the bottom of the block page.
*/
suppress_footer?: boolean;
}
/**
* DLP body scanning settings.
*/
interface BodyScanning {
/**
* Set the inspection mode to either `deep` or `shallow`.
*/
inspection_mode?: string;
}
/**
* Browser isolation settings.
*/
interface BrowserIsolation {
/**
* Enable non-identity onramp support for Browser Isolation.
*/
non_identity_enabled?: boolean;
/**
* Enable Clientless Browser Isolation.
*/
url_browser_isolation_enabled?: boolean;
}
/**
* Custom certificate settings for BYO-PKI.
*/
interface CustomCertificate {
/**
* Enable use of custom certificate authority for signing Gateway traffic.
*/
enabled: boolean;
/**
* UUID of certificate (ID from MTLS certificate store).
*/
id?: string;
/**
* Certificate status (internal).
*/
binding_status?: string;
updated_at?: string;
}
/**
* Extended e-mail matching settings.
*/
interface ExtendedEmailMatching {
/**
* Enable matching all variants of user emails (with + or . modifiers) used as
* criteria in Firewall policies.
*/
enabled?: boolean;
}
/**
* FIPS settings.
*/
interface Fips {
/**
* Enable only cipher suites and TLS versions compliant with FIPS 140-2.
*/
tls?: boolean;
}
/**
* Protocol Detection settings.
*/
interface ProtocolDetection {
/**
* Enable detecting protocol on initial bytes of client traffic.
*/
enabled?: boolean;
}
/**
* TLS interception settings.
*/
interface TLSDecrypt {
/**
* Enable inspecting encrypted HTTP traffic.
*/
enabled?: boolean;
}
}
}
/**
* account settings.
*/
export interface ConfigurationGetResponse {
created_at?: string;
/**
* account settings.
*/
settings?: ConfigurationGetResponse.Settings;
updated_at?: string;
}
export declare namespace ConfigurationGetResponse {
/**
* account settings.
*/
interface Settings {
/**
* Activity log settings.
*/
activity_log?: Settings.ActivityLog;
/**
* Anti-virus settings.
*/
antivirus?: Settings.Antivirus;
/**
* Block page layout settings.
*/
block_page?: Settings.BlockPage;
/**
* DLP body scanning settings.
*/
body_scanning?: Settings.BodyScanning;
/**
* Browser isolation settings.
*/
browser_isolation?: Settings.BrowserIsolation;
/**
* Custom certificate settings for BYO-PKI.
*/
custom_certificate?: Settings.CustomCertificate;
/**
* Extended e-mail matching settings.
*/
extended_email_matching?: Settings.ExtendedEmailMatching;
/**
* FIPS settings.
*/
fips?: Settings.Fips;
/**
* Protocol Detection settings.
*/
protocol_detection?: Settings.ProtocolDetection;
/**
* TLS interception settings.
*/
tls_decrypt?: Settings.TLSDecrypt;
}
namespace Settings {
/**
* Activity log settings.
*/
interface ActivityLog {
/**
* Enable activity logging.
*/
enabled?: boolean;
}
/**
* Anti-virus settings.
*/
interface Antivirus {
/**
* Enable anti-virus scanning on downloads.
*/
enabled_download_phase?: boolean;
/**
* Enable anti-virus scanning on uploads.
*/
enabled_upload_phase?: boolean;
/**
* Block requests for files that cannot be scanned.
*/
fail_closed?: boolean;
/**
* Configure a message to display on the user's device when an antivirus search is
* performed.
*/
notification_settings?: Antivirus.NotificationSettings;
}
namespace Antivirus {
/**
* Configure a message to display on the user's device when an antivirus search is
* performed.
*/
interface NotificationSettings {
/**
* Set notification on
*/
enabled?: boolean;
/**
* Customize the message shown in the notification.
*/
msg?: string;
/**
* Optional URL to direct users to additional information. If not set, the
* notification will open a block page.
*/
support_url?: string;
}
}
/**
* Block page layout settings.
*/
interface BlockPage {
/**
* Block page background color in #rrggbb format.
*/
background_color?: string;
/**
* Enable only cipher suites and TLS versions compliant with FIPS 140-2.
*/
enabled?: boolean;
/**
* Block page footer text.
*/
footer_text?: string;
/**
* Block page header text.
*/
header_text?: string;
/**
* Full URL to the logo file.
*/
logo_path?: string;
/**
* Admin email for users to contact.
*/
mailto_address?: string;
/**
* Subject line for emails created from block page.
*/
mailto_subject?: string;
/**
* Block page title.
*/
name?: string;
/**
* Suppress detailed info at the bottom of the block page.
*/
suppress_footer?: boolean;
}
/**
* DLP body scanning settings.
*/
interface BodyScanning {
/**
* Set the inspection mode to either `deep` or `shallow`.
*/
inspection_mode?: string;
}
/**
* Browser isolation settings.
*/
interface BrowserIsolation {
/**
* Enable non-identity onramp support for Browser Isolation.
*/
non_identity_enabled?: boolean;
/**
* Enable Clientless Browser Isolation.
*/
url_browser_isolation_enabled?: boolean;
}
/**
* Custom certificate settings for BYO-PKI.
*/
interface CustomCertificate {
/**
* Enable use of custom certificate authority for signing Gateway traffic.
*/
enabled: boolean;
/**
* UUID of certificate (ID from MTLS certificate store).
*/
id?: string;
/**
* Certificate status (internal).
*/
binding_status?: string;
updated_at?: string;
}
/**
* Extended e-mail matching settings.
*/
interface ExtendedEmailMatching {
/**
* Enable matching all variants of user emails (with + or . modifiers) used as
* criteria in Firewall policies.
*/
enabled?: boolean;
}
/**
* FIPS settings.
*/
interface Fips {
/**
* Enable only cipher suites and TLS versions compliant with FIPS 140-2.
*/
tls?: boolean;
}
/**
* Protocol Detection settings.
*/
interface ProtocolDetection {
/**
* Enable detecting protocol on initial bytes of client traffic.
*/
enabled?: boolean;
}
/**
* TLS interception settings.
*/
interface TLSDecrypt {
/**
* Enable inspecting encrypted HTTP traffic.
*/
enabled?: boolean;
}
}
}
export interface ConfigurationUpdateParams {
/**
* Path param:
*/
account_id: string;
/**
* Body param: account settings.
*/
settings?: ConfigurationUpdateParams.Settings;
}
export declare namespace ConfigurationUpdateParams {
/**
* account settings.
*/
interface Settings {
/**
* Activity log settings.
*/
activity_log?: Settings.ActivityLog;
/**
* Anti-virus settings.
*/
antivirus?: Settings.Antivirus;
/**
* Block page layout settings.
*/
block_page?: Settings.BlockPage;
/**
* DLP body scanning settings.
*/
body_scanning?: Settings.BodyScanning;
/**
* Browser isolation settings.
*/
browser_isolation?: Settings.BrowserIsolation;
/**
* Custom certificate settings for BYO-PKI.
*/
custom_certificate?: Settings.CustomCertificate;
/**
* Extended e-mail matching settings.
*/
extended_email_matching?: Settings.ExtendedEmailMatching;
/**
* FIPS settings.
*/
fips?: Settings.Fips;
/**
* Protocol Detection settings.
*/
protocol_detection?: Settings.ProtocolDetection;
/**
* TLS interception settings.
*/
tls_decrypt?: Settings.TLSDecrypt;
}
namespace Settings {
/**
* Activity log settings.
*/
interface ActivityLog {
/**
* Enable activity logging.
*/
enabled?: boolean;
}
/**
* Anti-virus settings.
*/
interface Antivirus {
/**
* Enable anti-virus scanning on downloads.
*/
enabled_download_phase?: boolean;
/**
* Enable anti-virus scanning on uploads.
*/
enabled_upload_phase?: boolean;
/**
* Block requests for files that cannot be scanned.
*/
fail_closed?: boolean;
/**
* Configure a message to display on the user's device when an antivirus search is
* performed.
*/
notification_settings?: Antivirus.NotificationSettings;
}
namespace Antivirus {
/**
* Configure a message to display on the user's device when an antivirus search is
* performed.
*/
interface NotificationSettings {
/**
* Set notification on
*/
enabled?: boolean;
/**
* Customize the message shown in the notification.
*/
msg?: string;
/**
* Optional URL to direct users to additional information. If not set, the
* notification will open a block page.
*/
support_url?: string;
}
}
/**
* Block page layout settings.
*/
interface BlockPage {
/**
* Block page background color in #rrggbb format.
*/
background_color?: string;
/**
* Enable only cipher suites and TLS versions compliant with FIPS 140-2.
*/
enabled?: boolean;
/**
* Block page footer text.
*/
footer_text?: string;
/**
* Block page header text.
*/
header_text?: string;
/**
* Full URL to the logo file.
*/
logo_path?: string;
/**
* Admin email for users to contact.
*/
mailto_address?: string;
/**
* Subject line for emails created from block page.
*/
mailto_subject?: string;
/**
* Block page title.
*/
name?: string;
/**
* Suppress detailed info at the bottom of the block page.
*/
suppress_footer?: boolean;
}
/**
* DLP body scanning settings.
*/
interface BodyScanning {
/**
* Set the inspection mode to either `deep` or `shallow`.
*/
inspection_mode?: string;
}
/**
* Browser isolation settings.
*/
interface BrowserIsolation {
/**
* Enable non-identity onramp support for Browser Isolation.
*/
non_identity_enabled?: boolean;
/**
* Enable Clientless Browser Isolation.
*/
url_browser_isolation_enabled?: boolean;
}
/**
* Custom certificate settings for BYO-PKI.
*/
interface CustomCertificate {
/**
* Enable use of custom certificate authority for signing Gateway traffic.
*/
enabled: boolean;
/**
* UUID of certificate (ID from MTLS certificate store).
*/
id?: string;
}
/**
* Extended e-mail matching settings.
*/
interface ExtendedEmailMatching {
/**
* Enable matching all variants of user emails (with + or . modifiers) used as
* criteria in Firewall policies.
*/
enabled?: boolean;
}
/**
* FIPS settings.
*/
interface Fips {
/**
* Enable only cipher suites and TLS versions compliant with FIPS 140-2.
*/
tls?: boolean;
}
/**
* Protocol Detection settings.
*/
interface ProtocolDetection {
/**
* Enable detecting protocol on initial bytes of client traffic.
*/
enabled?: boolean;
}
/**
* TLS interception settings.
*/
interface TLSDecrypt {
/**
* Enable inspecting encrypted HTTP traffic.
*/
enabled?: boolean;
}
}
}
export interface ConfigurationEditParams {
/**
* Path param:
*/
account_id: string;
/**
* Body param: account settings.
*/
settings?: ConfigurationEditParams.Settings;
}
export declare namespace ConfigurationEditParams {
/**
* account settings.
*/
interface Settings {
/**
* Activity log settings.
*/
activity_log?: Settings.ActivityLog;
/**
* Anti-virus settings.
*/
antivirus?: Settings.Antivirus;
/**
* Block page layout settings.
*/
block_page?: Settings.BlockPage;
/**
* DLP body scanning settings.
*/
body_scanning?: Settings.BodyScanning;
/**
* Browser isolation settings.
*/
browser_isolation?: Settings.BrowserIsolation;
/**
* Custom certificate settings for BYO-PKI.
*/
custom_certificate?: Settings.CustomCertificate;
/**
* Extended e-mail matching settings.
*/
extended_email_matching?: Settings.ExtendedEmailMatching;
/**
* FIPS settings.
*/
fips?: Settings.Fips;
/**
* Protocol Detection settings.
*/
protocol_detection?: Settings.ProtocolDetection;
/**
* TLS interception settings.
*/
tls_decrypt?: Settings.TLSDecrypt;
}
namespace Settings {
/**
* Activity log settings.
*/
interface ActivityLog {
/**
* Enable activity logging.
*/
enabled?: boolean;
}
/**
* Anti-virus settings.
*/
interface Antivirus {
/**
* Enable anti-virus scanning on downloads.
*/
enabled_download_phase?: boolean;
/**
* Enable anti-virus scanning on uploads.
*/
enabled_upload_phase?: boolean;
/**
* Block requests for files that cannot be scanned.
*/
fail_closed?: boolean;
/**
* Configure a message to display on the user's device when an antivirus search is
* performed.
*/
notification_settings?: Antivirus.NotificationSettings;
}
namespace Antivirus {
/**
* Configure a message to display on the user's device when an antivirus search is
* performed.
*/
interface NotificationSettings {
/**
* Set notification on
*/
enabled?: boolean;
/**
* Customize the message shown in the notification.
*/
msg?: string;
/**
* Optional URL to direct users to additional information. If not set, the
* notification will open a block page.
*/
support_url?: string;
}
}
/**
* Block page layout settings.
*/
interface BlockPage {
/**
* Block page background color in #rrggbb format.
*/
background_color?: string;
/**
* Enable only cipher suites and TLS versions compliant with FIPS 140-2.
*/
enabled?: boolean;
/**
* Block page footer text.
*/
footer_text?: string;
/**
* Block page header text.
*/
header_text?: string;
/**
* Full URL to the logo file.
*/
logo_path?: string;
/**
* Admin email for users to contact.
*/
mailto_address?: string;
/**
* Subject line for emails created from block page.
*/
mailto_subject?: string;
/**
* Block page title.
*/
name?: string;
/**
* Suppress detailed info at the bottom of the block page.
*/
suppress_footer?: boolean;
}
/**
* DLP body scanning settings.
*/
interface BodyScanning {
/**
* Set the inspection mode to either `deep` or `shallow`.
*/
inspection_mode?: string;
}
/**
* Browser isolation settings.
*/
interface BrowserIsolation {
/**
* Enable non-identity onramp support for Browser Isolation.
*/
non_identity_enabled?: boolean;
/**
* Enable Clientless Browser Isolation.
*/
url_browser_isolation_enabled?: boolean;
}
/**
* Custom certificate settings for BYO-PKI.
*/
interface CustomCertificate {
/**
* Enable use of custom certificate authority for signing Gateway traffic.
*/
enabled: boolean;
/**
* UUID of certificate (ID from MTLS certificate store).
*/
id?: string;
}
/**
* Extended e-mail matching settings.
*/
interface ExtendedEmailMatching {
/**
* Enable matching all variants of user emails (with + or . modifiers) used as
* criteria in Firewall policies.
*/
enabled?: boolean;
}
/**
* FIPS settings.
*/
interface Fips {
/**
* Enable only cipher suites and TLS versions compliant with FIPS 140-2.
*/
tls?: boolean;
}
/**
* Protocol Detection settings.
*/
interface ProtocolDetection {
/**
* Enable detecting protocol on initial bytes of client traffic.
*/
enabled?: boolean;
}
/**
* TLS interception settings.
*/
interface TLSDecrypt {
/**
* Enable inspecting encrypted HTTP traffic.
*/
enabled?: boolean;
}
}
}
export interface ConfigurationGetParams {
account_id: string;
}
export declare namespace Configurations {
export import ConfigurationUpdateResponse = ConfigurationsAPI.ConfigurationUpdateResponse;
export import ConfigurationEditResponse = ConfigurationsAPI.ConfigurationEditResponse;
export import ConfigurationGetResponse = ConfigurationsAPI.ConfigurationGetResponse;
export import ConfigurationUpdateParams = ConfigurationsAPI.ConfigurationUpdateParams;
export import ConfigurationEditParams = ConfigurationsAPI.ConfigurationEditParams;
export import ConfigurationGetParams = ConfigurationsAPI.ConfigurationGetParams;
}
//# sourceMappingURL=configurations.d.ts.map