ibmcloud-regions

View information for all regions

$ ibmcloud regions

ibmcloud regions [OPTIONS]

--json
    Outputs the list of regions in JSON format, which is useful for scripting and programmatic consumption. This overrides the default table-based output.

-h, --help
    Displays help information for the ibmcloud regions command, including available options and usage examples.

--output
    Specifies the output format. Common values include JSON or TEXT (for the default table format). For example, --output JSON is equivalent to --json.

The ibmcloud-regions command is a sub-command within the IBM Cloud CLI (Command Line Interface) suite. It serves as a crucial tool for developers and administrators to query and view information about the various geographical regions where IBM Cloud services and resources can be deployed.

IBM Cloud regions are distinct geographical locations that host multiple data centers, providing high availability, disaster recovery, and low-latency access to services. Understanding which regions are available and their specific endpoints is essential for planning deployments, configuring network access, and ensuring compliance with data residency requirements.

This command typically outputs details such as the region name, its API endpoint, and potentially its status or associated data centers. It's often the first step in understanding the global footprint of IBM Cloud and deciding where to provision new resources.

This command requires the IBM Cloud CLI to be installed and properly configured. While it lists available regions, it does not provide information on the specific services available within each region, nor does it indicate current service health status. Some regions might have limitations on the types of resources or services they support, which would need to be checked via service-specific documentation or other IBM Cloud CLI commands.

When run without the --json option, the command typically produces a human-readable table with columns like Name and Endpoint. For example:

Name          Endpoint
us-south      https://api.us-south.cloud.ibm.com
eu-de         https://api.eu-de.cloud.ibm.com
au-syd        https://api.au-syd.cloud.ibm.com

The ibmcloud regions command is often used in conjunction with ibmcloud target -r to switch the CLI's operational context to a specific region before executing other commands like creating resources or listing services. This ensures that subsequent operations are directed to the desired geographical location.

The regions command has been a fundamental part of the IBM Cloud CLI since its early days, evolving with the expansion of IBM's global cloud infrastructure. As new regions and availability zones are introduced, the command's data source is updated to reflect the latest geographical coverage, making it a continuously relevant tool for cloud users. Its core functionality has remained consistent: providing a centralized way to discover IBM Cloud's global presence.

ibmcloud(1), ibmcloud login(1), ibmcloud target(1), ibmcloud resource service-instance(1)