| description |
|---|
The Management API empowers orgs to manage APIs effectively, automate processes, and enhance developer experiences |
The Management API component manages the configuration of the entire Gravitee APIM platform. By exposing its RESTful endpoints, administrators, developers, and other stakeholders can interact with the APIM platform programmatically.
Before using the Gravitee API docs, we highly recommend reading the contextual information in the sections below. To explore the API documentation, select from the following endpoints categories to open an integrated API viewer and client. The viewer includes an option to download the API specification.
| Console UI and v2 APIs Endpoints Documentation Viewer | Manage all aspects of the Console UI and v2 APIs, e.g., import, update, export, and delete API definitions to configure plans, policies, users, groups, and analytics settings. | https://gravitee-io-labs.github.io/mapi-v1-docs/ | |
| v4 API Endpoints Documentation Viewer | Manage v4 APIs, e.g., import, update, export, and delete API definitions to configure plans, policies, users, groups, and analytics settings. | https://gravitee-io-labs.github.io/mapi-v2-docs-openapi-apis/ | |
| Portal Endpoints Documentation Viewer | Manage all aspects of the Developer Portal. | https://gravitee-io-labs.github.io/mapi-v2-docs-openapi-portal/ | |
| Plugin Endpoints Documentation Viewer | Read-only. Get information on entrypoints, endpoints, and policy plugins. | https://gravitee-io-labs.github.io/mapi-v2-docs-openapi-plugins/ | |
| Installation Endpoints Documentation Viewer | Read-only. Get environment and organization details. | https://gravitee-io-labs.github.io/mapi-v2-docs-openapi-installation/ | |
| OEM Customization Endpoints Documentation Viewer | Read-only. Get details around OEM customization of the Console UI. | https://gravitee-io-labs.github.io/mapi-v2-docs-openapi-ui/ |
The Management API consists of two main subcomponents, Management and Portal, which cater to distinct needs.
All Management API endpoints are accessible via the main Management API component, e.g., at http://localhost:8083 in a local installation.
There are two versions of the Management subcomponent: V1 and V2.
{% tabs %} {% tab title="V1" %} V1 is the initial version of the Management API, which covers all v2 APIs (including plans, policies, documentation, etc.) and all other resources available in the Console UI, e.g., applications, subscriptions, users, etc.
The V1 specification (YAML OAS) is available at /management/openapi.yaml of the Management API component.
{% endtab %}
{% tab title="V2" %} V2 is the latest version of the Management API, which currently covers v4 APIs (including plans, policies, documentation, etc.), plugins, installation, and OEM customization of the Console UI. T
The V2 home page is accessible at /management/v2/ of the Management API component. It is split into four groups:
- v4 APIs: Accessible at
/management/v2/openapi-apis.yamlof the Management API - Plugins: Accessible at
/management/v2/openapi-plugins.yamlof the Management API - Installation: Accessible at
/management/v2/openapi-installation.yamlof the Management API - OEM Customizations: Accessible at
/management/v2/openapi-ui.yamlof the Management API {% endtab %} {% endtabs %}
The Portal API is used to power the Developer Portal, and can be used as the backend API for a custom developer portal. Whether you’re building an external (potentially public-facing) portal or an internal developer hub, the Portal API empowers you to create a compelling and efficient platform.
The Portal API specification (YAML OAS) can be found at /portal/openapi of the Management API component.