- Home
- API reference
- API documentation (JSON/XML)
- Tasks
- Zone tasks
Zone comment update
Function
The ZoneCommentUpdate task updates the zone comment.
Description
Route: PUT /zone/{name}/{systemNameServer}/_comment
{
"comment": "new example comment"
}{
"stid": "20190701-app2-dev-23170",
"status": {
"code": "S0202004",
"text": "Zone comment was updated successfully.",
"type": "SUCCESS"
},
"object": {
"type": "Zone",
"value": "examplezone.com"
}
}
Task Code: 0202004
Uses Zone object
<request>
<auth>
<user>customer</user>
<password>password</password>
<context>4</context>
</auth>
<task>
<code>0202004</code>
<default>
<comment>comment</comment>
</default>
<zone>
<name>example.com</name>
<!-- the following is needed if the zone is present on different name servers to specify which zone is to be changed -->
<!--
<system_ns>ns1.nameserver.com</system_ns>
-->
<comment>Kommentar</comment>
</zone>
</task>
</request><response >
<result>
<msg>
<code>S0202004</code>
<type>success</type>
<object>
<type>zone</type>
<value>example.com</value>
</object>
</msg>
<status>
<code>S0202004</code>
<type>success</type>
</status>
</result>
</response>