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.
/accounts/{identifier}/gateway/configuration
patch
Zero Trust accounts
zero-trust-accounts-patch-zero-trust-account-configuration
nullnull[
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"example": "699d98642c564d2e855e9661899b7252"
}
}
]{
"content": {
"application/json": {
"schema": {
"description": "account settings.",
"properties": {
"settings": {
"description": "account settings.",
"properties": {
"activity_log": {
"description": "Activity log settings.",
"properties": {
"enabled": {
"description": "Enable activity logging.",
"example": true,
"type": "boolean"
}
},
"type": "object"
},
"antivirus": {
"description": "Anti-virus settings.",
"properties": {
"enabled_download_phase": {
"description": "Enable anti-virus scanning on downloads.",
"example": false,
"type": "boolean"
},
"enabled_upload_phase": {
"description": "Enable anti-virus scanning on uploads.",
"example": false,
"type": "boolean"
},
"fail_closed": {
"description": "Block requests for files that cannot be scanned.",
"example": false,
"type": "boolean"
}
},
"type": "object"
},
"block_page": {
"description": "Block page layout settings.",
"properties": {
"background_color": {
"description": "Block page background color in #rrggbb format.",
"type": "string"
},
"enabled": {
"description": "Enable only cipher suites and TLS versions compliant with FIPS 140-2.",
"example": true,
"type": "boolean"
},
"footer_text": {
"description": "Block page footer text.",
"example": "--footer--",
"type": "string"
},
"header_text": {
"description": "Block page header text.",
"example": "--header--",
"type": "string"
},
"logo_path": {
"description": "Full URL to the logo file.",
"example": "https://logos.com/a.png",
"type": "string"
},
"mailto_address": {
"description": "Admin email for users to contact.",
"example": "admin@example.com",
"type": "string"
},
"mailto_subject": {
"description": "Subject line for emails created from block page.",
"example": "Blocked User Inquiry",
"type": "string"
},
"name": {
"description": "Block page title.",
"example": "Cloudflare",
"type": "string"
},
"suppress_footer": {
"description": "Suppress detailed info at the bottom of the block page.",
"example": false,
"type": "boolean"
}
},
"type": "object"
},
"body_scanning": {
"description": "DLP body scanning settings.",
"properties": {
"inspection_mode": {
"description": "Set the inspection mode to either `deep` or `shallow`.",
"example": "deep",
"type": "string"
}
},
"type": "object"
},
"browser_isolation": {
"description": "Browser isolation settings.",
"properties": {
"non_identity_enabled": {
"description": "Enable non-identity onramp support for Browser Isolation.",
"example": true,
"type": "boolean"
},
"url_browser_isolation_enabled": {
"description": "Enable Clientless Browser Isolation.",
"example": true,
"type": "boolean"
}
},
"type": "object"
},
"custom_certificate": {
"description": "Custom certificate settings for BYO-PKI.",
"properties": {
"binding_status": {
"description": "Certificate status (internal).",
"example": "pending_deployment",
"readOnly": true,
"type": "string"
},
"enabled": {
"description": "Enable use of custom certificate authority for signing Gateway traffic.",
"example": true,
"type": "boolean"
},
"id": {
"description": "UUID of certificate (ID from MTLS certificate store).",
"example": "d1b364c5-1311-466e-a194-f0e943e0799f",
"type": "string"
},
"updated_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
}
},
"required": [
"enabled"
],
"type": "object"
},
"fips": {
"description": "FIPS settings.",
"properties": {
"tls": {
"description": "Enable only cipher suites and TLS versions compliant with FIPS 140-2.",
"example": true,
"type": "boolean"
}
},
"type": "object"
},
"protocol_detection": {
"description": "Protocol Detection settings.",
"properties": {
"enabled": {
"description": "Enable detecting protocol on initial bytes of client traffic.",
"example": true,
"type": "boolean"
}
},
"type": "object"
},
"tls_decrypt": {
"description": "TLS interception settings.",
"properties": {
"enabled": {
"description": "Enable inspecting encrypted HTTP traffic.",
"example": true,
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
}
}
},
"required": true
}{
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"allOf": [
{
"properties": {
"errors": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"messages": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"result": {
"anyOf": [
{
"type": "object"
},
{
"items": {},
"type": "array"
},
{
"type": "string"
}
]
},
"success": {
"description": "Whether the API call was successful",
"enum": [
true
],
"example": true,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
},
{
"properties": {
"result": {
"anyOf": [
{
"type": "object"
},
{
"type": "string"
}
]
}
}
}
],
"type": "object"
},
{
"properties": {
"result": {
"allOf": [
{
"description": "account settings.",
"properties": {
"settings": {
"description": "account settings.",
"properties": {
"activity_log": {
"description": "Activity log settings.",
"properties": {
"enabled": {
"description": "Enable activity logging.",
"example": true,
"type": "boolean"
}
},
"type": "object"
},
"antivirus": {
"description": "Anti-virus settings.",
"properties": {
"enabled_download_phase": {
"description": "Enable anti-virus scanning on downloads.",
"example": false,
"type": "boolean"
},
"enabled_upload_phase": {
"description": "Enable anti-virus scanning on uploads.",
"example": false,
"type": "boolean"
},
"fail_closed": {
"description": "Block requests for files that cannot be scanned.",
"example": false,
"type": "boolean"
}
},
"type": "object"
},
"block_page": {
"description": "Block page layout settings.",
"properties": {
"background_color": {
"description": "Block page background color in #rrggbb format.",
"type": "string"
},
"enabled": {
"description": "Enable only cipher suites and TLS versions compliant with FIPS 140-2.",
"example": true,
"type": "boolean"
},
"footer_text": {
"description": "Block page footer text.",
"example": "--footer--",
"type": "string"
},
"header_text": {
"description": "Block page header text.",
"example": "--header--",
"type": "string"
},
"logo_path": {
"description": "Full URL to the logo file.",
"example": "https://logos.com/a.png",
"type": "string"
},
"mailto_address": {
"description": "Admin email for users to contact.",
"example": "admin@example.com",
"type": "string"
},
"mailto_subject": {
"description": "Subject line for emails created from block page.",
"example": "Blocked User Inquiry",
"type": "string"
},
"name": {
"description": "Block page title.",
"example": "Cloudflare",
"type": "string"
},
"suppress_footer": {
"description": "Suppress detailed info at the bottom of the block page.",
"example": false,
"type": "boolean"
}
},
"type": "object"
},
"body_scanning": {
"description": "DLP body scanning settings.",
"properties": {
"inspection_mode": {
"description": "Set the inspection mode to either `deep` or `shallow`.",
"example": "deep",
"type": "string"
}
},
"type": "object"
},
"browser_isolation": {
"description": "Browser isolation settings.",
"properties": {
"non_identity_enabled": {
"description": "Enable non-identity onramp support for Browser Isolation.",
"example": true,
"type": "boolean"
},
"url_browser_isolation_enabled": {
"description": "Enable Clientless Browser Isolation.",
"example": true,
"type": "boolean"
}
},
"type": "object"
},
"custom_certificate": {
"description": "Custom certificate settings for BYO-PKI.",
"properties": {
"binding_status": {
"description": "Certificate status (internal).",
"example": "pending_deployment",
"readOnly": true,
"type": "string"
},
"enabled": {
"description": "Enable use of custom certificate authority for signing Gateway traffic.",
"example": true,
"type": "boolean"
},
"id": {
"description": "UUID of certificate (ID from MTLS certificate store).",
"example": "d1b364c5-1311-466e-a194-f0e943e0799f",
"type": "string"
},
"updated_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
}
},
"required": [
"enabled"
],
"type": "object"
},
"fips": {
"description": "FIPS settings.",
"properties": {
"tls": {
"description": "Enable only cipher suites and TLS versions compliant with FIPS 140-2.",
"example": true,
"type": "boolean"
}
},
"type": "object"
},
"protocol_detection": {
"description": "Protocol Detection settings.",
"properties": {
"enabled": {
"description": "Enable detecting protocol on initial bytes of client traffic.",
"example": true,
"type": "boolean"
}
},
"type": "object"
},
"tls_decrypt": {
"description": "TLS interception settings.",
"properties": {
"enabled": {
"description": "Enable inspecting encrypted HTTP traffic.",
"example": true,
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
{
"properties": {
"created_at": {
"example": "2014-01-01T05:20:00.12345Z",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"updated_at": {
"example": "2014-01-01T05:20:00.12345Z",
"format": "date-time",
"readOnly": true,
"type": "string"
}
}
}
],
"type": "object"
}
}
}
],
"type": "object"
}
}
},
"description": "Update Zero Trust account configuration response"
},
"4XX": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"allOf": [
{
"allOf": [
{
"properties": {
"errors": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"messages": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"result": {
"anyOf": [
{
"type": "object"
},
{
"items": {},
"type": "array"
},
{
"type": "string"
}
]
},
"success": {
"description": "Whether the API call was successful",
"enum": [
true
],
"example": true,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
},
{
"properties": {
"result": {
"anyOf": [
{
"type": "object"
},
{
"type": "string"
}
]
}
}
}
],
"type": "object"
},
{
"properties": {
"result": {
"allOf": [
{
"description": "account settings.",
"properties": {
"settings": {
"description": "account settings.",
"properties": {
"activity_log": {
"description": "Activity log settings.",
"properties": {
"enabled": {
"description": "Enable activity logging.",
"example": true,
"type": "boolean"
}
},
"type": "object"
},
"antivirus": {
"description": "Anti-virus settings.",
"properties": {
"enabled_download_phase": {
"description": "Enable anti-virus scanning on downloads.",
"example": false,
"type": "boolean"
},
"enabled_upload_phase": {
"description": "Enable anti-virus scanning on uploads.",
"example": false,
"type": "boolean"
},
"fail_closed": {
"description": "Block requests for files that cannot be scanned.",
"example": false,
"type": "boolean"
}
},
"type": "object"
},
"block_page": {
"description": "Block page layout settings.",
"properties": {
"background_color": {
"description": "Block page background color in #rrggbb format.",
"type": "string"
},
"enabled": {
"description": "Enable only cipher suites and TLS versions compliant with FIPS 140-2.",
"example": true,
"type": "boolean"
},
"footer_text": {
"description": "Block page footer text.",
"example": "--footer--",
"type": "string"
},
"header_text": {
"description": "Block page header text.",
"example": "--header--",
"type": "string"
},
"logo_path": {
"description": "Full URL to the logo file.",
"example": "https://logos.com/a.png",
"type": "string"
},
"mailto_address": {
"description": "Admin email for users to contact.",
"example": "admin@example.com",
"type": "string"
},
"mailto_subject": {
"description": "Subject line for emails created from block page.",
"example": "Blocked User Inquiry",
"type": "string"
},
"name": {
"description": "Block page title.",
"example": "Cloudflare",
"type": "string"
},
"suppress_footer": {
"description": "Suppress detailed info at the bottom of the block page.",
"example": false,
"type": "boolean"
}
},
"type": "object"
},
"body_scanning": {
"description": "DLP body scanning settings.",
"properties": {
"inspection_mode": {
"description": "Set the inspection mode to either `deep` or `shallow`.",
"example": "deep",
"type": "string"
}
},
"type": "object"
},
"browser_isolation": {
"description": "Browser isolation settings.",
"properties": {
"non_identity_enabled": {
"description": "Enable non-identity onramp support for Browser Isolation.",
"example": true,
"type": "boolean"
},
"url_browser_isolation_enabled": {
"description": "Enable Clientless Browser Isolation.",
"example": true,
"type": "boolean"
}
},
"type": "object"
},
"custom_certificate": {
"description": "Custom certificate settings for BYO-PKI.",
"properties": {
"binding_status": {
"description": "Certificate status (internal).",
"example": "pending_deployment",
"readOnly": true,
"type": "string"
},
"enabled": {
"description": "Enable use of custom certificate authority for signing Gateway traffic.",
"example": true,
"type": "boolean"
},
"id": {
"description": "UUID of certificate (ID from MTLS certificate store).",
"example": "d1b364c5-1311-466e-a194-f0e943e0799f",
"type": "string"
},
"updated_at": {
"format": "date-time",
"readOnly": true,
"type": "string"
}
},
"required": [
"enabled"
],
"type": "object"
},
"fips": {
"description": "FIPS settings.",
"properties": {
"tls": {
"description": "Enable only cipher suites and TLS versions compliant with FIPS 140-2.",
"example": true,
"type": "boolean"
}
},
"type": "object"
},
"protocol_detection": {
"description": "Protocol Detection settings.",
"properties": {
"enabled": {
"description": "Enable detecting protocol on initial bytes of client traffic.",
"example": true,
"type": "boolean"
}
},
"type": "object"
},
"tls_decrypt": {
"description": "TLS interception settings.",
"properties": {
"enabled": {
"description": "Enable inspecting encrypted HTTP traffic.",
"example": true,
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
{
"properties": {
"created_at": {
"example": "2014-01-01T05:20:00.12345Z",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"updated_at": {
"example": "2014-01-01T05:20:00.12345Z",
"format": "date-time",
"readOnly": true,
"type": "string"
}
}
}
],
"type": "object"
}
}
}
],
"type": "object"
},
{
"properties": {
"errors": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": [
{
"code": 7003,
"message": "No route for the URI"
}
],
"minLength": 1
},
"messages": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": []
},
"result": {
"enum": [
null
],
"nullable": true,
"type": "object"
},
"success": {
"description": "Whether the API call was successful",
"enum": [
false
],
"example": false,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
}
]
}
}
},
"description": "Update Zero Trust account configuration response failure"
}
}[
{
"api_email": [],
"api_key": []
}
]