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 OverView 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 OverView
| Field | Description |
|---|---|
| Username | Gravitee username |
| Password | User password |
| API URL | Base URL of API Management (e.g., https://api.gravitee.io) |
| API Key | API key for authentication |
Procedure
Generate a Personal Access Token
- Sign in to the Gravitee API Management console.
- Click the username dropdown in the top-right corner.
- Scroll down to the Tokens section.
- Click Generate personal token.
- Provide a token name (e.g., "OverView Integration").
- Copy the generated token immediately (it will not be displayed again).
Configure the Connector in OverView
- In OverView, go to Data Sources Settings > Sources.
- Select Gravitee API Management and click Configure.
- Fill in the required fields:
- API URL: Base URL of your Gravitee instance (e.g.,
https://api.gravitee.iofor SaaS orhttps://gravitee.example.comfor self-hosted) - Personal Access Token: Paste the token you generated
- API URL: Base URL of your Gravitee instance (e.g.,
- The connector will use the token as a
Bearertoken in the Authorization header. - 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
Alternative: file import through DropPoint
The API access described above is the recommended method for this connector. Where it is not available (a segregated network, a version or licence without API, an export you already produce), OverView accepts file exports, to be uploaded to the bucket dedicated to Gravitee API Management.
Bucket : s3://gravitee/
Example : s3://gravitee/export.csv
The procedure is described in the OverView DropPoint guide: generating credentials, configuring the client, then sending files from the OverView web interface, the AWS CLI or an SDK. Its examples come pre-filled with this bucket when you follow this link.