gitlab-org--gitlab-foss/doc/api/settings.md

43 KiB

Application settings API (CORE ONLY)

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.

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_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_whitelist" : [],
   "domain_blacklist_enabled" : false,
   "domain_blacklist" : [],
   "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_token_expire_delay": 5,
   "repository_storages_weighted": {"default": 100},
   "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,
   "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"],
   "npm_package_requests_forwarding": true,
   "snippet_size_limit": 52428800,
   "issues_create_limit": 300,
   "raw_blob_request_limit": 300,
   "wiki_page_max_content_bytes": 52428800
}

Users on GitLab Premium or Ultimate may also see the file_template_project_id, 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",
   "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_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_whitelist": [],
  "domain_blacklist_enabled" : false,
  "domain_blacklist" : [],
  "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_registry_token_expire_delay": 5,
  "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,
  "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_whitelist": ["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,
  "npm_package_requests_forwarding": true,
  "snippet_size_limit": 52428800,
  "issues_create_limit": 300,
  "raw_blob_request_limit": 300,
  "wiki_page_max_content_bytes": 52428800
}

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

  • file_template_project_id
  • geo_node_allowed_ips
  • geo_status_timeout
  • deletion_adjourned_period

Example responses: (PREMIUM ONLY)

  "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.

Attribute Type Required Description
admin_notification_email string no Deprecated: 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_email string no If set, abuse reports are sent to this address. Abuse reports are always available in the Admin Area.
after_sign_out_path string no Where to redirect users after logout.
after_sign_up_text string no Text shown to the user after signing up
akismet_api_key string required by: akismet_enabled API key for Akismet spam protection.
akismet_enabled boolean no (If enabled, requires: akismet_api_key) Enable or disable Akismet spam protection.
allow_group_owners_to_manage_ldap boolean no (PREMIUM) Set to true to allow group owners to manage LDAP
allow_local_requests_from_hooks_and_services boolean no (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_hooks boolean no Allow requests to the local network from system hooks.
allow_local_requests_from_web_hooks_and_services boolean no Allow requests to the local network from web hooks and services.
archive_builds_in_human_readable string no Set the duration for which the jobs will be considered as old and expired. Once that time passes, the jobs will be 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_enabled boolean no (If enabled, requires: asset_proxy_url) Enable proxying of assets. GitLab restart is required to apply changes.
asset_proxy_secret_key string no Shared secret with the asset proxy server. GitLab restart is required to apply changes.
asset_proxy_url string no URL of the asset proxy server. GitLab restart is required to apply changes.
asset_proxy_whitelist string or array of strings no Assets that match these domain(s) will NOT be proxied. Wildcards allowed. Your GitLab installation URL is automatically whitelisted. GitLab restart is required to apply changes.
authorized_keys_enabled boolean no By 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_domain string no Specify a domain to use by default for every project's Auto Review Apps and Auto Deploy stages.
auto_devops_enabled boolean no Enable Auto DevOps for projects by default. It will automatically build, test, and deploy applications based on a predefined CI/CD configuration.
automatic_purchased_storage_allocation boolean no Enabling this permits automatic allocation of purchased storage within a namespace.
check_namespace_plan boolean no (PREMIUM) Enabling this will make only licensed EE features available to projects if the project namespace's plan includes the feature or if the project is public.
commit_email_hostname string no Custom hostname (for private commit emails).
container_registry_token_expire_delay integer no Container Registry token duration in minutes.
default_artifacts_expire_in string no Set the default expiration time for each job's artifacts.
default_branch_protection integer no Determine if developers can push to master. Can take: 0 (not protected, both developers and maintainers can push new commits, force push, or delete the branch), 1 (partially protected, developers and maintainers can push new commits, but cannot force push, or delete, the branch) or 2 (fully protected, developers cannot push new commits, but maintainers can; no-one can force push or delete the branch) as a parameter. Default is 2.
default_ci_config_path string no Default CI configuration path for new projects (.gitlab-ci.yml if not set).
default_group_visibility string no What visibility level new groups receive. Can take private, internal and public as a parameter. Default is private.
default_project_creation integer no Default project creation protection. Can take: 0 (No one), 1 (Maintainers) or 2 (Developers + Maintainers)
default_project_visibility string no What visibility level new projects receive. Can take private, internal and public as a parameter. Default is private.
default_projects_limit integer no Project limit per user. Default is 100000.
default_snippet_visibility string no What visibility level new snippets receive. Can take private, internal and public as a parameter. Default is private.
deletion_adjourned_period integer no (PREMIUM ONLY) The number of days to wait before deleting a project or group that is marked for deletion. Value must be between 0 and 90.
diff_max_patch_bytes integer no Maximum diff patch size (Bytes).
disabled_oauth_sign_in_sources array of strings no Disabled OAuth sign-in sources.
dns_rebinding_protection_enabled boolean no Enforce DNS rebinding attack protection.
domain_blacklist_enabled boolean no (If enabled, requires: domain_blacklist) Allows blocking sign-ups from emails from specific domains.
domain_blacklist array of strings no Users with e-mail addresses that match these domain(s) will NOT be able to sign-up. Wildcards allowed. Use separate lines for multiple entries. Ex: domain.com, *.domain.com.
domain_whitelist array of strings no Force people to use only corporate emails for sign-up. Default is null, meaning there is no restriction.
dsa_key_restriction integer no The minimum allowed bit length of an uploaded DSA key. Default is 0 (no restriction). -1 disables DSA keys.
ecdsa_key_restriction integer no The minimum allowed curve size (in bits) of an uploaded ECDSA key. Default is 0 (no restriction). -1 disables ECDSA keys.
ed25519_key_restriction integer no The minimum allowed curve size (in bits) of an uploaded ED25519 key. Default is 0 (no restriction). -1 disables ED25519 keys.
eks_access_key_id string no AWS IAM access key ID
eks_account_id string no Amazon account ID
eks_integration_enabled boolean no Enable integration with Amazon EKS
eks_secret_access_key string no AWS IAM secret access key
elasticsearch_aws_access_key string no (PREMIUM) AWS IAM access key
elasticsearch_aws_region string no (PREMIUM) The AWS region the Elasticsearch domain is configured
elasticsearch_aws_secret_access_key string no (PREMIUM) AWS IAM secret access key
elasticsearch_aws boolean no (PREMIUM) Enable the use of AWS hosted Elasticsearch
elasticsearch_indexed_field_length_limit integer no (PREMIUM) Maximum size of text fields that will be indexed by Elasticsearch. 0 value means no limit. This does not apply to repository and wiki indexing.
elasticsearch_indexed_file_size_limit_kb integer no (PREMIUM) Maximum size of repository and wiki files that will be indexed by Elasticsearch.
elasticsearch_indexing boolean no (PREMIUM) Enable Elasticsearch indexing
elasticsearch_limit_indexing boolean no (PREMIUM) Limit Elasticsearch to index certain namespaces and projects
elasticsearch_max_bulk_concurrency integer no (PREMIUM) Maximum concurrency of Elasticsearch bulk requests per indexing operation. This only applies to repository indexing operations.
elasticsearch_max_bulk_size_mb integer no (PREMIUM) Maximum size of Elasticsearch bulk indexing requests in MB. This only applies to repository indexing operations.
elasticsearch_namespace_ids array of integers no (PREMIUM) The namespaces to index via Elasticsearch if elasticsearch_limit_indexing is enabled.
elasticsearch_project_ids array of integers no (PREMIUM) The projects to index via Elasticsearch if elasticsearch_limit_indexing is enabled.
elasticsearch_search boolean no (PREMIUM) Enable Elasticsearch search
elasticsearch_url string no (PREMIUM) The URL to use for connecting to Elasticsearch. Use a comma-separated list to support cluster (for example, http://localhost:9200, http://localhost:9201"). If your Elasticsearch instance is password protected, pass the username:password in the URL (for example, http://<username>:<password>@<elastic_host>:9200/).
email_additional_text string no (PREMIUM) Additional text added to the bottom of every email for legal/auditing/compliance reasons
email_author_in_body boolean no Some 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_protocol string no Enabled protocols for Git access. Allowed values are: ssh, http, and nil to allow both protocols.
enforce_namespace_storage_limit boolean no Enabling this permits enforcement of namespace storage limits.
enforce_terms boolean no (If enabled, requires: terms) Enforce application ToS to all users.
external_auth_client_cert string no (If enabled, requires: external_auth_client_key) The certificate to use to authenticate with the external authorization service
external_auth_client_key_pass string no Passphrase to use for the private key when authenticating with the external service this is encrypted when stored
external_auth_client_key string required 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_label string required 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_enabled boolean no (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_timeout float required 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_url string required by:
external_authorization_service_enabled
URL to which authorization requests are directed.
file_template_project_id integer no (PREMIUM) The ID of a project to load custom file templates from
first_day_of_week integer no Start 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 string yes (PREMIUM) Comma-separated list of IPs and CIDRs of allowed secondary nodes. For example, 1.1.1.1, 2.2.2.0/24.
geo_status_timeout integer no (PREMIUM) The amount of seconds after which a request to get a secondary node status will time out.
gitaly_timeout_default integer no Default 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_fast integer no Gitaly 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_medium integer no Medium Gitaly timeout, in seconds. This should be a value between the Fast and the Default timeout. Set to 0 to disable timeouts.
grafana_enabled boolean no Enable Grafana.
grafana_url string no Grafana URL.
gravatar_enabled boolean no Enable Gravatar.
hashed_storage_enabled boolean no Create 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 since 13.0, configuration will be removed in 14.0)
help_page_hide_commercial_content boolean no Hide marketing-related entries from help.
help_page_support_url string no Alternate support URL for help page and help dropdown.
help_page_text string no Custom text displayed on the help page.
help_text string no (PREMIUM) GitLab server administrator information
hide_third_party_offers boolean no Do not display offers from third parties within GitLab.
home_page_url string no Redirect to this URL when not logged in.
housekeeping_bitmaps_enabled boolean required by: housekeeping_enabled Enable Git pack file bitmap creation.
housekeeping_enabled boolean no (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_period integer required by: housekeeping_enabled Number of Git pushes after which an incremental git repack is run.
housekeeping_gc_period integer required by: housekeeping_enabled Number of Git pushes after which git gc is run.
housekeeping_incremental_repack_period integer required by: housekeeping_enabled Number of Git pushes after which an incremental git repack is run.
html_emails_enabled boolean no Enable HTML emails.
import_sources array of strings no Sources to allow project import from, possible values: github, bitbucket, bitbucket_server, gitlab, google_code, fogbugz, git, gitlab_project, gitea, manifest, and phabricator.
issues_create_limit integer no Max number of issue creation requests per minute per user. Disabled by default.
local_markdown_version integer no Increase this value when any cached Markdown should be invalidated.
maintenance_mode_message string no (PREMIUM) Message displayed when instance is in maintenance mode
maintenance_mode boolean no (PREMIUM) When instance is in maintenance mode, non-admin users can sign in with read-only access and make read-only API requests
max_artifacts_size integer no Maximum artifacts size in MB
max_attachment_size integer no Limit attachment size in MB
max_import_size integer no Maximum import size in MB. 0 for unlimited. Default = 50
max_pages_size integer no Maximum size of pages repositories in MB
max_personal_access_token_lifetime integer no (ULTIMATE ONLY) Maximum allowable lifetime for personal access tokens in days
metrics_method_call_threshold integer no A method call is only tracked when it takes longer than the given amount of milliseconds.
mirror_available boolean no Allow repository mirroring to configured by project Maintainers. If disabled, only Admins will be able to configure repository mirroring.
mirror_capacity_threshold integer no (PREMIUM) Minimum capacity to be available before scheduling more mirrors preemptively
mirror_max_capacity integer no (PREMIUM) Maximum number of mirrors that can be synchronizing at the same time.
mirror_max_delay integer no (PREMIUM) Maximum time (in minutes) between updates that a mirror can have when scheduled to synchronize.
npm_package_requests_forwarding boolean no (PREMIUM) Use npmjs.org as a default remote repository when the package is not found in the GitLab NPM Registry
outbound_local_requests_whitelist array of strings no Define 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_enabled boolean no Require 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_git boolean no Enable authentication for Git over HTTP(S) via a GitLab account password. Default is true.
password_authentication_enabled_for_web boolean no Enable authentication for the web interface via a GitLab account password. Default is true.
performance_bar_allowed_group_id string no (Deprecated: Use performance_bar_allowed_group_path instead) Path of the group that is allowed to toggle the performance bar.
performance_bar_allowed_group_path string no Path of the group that is allowed to toggle the performance bar.
performance_bar_enabled boolean no (Deprecated: Pass performance_bar_allowed_group_path: nil instead) Allow enabling the performance bar.
plantuml_enabled boolean no (If enabled, requires: plantuml_url) Enable PlantUML integration. Default is false.
plantuml_url string required by: plantuml_enabled The PlantUML instance URL for integration.
polling_interval_multiplier decimal no Interval multiplier used by endpoints that perform polling. Set to 0 to disable polling.
project_export_enabled boolean no Enable project export.
prometheus_metrics_enabled boolean no Enable Prometheus metrics.
protected_ci_variables boolean no Environment variables are protected by default.
pseudonymizer_enabled boolean no (PREMIUM) When enabled, GitLab will run a background job that will produce pseudonymized CSVs of the GitLab database that will be uploaded to your configured object storage directory.
push_event_activities_limit integer no Number of changes (branches or tags) in a single push to determine whether individual push events or bulk push events will be created. Bulk push events will be created if it surpasses that value.
push_event_hooks_limit integer no Number of changes (branches or tags) in a single push to determine whether webhooks and services will be fired or not. Webhooks and services won't be submitted if it surpasses that value.
raw_blob_request_limit integer no Max number of requests per minute for each raw path. Default: 300. To disable throttling set to 0.
recaptcha_enabled boolean no (If enabled, requires: recaptcha_private_key and recaptcha_site_key) Enable reCAPTCHA.
recaptcha_private_key string required by: recaptcha_enabled Private key for reCAPTCHA.
recaptcha_site_key string required by: recaptcha_enabled Site key for reCAPTCHA.
receive_max_input_size integer no Maximum push size (MB).
repository_checks_enabled boolean no GitLab will periodically run git fsck in all project and wiki repositories to look for silent disk corruption issues.
repository_size_limit integer no (PREMIUM) Size limit per repository (MB)
repository_storages_weighted hash of strings to integers no (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_storages array of strings no (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_two_factor_authentication boolean no (If enabled, requires: two_factor_grace_period) Require all users to set up Two-factor authentication.
restricted_visibility_levels array of strings no Selected levels cannot be used by non-admin 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_restriction integer no The minimum allowed bit length of an uploaded RSA key. Default is 0 (no restriction). -1 disables RSA keys.
send_user_confirmation_email boolean no Send confirmation email on sign-up.
session_expire_delay integer no Session duration in minutes. GitLab restart is required to apply changes
shared_runners_enabled boolean no (If enabled, requires: shared_runners_text and shared_runners_minutes) Enable shared runners for new projects.
shared_runners_minutes integer required by: shared_runners_enabled (PREMIUM) Set the maximum number of pipeline minutes that a group can use on shared runners per month.
shared_runners_text string required by: shared_runners_enabled Shared runners text.
sign_in_text string no Text on the login page.
signin_enabled string no (Deprecated: Use password_authentication_enabled_for_web instead) Flag indicating if password authentication is enabled for the web interface.
signup_enabled boolean no Enable registration. Default is true.
slack_app_enabled boolean no (PREMIUM) (If enabled, requires: slack_app_id, slack_app_secret and slack_app_secret) Enable Slack app.
slack_app_id string required by: slack_app_enabled (PREMIUM) The app ID of the Slack-app.
slack_app_secret string required by: slack_app_enabled (PREMIUM) The app secret of the Slack-app.
slack_app_verification_token string required by: slack_app_enabled (PREMIUM) The verification token of the Slack-app.
snippet_size_limit integer no Max snippet content size in bytes. Default: 52428800 Bytes (50MB).
snowplow_app_id string no The Snowplow site name / application ID. (for example, gitlab)
snowplow_collector_hostname string required by: snowplow_enabled The Snowplow collector hostname. (for example, snowplow.trx.gitlab.net)
snowplow_cookie_domain string no The Snowplow cookie domain. (for example, .gitlab.com)
snowplow_enabled boolean no Enable snowplow tracking.
sourcegraph_enabled boolean no Enables Sourcegraph integration. Default is false. If enabled, requires sourcegraph_url.
sourcegraph_public_only boolean no Blocks Sourcegraph from being loaded on private and internal projects. Default is true.
sourcegraph_url string required by: sourcegraph_enabled The Sourcegraph instance URL for integration.
spam_check_endpoint_enabled boolean no Enables Spam Check via external API endpoint. Default is false.
spam_check_endpoint_url string no URL of the external Spam Check service endpoint.
terminal_max_session_time integer no Maximum time for web terminal websocket connection (in seconds). Set to 0 for unlimited time.
terms text required by: enforce_terms (Required by: enforce_terms) Markdown content for the ToS.
throttle_authenticated_api_enabled boolean no (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_seconds integer required by:
throttle_authenticated_api_enabled
Rate limit period in seconds.
throttle_authenticated_api_requests_per_period integer required by:
throttle_authenticated_api_enabled
Max requests per period per user.
throttle_authenticated_web_enabled boolean no (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_seconds integer required by:
throttle_authenticated_web_enabled
Rate limit period in seconds.
throttle_authenticated_web_requests_per_period integer required by:
throttle_authenticated_web_enabled
Max requests per period per user.
throttle_unauthenticated_enabled boolean no (If enabled, requires: throttle_unauthenticated_period_in_seconds and throttle_unauthenticated_requests_per_period) Enable unauthenticated request rate limit. Helps reduce request volume (for example, from crawlers or abusive bots).
throttle_unauthenticated_period_in_seconds integer required by:
throttle_unauthenticated_enabled
Rate limit period in seconds.
throttle_unauthenticated_requests_per_period integer required by:
throttle_unauthenticated_enabled
Max requests per period per IP.
time_tracking_limit_to_hours boolean no Limit display of time tracking units to hours. Default is false.
two_factor_grace_period integer required 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_enabled boolean no (If enabled, requires: unique_ips_limit_per_user and unique_ips_limit_time_window) Limit sign in from multiple ips.
unique_ips_limit_per_user integer required by: unique_ips_limit_enabled Maximum number of IPs per user.
unique_ips_limit_time_window integer required by: unique_ips_limit_enabled How many seconds an IP will be counted towards the limit.
usage_ping_enabled boolean no Every week GitLab will report license usage back to GitLab, Inc.
user_default_external boolean no Newly registered users will be external by default.
user_default_internal_regex string no Specify an e-mail address regex pattern to identify default internal users.
user_oauth_applications boolean no Allow users to register any application to use GitLab as an OAuth provider.
user_show_add_ssh_key_message boolean no When 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_enabled boolean no Let GitLab inform you when an update is available.
web_ide_clientside_preview_enabled boolean no Live Preview (allow live previews of JavaScript projects in the Web IDE using CodeSandbox Live Preview).
wiki_page_max_content_bytes integer no Maximum wiki page content size in bytes. Default: 52428800 Bytes (50 MB). The minimum value is 1024 bytes.