IBM API Connect

IBM API Connect Cloud Settings API

The Cloud Settings API from IBM API Connect — 47 operation(s) for cloud settings.

GitHub OpenAPI

Operations 66

GET /cloud/settings Get the Cloud Setting object #
PUT /cloud/settings Update the Cloud Setting object #
POST /cloud/settings/audit-endpoint/test-connection Test an audit endpoint connection #
POST /cloud/settings/apicp-endpoint/test-connection Test an API Control Plane endpoint connection #
GET /cloud/info Return public information about the cloud deployment #
GET /cloud/about Return information about the cloud #
GET /cloud/topology Return the topology of the cloud for governance #
GET /cloud/settings/mail-server-configured Return true or false based on if mail server is configured or not #
GET /cloud/settings/toolkit-credentials List credential for toolkit, consumer toolkit, governance, and discovery toolkit #
GET /cloud/settings/designer-credentials List credential for designer #
GET /cloud/settings/transition-helper-credentials List credential for transition-helper #
GET /cloud/oauth2/certs Support JWKS_URI endpoint, conform to OIDC specification #
GET /cloud/settings/user-registries Get the User Registry Setting object #
PUT /cloud/settings/user-registries Update the User Registry Setting object #
GET /cloud/settings/notification-style Get the Notification Style object #
PUT /cloud/settings/notification-style Update the Notification Style object #
GET /cloud/settings/notification-templates List all Notification Template objects in all collections #
GET /cloud/settings/notification-templates/cloud List the Notification Template objects #
GET /cloud/settings/notification-templates/cloud/{notification-template} Get the Notification Template object by name or id #
PATCH /cloud/settings/notification-templates/cloud/{notification-template} Update the Notification Template object by name or id #
GET /cloud/settings/notification-templates/cloud/{notification-template}/notification-languages List the Notification language objects #
GET /cloud/settings/notification-templates/cloud/{notification-template}/notification-languages/{notification-language} Get the Notification template language by name or id #
PATCH /cloud/settings/notification-templates/cloud/{notification-template}/notification-languages/{notification-language} Update the Notification template language object #
GET /cloud/settings/notification-templates/admin List the Notification Template objects #
GET /cloud/settings/notification-templates/admin/{notification-template} Get the Notification Template object by name or id #
PATCH /cloud/settings/notification-templates/admin/{notification-template} Update the Notification Template object by name or id #
GET /cloud/settings/notification-templates/admin/{notification-template}/notification-languages List the Notification language objects #
GET /cloud/settings/notification-templates/admin/{notification-template}/notification-languages/{notification-language} Get the Notification template language by name or id #
PATCH /cloud/settings/notification-templates/admin/{notification-template}/notification-languages/{notification-language} Update the Notification template language object #
GET /cloud/settings/notification-templates/provider List the Notification Template objects #
GET /cloud/settings/notification-templates/provider/{notification-template} Get the Notification Template object by name or id #
PATCH /cloud/settings/notification-templates/provider/{notification-template} Update the Notification Template object by name or id #
GET /cloud/settings/notification-templates/provider/{notification-template}/notification-languages List the Notification language objects #
GET /cloud/settings/notification-templates/provider/{notification-template}/notification-languages/{notification-language} Get the Notification template language by name or id #
PATCH /cloud/settings/notification-templates/provider/{notification-template}/notification-languages/{notification-language} Update the Notification template language object #
GET /cloud/settings/notification-templates/catalog List the Notification Template objects #
GET /cloud/settings/notification-templates/catalog/{notification-template} Get the Notification Template object by name or id #
PATCH /cloud/settings/notification-templates/catalog/{notification-template} Update the Notification Template object by name or id #
GET /cloud/settings/notification-templates/catalog/{notification-template}/notification-languages List the Notification language objects #
GET /cloud/settings/notification-templates/catalog/{notification-template}/notification-languages/{notification-language} Get the Notification template language by name or id #
PATCH /cloud/settings/notification-templates/catalog/{notification-template}/notification-languages/{notification-language} Update the Notification template language object #
GET /cloud/settings/notification-templates/space List the Notification Template objects #
GET /cloud/settings/notification-templates/space/{notification-template} Get the Notification Template object by name or id #
PATCH /cloud/settings/notification-templates/space/{notification-template} Update the Notification Template object by name or id #
GET /cloud/settings/notification-templates/space/{notification-template}/notification-languages List the Notification language objects #
GET /cloud/settings/notification-templates/space/{notification-template}/notification-languages/{notification-language} Get the Notification template language by name or id #
PATCH /cloud/settings/notification-templates/space/{notification-template}/notification-languages/{notification-language} Update the Notification template language object #
GET /cloud/settings/notification-templates/consumer List the Notification Template objects #
GET /cloud/settings/notification-templates/consumer/{notification-template} Get the Notification Template object by name or id #
PATCH /cloud/settings/notification-templates/consumer/{notification-template} Update the Notification Template object by name or id #
GET /cloud/settings/notification-templates/consumer/{notification-template}/notification-languages List the Notification language objects #
GET /cloud/settings/notification-templates/consumer/{notification-template}/notification-languages/{notification-language} Get the Notification template language by name or id #
PATCH /cloud/settings/notification-templates/consumer/{notification-template}/notification-languages/{notification-language} Update the Notification template language object #
GET /cloud/settings/role-defaults List all Role Default objects in all collections #
POST /cloud/settings/role-defaults/provider Create a Role Default object #
GET /cloud/settings/role-defaults/provider List the Role Default objects #
DELETE /cloud/settings/role-defaults/provider Clear the Role Default objects #
GET /cloud/settings/role-defaults/provider/{role-default} Get the Role Default object by name or id #
PATCH /cloud/settings/role-defaults/provider/{role-default} Update the Role Default object by name or id #
DELETE /cloud/settings/role-defaults/provider/{role-default} Delete the Role Default object by name or id #
GET /cloud/settings/role-defaults/consumer List the Role Default objects #
GET /cloud/settings/role-defaults/consumer/{role-default} Get the Role Default object by name or id #
GET /cloud/data-sources List the Data Source objects across orgs #
POST /cloud/{org}/data-sources Create a Data Source object at Cloud Scope #
PATCH /cloud/{org}/data-sources/{data-source} Update the Data Source object by name or id for cloud #
GET /cloud/{org}/data-sources/limit Get remaining Data Source limit for cloud #

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-cloud-settings-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-cloud-settings-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-cloud-settings-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Ibm Api Connect Cloud Settings 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 Cloud Settings across 2 of this provider''s published API definitions: ibm-api-connect-cloud-management-api-openapi.yml, ibm-api-connect-discovery-api-openapi.yml. Each path carries the servers of the definition it was published in.'
tags:


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