enterprise-admin

Update an existing audit log stream configuration

Changed on

Updates an existing audit log stream configuration for an enterprise.

Microsoft Agent 365 streams are configured through Microsoft Entra authorization. For those streams, this endpoint can only pause or resume the stream. Authorization-managed fields cannot be updated; delete and recreate the stream to change its Entra tenant or authorization.

When using this endpoint, you must encrypt the credentials following the same encryption steps as outlined in the guide on encrypting secrets. See "Encrypting secrets for the REST API."

put/enterprises/{enterprise}/audit-log/streams/{stream_id}

Request

  • Base URL: https://api.github.com
  • URL: https://api.github.com/enterprises/{enterprise}/audit-log/streams/{stream_id}
  • Auth: none declared

Path parameters

enterprisestring required

The slug version of the enterprise name.

stream_idinteger required

The ID of the audit log stream configuration.

Request body

enabledboolean required

This setting pauses or resumes a stream.

stream_type'Azure Blob Storage' | 'Azure Event Hubs' | 'Amazon S3' | 'Splunk' | 'HTTPS Event Collector' | 'Google Cloud Storage' | 'Datadog' | 'Microsoft Agent 365' required

The audit log streaming provider. The name is case sensitive.

Response

Successful update

idinteger required
stream_typestring required
stream_detailsstring required
enabledboolean required
created_atstring date-time required
updated_atstring date-time required
paused_atstring date-time nullable

Changes

  • 2022-11-2809bdd45064e8Revision changes
    • breaking

      removed the enum value Microsoft Agent365 of the request property

    • info

      added the new Microsoft Agent 365 enum value to the request property

  • 2022-11-28d47f98f3168aRevision changes
    • info

      added the new Microsoft Agent365 enum value to the request property

    • info

      added subschema #9: MicrosoftAgent365Config to the request property oneOf list