Gravitee

Gravitee API Definition API

The API Definition API from Gravitee — 1 operation(s) for api definition.

Documentation GitHub OpenAPI

Business capability

Public API Lifecycle Management BC-4270.10

Operations 2

GET /organizations/{orgId}/environments/{envId}/apis/{api}/definition Export the API definition in JSON format #

PATCH /organizations/{orgId}/environments/{envId}/apis/{api}/definition Update the API with json patches #

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:gravitee-api-definition-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

openapi: 3.2.0
info:
  title: Gravitee.io - Management API Definition API
  description: Some news resources are in alpha version. This implies that they are likely to be modified or even removed in future versions. They are marked with the 🧪 symbol
  version: 3.20.0
servers:
- url: http://localhost:8083/management
security:
- gravitee-auth: []
tags:
- name: API Definition
paths:
  /organizations/{orgId}/environments/{envId}/apis/{api}/definition:
    get:
      tags:
      - API Definition
      summary: Export the API definition in JSON format
      description: User must have the API_DEFINITION[READ] permission to use this service
      operationId: getApiDefinition
      parameters:
      - name: api
        in: path
        description: The ID of the API
        required: true
        schema:
          type: string
      - name: envId
        in: path
        description: The ID of the environment
        required: true
        schema:
          type: string
          default: DEFAULT
      - name: orgId
        in: path
        description: The ID of the Organization
        required: true
        schema:
          type: string
          default: DEFAULT
      responses:
        '200':
          description: API definition
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonNode'
        '500':
          description: Internal server error
    patch:
      tags:
      - API Definition
      summary: Update the API with json patches
      description: User must have the API_DEFINITION[UPDATE] permission to use this service
      operationId: patch
      parameters:
      - name: dryRun
        in: query
        schema:
          type: boolean
          default: false
      - name: api
        in: path
        description: The ID of the API
        required: true
        schema:
          type: string
      - name: envId
        in: path
        description: The ID of the environment
        required: true
        schema:
          type: string
          default: DEFAULT
      - name: orgId
        in: path
        description: The ID of the Organization
        required: true
        schema:
          type: string
          default: DEFAULT
      requestBody:
        content:
          '*/*':
            schema:
              type: array
              items:
                $ref: '#/components/schemas/JsonPatch'
        required: true
      responses:
        '200':
          description: API successfully updated with json patches
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonNode'
        '500':
          description: Internal server error
components:
  schemas:
    JsonPatch:
      required:
      - jsonPath
      type: object
      properties:
        jsonPath:
          type: string
        operation:
          type: string
          enum:
          - ADD
          - REMOVE
          - REPLACE
          - TEST
        value:
          type: object
    JsonNode:
      type: object
  securitySchemes:
    gravitee-auth:
      type: http
      scheme: basic

Gravitee API Definition API

Operations 2

Documentation

Specifications

SDKs

Schemas & Data

Other Resources