Viewing your GitHub Advanced Security usage

About licenses for GitHub Advanced Security

Each license for GitHub Advanced Security specifies a maximum number of licenses that can use these features. Periodically you should check that your use is within your license capacity. For more information, see "About billing for GitHub Advanced Security."

Viewing GitHub Advanced Security license usage for your enterprise account

You can view the enterprise account's current license limits and usage.

1. In the top-right corner of GitHub, click your profile photo.

2. Depending on your environment, click Your enterprise, or click Your enterprises then click the enterprise you want to view.

3. On the left side of the page, in the enterprise account sidebar, click Settings.

4. Under Settings, click Licensing.

   Note

   If you are on the enhanced billing platform, the licensing page has been relocated. See "Gathering insights on your spending." The "GitHub Advanced Security" section shows details of the current usage.

   If you run out of licenses, the section will be red and show "Limit exceeded." You should either reduce your use of GitHub Advanced Security or purchase more licenses. For more information, see "About billing for GitHub Advanced Security" and "Managing your GitHub Advanced Security licensing."

   Note

   With security configurations, you can manage GitHub Advanced Security feature enablement and license usage for your organization. See "Managing your GitHub Advanced Security license usage."

5. Optionally, to see a detailed breakdown of usage per organization and user namespace when using Enterprise Managed Users, in the enterprise account sidebar, click Billing.

   In the “GitHub Advanced Security” section, you can see a summary of your current license usage, as well as the number of committers and unique committers for each organization and user namespace when using Enterprise Managed Users. The organizations and user namespaces in the billing table are sorted by the highest number of unique committers in descending order.

6. Optionally, display the security and analysis settings for an organization.

   • Click the name of the organization.

   • On the "Code security & analysis" settings page, scroll to the "GitHub Advanced Security repositories" section to see an overview of your organization's license usage, as well as a detailed breakdown of usage by repository for this organization.

     For more information, see "Managing security and analysis settings for your organization."

Downloading GitHub Advanced Security license usage information

You can download a CSV file with GitHub Advanced Security license usage information at both the enterprise and organization levels. The CSV file contains information about each Advanced Security license that is in use, including:

• The username of the person using the license
• The Advanced Security-enabled repositories where commits were made
• The organizations and user namespaces for Enterprise Managed Users that people using licenses belong to
• The most recent commit dates and associated email addresses

You can use this information for insights into your Advanced Security usage, such as which members of your enterprise are using an Advanced Security license or how Advanced Security licenses are being consumed across your organizations.

You can download the Advanced Security license usage CSV through the GitHub Enterprise Cloud user interface or the REST API.

Downloading Advanced Security license usage information through the UI

At the repository-level

1. In the upper-right corner of GitHub, select your profile photo, then click Your organizations.

2. Next to the organization, click Settings.

3. In the "Security" section of the sidebar, click Code security and analysis.

4. In the "GitHub Advanced Security repositories" section, next to the repository you want usage information for, select , then click Download CSV report.

   

At the organization-level

1. In the upper-right corner of GitHub, select your profile photo, then click Your organizations.
2. Next to the organization, click Settings.
3. In the "Access" section of the sidebar, click Billing and plans.
4. Underneath "GitHub Advanced Security," next to "Committers", click CSV report.

At the enterprise-level

1. In the top-right corner of GitHub, click your profile photo.

2. Depending on your environment, click Your enterprise, or click Your enterprises then click the enterprise you want to view.

3. On the left side of the page, in the enterprise account sidebar, click Settings.

4. Under Settings, click Licensing.

   Note

   If you are on the enhanced billing platform, the licensing page has been relocated. See "Gathering insights on your spending."

5. Under "GitHub Advanced Security," click the Manage dropdown and then click Download report.

   

Downloading Advanced Security license usage information through the REST API

You can retrieve Advanced Security usage information via the billing API.

For organization-level data, use the /orgs/{org}/settings/billing/advanced-security endpoint. For more information, see "REST API endpoints for billing."

For enterprise-level data, use the /enterprises/{enterprise}/settings/billing/advanced-security endpoint. For more information, see "REST API endpoints for GitHub Enterprise administration" in the GitHub REST API documentation.