User and IP rate limits

DETAILS: Tier: Free, Premium, Ultimate Offering: Self-managed

Rate limiting is a common technique used to improve the security and durability of a web application. For more details, see Rate limits.

The following limits are disabled by default:

• Unauthenticated API requests (per IP).
• Unauthenticated web requests (per IP).
• Authenticated API requests (per user).
• Authenticated web requests (per user).

NOTE: By default, all Git operations are first tried unauthenticated. Because of this, HTTP Git operations may trigger the rate limits configured for unauthenticated requests.

NOTE: The rate limits for API requests don't affect requests made by the frontend, as these are always counted as web traffic.

Enable unauthenticated API request rate limit

To enable the unauthenticated API request rate limit:

1. On the left sidebar, at the bottom, select Admin.

2. Select Settings > Network.

3. Expand User and IP rate limits.

4. Select Enable unauthenticated API request rate limit.

   • Optional. Update the Maximum unauthenticated API requests per rate limit period per IP value. Defaults to 3600.
   • Optional. Update the Unauthenticated rate limit period in seconds value. Defaults to 3600.

Enable unauthenticated web request rate limit

To enable the unauthenticated request rate limit:

1. On the left sidebar, at the bottom, select Admin.

2. Select Settings > Network.

3. Expand User and IP rate limits.

4. Select Enable unauthenticated web request rate limit.

   • Optional. Update the Maximum unauthenticated web requests per rate limit period per IP value. Defaults to 3600.
   • Optional. Update the Unauthenticated rate limit period in seconds value. Defaults to 3600.

Enable authenticated API request rate limit

To enable the authenticated API request rate limit:

1. On the left sidebar, at the bottom, select Admin.

2. Select Settings > Network.

3. Expand User and IP rate limits.

4. Select Enable authenticated API request rate limit.

   • Optional. Update the Maximum authenticated API requests per rate limit period per user value. Defaults to 7200.
   • Optional. Update the Authenticated API rate limit period in seconds value. Defaults to 3600.

Enable authenticated web request rate limit

To enable the authenticated request rate limit:

1. On the left sidebar, at the bottom, select Admin.

2. Select Settings > Network.

3. Expand User and IP rate limits.

4. Select Enable authenticated web request rate limit.

   • Optional. Update the Maximum authenticated web requests per rate limit period per user value. Defaults to 7200.
   • Optional. Update the Authenticated web rate limit period in seconds value. Defaults to 3600.

Use a custom rate limit response

A request that exceeds a rate limit returns a 429 response code and a plain-text body, which by default is Retry later.

To use a custom response:

1. On the left sidebar, at the bottom, select Admin.
2. Select Settings > Network.
3. Expand User and IP rate limits.
4. In the Plain-text response to send to clients that hit a rate limit text box, add the plain-text response message.

Maximum authenticated requests to project/:id/jobs per minute

• Introduced in GitLab 16.5.

To reduce timeouts, the project/:id/jobs endpoint has a default rate limit of 600 calls per authenticated user.

To modify the maximum number of requests:

1. On the left sidebar, at the bottom, select Admin.
2. Select Settings > Network.
3. Expand User and IP rate limits.
4. Update the Maximum authenticated requests to project/:id/jobs per minute value.

Response headers

When a client exceeds the associated rate limit, the following requests are blocked. The server may respond with rate-limiting information allowing the requester to retry after a specific period of time. These information are attached into the response headers.

Use an HTTP header to bypass rate limiting

Depending on the needs of your organization, you may want to enable rate limiting but have some requests bypass the rate limiter.

You can do this by marking requests that should bypass the rate limiter with a custom header. You must do this somewhere in a load balancer or reverse proxy in front of GitLab. For example:

1. Pick a name for your bypass header. For example, Gitlab-Bypass-Rate-Limiting.
2. Configure your load balancer to set Gitlab-Bypass-Rate-Limiting: 1 on requests that should bypass GitLab rate limiting.
3. Configure your load balancer to either:
   • Erase Gitlab-Bypass-Rate-Limiting.
   • Set Gitlab-Bypass-Rate-Limiting to a value other than 1 on all requests that should be affected by rate limiting.
4. Set the environment variable GITLAB_THROTTLE_BYPASS_HEADER.
   • For Linux package installations, set 'GITLAB_THROTTLE_BYPASS_HEADER' => 'Gitlab-Bypass-Rate-Limiting' in gitlab_rails['env'].
   • For self-compiled installations, set export GITLAB_THROTTLE_BYPASS_HEADER=Gitlab-Bypass-Rate-Limiting in /etc/default/gitlab.

It is important that your load balancer erases or overwrites the bypass header on all incoming traffic. Otherwise, you must trust your users to not set that header and bypass the GitLab rate limiter.

The bypass works only if the header is set to 1.

Requests that bypassed the rate limiter because of the bypass header are marked with "throttle_safelist":"throttle_bypass_header" in production_json.log.

To disable the bypass mechanism, make sure the environment variable GITLAB_THROTTLE_BYPASS_HEADER is unset or empty.

Allow specific users to bypass authenticated request rate limiting

Similarly to the bypass header described above, it is possible to allow a certain set of users to bypass the rate limiter. This only applies to authenticated requests: with unauthenticated requests, by definition GitLab does not know who the user is.

The allowlist is configured as a comma-separated list of user IDs in the GITLAB_THROTTLE_USER_ALLOWLIST environment variable. If you want users 1, 53 and 217 to bypass the authenticated request rate limiter, the allowlist configuration would be 1,53,217.

• For Linux package installations, set 'GITLAB_THROTTLE_USER_ALLOWLIST' => '1,53,217' in gitlab_rails['env'].
• For self-compiled installations, set export GITLAB_THROTTLE_USER_ALLOWLIST=1,53,217 in /etc/default/gitlab.

Requests that bypassed the rate limiter because of the user allowlist are marked with "throttle_safelist":"throttle_user_allowlist" in production_json.log.

At application startup, the allowlist is logged in auth.log.

Try out throttling settings before enforcing them

You can try out throttling settings by setting the GITLAB_THROTTLE_DRY_RUN environment variable to a comma-separated list of throttle names.

The possible names are:

• throttle_unauthenticated
  • Deprecated in GitLab 14.3. Use throttle_unauthenticated_api or throttle_unauthenticated_web instead. throttle_unauthenticated is still supported and selects both of them.
• throttle_unauthenticated_api
• throttle_unauthenticated_web
• throttle_authenticated_api
• throttle_authenticated_web
• throttle_unauthenticated_protected_paths
• throttle_authenticated_protected_paths_api
• throttle_authenticated_protected_paths_web
• throttle_unauthenticated_packages_api
• throttle_authenticated_packages_api
• throttle_authenticated_git_lfs
• throttle_unauthenticated_files_api
• throttle_authenticated_files_api
• throttle_unauthenticated_deprecated_api
• throttle_authenticated_deprecated_api

For example, to try out throttles for all authenticated requests to non-protected paths can be done by setting GITLAB_THROTTLE_DRY_RUN='throttle_authenticated_web,throttle_authenticated_api'.

To enable dry run mode for all throttles, the variable can be set to *.

Setting a throttle to dry run mode logs a message to the auth.log when it would hit the limit, while letting the request continue. The log message contains an env field set to track. The matched field contains the name of throttle that was hit.

It is important to set the environment variable before enabling the rate limiting in the settings. The settings in the Admin area take effect immediately, while setting the environment variable requires a restart of all the Puma processes.

Troubleshooting

Disable throttling after accidentally locking administrators out

If many users connect to GitLab through the same proxy or network gateway, it is possible that, if a rate limit is too low, that limit will also lock administrators out, because GitLab sees them using the same IP as the requests that triggered the throttling.

Administrators can use the Rails console to disable the same limits as listed for the GITLAB_THROTTLE_DRY_RUN variable. For example:

Gitlab::CurrentSettings.update!(throttle_authenticated_web_enabled: false)

In this example, the throttle_authenticated_web parameter has the _enabled name suffix.

To set numeric values for the limits, replace the _enabled name suffix with the _period_in_seconds and _requests_per_period suffixes.