Skip to content

Add details for the GitHub PAT permissions #16758

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
clement-fouque merged 5 commits into from
Jan 6, 2026
Merged

Add details for the GitHub PAT permissions #16758

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
15d12a7
Update GitHub integration README with Personal Access Token permissio…
clement-fouque Dec 19, 2025
d12ba60
Update GitHub integration to version 2.21.0 with PAT permissions deta…
clement-fouque Jan 5, 2026
06d26db
Update GitHub integration documentation to clarify Personal Access To…
clement-fouque Jan 6, 2026
f741a14
Update GitHub integration documentation to clarify Personal Access To…
clement-fouque Jan 6, 2026
b9a9403
Clarify GitHub PAT permissions required for Issues data stream in cha…
clement-fouque Jan 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions packages/github/_dev/build/docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,11 @@ To use this integration, users must use GitHub Apps or Personal Access Token wit

**Note**: The Issues API can fetch a maximum of 30,000 issues when querying at the organization level. No limitation exists when querying for the repository level.

**Note**: Ensure the GitHub Personal Access Token includes those permission for the repository:
- At least `Read-only` permission on Issues
- At least `Read-only` permission on Metadata
If not properly configured, the integration may start successfully without any data being ingested.

{{fields "issues"}}

{{event "issues"}}
Expand Down
5 changes: 5 additions & 0 deletions packages/github/changelog.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
# newer versions go on top
- version: "2.21.0"
changes:
- description: Add details for the GitHub PAT permissions.
type: enhancement
link: https://github.com/elastic/integrations/pull/16758
- version: "2.20.0"
changes:
- description: Update `event.kind` to "alert" for `code_scanning.alert_created` and `secret_scanning_alert.create` actions.
Expand Down
5 changes: 5 additions & 0 deletions packages/github/docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -780,6 +780,11 @@ To use this integration, users must use GitHub Apps or Personal Access Token wit

**Note**: The Issues API can fetch a maximum of 30,000 issues when querying at the organization level. No limitation exists when querying for the repository level.

**Note**: Ensure the GitHub Personal Access Token includes those permission for the repository:
- At least `Read-only` permission on Issues
- At least `Read-only` permission on Metadata
If not properly configured, the integration may start successfully without any data being ingested.

**Exported fields**

| Field | Description | Type | Unit | Metric Type |
Expand Down
2 changes: 1 addition & 1 deletion packages/github/manifest.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: github
title: GitHub
version: "2.20.0"
version: "2.21.0"
description: Collect logs from GitHub with Elastic Agent.
type: integration
format_version: "3.4.0"
Expand Down