---
title: "Update Dynamic DNS domain description"
method: GET
path: "/DynamicDNS/set_description"
tags: ["DynamicDNS", "Dynamic DNS"]
---

# Update Dynamic DNS domain description

`GET /DynamicDNS/set_description`

This function sets the description on a user’s Dynamic DNS (DDNS) domain.

**Important:**

When you disable the [_DNS_ role](https://go.cpanel.net/serverroles), the system disables this function.

## Query parameters

- `description` string, required
- `id` string, required

## Response `200`

HTTP Request was successful.

- object
  - `apiversion` integer — The version of the API.
  - `func` string — The name of the method called.
  - `module` string — The name of the module called.
  - `result` object
    - `errors` string[], nullable — List of errors if the API failed.
    - `messages` string[], nullable — List of messages generated by the API.
    - `metadata` object
      - `transformed` 1 — Post-processing may have transformed the data.
    - `status` 0 | 1 — - 1 - Success - 0 - Failed: Check the errors field for more details.
    - `warnings` string[], nullable — List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.

---

[API](https://skmtc.net/cpanel/apis/cpanel-uapi.md) · [All operations](https://skmtc.net/cpanel/apis/cpanel-uapi/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cpanel/cpanel-uapi/versions/632e2f8e6d04/schema)