Gravitee API Management Gravitee API Management

Integrate Gravitee API Management to retrieve API inventory and metrics

The Gravitee API Management connector allows you to retrieve the complete inventory of your published APIs and consumption metrics directly into OverSOC for complete visibility over your API ecosystem.

Objective

The Gravitee API Management connector retrieves the following information:

  • Complete catalog of published and managed APIs
  • Consumption metrics, latency, and availability
  • Registered applications and active subscriptions

Prerequisites

  • Access to the Gravitee API Management console
  • Administrator permissions to access APIs and metrics
  • Ability to generate API keys

Information to Provide in OverSOC

FieldDescription
API URLBase URL of API Management (e.g., https://api.gravitee.io)
Personal Access TokenPersonal Access Token (PAT) for authentication

Procedure

Generate a Personal Access Token

  1. Sign in to the Gravitee API Management console.
  2. Click the username dropdown in the top-right corner.
  3. Scroll down to the Tokens section.
  4. Click Generate personal token.
  5. Provide a token name (e.g., "OverSOC Integration").
  6. Copy the generated token immediately (it will not be displayed again).

Configure the Connector in OverSOC

  1. In OverSOC, go to Data Sources Settings > Sources.
  2. Select Gravitee API Management and click Configure.
  3. Fill in the required fields:
    • API URL: Base URL of your Gravitee instance (e.g., https://api.gravitee.io for SaaS or https://gravitee.example.com for self-hosted)
    • Personal Access Token: Paste the token you generated
  4. The connector will use the token as a Bearer token in the Authorization header.
  5. Click Save Configuration.

Reference: Gravitee API Management Documentation

Required Permissions

The credentials must have the following permissions:

  • Read access to API catalog and API details
  • Read access to registered applications
  • Read access to metrics and analytics
  • Read access to plans and subscriptions