Home
/
API reference
/
API documentation (JSON/XML)
/
Tasks
/
Domain restore tasks

Domain restore list

API reference (XML/JSON) · Updated 2023-09-18

Function

The DomainRestoreList task displays a list of deleted domains that can be restored.

Note that only domains with the value RESTORE_ARGP (= Auto Renew Grace Period) can be restored for free at "Action". When restoring domains with the value RESTORE costs arise, which you can find in the current price list.

Description

Route: POST /domain/restore/_search

Query parameters

The data of the following keywords can be queried with the query parameter ?keys[]=:

adminc
authinfo
nserver
ownerc
payable
registry_status
techc
zonec

{
	"filters": [
		{
			"key": "name",
			"value": "h*",
			"operator": "LIKE",
			"link": "AND",
			"filters": [
			]
		}
	],
	"view": {
		"limit": 10,
		"offset": 0,
		"children": true,
		"from": "2018-06-01T14:31:33.6306444Z",
		"to": "2019-05-17T16:05:33.6306444Z"
	},
	"orders": [
		{
			"key": "name",
			"ins": [
				"ins"
			],
			"type": "DESC"
		}
	]
}

{
    "stid": "20190628-app-11949",
    "status": {
        "code": "S0105005",
        "text": "The restorable domains could be inquired successfully.",
        "type": "SUCCESS"
    },
    "object": {
        "type": "DomainRestore",
        "summary": 3
    },
    "data": [
        {
            "created": "2018-07-04T12:28:25.000+0200",
            "owner": {
                "context": 4,
                "user": "customer"
            },
            "name": "example.com",
            "deleted": "2019-07-05T01:59:59.000+0200",  
            "restorePhaseEnd": "2019-07-04T12:28:25.000+0200",
            "expire": "2019-07-04T12:28:25.000+0200",
            "action": "RESTORE"
        },
        {
            "created": "2018-07-04T11:35:22.000+0200",
            "owner": {
                "context": 4,
                "user": "customer"
            },
            "name": "example.org",
            "restorePhaseEnd": "2019-07-04T11:35:22.000+0200",
            "expire": "2019-07-04T11:35:22.000+0200",
            "action": "RESTORE_NE"
        },
        {
            "created": "2018-07-04T09:32:20.000+0200",
            "owner": {
                "context": 4,
                "user": "customer"
            },
            "name": "example2.com",
            "deleted": "2019-07-05T01:59:59.000+0200", 
            "restorePhaseEnd": "2019-07-05T01:59:59.000+0200",
            "expire": "2019-07-05T01:59:59.000+0200",
            "action": "RESTORE_NE"
        }
    ]
}

Task code: 0105005
Uses Restore object

Keywords

The following keywords are returned by default:

action
name
owner
created
expire

The data of the following keywords can be queried with the <key> keyword:

adminc
authinfo
nserver
ownerc
payable
registry_status
techc
zonec

<request>
	<auth>
		<user>customer</user>
		<context>4</context>
		<password>password</password>
	</auth>
	<task>

		<code>0105005</code>
		<where>
			<key>name</key>
			<operator>LIKE</operator>
			<value>*</value>
		</where>
		<view>
			<offset>0</offset>
			<limit>3</limit>
			<children>1</children>
		</view>
		<key>action</key>
		<key>adminc</key>
		<key>authinfo</key>
		<key>created</key>
		<key>expire</key>
		<key>nserver</key>
		<key>owner</key>
		<key>ownerc</key>
		<key>payable</key>
		<key>registry_status</key>
		<key>techc</key>
		<key>zonec</key>
	</task>

<response>
	<result>
		<data>
			<summary>2</summary>
			<restore>
				<end_of_phase>2021-12-24 07:35:06</end_of_phase>
				<name>example.com</name>
				<expire>2022-04-27 15:21:51</expire>
				<payable>2022-04-27 15:21:51</payable>
				<ownerc>23235000</ownerc>
				<adminc>23235000</adminc>
				<techc>23235000</techc>
				<zonec>23235000</zonec>
				<registry_status>LOCK</registry_status>
				<nserver>
					<name>ns1.example.com</name>
				</nserver>
				<nserver>
					<name>ns2.example.com</name>
				</nserver>
				<action>RESTORE</action>
				<extension/>
				<owner>
					<user>customer</user>
					<context>4</context>
				</owner>
				<created>2021-04-27 15:21:51</created>
			</restore>
			<restore>
				<end_of_phase>2021-12-24 07:44:28</end_of_phase>
				<name>example.com</name>
				<expire>2022-04-27 15:20:44</expire>
				<payable>2022-04-27 15:20:44</payable>
				<ownerc>23235000</ownerc>
				<adminc>23235000</adminc>
				<techc>23235000</techc>
				<zonec>23235000</zonec>
				<registry_status>LOCK</registry_status>
				<nserver>
					<name>ns1.example.com</name>
				</nserver>
				<nserver>
					<name>nexample.com</name>
				</nserver>
				<action>RESTORE</action>
				<extension/>
				<owner>
					<user>customer</user>
					<context>4</context>
				</owner>
				<created>2021-04-27 15:20:44</created>
			</restore>
		</data>
		<status>
			<code>S0105005</code>
			<text>The restorable domains could be inquired successfully.</text>
			<type>success</type>
		</status>
	</result>
	<stid>20211125-app2-dev-88260</stid>
</response>