Gravitee

Gravitee APIs API

Manage APIs (v2 and v4 message-oriented APIs)

Documentation GitHub OpenAPI

Business capability

Public API Lifecycle Management BC-4270.10

Operations 11

GET /environments/{envId}/apis List APIs in an Environment #

POST /environments/{envId}/apis Create an API #

POST /environments/{envId}/apis/_import/swagger Import an API from an OpenAPI/Swagger Document #

POST /environments/{envId}/apis/_import/definition Import an API From a Gravitee Definition #

POST /environments/{envId}/apis/_search Search APIs by Query #

GET /environments/{envId}/apis/{apiId} Get an API by Identifier #

PUT /environments/{envId}/apis/{apiId} Update an API #

DELETE /environments/{envId}/apis/{apiId} Delete an API #

POST /environments/{envId}/apis/{apiId}/_deploy Deploy an API to the Gateway #

POST /environments/{envId}/apis/{apiId}/_start Start an API #

POST /environments/{envId}/apis/{apiId}/_stop Stop an API #

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-apis-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 APIs API
  description: 'The Gravitee API Management (APIM) Management API is the administrative

    control plane for the Gravitee platform.'
  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: APIs
  description: Manage APIs (v2 and v4 message-oriented APIs)
paths:
  /environments/{envId}/apis:
    get:
      tags:
      - APIs
      operationId: listApis
      summary: List APIs in an Environment
      parameters:
      - $ref: '#/components/parameters/EnvId'
      - in: query
        name: page
        schema:
          type: integer
          default: 1
      - in: query
        name: perPage
        schema:
          type: integer
          default: 10
      responses:
        '200':
          description: A page of APIs
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApisPage'
    post:
      tags:
      - APIs
      operationId: createApi
      summary: Create an API
      parameters:
      - $ref: '#/components/parameters/EnvId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateApi'
      responses:
        '201':
          description: API created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Api'
  /environments/{envId}/apis/_import/swagger:
    post:
      tags:
      - APIs
      operationId: importSwaggerApi
      summary: Import an API from an OpenAPI/Swagger Document
      parameters:
      - $ref: '#/components/parameters/EnvId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ImportSwaggerDescriptor'
      responses:
        '201':
          description: API imported
  /environments/{envId}/apis/_import/definition:
    post:
      tags:
      - APIs
      operationId: importApiDefinition
      summary: Import an API From a Gravitee Definition
      parameters:
      - $ref: '#/components/parameters/EnvId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '201':
          description: API imported
  /environments/{envId}/apis/_search:
    post:
      tags:
      - APIs
      operationId: searchApis
      summary: Search APIs by Query
      parameters:
      - $ref: '#/components/parameters/EnvId'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                query:
                  type: string
      responses:
        '200':
          description: Matching APIs
  /environments/{envId}/apis/{apiId}:
    get:
      tags:
      - APIs
      operationId: getApi
      summary: Get an API by Identifier
      parameters:
      - $ref: '#/components/parameters/EnvId'
      - $ref: '#/components/parameters/ApiId'
      responses:
        '200':
          description: The API
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Api'
    put:
      tags:
      - APIs
      operationId: updateApi
      summary: Update an API
      parameters:
      - $ref: '#/components/parameters/EnvId'
      - $ref: '#/components/parameters/ApiId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Api'
      responses:
        '200':
          description: API updated
    delete:
      tags:
      - APIs
      operationId: deleteApi
      summary: Delete an API
      parameters:
      - $ref: '#/components/parameters/EnvId'
      - $ref: '#/components/parameters/ApiId'
      responses:
        '204':
          description: API deleted
  /environments/{envId}/apis/{apiId}/_deploy:
    post:
      tags:
      - APIs
      operationId: deployApi
      summary: Deploy an API to the Gateway
      parameters:
      - $ref: '#/components/parameters/EnvId'
      - $ref: '#/components/parameters/ApiId'
      responses:
        '202':
          description: Deployment requested
  /environments/{envId}/apis/{apiId}/_start:
    post:
      tags:
      - APIs
      operationId: startApi
      summary: Start an API
      parameters:
      - $ref: '#/components/parameters/EnvId'
      - $ref: '#/components/parameters/ApiId'
      responses:
        '204':
          description: API started
  /environments/{envId}/apis/{apiId}/_stop:
    post:
      tags:
      - APIs
      operationId: stopApi
      summary: Stop an API
      parameters:
      - $ref: '#/components/parameters/EnvId'
      - $ref: '#/components/parameters/ApiId'
      responses:
        '204':
          description: API stopped
components:
  schemas:
    ApisPage:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Api'
        pagination:
          $ref: '#/components/schemas/Pagination'
    CreateApi:
      type: object
      required:
      - name
      - apiVersion
      - definitionVersion
      properties:
        name:
          type: string
        description:
          type: string
        apiVersion:
          type: string
        definitionVersion:
          type: string
          enum:
          - V2
          - V4
        type:
          type: string
          enum:
          - PROXY
          - MESSAGE
          - NATIVE
    Pagination:
      type: object
      properties:
        page:
          type: integer
        perPage:
          type: integer
        pageItemsCount:
          type: integer
        totalCount:
          type: integer
        pageCount:
          type: integer
    ImportSwaggerDescriptor:
      type: object
      required:
      - type
      - payload
      properties:
        type:
          type: string
          enum:
          - INLINE
          - URL
        payload:
          type: string
        format:
          type: string
          enum:
          - YAML
          - JSON
        withDocumentation:
          type: boolean
        withPathMapping:
          type: boolean
    Api:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        apiVersion:
          type: string
        definitionVersion:
          type: string
          enum:
          - V1
          - V2
          - V4
          - FEDERATED
        type:
          type: string
          enum:
          - PROXY
          - MESSAGE
          - NATIVE
        description:
          type: string
        tags:
          type: array
          items:
            type: string
        labels:
          type: array
          items:
            type: string
        state:
          type: string
          enum:
          - STARTED
          - STOPPED
        lifecycleState:
          type: string
          enum:
          - CREATED
          - PUBLISHED
          - UNPUBLISHED
          - ARCHIVED
          - DEPRECATED
        visibility:
          type: string
          enum:
          - PUBLIC
          - PRIVATE
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        deployedAt:
          type: string
          format: date-time
  parameters:
    EnvId:
      in: path
      name: envId
      required: true
      schema:
        type: string
      description: The environment identifier
    ApiId:
      in: path
      name: apiId
      required: true
      schema:
        type: string
      description: The API identifier
  securitySchemes:
    BasicAuth:
      type: http
      scheme: basic
    CookieAuth:
      type: apiKey
      in: cookie
      name: Auth-Graviteeio-APIM
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

Gravitee APIs API

Operations 11

Documentation

Specifications

SDKs

Schemas & Data

Other Resources