IBM API Connect

IBM API Connect Settings API

The Settings API from IBM API Connect — 2 operation(s) for settings.

Documentation GitHub OpenAPI

Operations 2

GET /settings Get the Setting object #

GET /settings/consumer-catalog-enabled Return true or false based on if consumer catalog is enabled or not #

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-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

openapi: 3.2.0
info:
  x-ibm-name: consumer
  version: 2.0.0
  title: IBM API Connect Platform - Consumer Settings API
  description: This API provides operations for accessing API consumer content
  termsOfService: https://www.ibm.com/legal
  contact:
    name: IBM
    url: https://www.ibm.com
    email: help@ibm.com
  license:
    name: tbd
    url: https://tbd.com
servers:
- url: ''
  description: Consumer apim base path
tags:
- name: Settings
paths:
  /settings:
    description: Setting object operations
    get:
      summary: Get the Setting object
      operationId: setting_singletonGet
      parameters:
      - $ref: '#/components/parameters/fields'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Setting'
            application/yaml:
              schema:
                $ref: '#/components/schemas/Setting'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
      tags:
      - Settings
  /settings/consumer-catalog-enabled:
    get:
      summary: Return true or false based on if consumer catalog is enabled or not
      description: Return true or false based on if consumer catalog is enabled or not.
      operationId: setting_consumerCatalogEnabled
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConsumerCatalogEnabled'
            application/yaml:
              schema:
                $ref: '#/components/schemas/ConsumerCatalogEnabled'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
      tags:
      - Settings
components:
  schemas:
    Error:
      type: object
      additionalProperties: false
      properties:
        status:
          type: integer
          minimum: 400
          maximum: 599
        message:
          type: array
          items:
            type: string
        errors:
          type: array
          items:
            type: string
    Setting:
      type: object
      additionalProperties: false
      properties:
        consumer_catalog_enabled:
          type: boolean
        consumer_self_service_onboarding:
          type: boolean
        consumer_org_invitations_enabled:
          type: boolean
        consumer_org_invitation_roles:
          type: array
          items:
            type: string
            enum:
            - administrator
            - developer
            - viewer
        consumer_analytics:
          type: boolean
        postman_setting:
          type: object
          additionalProperties: false
          properties:
            enabled:
              type: boolean
    ConsumerCatalogEnabled:
      type: object
      additionalProperties: false
      properties:
        consumer_catalog_enabled:
          type: boolean
  parameters:
    fields:
      name: fields
      in: query
      description: field name
      required: false
      schema:
        type: string
  responses:
    Error:
      description: Unexpected error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
        application/yaml:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    oauth:
      type: oauth2
      flows:
        password:
          tokenUrl: /token
          refreshUrl: /token
          scopes:
            app:manage: Create a Application object, Clear the Application objects, Update the Application object by name or id, Delete the Application object by name or id, Create a Application Credential object, Clear the Application Credential objects, Update the Application Credential object by name or id, Delete the Application Credential object by name or id, Create a Subscription object, Clear the Subscription objects, Update the Subscription object by name or id, Delete the Subscription object by name or id
            app:view: List the Application objects, Get the Application object by name or id, List the Application Credential objects, Get the Application Credential object by name or id, List the Subscription objects, Get the Subscription object by name or id
            my:manage: Update the Me object, Delete the Me object
            my:view: Get the Me object, List the My Permission objects, List the My Organization objects
            org:manage: Create a My Organization object, Update the Organization object by name or id, Delete the Organization object by name or id, Create a Member Invitation object, Clear the Member Invitation objects, Delete the Member Invitation object by name or id, Clear the Member objects, Update the Member object by name or id, Delete the Member object by name or id, Create a Payment Method object, Update the Payment Method object by name or id, Delete the Payment Method object by name or id
            org:view: List all Permission objects in all collections, Get the Organization object by name or id, Get the Group object by name or id, List the Member Invitation objects, Get the Member Invitation object by name or id, List the User Registry objects, Get the User Registry object by name or id, Get the User object by name or id, List the Associate objects, Get the Associate object by name or id, List the Member objects, Get the Member object by name or id, List the Role objects, Get the Role object by name or id, Get the Billing object by name or id, List the Billing objects, List the Payment Method objects, Get the Payment Method object by name or id, List the Payment Method Type objects, Get the Payment Method Type object by name or id
        authorizationCode:
          authorizationUrl: /oauth2/authorize
          tokenUrl: /token
          refreshUrl: /token
          scopes:
            app:manage: Create a Application object, Clear the Application objects, Update the Application object by name or id, Delete the Application object by name or id, Create a Application Credential object, Clear the Application Credential objects, Update the Application Credential object by name or id, Delete the Application Credential object by name or id, Create a Subscription object, Clear the Subscription objects, Update the Subscription object by name or id, Delete the Subscription object by name or id
            app:view: List the Application objects, Get the Application object by name or id, List the Application Credential objects, Get the Application Credential object by name or id, List the Subscription objects, Get the Subscription object by name or id
            my:manage: Update the Me object, Delete the Me object
            my:view: Get the Me object, List the My Permission objects, List the My Organization objects
            org:manage: Create a My Organization object, Update the Organization object by name or id, Delete the Organization object by name or id, Create a Member Invitation object, Clear the Member Invitation objects, Delete the Member Invitation object by name or id, Clear the Member objects, Update the Member object by name or id, Delete the Member object by name or id, Create a Payment Method object, Update the Payment Method object by name or id, Delete the Payment Method object by name or id
            org:view: List all Permission objects in all collections, Get the Organization object by name or id, Get the Group object by name or id, List the Member Invitation objects, Get the Member Invitation object by name or id, List the User Registry objects, Get the User Registry object by name or id, Get the User object by name or id, List the Associate objects, Get the Associate object by name or id, List the Member objects, Get the Member object by name or id, List the Role objects, Get the Role object by name or id, Get the Billing object by name or id, List the Billing objects, List the Payment Method objects, Get the Payment Method object by name or id, List the Payment Method Type objects, Get the Payment Method Type object by name or id
x-ibm-configuration:
  testable: false