# IBM API Connect Cloud Settings API

**Canonical:** https://apis.io/apis/ibm-api-connect/ibm-api-connect-cloud-settings-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 Cloud Settings 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 Cloud Settings. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, a getting-started guide, and authentication docs.

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

## Operations (60 of 66)

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

…and 6 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-cloud-settings-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

Cloud Settings

---

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