• Introduction
  • Concepts
  • Authentication
  • Members
  • IBM API Connect Platform - Cloud Management API 2.0.0
    • Overview

    • Logging Specification

    • Resource: Log Spec

    • User Management

    • Resource: User Registry

    • Resource: User

    • Resource: Access Token (User Scope)

    • Oauth2 Action

    • Resource: OAuth2 Redirect

    • Resource: Oauth2 Authorization Request

    • Cloud Settings

    • Resource: Cloud Setting

    • Resource: User Registry Setting

    • Resource: Notification Style (Cloud Scope)

    • Resource: Notification Template (Cloud Scope) (All Subcollections)

    • Resource: Notification Template (Cloud Scope) (Cloud Subcollection)

    • Resource: Notification Template (Cloud Scope) (Admin Subcollection)

    • Resource: Notification Template (Cloud Scope) (Provider Subcollection)

    • Resource: Notification Template (Cloud Scope) (Catalog Subcollection)

    • Resource: Notification Template (Cloud Scope) (Space Subcollection)

    • Resource: Notification Template (Cloud Scope) (Consumer Subcollection)

    • Resource: Role Default (Cloud Scope) (All Subcollections)

    • Resource: Role Default (Cloud Scope) (Provider Subcollection)

    • Resource: Role Default (Cloud Scope) (Consumer Subcollection)

    • Cloud Management

    • Resource: Integration (All Subcollections)

    • Resource: Integration (Billing Subcollection)

    • Resource: Integration (PaymentMethod Subcollection)

    • Resource: Integration (UserRegistry Subcollection)

    • Resource: Integration (GatewayService Subcollection)

    • Resource: Registration

    • Resource: API Key

    • Organization Settings

    • Resource: Organization Setting

    • Resource: Notification Template (Org Scope) (All Subcollections)

    • Resource: Notification Template (Org Scope) (Admin Subcollection)

    • Organization Management

    • Resource: Organization

    • Resource: Associate (Org Scope)

    • Resource: Member Invitation (Org Scope)

    • Resource: Member (Org Scope)

    • Resource: Permission (All Subcollections)

    • Resource: Permission (Org Subcollection)

    • Resource: Permission (Cloud Subcollection)

    • Resource: Permission (Provider Subcollection)

    • Resource: Permission (Consumer Subcollection)

    • Resource: Permission (Deployment Subcollection)

    • Resource: Role (Org Scope)

    • Organization Resources

    • Resource: Availability Zone

    • Resource: Gateway Service

    • Resource: Policy by Id (Org Scope)

    • Resource: Extension by Id (Org Scope)

    • Resource: Gateway Extension (Org Scope)

    • Resource: Portal Service

    • Resource: Analytics Service

    • Resource: Opentelemetry

    • Resource: Oauth Provider

    • Resource: Mail Server

    • Resource: TLS Server Profile by Id

    • Resource: TLS Client Profile by Id

    • Resource: Keystore

    • Resource: Truststore

    • Resource: Entry (Truststore Scope)

    • Resource: Jwk Set

    • Provider Management

    • Resource: Organization Invitation (Org Scope)

    • Resource: Group (Cloud Scope)

    • My Resources

    • Resource: Me

    • Resource: My Permission

    • Resource: My Organization

    • Webhooks

    • Resource: Webhook (Cloud Scope)

    • Resource: Primary Event (Cloud Scope)

    • Resource: Primary Event (GatewayService Scope)

    • Resource: Primary Event (PortalService Scope)

    • Resource: Subscriber Event (Cloud Scope)

    • Resource: Task Queue (Cloud Scope)

    • Resource Service Status

    • Resource: Resource Service Status

    • Definitions
  • IBM API Connect Platform - Provider API 2.0.0
  • IBM API Connect Platform - Consumer API 2.0.0
  • IBM API Connect Analytics API 2.0.0
  • IBM API Connect Consumer Analytics API 2.0.0
  • IBM API Connect Engagement API 2.0.0
  • API Connect Portal Admin API 1.0.0

Open API Explorer Documentation v10.0.LATEST

Introduction

The platform REST APIs documented here for IBM API Connect v10 provide complete access to the capability of the platform. They may be used to automate administration of the platform; for scripts and tools to support a continuous integration environment for API development and publishing; and for management of catalogs of APIs and their subscribers. The operations provided in the REST API also correspond directly with commands in the toolkit CLI.

APIs

The capability of the platform is comprised of three APIs which are oriented at different sets of use cases:

IBM API Connect Platform - Cloud Management API

2.0.0
This API provides operations for managing the IBM API Connect cloud configuration.

IBM API Connect Platform - Provider API

2.0.0
This API provides operations for accessing API provider capability.

IBM API Connect Platform - Consumer API

2.0.0
This API provides operations for accessing API consumer content

IBM API Connect Analytics API

2.0.0
API for the API Connect Analytics subsystem

IBM API Connect Consumer Analytics API

2.0.0
API for the API Connect Consumer Analytics dashboard

IBM API Connect Engagement API

2.0.0
API for the API Connect Engagement system

API Connect Portal Admin API

1.0.0
API for the API Connect Portal Admin subsystem