IBM API Connect

IBM API Connect Products and APIs API

The Products and APIs API from IBM API Connect — 81 operation(s) for products and apis.

GitHub OpenAPI
Business capability
Public API Lifecycle Management BC-4270.10

Operations 97

GET /public-products List all Product objects in all collections #
GET /public-products/{product-name} List the Product objects #
GET /public-products/{product-id} Get the Product object by id #
GET /public-products/{product-name}/{product-version} Get the Product object by name and version #
GET /public-products/{product-id}/document Get the Product document #
GET /public-products/{product-name}/{product-version}/document Get the Product document by name and version #
GET /public-apis List all API objects in all collections #
GET /public-apis/{api-name} List the API objects #
GET /public-apis/{api-id} Get the API object by id #
GET /public-apis/{api-name}/{api-version} Get the API object by name and version #
GET /public-apis/{api-id}/document Get the API document #
GET /public-apis/{api-name}/{api-version}/document Get the API document by name and version #
GET /public-apis/{api-id}/wsdl Get the API wsdl document #
GET /public-apis/{api-name}/{api-version}/wsdl Get the API wsdl document by name and version #
GET /products List all Product objects in all collections #
GET /products/{product-name} List the Product objects #
GET /products/{product-id} Get the Product object by id #
GET /products/{product-name}/{product-version} Get the Product object by name and version #
GET /products/{product-id}/document Get the Product document #
GET /products/{product-name}/{product-version}/document Get the Product document by name and version #
GET /apis List all API objects in all collections #
GET /apis/{api-name} List the API objects #
GET /apis/{api-id} Get the API object by id #
GET /apis/{api-name}/{api-version} Get the API object by name and version #
GET /apis/{api-id}/document Get the API document #
GET /apis/{api-name}/{api-version}/document Get the API document by name and version #
GET /apis/{api-id}/wsdl Get the API wsdl document #
GET /apis/{api-name}/{api-version}/wsdl Get the API wsdl document by name and version #
GET /catalogs/{org}/{catalog}/products Lists products #
DELETE /catalogs/{org}/{catalog}/products Clears products #
GET /catalogs/{org}/{catalog}/products/{product-name} Lists products #
DELETE /catalogs/{org}/{catalog}/products/{product-name} Clears product versions #
GET /catalogs/{org}/{catalog}/products/{product-id} Returns a product #
PATCH /catalogs/{org}/{catalog}/products/{product-id} Updates a product in a catalog #
DELETE /catalogs/{org}/{catalog}/products/{product-id} Deletes a product #
GET /catalogs/{org}/{catalog}/products/{product-name}/{product-version} Returns a product #
PATCH /catalogs/{org}/{catalog}/products/{product-name}/{product-version} Updates a product in a catalog #
DELETE /catalogs/{org}/{catalog}/products/{product-name}/{product-version} Delete a Product #
POST /catalogs/{org}/{catalog}/products/{product-id}/replace Hot replace a product #
POST /catalogs/{org}/{catalog}/products/{product-id}/supersede Supersede a product #
POST /catalogs/{org}/{catalog}/products/{product-id}/set-migration-target Set the migration target of a product #
POST /catalogs/{org}/{catalog}/products/{product-id}/migrate-subscriptions Migrate list of subscriptions between products #
POST /catalogs/{org}/{catalog}/products/{product-id}/execute-migration-target Migrate all subscriptions to their migration targets #
POST /catalogs/{org}/{catalog}/products/{product-name}/{product-version}/replace Hot replace the product #
POST /catalogs/{org}/{catalog}/products/{product-name}/{product-version}/supersede Supersede a product #
POST /catalogs/{org}/{catalog}/products/{product-name}/{product-version}/set-migration-target Set the migration target #
POST /catalogs/{org}/{catalog}/products/{product-name}/{product-version}/migrate-subscriptions Migrate list of subscriptions between products #
POST /catalogs/{org}/{catalog}/products/{product-name}/{product-version}/execute-migration-target Migrate all subscriptions to their migration targets #
GET /catalogs/{org}/{catalog}/products/{product-id}/document Get the Product document #
GET /catalogs/{org}/{catalog}/products/{product-name}/{product-version}/document Get the Product document by name and version #
GET /catalogs/{org}/{catalog}/apis Lists APIs in a catalog #
GET /catalogs/{org}/{catalog}/apis/{api-name} Lists APIs in a catalog #
GET /catalogs/{org}/{catalog}/apis/{api-id} Returns an API object #
PATCH /catalogs/{org}/{catalog}/apis/{api-id} Updates an API #
GET /catalogs/{org}/{catalog}/apis/{api-name}/{api-version} Returns an API object #
PATCH /catalogs/{org}/{catalog}/apis/{api-name}/{api-version} Updates an API #
GET /catalogs/{org}/{catalog}/apis/{api-id}/document Get the API document #
GET /catalogs/{org}/{catalog}/apis/{api-name}/{api-version}/document Get the API document by name and version #
GET /catalogs/{org}/{catalog}/apis/{api-id}/consumer-document Get the API consumer-document #
GET /catalogs/{org}/{catalog}/apis/{api-name}/{api-version}/consumer-document Get the API document by name and version #
GET /catalogs/{org}/{catalog}/apis/{api-id}/wsdl Get the API wsdl document #
GET /catalogs/{org}/{catalog}/apis/{api-name}/{api-version}/wsdl Get the API wsdl document by name and version #
GET /spaces/{org}/{catalog}/{space}/products Lists products #
DELETE /spaces/{org}/{catalog}/{space}/products Clears products #
GET /spaces/{org}/{catalog}/{space}/products/{product-name} Lists products #
DELETE /spaces/{org}/{catalog}/{space}/products/{product-name} Clears product versions #
GET /spaces/{org}/{catalog}/{space}/products/{product-id} Returns a product #
PATCH /spaces/{org}/{catalog}/{space}/products/{product-id} Updates a product in a space #
DELETE /spaces/{org}/{catalog}/{space}/products/{product-id} Deletes a product #
GET /spaces/{org}/{catalog}/{space}/products/{product-name}/{product-version} Returns a product #
PATCH /spaces/{org}/{catalog}/{space}/products/{product-name}/{product-version} Updates a product in a space #
DELETE /spaces/{org}/{catalog}/{space}/products/{product-name}/{product-version} Delete a Product #
POST /spaces/{org}/{catalog}/{space}/products/{product-id}/replace Hot replace a product #
POST /spaces/{org}/{catalog}/{space}/products/{product-id}/supersede Supersede a product #
POST /spaces/{org}/{catalog}/{space}/products/{product-id}/set-migration-target Set the migration target of a product #
POST /spaces/{org}/{catalog}/{space}/products/{product-id}/migrate-subscriptions Migrate list of subscriptions between products #
POST /spaces/{org}/{catalog}/{space}/products/{product-id}/execute-migration-target Migrate all subscriptions to their migration targets #
POST /spaces/{org}/{catalog}/{space}/products/{product-name}/{product-version}/replace Hot replace the product #
POST /spaces/{org}/{catalog}/{space}/products/{product-name}/{product-version}/supersede Supersede a product #
POST /spaces/{org}/{catalog}/{space}/products/{product-name}/{product-version}/set-migration-target Set the migration target #
POST /spaces/{org}/{catalog}/{space}/products/{product-name}/{product-version}/migrate-subscriptions Migrate list of subscriptions between products #
POST /spaces/{org}/{catalog}/{space}/products/{product-name}/{product-version}/execute-migration-target Migrate all subscriptions to their migration targets #
GET /spaces/{org}/{catalog}/{space}/products/{product-id}/document Get the Product document #
GET /spaces/{org}/{catalog}/{space}/products/{product-name}/{product-version}/document Get the Product document by name and version #
GET /spaces/{org}/{catalog}/{space}/apis Lists APIs in a space #
GET /spaces/{org}/{catalog}/{space}/apis/{api-name} Lists APIs in a space #
GET /spaces/{org}/{catalog}/{space}/apis/{api-id} Returns an API object #
PATCH /spaces/{org}/{catalog}/{space}/apis/{api-id} Updates an API #
GET /spaces/{org}/{catalog}/{space}/apis/{api-name}/{api-version} Returns an API object #
PATCH /spaces/{org}/{catalog}/{space}/apis/{api-name}/{api-version} Updates an API #
GET /spaces/{org}/{catalog}/{space}/apis/{api-id}/document Get the API document #
GET /spaces/{org}/{catalog}/{space}/apis/{api-name}/{api-version}/document Get the API document by name and version #
GET /spaces/{org}/{catalog}/{space}/apis/{api-id}/consumer-document Get the API consumer-document #
GET /spaces/{org}/{catalog}/{space}/apis/{api-name}/{api-version}/consumer-document Get the API document by name and version #
GET /spaces/{org}/{catalog}/{space}/apis/{api-id}/wsdl Get the API wsdl document #
GET /spaces/{org}/{catalog}/{space}/apis/{api-name}/{api-version}/wsdl Get the API wsdl document by name and version #
GET /orgs/{org}/apis/{api-name}/{api-version} List all the API objects across catalogs by name and version #

Documentation

📖
Documentation
https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=reference-api-connect-rest-apis
📖
GettingStarted
https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=reference-api-connect-rest-apis
📖
Authentication
https://www.ibm.com/docs/en/api-connect/software/12.1.1?topic=cli-managing-platform-rest-api-keys

Specifications

⚙
OpenAPI
https://artifacts.apis.io/ibm-api-connect/openapi/ibm-api-connect-products-and-apis-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/ibm-api-connect/json-schema/ibm-api-connect-product-2-schema.json
📊
JSONSchema
https://artifacts.apis.io/ibm-api-connect/json-schema/ibm-api-connect-api-2-schema.json
📊
JSONSchema
https://artifacts.apis.io/ibm-api-connect/json-schema/ibm-api-connect-product-schema.json
📊
JSONSchema
https://artifacts.apis.io/ibm-api-connect/json-schema/ibm-api-connect-api-schema.json

Other Resources

🔗
Reference
https://apic-api.apiconnect.ibmcloud.com/v12/

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/ibm-api-connect:ibm-api-connect-products-and-apis-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

ibm-api-connect-products-and-apis-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Ibm Api Connect Products and APIs API
  version: 2.0.0
  contact:
    name: IBM
    url: https://www.ibm.com
    email: help@ibm.com
  license:
    name: tbd
    url: https://tbd.com
  termsOfService: https://www.ibm.com/legal
  x-refined-note:
  - x-ibm-name differs across the merged source definitions and was not carried
  description: 'Operations tagged Products and APIs across 2 of this provider''s published API definitions: ibm-api-connect-consumer-api-openapi.yml, ibm-api-connect-management-api-openapi.yml. Each path carries the servers of the definition it was published in.'
tags:


# --- truncated at 32 KB (166 KB total) ---
# Full source: https://artifacts.apis.io/ibm-api-connect/openapi/ibm-api-connect-products-and-apis-api-openapi.yml