curl --request GET \
--url https://api.example.com/api/admin/settings{
"home": "~/.prefect",
"profiles_path": "<string>",
"debug_mode": false,
"api": {
"url": "<string>",
"auth_string": "<string>",
"key": "<string>",
"tls_insecure_skip_verify": false,
"ssl_cert_file": "<string>",
"enable_http2": false,
"request_timeout": 60
},
"cli": {
"colors": true,
"prompt": true,
"wrap_lines": true
},
"client": {
"max_retries": 5,
"retry_jitter_factor": 0.2,
"retry_extra_codes": "404,429,503",
"csrf_support_enabled": true,
"custom_headers": {},
"metrics": {
"enabled": false,
"port": 4201
}
},
"cloud": {
"api_url": "https://api.prefect.cloud/api",
"enable_orchestration_telemetry": true,
"max_log_size": 25000,
"ui_url": "<string>"
},
"deployments": {
"default_work_pool_name": "<string>",
"default_docker_build_namespace": "my-dockerhub-registry"
},
"experiments": {
"warn": true,
"plugins": {
"enabled": false,
"allow": [
"<string>"
],
"deny": [
"<string>"
],
"setup_timeout_seconds": 20,
"strict": false,
"safe_mode": false
}
},
"flows": {
"default_retries": 0,
"default_retry_delay_seconds": 0
},
"internal": {
"logging_level": "ERROR"
},
"logging": {
"level": "INFO",
"config_path": "<string>",
"extra_loggers": "<string>",
"log_prints": false,
"colors": true,
"markup": false,
"to_api": {
"enabled": true,
"batch_interval": 2,
"batch_size": 4000000,
"max_log_size": 1000000,
"when_missing_flow": "warn"
}
},
"results": {
"default_serializer": "pickle",
"persist_by_default": false,
"default_storage_block": "<string>",
"local_storage_path": "<string>"
},
"runner": {
"process_limit": 5,
"poll_frequency": 10,
"heartbeat_frequency": 31,
"server": {
"enable": false,
"host": "localhost",
"port": 8080,
"log_level": "ERROR",
"missed_polls_tolerance": 2
}
},
"server": {
"logging_level": "WARNING",
"analytics_enabled": true,
"metrics_enabled": false,
"log_retryable_errors": false,
"register_blocks_on_start": true,
"memoize_block_auto_registration": true,
"memo_store_path": "<string>",
"deployment_schedule_max_scheduled_runs": 50,
"api": {
"auth_string": "<string>",
"host": "127.0.0.1",
"port": 4200,
"base_path": "/v2/api",
"default_limit": 200,
"keepalive_timeout": 5,
"csrf_protection_enabled": false,
"csrf_token_expiration": "PT1H",
"cors_allowed_origins": "*",
"cors_allowed_methods": "*",
"cors_allowed_headers": "*"
},
"concurrency": {
"lease_storage": "prefect.server.concurrency.lease_storage.memory",
"initial_deployment_lease_duration": 300,
"maximum_concurrency_slot_wait_seconds": 30
},
"database": {
"sqlalchemy": {
"connect_args": {
"application_name": "<string>",
"search_path": "<string>",
"statement_cache_size": 123,
"prepared_statement_cache_size": 123,
"tls": {
"enabled": false,
"ca_file": "<string>",
"cert_file": "<string>",
"key_file": "<string>",
"check_hostname": true
}
},
"pool_size": 5,
"pool_recycle": 3600,
"pool_timeout": 30,
"max_overflow": 10
},
"connection_url": "<string>",
"driver": "postgresql+asyncpg",
"host": "<string>",
"port": 123,
"user": "<string>",
"name": "<string>",
"password": "<string>",
"echo": false,
"migrate_on_start": true,
"timeout": 10,
"connection_timeout": 5
},
"deployments": {
"concurrency_slot_wait_seconds": 30
},
"docket": {
"name": "prefect-server",
"url": "memory://"
},
"ephemeral": {
"enabled": false,
"startup_timeout_seconds": 20
},
"events": {
"stream_out_enabled": true,
"related_resource_cache_ttl": "PT5M",
"maximum_labels_per_resource": 500,
"maximum_related_resources": 100,
"maximum_size_bytes": 1500000,
"expired_bucket_buffer": "PT1M",
"proactive_granularity": "PT5S",
"retention_period": "P7D",
"maximum_websocket_backfill": "PT15M",
"websocket_backfill_page_size": 250,
"messaging_broker": "prefect.server.utilities.messaging.memory",
"messaging_cache": "prefect.server.utilities.messaging.memory",
"causal_ordering": "prefect.server.events.ordering.memory",
"maximum_event_name_length": 1024
},
"flow_run_graph": {
"max_nodes": 10000,
"max_artifacts": 10000
},
"logs": {
"stream_out_enabled": false,
"stream_publishing_enabled": false
},
"services": {
"cancellation_cleanup": {
"enabled": true,
"loop_seconds": 20
},
"event_persister": {
"enabled": true,
"batch_size": 20,
"read_batch_size": 1,
"flush_interval": 5,
"batch_size_delete": 10000,
"queue_max_size": 50000,
"max_flush_retries": 5
},
"event_logger": {
"enabled": false
},
"foreman": {
"enabled": true,
"loop_seconds": 15,
"inactivity_heartbeat_multiple": 3,
"fallback_heartbeat_interval_seconds": 30,
"deployment_last_polled_timeout_seconds": 60,
"work_queue_last_polled_timeout_seconds": 60
},
"late_runs": {
"enabled": true,
"loop_seconds": 5,
"after_seconds": "PT15S"
},
"scheduler": {
"enabled": true,
"loop_seconds": 60,
"deployment_batch_size": 100,
"max_runs": 100,
"min_runs": 3,
"max_scheduled_time": "P100D",
"min_scheduled_time": "PT1H",
"insert_batch_size": 500,
"recent_deployments_loop_seconds": 5
},
"pause_expirations": {
"enabled": true,
"loop_seconds": 5
},
"repossessor": {
"enabled": true,
"loop_seconds": 15
},
"task_run_recorder": {
"enabled": true,
"read_batch_size": 1
},
"triggers": {
"enabled": true,
"read_batch_size": 1,
"pg_notify_reconnect_interval_seconds": 10,
"pg_notify_heartbeat_interval_seconds": 5
}
},
"tasks": {
"tag_concurrency_slot_wait_seconds": 30,
"max_cache_key_length": 2000,
"scheduling": {
"max_scheduled_queue_size": 1000,
"max_retry_queue_size": 100,
"pending_task_timeout": "PT0S"
}
},
"ui": {
"enabled": true,
"api_url": "<string>",
"serve_base": "/",
"static_directory": "<string>",
"show_promotional_content": true
}
},
"tasks": {
"refresh_cache": false,
"default_no_cache": false,
"disable_caching": false,
"default_retries": 0,
"default_retry_delay_seconds": 0,
"default_persist_result": true,
"runner": {
"thread_pool_max_workers": 1,
"process_pool_max_workers": 1
},
"scheduling": {
"default_storage_block": "<string>",
"delete_failed_submissions": true
}
},
"testing": {
"test_mode": false,
"unit_test_mode": false,
"unit_test_loop_debug": true,
"test_setting": "FOO"
},
"worker": {
"heartbeat_seconds": 30,
"query_seconds": 10,
"prefetch_seconds": 10,
"webserver": {
"host": "0.0.0.0",
"port": 8080
}
},
"ui_url": "<string>",
"silence_api_url_misconfiguration": false
}Get the current Prefect REST API settings.
Secret setting values will be obfuscated.
curl --request GET \
--url https://api.example.com/api/admin/settings{
"home": "~/.prefect",
"profiles_path": "<string>",
"debug_mode": false,
"api": {
"url": "<string>",
"auth_string": "<string>",
"key": "<string>",
"tls_insecure_skip_verify": false,
"ssl_cert_file": "<string>",
"enable_http2": false,
"request_timeout": 60
},
"cli": {
"colors": true,
"prompt": true,
"wrap_lines": true
},
"client": {
"max_retries": 5,
"retry_jitter_factor": 0.2,
"retry_extra_codes": "404,429,503",
"csrf_support_enabled": true,
"custom_headers": {},
"metrics": {
"enabled": false,
"port": 4201
}
},
"cloud": {
"api_url": "https://api.prefect.cloud/api",
"enable_orchestration_telemetry": true,
"max_log_size": 25000,
"ui_url": "<string>"
},
"deployments": {
"default_work_pool_name": "<string>",
"default_docker_build_namespace": "my-dockerhub-registry"
},
"experiments": {
"warn": true,
"plugins": {
"enabled": false,
"allow": [
"<string>"
],
"deny": [
"<string>"
],
"setup_timeout_seconds": 20,
"strict": false,
"safe_mode": false
}
},
"flows": {
"default_retries": 0,
"default_retry_delay_seconds": 0
},
"internal": {
"logging_level": "ERROR"
},
"logging": {
"level": "INFO",
"config_path": "<string>",
"extra_loggers": "<string>",
"log_prints": false,
"colors": true,
"markup": false,
"to_api": {
"enabled": true,
"batch_interval": 2,
"batch_size": 4000000,
"max_log_size": 1000000,
"when_missing_flow": "warn"
}
},
"results": {
"default_serializer": "pickle",
"persist_by_default": false,
"default_storage_block": "<string>",
"local_storage_path": "<string>"
},
"runner": {
"process_limit": 5,
"poll_frequency": 10,
"heartbeat_frequency": 31,
"server": {
"enable": false,
"host": "localhost",
"port": 8080,
"log_level": "ERROR",
"missed_polls_tolerance": 2
}
},
"server": {
"logging_level": "WARNING",
"analytics_enabled": true,
"metrics_enabled": false,
"log_retryable_errors": false,
"register_blocks_on_start": true,
"memoize_block_auto_registration": true,
"memo_store_path": "<string>",
"deployment_schedule_max_scheduled_runs": 50,
"api": {
"auth_string": "<string>",
"host": "127.0.0.1",
"port": 4200,
"base_path": "/v2/api",
"default_limit": 200,
"keepalive_timeout": 5,
"csrf_protection_enabled": false,
"csrf_token_expiration": "PT1H",
"cors_allowed_origins": "*",
"cors_allowed_methods": "*",
"cors_allowed_headers": "*"
},
"concurrency": {
"lease_storage": "prefect.server.concurrency.lease_storage.memory",
"initial_deployment_lease_duration": 300,
"maximum_concurrency_slot_wait_seconds": 30
},
"database": {
"sqlalchemy": {
"connect_args": {
"application_name": "<string>",
"search_path": "<string>",
"statement_cache_size": 123,
"prepared_statement_cache_size": 123,
"tls": {
"enabled": false,
"ca_file": "<string>",
"cert_file": "<string>",
"key_file": "<string>",
"check_hostname": true
}
},
"pool_size": 5,
"pool_recycle": 3600,
"pool_timeout": 30,
"max_overflow": 10
},
"connection_url": "<string>",
"driver": "postgresql+asyncpg",
"host": "<string>",
"port": 123,
"user": "<string>",
"name": "<string>",
"password": "<string>",
"echo": false,
"migrate_on_start": true,
"timeout": 10,
"connection_timeout": 5
},
"deployments": {
"concurrency_slot_wait_seconds": 30
},
"docket": {
"name": "prefect-server",
"url": "memory://"
},
"ephemeral": {
"enabled": false,
"startup_timeout_seconds": 20
},
"events": {
"stream_out_enabled": true,
"related_resource_cache_ttl": "PT5M",
"maximum_labels_per_resource": 500,
"maximum_related_resources": 100,
"maximum_size_bytes": 1500000,
"expired_bucket_buffer": "PT1M",
"proactive_granularity": "PT5S",
"retention_period": "P7D",
"maximum_websocket_backfill": "PT15M",
"websocket_backfill_page_size": 250,
"messaging_broker": "prefect.server.utilities.messaging.memory",
"messaging_cache": "prefect.server.utilities.messaging.memory",
"causal_ordering": "prefect.server.events.ordering.memory",
"maximum_event_name_length": 1024
},
"flow_run_graph": {
"max_nodes": 10000,
"max_artifacts": 10000
},
"logs": {
"stream_out_enabled": false,
"stream_publishing_enabled": false
},
"services": {
"cancellation_cleanup": {
"enabled": true,
"loop_seconds": 20
},
"event_persister": {
"enabled": true,
"batch_size": 20,
"read_batch_size": 1,
"flush_interval": 5,
"batch_size_delete": 10000,
"queue_max_size": 50000,
"max_flush_retries": 5
},
"event_logger": {
"enabled": false
},
"foreman": {
"enabled": true,
"loop_seconds": 15,
"inactivity_heartbeat_multiple": 3,
"fallback_heartbeat_interval_seconds": 30,
"deployment_last_polled_timeout_seconds": 60,
"work_queue_last_polled_timeout_seconds": 60
},
"late_runs": {
"enabled": true,
"loop_seconds": 5,
"after_seconds": "PT15S"
},
"scheduler": {
"enabled": true,
"loop_seconds": 60,
"deployment_batch_size": 100,
"max_runs": 100,
"min_runs": 3,
"max_scheduled_time": "P100D",
"min_scheduled_time": "PT1H",
"insert_batch_size": 500,
"recent_deployments_loop_seconds": 5
},
"pause_expirations": {
"enabled": true,
"loop_seconds": 5
},
"repossessor": {
"enabled": true,
"loop_seconds": 15
},
"task_run_recorder": {
"enabled": true,
"read_batch_size": 1
},
"triggers": {
"enabled": true,
"read_batch_size": 1,
"pg_notify_reconnect_interval_seconds": 10,
"pg_notify_heartbeat_interval_seconds": 5
}
},
"tasks": {
"tag_concurrency_slot_wait_seconds": 30,
"max_cache_key_length": 2000,
"scheduling": {
"max_scheduled_queue_size": 1000,
"max_retry_queue_size": 100,
"pending_task_timeout": "PT0S"
}
},
"ui": {
"enabled": true,
"api_url": "<string>",
"serve_base": "/",
"static_directory": "<string>",
"show_promotional_content": true
}
},
"tasks": {
"refresh_cache": false,
"default_no_cache": false,
"disable_caching": false,
"default_retries": 0,
"default_retry_delay_seconds": 0,
"default_persist_result": true,
"runner": {
"thread_pool_max_workers": 1,
"process_pool_max_workers": 1
},
"scheduling": {
"default_storage_block": "<string>",
"delete_failed_submissions": true
}
},
"testing": {
"test_mode": false,
"unit_test_mode": false,
"unit_test_loop_debug": true,
"test_setting": "FOO"
},
"worker": {
"heartbeat_seconds": 30,
"query_seconds": 10,
"prefetch_seconds": 10,
"webserver": {
"host": "0.0.0.0",
"port": 8080
}
},
"ui_url": "<string>",
"silence_api_url_misconfiguration": false
}Successful Response
Settings for Prefect using Pydantic settings.
See https://docs.pydantic.dev/latest/concepts/pydantic_settings
The path to the Prefect home directory. Defaults to ~/.prefect
The path to a profiles configuration file. Supports $PREFECT_HOME templating. Defaults to $PREFECT_HOME/profiles.toml.
If True, enables debug mode which may provide additional logging and debugging features.
Settings for interacting with the Prefect API
Show child attributes
Settings for controlling CLI behavior
Show child attributes
Settings for controlling API client behavior
Show child attributes
Settings for interacting with Prefect Cloud
Show child attributes
Settings for configuring deployments defaults
Show child attributes
Settings for controlling experimental features
Show child attributes
Settings for controlling flow behavior
Show child attributes
Settings for internal Prefect machinery
Show child attributes
Settings for controlling logging behavior
Show child attributes
Settings for controlling result storage behavior
Show child attributes
Settings for controlling runner behavior
Show child attributes
Settings for controlling server behavior
Show child attributes
Settings for controlling task behavior
Show child attributes
Settings used during testing
Show child attributes
Settings for controlling worker behavior
Show child attributes
The URL of the Prefect UI. If not set, the client will attempt to infer it.
If `True`, disable the warning when a user accidentally misconfigure its `PREFECT_API_URL`
Sometimes when a user manually set `PREFECT_API_URL` to a custom url,reverse-proxy for example,
we would like to silence this warning so we will set it to `FALSE`.Was this page helpful?