Suche in diesem Bereich

Skip to end of metadata
Go to start of metadata


Table of Contents

Function

The DomainRenew task prolongates the registration period of a domain.

Description

Route: PUT /domain/{name}/_renew

The "messages" element is only returned if there was a cancelation order.

Request
{
	"payable":"2020-05-10T14:50:07.5816807Z",
 	"period":{
		"unit":"YEAR",
		"period":1
  	}
}
Response
{
    "stid": "20190701-app2-dev-13910",
    "status": {
        "code": "N0101003",
        "text": "Domain renew has been started successfully.",
        "type": "NOTIFY"
    },
    "object": {
        "type": "Domain",
        "value": "example.com"
    },
	"messages": [
		{
			"text": "The existing cancelation request was cancelled.",
			"code": "MSG01046",
			"status": "NOTICE"
		}
	],
    "data": [
        {
            "created": "2019-07-01T10:16:09.000+0200",
            "updated": "2019-07-01T10:16:08.000+0200",
            "owner": {
                "context": 4,
                "user": "exampleuser"
            },
            "updater": {
                "context": 4,
                "user": "exampleuser"
            },
            "status": "RUNNING",
            "execution": "2019-07-01T10:16:08.000+0200",
            "id": 4297543152
        }
    ]
}

Task Code: 0101003
Uses Domain Object

The <msg> element is only returned if there was a cancellation order.

Request
<request>
	<auth>
		<user>customer</user>
		<password>password</password>
		<context>4</context>
	</auth>
	<task>
		<code>0101003</code>
		<domain>
			<name>example.com</name>
			<payable>2010-05-16</payable>
			<period>2</period>
			<remove_cancelation>yes</remove_cancelation>
		</domain>
	</task>
</request>
Response
<response>
	<result>
		<msg>
			<code>MSG01046</code>
			<status>success</status>
			<text>The existing cancelation request was cancelled.</text>
			<type>notice</type>
		</msg>
		<status>
			<code>N0101003</code>
			<object>
				<type>domain</type>
				<value>example1695.com</value>
			</object>
			<text>Domain renew has been started successfully.</text>
			<type>notify</type>
		</status>
	</result>
</response>

Possible Error Messages

  • EF0103120 The domain has not yet been billed.
  • EF01084 Payable date does not match.
  • EF0072003 The registry does not support this operation.
  • EF010871 Renew of the current registration period is not possible at this time.
  • EF01016 Invalid registration period.
  • EF0103101 For this domain a cancelation request already exists.
  • EF0103103 For this domain no cancelation request exists.
  • EF01030 An identical task is already being processed.
  • EF06002 Object could not be found in the DomainSafe.