- Home
- API reference
- API documentation (JSON/XML)
- Tasks
- Transfer tasks
Domain status update
Function
The DomainStatusUpdate task sets the status of a domain. So you can protect the domain from transfers. This is only possible for gTLDs. Note that some registries do not support all statuses. The possible statuses are specified in the RegistryStatusConstants enum.
Description
Route: PUT /domain/{name}/_statusUpdate
{
"registryStatus": "LOCK"
}{
"status" : {
"code" : "N0102002",
"text" : "Domain status update has been started successfully.",
"type" : "NOTIFY"
},
"object" : {
"type" : "Domain",
"value" : "example.com"
},
"data" : [ {
"owner" : {
"context" : 4,
"user" : "customer"
},
"updater" : {
"context" : 4,
"user" : "customer"
},
"execution" : "2020-06-29T11:39:25.823+0200",
"id" : 2697604
} ]
}Task code: 0102002
Uses Domain object
<request>
<auth>
<user>customer</user>
<password>password</password>
<context>4</context>
</auth>
<task>
<code>0102002</code>
<domain>
<name>example.com</name>
<registry_status>ACTIVE</registry_status>
</domain>
<reply_to>customer@example.com</reply_to>
<ctid>aöslkdjf</ctid>
</task>
</request><response>
<result>
<data>
<domain_job>
<job>
<id>673402</id>
</job>
</domain_job>
</data>
<status>
<code>N0102002</code>
<type>notify</type>
<object>
<type>domain</type>
<value>example.com</value>
</object>
</status>
</result>
</response>