This API is deprecated and has been replaced by /document/delete.
This API will be removed on 2018-05-01.
Removes a given URL from the sitesearch index (used for both sitesearch implementations as well as Cxense Content implementations).
Please note that this functionality should only be used to remove content that has also been removed from your site. If you use this API call to remove an URL that is still available on your site, it may be re-crawled and reindexed again. If you would like to simply prevent existing content from being offered as recommendations, you should follow the steps outlined in this other article instead.
The user must be authenticated and have write permissions to the associated site.
Request
The request object has the following fields:
|
Name |
Type |
Required |
Description |
|---|---|---|---|
|
|
String |
Yes |
The URL to be removed. |
Note that the argument is a URL. The authorization check currently looks at the site identifier found when the domain's top level page (i.e., the URL without its path or any parameters) was last crawled to establish if the user has the required permissions. Hence, to be able to remove the URL http://www.example.com/foo/bar, the cXense script has to be present on http://www.example.com.
Response
The response object has the following fields:
|
Name |
Type |
Description |
|---|---|---|
|
|
String |
The deleted url. |
Examples
$ cx.py /profile/content/delete '{"url":"https://www.example.com"}'
{
"url":"https://www.example.com"
}