Gravitee

Gravitee API Health API

The API Health API from Gravitee — 4 operation(s) for api health.

GitHub OpenAPI
Business capability
Observability Management BC-4220.20

Operations 4

GET /organizations/{orgId}/environments/{envId}/apis/{api}/health Health-check statistics for API #
GET /organizations/{orgId}/environments/{envId}/apis/{api}/health/average Health-check average statistics for API #
GET /organizations/{orgId}/environments/{envId}/apis/{api}/health/logs Health-check logs #
GET /organizations/{orgId}/environments/{envId}/apis/{api}/health/logs/{log} Health-check log #

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-api-health-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-api-health-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-api-health-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Gravitee.io - Management API Health 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 Health
paths:
  /organizations/{orgId}/environments/{envId}/apis/{api}/health:
    get:
      tags:
      - API Health
      summary: Health-check statistics for API
      operationId: getApiHealth
      parameters:
      - name: type
        in: query
        schema:
          $ref: '#/components/schemas/HealthcheckType'
      - name: field
        in: query
        schema:
          $ref: '#/components/schemas/HealthcheckField'
      - 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 health
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiMetrics'
  /organizations/{orgId}/environments/{envId}/apis/{api}/health/average:
    get:
      tags:
      - API Health
      summary: Health-check average statistics for API
      operationId: getApiHealthAverage
      parameters:
      - name: from
        in: query
        schema:
          minimum: 0
          type: integer
          format: int64
      - name: to
        in: query
        schema:
          minimum: 0
          type: integer
          format: int64
      - name: interval
        in: query
        schema:
          maximum: 1000000000
          minimum: 1000
          type: integer
          format: int64
      - name: type
        in: query
        required: true
        schema:
          $ref: '#/components/schemas/AnalyticsAverageType'
      - 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:
        default:
          description: default response
          content:
            application/json: {}
  /organizations/{orgId}/environments/{envId}/apis/{api}/health/logs:
    get:
      tags:
      - API Health
      summary: Health-check logs
      operationId: getApiHealthCheckLogs
      parameters:
      - name: from
        in: query
        schema:
          minimum: 0
          type: integer
          format: int64
      - name: to
        in: query
        schema:
          minimum: 0
          type: integer
          format: int64
      - name: query
        in: query
        schema:
          type: string
      - name: size
        in: query
        schema:
          type: integer
          format: int32
          default: 10
      - name: page
        in: query
        schema:
          type: integer
          format: int32
          default: 1
      - name: transition
        in: query
        schema:
          type: boolean
      - 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 logs
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchLogResponse'
        '500':
          description: Internal server error
  /organizations/{orgId}/environments/{envId}/apis/{api}/health/logs/{log}:
    get:
      tags:
      - API Health
      summary: Health-check log
      operationId: getApiHealthCheckLog
      parameters:
      - name: log
        in: path
        required: true
        schema:
          type: string
      - 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: Single health-check log
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Log'
        '500':
          description: Internal server error
components:
  schemas:
    MediaType:
      type: object
      properties:
        QUALITY_FACTOR_PARAMETER:
          type: string
        charset:
          type: object
          properties:
            registered:
              type: boolean
        concrete:
          type: boolean
        parameters:
          type: object
          additionalProperties:
            type: string
        qualityFactor:
          type: number
          format: double
        subtype:
          type: string
        type:
          type: string
        wildcardSubtype:
          type: boolean
        wildcardType:
          type: boolean
    Log:
      type: object
      properties:
        available:
          type: boolean
        endpoint:
          type: string
        gateway:
          type: string
        id:
          type: string
        message:
          type: string
        request:
          $ref: '#/components/schemas/Request'
        response:
          $ref: '#/components/schemas/Response'
        responseTime:
          type: integer
          format: int64
        state:
          type: integer
          format: int32
        success:
          type: boolean
        timestamp:
          type: integer
          format: int64
    HealthcheckField:
      type: string
      enum:
      - ENDPOINT
      - GATEWAY
    SearchLogResponse:
      type: object
      properties:
        logs:
          type: array
          items:
            $ref: '#/components/schemas/Log'
        metadata:
          type: object
          additionalProperties:
            type: object
            additionalProperties:
              type: string
        total:
          type: integer
          format: int64
    HealthcheckType:
      type: string
      enum:
      - AVAILABILITY
      - RESPONSE_TIME
    Request:
      type: object
      properties:
        body:
          type: string
        headers:
          type: object
          properties:
            accept:
              type: array
              items:
                $ref: '#/components/schemas/MediaType'
            all:
              type: object
              additionalProperties:
                type: string
              writeOnly: true
            empty:
              type: boolean
          additionalProperties:
            type: array
            items:
              type: string
        method:
          type: string
          enum:
          - CONNECT
          - DELETE
          - GET
          - HEAD
          - OPTIONS
          - PATCH
          - POST
          - PUT
          - TRACE
          - OTHER
        uri:
          type: string
    AnalyticsAverageType:
      type: string
      enum:
      - AVAILABILITY
      - RESPONSE_TIME
    ApiMetrics:
      type: object
      properties:
        buckets:
          type: object
          additionalProperties:
            type: object
            additionalProperties:
              type: number
        global:
          type: object
          additionalProperties:
            type: number
            format: double
        metadata:
          type: object
          additionalProperties:
            type: object
            additionalProperties:
              type: string
    Response:
      type: object
      properties:
        body:
          type: string
        headers:
          type: object
          properties:
            accept:
              type: array
              items:
                $ref: '#/components/schemas/MediaType'
            all:
              type: object
              additionalProperties:
                type: string
              writeOnly: true
            empty:
              type: boolean
          additionalProperties:
            type: array
            items:
              type: string
        status:
          type: integer
          format: int32
  securitySchemes:
    gravitee-auth:
      type: http
      scheme: basic