Enable or Disable a Hostname for Client Authentication

PUT

https://api.cloudflare.com/client/v4/zones/{zone_identifier}/origin_tls_client_auth/hostnames

Last modified:2022-12-16 13:48:34

Associate a hostname to a certificate and enable, disable or invalidate the association. If disabled, client certificate will not be sent to the hostname even if activated at the zone level. 100 maximum associations on a single certificate are allowed. Note: Use a null value for parameter enabled to invalidate the association.

Request

Path Params

zone_identifier

string

required

Body Params application/json

config

array[object (hostname_certid_input) {2}]

required

enabled

boolean | null

optional

Indicates whether hostname-level authenticated origin pulls is enabled. A null value voids the association.

Example:

true

hostname

string

optional

The hostname on the origin for which the client certificate uploaded will be used.

<= 255 characters

Example:

app.example.com

Example

{
    "config": [
        {
            "enabled": true,
            "hostname": "app.example.com"
        }
    ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT 'https://api.cloudflare.com/client/v4/zones//origin_tls_client_auth/hostnames' \
--header 'Content-Type: application/json' \
--data-raw '{
    "config": [
        {
            "enabled": true,
            "hostname": "app.example.com"
        }
    ]
}'

Responses

🟢200Enable or Disable a Hostname for Client Authentication response

application/json

Body

allOf {2}

optional

object (api-response-collection)

optional

errors

array [object {2}]

messages

required

Example:

[]

messages

array [object {2}]

messages

required

Example:

[]

result

required

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

result_info

object

result_info

optional

object

optional

result

array[object (hostname-authenticated-origin-pull) {7}]

optional

Example

🟢200Enable or Disable a Hostname for Client Authentication response failure

Modified at 2022-12-16 13:48:34

Get Passive DNS by IP

List Certificates