Gravitee

Gravitee Audit API

The Audit API from Gravitee — 8 operation(s) for audit.

GitHub OpenAPI

Operations 8

GET /organizations/{organizationId}/audits List audit logs for the organization #
GET /organizations/{organizationId}/audits/{audit} Get an audit log #
GET /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/audits List audit logs for a security domain #
GET /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/audits/{audit} Get an audit log #
GET /organizations/{orgId}/audit Retrieve audit logs for the environment #
GET /organizations/{orgId}/audit/events List available audit event type for the environment #
GET /organizations/{orgId}/environments/{envId}/audit Retrieve audit logs for the environment #
GET /organizations/{orgId}/environments/{envId}/audit/events List available audit event type for the environment #

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-audit-api-openapi.yml

SDKs

📦
GitHubRepository
https://github.com/gravitee-io/gravitee-api-management
📦
GitHubRepository
https://github.com/gravitee-io/gravitee-access-management

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-audit-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-audit-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Gravitee.io - Access Management Audit API
  version: 4.12.0-alpha.3
servers:
- url: /management
security:
- gravitee-auth: []
tags:
- name: Audit
paths:
  /organizations/{organizationId}/audits:
    get:
      tags:
      - Audit
      summary: List audit logs for the organization
      description: User must have the ORGANIZATION_AUDIT[LIST] permission on the specified organization. Except if user has ORGANIZATION_AUDIT[READ] permission on the organization, each returned audit is filtered and contains only basic information such as id, date, event, actor, target and status.
      operationId: listOrganizationAudits
      parameters:
      - name: organizationId
        in: path
        required: true
        schema:
          type: string
      - name: type
        in: query
        schema:
          type: string
      - name: status
        in: query
        schema:
          type: string
      - name: user
        in: query
        schema:
          type: string
      - name: from
        in: query
        schema:
          type: integer
          format: int64
      - name: to
        in: query
        schema:
          type: integer
          format: int64
      - name: size
        in: query
        schema:
          type: integer
          format: int32
          default: 10
      - name: page
        in: query
        schema:
          type: integer
          format: int32
          default: 0
      responses:
        '200':
          description: List audit logs for the platform
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Audit'
        '500':
          description: Internal server error
  /organizations/{organizationId}/audits/{audit}:
    get:
      tags:
      - Audit
      summary: Get an audit log
      description: User must have the ORGANIZATION_AUDIT[READ] permission on the specified organization
      operationId: getOrganizationAudit
      parameters:
      - name: organizationId
        in: path
        required: true
        schema:
          type: string
      - name: audit
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Audit log successfully fetched
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Audit'
        '500':
          description: Internal server error
  /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/audits:
    get:
      tags:
      - Audit
      summary: List audit logs for a security domain
      description: User must have the DOMAIN_AUDIT[LIST] permission on the specified domain, environment or organization. Except if user has ORGANIZATION_AUDIT[READ] permission on the domain, environment or organization, each returned audit is filtered and contains only basic information such as id, date, event, actor, target and status.
      operationId: listDomainAudits
      parameters:
      - name: organizationId
        in: path
        required: true
        schema:
          type: string
      - name: environmentId
        in: path
        required: true
        schema:
          type: string
      - name: domain
        in: path
        required: true
        schema:
          type: string
      - name: type
        in: query
        schema:
          type: string
      - name: status
        in: query
        schema:
          type: string
      - name: user
        in: query
        schema:
          type: string
      - name: from
        in: query
        schema:
          type: integer
          format: int64
      - name: to
        in: query
        schema:
          type: integer
          format: int64
      - name: size
        in: query
        schema:
          type: integer
          format: int32
          default: 10
      - name: page
        in: query
        schema:
          type: integer
          format: int32
          default: 0
      responses:
        '200':
          description: List audit logs for a security domain
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Audit'
        '500':
          description: Internal server error
  /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/audits/{audit}:
    get:
      tags:
      - Audit
      summary: Get an audit log
      description: User must have the DOMAIN_AUDIT[READ] permission on the specified domain or DOMAIN_AUDIT[READ] permission on the specified environment or DOMAIN_AUDIT[READ] permission on the specified organization
      operationId: getDomainAudit
      parameters:
      - name: organizationId
        in: path
        required: true
        schema:
          type: string
      - name: environmentId
        in: path
        required: true
        schema:
          type: string
      - name: domain
        in: path
        required: true
        schema:
          type: string
      - name: audit
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Audit log successfully fetched
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Audit'
        '500':
          description: Internal server error
  /organizations/{orgId}/audit:
    get:
      tags:
      - Audit
      summary: Retrieve audit logs for the environment
      description: User must have the ENVIRONMENT_AUDIT[READ] or ORGANIZATION_AUDIT[READ] permission to use this service
      operationId: getAudits
      parameters:
      - name: environment
        in: query
        schema:
          type: string
      - name: api
        in: query
        schema:
          type: string
      - name: application
        in: query
        schema:
          type: string
      - name: type
        in: query
        description: filter on the type of audit
        schema:
          $ref: '#/components/schemas/AuditType'
      - name: event
        in: query
        description: filter by the name of an event.
        schema:
          type: string
        example: APPLICATION_UPDATED, API_CREATED, METADATA_DELETED, ...
      - name: from
        in: query
        description: Timestamp used to define the start date of the time window to query
        schema:
          type: integer
          format: int64
      - name: to
        in: query
        description: Timestamp used to define the end date of the time window to query
        schema:
          type: integer
          format: int64
      - name: size
        in: query
        description: Number of elements per page
        schema:
          type: integer
          format: int32
          default: 20
      - name: page
        in: query
        schema:
          type: integer
          format: int32
          default: 1
      - name: orgId
        in: path
        description: The ID of the Organization
        required: true
        schema:
          type: string
          default: DEFAULT
      responses:
        '200':
          description: List of audits
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuditEntityMetadataPage'
        '500':
          description: Internal server error
  /organizations/{orgId}/audit/events:
    get:
      tags:
      - Audit
      summary: List available audit event type for the environment
      description: User must have the ENVIRONMENT_AUDIT[READ] or ORGANIZATION_AUDIT[READ] permission to use this service
      operationId: getAuditEvents
      parameters:
      - name: orgId
        in: path
        description: The ID of the Organization
        required: true
        schema:
          type: string
          default: DEFAULT
      responses:
        '200':
          description: List of audits
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AuditEvent'
        '500':
          description: Internal server error
  /organizations/{orgId}/environments/{envId}/audit:
    get:
      tags:
      - Audit
      summary: Retrieve audit logs for the environment
      description: User must have the ENVIRONMENT_AUDIT[READ] or ORGANIZATION_AUDIT[READ] permission to use this service
      operationId: getAudits_1
      parameters:
      - name: environment
        in: query
        schema:
          type: string
      - name: api
        in: query
        schema:
          type: string
      - name: application
        in: query
        schema:
          type: string
      - name: type
        in: query
        description: filter on the type of audit
        schema:
          $ref: '#/components/schemas/AuditType'
      - name: event
        in: query
        description: filter by the name of an event.
        schema:
          type: string
        example: APPLICATION_UPDATED, API_CREATED, METADATA_DELETED, ...
      - name: from
        in: query
        description: Timestamp used to define the start date of the time window to query
        schema:
          type: integer
          format: int64
      - name: to
        in: query
        description: Timestamp used to define the end date of the time window to query
        schema:
          type: integer
          format: int64
      - name: size
        in: query
        description: Number of elements per page
        schema:
          type: integer
          format: int32
          default: 20
      - name: page
        in: query
        schema:
          type: integer
          format: int32
          default: 1
      - 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: List of audits
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuditEntityMetadataPage'
        '500':
          description: Internal server error
  /organizations/{orgId}/environments/{envId}/audit/events:
    get:
      tags:
      - Audit
      summary: List available audit event type for the environment
      description: User must have the ENVIRONMENT_AUDIT[READ] or ORGANIZATION_AUDIT[READ] permission to use this service
      operationId: getAuditEvents_1
      parameters:
      - 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: List of audits
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AuditEvent'
        '500':
          description: Internal server error
components:
  schemas:
    AuditAccessPoint:
      type: object
      properties:
        alternativeId:
          type: string
        displayName:
          type: string
        id:
          type: string
        ipAddress:
          type: string
        userAgent:
          type: string
    Audit:
      type: object
      properties:
        accessPoint:
          $ref: '#/components/schemas/AuditAccessPoint'
        actor:
          $ref: '#/components/schemas/AuditEntity'
        id:
          type: string
        outcome:
          $ref: '#/components/schemas/AuditOutcome'
        reference:
          $ref: '#/components/schemas/Reference'
        referenceId:
          type: string
        referenceType:
          type: string
          enum:
          - PLATFORM
          - DOMAIN
          - APPLICATION
          - ORGANIZATION
          - ENVIRONMENT
          - PROTECTED_RESOURCE
        target:
          $ref: '#/components/schemas/AuditEntity'
        timestamp:
          type: string
          format: date-time
          writeOnly: true
        transactionId:
          type: string
        type:
          type: string
    AuditOutcome:
      type: object
      properties:
        message:
          type: string
        status:
          type: string
          enum:
          - SUCCESS
          - FAILURE
    AuditEntity:
      type: object
      properties:
        alternativeId:
          type: string
        attributes:
          type: object
          additionalProperties:
            type: object
        displayName:
          type: string
        id:
          type: string
        referenceId:
          type: string
        referenceType:
          type: string
          enum:
          - PLATFORM
          - DOMAIN
          - APPLICATION
          - ORGANIZATION
          - ENVIRONMENT
          - PROTECTED_RESOURCE
        type:
          type: string
    Reference:
      type: object
      properties:
        id:
          type: string
        type:
          type: string
          enum:
          - PLATFORM
          - DOMAIN
          - APPLICATION
          - ORGANIZATION
          - ENVIRONMENT
          - PROTECTED_RESOURCE
    AuditType:
      type: string
      enum:
      - ORGANIZATION
      - ENVIRONMENT
      - APPLICATION
      - API
    AuditEvent:
      type: object
    AuditReferenceType:
      type: string
      enum:
      - ORGANIZATION
      - ENVIRONMENT
      - APPLICATION
      - API
    AuditEntityMetadataPage:
      type: object
      properties:
        content:
          type: array
          items:
            $ref: '#/components/schemas/AuditEntity'
        metadata:
          type: object
          additionalProperties:
            type: string
        pageElements:
          type: integer
          format: int64
        pageNumber:
          type: integer
          format: int32
        totalElements:
          type: integer
          format: int64
  securitySchemes:
    gravitee-auth:
      type: http
      scheme: Bearer