--- name: metrics-router-settings title: Configuring account settings description: You can configure your account settings for IBM Cloud® Metrics Routing by using the IBM Cloud Metrics Routing UI, the IBM Cloud Metrics Routing CLI, the IBM Cloud Metrics Routing REST API, and Terraform scripts. Set these settings to define where and how metrics are collected, routed, and managed in your account. last-updated: 2025-03-13 --- > ## Documentation Index > The table of contents for this documentation set is at https://cloud.ibm.com/docs/metrics-router?format=markdown > The index for all IBM Cloud docs is at: https://cloud.ibm.com/docs/llms.txt > Use these files to discover more information as needed. # Configuring account settings {: #settings} You can configure your account settings for IBM Cloud® Metrics Routing by using the IBM Cloud Metrics Routing UI, the IBM Cloud Metrics Routing CLI, the IBM Cloud Metrics Routing REST API, and Terraform scripts. Set these settings to define where and how metrics are collected, routed, and managed in your account. {: shortdesc} Before you disable public endpoints by setting `--private-api-endpoint-only TRUE`, make sure your account has access to the private endpoint. You can do this by running the command `ibmcloud account show`. If `VRF Enabled` is `true` and `Service Endpoint Enabled` is `true` then you have access to the private endpoint. If you do not have access to the private endpoint, you will be unable to re-enable the public endpoint since private endpoint access is required to re-enable the public endpoint. {: important} For more information, see [About account settings](https://cloud.ibm.com/docs/metrics-router?topic=metrics-router-settings-about&interface=api&format=markdown). ## IAM permissions {: #settings-access} Ensure you have the [correct IAM permissions to configure IBM Cloud Metrics Routing settings.](https://cloud.ibm.com/docs/metrics-router?topic=metrics-router-iam&format=markdown) ## Getting account settings using the UI {: #settings-get-ui} {: ui} Do the following to view the account settings for IBM Cloud Metrics Routing by using the UI. 1. [Log in to your IBM Cloud account](https://cloud.ibm.com/login){: external}. 2. Click the **Menu** icon ![Menu icon](../icons/icon_hamburger.svg) > **Observability**. 3. Click **Monitoring**. 4. Click **Routing**. 5. Click the **Settings** tab. On this page you can view the following settings: - **Metadata location**: Displays primary metadata region and backup metadata region. - **Permitted target regions**. Displays the targets regions where metrics can be sent. - **Default targets**: Displays the configured default targets. - **Public endpoints**: Displays if public endpoints are enabled. When disabled, the IBM Cloud Metrics Routing UI cannot be accessed. - **Reports**: Displays the configurations in JSON format. ## Updating settings using the UI {: #settings-update-ui} {: ui} 1. [Log in to your IBM Cloud account](https://cloud.ibm.com/login){: external}. 2. Click the **Menu** icon ![Menu icon](../icons/icon_hamburger.svg) > **Observability**. 3. Click **Monitoring**. 4. Click **Routing**. 5. Click the **Settings** tab. 6. Click **Edit** next to the setting to be changed. You can modify the following settings: - **Metadata location**: Select your desired primary metadata region and backup metadata region. - **Permitted target regions**: Select the region where targets can be created. If no regions are selected, then all regions can receive metrics. - **Default targets**: Select the target that will be used by default when routing rules do not exist or are not matched. ## CLI prerequisites {: #settings-prereqs-cli} {: cli} Before you use the the CLI to manage IBM Cloud Metrics Routing account settings, [Install the IBM Cloud Metrics Routing CLI](https://cloud.ibm.com/docs/metrics-router?topic=metrics-router-metrics-router-cli-config&format=markdown). Check that you have IAM permissions to read, update, or both the IBM Cloud Metrics Routing account settings. ## Getting account settings using the CLI {: #settings-get-using-cli} {: cli} Use this command to get the settings for the IBM Cloud Metrics Routing account configurations. ```sh ibmcloud metrics-router setting get [--output FORMAT] ``` {: pre} ### Command options {: #settings-get-options-cli} `--output FORMAT` : If `JSON` is specified, output will be returned in JSON format. If `JSON` is not specified, output will be returned in a tabular format. `help` | `--help` | `-h` : List options available for the command. ### Example {: #settings-get-example} The following is an example where no default or permitted targets have been set. ```text Primary metadata region: us-east Backup metadata region: - Default targets: [] Permitted target regions: [] Private api endpoint only: false ``` {: codeblock} ## Updating settings using the CLI {: #settings-update-using-cli} {: cli} Use this command to modify current account settings such as the default targets, permitted target regions, and the primary metadata region. ```sh ibmcloud metrics-router setting update [--primary-metadata-region REGION] [--backup-metadata-region REGION] [--private-api-endpoint-only ( TRUE | FALSE )] [--default-targets TARGET] [--permitted-target-regions REGIONS] [--output FORMAT] [--force] ``` {: pre} ### Command options {: #settings-update-options-cli} `primary-metadata-region` : Specify the REGION where the metadata associated with route and target definitions is stored. `backup-metadata-region` : Specify the REGION where the metadata associated with route and target definitions is stored as a backup. `private-api-endpoint-only` : Specifies whether nor not a private endpoint can be used. If `TRUE` only a private endpoint can be used. `default-targets` : Is a list of target IDs. If no routing rules cause metrics to be sent to other targets, these targets will received the metrics. TARGETS is a comma-separated list of target IDs. `permitted-target-regions` : Is the list of regions that can be used to define a target. REGIONS is a comma-separated list of regions. `--output FORMAT` : If `JSON` specified, output will be returned in JSON format. If `JSON` is not specified, output will be returned in a tabular format. `help` | `--help` | `-h` : List options available for the command. If the update is successful, the current settings will be displayed. ## API prerequsites {: #settings-prereqs-api} {: api} To make API calls to manage settings, complete the following steps: 1. Get an IAM access token. For more information, see [Retrieving IAM access tokens](https://cloud.ibm.com/docs/metrics-router?topic=metrics-router-iam-retrieve-token&interface=cli&format=markdown). 2. Identify the API endpoint in the region where you plan to configure or manage settings. For more information, see [Endpoints](https://cloud.ibm.com/docs/metrics-router?topic=metrics-router-endpoints&format=markdown). ## Getting settings using the API {: #settings-get-api} {: api} You can use the following cURL command to get existing settings information: ```shell curl -X GET ENDPOINT/api/v3/settings -H "Authorization: $ACCESS_TOKEN" ``` {: codeblock} Where: `ENDPOINT` : Is the API endpoint in the region where you plan to configure or manage a target. For more information, see [Endpoints](https://cloud.ibm.com/docs/metrics-router?topic=metrics-router-endpoints&format=markdown). For example, you can use the following cURL request to get the account settings information: ```shell curl -X GET https://private.us-south.metrics_router.cloud.ibm.com/api/v2/settings -H "Authorization: $ACCESS_TOKEN" ``` {: screen} A response similar to the following is returned: ```json { "default_targets": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "crn": "crn:v1:bluemix:public:metrics-router:us-south:a/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa::target:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "name": "default-us-south-target", "target_type": "sysdig_monitor" }, { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "crn": "crn:v1:bluemix:public:metrics-router:au-syd:a/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa::target:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "name": "default-au-syd-south-target", "target_type": "sysdig_monitor" } ], "permitted_target_regions": [ "us-south", "us-east" ], "primary_metadata_region": "us-south", "private_api_endpoint_only": false } ``` {: screen} Where: `default_targets` : Is a list of target IDs. If no routing rules cause metrics to be sent to other targets, these targets will received the metrics. `permitted_target_regions` : Is the list of regions that can be used to define a target. A maximum of two permitted target regions are allowed. `primary_metadata_region` : Is the region where the metadata associated with route and target definitions is stored. `backup_metadata_region` : Is the region where the metadata associated with route and target definitions is stored as a backup. `private_api_endpoint_only` : Specifies whether nor not a private endpoint can be used. If `true` only a private endpoint can be used. ## Updating settings using the API {: #settings-update-api} {: api} When you update settings, consider the following information: - You must include the settings information in the data section of the request. - You must pass the data that is configured for each setting. Data that is configured and not included in an update request is deleted. {: important} - Update the data for the fields that need changing. You can use the following cURL command to update settings: ```shell curl -X PATCH https:///api/v3/settings -H "Authorization: Bearer " -H 'accept: application/json' -d '{ "default_targets": [ { "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ], "permitted_target_regions": ["us-south", "us-east"], "primary_metadata_region": "us-south", "backup_metadata_region": "us-east", "private_api_endpoint_only": false }' ``` {: codeblock} Where: `ENDPOINT` : Is the API endpoint in the region where you plan to configure or manage a target. For more information, see [Endpoints](https://cloud.ibm.com/docs/metrics-router?topic=metrics-router-endpoints&format=markdown). `default_targets` : Is a list of target IDs. If no routing rules cause metrics to be sent to other targets, these targets will received the metrics. `permitted_target_regions` : Is the list of regions that can be used to define a target. A maximum of two permitted target regions can be specified. `primary_metadata_region` : Is the region where the metadata associated with route and target definitions is stored. `backup_metadata_region` : Is the region where the metadata associated with route and target definitions is stored for backup purposes. `private_api_endpoint_only` : Specifies whether or not a private endpoint can be used. If `true` only a private endpoint can be used.