GitLab Audit events API

openapi: 3.2.0
info:
  title: GitLab REST Audit events API
  description: GitLab REST API used to interact with a GitLab installation.
  termsOfService: https://handbook.gitlab.com/handbook/legal/api-terms/
  version: '19.6'
  license:
    name: CC BY-SA 4.0
    url: https://gitlab.com/gitlab-org/gitlab/-/blob/master/LICENSE
    x-gitlab-description: The license applies to the OpenAPI specification document itself. For terms governing use of the GitLab API, see the termsOfService field.
servers:
- url: https://{hostname}
  description: GitLab REST API
  variables:
    hostname:
      default: gitlab.com
      description: Your GitLab instance hostname
security:
- http: []
- oauth2: []
- apiKey: []
tags:
- name: Audit Events
  description: 'Use this API to list and retrieve the

    audit events recorded for an instance or a group.'
  x-displayName: Audit events
  externalDocs:
    url: https://docs.gitlab.com/api/audit_events/
paths:
  /api/v4/audit_events:
    get:
      operationId: getApiV4AuditEvents
      summary: List all instance audit events
      description: Lists all available instance audit events, limited to a maximum of 30 days for each query.
      tags:
      - Audit Events
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/APIEntitiesAuditEvent'
        '400':
          description: Bad Request
      parameters:
      - name: entity_type
        required: true
        description: Return audit events for the specified entity type.
        schema:
          type: string
          enum:
          - Project
          - User
          - Group
          - Gitlab::Audit::InstanceScope
          minLength: 1
        in: query
      - name: entity_id
        required: false
        description: Return audit events for the specified entity ID. Requires the `entity_type` attribute.
        schema:
          type:
          - integer
          - 'null'
        in: query
      - name: created_after
        required: false
        description: Return audit events created on or after the specified time.
        schema:
          type:
          - string
          - 'null'
          format: date-time
        in: query
        example: '2016-01-19T09:05:50.355Z'
      - name: created_before
        required: false
        description: Return audit events created on or before the specified time.
        schema:
          type:
          - string
          - 'null'
          format: date-time
        in: query
        example: '2016-01-19T09:05:50.355Z'
      - name: page
        required: false
        description: Page number of results to retrieve.
        schema:
          type: integer
          default: 1
        in: query
        example: 1
      - name: per_page
        required: false
        description: Number of items to list per page.
        schema:
          type: integer
          default: 20
        in: query
        example: 20
      x-gitlab-tier: premium
  /api/v4/audit_events/{id}:
    get:
      operationId: getApiV4AuditEventsId
      summary: Retrieve an instance audit event
      description: Retrieves a specified instance audit event.
      tags:
      - Audit Events
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesAuditEvent'
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID of the audit event.
        schema:
          type: integer
        in: path
      x-gitlab-tier: premium
  /api/v4/groups/{id}/audit_events:
    get:
      operationId: getApiV4GroupsIdAuditEvents
      summary: List all group audit events
      description: Lists all audit events for a specified group.
      tags:
      - Audit Events
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/APIEntitiesAuditEvent'
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: created_after
        required: false
        description: Return group audit events created on or after the specified time.
        schema:
          type:
          - string
          - 'null'
          format: date-time
        in: query
        example: '2016-01-19T09:05:50.355Z'
      - name: created_before
        required: false
        description: Return group audit events created on or before the specified time.
        schema:
          type:
          - string
          - 'null'
          format: date-time
        in: query
        example: '2016-01-19T09:05:50.355Z'
      - name: page
        required: false
        description: Page number of results to retrieve.
        schema:
          type: integer
          default: 1
        in: query
        example: 1
      - name: per_page
        required: false
        description: Number of items to list per page.
        schema:
          type: integer
          default: 20
        in: query
        example: 20
      - name: id
        required: true
        description: ID or URL-encoded path of the group.
        schema:
          oneOf:
          - type: string
          - type: integer
        in: path
      x-gitlab-tier: premium
components:
  schemas:
    APIEntitiesAuditEvent:
      type: object
      properties:
        id:
          type: integer
          format: int64
        author_id:
          type: integer
          format: int64
        entity_id:
          type: integer
          format: int64
        entity_type:
          type: string
        event_name:
          type: string
        details:
          type: object
        created_at:
          type: string
          format: date-time
  securitySchemes:
    http:
      type: http
      scheme: bearer
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://gitlab.com/oauth/authorize
          tokenUrl: https://gitlab.com/oauth/token
          refreshUrl: https://gitlab.com/oauth/token
          scopes:
            api: Grants complete read/write access to the API, including all groups and projects, the container registry, the dependency proxy, and the package registry.
            read_api: Grants read access to the API, including all groups and projects, the container registry, and the package registry.
            read_user: Grants read-only access to your profile through the /user API endpoint, which includes username, public email, and full name. Also grants access to read-only API endpoints under /users.
            create_runner: Grants create access to the runners.
            manage_runner: Grants access to manage the runners.
            k8s_proxy: Grants permission to perform Kubernetes API calls using the agent for Kubernetes.
            self_rotate: Grants permission for token to rotate itself.
            mcp: Grants read-write access to remote Model Context Protocol (MCP) server for tools execution.
            mcp_orbit: Grants access to the Orbit Knowledge Graph MCP server for graph queries and schema retrieval.
    apiKey:
      type: apiKey
      name: PRIVATE-TOKEN
      in: header