Restore content

1 min

POST

/_cms/v1/content/{key}:undelete

Restore the deleted content item with the provided key. If a content item with the provided key is not deleted an error is returned.

Path Parameters

keystringrequired
Description
The key of the content item to undelete.

Header Parameters

Preferstring[]
Example
```
[
  "return=representation"
]
```
Description
Indicates client preference for the response content as per IETF RFC7240. Currently only supports 'return=representation' which can be used to indicate a preference to receive a representation of the resource that has been altered in the response.

Responses

200OK

ContentNode
Description
Metadata about a content item in the content hierarchy, including ownership, localization, and audit information. This represents the structural information without the actual property values.
- keystring
  Description
  The unique identifier (key) of the resource.
- containerstring
  Description
  The content item that contains this item in the hierarchy.
- ownerstring
  Description
  The content item that owns this item. Content that is owned by another content is also known as an asset. Cannot be combined with container.
- contentTypestring
  Description
  The content type that defines the structure and available properties for this item.
- primaryLocalestring
  Description
  The locale for which this content was originally created. This locale will include properties that are shared across all locales.
- localesstring[]
  Description
  The complete list of locales for which this content has been created for.
- lastModifiedstring<date-time>
  Description
  The date and time when this content was last modified.
  Format
  date-time
- lastModifiedBystring
  Description
  The username of the user that last modified this content.
- createdstring<date-time>
  Description
  The date and time when this content was first created.
  Format
  date-time
- createdBystring
  Description
  The username of the user who created this content.
- deletedstring<date-time>
  Description
  If populated, the date and time when this content was deleted.
  Format
  date-time
- deletedBystring
  Description
  The username of the user who deleted this content. Only populated if the content is deleted.

Response Headers

Content-Locationstring
Description
Indicates the standard location for the data returned in this response.
Preference-Applied

204No Content

400Bad Request

401Unauthorized

403Forbidden

404Not Found

500Internal Server Error

curl

curl --request POST \
     --url /_cms/v1/content/{key}:undelete \
     --header 'accept: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("/_cms/v1/content/{key}:undelete", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("/_cms/v1/content/{key}:undelete")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

response = http.request(request)
puts response.read_body

python

import requests
import json

url = "/_cms/v1/content/{key}:undelete"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

200

// OK
{
  "key": "",
  "container": "",
  "owner": "",
  "contentType": "",
  "primaryLocale": "",
  "locales": [
    ""
  ],
  "lastModified": "",
  "lastModifiedBy": "",
  "created": "",
  "createdBy": "",
  "deleted": "",
  "deletedBy": ""
}

204

// No Content

400

// Bad Request

401

// Unauthorized

403

// Forbidden

404

// Not Found

500

// Internal Server Error