Example Use Cases
- Bidirectional synchronization
- Unidirectional synchronization
- Synchronize Jira Server with Jira Cloud
- Synchronize one project with multiple others
- Synchronize a private with a public project
- Synchronize projects behind firewalls
- Synchronize without installing
- Synchronize with changing Jiras
- Migrate Jira projects
- JIRA Service Desk
- Configuring the synchronization user
- Start and stop synchronizations
- Create a synchronization
- Issue Type Mappings
- Field Mappings
- Fields (Default values)
- Workflow Mappings
- Advanced Settings
- Configure email error notifications
- Distributed configuration
- Analyze and fix errors
- Trigger a resync
- Increase the JIRA logging level
Fix common problems
General problem situations
- 411 - Length required
- All fields have English names although Jira is in a different language
- Authentication with an external Jira fails
- Exception: ServiceLocatorImpl has been shut down
- Sync info panel displays wrong synchronization name, and no link to partner project
- Server is not reachable - how to fix it
- Changes are not being synchronized
- Can't change the synchronization user
- Recently created issue types, fields, etc. are not available when editing configuration
Issue specific problem situations
- Admin or project admin permissions are required
- Bad gateway
- Cannot add or remove watcher
- Cannot create new issue without mapped issue type
- Cannot find transition
- Cannot find transition id
- Cannot perform transition
- Component(s) not valid
- Could not resolve value of Project Key
- Fallback user does not exist
- Field not on the Screen
- Incoming Issue Error
- Incompatible message format
- Invalid JQL Filter
- Invalid license
- Invalid regex syntax
- Issue does not exist
- Issues must be assigned
- JIRA is offline
- Missing attachment permissions
- Missing Issue
- Missing issue type mapping
- Missing message
- Missing parent Issue error
- Missing required fields
- No create version permissions
- No project administration permissions
- Option not valid
- Outgoing Issue error
- Outgoing Send Error
- Priority not valid
- Resolution cannot be chosen
- Security level name is not valid
- Sprint does not exist
- Template error
- The requested board cannot be viewed
- User does not exist
- User not assignable
- Version(s) not valid
- Workflow operation not valid
- General problem situations
- Field mapping reference
- REST API
- Synchronization behavior
- Data Encryption
- How does Backbone affect server performance?
- Do you plan to synchronize with other systems?
- Does Backbone communicate via an encrypted channel?
- Can I synchronize an instance from behind an enterprise firewall?
- Can I synchronize an instance without installing Backbone?
- Can I have the same issue keys in both projects?
- Knowledge Base
Before starting to request URLs, you need to be aware of the different authentication methods. You can authenticate yourself for the REST APIs in three ways:
- Log in to JIRA manually You will then be authenticated for the REST APIs for that same browser session.
- Use HTTP basic authentication (Authorization HTTP header) containing 'Basic username:password'. username:password must be base64 encoded.
If you encounter the problem "XSRF check failed" while accessing the REST API, you should add the header "X-Atlassian-Token:nocheck" to your request.
Curl is a command line tool for transferring data with URL syntax. It is preinstalled on MacOS X and available for all Linux distributions using the package manager. There are also builds for Windows available.
You can use curl using the command line as follows. On MacOS X and Linux please make sure to place the URL in double quotes as otherwise the "&" character inside the URL will break the command.
curl --remote-header-name --remote-name -u admin:admin "http://www.example.com/jira/plugins/servlet/backbone-issue-sync/api/1/health"
In some cases the colons are replaced with '&3A'. Please check the permalink carefully and edit it if necessary.
If you want to call curl from a script, the "-f" parameter may be interesting as it will make curl return some non-zero return value in case of download errors. See the curl documentation for more info.
wget is another command line tool for transferring data with URL syntax. It is available for all major platforms.
You can use wget using the command line as follows. On MacOS X and Linux please make sure to place the URL in double quotes as otherwise the "&" character inside the URL will break the command.
wget --content-disposition --http-user=admin --http-password=admin "http://www.example.com/jira/plugins/servlet/backbone-issue-sync/api/1/health"
There are plenty of other tools you can use (e.g. Postman). If you use them, you can compose the URL as described below.
All urls of the Backbone REST API must be prepended by the following base URL:
All endpoints are using application/json as the content type for request and responses if not stated different.