--- name: logs-router-about title: Learning about IBM Cloud Logs Routing description: You can use the IBM Cloud Logs Routing service to route platform logs that are generated by selected IBM Cloud service instances to your chosen destination (target). last-updated: 2025-07-03 --- > ## Documentation Index > The table of contents for this documentation set is at https://cloud.ibm.com/docs/logs-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. # Learning about IBM Cloud Logs Routing {: #about} You can use the IBM Cloud Logs Routing service to route platform logs that are generated by selected IBM Cloud service instances to your chosen destination (target). {: shortdesc} ![Flow of platform logs](/images/cloud-logs-platform-logs.png "Flow of platform logs"){: caption="Flow of platform logs" caption-side="bottom"} For more information, see [About platform logs](https://cloud.ibm.com/docs/logs-router?topic=logs-router-about-platform-logs&format=markdown). To configure platform logs, you must configure tenants and targets (destinations) in your IBM Cloud account. {{site.data.content.tenant_definition-paragraph}} ## Tenants {: #about_tenants} When you manage tenants, consider the following information: - You must create a tenant in your account in each region where you want to use IBM Cloud Logs Routing to collect and route platform logs. Each region is independent. Regions do not share data. - When you create a tenant, you must define 1 target destination. For more information, see [Creating a tenant](https://cloud.ibm.com/docs/logs-router?topic=logs-router-tenant-create&format=markdown). - When you update a tenant, you can only modify the name of the tenant. - When you delete a tenant, you also delete the target definitions. If you want to delete a target destination instance, you must delete the instance separately. - You can list all the tenants in an account by using the `GET /tenants` API method. - To get the details about a tenant, you can use the `GET /tenants/{tenant_id}` API method specifying the tenant ID returned when listing the tenants in an account. You can also see the configured tenants and target destinations using the [routing configuration UI](https://cloud.ibm.com/docs/logs-router?topic=logs-router-launch-ui&format=markdown). {: tip} ## Targets {: #about_targets} IBM Cloud Logs Routing supports IBM Cloud Logs instances targets. Only public ingress endpoints are supported when configuring a target to an IBM Cloud Logs instance. {: restriction} For more information, see [Configuring the IBM Cloud Logs Routing service to route platform logs to an IBM Cloud Logs instance](https://cloud.ibm.com/docs/logs-router?topic=logs-router-target-cloud-logs&format=markdown). The IBM Cloud Logs Routing target instance can be located in the same account, a different account, and the same or different region as the IBM Cloud Logs Routing tenant. {: important} When you manage targets, consider the following information: - You can update the target configuration details such as target host, target port, target name, target instance CRN, and more. - You can list all the targets in a tenant by using the `GET /tenants/{tenant_id}/targets` API method. - To get the details about a target by using the `GET /tenants/{tenant_id}/targets/{target_id}` API method. You can also see the configured tenants and target destinations using the [routing configuration UI](https://cloud.ibm.com/docs/logs-router?topic=logs-router-launch-ui&format=markdown). {: tip} Authorization between the IBM Cloud Logs Routing service and the target destination instances is done through IAM. ## Connecting to IBM Cloud Logs Routing {: #about_connecting} IBM® Cloud Logs Routing provides API endpoints for management functions, such as creating or managing a tenant configuration. These API endpoints are endpoints are accessed by using region-specific URLs. You can find the endpoints for each supported region [here](https://cloud.ibm.com/docs/logs-router?topic=logs-router-endpoints&format=markdown). You can manage IBM Cloud Logs Routing by using the management API. The management API supports either a public endpoint or a private endpoint. A public endpoint can be reached over the internet, whereas a private endpoint can be accessed only from within the IBM Cloud private network. Through the IBM Cloud Logs Routing UI, you can create a tenant in a region by using the public network. ![Flow of routed logs](/images/Logs-Router-04--1.svg "Resources"){: caption="Resources" caption-side="bottom"} The IBM® Cloud Logs Routing supports the following types of endpoints to privately connect to IBM Cloud Logs Routing: - IBM Cloud Cloud Service Endpoint (CSE) - Virtual Private Endpoint (VPE) for VPC. If you are connecting from an IBM Cloud VPC, you can connect by using either a CSE or VPE for VPC. For more information, see [Using virtual private endpoints for VPC to privately connect to IBM Cloud Logs Routing](https://cloud.ibm.com/docs/logs-router?topic=logs-router-vpe-connection&interface=api&format=markdown). If you are connecting from a system that is not contained in an IBM Cloud VPC, your only private endpoint option is to connect by using a CSE. Connecting to IBM Cloud Logs Routing by using a CSE might not require any additional work on your part. Access to CSEs is only available from within the IBM Cloud private network. For more information, see [Using service endpoints to privately connect to IBM Cloud Logs Routing](https://cloud.ibm.com/docs/logs-router?topic=logs-router-service-endpoints&format=markdown). You can only access the [IBM Cloud Logs Routing UI](https://cloud.ibm.com/docs/logs-router?topic=logs-router-launch-ui&format=markdown) through the public network. You can manage IBM Cloud Logs Routing by using the management API. The management API supports either a public endpoint or a private endpoint. A public endpoint can be reached over the internet, whereas a private endpoint can be accessed only from within the IBM Cloud private network. - To create, update, or delete a configuration, you can use the [IBM Cloud Logs Routing management API](https://cloud.ibm.com/apidocs/logs-router-service-api) or the [IBM Cloud Logs Routing UI](https://cloud.ibm.com/docs/logs-router?topic=logs-router-launch-ui&format=markdown). - To see the list of management endpoints, see [Endpoints](https://cloud.ibm.com/docs/logs-router?topic=logs-router-endpoints&format=markdown). Using the public endpoint does not require additional work.