Gravitee

Gravitee Console API

The Console API from Gravitee — 1 operation(s) for console.

Documentation GitHub OpenAPI

Operations 2

GET /organizations/{orgId}/console Get the console configuration needed for runtime #

POST /organizations/{orgId}/console Save the console configuration #

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-console-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 Console 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: Console
paths:
  /organizations/{orgId}/console:
    get:
      tags:
      - Console
      summary: Get the console configuration needed for runtime
      description: Every users can use this service
      operationId: getConsoleConfig
      parameters:
      - name: orgId
        in: path
        description: The ID of the Organization
        required: true
        schema:
          type: string
          default: DEFAULT
      responses:
        '200':
          description: Console configuration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConsoleConfigEntity'
        '500':
          description: Internal server error
    post:
      tags:
      - Console
      summary: Save the console configuration
      operationId: saveConsoleConfig
      parameters:
      - name: orgId
        in: path
        description: The ID of the Organization
        required: true
        schema:
          type: string
          default: DEFAULT
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConsoleSettingsEntity'
        required: true
      responses:
        '200':
          description: Console configuration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConsoleSettingsEntity'
        '500':
          description: Internal server error
      deprecated: true
components:
  schemas:
    ConsoleAnalyticsPendo:
      type: object
      properties:
        apiKey:
          type: string
        enabled:
          type: boolean
    ConsoleAuthentication:
      type: object
      properties:
        github:
          $ref: '#/components/schemas/GithubAuthentication'
        google:
          $ref: '#/components/schemas/GoogleAuthentication'
        localLogin:
          $ref: '#/components/schemas/Enabled'
        oauth2:
          $ref: '#/components/schemas/OAuth2Authentication'
    EmailProperties:
      type: object
      properties:
        auth:
          type: boolean
        sslTrust:
          type: string
        startTlsEnable:
          type: boolean
    Theme:
      type: object
      properties:
        css:
          type: string
        loader:
          type: string
        logo:
          type: string
        name:
          type: string
    Alert:
      type: object
      properties:
        enabled:
          type: boolean
    ConsoleScheduler:
      type: object
      properties:
        notifications:
          type: integer
          format: int32
        tasks:
          type: integer
          format: int32
    ConsoleConfigEntity:
      type: object
      properties:
        alert:
          $ref: '#/components/schemas/Alert'
        analyticsPendo:
          $ref: '#/components/schemas/ConsoleAnalyticsPendo'
        authentication:
          $ref: '#/components/schemas/ConsoleAuthentication'
        jupiterMode:
          $ref: '#/components/schemas/JupiterMode'
        logging:
          $ref: '#/components/schemas/Logging'
        maintenance:
          $ref: '#/components/schemas/Maintenance'
        management:
          $ref: '#/components/schemas/Management'
        newsletter:
          $ref: '#/components/schemas/Newsletter'
        reCaptcha:
          $ref: '#/components/schemas/ConsoleReCaptcha'
        scheduler:
          $ref: '#/components/schemas/ConsoleScheduler'
        theme:
          $ref: '#/components/schemas/Theme'
    Newsletter:
      type: object
      properties:
        enabled:
          type: boolean
    ConsoleCors:
      type: object
      properties:
        allowHeaders:
          type: array
          items:
            type: string
        allowMethods:
          type: array
          items:
            type: string
        allowOrigin:
          type: array
          items:
            type: string
        exposedHeaders:
          type: array
          items:
            type: string
        maxAge:
          type: integer
          format: int32
    GoogleAuthentication:
      type: object
      properties:
        clientId:
          type: string
    GithubAuthentication:
      type: object
      properties:
        clientId:
          type: string
    Enabled:
      type: object
      properties:
        enabled:
          type: boolean
    Logging:
      type: object
      properties:
        condition:
          type: string
        content:
          type: string
          enum:
          - NONE
          - HEADERS
          - PAYLOADS
          - HEADERS_PAYLOADS
        mode:
          type: string
          enum:
          - NONE
          - CLIENT
          - PROXY
          - CLIENT_PROXY
        scope:
          type: string
          enum:
          - NONE
          - REQUEST
          - RESPONSE
          - REQUEST_RESPONSE
    Maintenance:
      type: object
      properties:
        enabled:
          type: boolean
    ConsoleReCaptcha:
      type: object
      properties:
        enabled:
          type: boolean
        siteKey:
          type: string
    ConsoleSettingsEntity:
      type: object
      properties:
        alert:
          $ref: '#/components/schemas/Alert'
        analyticsPendo:
          $ref: '#/components/schemas/ConsoleAnalyticsPendo'
        authentication:
          $ref: '#/components/schemas/ConsoleAuthentication'
        cors:
          $ref: '#/components/schemas/ConsoleCors'
        email:
          $ref: '#/components/schemas/Email'
        jupiterMode:
          $ref: '#/components/schemas/JupiterMode'
        logging:
          $ref: '#/components/schemas/Logging'
        maintenance:
          $ref: '#/components/schemas/Maintenance'
        management:
          $ref: '#/components/schemas/Management'
        metadata:
          type: object
          properties:
            all:
              type: object
              additionalProperties:
                type: string
              writeOnly: true
            empty:
              type: boolean
          additionalProperties:
            type: array
            items:
              type: string
          readOnly: true
        newsletter:
          $ref: '#/components/schemas/Newsletter'
        reCaptcha:
          $ref: '#/components/schemas/ConsoleReCaptcha'
        scheduler:
          $ref: '#/components/schemas/ConsoleScheduler'
        theme:
          $ref: '#/components/schemas/Theme'
    OAuth2Authentication:
      type: object
      properties:
        clientId:
          type: string
    Management:
      type: object
      properties:
        automaticValidation:
          $ref: '#/components/schemas/Enabled'
        pathBasedApiCreation:
          $ref: '#/components/schemas/Enabled'
        support:
          $ref: '#/components/schemas/Enabled'
        systemRoleEdition:
          $ref: '#/components/schemas/Enabled'
        title:
          type: string
        url:
          type: string
        userCreation:
          $ref: '#/components/schemas/Enabled'
    Email:
      type: object
      properties:
        enabled:
          type: boolean
        from:
          type: string
        host:
          type: string
        password:
          type: string
        port:
          type: integer
          format: int32
        properties:
          $ref: '#/components/schemas/EmailProperties'
        protocol:
          type: string
        subject:
          type: string
        username:
          type: string
    JupiterMode:
      type: object
      properties:
        enabled:
          type: boolean
        isDefault:
          type: string
  securitySchemes:
    gravitee-auth:
      type: http
      scheme: basic

Gravitee Console API

Operations 2

Documentation

Specifications

SDKs

Schemas & Data

Other Resources