Updated on 2025-08-19 GMT+08:00

Enabling DNSSEC

Function

This API is used to enable DNSSEC for a public zone.

Calling Method

For details, see Calling APIs.

URI

POST /v2/zones/{zone_id}/enable-dnssec

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

zone_id

Yes

String

Public zone ID

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

The user token.

The token can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.

For details about how to obtain a user token, seeObtaining a User Token.

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Status code: 202

Table 3 Response body parameters

Parameter

Type

Description

zone_name

String

Domain name

key_tag

Integer

Key tag

flag

Integer

Flag

digest_algorithm

String

Digest algorithm

digest_type

Integer

Digest algorithm type

digest

String

Digest

signature

String

Signature algorithm

signature_type

Integer

Signature algorithm type

ksk_public_key

String

Public key

ds_record

String

DS record

created_at

String

The creation time.

Format: yyyy-MM-dd'T'HH:mm:ss.SSS

updated_at

String

The update time.

Format: yyyy-MM-dd'T'HH:mm:ss.SSS

status

String

Status.

Value options:

  • ENABLE: DNSSEC is enabled.

  • DISABLE: DNSSEC is disabled.

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

code

String

Definition

Error code

Range

N/A

message

String

Definition

Error description

Range

N/A

Status code: 500

Table 5 Response body parameters

Parameter

Type

Description

code

String

Definition

Error code

Range

N/A

message

String

Definition

Error description

Range

N/A

Example Requests

None

Example Responses

Status code: 202

Request accepted

{
  "zone_name" : "example.com.",
  "key_tag" : 46576,
  "flag" : 257,
  "digest" : "2cb6a21bc5ea1622a24d35b94d171dcc06523daf708f6eb08c3358608e84f51c",
  "digest_algorithm" : "SHA256",
  "digest_type" : 2,
  "signature" : "ECDSAP256SHA256",
  "signature_type" : 13,
  "ksk_public_key" : "M7/fjwRNXwWsBxjIMZ2KzxEQ+DnhZ8pbPTn8VCcPKdrDhvV750DkFdXhuXRMLFHrXI9xjIVUugtVKgmdPIEf8w==",
  "ds_record" : "example.com. 300 IN DS 46576 13 2 2cb6a21bc5ea1622a24d35b94d171dcc06523daf708f6eb08c3358608e84f51c",
  "created_at" : "2023-11-17T12:03:17.827",
  "updated_at" : "2023-11-17T12:03:17.827",
  "status" : "ENABLE"
}

Status Codes

Status Code

Description

202

Request accepted

400

Bad Request

500

Internal Server Error

Error Codes

See Error Codes.