secret_scanning_list_alerts - Charter Docs

GET

github_secret_scanning_list_alerts.py

import asyncio

from charter.packs import github

result = asyncio.run(github.secret_scanning_list_alerts.ainvoke({"owner": ..., "repo": ...}))

Requires security_events or repo. With github.APP or github.FINE_GRAINED, requires secret_scanning_alerts=read or secret_scanning_alerts=write. Pages by number: page with per_page.

Path parameters

Field	Type	Description
`owner` *	`string`	The account owner of the repository. The name is not case sensitive.
`repo` *	`string`	The name of the repository without the `.git` extension. The name is not case sensitive.

Query parameters

Field	Type	Description
`perPage`	`integer`	The number of results per page (max 100). Defaults to 30. ≥ 1; ≤ 100; defaults to `30`
`page`	`integer`	The page number of the results to fetch. Defaults to 1. ≥ 1; defaults to `1`
`state`	SecretScanningState	Set to `open` or `resolved` to only list alerts in a specific state.
`secretType`	`string`	A comma-separated list of secret types to return. All default secret patterns are returned when absent. Cannot be combined with `exclude_secret_types`.
`excludeSecretTypes`	`string`	A comma-separated list of secret types to exclude from the results. Cannot be combined with `secret_type`.
`resolution`	`string`	A comma-separated list of resolutions. Valid resolutions are `false_positive`, `wont_fix`, `revoked`, `pattern_edited`, `pattern_deleted` or `used_in_tests`.
`assignee`	`string`	Filters alerts by assignee. Use `*` for all assigned alerts, `none` for unassigned, or a GitHub username.
`validity`	`string`	A comma-separated list of validities — whether GitHub could confirm the secret still works. Can be: `active`, `inactive`, `unknown`.
`hideSecret`	`boolean`	Leave the detected secret value out of the response. Set this when the result is going into a model’s context: triage needs the type, the location and the state, not the credential.
`isPubliclyLeaked`	`boolean`	Only alerts for secrets that were leaked publicly.
`isMultiRepo`	`boolean`	Only alerts for secrets detected in more than one repository.
`sort`	CodeScanningSort	The property to sort the results by. `created` means when the alert was created; `updated` means when it was updated or resolved. GitHub uses `created` when this is absent.
`direction`	SortDirection	The direction to sort the results by. GitHub uses `desc` when this is absent.