Gravitee

Gravitee Gateway API

The Gateway API from Gravitee — 3 operation(s) for gateway.

GitHub OpenAPI
Business capability
Observability Management BC-4220.20

Operations 3

GET /organizations/{orgId}/environments/{envId}/instances List gateway instances #
GET /organizations/{orgId}/environments/{envId}/instances/{instance} Get a gateway instance #
GET /organizations/{orgId}/environments/{envId}/instances/{instance}/monitoring/{gatewayId} Get monitoring metrics for a gateway instance #

Documentation

📖
Documentation
https://documentation.gravitee.io/apim
📖
GettingStarted
https://documentation.gravitee.io/apim/getting-started
📖
RateLimits
https://artifacts.apis.io/gravitee/rate-limits/gravitee-rate-limits.yml
📖
Documentation
https://documentation.gravitee.io/am

Specifications

⚙
OpenAPI
https://artifacts.apis.io/gravitee/openapi/gravitee-gateway-api-openapi.yml

SDKs

📦
GitHubRepository
https://github.com/gravitee-io/gravitee-api-management
📦
GitHubRepository
https://github.com/gravitee-io/gravitee-access-management

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/gravitee/json-schema/gravitee-api-schema.json
📊
JSONSchema
https://artifacts.apis.io/gravitee/json-schema/gravitee-plan-schema.json
📊
JSONSchema
https://artifacts.apis.io/gravitee/json-schema/gravitee-domain-schema.json

Other Resources

🔗
ChangeLog
https://documentation.gravitee.io/apim/release-information/changelog
🔗
License
https://github.com/gravitee-io/gravitee-api-management/blob/master/LICENSE.txt
🔗
SDKs
https://github.com/gravitee-io/gravitee-clients-sdk
🔗
SDKs
https://github.com/gravitee-io/terraform-provider-apim
🔗
CLI
https://github.com/gravitee-io/graviteeio-cli
🔗
KubernetesOperator
https://github.com/gravitee-io/gravitee-kubernetes-operator
🔗
HelmChart
https://github.com/gravitee-io/helm-charts
🔗
DockerImage
https://hub.docker.com/r/graviteeio/apim-gateway
🔗
JSONLDContext
https://artifacts.apis.io/gravitee/json-ld/gravitee-context.jsonld
🔗
KubernetesCRD
https://artifacts.apis.io/gravitee/crd/gravitee.io_apidefinitions.yaml
🔗
KubernetesCRD
https://artifacts.apis.io/gravitee/crd/gravitee.io_apiv4definitions.yaml
🔗
KubernetesCRD
https://artifacts.apis.io/gravitee/crd/gravitee.io_apiresources.yaml
🔗
KubernetesCRD
https://artifacts.apis.io/gravitee/crd/gravitee.io_applications.yaml
🔗
KubernetesCRD
https://artifacts.apis.io/gravitee/crd/gravitee.io_subscriptions.yaml
🔗
KubernetesCRD
https://artifacts.apis.io/gravitee/crd/gravitee.io_managementcontexts.yaml
🔗
KubernetesCRD
https://artifacts.apis.io/gravitee/crd/gravitee.io_sharedpolicygroups.yaml
🔗
KubernetesCRD
https://artifacts.apis.io/gravitee/crd/gravitee.io_groups.yaml
🔗
KubernetesCRD
https://artifacts.apis.io/gravitee/crd/gravitee.io_notifications.yaml
🔗
Plans
https://artifacts.apis.io/gravitee/plans/gravitee-plans-pricing.yml
🔗
FinOps
https://artifacts.apis.io/gravitee/finops/gravitee-finops.yml
🔗
Reference
https://documentation.gravitee.io/am/reference/am-api-reference
🔗
ChangeLog
https://documentation.gravitee.io/am/releases-and-changelog/release-notes
🔗
License
https://github.com/gravitee-io/gravitee-access-management/blob/master/LICENSE
🔗
SDKs
https://github.com/gravitee-io/gravitee-access-management/tree/master/gravitee-am-management-api-sdk-java
🔗
HelmChart
https://github.com/gravitee-io/helm-charts/tree/master/helm/gravitee-am
🔗
DockerImage
https://hub.docker.com/r/graviteeio/am-gateway

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-gateway-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

gravitee-gateway-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Gravitee.io - Management Gateway 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: Gateway
paths:
  /organizations/{orgId}/environments/{envId}/instances:
    get:
      tags:
      - Gateway
      summary: List gateway instances
      operationId: getInstances
      parameters:
      - name: includeStopped
        in: query
        schema:
          type: boolean
          default: false
      - name: from
        in: query
        schema:
          type: integer
          format: int64
          default: 0
      - name: to
        in: query
        schema:
          type: integer
          format: int64
          default: 0
      - name: page
        in: query
        schema:
          type: integer
          format: int32
          default: 0
      - name: size
        in: query
        schema:
          type: integer
          format: int32
          default: 10
      - 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:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PageInstanceListItem'
  /organizations/{orgId}/environments/{envId}/instances/{instance}:
    get:
      tags:
      - Gateway
      summary: Get a gateway instance
      operationId: getInstance
      parameters:
      - name: instance
        in: path
        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:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InstanceEntity'
  /organizations/{orgId}/environments/{envId}/instances/{instance}/monitoring/{gatewayId}:
    get:
      tags:
      - Gateway
      summary: Get monitoring metrics for a gateway instance
      operationId: getInstanceMonitoring
      parameters:
      - name: gatewayId
        in: path
        required: true
        schema:
          type: string
      - name: instance
        in: path
        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:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MonitoringData'
components:
  schemas:
    MonitoringJVM:
      type: object
      properties:
        heap_committed_in_bytes:
          type: integer
          format: int64
        heap_max_in_bytes:
          type: integer
          format: int64
        heap_used_in_bytes:
          type: integer
          format: int64
        heap_used_percent:
          type: integer
          format: int32
        non_heap_committed_in_bytes:
          type: integer
          format: int64
        non_heap_used_in_bytes:
          type: integer
          format: int64
        old_pool_max_in_bytes:
          type: integer
          format: int64
        old_pool_peak_max_in_bytes:
          type: integer
          format: int64
        old_pool_peak_used_in_bytes:
          type: integer
          format: int64
        old_pool_used_in_bytes:
          type: integer
          format: int64
        survivor_pool_max_in_bytes:
          type: integer
          format: int64
        survivor_pool_peak_max_in_bytes:
          type: integer
          format: int64
        survivor_pool_peak_used_in_bytes:
          type: integer
          format: int64
        survivor_pool_used_in_bytes:
          type: integer
          format: int64
        timestamp:
          type: integer
          format: int64
        uptime_in_millis:
          type: integer
          format: int64
        young_pool_max_in_bytes:
          type: integer
          format: int64
        young_pool_peak_max_in_bytes:
          type: integer
          format: int64
        young_pool_peak_used_in_bytes:
          type: integer
          format: int64
        young_pool_used_in_bytes:
          type: integer
          format: int64
    InstanceEntity:
      type: object
      properties:
        environments:
          uniqueItems: true
          type: array
          items:
            type: string
        environments_hrids:
          type: array
          items:
            type: string
        event:
          type: string
        hostname:
          type: string
        id:
          type: string
        ip:
          type: string
        last_heartbeat_at:
          type: string
          format: date-time
        organizations_hrids:
          type: array
          items:
            type: string
        plugins:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/PluginEntity'
        port:
          type: string
        started_at:
          type: string
          format: date-time
        state:
          $ref: '#/components/schemas/InstanceState'
        stopped_at:
          type: string
          format: date-time
        systemProperties:
          type: object
          additionalProperties:
            type: string
        tags:
          type: array
          items:
            type: string
        tenant:
          type: string
        version:
          type: string
    PluginEntity:
      type: object
      properties:
        dependencies:
          type: array
          items:
            type: string
            format: url
        description:
          type: string
        id:
          type: string
        name:
          type: string
        path:
          type: string
        plugin:
          type: string
        type:
          type: string
        version:
          type: string
    MonitoringCPU:
      type: object
      properties:
        load_average:
          type: object
          additionalProperties:
            type: object
        percent_use:
          type: integer
          format: int32
    InstanceState:
      type: string
      enum:
      - STARTED
      - UNKNOWN
      - STOPPED
    MonitoringThread:
      type: object
      properties:
        count:
          type: integer
          format: int32
        peak_count:
          type: integer
          format: int32
    PageInstanceListItem:
      type: object
      properties:
        content:
          type: array
          items:
            $ref: '#/components/schemas/InstanceListItem'
        pageElements:
          type: integer
          format: int64
        pageNumber:
          type: integer
          format: int32
        totalElements:
          type: integer
          format: int64
    MonitoringGC:
      type: object
      properties:
        old_collection_count:
          type: integer
          format: int32
        old_collection_time_in_millis:
          type: integer
          format: int64
        young_collection_count:
          type: integer
          format: int32
        young_collection_time_in_millis:
          type: integer
          format: int64
    MonitoringProcess:
      type: object
      properties:
        cpu_percent:
          type: integer
          format: int32
        max_file_descriptors:
          type: integer
          format: int32
        open_file_descriptors:
          type: integer
          format: int32
    InstanceListItem:
      type: object
      properties:
        event:
          type: string
        hostname:
          type: string
        id:
          type: string
        ip:
          type: string
        last_heartbeat_at:
          type: string
          format: date-time
        operating_system_name:
          type: string
        port:
          type: string
        started_at:
          type: string
          format: date-time
        state:
          $ref: '#/components/schemas/InstanceState'
        stopped_at:
          type: string
          format: date-time
        tags:
          type: array
          items:
            type: string
        tenant:
          type: string
        version:
          type: string
    MonitoringData:
      type: object
      properties:
        cpu:
          $ref: '#/components/schemas/MonitoringCPU'
        gc:
          $ref: '#/components/schemas/MonitoringGC'
        jvm:
          $ref: '#/components/schemas/MonitoringJVM'
        process:
          $ref: '#/components/schemas/MonitoringProcess'
        thread:
          $ref: '#/components/schemas/MonitoringThread'
  securitySchemes:
    gravitee-auth:
      type: http
      scheme: basic