GET /orgs/{org}/code-scanning/alerts

Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see "Managing security managers in your organization."

The authenticated user must be an owner or security manager for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the security_events or repos cope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.

Servers

Path parameters

Name Type Required Description
org String Yes

The organization name. The name is not case sensitive.

Query parameters

Name Type Required Description
page Integer No

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

Default value: 1

direction String No

The direction to sort the results by.

Possible values:

  • "desc"
  • "asc"

Default value: "desc"

tool_name String No

The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either tool_name or tool_guid, but not both.

after String No

A cursor, as given in the Link header. If specified, the query only searches for results after this cursor. For more information, see "Using pagination in the REST API."

per_page Integer No

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

Default value: 30

sort String No

The property by which to sort the results.

Possible values:

  • "updated"
  • "created"

Default value: "created"

tool_guid String No

The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either tool_guid or tool_name, but not both.

state String No

If specified, only code scanning alerts with this state will be returned.

Possible values:

  • "fixed"
  • "open"
  • "closed"
  • "dismissed"
before String No

A cursor, as given in the Link header. If specified, the query only searches for results before this cursor. For more information, see "Using pagination in the REST API."

severity String No

If specified, only code scanning alerts with this severity will be returned.

Possible values:

  • "medium"
  • "high"
  • "low"
  • "critical"
  • "error"
  • "note"
  • "warning"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.