Update domain

PUT

https://api.cloudflare.com/client/v4/accounts/{account_identifier}/registrar/domains/{domain_name}

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

Update individual domain.

Request

Path Params

domain_name

string

required

account_identifier

string

required

Body Params application/json

auto_renew

boolean

auto_renew

optional

Auto-renew controls whether subscription is automatically renewed upon domain expiration.

Example:

true

locked

boolean

locked

optional

Shows whether a registrar lock is in place for a domain.

Example:

false

name_servers

array[string]

name_servers

optional

List of name servers.

Example:

["preston.ns.cloudflare.com","oli.ns.cloudflare.com"]

privacy

boolean

privacy

optional

Privacy option controls redacting WHOIS information.

Example:

true

Example

{
    "auto_renew": true,
    "locked": false,
    "name_servers": [
        "preston.ns.cloudflare.com",
        "oli.ns.cloudflare.com"
    ],
    "privacy": true
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT 'https://api.cloudflare.com/client/v4/accounts//registrar/domains/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "auto_renew": true,
    "locked": false,
    "name_servers": [
        "preston.ns.cloudflare.com",
        "oli.ns.cloudflare.com"
    ],
    "privacy": true
}'

Responses

🟢200Update domain response

application/json

Body

allOf {2}

optional

object (api-response-single)

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

object

optional

result

object

optional

Example

{
    "errors": [],
    "messages": [],
    "result": {},
    "success": true
}

🟢200Update domain response failure

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

Get domain

SSL Verification Details