×

You're using an outdated browser

For a better experience, keep your browser up to date. Check here for the latest version.

Manual

Rename the project key

Matthias Gaiser

Matthias Gaiser Last update: Dec 14, 2017

Currently, it is not possible to rename Backbone project keys via the UI (although we're planning on improving this in a future release). However, you can update them via REST using the following method.

Warning

Make sure you follow these instructions exactly as they are laid out here, as doing them incorrectly can cause major problems to your Backbone integrations.

Please be aware that you make these changes at your own risk.

Instructions

  1. Firstly, troubleshoot your integration and make sure there are no errors. 
  2. Then, stop all the integrations related to the project you want to rename.
  3. Get your connectorKeys by calling the following URL in your browser: JIRA_BASE_URL/plugins/servlet/backbone-issue-sync/api/1/integrations?projectKey=CURRENT_PROJECT_KEY 
    This will bring up a list of integrations, including their connectorKeys. It will look a little like this:

    [
      {
        "createdUser": "admin",
        "lastModifiedUser": "admin",
        "createdDate": "2016-11-14T15:19:21+0100",
        "lastModifiedDate": "2016-11-14T15:19:21+0100",
        "integrationKey": "INT-17",
        "summary": "Project A <> Agile Project",
        "description": "This integration synchronizes issues between project Project A (PA) and project Agile Project (AP)",
        "status": {},
        "firstConnector": {
          "createdUser": "admin",
          "lastModifiedUser": "backbone",
          "createdDate": "2016-11-14T15:20:49+0100",
          "lastModifiedDate": "2016-12-19T09:32:14+0100",
          "connectorKey": "PA-31",
          "projectKey": "PA",
          "connection": {}
        },
        "secondConnector": {
          "createdUser": "admin",
          "lastModifiedUser": "backbone",
          "createdDate": "2016-11-14T15:20:49+0100",
          "lastModifiedDate": "2016-12-19T09:32:15+0100",
          "connectorKey": "AP-32",
          "projectKey": "AP",
          "connection": {}
        }
      }
    ]

    Info

    If there are multiple integrations related to the same project, this list will include multiple connectorKey values.

     You need to find the corresponding connectorKey (or connectorKeys) from the first either from the firstConnector or secondConnector, depending on which project key you want to change. (In the example above, if you wanted to change projectKey PA, you would need connectorKey PA-31).

  4. Rename your JIRA project key within JIRA. 
  5. Now, you need to rename the JIRA project key within Backbone.

    Rename the project key inside Backbone by calling the URL: JIRA_BASE_URL/plugins/servlet/backbone-issue-sync/api/1/connectors/CONNECTOR_KEY/projectKey?newProjectKey=NEW_PROJECT_KEY

    The response will confirm that the rename was successful by answering with your new project key:

    { "projectKey": "PAA" }

    Note

    If your project is bound to more than one integration, then you must rename your project key (within Backbone) for EVERY connectorKey listed in step 3.

  6. Start your integration(s)

Troubleshooting

If you had problems changing the project key, these endpoints might help you to resolve this:

  • To check if the project key needs to be changed: GET JIRA_BASE_URL/plugins/servlet/backbone-issue-sync/api/1/connectors/CONNECTOR_KEY/projectKey

  • To get a list of all syncinfos (this list may be long): GET JIRA_BASE_URL/plugins/servlet/backbone-issue-sync/api/1/connectors/CONNECTOR_KEY/syncInformation

  • To delete wrong syncinfos: DELETE JIRA_BASE_URL/plugins/servlet/backbone-issue-sync/api/1/connectors/CONNECTOR_KEY/syncInformation?syncInfoId=42 
    (info) When executing this command, make sure to delete on both sides, and also make sure to delete the unneeded/duplicated issue bound to the wrong syncInfo.

    Info

    For the third endpoint (delete wrong syncinfos), you will need a REST tool like Postman, as browsers do not support DELETE commands.

2x3.6
We use cookies to create a secure and effective browsing experience for our website visitors and to understand how you use our site (i.e. Google Analytics). For more information: click here.
Ok