Gravitee

Gravitee API Events API

The API Events API from Gravitee — 6 operation(s) for api events.

GitHub OpenAPI

Operations 6

GET /organizations/{orgId}/environments/{envId}/apis/{api}/events Get API's events #
GET /organizations/{orgId}/environments/{envId}/apis/{api}/events/search Get API's events #
GET /organizations/{orgId}/environments/{envId}/apis/{api}/events/{eventId} Get an API event with its id #
GET /organizations/{orgId}/environments/{envId}/v4/apis/{api}/events Get API's events #
GET /organizations/{orgId}/environments/{envId}/v4/apis/{api}/events/search Get API's events #
GET /organizations/{orgId}/environments/{envId}/v4/apis/{api}/events/{eventId} Get an API event with its id #

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-events-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-events-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-events-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Gravitee.io - Management API Events 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 Events
paths:
  /organizations/{orgId}/environments/{envId}/apis/{api}/events:
    get:
      tags:
      - API Events
      summary: Get API's events
      description: User must have the MANAGE_LIFECYCLE permission to use this service
      operationId: getApiEventsEvents
      parameters:
      - name: type
        in: query
        explode: false
        schema:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/EventType'
      - 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's events
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/EventEntity'
        '500':
          description: Internal server error
  /organizations/{orgId}/environments/{envId}/apis/{api}/events/search:
    get:
      tags:
      - API Events
      summary: Get API's events
      description: User must have the API_EVENT[READ] permission to use this service
      operationId: searchApiEvents
      parameters:
      - name: type
        in: query
        explode: false
        schema:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/EventType'
      - name: from
        in: query
        schema:
          type: integer
          format: int64
      - name: to
        in: query
        schema:
          type: integer
          format: int64
      - name: page
        in: query
        schema:
          type: integer
          format: int32
          default: 0
      - name: size
        in: query
        schema:
          type: integer
          format: int32
          default: 10
      - name: api_ids
        in: query
        explode: false
        schema:
          type: array
          items:
            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: Page of API events
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventEntityPage'
        '500':
          description: Internal server error
  /organizations/{orgId}/environments/{envId}/apis/{api}/events/{eventId}:
    get:
      tags:
      - API Events
      summary: Get an API event with its id
      description: User must have the READ API_EVENT permission to use this service
      operationId: getEvent
      parameters:
      - name: eventId
        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: API event
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventEntity'
        '500':
          description: Internal server error
  /organizations/{orgId}/environments/{envId}/v4/apis/{api}/events:
    get:
      tags:
      - API Events
      summary: Get API's events
      description: User must have the MANAGE_LIFECYCLE permission to use this service
      operationId: getApiEventsEvents_1
      parameters:
      - name: type
        in: query
        explode: false
        schema:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/EventType'
      - 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's events
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/EventEntity'
        '500':
          description: Internal server error
  /organizations/{orgId}/environments/{envId}/v4/apis/{api}/events/search:
    get:
      tags:
      - API Events
      summary: Get API's events
      description: User must have the API_EVENT[READ] permission to use this service
      operationId: searchApiEvents_1
      parameters:
      - name: type
        in: query
        explode: false
        schema:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/EventType'
      - name: from
        in: query
        schema:
          type: integer
          format: int64
      - name: to
        in: query
        schema:
          type: integer
          format: int64
      - name: page
        in: query
        schema:
          type: integer
          format: int32
          default: 0
      - name: size
        in: query
        schema:
          type: integer
          format: int32
          default: 10
      - name: api_ids
        in: query
        explode: false
        schema:
          type: array
          items:
            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: Page of API events
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventEntityPage'
        '500':
          description: Internal server error
  /organizations/{orgId}/environments/{envId}/v4/apis/{api}/events/{eventId}:
    get:
      tags:
      - API Events
      summary: Get an API event with its id
      description: User must have the READ API_EVENT permission to use this service
      operationId: getEvent_1
      parameters:
      - name: eventId
        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: API event
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventEntity'
        '500':
          description: Internal server error
components:
  schemas:
    EventType:
      type: string
      enum:
      - PUBLISH_API
      - PUBLISH_API_RESULT
      - UNPUBLISH_API
      - UNPUBLISH_API_RESULT
      - START_API
      - STOP_API
      - GATEWAY_STARTED
      - GATEWAY_STOPPED
      - PUBLISH_DICTIONARY
      - UNPUBLISH_DICTIONARY
      - START_DICTIONARY
      - STOP_DICTIONARY
      - ALERT_NOTIFICATION
      - PUBLISH_ORGANIZATION
      - DEBUG_API
    EventEntity:
      type: object
      properties:
        created_at:
          type: string
          format: date-time
        environments:
          uniqueItems: true
          type: array
          items:
            type: string
        id:
          type: string
        parentId:
          type: string
        payload:
          type: string
        properties:
          type: object
          additionalProperties:
            type: string
        type:
          $ref: '#/components/schemas/EventType'
        updated_at:
          type: string
          format: date-time
        user:
          $ref: '#/components/schemas/UserEntity'
    UserRoleEntity:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        permissions:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
        scope:
          $ref: '#/components/schemas/RoleScope'
    EventEntityPage:
      type: object
      properties:
        content:
          type: array
          items:
            $ref: '#/components/schemas/EventEntity'
        pageElements:
          type: integer
          format: int64
        pageNumber:
          type: integer
          format: int32
        totalElements:
          type: integer
          format: int64
    UserEntity:
      type: object
      properties:
        created_at:
          type: string
          format: date-time
        customFields:
          type: object
          additionalProperties:
            type: object
        displayName:
          type: string
          readOnly: true
        email:
          type: string
        envRoles:
          type: object
          additionalProperties:
            uniqueItems: true
            type: array
            items:
              $ref: '#/components/schemas/UserRoleEntity'
        firstConnectionAt:
          type: string
          format: date-time
        firstname:
          type: string
        id:
          type: string
        lastConnectionAt:
          type: string
          format: date-time
        lastname:
          type: string
        loginCount:
          type: integer
          format: int64
        newsletterSubscribed:
          type: boolean
        number_of_active_tokens:
          type: integer
          format: int32
        password:
          type: string
        picture:
          type: string
        primary_owner:
          type: boolean
        roles:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/UserRoleEntity'
        source:
          type: string
        sourceId:
          type: string
        status:
          type: string
        updated_at:
          type: string
          format: date-time
    RoleScope:
      type: string
      enum:
      - API
      - APPLICATION
      - GROUP
      - ENVIRONMENT
      - ORGANIZATION
      - PLATFORM
  securitySchemes:
    gravitee-auth:
      type: http
      scheme: basic