Application settings API

These API calls allow you to read and modify GitLab instance application settings as they appear in /admin/application_settings/general. You must be an administrator to perform this action.

Application settings are subject to caching and may not immediately take effect. By default, GitLab caches application settings for 60 seconds. For information on how to control the application settings cache for an instance, see Application cache interval.

Get current application settings

List the current application settings of the GitLab instance.

GET /application/settings
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/application/settings"

Example response:

{
  "default_projects_limit" : 100000,
  "signup_enabled" : true,
  "id" : 1,
  "default_branch_protection" : 2,
  "restricted_visibility_levels" : [],
  "password_authentication_enabled_for_web" : true,
  "after_sign_out_path" : null,
  "max_attachment_size" : 10,
  "max_export_size": 50,
  "max_import_size": 50,
  "user_oauth_applications" : true,
  "updated_at" : "2016-01-04T15:44:55.176Z",
  "session_expire_delay" : 10080,
  "home_page_url" : null,
  "default_snippet_visibility" : "private",
  "outbound_local_requests_whitelist": [],
  "domain_allowlist" : [],
  "domain_denylist_enabled" : false,
  "domain_denylist" : [],
  "created_at" : "2016-01-04T15:44:55.176Z",
  "default_ci_config_path" : null,
  "default_project_visibility" : "private",
  "default_group_visibility" : "private",
  "gravatar_enabled" : true,
  "sign_in_text" : null,
  "container_expiration_policies_enable_historic_entries": true,
  "container_registry_cleanup_tags_service_max_list_size": 200,
  "container_registry_delete_tags_service_timeout": 250,
  "container_registry_expiration_policies_caching": true,
  "container_registry_expiration_policies_worker_capacity": 4,
  "container_registry_token_expire_delay": 5,
  "repository_storages_weighted": {"default": 100},
  "plantuml_enabled": false,
  "plantuml_url": null,
  "kroki_enabled": false,
  "kroki_url": null,
  "terminal_max_session_time": 0,
  "polling_interval_multiplier": 1.0,
  "rsa_key_restriction": 0,
  "dsa_key_restriction": 0,
  "ecdsa_key_restriction": 0,
  "ed25519_key_restriction": 0,
  "ecdsa_sk_key_restriction": 0,
  "ed25519_sk_key_restriction": 0,
  "first_day_of_week": 0,
  "enforce_terms": true,
  "terms": "Hello world!",
  "performance_bar_allowed_group_id": 42,
  "user_show_add_ssh_key_message": true,
  "local_markdown_version": 0,
  "allow_local_requests_from_hooks_and_services": true,
  "allow_local_requests_from_web_hooks_and_services": true,
  "allow_local_requests_from_system_hooks": false,
  "asset_proxy_enabled": true,
  "asset_proxy_url": "https://assets.example.com",
  "asset_proxy_whitelist": ["example.com", "*.example.com", "your-instance.com"],
  "asset_proxy_allowlist": ["example.com", "*.example.com", "your-instance.com"],
  "maven_package_requests_forwarding": true,
  "npm_package_requests_forwarding": true,
  "pypi_package_requests_forwarding": true,
  "snippet_size_limit": 52428800,
  "issues_create_limit": 300,
  "raw_blob_request_limit": 300,
  "wiki_page_max_content_bytes": 52428800,
  "require_admin_approval_after_user_signup": false,
  "personal_access_token_prefix": "glpat-",
  "rate_limiting_response_text": null,
  "keep_latest_artifact": true,
  "admin_mode": false,
  "floc_enabled": false,
  "external_pipeline_validation_service_timeout": null,
  "external_pipeline_validation_service_token": null,
  "external_pipeline_validation_service_url": null
}

Users on GitLab Premium or Ultimate may also see the file_template_project_id, delayed_project_deletion, delayed_group_deletion, deletion_adjourned_period, or the geo_node_allowed_ips parameters:

{
  "id" : 1,
  "signup_enabled" : true,
  "file_template_project_id": 1,
  "geo_node_allowed_ips": "0.0.0.0/0, ::/0",
  "delayed_project_deletion": false,
  "delayed_group_deletion": false,
  "deletion_adjourned_period": 7,
  ...
}

Change application settings

Use an API call to modify GitLab instance application settings.

PUT /application/settings
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/application/settings?signup_enabled=false&default_project_visibility=internal"

Example response:

{
  "id": 1,
  "default_projects_limit": 100000,
  "signup_enabled": false,
  "password_authentication_enabled_for_web": true,
  "gravatar_enabled": true,
  "sign_in_text": "",
  "created_at": "2015-06-12T15:51:55.432Z",
  "updated_at": "2015-06-30T13:22:42.210Z",
  "home_page_url": "",
  "default_branch_protection": 2,
  "restricted_visibility_levels": [],
  "max_attachment_size": 10,
  "max_export_size": 50,
  "max_import_size": 50,
  "session_expire_delay": 10080,
  "default_ci_config_path" : null,
  "default_project_visibility": "internal",
  "default_snippet_visibility": "private",
  "default_group_visibility": "private",
  "outbound_local_requests_whitelist": [],
  "domain_allowlist": [],
  "domain_denylist_enabled" : false,
  "domain_denylist" : [],
  "external_authorization_service_enabled": true,
  "external_authorization_service_url": "https://authorize.me",
  "external_authorization_service_default_label": "default",
  "external_authorization_service_timeout": 0.5,
  "user_oauth_applications": true,
  "after_sign_out_path": "",
  "container_expiration_policies_enable_historic_entries": true,
  "container_registry_cleanup_tags_service_max_list_size": 200,
  "container_registry_delete_tags_service_timeout": 250,
  "container_registry_expiration_policies_caching": true,
  "container_registry_expiration_policies_worker_capacity": 4,
  "container_registry_token_expire_delay": 5,
  "package_registry_cleanup_policies_worker_capacity": 2,
  "repository_storages": ["default"],
  "plantuml_enabled": false,
  "plantuml_url": null,
  "terminal_max_session_time": 0,
  "polling_interval_multiplier": 1.0,
  "rsa_key_restriction": 0,
  "dsa_key_restriction": 0,
  "ecdsa_key_restriction": 0,
  "ed25519_key_restriction": 0,
  "ecdsa_sk_key_restriction": 0,
  "ed25519_sk_key_restriction": 0,
  "first_day_of_week": 0,
  "enforce_terms": true,
  "terms": "Hello world!",
  "performance_bar_allowed_group_id": 42,
  "user_show_add_ssh_key_message": true,
  "file_template_project_id": 1,
  "local_markdown_version": 0,
  "asset_proxy_enabled": true,
  "asset_proxy_url": "https://assets.example.com",
  "asset_proxy_allowlist": ["example.com", "*.example.com", "your-instance.com"],
  "geo_node_allowed_ips": "0.0.0.0/0, ::/0",
  "allow_local_requests_from_hooks_and_services": true,
  "allow_local_requests_from_web_hooks_and_services": true,
  "allow_local_requests_from_system_hooks": false,
  "maven_package_requests_forwarding": true,
  "npm_package_requests_forwarding": true,
  "pypi_package_requests_forwarding": true,
  "snippet_size_limit": 52428800,
  "issues_create_limit": 300,
  "raw_blob_request_limit": 300,
  "wiki_page_max_content_bytes": 52428800,
  "require_admin_approval_after_user_signup": false,
  "personal_access_token_prefix": "glpat-",
  "rate_limiting_response_text": null,
  "keep_latest_artifact": true,
  "admin_mode": false,
  "external_pipeline_validation_service_timeout": null,
  "external_pipeline_validation_service_token": null,
  "external_pipeline_validation_service_url": null
}

Users on GitLab Premium or Ultimate may also see these parameters:

  • file_template_project_id
  • geo_node_allowed_ips
  • geo_status_timeout
  • delayed_project_deletion
  • delayed_group_deletion
  • deletion_adjourned_period

Example responses:

  "file_template_project_id": 1,
  "geo_node_allowed_ips": "0.0.0.0/0, ::/0"

List of settings that can be accessed via API calls

In general, all settings are optional. Certain settings though, if enabled, require other settings to be set to function properly. These requirements are listed in the descriptions of the relevant settings.

AttributeTypeRequiredDescription
admin_modebooleannoRequire administrators to enable Admin Mode by re-authenticating for administrative tasks.
admin_notification_emailstringnoDeprecated: Use abuse_notification_email instead. If set, abuse reports are sent to this address. Abuse reports are always available in the Admin Area.
abuse_notification_emailstringnoIf set, abuse reports are sent to this address. Abuse reports are always available in the Admin Area.
after_sign_out_pathstringnoWhere to redirect users after logout.
after_sign_up_textstringnoText shown to the user after signing up.
akismet_api_keystringrequired by: akismet_enabled API key for Akismet spam protection.
akismet_enabledbooleanno(If enabled, requires: akismet_api_key) Enable or disable Akismet spam protection.
allow_group_owners_to_manage_ldap booleannoSet to true to allow group owners to manage LDAP.
allow_local_requests_from_hooks_and_servicesbooleanno(Deprecated: Use allow_local_requests_from_web_hooks_and_services instead) Allow requests to the local network from hooks and services.
allow_local_requests_from_system_hooksbooleannoAllow requests to the local network from system hooks.
allow_local_requests_from_web_hooks_and_servicesbooleannoAllow requests to the local network from web hooks and services.
archive_builds_in_human_readablestringnoSet the duration for which the jobs are considered as old and expired. After that time passes, the jobs are archived and no longer able to be retried. Make it empty to never expire jobs. It has to be no less than 1 day, for example: 15 days, 1 month, 2 years.
asset_proxy_enabledbooleanno(If enabled, requires: asset_proxy_url) Enable proxying of assets. GitLab restart is required to apply changes.
asset_proxy_secret_keystringnoShared secret with the asset proxy server. GitLab restart is required to apply changes.
asset_proxy_urlstringnoURL of the asset proxy server. GitLab restart is required to apply changes.
asset_proxy_whiteliststring or array of stringsno(Deprecated: Use asset_proxy_allowlist instead) Assets that match these domains are not proxied. Wildcards allowed. Your GitLab installation URL is automatically allowlisted. GitLab restart is required to apply changes.
asset_proxy_allowliststring or array of stringsnoAssets that match these domains are not proxied. Wildcards allowed. Your GitLab installation URL is automatically allowlisted. GitLab restart is required to apply changes.
authorized_keys_enabledbooleannoBy default, we write to the authorized_keys file to support Git over SSH without additional configuration. GitLab can be optimized to authenticate SSH keys via the database file. Only disable this if you have configured your OpenSSH server to use the AuthorizedKeysCommand.
auto_devops_domainstringnoSpecify a domain to use by default for every project’s Auto Review Apps and Auto Deploy stages.
auto_devops_enabledbooleannoEnable Auto DevOps for projects by default. It automatically builds, tests, and deploys applications based on a predefined CI/CD configuration.
automatic_purchased_storage_allocationbooleannoEnabling this permits automatic allocation of purchased storage in a namespace.
check_namespace_plan booleannoEnabling this makes only licensed EE features available to projects if the project namespace’s plan includes the feature or if the project is public.
commit_email_hostnamestringnoCustom hostname (for private commit emails).
container_expiration_policies_enable_historic_entriesbooleannoEnable cleanup policies for all projects.
container_registry_cleanup_tags_service_max_list_sizeintegernoThe maximum number of tags that can be deleted in a single execution of cleanup policies.
container_registry_delete_tags_service_timeoutintegernoThe maximum time, in seconds, that the cleanup process can take to delete a batch of tags for cleanup policies.
container_registry_expiration_policies_cachingbooleannoCaching during the execution of cleanup policies.
container_registry_expiration_policies_worker_capacityintegernoNumber of workers for cleanup policies.
container_registry_token_expire_delayintegernoContainer Registry token duration in minutes.
package_registry_cleanup_policies_worker_capacityintegernoNumber of workers assigned to the packages cleanup policies.
deactivate_dormant_usersbooleannoEnable automatic deactivation of dormant users.
deactivate_dormant_users_periodintegernoLength of time (in days) after which a user is considered dormant. Introduced in GitLab 15.3.
default_artifacts_expire_instringnoSet the default expiration time for each job’s artifacts.
default_branch_namestringno Instance-level custom initial branch name. Introduced in GitLab 13.2.
default_branch_protectionintegernoDetermine if developers can push to the default branch. Can take: 0 (not protected, both users with the Developer role or Maintainer role can push new commits and force push), 1 (partially protected, users with the Developer role or Maintainer role can push new commits, but cannot force push) or 2 (fully protected, users with the Developer or Maintainer role cannot push new commits, but users with the Developer or Maintainer role can; no one can force push) as a parameter. Default is 2.
default_ci_config_pathstringnoDefault CI/CD configuration file and path for new projects (.gitlab-ci.yml if not set).
default_group_visibilitystringnoWhat visibility level new groups receive. Can take private, internal and public as a parameter. Default is private.
default_project_creationintegernoDefault project creation protection. Can take: 0 (No one), 1 (Maintainers) or 2 (Developers + Maintainers)
default_project_visibilitystringnoWhat visibility level new projects receive. Can take private, internal and public as a parameter. Default is private.
default_projects_limitintegernoProject limit per user. Default is 100000.
default_snippet_visibilitystringnoWhat visibility level new snippets receive. Can take private, internal and public as a parameter. Default is private.
delayed_project_deletion booleannoEnable delayed project deletion by default in new groups. Default is false. From GitLab 15.1, can only be enabled when delayed_group_deletion is true.
delayed_group_deletion booleannoEnable delayed group deletion. Default is true. Introduced in GitLab 15.0. From GitLab 15.1, disables and locks the group-level setting for delayed protect deletion when set to false.
delete_inactive_projectsbooleannoEnable inactive project deletion feature. Default is false. Introduced in GitLab 14.10. Became operational without feature flag in GitLab 15.4.
deletion_adjourned_period integernoThe number of days to wait before deleting a project or group that is marked for deletion. Value must be between 1 and 90. Defaults to 7. From GitLab 15.1, a hook on deletion_adjourned_period sets the period to 1 on every update, and sets both delayed_project_deletion and delayed_group_deletion to false if the period is 0.
diff_max_patch_bytesintegernoMaximum diff patch size, in bytes.
diff_max_filesintegernoMaximum files in a diff.
diff_max_linesintegernoMaximum lines in a diff.
disable_feed_tokenbooleannoDisable display of RSS/Atom and calendar feed tokens. Introduced in GitLab 13.7.
disabled_oauth_sign_in_sourcesarray of stringsnoDisabled OAuth sign-in sources.
dns_rebinding_protection_enabledbooleannoEnforce DNS rebinding attack protection.
domain_denylist_enabledbooleanno(If enabled, requires: domain_denylist) Allows blocking sign-ups from emails from specific domains.
domain_denylistarray of stringsnoUsers with email addresses that match these domains cannot sign up. Wildcards allowed. Use separate lines for multiple entries. Ex: domain.com, *.domain.com.
domain_allowlistarray of stringsnoForce people to use only corporate emails for sign-up. Default is null, meaning there is no restriction.
dsa_key_restrictionintegernoThe minimum allowed bit length of an uploaded DSA key. Default is 0 (no restriction). -1 disables DSA keys.
ecdsa_key_restrictionintegernoThe minimum allowed curve size (in bits) of an uploaded ECDSA key. Default is 0 (no restriction). -1 disables ECDSA keys.
ecdsa_sk_key_restrictionintegernoThe minimum allowed curve size (in bits) of an uploaded ECDSA_SK key. Default is 0 (no restriction). -1 disables ECDSA_SK keys.
ed25519_key_restrictionintegernoThe minimum allowed curve size (in bits) of an uploaded ED25519 key. Default is 0 (no restriction). -1 disables ED25519 keys.
ed25519_sk_key_restrictionintegernoThe minimum allowed curve size (in bits) of an uploaded ED25519_SK key. Default is 0 (no restriction). -1 disables ED25519_SK keys.
eks_access_key_idstringnoAWS IAM access key ID.
eks_account_idstringnoAmazon account ID.
eks_integration_enabledbooleannoEnable integration with Amazon EKS.
eks_secret_access_keystringnoAWS IAM secret access key.
elasticsearch_aws_access_key stringnoAWS IAM access key.
elasticsearch_aws_region stringnoThe AWS region the Elasticsearch domain is configured.
elasticsearch_aws_secret_access_key stringnoAWS IAM secret access key.
elasticsearch_aws booleannoEnable the use of AWS hosted Elasticsearch.
elasticsearch_indexed_field_length_limit integernoMaximum size of text fields to index by Elasticsearch. 0 value means no limit. This does not apply to repository and wiki indexing.
elasticsearch_indexed_file_size_limit_kb integernoMaximum size of repository and wiki files that are indexed by Elasticsearch.
elasticsearch_indexing booleannoEnable Elasticsearch indexing.
elasticsearch_limit_indexing booleannoLimit Elasticsearch to index certain namespaces and projects.
elasticsearch_max_bulk_concurrency integernoMaximum concurrency of Elasticsearch bulk requests per indexing operation. This only applies to repository indexing operations.
elasticsearch_max_bulk_size_mb integernoMaximum size of Elasticsearch bulk indexing requests in MB. This only applies to repository indexing operations.
elasticsearch_namespace_ids array of integersnoThe namespaces to index via Elasticsearch if elasticsearch_limit_indexing is enabled.
elasticsearch_project_ids array of integersnoThe projects to index via Elasticsearch if elasticsearch_limit_indexing is enabled.
elasticsearch_search booleannoEnable Elasticsearch search.
elasticsearch_url stringnoThe URL to use for connecting to Elasticsearch. Use a comma-separated list to support cluster (for example, http://localhost:9200, http://localhost:9201").
elasticsearch_username stringnoThe username of your Elasticsearch instance.
elasticsearch_password stringnoThe password of your Elasticsearch instance.
email_additional_text stringnoAdditional text added to the bottom of every email for legal/auditing/compliance reasons.
email_author_in_bodybooleannoSome email servers do not support overriding the email sender name. Enable this option to include the name of the author of the issue, merge request or comment in the email body instead.
enabled_git_access_protocolstringnoEnabled protocols for Git access. Allowed values are: ssh, http, and nil to allow both protocols.
enforce_namespace_storage_limitbooleannoEnabling this permits enforcement of namespace storage limits.
enforce_termsbooleanno(If enabled, requires: terms) Enforce application ToS to all users.
external_auth_client_certstringno(If enabled, requires: external_auth_client_key) The certificate to use to authenticate with the external authorization service.
external_auth_client_key_passstringnoPassphrase to use for the private key when authenticating with the external service this is encrypted when stored.
external_auth_client_keystringrequired by: external_auth_client_cert Private key for the certificate when authentication is required for the external authorization service, this is encrypted when stored.
external_authorization_service_default_labelstringrequired by:
external_authorization_service_enabled
The default classification label to use when requesting authorization and no classification label has been specified on the project.
external_authorization_service_enabledbooleanno(If enabled, requires: external_authorization_service_default_label, external_authorization_service_timeout and external_authorization_service_url) Enable using an external authorization service for accessing projects.
external_authorization_service_timeoutfloatrequired by:
external_authorization_service_enabled
The timeout after which an authorization request is aborted, in seconds. When a request times out, access is denied to the user. (min: 0.001, max: 10, step: 0.001).
external_authorization_service_urlstringrequired by:
external_authorization_service_enabled
URL to which authorization requests are directed.
external_pipeline_validation_service_urlstringnoURL to use for pipeline validation requests.
external_pipeline_validation_service_tokenstringnoOptional. Token to include as the X-Gitlab-Token header in requests to the URL in external_pipeline_validation_service_url.
external_pipeline_validation_service_timeoutintegernoHow long to wait for a response from the pipeline validation service. Assumes OK if it times out.
file_template_project_id integernoThe ID of a project to load custom file templates from.
first_day_of_weekintegernoStart day of the week for calendar views and date pickers. Valid values are 0 (default) for Sunday, 1 for Monday, and 6 for Saturday.
geo_node_allowed_ips stringyesComma-separated list of IPs and CIDRs of allowed secondary nodes. For example, 1.1.1.1, 2.2.2.0/24.
geo_status_timeout integernoThe amount of seconds after which a request to get a secondary node status times out.
git_two_factor_session_expiry integernoMaximum duration (in minutes) of a session for Git operations when 2FA is enabled.
gitaly_timeout_defaultintegernoDefault Gitaly timeout, in seconds. This timeout is not enforced for Git fetch/push operations or Sidekiq jobs. Set to 0 to disable timeouts.
gitaly_timeout_fastintegernoGitaly fast operation timeout, in seconds. Some Gitaly operations are expected to be fast. If they exceed this threshold, there may be a problem with a storage shard and ‘failing fast’ can help maintain the stability of the GitLab instance. Set to 0 to disable timeouts.
gitaly_timeout_mediumintegernoMedium Gitaly timeout, in seconds. This should be a value between the Fast and the Default timeout. Set to 0 to disable timeouts.
grafana_enabledbooleannoEnable Grafana.
grafana_urlstringnoGrafana URL.
gravatar_enabledbooleannoEnable Gravatar.
hashed_storage_enabledbooleannoCreate new projects using hashed storage paths: Enable immutable, hash-based paths and repository names to store repositories on disk. This prevents repositories from having to be moved or renamed when the Project URL changes and may improve disk I/O performance. (Always enabled in GitLab versions 13.0 and later, configuration is scheduled for removal in 14.0)
help_page_hide_commercial_contentbooleannoHide marketing-related entries from help.
help_page_support_urlstringnoAlternate support URL for help page and help dropdown.
help_page_textstringnoCustom text displayed on the help page.
help_text stringnoGitLab server administrator information.
hide_third_party_offersbooleannoDo not display offers from third parties in GitLab.
home_page_urlstringnoRedirect to this URL when not logged in.
housekeeping_bitmaps_enabledbooleannoGit pack file bitmap creation is always enabled and cannot be changed via API and UI. This API field is deprecated and always returns true.
housekeeping_enabledbooleanno(If enabled, requires: housekeeping_bitmaps_enabled, housekeeping_full_repack_period, housekeeping_gc_period, and housekeeping_incremental_repack_period) Enable or disable Git housekeeping.
housekeeping_full_repack_periodintegerrequired by: housekeeping_enabled Number of Git pushes after which an incremental git repack is run.
housekeeping_gc_periodintegerrequired by: housekeeping_enabled Number of Git pushes after which git gc is run.
housekeeping_incremental_repack_periodintegerrequired by: housekeeping_enabled Number of Git pushes after which an incremental git repack is run.
html_emails_enabledbooleannoEnable HTML emails.
import_sourcesarray of stringsnoSources to allow project import from, possible values: github, bitbucket, bitbucket_server, gitlab, fogbugz, git, gitlab_project, gitea, manifest, and phabricator.
in_product_marketing_emails_enabledbooleannoEnable in-product marketing emails. Enabled by default.
inactive_projects_delete_after_monthsintegernoIf delete_inactive_projects is true, the time (in months) to wait before deleting inactive projects. Default is 2. Introduced in GitLab 14.10. Became operational in GitLab 15.0.
inactive_projects_min_size_mbintegernoIf delete_inactive_projects is true, the minimum repository size for projects to be checked for inactivity. Default is 0. Introduced in GitLab 14.10. Became operational in GitLab 15.0.
inactive_projects_send_warning_email_after_monthsintegernoIf delete_inactive_projects is true, sets the time (in months) to wait before emailing maintainers that the project is scheduled be deleted because it is inactive. Default is 1. Introduced in GitLab 14.10. Became operational in GitLab 15.0.
invisible_captcha_enabledbooleannoEnable Invisible CAPTCHA spam detection during sign-up. Disabled by default.
issues_create_limitintegernoMax number of issue creation requests per minute per user. Disabled by default.
keep_latest_artifactbooleannoPrevent the deletion of the artifacts from the most recent successful jobs, regardless of the expiry time. Enabled by default.
local_markdown_versionintegernoIncrease this value when any cached Markdown should be invalidated.
mailgun_signing_keystringnoThe Mailgun HTTP webhook signing key for receiving events from webhook.
mailgun_events_enabledbooleannoEnable Mailgun event receiver.
maintenance_mode_message stringnoMessage displayed when instance is in maintenance mode.
maintenance_mode booleannoWhen instance is in maintenance mode, non-administrative users can sign in with read-only access and make read-only API requests.
max_artifacts_sizeintegernoMaximum artifacts size in MB.
max_attachment_sizeintegernoLimit attachment size in MB.
max_export_sizeintegernoMaximum export size in MB. 0 for unlimited. Default = 0 (unlimited).
max_import_sizeintegernoMaximum import size in MB. 0 for unlimited. Default = 0 (unlimited). Changed from 50 MB to 0 in GitLab 13.8.
max_pages_sizeintegernoMaximum size of pages repositories in MB.
max_personal_access_token_lifetime integernoMaximum allowable lifetime for access tokens in days.
max_ssh_key_lifetime integernoMaximum allowable lifetime for SSH keys in days. Introduced in GitLab 14.6.
metrics_method_call_thresholdintegernoA method call is only tracked when it takes longer than the given amount of milliseconds.
max_number_of_repository_downloads integernoMaximum number of unique repositories a user can download in the specified time period before they are banned. Default: 0, Maximum: 10,000 repositories. Introduced in GitLab 15.1.
max_number_of_repository_downloads_within_time_period integernoReporting time period (in seconds). Default: 0, Maximum: 864000 seconds (10 days). Introduced in GitLab 15.1.
git_rate_limit_users_allowlist array of stringsnoList of usernames excluded from Git anti-abuse rate limits. Default: [], Maximum: 100 usernames. Introduced in GitLab 15.2.
auto_ban_user_on_excessive_projects_download booleannoWhen enabled, users will get automatically banned from the application when they download more than the maximum number of unique projects in the time period specified by max_number_of_repository_downloads and max_number_of_repository_downloads_within_time_period respectively. Introduced in GitLab 15.4
mirror_availablebooleannoAllow repository mirroring to configured by project Maintainers. If disabled, only Administrators can configure repository mirroring.
mirror_capacity_threshold integernoMinimum capacity to be available before scheduling more mirrors preemptively.
mirror_max_capacity integernoMaximum number of mirrors that can be synchronizing at the same time.
mirror_max_delay integernoMaximum time (in minutes) between updates that a mirror can have when scheduled to synchronize.
maven_package_requests_forwarding booleannoUse repo.maven.apache.org as a default remote repository when the package is not found in the GitLab Package Registry for Maven.
npm_package_requests_forwarding booleannoUse npmjs.org as a default remote repository when the package is not found in the GitLab Package Registry for npm.
pypi_package_requests_forwarding booleannoUse pypi.org as a default remote repository when the package is not found in the GitLab Package Registry for PyPI.
outbound_local_requests_whitelistarray of stringsnoDefine a list of trusted domains or IP addresses to which local requests are allowed when local requests for hooks and services are disabled.
pages_domain_verification_enabledbooleannoRequire users to prove ownership of custom domains. Domain verification is an essential security measure for public GitLab sites. Users are required to demonstrate they control a domain before it is enabled.
password_authentication_enabled_for_gitbooleannoEnable authentication for Git over HTTP(S) via a GitLab account password. Default is true.
password_authentication_enabled_for_webbooleannoEnable authentication for the web interface via a GitLab account password. Default is true.
password_number_required booleannoIndicates whether passwords require at least one number. Introduced in GitLab 15.1.
password_symbol_required booleannoIndicates whether passwords require at least one symbol character. Introduced in GitLab 15.1.
password_uppercase_required booleannoIndicates whether passwords require at least one uppercase letter. Introduced in GitLab 15.1.
password_lowercase_required booleannoIndicates whether passwords require at least one lowercase letter. Introduced in GitLab 15.1.
performance_bar_allowed_group_idstringno(Deprecated: Use performance_bar_allowed_group_path instead) Path of the group that is allowed to toggle the performance bar.
performance_bar_allowed_group_pathstringnoPath of the group that is allowed to toggle the performance bar.
performance_bar_enabledbooleanno(Deprecated: Pass performance_bar_allowed_group_path: nil instead) Allow enabling the performance bar.
personal_access_token_prefixstringnoPrefix for all generated personal access tokens.
pipeline_limit_per_project_user_shaintegernoMaximum number of pipeline creation requests per minute per user and commit. Disabled by default.
plantuml_enabledbooleanno(If enabled, requires: plantuml_url) Enable PlantUML integration. Default is false.
plantuml_urlstringrequired by: plantuml_enabled The PlantUML instance URL for integration.
polling_interval_multiplierdecimalnoInterval multiplier used by endpoints that perform polling. Set to 0 to disable polling.
project_export_enabledbooleannoEnable project export.
prometheus_metrics_enabledbooleannoEnable Prometheus metrics.
protected_ci_variablesbooleannoCI/CD variables are protected by default.
push_event_activities_limitintegernoNumber of changes (branches or tags) in a single push to determine whether individual push events or bulk push events are created. Bulk push events are created if it surpasses that value.
push_event_hooks_limitintegernoNumber of changes (branches or tags) in a single push to determine whether webhooks and services fire or not. Webhooks and services aren’t submitted if it surpasses that value.
rate_limiting_response_textstringnoWhen rate limiting is enabled via the throttle_* settings, send this plain text response when a rate limit is exceeded. ‘Retry later’ is sent if this is blank.
raw_blob_request_limitintegernoMax number of requests per minute for each raw path. Default: 300. To disable throttling set to 0.
user_email_lookup_limitintegernocaution Deprecated in GitLab 14.9 will be removed in 15.0. Replaced by search_rate_limit. Max number of requests per minute for email lookup. Default: 60. To disable throttling set to 0.
search_rate_limitintegernoMax number of requests per minute for performing a search while authenticated. Default: 30. To disable throttling set to 0.
search_rate_limit_unauthenticatedintegernoMax number of requests per minute for performing a search while unauthenticated. Default: 10. To disable throttling set to 0.
recaptcha_enabledbooleanno(If enabled, requires: recaptcha_private_key and recaptcha_site_key) Enable reCAPTCHA.
recaptcha_private_keystringrequired by: recaptcha_enabled Private key for reCAPTCHA.
recaptcha_site_keystringrequired by: recaptcha_enabled Site key for reCAPTCHA.
receive_max_input_sizeintegernoMaximum push size (MB).
repository_checks_enabledbooleannoGitLab periodically runs git fsck in all project and wiki repositories to look for silent disk corruption issues.
repository_size_limit integernoSize limit per repository (MB)
repository_storages_weightedhash of strings to integersno(GitLab 13.1 and later) Hash of names of taken from gitlab.yml to weights. New projects are created in one of these stores, chosen by a weighted random selection.
repository_storagesarray of stringsno(GitLab 13.0 and earlier) List of names of enabled storage paths, taken from gitlab.yml. New projects are created in one of these stores, chosen at random.
require_admin_approval_after_user_signupbooleannoWhen enabled, any user that signs up for an account using the registration form is placed under a Pending approval state and has to be explicitly approved by an administrator.
require_two_factor_authenticationbooleanno(If enabled, requires: two_factor_grace_period) Require all users to set up Two-factor authentication.
restricted_visibility_levelsarray of stringsnoSelected levels cannot be used by non-Administrator users for groups, projects or snippets. Can take private, internal and public as a parameter. Default is null which means there is no restriction.
rsa_key_restrictionintegernoThe minimum allowed bit length of an uploaded RSA key. Default is 0 (no restriction). -1 disables RSA keys.
send_user_confirmation_emailbooleannoSend confirmation email on sign-up.
session_expire_delayintegernoSession duration in minutes. GitLab restart is required to apply changes.
shared_runners_enabledbooleanno(If enabled, requires: shared_runners_text and shared_runners_minutes) Enable shared runners for new projects.
shared_runners_minutes integerrequired by: shared_runners_enabled Set the maximum number of CI/CD minutes that a group can use on shared runners per month.
shared_runners_textstringrequired by: shared_runners_enabled Shared runners text.
sidekiq_job_limiter_modestringno track or compress. Sets the behavior for Sidekiq job size limits. Default: ‘compress’.
sidekiq_job_limiter_compression_threshold_bytesintegernoThe threshold in bytes at which Sidekiq jobs are compressed before being stored in Redis. Default: 100 000 bytes (100KB).
sidekiq_job_limiter_limit_bytesintegernoThe threshold in bytes at which Sidekiq jobs are rejected. Default: 0 bytes (doesn’t reject any job).
sign_in_textstringnoText on the login page.
signin_enabledstringno(Deprecated: Use password_authentication_enabled_for_web instead) Flag indicating if password authentication is enabled for the web interface.
signup_enabledbooleannoEnable registration. Default is true.
slack_app_enabled booleanno(If enabled, requires: slack_app_id, slack_app_secret and slack_app_secret) Enable Slack app.
slack_app_id stringrequired by: slack_app_enabled The app ID of the Slack-app.
slack_app_secret stringrequired by: slack_app_enabled The app secret of the Slack-app.
slack_app_signing_secret stringnoThe signing secret of the Slack-app.
slack_app_verification_token stringrequired by: slack_app_enabled The verification token of the Slack-app.
snippet_size_limitintegernoMax snippet content size in bytes. Default: 52428800 Bytes (50MB).
snowplow_app_idstringnoThe Snowplow site name / application ID. (for example, gitlab)
snowplow_collector_hostnamestringrequired by: snowplow_enabled The Snowplow collector hostname. (for example, snowplow.trx.gitlab.net)
snowplow_cookie_domainstringnoThe Snowplow cookie domain. (for example, .gitlab.com)
snowplow_enabledbooleannoEnable snowplow tracking.
sourcegraph_enabledbooleannoEnables Sourcegraph integration. Default is false. If enabled, requires sourcegraph_url.
sourcegraph_public_onlybooleannoBlocks Sourcegraph from being loaded on private and internal projects. Default is true.
sourcegraph_urlstringrequired by: sourcegraph_enabled The Sourcegraph instance URL for integration.
spam_check_endpoint_enabledbooleannoEnables spam checking using external Spam Check API endpoint. Default is false.
spam_check_endpoint_urlstringnoURL of the external Spamcheck service endpoint. Valid URI schemes are grpc or tls. Specifying tls forces communication to be encrypted.
spam_check_api_keystringnoAPI key used by GitLab for accessing the Spam Check service endpoint.
suggest_pipeline_enabledbooleannoEnable pipeline suggestion banner.
terminal_max_session_timeintegernoMaximum time for web terminal websocket connection (in seconds). Set to 0 for unlimited time.
termstextrequired by: enforce_terms (Required by: enforce_terms) Markdown content for the ToS.
throttle_authenticated_api_enabledbooleanno(If enabled, requires: throttle_authenticated_api_period_in_seconds and throttle_authenticated_api_requests_per_period) Enable authenticated API request rate limit. Helps reduce request volume (for example, from crawlers or abusive bots).
throttle_authenticated_api_period_in_secondsintegerrequired by:
throttle_authenticated_api_enabled
Rate limit period (in seconds).
throttle_authenticated_api_requests_per_periodintegerrequired by:
throttle_authenticated_api_enabled
Maximum requests per period per user.
throttle_authenticated_packages_api_enabledbooleanno(If enabled, requires: throttle_authenticated_packages_api_period_in_seconds and throttle_authenticated_packages_api_requests_per_period) Enable authenticated API request rate limit. Helps reduce request volume (for example, from crawlers or abusive bots). View Package Registry rate limits for more details.
throttle_authenticated_packages_api_period_in_secondsintegerrequired by:
throttle_authenticated_packages_api_enabled
Rate limit period (in seconds). View Package Registry rate limits for more details.
throttle_authenticated_packages_api_requests_per_periodintegerrequired by:
throttle_authenticated_packages_api_enabled
Maximum requests per period per user. View Package Registry rate limits for more details.
throttle_authenticated_web_enabledbooleanno(If enabled, requires: throttle_authenticated_web_period_in_seconds and throttle_authenticated_web_requests_per_period) Enable authenticated web request rate limit. Helps reduce request volume (for example, from crawlers or abusive bots).
throttle_authenticated_web_period_in_secondsintegerrequired by:
throttle_authenticated_web_enabled
Rate limit period (in seconds).
throttle_authenticated_web_requests_per_periodintegerrequired by:
throttle_authenticated_web_enabled
Maximum requests per period per user.
throttle_unauthenticated_enabledbooleanno(Deprecated in GitLab 14.3. Use throttle_unauthenticated_web_enabled or throttle_unauthenticated_api_enabled instead.) (If enabled, requires: throttle_unauthenticated_period_in_seconds and throttle_unauthenticated_requests_per_period) Enable unauthenticated web request rate limit. Helps reduce request volume (for example, from crawlers or abusive bots).
throttle_unauthenticated_period_in_secondsintegerrequired by:
throttle_unauthenticated_enabled
(Deprecated in GitLab 14.3. Use throttle_unauthenticated_web_period_in_seconds or throttle_unauthenticated_api_period_in_seconds instead.) Rate limit period in seconds.
throttle_unauthenticated_requests_per_periodintegerrequired by:
throttle_unauthenticated_enabled
(Deprecated in GitLab 14.3. Use throttle_unauthenticated_web_requests_per_period or throttle_unauthenticated_api_requests_per_period instead.) Max requests per period per IP.
throttle_unauthenticated_api_enabledbooleanno(If enabled, requires: throttle_unauthenticated_api_period_in_seconds and throttle_unauthenticated_api_requests_per_period) Enable unauthenticated API request rate limit. Helps reduce request volume (for example, from crawlers or abusive bots).
throttle_unauthenticated_api_period_in_secondsintegerrequired by:
throttle_unauthenticated_api_enabled
Rate limit period in seconds.
throttle_unauthenticated_api_requests_per_periodintegerrequired by:
throttle_unauthenticated_api_enabled
Max requests per period per IP.
throttle_unauthenticated_packages_api_enabledbooleanno(If enabled, requires: throttle_unauthenticated_packages_api_period_in_seconds and throttle_unauthenticated_packages_api_requests_per_period) Enable authenticated API request rate limit. Helps reduce request volume (for example, from crawlers or abusive bots). View Package Registry rate limits for more details.
throttle_unauthenticated_packages_api_period_in_secondsintegerrequired by:
throttle_unauthenticated_packages_api_enabled
Rate limit period (in seconds). View Package Registry rate limits for more details.
throttle_unauthenticated_packages_api_requests_per_periodintegerrequired by:
throttle_unauthenticated_packages_api_enabled
Maximum requests per period per user. View Package Registry rate limits for more details.
throttle_unauthenticated_web_enabledbooleanno(If enabled, requires: throttle_unauthenticated_web_period_in_seconds and throttle_unauthenticated_web_requests_per_period) Enable unauthenticated web request rate limit. Helps reduce request volume (for example, from crawlers or abusive bots).
throttle_unauthenticated_web_period_in_secondsintegerrequired by:
throttle_unauthenticated_web_enabled
Rate limit period in seconds.
throttle_unauthenticated_web_requests_per_periodintegerrequired by:
throttle_unauthenticated_web_enabled
Max requests per period per IP.
time_tracking_limit_to_hoursbooleannoLimit display of time tracking units to hours. Default is false.
two_factor_grace_periodintegerrequired by: require_two_factor_authentication Amount of time (in hours) that users are allowed to skip forced configuration of two-factor authentication.
unique_ips_limit_enabledbooleanno(If enabled, requires: unique_ips_limit_per_user and unique_ips_limit_time_window) Limit sign in from multiple IPs.
unique_ips_limit_per_userintegerrequired by: unique_ips_limit_enabled Maximum number of IPs per user.
unique_ips_limit_time_windowintegerrequired by: unique_ips_limit_enabled How many seconds an IP is counted towards the limit.
usage_ping_enabledbooleannoEvery week GitLab reports license usage back to GitLab, Inc.
user_deactivation_emails_enabledbooleannoSend an email to users upon account deactivation.
user_default_externalbooleannoNewly registered users are external by default.
user_default_internal_regexstringnoSpecify an email address regex pattern to identify default internal users.
user_oauth_applicationsbooleannoAllow users to register any application to use GitLab as an OAuth provider.
user_show_add_ssh_key_messagebooleannoWhen set to false disable the You won't be able to pull or push project code via SSH warning shown to users with no uploaded SSH key.
version_check_enabledbooleannoLet GitLab inform you when an update is available.
whats_new_variantstringnoWhat’s new variant, possible values: all_tiers, current_tier, and disabled.
web_ide_clientside_preview_enabledbooleannoLive Preview (allow live previews of JavaScript projects in the Web IDE using CodeSandbox Live Preview).
wiki_page_max_content_bytesintegernoMaximum wiki page content size in bytes. Default: 52428800 Bytes (50 MB). The minimum value is 1024 bytes.

Package Registry: Package file size limits

The package file size limits are not part of the Application settings API. Instead, these settings can be accessed using the Plan limits API.