Encrypt email adresses on your web page from bots, while keeping them visible to humans. (https://support.cloudflare.com/hc/en-us/articles/200170016).
/zones/{zone_identifier}/settings/email_obfuscation
patch
Zone Settings
zone-settings-change-email-obfuscation-setting
{
"business": true,
"enterprise": true,
"free": true,
"pro": true
} {
"enum": [
"#zone_settings:edit"
]
} [
{
"in": "path",
"name": "zone_identifier",
"required": true,
"schema": {
"description": "Identifier",
"example": "023e105f4ecef8ad9ca31a8372d0c353",
"maxLength": 32,
"type": "string"
}
}
] {
"content": {
"application/json": {
"schema": {
"properties": {
"value": {
"default": "on",
"description": "Value of the zone setting.",
"enum": [
"on",
"off"
],
"type": "string"
}
},
"required": [
"value"
]
}
}
},
"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"
},
"success": {
"description": "Whether the API call was successful",
"example": true,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages"
],
"type": "object"
},
{
"properties": {
"result": {
"type": "object"
}
}
}
]
},
{
"properties": {
"result": {
"allOf": [
{
"properties": {
"editable": {
"default": true,
"description": "Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).",
"enum": [
true,
false
],
"readOnly": true,
"type": "boolean"
},
"id": {
"description": "Identifier of the zone setting.",
"example": "development_mode",
"type": "string"
},
"modified_on": {
"description": "last time this setting was modified.",
"example": "2014-01-01T05:20:00.12345Z",
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"value": {
"description": "Current value of the zone setting.",
"example": "on"
}
},
"required": [
"id",
"value"
]
},
{
"properties": {
"id": {
"description": "ID of the zone setting.",
"enum": [
"email_obfuscation"
],
"example": "email_obfuscation"
},
"value": {
"default": "on",
"description": "Value of the zone setting.",
"enum": [
"on",
"off"
],
"type": "string"
}
}
}
],
"description": "Encrypt email adresses on your web page from bots, while keeping them visible to humans. (https://support.cloudflare.com/hc/en-us/articles/200170016).",
"title": "Email Obfuscation"
}
}
}
]
}
}
},
"description": "Change Email Obfuscation setting response"
},
"4XX": {
"content": {
"application/json": {
"schema": {
"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": {
"nullable": true,
"type": "object"
},
"success": {
"description": "Whether the API call was successful",
"example": false,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
}
}
},
"description": "Change Email Obfuscation setting response failure"
}
} [
{
"api_token": []
},
{
"api_email": [],
"api_key": []
}
]