IBM API Connect Management API

Name: IBM API Connect Management API
Brand: IBM API Connect Management API
Availability: InStock

✓ Official Vendor SpecDeveloper ToolsCi Cdbearer25 EndpointsREST

Install Jentic One Beta

Connect the IBM API Connect Management API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the IBM API Connect Management API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fibm.com%2Fmain" | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fibm.com%2Fmain" | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with IBM API Connect Management API.

Manage provider organisations via /orgs and /orgs/{orgId}

List and update draft APIs and products via /orgs/{orgId}/drafts/apis and /drafts/products

Manage catalogs and their published products via /orgs/{orgId}/catalogs and /catalogs/{catalogId}/products

GET STARTED

Start building with IBM API Connect Management API

Explore with Jentic One

View OpenAPI Document

For Agents

Manage the full IBM API Connect lifecycle - orgs, drafts, catalogs, products, applications, and subscriptions - from CI or an agent.

Use for: I need to publish a new API product to a catalog, List all draft APIs in a provider organisation, Promote a product from a staging catalog to production, Subscribe an application to a product on a catalog

Not supported: Does not handle gateway runtime traffic, developer-portal content, or analytics dashboards - use for managing API Connect orgs, drafts, catalogs, and subscriptions only.

Use Cases

Patterns agents use IBM API Connect Management API for, with concrete tasks.

★ API Lifecycle Promotion

Promote a draft API and product from a development catalog through staging into production by calling the catalogs and products endpoints in sequence. The Management API provides /orgs/{orgId}/drafts/apis for the draft state and /catalogs/{catalogId}/products for catalog membership, which together cover the standard four-stage promotion that platform teams run from CI.

List drafts in /orgs/{orgId}/drafts/products, find the order-service product, then publish it to /catalogs/{catalogId}/products for the staging catalog.

Consumer Onboarding

Create a consumer organisation, register an application, and subscribe that application to a product so a partner can call published APIs through the API Connect gateway. The /catalogs/{catalogId}/consumer-orgs, /catalogs/{catalogId}/apps, and /catalogs/{catalogId}/subscriptions endpoints together cover the partner-onboarding sequence end to end.

Create a consumer org named partner-co, register an application named partner-co-app, and subscribe it to the public-orders product.

Gateway Configuration Audit

List the gateway services attached to a provider organisation to verify that the right gateways are wired to the right orgs before a release. The /orgs/{orgId}/gateway-services endpoint returns the gateway bindings, which an agent can compare against an expected manifest as part of a pre-release check.

GET /orgs/{orgId}/gateway-services for the production org and flag any gateway whose name does not match the expected list.

AI Agent Catalog Operator

An AI agent receives a request to publish an API product and drives the API Connect catalog operations directly through Jentic. The agent searches by intent, loads the publish-product schema, and executes the call without holding the raw API Connect bearer token. Typical agent integration is under one hour because the catalog and subscription surfaces are small and well-named.

Search Jentic for 'publish a product to an API Connect catalog', load the /catalogs/{catalogId}/products schema, and publish the order-service product.

Key Endpoints

25 endpoints — ibm api connect is the api management platform used by enterprises to design, secure, publish, and govern internal and partner apis.

METHOD

PATH

DESCRIPTION

GET

/orgs

List provider organisations

GET

/orgs/{orgId}/drafts/apis

List draft APIs

GET

/orgs/{orgId}/drafts/products

List draft products

GET

/orgs/{orgId}/catalogs

List catalogs in an org

GET

/catalogs/{catalogId}/products

List products in a catalog

GET

/catalogs/{catalogId}/consumer-orgs

List consumer organisations

GET

/catalogs/{catalogId}/apps

List applications

GET

/catalogs/{catalogId}/subscriptions

List subscriptions

GET

/orgs

List provider organisations

GET

/orgs/{orgId}/drafts/apis

List draft APIs

GET

/orgs/{orgId}/drafts/products

List draft products

GET

/orgs/{orgId}/catalogs

List catalogs in an org

GET

/catalogs/{catalogId}/products

List products in a catalog

Why Jentic?

What agents get from Jentic-routed access to this vendor.

Setup

Wiring the IBM API Connect Management API by hand means handling its bearer-token auth against your management server and mapping its org, catalog, and subscription routes yourself. Through Jentic you install once, import the IBM API Connect Management API from the API Directory, store the token once, and your agent calls it.

Permission scoping

API Connect puts the org and catalog ids in the URL path (/orgs/{orgId}, /catalogs/{catalogId}), so a rule can pin your agent to reading drafts, products, and subscriptions for one org or catalog. You choose the operations it may call, so anything beyond those reads is not included unless you add it.

Credential isolation

Your API Connect token is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.

Intent-based discovery

Agents search Jentic by intent such as 'list a catalog's products' or 'see an org's draft APIs', and Jentic returns the matching operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

FAQs

Specific to using IBM API Connect Management API through Jentic.

What authentication does the IBM API Connect Management API use?

The API Connect Management API uses HTTP bearer authentication. Through Jentic, the API Connect bearer token is stored in your Jentic One instance and the agent calls operations using a scoped Jentic credential, never the raw bearer token.

Can I publish an API product to a catalog with this API?

Yes. POST to /catalogs/{catalogId}/products with the product reference to publish a previously drafted product to that catalog. This is the same operation the API Manager UI runs when an editor clicks Publish.

How do I subscribe a consumer application to a product?

POST to /catalogs/{catalogId}/subscriptions with the application ID and the product ID. The subscription record is what the gateway uses to authorise calls from that application against the product's plan.

How do I drive API Connect promotions through Jentic?

Search Jentic for 'publish a product to an API Connect catalog', load the /catalogs/{catalogId}/products schema, and execute. Install the SDK with pip install jentic and use the async search, load, execute pattern from a CI step.

Can I list all consumer organisations on a catalog?

Yes. GET /catalogs/{catalogId}/consumer-orgs returns the consumer organisations registered against that catalog. Combine it with /catalogs/{catalogId}/apps to walk the application tree underneath each consumer org.

What are the rate limits for the API Connect Management API?

API Connect does not publish a fixed Management API rate limit; throughput depends on the management-server configuration. Treat 429 and 503 responses as backpressure and retry with exponential backoff, especially during bulk catalog operations.

Can I limit what my agent is allowed to do with the IBM API Connect Management API?

Yes. Because you run Jentic One self-hosted, your own rules decide which API Connect operations and which stored token the agent may use. Since API Connect carries the org and catalog ids in the URL path (/orgs/{orgId}, /catalogs/{catalogId}), you can pin the agent to read-only calls like GET /catalogs/{catalogId}/products or /catalogs/{catalogId}/subscriptions for a single catalog, so it cannot publish products or create subscriptions unless you grant those operations. Anything beyond the operations you allow is simply not available to the agent.