Updates an mTLS certificate's hostname settings.
/accounts/{identifier}/access/certificates/settings
put
Access mTLS authentication
access-mtls-authentication-update-an-mtls-certificate-settings
nullnull[
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"description": "Identifier",
"example": "023e105f4ecef8ad9ca31a8372d0c353",
"maxLength": 32,
"readOnly": true,
"type": "string"
}
}
]{
"content": {
"application/json": {
"schema": {
"properties": {
"settings": {
"items": {
"additionalProperties": false,
"properties": {
"china_network": {
"description": "Request client certificates for this hostname in China. Can only be set to true if this zone is china network enabled.",
"example": false,
"type": "boolean"
},
"client_certificate_forwarding": {
"description": "Client Certificate Forwarding is a feature that takes the client cert provided by the eyeball to the edge, and forwards it to the origin as a HTTP header to allow logging on the origin.",
"example": true,
"type": "boolean"
},
"hostname": {
"description": "The hostname that these settings apply to.",
"example": "admin.example.com",
"type": "string"
}
},
"required": [
"hostname",
"china_network",
"client_certificate_forwarding"
],
"title": "Hostname Settings",
"type": "object"
},
"type": "array"
}
},
"required": [
"settings"
],
"type": "object"
}
}
},
"required": true
}{
"202": {
"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": {
"items": {},
"nullable": true,
"type": "array"
},
"result_info": {
"properties": {
"count": {
"description": "Total number of results for the requested service",
"example": 1,
"type": "number"
},
"page": {
"description": "Current page within paginated list of results",
"example": 1,
"type": "number"
},
"per_page": {
"description": "Number of results per page of results",
"example": 20,
"type": "number"
},
"total_count": {
"description": "Total results available without any search parameters",
"example": 2000,
"type": "number"
}
},
"type": "object"
}
}
}
],
"type": "object"
},
{
"properties": {
"result": {
"items": {
"additionalProperties": false,
"properties": {
"china_network": {
"description": "Request client certificates for this hostname in China. Can only be set to true if this zone is china network enabled.",
"example": false,
"type": "boolean"
},
"client_certificate_forwarding": {
"description": "Client Certificate Forwarding is a feature that takes the client cert provided by the eyeball to the edge, and forwards it to the origin as a HTTP header to allow logging on the origin.",
"example": true,
"type": "boolean"
},
"hostname": {
"description": "The hostname that these settings apply to.",
"example": "admin.example.com",
"type": "string"
}
},
"required": [
"hostname",
"china_network",
"client_certificate_forwarding"
],
"title": "Hostname Settings",
"type": "object"
},
"type": "array"
}
}
}
]
}
}
},
"description": "Update an mTLS certificates hostname settings 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": {
"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 an mTLS certificates hostname settings failure"
}
}[
{
"api_email": [],
"api_key": []
}
]