IBM API Connect

IBM API Connect Engagement API

Manages engagement configuration and rules evaluated against API Connect Analytics data for a provider organization. OpenAPI 3.0, version 2.0.0.

GitHub OpenAPI

Operations 62

GET /{analytics-service}/orgs/{org}/engagement-config Engagement configuration supported at provider organization scope #
GET /{analytics-service}/orgs/{org}/anomaly-detectors List anomaly detectors at provider organization scope #
POST /{analytics-service}/orgs/{org}/anomaly-detectors Create an anomaly detector at provider organization scope #
POST /{analytics-service}/orgs/{org}/anomaly-detectors/templates/{detector-type} Create an anomaly detector from a template #
POST /{analytics-service}/orgs/{org}/anomaly-detectors/validate/model Validate anomaly detector configuration #
GET /{analytics-service}/orgs/{org}/anomaly-detectors/{detector-id} Get an anomaly detector #
PUT /{analytics-service}/orgs/{org}/anomaly-detectors/{detector-id} Update an anomaly detector #
DELETE /{analytics-service}/orgs/{org}/anomaly-detectors/{detector-id} Delete an anomaly detector #
POST /{analytics-service}/orgs/{org}/anomaly-detectors/{detector-id}/start Start an anomaly detector #
POST /{analytics-service}/orgs/{org}/anomaly-detectors/{detector-id}/stop Stop an anomaly detector #
GET /{analytics-service}/orgs/{org}/rules List rules at provider organization scope #
POST /{analytics-service}/orgs/{org}/rules Create a rule at provider organization scope #
GET /{analytics-service}/orgs/{org}/rules/{rule-id} Get an engagement rule #
PUT /{analytics-service}/orgs/{org}/rules/{rule-id} Update an engagement rule #
DELETE /{analytics-service}/orgs/{org}/rules/{rule-id} Delete an engagement rule #
GET /{analytics-service}/orgs/{org}/tasks List tasks for an engagement rule at provider organization scope #
GET /{analytics-service}/orgs/{org}/rules/total-count Returns the total count of all engagement rules within a specific organization #
GET /{analytics-service}/orgs/{org}/tasks/{task-id} Get an engagement task #
GET /{analytics-service}/orgs/{org}/destinations List destinations at provider organization scope #
POST /{analytics-service}/orgs/{org}/destinations Create a destination at provider organization scope #
GET /{analytics-service}/orgs/{org}/destinations/{destination-id} Get an engagement destination #
PUT /{analytics-service}/orgs/{org}/destinations/{destination-id} Update an engagement destination #
DELETE /{analytics-service}/orgs/{org}/destinations/{destination-id} Delete an engagement destination #
GET /{analytics-service}/orgs/{org}/destinations/{destination-id}/test Test an engagement destination #
POST /{analytics-service}/orgs/{org}/notifications Create a Jira ticket notification at provider organization scope #
GET /{analytics-service}/orgs/{org}/scheduled-reports List scheduled reports at provider organization scope #
POST /{analytics-service}/orgs/{org}/scheduled-reports Create a scheduled report at provider organization scope #
GET /{analytics-service}/orgs/{org}/scheduled-reports/{scheduledreport-id} Get a scheduled report #
PUT /{analytics-service}/orgs/{org}/scheduled-reports/{scheduledreport-id} Update a scheduled report #
DELETE /{analytics-service}/orgs/{org}/scheduled-reports/{scheduledreport-id} Delete a scheduled report #
GET /{analytics-service}/catalogs/{org}/{catalog}/engagement-config Engagement configuration supported at catalog scope #
GET /{analytics-service}/catalogs/{org}/{catalog}/rules List rules at catalog scope #
POST /{analytics-service}/catalogs/{org}/{catalog}/rules Create a rule at catalog scope #
GET /{analytics-service}/catalogs/{org}/{catalog}/rules/total-count Returns the total count of all engagement rules within a specific catalog #
GET /{analytics-service}/catalogs/{org}/{catalog}/rules/{rule-id} Get an engagement rule #
PUT /{analytics-service}/catalogs/{org}/{catalog}/rules/{rule-id} Update an engagement rule #
DELETE /{analytics-service}/catalogs/{org}/{catalog}/rules/{rule-id} Delete an engagement rule #
GET /{analytics-service}/catalogs/{org}/{catalog}/tasks List tasks for an engagement rule at catalog scope #
GET /{analytics-service}/catalogs/{org}/{catalog}/tasks/{task-id} Get an engagement task #
GET /{analytics-service}/catalogs/{org}/{catalog}/destinations List destinations at catalog scope #
POST /{analytics-service}/catalogs/{org}/{catalog}/destinations Create a destination at catalog scope #
GET /{analytics-service}/catalogs/{org}/{catalog}/destinations/{destination-id} Get an engagement destination #
PUT /{analytics-service}/catalogs/{org}/{catalog}/destinations/{destination-id} Update an engagement destination #
DELETE /{analytics-service}/catalogs/{org}/{catalog}/destinations/{destination-id} Delete an engagement destination #
GET /{analytics-service}/catalogs/{org}/{catalog}/destinations/{destination-id}/test Test an engagement destination #
GET /{analytics-service}/catalogs/{org}/{catalog}/scheduled-reports List scheduled reports at catalog scope #
POST /{analytics-service}/catalogs/{org}/{catalog}/scheduled-reports Create a scheduled report at catalog scope #
GET /{analytics-service}/catalogs/{org}/{catalog}/scheduled-reports/{scheduledreport-id} Get a scheduled report #
PUT /{analytics-service}/catalogs/{org}/{catalog}/scheduled-reports/{scheduledreport-id} Update a scheduled report #
DELETE /{analytics-service}/catalogs/{org}/{catalog}/scheduled-reports/{scheduledreport-id} Delete a scheduled report #
GET /{analytics-service}/cloud/engagement-config Engagement configuration supported at cloud scope #
GET /{analytics-service}/cloud/scheduled-reports List scheduled reports at cloud scope #
POST /{analytics-service}/cloud/scheduled-reports Create a scheduled report at cloud scope #
GET /{analytics-service}/cloud/scheduled-reports/{scheduledreport-id} Get a scheduled report #
PUT /{analytics-service}/cloud/scheduled-reports/{scheduledreport-id} Update a scheduled report #
DELETE /{analytics-service}/cloud/scheduled-reports/{scheduledreport-id} Delete a scheduled report #
GET /{analytics-service}/cloud/destinations List destinations at cloud scope #
POST /{analytics-service}/cloud/destinations Create a destination at cloud scope #
GET /{analytics-service}/cloud/destinations/{destination-id} Get an engagement destination #
PUT /{analytics-service}/cloud/destinations/{destination-id} Update an engagement destination #
DELETE /{analytics-service}/cloud/destinations/{destination-id} Delete an engagement destination #
GET /{analytics-service}/cloud/destinations/{destination-id}/test Test an engagement destination #

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://artifacts.apis.io/ibm-api-connect/openapi/ibm-api-connect-engagement-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/ibm-api-connect/json-schema/ibm-api-connect-notification-create-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/ibm-api-connect/json-schema/ibm-api-connect-anomaly-detector-create-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/ibm-api-connect/json-schema/ibm-api-connect-anomaly-detector-template-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/ibm-api-connect/json-schema/ibm-api-connect-anomaly-detector-update-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/ibm-api-connect/json-schema/ibm-api-connect-scheduled-report-create-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/ibm-api-connect/json-schema/ibm-api-connect-scheduled-report-update-request-schema.json

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

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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-engagement-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  x-ibm-name: engagement
  version: 2.0.0
  title: IBM API Connect Engagement API
  x-ibm-summary: API for the API Connect Engagement system
  description: '## API for the API Connect Engagement system'
  termsOfService: https://www.ibm.com/terms-of-service
  contact:
    name: IBM
    url: https://www.ibm.com
    email: help@ibm.com
servers:
- url: ''
  description: Engagement V2 base path
tags:


# --- truncated at 32 KB (101 KB total) ---
# Full source: https://artifacts.apis.io/ibm-api-connect/openapi/ibm-api-connect-engagement-api-openapi.yml