Technical Documentation

Authentication

To use the Epic Clone REST API, authenticate with your Atlassian account email and an app-specific API token.

Username: Use the email associated with your Atlassian account.
Password (API Token): Obtainable from the app's administration.
- Navigate to: Apps → Manage Apps → Epic Clone on the left sidebar → API token tab.
- Note: Tokens are visible only during creation. Copy and store securely.

Store created token - only displayed during creation

Endpoint URL

The endpoint URL is unique for each instance and must be retrieved from within the app.

Get it from Apps → Manage apps → Epic Clone on the left sidebar → REST API Endpoints tab.

Bildschirmfoto 2025-07-28 um 11.46.11.png — REST endpoints tab

Request Parameter

The request requires a single parameter: the work item key of the item you want to clone.

The parameter name is issueKey.

Body

The body is optional and can be omitted. Without it, the work item is cloned with a default configuration in the same project.

For advanced cloning configuration, include a body with the following parameters. Attributes not included in the body will not be considered for cloning.

Name	Description	Example
cloneToDifferentProject	Clone the item within the same project or to a different project. The value must be true or false.	“cloneToDifferentProject”: true
targetProjectKey	Project key of the target project, if different from the source project. This is mandatory if cloneToDifferentProject is true and must be a valid project key.	“targetProjectKey”: “TAR”
cloneChildItems	Set this parameter to false to prevent cloning of child items. If omitted or set to a value other than false, child items will be cloned.	“cloneChildItems”: false
parentLinks	Select one of the three options for parent links: ‘cloneLinks’: Clone the parent links. The cloned parent item will link to the same work items as the source item. ‘cloneLinkedWorkItems’: Clone the items linked to the parent. The cloned items will link to the cloned parent. ‘noLinks’: Don’t do anything with the parent links.	“parentLinks”: “cloneLinkedWorkItems”
childLinks	Select one of the three options for child links: ‘cloneLinks’: Clone the links of the child items. The cloned child items will link to the same work items as the source items. ‘recreateInternalLinks’: Internal links connect two child items under the same parent (read more on this page). The cloned child items will link to each other. ‘noLinks’: Don’t do anything with the child item links.	“childLinks”: “recreateInternalLinks”
cloneParentAttachments	Set to true to clone the attachments of the parent item. The default value is false.	“cloneParentAttachments”: true
cloneChildItemsAttachments	Set to true to clone the attachments of child items. The default is false.	“cloneChildItemsAttachments”: true
cloneChildItemsInSourceProject	Set to true to clone all child items within their current project. The default value is false.	“cloneChildItemsInSourceProject”: true
findInParentDescription	Replace the text in the parent item description with a suitable alternative (e.g., for placeholders).	“findInParentDescription”: “type_of_user”
replaceWithInParentDescription	Replacement text for the find text in the parent item description. If no text is provided, the find text will be removed.	“replaceWithInParentDescription”: “admin”
findInChildrenSummaries	Text to replace with something else in the summary of child items.	“findInChildrenSummaries”: “<version>”
replaceWithInChildrenSummaries	Replacement text for the summary of child items above. If no text is provided, the find text will be removed.	“replaceWithInChildrenSummaries”: “2.0”
childSummariesPrefix	Prefix to add to child item titles	“childSummariesPrefix”: “PRE - “
childSummariesSuffix	Suffix to add to child item titles	“childSummariesSuffix”: “ - SUFFIX”

Example Body:

JSON

{
    "cloneToDifferentProject": true,
    "targetProjectKey": "<target_project_key>",
    "cloneChildItems": true,
    "parentLinks": "cloneLinks",
    "childLinks": "recreateInternalLinks",
    "cloneParentAttachments": true,
    "cloneChildItemsAttachments": true,
    "cloneChildItemsInSourceProject": false,
    "findInParentDescription": "<find_string_in_parent_description>",
    "replaceWithInParentDescription": "<replace_string_in_parent_description>",
    "findInChildrenSummaries": "<find_string_in_children_summaries>",
    "replaceWithInChildrenSummaries": "<replace_string_in_children_summaries>",
    "childSummariesPrefix": "<prefix_for_child_titles>",
    "childSummariesSuffix": "<suffix_for_child_titles>"
}

Responses

When you call the API, it returns one of the following status codes:

Status Code	Text	Remarks
200	`Cloning started`	The cloning process has been started. Items will be seamlessly copied in the background.
401	`Error: Unauthorized - something is wrong with the provided credentials. Please authenticate with Atlassian account email address and Epic Clone api token.`	Please verify the provided credentials. Authenticate using your Atlassian account email and the app-specific API token.
401	`Error: No valid license found. Please contact your Jira system administrator to check the license for the Epic Clone app.`	The license for the app isn’t valid. Please contact an organisation admin to check the license status of the app.
400	`Error: The work item key is missing in the request. Please provide the key of the work item you want to clone.`
405	`Error: Method not allowed. Please use POST method to clone the work item.`	Only the POST method is allowed for the Epic Clone API.
400	`Error: Invalid JSON body. Please provide a valid JSON body.`
404	`Error: We could not find a work item with the provided key.`
401	`Error: You do not have access to a work item with the provided key.`
403	`Error: Access denied - you do not have permission to use the Epic Clone app.`	Access to the app can either be restricted by project or user group. If you aren’t in a group with access or try to clone in a project where it isn’t permitted, this error is returned.
403	`Error: Access denied - you do not have permission to create work items in the target project.`	You lack the create work item permission in the target project.
400	`Error: Invalid target project. Please provide a valid project key in the body if the work item shall be cloned to a different project.`
500	`Error: Cloning of work item failed. Please try again.`	Something went wrong within the app. Please try again and contact support if it continues to fail.