IBM API Connect · API Governance Rules

IBM API Connect API Rules

Spectral linting rules defining API design standards and conventions for IBM API Connect.

0 Rules
Authorship not recorded No authorship marker is recorded for this file. It is not presented as the provider's; it was most likely written by an API Evangelist pass before outputs were stamped.
View Rules File View on GitHub

Spectral Ruleset

Raw ↑ 
x-aid: ibm-api-connect:ibm-api-connect-rules
x-name: IBM API Connect Rules
description: >-
  Governance and operational rules for the IBM API Connect API artifacts
  maintained in this repository.
x-tags:
  - Governance
  - Rules
  - IBM
  - API Connect
rules:
  - name: Specification Format
    description: >-
      All API descriptions in this repository must use OpenAPI 3.0 or later in
      YAML format and live under the openapi/ directory; legacy Swagger 2.0
      sources from IBM should be converted before being committed.
  - name: Authentication
    description: >-
      The v12 platform REST APIs require a bearer token from the /api/token
      endpoint (/consumer-api/token for consumer calls), requested with an
      app client_id and client_secret plus a platform API key or user
      credentials. Consumer API calls also need the X-IBM-Consumer-Context
      header. Anonymous access is limited to public portal content.
  - name: Backward Compatibility
    description: >-
      Profiles track the current v12 platform REST APIs (version 2.0.0, Portal
      Admin 1.0.0). Retired IBM Cloud-era APIs such as the V1 API are not
      listed; new integrations should target the v12 APIs.
  - name: Environment URLs
    description: >-
      There is no shared public host. Each API Connect instance, SaaS or
      self-managed, has its own platform, consumer, governance and discovery
      endpoints, listed in the toolkit credentials.json downloaded from API
      Manager. On SaaS the hosts vary by region, for example
      platform-api.us-east-b.apiconnect.automation.ibm.com; self-managed
      deployments use whatever hosts the customer configured. Base URLs in
      apis.yml are templates to fill with those values, and IBM publishes the
      specs with an empty servers URL for the same reason.
  - name: Versioning
    description: >-
      API artifacts should track the API Connect v12 API Explorer
      (https://apic-api.apiconnect.ibmcloud.com/v12/) and be refreshed when IBM
      publishes a new revision. The OpenAPI files under openapi/ are YAML
      conversions of the JSON specs listed in
      https://apic-api.apiconnect.ibmcloud.com/v12/12.1.LATEST/openapi/index.json.
  - name: APIs.yml Sync
    description: >-
      The apis.yml index in this repository must reference all OpenAPI files
      under openapi/ and be updated when artifacts change.
x-maintainers:
  - FN: Kin Lane
    email: kin@apievangelist.com

Work with this as data

Every ruleset 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 spectral rules

4 MCP tools reach this
  • find_rulesBrowse and filter every ruleset in the catalog.
  • 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 ruleset 
curl "https://apis.io/api/v1/rules/ibm-api-connect-rules"
All spectral rules 
curl "https://apis.io/api/v1/rules?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.