Skip to content

Package Install

Kevin Obee edited this page Oct 11, 2013 · 1 revision

This command can be used to install a Sitecore package by specifying the path to the package on the server.

Details

Issue a POST request to /services/package/install and pass it a path parameter in the x-www-form-urlencoded form-data specifying the location of the update package.

Example:

POST /services/package/install HTTP/1.1
Host: shiptester
Cache-Control: no-cache

----WebKitFormBoundaryE19zNvXGzXaLvS5C
Content-Disposition: form-data; name="path"

d:\package.update
----WebKitFormBoundaryE19zNvXGzXaLvS5C

When the package is installed correctly a 201 Created HTTP Status code will be returned.

Content-Length 108
Content-Type application/json
Date Sun, 14 Jul 2013 07:44:50 GMT
Location: http://shiptest/services/package/latestversion

The body of a successfull request will contain details of the package contents in JSON format. For example:

 {"Entries":[{"ID":"110d559f-dea5-42ea-9c1c-8a5df7e70ef9","Path":"addeditems/master/sitecore/content/home"}]}

Notes:

The request also takes an optional DisableIndexing parameter in the x-www-form-urlencoded form-data which defaults to false. When the parameter is set to true updating of search indexes during the package installation will be suspended. Disabling the search index updates will increase the speed at which packages are installed into the CMS. You can read more about this approach on Alex Shyba's blog

Clone this wiki locally