REST API endpoints for enterprise billing
Use the REST API to retrieve the billing information for a GitHub Enterprise Server instance.
These endpoints only support authentication using a personal access token (classic). For more information, see "Managing your personal access tokens."
The manage_billing:enterprise
scope is required for personal access tokens (classic) to access these endpoints.
Get GitHub Advanced Security active committers for an enterprise
Gets the GitHub Advanced Security active committers for an enterprise per repository.
Each distinct user login across all repositories is counted as a single Advanced Security seat, so the total_advanced_security_committers
is not the sum of active_users for each repository.
The total number of repositories with committer information is tracked by the total_count
field.
Fine-grained access tokens for "Get GitHub Advanced Security active committers for an enterprise"
This endpoint works with the following fine-grained token types:
- GitHub App user access tokens
- GitHub App installation access tokens
- Fine-grained personal access tokens
The fine-grained token must have the following permission set:
- "Enterprise administration" business permissions (write)
Parameters for "Get GitHub Advanced Security active committers for an enterprise"
Name, Type, Description |
---|
accept string Setting to |
Name, Type, Description |
---|
enterprise string RequiredThe slug version of the enterprise name. You can also substitute this value with the enterprise id. |
Name, Type, Description |
---|
per_page integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." Default: |
page integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Default: |
HTTP response status codes for "Get GitHub Advanced Security active committers for an enterprise"
Status code | Description |
---|---|
200 | Success |
Code samples for "Get GitHub Advanced Security active committers for an enterprise"
Request example
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "X-GitHub-Api-Version: 2022-11-28" \
http(s)://HOSTNAME/api/v3/enterprises/ENTERPRISE/settings/billing/advanced-security
Success
Status: 200
{
"total_advanced_security_committers": 2,
"total_count": 2,
"maximum_advanced_security_committers": 4,
"purchased_advanced_security_committers": 4,
"repositories": [
{
"name": "octocat-org/Hello-World",
"advanced_security_committers": 2,
"advanced_security_committers_breakdown": [
{
"user_login": "octocat",
"last_pushed_date": "2021-11-03",
"last_pushed_email": "octocat@github.com"
},
{
"user_login": "octokitten",
"last_pushed_date": "2021-10-25",
"last_pushed_email": "octokitten@github.com"
}
]
},
{
"name": "octocat-org/server",
"advanced_security_committers": 1,
"advanced_security_committers_breakdown": [
{
"user_login": "octokitten",
"last_pushed_date": "2021-10-26",
"last_pushed_email": "octokitten@github.com"
}
]
}
]
}