IBM Cloud Docs
Managing targets

Managing targets

You can manage IBM Cloud® Activity Tracker Event Routing targets in your account by using the Activity Tracker Event Routing CLI, the Activity Tracker Event Routing REST API, and Terraform scripts. A target is a resource where you can collect auditing events.

Understanding how targets work in your account

Note the following information about targets:

  • You can define up to 16 targets in each account. Each account can have up to 2 default targets.

  • A target defines a resource where auditing events are collected. Routes define how auditing events that are generated in the account are routed to the targets that you configure.

  • You can define a target in any of the supported locations where Activity Tracker Event Routing is available. For more information, see Locations.

  • Targets are created within a region but are visible across regions. That is, all targets can be accessed by any IBM Cloud® Activity Tracker Event Routing API endpoint.

  • You can use private and public endpoints to manage targets. For more information about the list of ENDPOINTS that are available, see Endpoints.

    • You can manage targets from the private network using an API endpoint with the following format: https://private.REGION.atracker.cloud.ibm.com

    • You can manage targets from the public network using an API endpoint with the following format: https://REGION.atracker.cloud.ibm.com

    • You can disable the public endpoints by updating the account settings. For more information, see Enforcing private endpoints.

Target types

You can configure any of the following target types:

Table 1. List of targets
Target Type Learn more
IBM Cloud Object Storage (COS) cloud_object_storage Managing IBM Cloud Object Storage (COS) targets
IBM Cloud Activity Tracker Event Routing AT hosted event search logdna Managing IBM Cloud Activity Tracker Event Routing hosted event search targets.
IBM® Event Streams for IBM Cloud® (Event Streams) event_streams Managing IBM® Event Streams for IBM Cloud® (Event Streams) targets

IAM Access

You must grant users IAM permissions to manage targets. For more information, see Assign access to resources.

When you define a policy, you can indicate the scope of the permissions. You can choose from granting permissions for a specific region or for the entire account.

Users with regional scope will be limited to access targets in their authorized region.

Table 2. Required IAM roles
IAM action IAM Policy scope IAM Roles Description
atracker.target.read Region Administrator
Editor
Viewer
Operator		 Read (view) information about a target
atracker.target.create Region Administrator
Editor		 Create a target
atracker.target.update Region Administrator
Editor		 Update a target
atracker.target.delete Region Administrator
Editor		 Delete a target
atracker.target.list Account Administrator
Editor
Viewer
Operator		 List all targets

Authentication options

To route events to a target, check the options that you can use to authenticate for that target type.

Table 3. Authentication options by target type
Target Service to Service (S2S) authentication API key
cloud_object_storage Checkmark icon Checkmark icon
logdna Checkmark icon
event_streams Checkmark icon

Validating targets

When you validate a target, you check that the credentials that are configured for a target are valid. These credentials are used by Activity Tracker Event Routing to authenticate with the destination target.

You can validate a target by using the IBM Cloud Metrics Routing CLI, the IBM Cloud Metrics Routing REST API, and Terraform scripts.

Table 4. Validating options by target type
Target type CLI API
cloud-object-storage Validate via CLI Validate via API
logdna Validate via CLI Validate via API
event_streams Validate via CLI Validate via API

CLI prerequisites

Before you use the CLI to manage targets, complete the following steps:

  1. Install the IBM Cloud CLI.

  2. Install the IBM Cloud Activity Tracker Event Routing CLI.

CLI commands

The following table lists the actions that you can run to manage targets:

Table 5. Target actions by using the IBM Cloud Activity Tracker Event RoutingEvent Routing CLI
Action Command
Create a target ibmcloud atracker target create
Update a target ibmcloud atracker target update
Delete a target ibmcloud atracker target delete
Read a target ibmcloud atracker target get
List all targets ibmcloud atracker target ls
Validate a target ibmcloud atracker target validate

For more information, see IBM Cloud Activity Tracker Event Routing V2 CLI.

API targets and actions

To make API calls to manage targets, complete the following steps:

  1. Get an IAM access token. For more information, see Retrieving IAM access tokens.
  2. Identify the API endpoint in the region where you plan to configure or manage a target. For more information, see Endpoints.

The following table lists the actions that you can run to manage targets:

Table 6. Target actions by using the IBM Cloud Activity Tracker Event Routing REST API
Action REST API Method API_URL
Create a target POST <ENDPOINT>/api/v2/targets
Update a target PUT <ENDPOINT>/api/v2/targets/<TARGET_ID>
Delete a target DELETE <ENDPOINT>/api/v2/targets/<TARGET_ID>
Read a target GET <ENDPOINT>/api/v2/targets/<TARGET_ID>
List all targets GET <ENDPOINT>/api/v2/targets
Validate a target POST <ENDPOINT>/api/v2/targets/{id}/validate

For more information, see IBM Cloud Activity Tracker Event Routing V2 API.

HTTP response codes

When you use the IBM Cloud Activity Tracker Event Routing REST API, you can get standard HTTP response codes to indicate whether a method completed successfully.

  • A 200 response always indicates success.
  • A 4xx response indicates a failure.
  • A 5xx response usually indicates an internal system error.

See the following table for some HTTP response codes:

Table 7. List of HTTP response codes
Status code Status Description
200 OK The request was successful.
201 OK The request was successful. A resource is created.
400 Bad Request The request was unsuccessful. You might be missing a parameter that is required.
401 Unauthorized The IAM token that is used in the API request is invalid or expired.
403 Forbidden The operation is forbidden due to insufficient permissions.
404 Not Found The requested resource doesn't exist or is already deleted.
429 Too Many Requests Too many requests hit the API too quickly.
500 Internal Server Error Something went wrong in IBM Cloud Activity Tracker Event Routing processing.

Next

Choose 1 of the following options to configure a target in your account: