You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
feat: add support for GET /enterprises/{enterprise}/code-scanning/alerts endpoint via octokit.rest.codeScanning.listAlertsForEnterprise() function (and description updates for other endpoints) (#523)
route: GET /enterprises/{enterprise}/code-scanning/alerts
5
+
scope: codeScanning
6
+
type: API method
7
+
---
8
+
9
+
# List code scanning alerts for an enterprise
10
+
11
+
Lists code scanning alerts for the default branch for all eligible repositories in an enterprise. 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](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)."
12
+
13
+
To use this endpoint, you must be a member of the enterprise,
14
+
and you must use an access token with the `repo` scope or `security_events` scope.
The slug version of the enterprise name. You can also substitute this value with the enterprise id.
36
+
37
+
</td></tr>
38
+
<tr><td>tool_name</td><td>no</td><td>
39
+
40
+
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.
41
+
42
+
</td></tr>
43
+
<tr><td>tool_guid</td><td>no</td><td>
44
+
45
+
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.
46
+
47
+
</td></tr>
48
+
<tr><td>before</td><td>no</td><td>
49
+
50
+
A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events before this cursor.
51
+
52
+
</td></tr>
53
+
<tr><td>after</td><td>no</td><td>
54
+
55
+
A cursor, as given in the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header). If specified, the query only searches for events after this cursor.
56
+
57
+
</td></tr>
58
+
<tr><td>page</td><td>no</td><td>
59
+
60
+
Page number of the results to fetch.
61
+
62
+
</td></tr>
63
+
<tr><td>per_page</td><td>no</td><td>
64
+
65
+
The number of results per page (max 100).
66
+
67
+
</td></tr>
68
+
<tr><td>direction</td><td>no</td><td>
69
+
70
+
The direction to sort the results by.
71
+
72
+
</td></tr>
73
+
<tr><td>state</td><td>no</td><td>
74
+
75
+
If specified, only code scanning alerts with this state will be returned.
76
+
77
+
</td></tr>
78
+
<tr><td>sort</td><td>no</td><td>
79
+
80
+
The property by which to sort the results.
81
+
82
+
</td></tr>
83
+
</tbody>
84
+
</table>
85
+
86
+
See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/code-scanning#list-code-scanning-alerts-for-an-enterprise).
Copy file name to clipboardExpand all lines: docs/projects/createForAuthenticatedUser.md
+2Lines changed: 2 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,6 +8,8 @@ type: API method
8
8
9
9
# Create a user project
10
10
11
+
Creates a user project board. Returns a `410 Gone` status if the user does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.
Copy file name to clipboardExpand all lines: docs/projects/createForOrg.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ type: API method
8
8
9
9
# Create an organization project
10
10
11
-
Creates an organization project board. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.
11
+
Creates an organization project board. Returns a `410 Gone` status if projects are disabled in the organization or if the organization does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.
Copy file name to clipboardExpand all lines: docs/projects/createForRepo.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ type: API method
8
8
9
9
# Create a repository project
10
10
11
-
Creates a repository project board. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.
11
+
Creates a repository project board. Returns a `410 Gone` status if projects are disabled in the repository or if the repository does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.
Copy file name to clipboardExpand all lines: src/generated/method-types.ts
+20-3Lines changed: 20 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -2980,6 +2980,21 @@ export type RestEndpointMethods = {
2980
2980
defaults: RequestInterface["defaults"];
2981
2981
endpoint: EndpointInterface<{ url: string }>;
2982
2982
};
2983
+
/**
2984
+
* Lists code scanning alerts for the default branch for all eligible repositories in an enterprise. 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](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)."
2985
+
*
2986
+
* To use this endpoint, you must be a member of the enterprise,
2987
+
* and you must use an access token with the `repo` scope or `security_events` scope.
* 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](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)."
2985
3000
*
@@ -6788,7 +6803,9 @@ export type RestEndpointMethods = {
6788
6803
defaults: RequestInterface["defaults"];
6789
6804
endpoint: EndpointInterface<{ url: string }>;
6790
6805
};
6791
-
6806
+
/**
6807
+
* Creates a user project board. Returns a `410 Gone` status if the user does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.
@@ -6799,7 +6816,7 @@ export type RestEndpointMethods = {
6799
6816
endpoint: EndpointInterface<{ url: string }>;
6800
6817
};
6801
6818
/**
6802
-
* Creates an organization project board. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.
6819
+
* Creates an organization project board. Returns a `410 Gone` status if projects are disabled in the organization or if the organization does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.
6803
6820
*/
6804
6821
createForOrg: {
6805
6822
(
@@ -6811,7 +6828,7 @@ export type RestEndpointMethods = {
6811
6828
endpoint: EndpointInterface<{ url: string }>;
6812
6829
};
6813
6830
/**
6814
-
* Creates a repository project board. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.
6831
+
* Creates a repository project board. Returns a `410 Gone` status if projects are disabled in the repository or if the repository does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.
0 commit comments