# IBM API Connect Portal API

**Canonical:** https://apis.io/apis/ibm-api-connect/ibm-api-connect-portal-api/  
**Provider:** IBM API Connect — https://apis.io/providers/ibm-api-connect/  
**Base URL:** https://{platform-api-endpoint}/api  
**Documentation:** https://apic-api.apiconnect.ibmcloud.com/v12/

IBM API Connect Portal API is one of 43 APIs that [IBM API Connect](https://apis.io/providers/ibm-api-connect/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Portal. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, a getting-started guide, and authentication docs.

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

## Operations (60 of 145)

| Method | Path | Summary |
|---|---|---|
| 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 |

…and 85 more operations. They are listed in full on the page.

## Machine-readable artifacts (5)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/ibm-api-connect/refs/heads/main/openapi/ibm-api-connect-portal-api-openapi.yml
- **Reference** — https://apic-api.apiconnect.ibmcloud.com/v12/
- **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

## Other IBM API Connect APIs (12)

- [IBM API Connect Platform - Cloud Management API](https://apis.io/apis/ibm-api-connect/ibm-api-connect-cloud-management-api/)
- [IBM API Connect Analytics API](https://apis.io/apis/ibm-api-connect/ibm-api-connect-analytics-api/)
- [IBM API Connect Consumer Analytics API](https://apis.io/apis/ibm-api-connect/ibm-api-connect-consumer-analytics-api/)
- [IBM API Connect Engagement API](https://apis.io/apis/ibm-api-connect/ibm-api-connect-engagement-api/)
- [IBM API Connect Discovery API](https://apis.io/apis/ibm-api-connect/ibm-api-connect-discovery-api/)
- [IBM API Connect AI Assets API](https://apis.io/apis/ibm-api-connect/ibm-api-connect-ai-assets-api/)
- [IBM API Connect Application Strategy management API](https://apis.io/apis/ibm-api-connect/ibm-api-connect-application-strategy-management-api/)
- [IBM API Connect Billing Management API](https://apis.io/apis/ibm-api-connect/ibm-api-connect-billing-management-api/)
- [IBM API Connect Catalog Management API](https://apis.io/apis/ibm-api-connect/ibm-api-connect-catalog-management-api/)
- [IBM API Connect Catalog Resource API](https://apis.io/apis/ibm-api-connect/ibm-api-connect-catalog-resource-api/)
- [IBM API Connect Catalog Resources API](https://apis.io/apis/ibm-api-connect/ibm-api-connect-catalog-resources-api/)
- [IBM API Connect Catalog Settings API](https://apis.io/apis/ibm-api-connect/ibm-api-connect-catalog-settings-api/)

## Tags

Portal

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/ibm-api-connect/ibm-api-connect-portal-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/ibm-api-connect/.