kotovalexarian-likes-gitlab/gitlab-org--gitlab-foss

Marcel Amirault 70a16ebc97 Realign 3 docs that diverged between ce/ee

2019-09-02 02:35:06 +00:00

37 KiB

Raw Blame History

table_display_block
true

Application settings API

These API calls allow you to read and modify GitLab instance application settings as appear in /admin/application_settings. You have to be an administrator in order 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,
   "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_project_visibility" : "private",
   "default_group_visibility" : "private",
   "gravatar_enabled" : true,
   "sign_in_text" : null,
   "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,
   "instance_statistics_visibility_private": false,
   "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"]
}

Users on GitLab Premium or Ultimate may also see the file_template_project_id 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"
   ...
}

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,
  "session_expire_delay": 10080,
  "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,
  "instance_statistics_visibility_private": false,
  "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
}

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

file_template_project_id
geo_node_allowed_ips
geo_status_timeout

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, will require other settings to be set in order to function properly. These requirements are listed in the descriptions of the relevant settings.

Attribute	Type	Required	Description
`admin_notification_email`	string	no	Abuse reports will be sent to this address if it is set. 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.
`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_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_projects_limit`	integer	no	Project limit per user. Default is `100000`.
`default_project_visibility`	string	no	What visibility level new projects receive. Can take `private`, `internal` and `public` as a parameter. Default is `private`.
`default_snippet_visibility`	string	no	What visibility level new snippets receive. Can take `private`, `internal` and `public` as a parameter. Default is `private`.
`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`	array of strings	required by: `domain_blacklist_enabled`	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_blacklist_enabled`	boolean	no	(If enabled, requires: `domain_blacklist`) Allows blocking sign-ups from emails from specific domains.
`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.
`elasticsearch_aws_access_key`	string	no	(PREMIUM) AWS IAM access key
`elasticsearch_aws`	boolean	no	(PREMIUM) Enable the use of AWS hosted Elasticsearch
`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_experimental_indexer`	boolean	no	(PREMIUM) Use the experimental elasticsearch indexer. More info: https://gitlab.com/gitlab-org/gitlab-elasticsearch-indexer
`elasticsearch_indexing`	boolean	no	(PREMIUM) Enable Elasticsearch indexing
`elasticsearch_limit_indexing`	boolean	no	(PREMIUM) Limit Elasticsearch to index certain namespaces and projects
`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 (e.g., `http://localhost:9200, http://localhost:9201"`). If your Elasticsearch instance is password protected, pass the `username:password` in the URL (e.g., `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_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 will be 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. (EXPERIMENTAL)
`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`.

37 KiB Raw Blame History

Application settings API

Get current application settings

Change application settings

List of settings that can be accessed via API calls

37 KiB

Raw Blame History