Gravitee

Gravitee Plans API

Manage plans (Keyless, API Key, OAuth2, JWT, mTLS, Push)

Documentation GitHub OpenAPI

Operations 6

GET /environments/{envId}/apis/{apiId}/plans List Plans on an API #

POST /environments/{envId}/apis/{apiId}/plans Create a Plan on an API #

GET /environments/{envId}/apis/{apiId}/plans/{planId} Get a Plan by Identifier #

PUT /environments/{envId}/apis/{apiId}/plans/{planId} Update a Plan #

POST /environments/{envId}/apis/{apiId}/plans/{planId}/_publish Publish a Plan #

POST /environments/{envId}/apis/{apiId}/plans/{planId}/_close Close a Plan #

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/gravitee-plans-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:
  title: Gravitee.io APIM Management Plans API
  description: 'The Gravitee API Management (APIM) Management API is the administrative

    control plane for the Gravitee platform. It exposes endpoints to create

    and deploy APIs (both v2 "Gravitee definition v2" and v4 message-oriented

    APIs), manage plans, applications, subscriptions, API products,

    analytics, logs, users, plugins, UI customization, environments, and

    organization-level installation.


    This consolidated specification is synthesized from the upstream v2

    OpenAPI fragments in `gravitee-apim-rest-api-management-v2-rest`

    (`openapi-apis.yaml`, `openapi-environments.yaml`,

    `openapi-analytics.yaml`, `openapi-api-products.yaml`,

    `openapi-installation.yaml`, `openapi-plugins.yaml`,

    `openapi-users.yaml`, `openapi-logs.yaml`, `openapi-ui.yaml`).'
  contact:
    name: GraviteeSource Team
    url: https://gravitee.io
    email: team-apim@graviteesource.com
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  version: 2.0.0
servers:
- url: https://{host}/management/v2
  description: APIM Management API v2 - default base URL
  variables:
    host:
      default: apim.example.com
      description: Hostname of the Gravitee APIM Management API
- url: https://{host}/management/v2/organizations/{orgId}
  description: APIM Management API v2 - per-organization base URL
  variables:
    host:
      default: apim.example.com
    orgId:
      default: DEFAULT
security:
- BasicAuth: []
- CookieAuth: []
- BearerAuth: []
tags:
- name: Plans
  description: Manage plans (Keyless, API Key, OAuth2, JWT, mTLS, Push)
paths:
  /environments/{envId}/apis/{apiId}/plans:
    get:
      tags:
      - Plans
      operationId: listApiPlans
      summary: List Plans on an API
      parameters:
      - $ref: '#/components/parameters/EnvId'
      - $ref: '#/components/parameters/ApiId'
      responses:
        '200':
          description: Plans page
    post:
      tags:
      - Plans
      operationId: createApiPlan
      summary: Create a Plan on an API
      parameters:
      - $ref: '#/components/parameters/EnvId'
      - $ref: '#/components/parameters/ApiId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Plan'
      responses:
        '201':
          description: Plan created
  /environments/{envId}/apis/{apiId}/plans/{planId}:
    get:
      tags:
      - Plans
      operationId: getApiPlan
      summary: Get a Plan by Identifier
      parameters:
      - $ref: '#/components/parameters/EnvId'
      - $ref: '#/components/parameters/ApiId'
      - in: path
        name: planId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The plan
    put:
      tags:
      - Plans
      operationId: updateApiPlan
      summary: Update a Plan
      parameters:
      - $ref: '#/components/parameters/EnvId'
      - $ref: '#/components/parameters/ApiId'
      - in: path
        name: planId
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Plan'
      responses:
        '200':
          description: Plan updated
  /environments/{envId}/apis/{apiId}/plans/{planId}/_publish:
    post:
      tags:
      - Plans
      operationId: publishApiPlan
      summary: Publish a Plan
      parameters:
      - $ref: '#/components/parameters/EnvId'
      - $ref: '#/components/parameters/ApiId'
      - in: path
        name: planId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Plan published
  /environments/{envId}/apis/{apiId}/plans/{planId}/_close:
    post:
      tags:
      - Plans
      operationId: closeApiPlan
      summary: Close a Plan
      parameters:
      - $ref: '#/components/parameters/EnvId'
      - $ref: '#/components/parameters/ApiId'
      - in: path
        name: planId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Plan closed
components:
  parameters:
    ApiId:
      in: path
      name: apiId
      required: true
      schema:
        type: string
      description: The API identifier
    EnvId:
      in: path
      name: envId
      required: true
      schema:
        type: string
      description: The environment identifier
  schemas:
    Plan:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        description:
          type: string
        security:
          type: object
          properties:
            type:
              type: string
              enum:
              - KEY_LESS
              - API_KEY
              - OAUTH2
              - JWT
              - MTLS
              - SUBSCRIPTION
              - PUSH
            configuration:
              type: object
        status:
          type: string
          enum:
          - STAGING
          - PUBLISHED
          - DEPRECATED
          - CLOSED
        validation:
          type: string
          enum:
          - MANUAL
          - AUTO
        order:
          type: integer
        characteristics:
          type: array
          items:
            type: string
  securitySchemes:
    BasicAuth:
      type: http
      scheme: basic
    CookieAuth:
      type: apiKey
      in: cookie
      name: Auth-Graviteeio-APIM
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

Gravitee Plans API

Operations 6

Documentation

Specifications

SDKs

Schemas & Data

Other Resources