Patch DNS Record

PATCH

https://api.cloudflare.com/client/v4/zones/{zone_identifier}/dns_records/{identifier}

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

Request

Path Params

identifier

string

required

zone_identifier

string

required

Body Params application/json

comment

string

optional

Comments or notes about the DNS record. This field has no effect on DNS responses.

Example:

Domain verification record

content

string

optional

DNS record content.

Example:

127.0.0.1

name

string

optional

DNS record name (or @ for the zone apex).

<= 255 characters

Example:

example.com

proxied

boolean

optional

Whether the record is receiving the performance and security benefits of Cloudflare.

Example:

false

tags

array[string]

optional

Custom tags for the DNS record. This field has no effect on DNS responses.

ttl

optional

Time to live, in seconds, of the DNS record. Must be between 60 and 86400, or 1 for 'automatic'.

Any of

number

>= 60<= 86400

Example:

3600

Example

{
    "comment": "Domain verification record",
    "content": "127.0.0.1",
    "name": "example.com",
    "proxied": false,
    "tags": [
        "owner:dns-team"
    ],
    "ttl": 3600
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH 'https://api.cloudflare.com/client/v4/zones//dns_records/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "comment": "Domain verification record",
    "content": "127.0.0.1",
    "name": "example.com",
    "proxied": false,
    "tags": [
        "owner:dns-team"
    ],
    "ttl": 3600
}'

Responses

🟢200Patch DNS Record 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
}

🟢200Patch DNS Record response failure

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

DNS Record Details

Update DNS Record