Configuring rate limits

Enabling rate limits for the GitHub Enterprise Server APIs

Enabling rate limits on the GitHub Enterprise Server APIs can prevent overuse of resources by individual or unauthenticated users. For more information, see "Resources in the REST API."

You can exempt a list of users from API rate limits using the ghe-config utility in the administrative shell. For more information, see "Command-line utilities."

1. From an administrative account on GitHub Enterprise Server, in the upper-right corner of any page, click .

   

2. If you're not already on the "Site admin" page, in the upper-left corner, click Site admin.

   

3. In the left sidebar, click Management Console.

4. Under "Rate Limiting", select Enable HTTP API Rate Limiting.

5. Type limits for authenticated and unauthenticated requests for each API, or accept the pre-filled default limits.

6. Under the left sidebar, click Save settings.

   

   Note: Saving settings in the Management Console restarts system services, which could result in user-visible downtime.

7. Wait for the configuration run to complete.

   

Enabling secondary rate limits

Setting secondary rate limits protects the overall level of service on your GitHub Enterprise Server instance.

1. From an administrative account on GitHub Enterprise Server, in the upper-right corner of any page, click .

   

2. If you're not already on the "Site admin" page, in the upper-left corner, click Site admin.

   

3. In the left sidebar, click Management Console.

4. Under "Rate Limiting", select Enable Abuse Rate Limiting.

5. Type limits for Total Requests, CPU Limit, and CPU Limit for Searching, or accept the pre-filled default limits.

6. Under the left sidebar, click Save settings.

   

   Note: Saving settings in the Management Console restarts system services, which could result in user-visible downtime.

7. Wait for the configuration run to complete.

   

Enabling rate limits for Git

You can apply Git rate limits per repository network or per user ID. Git rate limits are expressed in concurrent operations per minute, and are adaptive based on the current CPU load.

1. From an administrative account on GitHub Enterprise Server, in the upper-right corner of any page, click .

   

2. If you're not already on the "Site admin" page, in the upper-left corner, click Site admin.

   

3. In the left sidebar, click Management Console.

4. Under "Rate Limiting", select Enable Git Rate Limiting.

5. Type limits for each repository network or user ID.

6. Under the left sidebar, click Save settings.

   

   Note: Saving settings in the Management Console restarts system services, which could result in user-visible downtime.

7. Wait for the configuration run to complete.