Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developer.watson-orchestrate.ibm.com/llms.txt

Use this file to discover all available pages before exploring further.

Manage the connections in your active environment.

​
Listing all connections

To list all existing connections in your environment, run the following command:
BASH
orchestrate connections list
This command will display one or more tables, each corresponding to a different environment.

​
Updating a connection

To update a connection, simply run the import command again and use the same app-id of the connection that you want to update.
BASH
orchestrate connections import --file <path to file with the same --app-id <name of the connection that you want to update>

​
Deleting a connection

To remove a connection, simply run the following command. Be aware that deleting the connection will also delete all associated configurations.
BASH
orchestrate connections remove --app-id <my_app_id>

​
Exporting connections

Use the orchestrate connections export command to export a connection configuration from an existing Orchestrate environment. The exported data is saved as a YAML file, which contains the connection object and associated configuration details.
BASH
orchestrate connections export -a <app_id> -o <output_file>.yml

​
Example

The following example exports a connection from an application by using the app ID and saves it to a YAML file:
BASH
orchestrate connections list
orchestrate connections export -a <application_id> -o <file-path>.yml
Note:
  • The resulting file contains the connection object in YAML format.
  • If the connection includes a live configuration, a live section appears in the exported file.