Skip to main content
O controle de versão da API REST já foi feito. Para obter mais informações, confira "Sobre o controle de versão da API".

Pontos de extremidade da API REST para logs de auditoria corporativa

Use a API REST para recuperar os logs de auditoria de uma empresa.

Esses pontos de extremidade só dão suporte à autenticação por meio de um personal access token (classic). Para obter mais informações, confira "Gerenciar seus tokens de acesso pessoal".

Get the audit log for an enterprise

Gets the audit log for an enterprise.

This endpoint has a rate limit of 1,750 queries per hour per user and IP address. If your integration receives a rate limit error (typically a 403 or 429 response), it should wait before making another request to the GitHub API. For more information, see "Rate limits for the REST API" and "Best practices for integrators."

The authenticated user must be an enterprise admin to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the read:audit_log scope to use this endpoint.

Tokens de acesso refinados para "Get the audit log for an enterprise"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

  • "Enterprise administration" business permissions (read)

Parâmetros para "Get the audit log for an enterprise"

Cabeçalhos
Nome, Tipo, Descrição
accept string

Setting to application/vnd.github+json is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
enterprise string Obrigatório

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

Parâmetros de consulta
Nome, Tipo, Descrição
phrase string

A search phrase. For more information, see Searching the audit log.

include string

The event types to include:

  • web - returns web (non-Git) events.
  • git - returns Git events.
  • all - returns both web and Git events.

The default is web.

Pode ser um dos: web, git, all

after string

A cursor, as given in the Link header. If specified, the query only searches for events after this cursor.

before string

A cursor, as given in the Link header. If specified, the query only searches for events before this cursor.

order string

The order of audit log events. To list newest events first, specify desc. To list oldest events first, specify asc.

The default is desc.

Pode ser um dos: desc, asc

page integer

The page number of the results to fetch. For more information, see "Using pagination in the REST API."

Padrão: 1

per_page integer

The number of results per page (max 100). For more information, see "Using pagination in the REST API."

Padrão: 30

Códigos de status de resposta HTTP para "Get the audit log for an enterprise"

Código de statusDescrição
200

OK

Exemplos de código para "Get the audit log for an enterprise"

Se você acessar o GitHub em GHE.com, substitua api.github.com pelo subdomínio dedicado da sua empresa em api.SUBDOMAIN.ghe.com.

Exemplo de solicitação

get/enterprises/{enterprise}/audit-log
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/enterprises/ENTERPRISE/audit-log

Response

Status: 200
[ { "@timestamp": 1606929874512, "action": "team.add_member", "actor": "octocat", "created_at": 1606929874512, "_document_id": "xJJFlFOhQ6b-5vaAFy9Rjw", "org": "octo-corp", "team": "octo-corp/example-team", "user": "monalisa" }, { "@timestamp": 1606507117008, "action": "org.create", "actor": "octocat", "created_at": 1606507117008, "_document_id": "Vqvg6kZ4MYqwWRKFDzlMoQ", "org": "octocat-test-org" }, { "@timestamp": 1605719148837, "action": "repo.destroy", "actor": "monalisa", "created_at": 1605719148837, "_document_id": "LwW2vpJZCDS-WUmo9Z-ifw", "org": "mona-org", "repo": "mona-org/mona-test-repo", "visibility": "private" } ]

Get the audit log stream key for encrypting secrets

Retrieves the audit log streaming public key for encrypting secrets.

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."

Tokens de acesso refinados para "Get the audit log stream key for encrypting secrets"

Esse ponto de extremidade não funciona com tokens de acesso de usuário do aplicativo GitHub, tokens de acesso de instalação do aplicativo GitHub ou tokens de acesso pessoal refinados.

Parâmetros para "Get the audit log stream key for encrypting secrets"

Cabeçalhos
Nome, Tipo, Descrição
accept string

Setting to application/vnd.github+json is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
enterprise string Obrigatório

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

Códigos de status de resposta HTTP para "Get the audit log stream key for encrypting secrets"

Código de statusDescrição
200

The stream key for the audit log streaming configuration was retrieved successfully.

Exemplos de código para "Get the audit log stream key for encrypting secrets"

Se você acessar o GitHub em GHE.com, substitua api.github.com pelo subdomínio dedicado da sua empresa em api.SUBDOMAIN.ghe.com.

Exemplo de solicitação

get/enterprises/{enterprise}/audit-log/stream-key
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/enterprises/ENTERPRISE/audit-log/stream-key

The stream key for the audit log streaming configuration was retrieved successfully.

Status: 200
{ "key_id": "123", "key": "actual-public-key-value" }

List audit log stream configurations for an enterprise

Lists the configured audit log streaming configurations for an enterprise. This only lists configured streams for supported providers.

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."

Tokens de acesso refinados para "List audit log stream configurations for an enterprise"

Esse ponto de extremidade não funciona com tokens de acesso de usuário do aplicativo GitHub, tokens de acesso de instalação do aplicativo GitHub ou tokens de acesso pessoal refinados.

Parâmetros para "List audit log stream configurations for an enterprise"

Cabeçalhos
Nome, Tipo, Descrição
accept string

Setting to application/vnd.github+json is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
enterprise string Obrigatório

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

Códigos de status de resposta HTTP para "List audit log stream configurations for an enterprise"

Código de statusDescrição
200

OK

Exemplos de código para "List audit log stream configurations for an enterprise"

Se você acessar o GitHub em GHE.com, substitua api.github.com pelo subdomínio dedicado da sua empresa em api.SUBDOMAIN.ghe.com.

Exemplo de solicitação

get/enterprises/{enterprise}/audit-log/streams
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/enterprises/ENTERPRISE/audit-log/streams

OK

Status: 200
[ { "id": 1, "stream_type": "Splunk", "stream_details": "US", "enabled": true, "created_at": "2024-06-06T08:00:00Z", "updated_at": "2024-06-06T08:00:00Z", "paused_at": null } ]

Create an audit log streaming configuration for an enterprise

Creates an audit log streaming configuration for any of the supported streaming endpoints: Azure Blob Storage, Azure Event Hubs, Amazon S3, Splunk, Google Cloud Storage, Datadog.

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."

Tokens de acesso refinados para "Create an audit log streaming configuration for an enterprise"

Esse ponto de extremidade não funciona com tokens de acesso de usuário do aplicativo GitHub, tokens de acesso de instalação do aplicativo GitHub ou tokens de acesso pessoal refinados.

Parâmetros para "Create an audit log streaming configuration for an enterprise"

Cabeçalhos
Nome, Tipo, Descrição
accept string

Setting to application/vnd.github+json is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
enterprise string Obrigatório

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

Parâmetros do corpo
Nome, Tipo, Descrição
enabled boolean Obrigatório

This setting pauses or resumes a stream.

stream_type string Obrigatório

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

Pode ser um dos: Azure Blob Storage, Azure Event Hubs, Amazon S3, Splunk, HTTPS Event Collector, Google Cloud Storage, Datadog

vendor_specific object Obrigatório
Nome, Tipo, Descrição
AzureBlobConfig object Obrigatório

Azure Blob Config for audit log streaming configuration.

Nome, Tipo, Descrição
key_id string Obrigatório

Key ID obtained from the audit log stream key endpoint used to encrypt secrets.

encrypted_sas_url string Obrigatório
AzureHubConfig object Obrigatório

Azure Event Hubs Config for audit log streaming configuration.

Nome, Tipo, Descrição
name string Obrigatório

Instance name of Azure Event Hubs

encrypted_connstring string Obrigatório

Encrypted Connection String for Azure Event Hubs

key_id string Obrigatório

Key ID obtained from the audit log stream key endpoint used to encrypt secrets.

AmazonS3OIDCConfig object Obrigatório

Amazon S3 OIDC Config for audit log streaming configuration.

Nome, Tipo, Descrição
bucket string Obrigatório

Amazon S3 Bucket Name.

region string Obrigatório

AWS S3 Bucket Region.

key_id string Obrigatório

Key ID obtained from the audit log stream key endpoint used to encrypt secrets.

authentication_type string Obrigatório

Authentication Type for Amazon S3.

Valor: oidc

arn_role string Obrigatório
AmazonS3AccessKeysConfig object Obrigatório

Amazon S3 Access Keys Config for audit log streaming configuration.

Nome, Tipo, Descrição
bucket string Obrigatório

Amazon S3 Bucket Name.

region string Obrigatório

Amazon S3 Bucket Name.

key_id string Obrigatório

Key ID obtained from the audit log stream key endpoint used to encrypt secrets.

authentication_type string Obrigatório

Authentication Type for Amazon S3.

Valor: access_keys

encrypted_secret_key string Obrigatório

Encrypted AWS Secret Key.

encrypted_access_key_id string Obrigatório

Encrypted AWS Access Key ID.

SplunkConfig object Obrigatório

Splunk Config for Audit Log Stream Configuration

Nome, Tipo, Descrição
domain string Obrigatório

Domain of Splunk instance.

port integer Obrigatório

The port number for connecting to Splunk.

key_id string Obrigatório

Key ID obtained from the audit log stream key endpoint used to encrypt secrets.

encrypted_token string Obrigatório

Encrypted Token.

ssl_verify boolean Obrigatório

SSL verification helps ensure your events are sent to your Splunk endpoint securely.

GoogleCloudConfig object Obrigatório

Google Cloud Config for audit log streaming configuration.

Nome, Tipo, Descrição
bucket string Obrigatório

Google Cloud Bucket Name

key_id string Obrigatório

Key ID obtained from the audit log stream key endpoint used to encrypt secrets.

encrypted_json_credentials string Obrigatório
DatadogConfig object Obrigatório

Datadog Config for audit log streaming configuration.

Nome, Tipo, Descrição
encrypted_token string Obrigatório

Encrypted Splunk token.

site string Obrigatório

Datadog Site to use.

Pode ser um dos: US, US3, US5, EU1, US1-FED, AP1

key_id string Obrigatório

Key ID obtained from the audit log stream key endpoint used to encrypt secrets.

Códigos de status de resposta HTTP para "Create an audit log streaming configuration for an enterprise"

Código de statusDescrição
200

The audit log stream configuration was created successfully.

Exemplos de código para "Create an audit log streaming configuration for an enterprise"

Se você acessar o GitHub em GHE.com, substitua api.github.com pelo subdomínio dedicado da sua empresa em api.SUBDOMAIN.ghe.com.

Exemplo de solicitação

post/enterprises/{enterprise}/audit-log/streams
curl -L \ -X POST \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/enterprises/ENTERPRISE/audit-log/streams \ -d '{"enabled":false,"stream_type":"Azure Event Hubs","vendor_specific":{"namespace":"newnamespace","shared_access_key_name":"newaccesskeyname","shared_access_key":"newaccesskey","event_hub_name":"neweventhub"}}'

The audit log stream configuration was created successfully.

Status: 200
{ "id": 1, "stream_type": "Splunk", "stream_details": "US", "enabled": true, "created_at": "2024-06-06T08:00:00Z", "updated_at": "2024-06-06T08:00:00Z", "paused_at": null }

List one audit log streaming configuration via a stream ID

Lists one audit log stream configuration via a stream ID.

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."

Tokens de acesso refinados para "List one audit log streaming configuration via a stream ID"

Esse ponto de extremidade não funciona com tokens de acesso de usuário do aplicativo GitHub, tokens de acesso de instalação do aplicativo GitHub ou tokens de acesso pessoal refinados.

Parâmetros para "List one audit log streaming configuration via a stream ID"

Cabeçalhos
Nome, Tipo, Descrição
accept string

Setting to application/vnd.github+json is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
enterprise string Obrigatório

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

stream_id integer Obrigatório

The ID of the audit log stream configuration.

Códigos de status de resposta HTTP para "List one audit log streaming configuration via a stream ID"

Código de statusDescrição
200

Lists one audit log stream configuration via stream ID.

Exemplos de código para "List one audit log streaming configuration via a stream ID"

Se você acessar o GitHub em GHE.com, substitua api.github.com pelo subdomínio dedicado da sua empresa em api.SUBDOMAIN.ghe.com.

Exemplo de solicitação

get/enterprises/{enterprise}/audit-log/streams/{stream_id}
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/enterprises/ENTERPRISE/audit-log/streams/STREAM_ID

Lists one audit log stream configuration via stream ID.

Status: 200
{ "id": 1, "stream_type": "Splunk", "stream_details": "US", "enabled": true, "created_at": "2024-06-06T08:00:00Z", "updated_at": "2024-06-06T08:00:00Z", "paused_at": null }

Update an existing audit log stream configuration

Updates an existing audit log stream configuration for an enterprise.

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."

Tokens de acesso refinados para "Update an existing audit log stream configuration"

Esse ponto de extremidade não funciona com tokens de acesso de usuário do aplicativo GitHub, tokens de acesso de instalação do aplicativo GitHub ou tokens de acesso pessoal refinados.

Parâmetros para "Update an existing audit log stream configuration"

Cabeçalhos
Nome, Tipo, Descrição
accept string

Setting to application/vnd.github+json is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
enterprise string Obrigatório

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

stream_id integer Obrigatório

The ID of the audit log stream configuration.

Parâmetros do corpo
Nome, Tipo, Descrição
enabled boolean Obrigatório

This setting pauses or resumes a stream.

stream_type string Obrigatório

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

Pode ser um dos: Azure Blob Storage, Azure Event Hubs, Amazon S3, Splunk, HTTPS Event Collector, Google Cloud Storage, Datadog

vendor_specific object Obrigatório
Nome, Tipo, Descrição
AzureBlobConfig object Obrigatório

Azure Blob Config for audit log streaming configuration.

Nome, Tipo, Descrição
key_id string Obrigatório

Key ID obtained from the audit log stream key endpoint used to encrypt secrets.

encrypted_sas_url string Obrigatório
AzureHubConfig object Obrigatório

Azure Event Hubs Config for audit log streaming configuration.

Nome, Tipo, Descrição
name string Obrigatório

Instance name of Azure Event Hubs

encrypted_connstring string Obrigatório

Encrypted Connection String for Azure Event Hubs

key_id string Obrigatório

Key ID obtained from the audit log stream key endpoint used to encrypt secrets.

AmazonS3OIDCConfig object Obrigatório

Amazon S3 OIDC Config for audit log streaming configuration.

Nome, Tipo, Descrição
bucket string Obrigatório

Amazon S3 Bucket Name.

region string Obrigatório

AWS S3 Bucket Region.

key_id string Obrigatório

Key ID obtained from the audit log stream key endpoint used to encrypt secrets.

authentication_type string Obrigatório

Authentication Type for Amazon S3.

Valor: oidc

arn_role string Obrigatório
AmazonS3AccessKeysConfig object Obrigatório

Amazon S3 Access Keys Config for audit log streaming configuration.

Nome, Tipo, Descrição
bucket string Obrigatório

Amazon S3 Bucket Name.

region string Obrigatório

Amazon S3 Bucket Name.

key_id string Obrigatório

Key ID obtained from the audit log stream key endpoint used to encrypt secrets.

authentication_type string Obrigatório

Authentication Type for Amazon S3.

Valor: access_keys

encrypted_secret_key string Obrigatório

Encrypted AWS Secret Key.

encrypted_access_key_id string Obrigatório

Encrypted AWS Access Key ID.

SplunkConfig object Obrigatório

Splunk Config for Audit Log Stream Configuration

Nome, Tipo, Descrição
domain string Obrigatório

Domain of Splunk instance.

port integer Obrigatório

The port number for connecting to Splunk.

key_id string Obrigatório

Key ID obtained from the audit log stream key endpoint used to encrypt secrets.

encrypted_token string Obrigatório

Encrypted Token.

ssl_verify boolean Obrigatório

SSL verification helps ensure your events are sent to your Splunk endpoint securely.

GoogleCloudConfig object Obrigatório

Google Cloud Config for audit log streaming configuration.

Nome, Tipo, Descrição
bucket string Obrigatório

Google Cloud Bucket Name

key_id string Obrigatório

Key ID obtained from the audit log stream key endpoint used to encrypt secrets.

encrypted_json_credentials string Obrigatório
DatadogConfig object Obrigatório

Datadog Config for audit log streaming configuration.

Nome, Tipo, Descrição
encrypted_token string Obrigatório

Encrypted Splunk token.

site string Obrigatório

Datadog Site to use.

Pode ser um dos: US, US3, US5, EU1, US1-FED, AP1

key_id string Obrigatório

Key ID obtained from the audit log stream key endpoint used to encrypt secrets.

Códigos de status de resposta HTTP para "Update an existing audit log stream configuration"

Código de statusDescrição
200

Successful update

422

Validation error

Exemplos de código para "Update an existing audit log stream configuration"

Se você acessar o GitHub em GHE.com, substitua api.github.com pelo subdomínio dedicado da sua empresa em api.SUBDOMAIN.ghe.com.

Exemplo de solicitação

put/enterprises/{enterprise}/audit-log/streams/{stream_id}
curl -L \ -X PUT \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/enterprises/ENTERPRISE/audit-log/streams/STREAM_ID \ -d '{"enabled":false,"stream_type":"Azure Event Hubs","vendor_specific":{"namespace":"newnamespace","shared_access_key_name":"newaccesskeyname","shared_access_key":"newaccesskey","event_hub_name":"neweventhub"}}'

Successful update

Status: 200
{ "id": 1, "stream_type": "Splunk", "stream_details": "US", "enabled": true, "created_at": "2024-06-06T08:00:00Z", "updated_at": "2024-06-06T08:00:00Z", "paused_at": null }

Delete an audit log streaming configuration for an enterprise

Deletes an existing audit log stream configuration for an enterprise.

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."

Tokens de acesso refinados para "Delete an audit log streaming configuration for an enterprise"

Esse ponto de extremidade não funciona com tokens de acesso de usuário do aplicativo GitHub, tokens de acesso de instalação do aplicativo GitHub ou tokens de acesso pessoal refinados.

Parâmetros para "Delete an audit log streaming configuration for an enterprise"

Cabeçalhos
Nome, Tipo, Descrição
accept string

Setting to application/vnd.github+json is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
enterprise string Obrigatório

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

stream_id integer Obrigatório

The ID of the audit log stream configuration.

Códigos de status de resposta HTTP para "Delete an audit log streaming configuration for an enterprise"

Código de statusDescrição
204

The audit log stream configuration was deleted successfully.

Exemplos de código para "Delete an audit log streaming configuration for an enterprise"

Se você acessar o GitHub em GHE.com, substitua api.github.com pelo subdomínio dedicado da sua empresa em api.SUBDOMAIN.ghe.com.

Exemplo de solicitação

delete/enterprises/{enterprise}/audit-log/streams/{stream_id}
curl -L \ -X DELETE \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/enterprises/ENTERPRISE/audit-log/streams/STREAM_ID

The audit log stream configuration was deleted successfully.

Status: 204