POST /wiki/rest/api/content/{id}/pagehierarchy/copy

Copy page hierarchy allows the copying of an entire hierarchy of pages and their associated properties, permissions and attachments. The id path parameter refers to the content id of the page to copy, and the new parent of this copied page is defined using the destinationPageId in the request body. The titleOptions object defines the rules of renaming page titles during the copy; for example, search and replace can be used in conjunction to rewrite the copied page titles.

Response example:


 {
      "id" : "1180606",
      "links" : {
           "status" : "/rest/api/longtask/1180606"
      }
 }

Use the /longtask/ REST API to get the copy task status.

Servers

https://your-domain.atlassian.net

Path parameters

Name	Type	Required	Description
`id`	String	Yes

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`titleOptions`	Object	No	Required for copying page in the same space.
`titleOptions.prefix`	String	No
`titleOptions.replace`	String	No
`titleOptions.search`	String	No
`copyLabels`	Boolean	No	If set to `true`, labels are copied to the destination page. Default value: false
`copyDescendants`	Boolean	No	If set to `true`, descendants are copied to the destination page. Default value: true
`copyProperties`	Boolean	No	If set to `true`, content properties are copied to the destination page. Default value: false
`destinationPageId`	String	Yes
`copyAttachments`	Boolean	No	If set to `true`, attachments are copied to the destination page. Default value: false
`copyCustomContents`	Boolean	No	If set to `true`, custom contents are copied to the destination page. Default value: false
`copyPermissions`	Boolean	No	If set to `true`, page permissions are copied to the destination page. Default value: false

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.