How to get the list of applications linked with Bamboo using CLI

This article explains how to get the list of applications linked with Bamboo using the Command Line Interface (CLI) app.

Instructions

Use getApplicationLinkList action to get the list of the linked applications. Linking Bamboo to other applications allows you to include information from other applications in your Bamboo builds.

  • Execute the following action to get the list of all applications linked to your Bamboo instance:

    --action getApplicationLinkList --outputFormat 1

    The output of the CLI action is similar to the following:

    3 application links
    "Name","Type","Id","Primary","System","URL","Application URL"
    "Bitbucket","stash","1620cd7b-501d-3f5a-abd2-e1ecfd6549c3","Yes","No","http://example1.com","http://example1.com"
    "Jira","jira","da8d766f-fbf2-3fe7-8768-32b30b0a38e7","Yes","No","http://example2.com","http://example2.com"
    "Your Company Jira","jira","3c9aacea-555f-3fc1-a54c-acf012d98341","No","No","http://example3.com","http://example3.com"
    
    
  • Execute the following action to get the list of applications linked to your Bamboo instance based on the name of the application:

     --action getApplicationLinkList --type "jira"
    The output of the given action displays a list of Jira projects linked to your Bamboo instance.
  • Execute the following action to get the list of applications linked to your Bamboo instance based on the application details in a CSV format with specified column details:

    --action getApplicationLinkList --file "applicationlist.csv" --columns "Name,Type,System"

    The output of the given action is added to the specified CSV file and contains the following information:

The following parameters are used in this action:

  • --outputFormat value refers to the format that determines what columns are retrieved for the list.

  • --type value refers to the name of the application.

  • --file value refers to the output file name.

  • --columns value refers to the column name details you want to see.

It is recommended to test the command in a non-production environment before running in productionor, run the action with --simulate parameter to verify the behaviour before deploying.