IBM API Connect

IBM API Connect Portal API

The Portal API from IBM API Connect — 128 operation(s) for portal.

GitHub OpenAPI

Operations 145

POST /portal-chatbot Create a new AI Agent chat session #
POST /portal-chatbot/{chat-session} Send message to AI Agent #
GET /catalogs/{org}/{catalog}/api/list Shows a list of apis from a site #
GET /catalogs/{org}/{catalog}/api/get Get a specific api from a developer portal #
GET /catalogs/{org}/{catalog}/api/get-document Get a specific entire api document from a developer portal #
POST /catalogs/{org}/{catalog}/api/add-attachment Add an attachment for the given api #
POST /catalogs/{org}/{catalog}/api/add-tag Add a tag for the given api #
PUT /catalogs/{org}/{catalog}/api/set-icon Set an icon image for the given api #
GET /catalogs/{org}/{catalog}/apic-config/get Get the configuration object that the developer portal holds #
GET /catalogs/{org}/{catalog}/application/list Shows a list of applications from a site #
GET /catalogs/{org}/{catalog}/application/get Get a specific application from a developer portal #
GET /catalogs/{org}/{catalog}/consumer-org/list Shows a list of consumer orgs from a site #
GET /catalogs/{org}/{catalog}/consumer-org/get Get a specific consumer org from a developer portal #
POST /catalogs/{org}/{catalog}/content/export/{entity_type} Export a tgz containing the site content #
GET /catalogs/{org}/{catalog}/content/export/{task_id}/download When ready, streams a content export artifact #
DELETE /catalogs/{org}/{catalog}/content/export/{task_id}/delete If running, cancels a content export task #
GET /catalogs/{org}/{catalog}/content/export/{task_id}/status Returns information about the status of this task #
POST /catalogs/{org}/{catalog}/content/import Create a task that imports an archive of site content #
DELETE /catalogs/{org}/{catalog}/content/import/{task_id} If running, cancels a content import task #
GET /catalogs/{org}/{catalog}/content/import/{task_id}/status Returns information about the status of this task #
GET /catalogs/{org}/{catalog}/content/list/{entity_type} Lists all of the entities in your site for the given entity type and bundle #
GET /catalogs/{org}/{catalog}/content/list-types Lists allowed content types on your site #
POST /catalogs/{org}/{catalog}/custom-module/export Create a task that exports an archive that contains the custom modules of a site #
GET /catalogs/{org}/{catalog}/custom-module/export/{task_id} When ready, streams a custom module export artifact #
DELETE /catalogs/{org}/{catalog}/custom-module/export/{task_id} If running, cancels a custom module export task #
GET /catalogs/{org}/{catalog}/custom-module/export/{task_id}/status Returns information about the status of this task #
POST /catalogs/{org}/{catalog}/custom-module/import Create a task that imports an archive that contains the custom modules of a site #
DELETE /catalogs/{org}/{catalog}/custom-module/import/{task_id} If running, cancels a custom module import task #
GET /catalogs/{org}/{catalog}/custom-module/import/{task_id}/status Get the result of the custom module import task #
POST /catalogs/{org}/{catalog}/custom-library/import Create a task that imports an archive that contains the custom libraries of a… #
DELETE /catalogs/{org}/{catalog}/custom-library/import/{task_id} If running, cancels a custom library import task #
GET /catalogs/{org}/{catalog}/custom-library/import/{task_id}/status Get the result of the custom library import task #
POST /catalogs/{org}/{catalog}/custom-theme/export Create a task that exports an archive that contains the custom themes of a site #
GET /catalogs/{org}/{catalog}/custom-theme/export/{task_id} When ready, streams a custom theme export artifact #
DELETE /catalogs/{org}/{catalog}/custom-theme/export/{task_id} If running, cancels a custom theme export task #
GET /catalogs/{org}/{catalog}/custom-theme/export/{task_id}/status Returns information about the status of this task #
POST /catalogs/{org}/{catalog}/custom-theme/import Create a task that imports an archive that contains the custom themes of a site #
DELETE /catalogs/{org}/{catalog}/custom-theme/import/{task_id} Cancels a running custom theme import task #
GET /catalogs/{org}/{catalog}/custom-theme/import/{task_id}/status Get the result of the custom theme import task #
POST /catalogs/{org}/{catalog}/custom-translation/export Create a task that exports an archive that contains the custom translation of a… #
GET /catalogs/{org}/{catalog}/custom-translation/export/{task_id} When ready, streams a custom translation export artifact #
DELETE /catalogs/{org}/{catalog}/custom-translation/export/{task_id} If running, cancels a custom translation export task #
GET /catalogs/{org}/{catalog}/custom-translation/export/{task_id}/status Returns information about the status of this task #
POST /catalogs/{org}/{catalog}/custom-translation/import Create a task that imports an archive that contains the custom translations of… #
DELETE /catalogs/{org}/{catalog}/custom-translation/import/{task_id} If running, cancels a custom translation import task #
GET /catalogs/{org}/{catalog}/custom-translation/import/{task_id}/status Get the result of the custom translation import task #
GET /catalogs/{org}/{catalog}/export-entity List export entities #
PUT /catalogs/{org}/{catalog}/export-entity Create an export entity #
GET /catalogs/{org}/{catalog}/export-entity/{export_entity_id} Get an export entity #
DELETE /catalogs/{org}/{catalog}/export-entity/{export_entity_id} Delete an export entity #
POST /catalogs/{org}/{catalog}/export-entity/{export_entity_id}/add-content Add content to an export entity #
POST /catalogs/{org}/{catalog}/export-entity/{export_entity_id}/remove-content Remove content from an export entity #
POST /catalogs/{org}/{catalog}/export-entity/{export_entity_id}/launch Launch a export entity #
GET /catalogs/{org}/{catalog}/export-entity/{task_id}/download When ready, streams a content export artifact generated from an export entity #
DELETE /catalogs/{org}/{catalog}/export-entity/{task_id}/delete If running, cancels a export entity launch export task #
GET /catalogs/{org}/{catalog}/export-entity/{task_id}/status Returns information about the status of this task #
GET /service/custom-webserver-page Get the HTML for a web server page #
DELETE /service/custom-webserver-page Delete the custom HTML for a web server page #
POST /service/custom-webserver-page Set a custom HTML page for a web server page type #
GET /catalogs/{org}/{catalog}/site/check Run a platform check against a portal site #
PUT /catalogs/{org}/{catalog}/site/content-refresh Triggers a site level content refresh of the Developer Portal configuration… #
GET /catalogs/{org}/{catalog}/site/content-refresh/status Gets the status of the latest site level content refresh of the Developer Portal #
POST /catalogs/{org}/{catalog}/site/export Create a task that exports an archive that contains the entire make-up of a site #
GET /catalogs/{org}/{catalog}/site/export/{task_id} When ready, streams a site export artifact #
DELETE /catalogs/{org}/{catalog}/site/export/{task_id} If running, cancels a site export task #
GET /catalogs/{org}/{catalog}/site/export/{task_id}/status Returns information about the status of this task #
POST /catalogs/{org}/{catalog}/site/import Create a task that imports an archive that contains the make-up of a site #
DELETE /catalogs/{org}/{catalog}/site/import/{task_id} If running, cancels a site import task #
GET /catalogs/{org}/{catalog}/site/import/{task_id}/status Get the result of the site import task #
GET /catalogs/{org}/{catalog}/site/state Obtain the current state of a portal site #
GET /catalogs/{org}/{catalog}/entity/count Shows a count of entities from a site #
POST /catalogs/{org}/{catalog}/forums/disable Disable the forum module for a given site #
POST /catalogs/{org}/{catalog}/forums/enable Enable the forum module for a given site #
GET /catalogs/{org}/{catalog}/security/clearbans Clear all bans for a site #
GET /catalogs/{org}/{catalog}/drupal-config Get the Config object #
DELETE /catalogs/{org}/{catalog}/drupal-config Delete the Config object #
POST /catalogs/{org}/{catalog}/drupal-config Set a config value #
GET /catalogs/{org}/{catalog}/drupal-config/list List the config names by prefix #
GET /catalogs/{org}/{catalog}/drupal-state Get the State key #
DELETE /catalogs/{org}/{catalog}/drupal-state Delete the State key #
POST /catalogs/{org}/{catalog}/drupal-state Set a state key value #
GET /catalogs/{org}/{catalog}/maintenance/status Gets the maintenance mode for the given Developer Portal #
PUT /catalogs/{org}/{catalog}/maintenance/enable Enables maintenance mode for the given Developer Portal #
PUT /catalogs/{org}/{catalog}/maintenance/disable Disables maintenance mode for the given Developer Portal #
GET /catalogs/{org}/{catalog}/maintenance/search-api-index-status Prints the search API index status for a Developer Portal #
PUT /catalogs/{org}/{catalog}/maintenance/rebuild-node-access Rebuilds the node access table for a Developer Portal #
PUT /catalogs/{org}/{catalog}/maintenance/search-api-index-rebuild Rebuilds and reindexes the search API index for a Developer Portal #
POST /catalogs/{org}/{catalog}/site-config/export Create a task that exports an archive that contains the configuration of a site #
GET /catalogs/{org}/{catalog}/site-config/export/{task_id} When ready, streams a site configuration export artifact #
DELETE /catalogs/{org}/{catalog}/site-config/export/{task_id} If running, cancels a site configuration export task #
GET /catalogs/{org}/{catalog}/site-config/export/{task_id}/status Returns information about the status of this task #
POST /catalogs/{org}/{catalog}/site-config/import Create a task that imports an archive that contains the configuration of a site #
DELETE /catalogs/{org}/{catalog}/site-config/import/{task_id} Cancels a running site configuration import task #
GET /catalogs/{org}/{catalog}/site-config/import/{task_id}/status Get the result of the site configuration import task #
GET /catalogs/{org}/{catalog}/queue Shows queued and locked platform related tasks for a Developer Portal #
GET /service/backups/list List the backups present on the remote backup server #
GET /service/platforms/list List the platforms present on the portal service #
GET /catalogs/{org}/{catalog}/product/list Shows a list of products from a site #
GET /catalogs/{org}/{catalog}/product/get Get a specific product from a developer portal #
GET /catalogs/{org}/{catalog}/product/get-document Get a specific entire product document from a developer portal #
POST /catalogs/{org}/{catalog}/product/add-attachment Add an attachment for the given product #
POST /catalogs/{org}/{catalog}/product/add-tag Add a tag for the given product #
PUT /catalogs/{org}/{catalog}/product/set-icon Set an icon image for the given product #
GET /service/list List the Portal service #
PUT /service/content-refresh Triggers a cloud level content refresh of the Developer Portal Service… #
GET /service/sites/check Run a platform check against all portal sites present on a portal service #
GET /service/sites/list List the sites present on the Portal service #
PUT /service/sites/reset-upgrade-attempts Resets the Developer Portal site upgrade attempts #
DELETE /service/factory-reset Factory resets the Developer Portal #
POST /service/ip-security-enabled Enable or disable IP security functionality within the Developer Portal #
GET /service/queue/list Shows queued and locked platform related tasks across all Developer Portals #
GET /service/php-memory/list List the PHP memory limit on the platform #
POST /service/php-memory/update Set the PHP memory limit on the portal platform #
POST /service/ip-allowlist/add Add IP(s) to the allowlist #
POST /service/ip-allowlist/remove Remove IP(s) from the allowlist #
DELETE /service/ip-allowlist Remove all IPs from the allowlist #
GET /service/ip-allowlist/list List IP(s) currently on the allowlist #
GET /catalogs/{org}/{catalog}/modules/list Shows a list of available modules #
POST /catalogs/{org}/{catalog}/modules/enable Enable one or more module #
POST /catalogs/{org}/{catalog}/modules/disable Disable one or more modules and their dependent modules #
DELETE /catalogs/{org}/{catalog}/modules/delete Deletes one or more modules #
GET /catalogs/{org}/{catalog}/role Get a role defined on the site #
POST /catalogs/{org}/{catalog}/role Create a new role #
DELETE /catalogs/{org}/{catalog}/role Delete a role #
POST /catalogs/{org}/{catalog}/role/permission Grant specified permission(s) to a role #
DELETE /catalogs/{org}/{catalog}/role/permission Remove specified permission(s) from a role #
GET /catalogs/{org}/{catalog}/role/list Display a list of all roles defined on the system. #
POST /catalogs/{org}/{catalog}/site/cache-rebuild Rebuilds the cache of a specific Portal site #
GET /catalogs/{org}/{catalog}/themes/list Shows a list of available themes #
POST /catalogs/{org}/{catalog}/themes/enable Enable one or more theme #
POST /catalogs/{org}/{catalog}/themes/disable Disable one or more themes #
DELETE /catalogs/{org}/{catalog}/themes/delete Deletes one or more themes #
POST /catalogs/{org}/{catalog}/themes/set-default Set a portal's default theme #
GET /catalogs/{org}/{catalog}/memcache Gets the memcache enabled status on a specific Developer Portal site #
PUT /catalogs/{org}/{catalog}/memcache/enable Enables memcache on a specific Developer Portal site #
PUT /catalogs/{org}/{catalog}/memcache/disable Disables memcache on a specific Developer Portal site #
POST /catalogs/{org}/{catalog}/twig/debug-enable Enables twig debugging on a specific Portal site #
POST /catalogs/{org}/{catalog}/twig/debug-disable Disable twig debugging on a specific Portal site #
GET /catalogs/{org}/{catalog}/twig/debug-status Shows the current state of twig debugging of a specific Portal site #
POST /catalogs/{org}/{catalog}/user/role Add a singular or multiple roles to the specified Drupal User accounts #
DELETE /catalogs/{org}/{catalog}/user/role Remove a singular or multiple roles from the specified Drupal User accounts #
POST /catalogs/{org}/{catalog}/user/block Block a Developer Portal Drupal User #
POST /catalogs/{org}/{catalog}/user/unblock Unblock a Developer Portal Drupal User #
GET /catalogs/{org}/{catalog}/user/information Gets Developer Portal Drupal User information #

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://raw.githubusercontent.com/api-evangelist/ibm-api-connect/refs/heads/main/openapi/ibm-api-connect-portal-api-openapi.yml

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-portal-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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-portal-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Ibm Api Connect Portal API
  contact:
    name: IBM
    url: https://www.ibm.com
    email: help@ibm.com
  license:
    name: tbd
    url: https://tbd.com
  x-refined-note:
  - x-ibm-name differs across the merged source definitions and was not carried
  version: '1.0'
  description: 'Operations tagged Portal across 2 of this provider''s published API definitions: ibm-api-connect-consumer-api-openapi.yml, ibm-api-connect-portal-admin-api-openapi.yml. Each path carries the servers of the definition it was published in.'
tags:


# --- truncated at 32 KB (268 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/ibm-api-connect/refs/heads/main/openapi/ibm-api-connect-portal-api-openapi.yml