Audit event streaming GraphQL API (ULTIMATE)

• API Introduced in GitLab 14.5 with a flag named ff_external_audit_events_namespace. Disabled by default.
• API Enabled on GitLab.com and by default on self-managed in GitLab 14.7.
• API Feature flag ff_external_audit_events_namespace removed in GitLab 14.8.
• Custom HTTP headers API introduced in GitLab 15.1 with a flag named streaming_audit_event_headers. Disabled by default.
• Custom HTTP headers API enabled on GitLab.com and self-managed in GitLab 15.2.
• Custom HTTP headers API made generally available in GitLab 15.3. Feature flag streaming_audit_event_headers removed.
• User-specified verification token API support introduced in GitLab 15.4.
• APIs for custom HTTP headers for instance level streaming destinations introduced in GitLab 16.1 with a flag named ff_external_audit_events. Disabled by default.

Audit event streaming destinations can be maintained using a GraphQL API.

Add a new streaming destination

Add a new streaming destination to top-level groups or an entire instance.

WARNING: Streaming destinations receive all audit event data, which could include sensitive information. Make sure you trust the streaming destination.

Top-level group streaming destinations

Prerequisites:

• Owner role for a top-level group.

To enable streaming and add a destination to a top-level group, use the externalAuditEventDestinationCreate mutation.

mutation {
  externalAuditEventDestinationCreate(input: { destinationUrl: "https://mydomain.io/endpoint/ingest", groupPath: "my-group" } ) {
    errors
    externalAuditEventDestination {
      id
      destinationUrl
      verificationToken
      group {
        name
      }
    }
  }
}

You can optionally specify your own verification token (instead of the default GitLab-generated one) using the GraphQL externalAuditEventDestinationCreate mutation. Verification token length must be within 16 to 24 characters and trailing whitespace are not trimmed. You should set a cryptographically random and unique value. For example:

mutation {
  externalAuditEventDestinationCreate(input: { destinationUrl: "https://mydomain.io/endpoint/ingest", groupPath: "my-group", verificationToken: "unique-random-verification-token-here" } ) {
    errors
    externalAuditEventDestination {
      id
      destinationUrl
      verificationToken
      group {
        name
      }
    }
  }
}

Event streaming is enabled if:

• The returned errors object is empty.
• The API responds with 200 OK.

You can add an HTTP header using the GraphQL auditEventsStreamingHeadersCreate mutation. You can retrieve the destination ID by listing all the streaming destinations for the group or from the mutation above.

mutation {
  auditEventsStreamingHeadersCreate(input: { destinationId: "gid://gitlab/AuditEvents::ExternalAuditEventDestination/24601", key: "foo", value: "bar" }) {
    errors
  }
}

The header is created if the returned errors object is empty.

Instance streaming destinations

Introduced in GitLab 16.0 with a flag named ff_external_audit_events. Disabled by default.

FLAG: On self-managed GitLab, by default this feature is not available. To make it available, ask an administrator to enable the feature flag named ff_external_audit_events. On GitLab.com, this feature is not available. The feature is not ready for production use.

Prerequisites:

• Administrator access on the instance.

To enable streaming and add a destination, use the instanceExternalAuditEventDestinationCreate mutation in the GraphQL API.

mutation {
  instanceExternalAuditEventDestinationCreate(input: { destinationUrl: "https://mydomain.io/endpoint/ingest"}) {
    errors
    instanceExternalAuditEventDestination {
      destinationUrl
      id
      verificationToken
    }
  }
}

Event streaming is enabled if:

• The returned errors object is empty.
• The API responds with 200 OK.

Instance administrators can add an HTTP header using the GraphQL auditEventsStreamingInstanceHeadersCreate mutation. You can retrieve the destination ID by listing all the streaming destinations for the instance or from the mutation above.

mutation {
  auditEventsStreamingInstanceHeadersCreate(input:
    {
      destinationId: "gid://gitlab/AuditEvents::InstanceExternalAuditEventDestination/42",
      key: "foo",
      value: "bar"
    }) {
    errors
    header {
      id
      key
      value
    }
  }
}

The header is created if the returned errors object is empty.

List streaming destinations

List new streaming destinations for top-level groups or an entire instance.

Top-level group streaming destinations

Prerequisites:

• Owner role for a top-level group.

You can view a list of streaming destinations for a top-level group using the externalAuditEventDestinations query type.

query {
  group(fullPath: "my-group") {
    id
    externalAuditEventDestinations {
      nodes {
        destinationUrl
        verificationToken
        id
        headers {
          nodes {
            key
            value
            id
          }
        }
        eventTypeFilters
      }
    }
  }
}

If the resulting list is empty, then audit streaming is not enabled for that group.

Instance streaming destinations

Introduced in GitLab 16.0 with a flag named ff_external_audit_events. Disabled by default.

FLAG: On self-managed GitLab, by default this feature is not available. To make it available, ask an administrator to enable the feature flag named ff_external_audit_events. On GitLab.com, this feature is not available. The feature is not ready for production use.

Prerequisites:

• Administrator access on the instance.

To view a list of streaming destinations for an instance, use the instanceExternalAuditEventDestinations query type.

query {
  instanceExternalAuditEventDestinations {
    nodes {
      id
      destinationUrl
      verificationToken
      headers {
        nodes {
          id
          key
          value
        }
      }
    }
  }
}

If the resulting list is empty, then audit streaming is not enabled for the instance.

You need the ID values returned by this query for the update and delete mutations.

Update streaming destinations

Update streaming destinations for a top-level group or an entire instance.

Top-level group streaming destinations

Prerequisites:

• Owner role for a top-level group.

Users with the Owner role for a group can update streaming destinations' custom HTTP headers using the auditEventsStreamingHeadersUpdate mutation type. You can retrieve the custom HTTP headers ID by listing all the custom HTTP headers for the group.

mutation {
  externalAuditEventDestinationDestroy(input: { id: destination }) {
    errors
  }
}

Streaming destination is updated if:

• The returned errors object is empty.
• The API responds with 200 OK.

Group owners can remove an HTTP header using the GraphQL auditEventsStreamingHeadersDestroy mutation. You can retrieve the header ID by listing all the custom HTTP headers for the group.

mutation {
  auditEventsStreamingHeadersDestroy(input: { headerId: "gid://gitlab/AuditEvents::Streaming::Header/1" }) {
    errors
  }
}

The header is deleted if the returned errors object is empty.

Instance streaming destinations

Introduced in GitLab 16.0 with a flag named ff_external_audit_events. Disabled by default.

FLAG: On self-managed GitLab, by default this feature is not available. To make it available, ask an administrator to enable the feature flag named ff_external_audit_events. On GitLab.com, this feature is not available. The feature is not ready for production use.

Prerequisites:

• Administrator access on the instance.

To update streaming destinations for an instance, use the instanceExternalAuditEventDestinationUpdate mutation type. You can retrieve the destination ID by listing all the external destinations for the instance.

mutation {
  instanceExternalAuditEventDestinationUpdate(input: { id: "gid://gitlab/AuditEvents::InstanceExternalAuditEventDestination/1", destinationUrl: "https://www.new-domain.com/webhook"}) {
    errors
    instanceExternalAuditEventDestination {
      destinationUrl
      id
      verificationToken
    }
  }
}

Streaming destination is updated if:

• The returned errors object is empty.
• The API responds with 200 OK.

Instance administrators can update streaming destinations custom HTTP headers using the auditEventsStreamingInstanceHeadersUpdate mutation type. You can retrieve the custom HTTP headers ID by listing all the custom HTTP headers for the instance.

mutation {
  auditEventsStreamingInstanceHeadersUpdate(input: { headerId: "gid://gitlab/AuditEvents::Streaming::InstanceHeader/2", key: "new-key", value: "new-value" }) {
    errors
    header {
      id
      key
      value
    }
  }
}

The header is updated if the returned errors object is empty.

Delete streaming destinations

Delete streaming destinations for a top-level group or an entire instance.

When the last destination is successfully deleted, streaming is disabled for the group or the instance.

Top-level group streaming destinations

Prerequisites:

• Owner role for a top-level group.

Users with the Owner role for a group can delete streaming destinations using the externalAuditEventDestinationDestroy mutation type. You can retrieve the destinations ID by listing all the streaming destinations for the group.

mutation {
  externalAuditEventDestinationDestroy(input: { id: destination }) {
    errors
  }
}

Streaming destination is deleted if:

• The returned errors object is empty.
• The API responds with 200 OK.

Group owners can remove an HTTP header using the GraphQL auditEventsStreamingHeadersDestroy mutation. You can retrieve the header ID by listing all the custom HTTP headers for the group.

mutation {
  auditEventsStreamingHeadersDestroy(input: { headerId: "gid://gitlab/AuditEvents::Streaming::Header/1" }) {
    errors
  }
}

The header is deleted if the returned errors object is empty.

Instance streaming destinations

Introduced in GitLab 16.0 with a flag named ff_external_audit_events. Disabled by default.

FLAG: On self-managed GitLab, by default this feature is not available. To make it available, ask an administrator to enable the feature flag named ff_external_audit_events. On GitLab.com, this feature is not available. The feature is not ready for production use.

Prerequisites:

• Administrator access on the instance.

To delete streaming destinations, use the instanceExternalAuditEventDestinationDestroy mutation type. You can retrieve the destinations ID by listing all the streaming destinations for the instance.

mutation {
  instanceExternalAuditEventDestinationDestroy(input: { id: "gid://gitlab/AuditEvents::InstanceExternalAuditEventDestination/1" }) {
    errors
  }
}

Streaming destination is deleted if:

• The returned errors object is empty.
• The API responds with 200 OK.

Event type filters

Event type filters API introduced in GitLab 15.7.

When this feature is enabled for a group, you can use an API to permit users to filter streamed audit events per destination. If the feature is enabled with no filters, the destination receives all audit events.

A streaming destination that has an event type filter set has a filtered ({filter}) label.

Use the API to add an event type filter

Prerequisites:

• You must have the Owner role for the group.

You can add a list of event type filters using the auditEventsStreamingDestinationEventsAdd query type:

mutation {
    auditEventsStreamingDestinationEventsAdd(input: {
        destinationId: "gid://gitlab/AuditEvents::ExternalAuditEventDestination/1",
        eventTypeFilters: ["list of event type filters"]}){
        errors
        eventTypeFilters
    }
}

Event type filters are added if:

• The returned errors object is empty.
• The API responds with 200 OK.

Use the API to remove an event type filter

Prerequisites:

• You must have the Owner role for the group.

You can remove a list of event type filters using the auditEventsStreamingDestinationEventsRemove query type:

mutation {
    auditEventsStreamingDestinationEventsRemove(input: {
    destinationId: "gid://gitlab/AuditEvents::ExternalAuditEventDestination/1",
    eventTypeFilters: ["list of event type filters"]
  }){
    errors
  }
}

Event type filters are removed if:

• The returned errors object is empty.
• The API responds with 200 OK.