Sign in
latestOpenAPI 3.0.12026-08-10234260964.0 KB

6cc88fde6435

Project Settings

Get list of project settings

Retrieve the global settings for a project.

get/projects/{projectId}/settings

Path parameters

projectIdstring required

Response

initializeobject required
product_namestring required

The name of the product.

product_codestring required

The lowercase ASCII code of the product.

ui_uri_templatestring required

The template of the project UI uri

variables_prefixstring required

The prefix of the generated environment variables.

bot_emailstring required

The email of the bot.

application_config_filestring required

The name of the application-specific configuration file.

project_config_dirstring required

The name of the project configuration directory.

use_drupal_defaultsboolean required

Whether to use the default Drupal-centric configuration files when missing from the repository.

use_legacy_subdomainsboolean required

Whether to use legacy subdomain scheme, that replaces . by --- in development subdomains.

development_service_size'2XL' | '4XL' | 'L' | 'M' | 'S' | 'XL' required

The size of development services.

development_application_size'2XL' | '4XL' | 'L' | 'M' | 'S' | 'XL' required

The size of development applications.

enable_certificate_provisioningboolean required

Enable automatic certificate provisioning.

certificate_style'ecdsa' | 'rsa' required
certificate_renewal_activityboolean required

Create an activity for certificate renewal

development_domain_templatestring nullable required

The template of the development domain, can include {project} and {environment} placeholders.

enable_state_api_deploymentsboolean required

Enable the State API-driven deployments on regions that support them.

temporary_disk_sizeinteger nullable required

Set the size of the temporary disk (/tmp, in MB).

local_disk_sizeinteger nullable required

Set the size of the instance disk (in MB).

cron_minimum_intervalinteger required

Minimum interval between cron runs (in minutes)

cron_maximum_jitterinteger required

Maximum jitter inserted in cron runs (in minutes)

cron_production_expiry_intervalinteger required

The interval (in days) for which cron activity and logs are kept around

cron_non_production_expiry_intervalinteger required

The interval (in days) for which cron activity and logs are kept around

concurrency_limitsobject required

The concurrency limits applied to different kind of activities

flexible_build_cacheboolean required

Enable the flexible build cache implementation

strict_configurationboolean required

Strict configuration validation.

has_sleepy_cronsboolean required
crons_in_gitboolean required
custom_error_templatestring nullable required

Custom error template for the router.

app_error_page_templatestring nullable required

Custom error template for the application.

environment_name_strategy'hash' | 'name-and-hash' required

The strategy used to generate environment machine names

data_retentionobject nullable required

Data retention configuration

enable_codesource_integration_pushboolean required

Enable pushing commits to codesource integration.

enforce_mfaboolean required

Enforce multi-factor authentication.

systemdboolean required

Use systemd images.

router_gen2boolean required

Use the router v2 image.

outbound_restrictions_default_policy'allow' | 'deny' required

The default policy for firewall outbound restrictions

self_upgradeboolean required

Whether self-upgrades are enabled

self_upgrade_latest_majorboolean required
additional_hostsobject required

A mapping of hostname to ip address to be added to the container's hosts file

max_allowed_routesinteger required

Maximum number of routes allowed

max_allowed_redirects_pathsinteger required

Maximum number of redirect paths allowed

enable_incremental_backupsboolean required

Enable incremental backups on regions that support them.

sizing_api_enabledboolean required

Enable sizing api.

enable_cache_grace_periodboolean required

Enable cache grace period.

enable_zero_downtime_deploymentsboolean required

Enable zero-downtime deployments for resource-only changes.

enable_admin_agentboolean required
certifier_urlstring required

The certifier url

centralized_permissionsboolean required

Whether centralized permissions are enabled

glue_server_max_request_sizeinteger required

Maximum size of request to glue-server (in MB)

persistent_endpoints_sshboolean required

Enable SSH access update with persistent endpoint

persistent_endpoints_ssl_certificatesboolean required

Enable SSL certificate update with persistent endpoint

enable_disk_health_monitoringboolean required
enable_paused_environmentsboolean required
enable_unified_configurationboolean required
enable_routes_tracingboolean required

Enable tracing support in routes

image_deployment_validationboolean required

Enable extended deployment validation by images

support_generic_imagesboolean required
enable_github_app_token_exchangeboolean required

Enable fetching the GitHub App token from SIA.

disable_agent_error_reporterboolean required
requires_domain_ownershipboolean required

Require ownership proof before domains are added to environments.

enable_guaranteed_resourcesboolean required

Enable guaranteed resources feature

activity_logs_max_sizeinteger required

The maximum size of activity logs in bytes. This limit is applied on the pre-compressed log size.

allow_manual_deploymentsboolean required

If deployments can be manual, i.e. explicitly triggered by user.

allow_rolling_deploymentsboolean required

If the project can use rolling deployments.

allow_burstboolean required