Gravitee platform API

The platform API from Gravitee — 45 operation(s) for platform.

Operations 8

GET /platform/audits/events List audit event types #
GET /platform/configuration/alerts/status Get the alert service status #
GET /platform/configuration/flow/schema Get the Policy Studio flow schema #
GET /platform/configuration/spel/grammar Get the spel grammar #
GET /platform/configuration/users/email-required #
GET /platform/installation Get installation information #
GET /platform/license Get current node License #
GET /platform/roles/{role} Get a system role #

Documentation

Specifications

SDKs

Schemas & Data

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://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/json-ld/gravitee-context.jsonld
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/crd/gravitee.io_apidefinitions.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/crd/gravitee.io_apiv4definitions.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/crd/gravitee.io_apiresources.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/crd/gravitee.io_applications.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/crd/gravitee.io_subscriptions.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/crd/gravitee.io_managementcontexts.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/crd/gravitee.io_sharedpolicygroups.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/crd/gravitee.io_groups.yaml
🔗
KubernetesCRD
https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/crd/gravitee.io_notifications.yaml
🔗
Plans
https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/plans/gravitee-plans-pricing.yml
🔗
FinOps
https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/finops/gravitee-finops.yml
🔗
GraphQL
https://raw.githubusercontent.com/api-evangelist/gravitee/refs/heads/main/graphql/gravitee-graphql.md
🔗
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-platform-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

gravitee-platform-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Gravitee.io - Access Management Platform API
  version: 4.12.0-alpha.3
servers:
- url: /management
security:
- gravitee-auth: []
tags:
- name: platform
paths:
  /platform/audits/events:
    get:
      tags:
      - platform
      summary: List audit event types
      description: There is no particular permission needed. User must be authenticated.
      operationId: listAuditEventTypes
      responses:
        default:
          description: default response
          content:
            application/json: {}
  /platform/configuration/alerts/status:
    get:
      tags:
      - platform
      summary: Get the alert service status
      description: There is no particular permission needed. User must be authenticated.
      operationId: getAlertServiceStatus
      responses:
        '200':
          description: Current alert service status
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertServiceStatusEntity'
        '500':
          description: Internal server error
  /platform/configuration/flow/schema:
    get:
      tags:
      - platform
      summary: Get the Policy Studio flow schema
      description: There is no particular permission needed. User must be authenticated.
      operationId: getPolicyStudioFlowSchema
      responses:
        default:
          description: default response
          content:
            application/json: {}
  /platform/configuration/spel/grammar:
    get:
      tags:
      - platform
      summary: Get the spel grammar
      description: There is no particular permission needed. User must be authenticated.
      operationId: getSpelGrammar
      responses:
        default:
          description: default response
          content:
            application/json: {}
  /platform/configuration/users/email-required:
    get:
      tags:
      - platform
      operationId: getUserEmailRequired
      responses:
        default:
          description: default response
          content:
            application/json: {}
  /platform/installation:
    get:
      tags:
      - platform
      summary: Get installation information
      description: User must have the INSTALLATION[READ] permission on the platform
      operationId: getInstallation
      responses:
        '200':
          description: Installation successfully fetched
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InstallationEntity'
        '404':
          description: No installation has been found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEntity'
        '500':
          description: Internal server error
  /platform/license:
    get:
      tags:
      - platform
      summary: Get current node License
      operationId: getLicense
      responses:
        default:
          description: default response
          content:
            application/json: {}
  /platform/roles/{role}:
    get:
      tags:
      - platform
      summary: Get a system role
      description: There is no particular permission needed. User must be authenticated.
      operationId: getSystemRole
      parameters:
      - name: role
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: System role successfully fetched
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Role'
        '500':
          description: Internal server error
components:
  schemas:
    ErrorEntity:
      type: object
      properties:
        http_status:
          type: integer
          format: int32
        message:
          type: string
    InstallationEntity:
      type: object
      properties:
        additionalInformation:
          type: object
          additionalProperties:
            type: string
        createdAt:
          type: string
          format: date-time
        id:
          type: string
        updatedAt:
          type: string
          format: date-time
    Role:
      type: object
      properties:
        assignableType:
          type: string
          enum:
          - PLATFORM
          - DOMAIN
          - APPLICATION
          - ORGANIZATION
          - ENVIRONMENT
          - PROTECTED_RESOURCE
        createdAt:
          type: string
          format: date-time
        defaultRole:
          type: boolean
        description:
          type: string
        id:
          type: string
        internalOnly:
          type: boolean
        name:
          type: string
        oauthScopes:
          type: array
          items:
            type: string
        permissionAcls:
          type: object
          additionalProperties:
            uniqueItems: true
            type: array
            items:
              type: string
              enum:
              - CREATE
              - READ
              - LIST
              - UPDATE
              - DELETE
        referenceId:
          type: string
        referenceType:
          type: string
          enum:
          - PLATFORM
          - DOMAIN
          - APPLICATION
          - ORGANIZATION
          - ENVIRONMENT
          - PROTECTED_RESOURCE
        system:
          type: boolean
        updatedAt:
          type: string
          format: date-time
    AlertServiceStatusEntity:
      type: object
      properties:
        available:
          type: boolean
  securitySchemes:
    gravitee-auth:
      type: http
      scheme: Bearer