Skip to main content
Connect IBM API Connect and CloudThinker agents can review catalogs and published APIs, API errors and latency, governance rulesets, and AI gateway usage. The connection signs in with an API Connect API key and the platform client ID and client secret of your provider organization.
IBM API Connect isn’t turned on for every workspace yet. To use it, contact us.

Prerequisites

  • API Connect v10.0.10 or later, or API Connect v12, on IBM’s cloud service or on your own servers.
  • For v10, API Agent enabled on your instance, and a user with the api-agent role in the provider organization. See IBM’s API Agent documentation.
  • An HTTPS path from CloudThinker to the platform and management API addresses. This connection runs from CloudThinker Cloud. If your instance only accepts known addresses, allow CloudThinker’s egress IPs: these docs don’t publish the list, so ask your CloudThinker contact, or contact us. See Reaching private services.
  • The Admin role in your CloudThinker workspace, which can add and edit connections. See Roles.

Choose a connection

On v10, one connection covers everything. On v12, IBM splits API Connect into services, and each one is its own connection with the same fields. Add only the ones you need.

Setup

1

Create an API key

Sign in to API Manager as the user CloudThinker should act as. Open the profile icon at the top right and select My API Keys. Click Add, enter a Title and Description, and choose a timeout long enough to cover your use. Select Enable multiple use and click Create. Copy the key.
2

Find the client ID, client secret, and URLs

On the My API Keys page, scroll to Authenticating for the platform REST API. In its example curl command:
  • The client ID and client secret are the client_id and client_secret values.
  • The Platform URL is the address before /api/token.
On v10 installed on your own servers, the client ID and secret are also in the toolkit section of the Toolkit credentials file you download from API Manager. Use these platform credentials, not a consumer app’s credentials. For the Management URL, ask your API Connect administrator for the HTTPS address of the management API.
3

Add the connection in CloudThinker

In the sidebar, click More → Workspace settings → Connections. On the Builtin Connections tab, search for IBM API Connect, pick the connection from Choose a connection, and click Connect. Fill in the fields from Connection details and click Connect.Success state: the connection shows Connected. Repeat this step for each v12 service you want.

Connection details

Both URLs must use HTTPS with a trusted certificate. CloudThinker connects only to these two addresses and refuses redirects to anywhere else.

Required permissions

Agents can do what the API key’s user can do in the provider organization.
Create a dedicated API Connect user for CloudThinker, give it only the catalogs agents should see, and set the API key timeout to match how long you want the connection to work.

Agent capabilities

Reads run without asking. Validation and draft tools go through your Approvals first. Drafts stay with the agent: nothing is published to API Connect. Agents can’t create apps or subscriptions, publish products, change rulesets, or read consumer app credentials. Make those changes in API Manager.

Verify the connection

A working connection returns your catalog names and the published APIs in that catalog.

Example prompts

Troubleshooting

A field is empty or contains a line break. The field named in the message is one of Provider organization, API key, Client ID, Client secret, Platform URL, or Management URL. Fill it in and connect again.
The Platform URL (or Management URL, for APIC_MANAGEMENT_URL) isn’t a bare HTTPS address. Enter only https:// and the host, such as https://platform-api.example.com.
API Connect redirected the request to another address, didn’t answer within 30 seconds, or sent an unusually large response. Check that both URLs are the exact platform and management API addresses, not addresses that redirect.
Check that API Agent is enabled on the instance and that the API key’s user has the api-agent role in the provider organization.
The API key’s timeout ran out, or the key wasn’t created with Enable multiple use. Create a new key and update the connection.

Security

  • Least privilege — grant only the permissions the agents need for your use case; start read-only and widen later.
  • Read-only by default — use read-only credentials unless you want agents to make changes through this connection.
  • Rotate credentials — rotate keys and tokens on your normal schedule; CloudThinker picks up the new value when you update the connection.
  • Revoke on offboarding — remove the credential at the provider when you delete a connection or a teammate leaves.
  • Use platform credentials only. Enter the platform client ID and secret, never a consumer app’s credentials.
  • Limit the user. Give the API key’s user access to only the catalogs agents should see.
  • Set a key timeout. An API key with a timeout stops working on its own if you forget to revoke it.

Approvals

Decide which changes run, wait for a person, or are refused

Connections

Every service CloudThinker can connect to