audit_event_definitions

Creates, updates, deletes, gets or lists an audit_event_definitions resource.

Overview

Name	audit_event_definitions
Type	Resource
Id	gitlab.audit.audit_event_definitions

Fields

The following fields are returned by SELECT queries:

list

GraphQL response envelope

Name	Datatype	Description
name	string	Key name of the audit event.
description	string	Description of what action the audit event tracks.
feature_category	string	Feature category associated with the event.
introduced_by_issue	string	Link to the issue introducing the event. For olderaudit events, it can be a commit URL rather than amerge request URL.
introduced_by_mr	string	Link to the merge request introducing the event. Forolder audit events, it can be a commit URL rather thana merge request URL.
milestone	string	Milestone the event was introduced in.
saved_to_database	boolean	Indicates if the event is saved to PostgreSQL database.
streamed	boolean	Indicates if the event is streamed to an external destination.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	host		Definitions for all audit events available on the instance. Generated from the GitLab GraphQL schema field Query.auditEventDefinitions (connection of AuditEventDefinition nodes).

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
host	string	GitLab host, with an optional port (default gitlab.com). Resolved from the GITLAB_HOST environment variable when it is set (x-stackQL-envVar); a WHERE host value always takes precedence. Self-managed instances: the provider is generated from the gitlab.com schema, so older instances may reject fields they do not serve. (default: gitlab.com, x-stackQL-envVar: GITLAB_HOST)

SELECT examples

list

Definitions for all audit events available on the instance. Generated from the GitLab GraphQL schema field Query.auditEventDefinitions (connection of AuditEventDefinition nodes).

SELECT
name,
description,
feature_category,
introduced_by_issue,
introduced_by_mr,
milestone,
saved_to_database,
streamed
FROM gitlab.audit.audit_event_definitions
WHERE host = '{{ host }}' -- required (defaults to gitlab.com; or set GITLAB_HOST)
;