API Documents
Documentation API Documents Set the Record Status

Set the Record Status

1. API Description

This API (Record.Remark) is used to set the record status.
Domain name for API request:https://api.dnspod.com/Record.Status
HTTP request method: POST

2. Request Parameters

The table below lists only the API request parameters. Common request parameters are required when the API is called. For more information, please see Common Request Parameters.

Parameter Required Description
domain_id yes The domain id. Mandatory parameter.
record_id yes The record id. Mandatory parameter.。
status {enable disable} yes

3. Response Codes

Only the response codes related to this API are listed below. For other response codes, please see Common Return Codes.

Response Code Description
-15 Domain got prohibited.
-7 A domain of a company account need a upgrade first.
-8 You need a upgrade for the domain you are acting for.
6 Invalid domain id.
7 You don’t have the permission.
8 Invalid record id.
21 Domain got locked.

4. Sample

curl -X POST https://api.dnspod.com/Record.Status -d 'login_token=730060,e1a8a$f14dc5dcbafd83680b3d2a553c4d553d&format=json&domain_id=2317346&record_id=16894439&status=disable'

The following is a sample response:

  • JSON:
    "status": {
        "code": "1",
        "message": "Action completed successful",
        "created_at": "2012-11-24 20:07:29"
    "record": {
        "id": 16909160,
        "name": "@",
        "status": "disable"
Last updated on 2022-03-11 03:41

DNS health check tool powered by DNSPod


Official WeChat group

Join WeChat group to chat and feedback

Scan using WeChat