IBM API Connect · Schema

PlanList

API GatewayAPI ManagementDeveloper PortalDeveloper ToolsIBM

Properties

Name Type Description
total_results integer
results array
View JSON Schema on GitHub

JSON Schema

ibm-api-connect-plan-list-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/ibm-api-connect/json-schema/ibm-api-connect-plan-list-schema.json",
  "title": "PlanList",
  "x-generated": "2026-10-29",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/ibm-api-connect-plans-and-quotas-api-openapi.yml#/components/schemas/PlanList",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "total_results": {
      "type": "integer"
    },
    "results": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/Plan"
      }
    }
  },
  "$defs": {
    "Plan": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "type": "string",
          "readOnly": true,
          "enum": [
            "plan"
          ]
        },
        "api_version": {
          "type": "string",
          "readOnly": true,
          "enum": [
            "2.0.0"
          ]
        },
        "id": {
          "type": "string",
          "readOnly": true
        },
        "name": {
          "type": "string",
          "maxLength": 255
        },
        "version": {
          "type": "string",
          "maxLength": 255
        },
        "title": {
          "type": "string",
          "maxLength": 1023
        },
        "summary": {
          "type": "string",
          "maxLength": 65535
        },
        "scope": {
          "type": "string"
        },
        "plan_kind": {
          "$ref": "#/$defs/ProjectPlan"
        },
        "org_url": {
          "type": "string",
          "format": "uri"
        },
        "catalog_url": {
          "type": "string",
          "format": "uri"
        },
        "space_urls": {
          "type": "array",
          "items": {
            "type": "string",
            "format": "uri"
          }
        },
        "quota_urls": {
          "type": "array",
          "items": {
            "type": "string",
            "format": "uri"
          }
        },
        "product_urls": {
          "type": "array",
          "items": {
            "type": "string",
            "format": "uri"
          }
        },
        "mcp_server_urls": {
          "type": "array",
          "items": {
            "type": "string",
            "format": "uri"
          }
        },
        "quotas_kind": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/ProjectQuota"
          }
        },
        "metadata": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        },
        "created_at": {
          "type": "string",
          "format": "date-time",
          "readOnly": true
        },
        "updated_at": {
          "type": "string",
          "format": "date-time",
          "readOnly": true
        },
        "url": {
          "type": "string",
          "readOnly": true,
          "format": "uri"
        }
      }
    },
    "ProjectMetadata": {
      "description": "Defines a message named Metadata",
      "type": "object",
      "required": [
        "name",
        "version"
      ],
      "additionalProperties": false,
      "properties": {
        "description": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "namespace": {
          "type": "string"
        },
        "tags": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "type": {
          "enum": [
            "REST",
            "SWAGGER",
            "SOAP",
            "GRAPHQL",
            "ODATA"
          ],
          "type": "string"
        },
        "version": {
          "type": "string"
        },
        "domain": {
          "enum": [
            "api",
            "ai-platform",
            "mcp"
          ],
          "type": "string"
        },
        "labels": {
          "type": "object",
          "additionalProperties": true,
          "properties": {
            "gatewayTypes": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "ProjectPlan": {
      "type": "object",
      "required": [
        "kind",
        "apiVersion",
        "metadata",
        "spec"
      ],
      "properties": {
        "apiVersion": {
          "type": "string"
        },
        "kind": {
          "enum": [
            "Plan"
          ],
          "type": "string"
        },
        "metadata": {
          "$ref": "#/$defs/ProjectMetadata"
        },
        "spec": {
          "type": "object",
          "properties": {
            "termsOfService": {
              "type": "string"
            },
            "license": {
              "type": "string"
            },
            "qos": {
              "type": "object",
              "required": [
                "withQuota"
              ],
              "properties": {
                "withQuota": {
                  "type": "object",
                  "properties": {
                    "unlimited": {
                      "type": "object"
                    }
                  },
                  "additionalProperties": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "$ref"
                      ],
                      "properties": {
                        "$ref": {
                          "type": "string"
                        }
                      }
                    }
                  }
                }
              }
            },
            "extensions": {
              "type": "object",
              "properties": {
                "webm-gateway": {
                  "type": "object",
                  "properties": {
                    "apiVersion": {
                      "type": "string"
                    },
                    "spec": {
                      "type": "object",
                      "properties": {
                        "pricing": {
                          "type": "object",
                          "properties": {
                            "value": {
                              "type": "number"
                            },
                            "currency": {
                              "type": "string"
                            }
                          },
                          "required": [
                            "value",
                            "currency"
                          ]
                        },
                        "withRateLimit": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "maxRequest": {
                                "type": "integer"
                              },
                              "interval": {
                                "type": "string"
                              },
                              "alertMessage": {
                                "type": "string"
                              },
                              "alertFrequency": {
                                "type": "string"
                              },
                              "name": {
                                "type": "string"
                              }
                            },
                            "required": [
                              "maxRequest",
                              "interval",
                              "name"
                            ]
                          }
                        }
                      }
                    }
                  }
                },
                "dp-nano-gateway": {
                  "type": "object",
                  "properties": {
                    "apiVersion": {
                      "type": "string"
                    },
                    "spec": {
                      "type": "object",
                      "properties": {
                        "isApprovalRequired": {
                          "type": "boolean"
                        },
                        "apis": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "$ref": {
                                "type": "string"
                              },
                              "operations": {
                                "type": "array",
                                "items": {
                                  "type": "object",
                                  "properties": {
                                    "id": {
                                      "type": "string"
                                    },
                                    "path": {
                                      "type": "string"
                                    },
                                    "method": {
                                      "type": "string"
                                    },
                                    "withQuota": {
                                      "oneOf": [
                                        {
                                          "type": "object",
                                          "additionalProperties": {
                                            "type": "array",
                                            "items": {
                                              "type": "object",
                                              "required": [
                                                "$ref"
                                              ],
                                              "properties": {
                                                "$ref": {
                                                  "type": "string"
                                                }
                                              }
                                            }
                                          }
                                        },
                                        {
                                          "type": "object",
                                          "additionalProperties": false,
                                          "required": [
                                            "unlimited"
                                          ],
                                          "properties": {
                                            "unlimited": {
                                              "type": "object"
                                            }
                                          }
                                        }
                                      ]
                                    }
                                  }
                                }
                              }
                            },
                            "required": [
                              "$ref"
                            ]
                          }
                        },
                        "withAssemblyCountLimit": {
                          "type": "object",
                          "additionalProperties": {
                            "type": "array",
                            "items": {
                              "type": "object",
                              "required": [
                                "$ref"
                              ],
                              "properties": {
                                "$ref": {
                                  "type": "string"
                                }
                              }
                            }
                          }
                        },
                        "properties": {
                          "type": "object",
                          "additionalProperties": {
                            "type": "string"
                          },
                          "description": "Arbitrary key-value pairs for custom properties"
                        },
                        "telemetry": {
                          "type": "object",
                          "additionalProperties": {
                            "type": "string"
                          }
                        }
                      }
                    }
                  }
                },
                "dp-gateway": {
                  "type": "object",
                  "properties": {
                    "apiVersion": {
                      "type": "string"
                    },
                    "spec": {
                      "type": "object",
                      "properties": {
                        "isApprovalRequired": {
                          "type": "boolean"
                        },
                        "withRateLimit": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "maxRequest": {
                                "type": "integer"
                              },
                              "interval": {
                                "type": "string"
                              },
                              "name": {
                                "type": "string"
                              }
                            },
                            "required": [
                              "maxRequest",
                              "interval",
                              "name"
                            ]
                          }
                        },
                        "withAssemblyCountLimit": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "name": {
                                "type": "string"
                              },
                              "maxRequest": {
                                "oneOf": [
                                  {
                                    "type": "integer"
                                  },
                                  {
                                    "type": "string"
                                  }
                                ]
                              },
                              "hard-limit": {
                                "type": "boolean"
                              },
                              "cache-only": {
                                "type": "boolean"
                              },
                              "is-client": {
                                "type": "boolean"
                              },
                              "use-api-name": {
                                "type": "boolean"
                              },
                              "use-app-id": {
                                "type": "boolean"
                              },
                              "use-client-id": {
                                "type": "boolean"
                              },
                              "dynamic-value": {
                                "type": "string"
                              },
                              "weight": {
                                "type": "string",
                                "pattern": ".+"
                              },
                              "auto-decrement": {
                                "type": "boolean"
                              }
                            },
                            "required": [
                              "name",
                              "maxRequest"
                            ]
                          }
                        },
                        "withAssemblyRateLimit": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "name": {
                                "type": "string"
                              },
                              "maxRequest": {
                                "type": "integer"
                              },
                              "interval": {
                                "type": "string"
                              },
                              "cache-only": {
                                "type": "boolean"
                              },
                              "is-client": {
                                "type": "boolean"
                              },
                              "use-api-name": {
                                "type": "boolean"
                              },
                              "use-app-id": {
                                "type": "boolean"
                              },
                              "use-client-id": {
                                "type": "boolean"
                              },
                              "dynamic-value": {
                                "type": "string"
                              },
                              "weight": {
                                "type": "string",
                                "pattern": ".+"
                              }
                            },
                            "required": [
                              "name",
                              "maxRequest",
                              "interval"
                            ]
                          }
                        },
                        "withAssemblyQuotaLimit": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "name": {
                                "type": "string"
                              },
                              "maxRequest": {
                                "type": "integer"
                              },
                              "interval": {
                                "type": "string"
                              },
                              "hard-limit": {
                                "type": "boolean"
                              },
                              "cache-only": {
                                "type": "boolean"
                              },
                              "is-client": {
                                "type": "boolean"
                              },
                              "use-api-name": {
                                "type": "boolean"
                              },
                              "use-app-id": {
                                "type": "boolean"
                              },
                              "use-client-id": {
                                "type": "boolean"
                              },
                              "dynamic-value": {
                                "type": "string"
                              },
                              "weight": {
                                "type": "string",
                                "pattern": ".+"
                              }
                            },
                            "required": [
                              "name",
                              "maxRequest",
                              "interval"
                            ]
                          }
                        },
                        "apis": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "$ref": {
                                "type": "string"
                              },
                              "operations": {
                                "type": "array",
                                "items": {
                                  "type": "object",
                                  "properties": {
                                    "path": {
                                      "type": "string"
                                    },
                                    "method": {
                                      "type": "string"
                                    },
                                    "withQuota": {
                                      "oneOf": [
                                        {
                                          "type": "object",
                                          "additionalProperties": {
                                            "type": "array",
                                            "items": {
                                              "type": "object",
                                              "required": [
                                                "$ref"
                                              ],
                                              "properties": {
                                                "$ref": {
                                                  "type": "string"
                                                }
                                              }
                                            }
                                          }
                                        },
                                        {
                                          "type": "object",
                                          "additionalProperties": false,
                                          "required": [
                                            "unlimited"
                                          ],
                                          "properties": {
                                            "unlimited": {
                                              "type": "object"
                                            }
                                          }
                                        }
                                      ]
                                    }
                                  },
                                  "required": [
                                    "path",
                                    "method"
                                  ]
                                }
                              }
                            },
                            "required": [
                              "$ref"
                            ]
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    },
    "ProjectQuota": {
      "type": "object",
      "required": [
        "kind",
        "apiVersion",
        "metadata",
        "spec"
      ],
      "properties": {
        "apiVersion": {
          "type": "string"
        },
        "kind": {
          "enum": [
            "Quota"
          ],
          "type": "string"
        },
        "metadata": {
          "$ref": "#/$defs/ProjectMetadata"
        },
        "spec": {
          "type": "object",
          "properties": {
            "maxRequest": {
              "type": "integer",
              "description": "Size of the rate limit bucket"
            },
            "interval": {
              "type": "string",
              "description": "Time interval for the rate limit (e.g., 1s, 1m, 1h)"
            },
            "extensions": {
              "type": "object",
              "properties": {
                "dp-gateway": {
                  "type": "object",
                  "properties": {
                    "apiVersion": {
                      "type": "string"
                    },
                    "spec": {
                      "type": "object",
                      "properties": {
                        "onLimitReach": {
                          "type": "string",
                          "enum": [
                            "block",
                            "allow"
                          ]
                        }
                      }
                    }
                  }
                },
                "dp-nano-gateway": {
                  "type": "object",
                  "properties": {
                    "apiVersion": {
                      "type": "string"
                    },
                    "spec": {
                      "type": "object",
                      "properties": {
                        "weightExpr": {
                          "type": "string",
                          "description": "Optional dynamic string expression"
                        },
                        "exceedAction": {
                          "type": "string",
                          "enum": [
                            "continue",
                            "return429",
                            "return500"
                          ]
                        },
                        "intervalOffset": {
                          "type": "integer"
                        },
                        "dynamicValue": {
                          "type": "string",
                          "description": "Optional dynamic key expression"
                        }
                      }
                    }
                  }
                },
                "webm-gateway": {
                  "type": "object",
                  "properties": {
                    "apiVersion": {
                      "type": "string"
                    },
                    "spec": {
                      "type": "object",
                      "properties": {
                        "alertMessage": {
                          "type": "string"
                        },
                        "alertFrequency": {
                          "type": "string",
                          "enum": [
                            "always",
                            "once"
                          ]
                        },
                        "onLimitReach": {
                          "type": "string",
                          "enum": [
                            "block",
                            "allow"
                          ]
                        },
                        "notification": {
                          "type": "object",
                          "properties": {
                            "enabled": {
                              "type": "boolean"
                            },
                            "notifyAfter": {
                              "type": "string"
                            },
                            "message": {
                              "type": "string"
                            },
                            "email": {
                              "type": "array",
                              "items": {
                                "type": "string"
                              }
                            },
                            "customDestination": {
                              "type": "array",
                              "items": {
                                "type": "string"
                              }
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

Work with this as data

Every JSON Schema 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 schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema 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 JSON Schema
curl "https://apis.io/api/v1/json-schemas/ibm-api-connect-plan-list"
All schemas
curl "https://apis.io/api/v1/json-schemas?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.

A second provider on the same verified email joins the account you already have.