GET
/
api
/
admin
/
settings
{
  "PREFECT_HOME": "~/.prefect",
  "PREFECT_EXTRA_ENTRYPOINTS": "",
  "PREFECT_DEBUG_MODE": false,
  "PREFECT_CLI_COLORS": true,
  "PREFECT_CLI_PROMPT": true,
  "PREFECT_CLI_WRAP_LINES": true,
  "PREFECT_TEST_MODE": false,
  "PREFECT_UNIT_TEST_MODE": false,
  "PREFECT_UNIT_TEST_LOOP_DEBUG": true,
  "PREFECT_TEST_SETTING": "<any>",
  "PREFECT_API_TLS_INSECURE_SKIP_VERIFY": false,
  "PREFECT_API_SSL_CERT_FILE": "<string>",
  "PREFECT_API_URL": "<string>",
  "PREFECT_SILENCE_API_URL_MISCONFIGURATION": false,
  "PREFECT_API_KEY": "<string>",
  "PREFECT_API_ENABLE_HTTP2": true,
  "PREFECT_CLIENT_MAX_RETRIES": 5,
  "PREFECT_CLIENT_RETRY_JITTER_FACTOR": 0.2,
  "PREFECT_CLIENT_RETRY_EXTRA_CODES": "",
  "PREFECT_CLIENT_CSRF_SUPPORT_ENABLED": true,
  "PREFECT_CLOUD_API_URL": "https://api.prefect.cloud/api",
  "PREFECT_UI_URL": "<string>",
  "PREFECT_CLOUD_UI_URL": "<string>",
  "PREFECT_API_REQUEST_TIMEOUT": 60,
  "PREFECT_EXPERIMENTAL_WARN": true,
  "PREFECT_PROFILES_PATH": "${PREFECT_HOME}/profiles.toml",
  "PREFECT_RESULTS_DEFAULT_SERIALIZER": "pickle",
  "PREFECT_RESULTS_PERSIST_BY_DEFAULT": false,
  "PREFECT_TASKS_REFRESH_CACHE": false,
  "PREFECT_TASK_DEFAULT_RETRIES": 0,
  "PREFECT_FLOW_DEFAULT_RETRIES": 0,
  "PREFECT_FLOW_DEFAULT_RETRY_DELAY_SECONDS": 123,
  "PREFECT_TASK_DEFAULT_RETRY_DELAY_SECONDS": 123,
  "PREFECT_TASK_RUN_TAG_CONCURRENCY_SLOT_WAIT_SECONDS": 30,
  "PREFECT_LOCAL_STORAGE_PATH": "${PREFECT_HOME}/storage",
  "PREFECT_MEMO_STORE_PATH": "${PREFECT_HOME}/memo_store.toml",
  "PREFECT_MEMOIZE_BLOCK_AUTO_REGISTRATION": true,
  "PREFECT_LOGGING_LEVEL": "INFO",
  "PREFECT_LOGGING_INTERNAL_LEVEL": "ERROR",
  "PREFECT_LOGGING_SERVER_LEVEL": "WARNING",
  "PREFECT_LOGGING_SETTINGS_PATH": "${PREFECT_HOME}/logging.yml",
  "PREFECT_LOGGING_EXTRA_LOGGERS": "",
  "PREFECT_LOGGING_LOG_PRINTS": false,
  "PREFECT_LOGGING_TO_API_ENABLED": true,
  "PREFECT_LOGGING_TO_API_BATCH_INTERVAL": 2,
  "PREFECT_LOGGING_TO_API_BATCH_SIZE": 4000000,
  "PREFECT_LOGGING_TO_API_MAX_LOG_SIZE": 1000000,
  "PREFECT_LOGGING_TO_API_WHEN_MISSING_FLOW": "warn",
  "PREFECT_SQLALCHEMY_POOL_SIZE": 123,
  "PREFECT_SQLALCHEMY_MAX_OVERFLOW": 123,
  "PREFECT_LOGGING_COLORS": true,
  "PREFECT_LOGGING_MARKUP": false,
  "PREFECT_ASYNC_FETCH_STATE_RESULT": false,
  "PREFECT_API_BLOCKS_REGISTER_ON_START": true,
  "PREFECT_API_DATABASE_PASSWORD": "<string>",
  "PREFECT_API_DATABASE_CONNECTION_URL": "<string>",
  "PREFECT_API_DATABASE_ECHO": false,
  "PREFECT_API_DATABASE_MIGRATE_ON_START": true,
  "PREFECT_API_DATABASE_TIMEOUT": 123,
  "PREFECT_API_DATABASE_CONNECTION_TIMEOUT": 123,
  "PREFECT_API_SERVICES_SCHEDULER_LOOP_SECONDS": 60,
  "PREFECT_API_SERVICES_SCHEDULER_DEPLOYMENT_BATCH_SIZE": 100,
  "PREFECT_API_SERVICES_SCHEDULER_MAX_RUNS": 100,
  "PREFECT_API_SERVICES_SCHEDULER_MIN_RUNS": 3,
  "PREFECT_API_SERVICES_SCHEDULER_MAX_SCHEDULED_TIME": "P100D",
  "PREFECT_API_SERVICES_SCHEDULER_MIN_SCHEDULED_TIME": "PT1H",
  "PREFECT_API_SERVICES_SCHEDULER_INSERT_BATCH_SIZE": 500,
  "PREFECT_API_SERVICES_LATE_RUNS_LOOP_SECONDS": 5,
  "PREFECT_API_SERVICES_LATE_RUNS_AFTER_SECONDS": "PT15S",
  "PREFECT_API_SERVICES_PAUSE_EXPIRATIONS_LOOP_SECONDS": 5,
  "PREFECT_API_SERVICES_CANCELLATION_CLEANUP_LOOP_SECONDS": 20,
  "PREFECT_API_SERVICES_FOREMAN_ENABLED": true,
  "PREFECT_API_SERVICES_FOREMAN_LOOP_SECONDS": 15,
  "PREFECT_API_SERVICES_FOREMAN_INACTIVITY_HEARTBEAT_MULTIPLE": 3,
  "PREFECT_API_SERVICES_FOREMAN_FALLBACK_HEARTBEAT_INTERVAL_SECONDS": 30,
  "PREFECT_API_SERVICES_FOREMAN_DEPLOYMENT_LAST_POLLED_TIMEOUT_SECONDS": 60,
  "PREFECT_API_SERVICES_FOREMAN_WORK_QUEUE_LAST_POLLED_TIMEOUT_SECONDS": 60,
  "PREFECT_API_LOG_RETRYABLE_ERRORS": false,
  "PREFECT_API_DEFAULT_LIMIT": 200,
  "PREFECT_SERVER_API_HOST": "127.0.0.1",
  "PREFECT_SERVER_API_PORT": 4200,
  "PREFECT_SERVER_API_KEEPALIVE_TIMEOUT": 5,
  "PREFECT_SERVER_CSRF_PROTECTION_ENABLED": false,
  "PREFECT_SERVER_CSRF_TOKEN_EXPIRATION": "PT1H",
  "PREFECT_UI_ENABLED": true,
  "PREFECT_UI_API_URL": "<string>",
  "PREFECT_SERVER_ANALYTICS_ENABLED": true,
  "PREFECT_API_SERVICES_SCHEDULER_ENABLED": true,
  "PREFECT_API_SERVICES_LATE_RUNS_ENABLED": true,
  "PREFECT_API_SERVICES_FLOW_RUN_NOTIFICATIONS_ENABLED": true,
  "PREFECT_API_SERVICES_PAUSE_EXPIRATIONS_ENABLED": true,
  "PREFECT_API_TASK_CACHE_KEY_MAX_LENGTH": 2000,
  "PREFECT_API_SERVICES_CANCELLATION_CLEANUP_ENABLED": true,
  "PREFECT_API_MAX_FLOW_RUN_GRAPH_NODES": 10000,
  "PREFECT_API_MAX_FLOW_RUN_GRAPH_ARTIFACTS": 10000,
  "PREFECT_EXPERIMENTAL_ENABLE_WORKERS": true,
  "PREFECT_EXPERIMENTAL_WARN_WORKERS": false,
  "PREFECT_EXPERIMENTAL_ENABLE_ENHANCED_CANCELLATION": true,
  "PREFECT_EXPERIMENTAL_WARN_ENHANCED_CANCELLATION": false,
  "PREFECT_RUNNER_PROCESS_LIMIT": 5,
  "PREFECT_RUNNER_POLL_FREQUENCY": 10,
  "PREFECT_RUNNER_SERVER_MISSED_POLLS_TOLERANCE": 2,
  "PREFECT_RUNNER_SERVER_HOST": "localhost",
  "PREFECT_RUNNER_SERVER_PORT": 8080,
  "PREFECT_RUNNER_SERVER_LOG_LEVEL": "error",
  "PREFECT_RUNNER_SERVER_ENABLE": false,
  "PREFECT_DEPLOYMENT_SCHEDULE_MAX_SCHEDULED_RUNS": 50,
  "PREFECT_WORKER_HEARTBEAT_SECONDS": 30,
  "PREFECT_WORKER_QUERY_SECONDS": 10,
  "PREFECT_WORKER_PREFETCH_SECONDS": 10,
  "PREFECT_WORKER_WEBSERVER_HOST": "0.0.0.0",
  "PREFECT_WORKER_WEBSERVER_PORT": 8080,
  "PREFECT_API_SERVICES_TASK_SCHEDULING_ENABLED": true,
  "PREFECT_TASK_SCHEDULING_DEFAULT_STORAGE_BLOCK": "local-file-system/prefect-task-scheduling",
  "PREFECT_TASK_SCHEDULING_DELETE_FAILED_SUBMISSIONS": true,
  "PREFECT_TASK_SCHEDULING_MAX_SCHEDULED_QUEUE_SIZE": 1000,
  "PREFECT_TASK_SCHEDULING_MAX_RETRY_QUEUE_SIZE": 100,
  "PREFECT_TASK_SCHEDULING_PENDING_TASK_TIMEOUT": "PT0S",
  "PREFECT_EXPERIMENTAL_ENABLE_EXTRA_RUNNER_ENDPOINTS": false,
  "PREFECT_EXPERIMENTAL_DISABLE_SYNC_COMPAT": false,
  "PREFECT_EXPERIMENTAL_ENABLE_SCHEDULE_CONCURRENCY": false,
  "PREFECT_DEFAULT_RESULT_STORAGE_BLOCK": "<string>",
  "PREFECT_DEFAULT_WORK_POOL_NAME": "<string>",
  "PREFECT_DEFAULT_DOCKER_BUILD_NAMESPACE": "<string>",
  "PREFECT_UI_SERVE_BASE": "/",
  "PREFECT_UI_STATIC_DIRECTORY": "<string>",
  "PREFECT_MESSAGING_BROKER": "prefect.server.utilities.messaging.memory",
  "PREFECT_MESSAGING_CACHE": "prefect.server.utilities.messaging.memory",
  "PREFECT_EVENTS_MAXIMUM_LABELS_PER_RESOURCE": 500,
  "PREFECT_EVENTS_MAXIMUM_RELATED_RESOURCES": 500,
  "PREFECT_EVENTS_MAXIMUM_SIZE_BYTES": 1500000,
  "PREFECT_API_SERVICES_TRIGGERS_ENABLED": true,
  "PREFECT_EVENTS_EXPIRED_BUCKET_BUFFER": "PT1M",
  "PREFECT_EVENTS_PROACTIVE_GRANULARITY": "PT5S",
  "PREFECT_API_SERVICES_EVENT_PERSISTER_ENABLED": true,
  "PREFECT_API_SERVICES_EVENT_PERSISTER_BATCH_SIZE": 20,
  "PREFECT_API_SERVICES_EVENT_PERSISTER_FLUSH_INTERVAL": 5,
  "PREFECT_EVENTS_RETENTION_PERIOD": "P7D",
  "PREFECT_API_EVENTS_STREAM_OUT_ENABLED": true,
  "PREFECT_API_EVENTS_RELATED_RESOURCE_CACHE_TTL": "PT5M"
}

Headers

x-prefect-api-version
string

Response

Successful Response

Contains validated Prefect settings.

Settings should be accessed using the relevant Setting object. For example:

from prefect.settings import PREFECT_HOME
PREFECT_HOME.value()

Accessing a setting attribute directly will ignore any value_callback mutations. This is not recommended:

from prefect.settings import Settings
Settings().PREFECT_PROFILES_PATH # PosixPath('${PREFECT_HOME}/profiles.toml')
PREFECT_HOME
string<path>
default:~/.prefect
PREFECT_EXTRA_ENTRYPOINTS
string
default:""
PREFECT_DEBUG_MODE
boolean
default:false
PREFECT_CLI_COLORS
boolean
default:true
PREFECT_CLI_PROMPT
boolean | null
PREFECT_CLI_WRAP_LINES
boolean
default:true
PREFECT_TEST_MODE
boolean
default:false
PREFECT_UNIT_TEST_MODE
boolean
default:false
PREFECT_UNIT_TEST_LOOP_DEBUG
boolean
default:true
PREFECT_TEST_SETTING
any
PREFECT_API_TLS_INSECURE_SKIP_VERIFY
boolean
default:false
PREFECT_API_SSL_CERT_FILE
string | null
PREFECT_API_URL
string | null
PREFECT_SILENCE_API_URL_MISCONFIGURATION
boolean
default:false
PREFECT_API_KEY
string | null
PREFECT_API_ENABLE_HTTP2
boolean
default:true
PREFECT_CLIENT_MAX_RETRIES
integer
default:5
PREFECT_CLIENT_RETRY_JITTER_FACTOR
number
default:0.2
PREFECT_CLIENT_RETRY_EXTRA_CODES
string
default:""
PREFECT_CLIENT_CSRF_SUPPORT_ENABLED
boolean
default:true
PREFECT_CLOUD_API_URL
string
default:https://api.prefect.cloud/api
PREFECT_UI_URL
string | null
PREFECT_CLOUD_UI_URL
string | null
PREFECT_API_REQUEST_TIMEOUT
number
default:60
PREFECT_EXPERIMENTAL_WARN
boolean
default:true
PREFECT_PROFILES_PATH
string<path>
default:${PREFECT_HOME}/profiles.toml
PREFECT_RESULTS_DEFAULT_SERIALIZER
string
default:pickle
PREFECT_RESULTS_PERSIST_BY_DEFAULT
boolean
default:false
PREFECT_TASKS_REFRESH_CACHE
boolean
default:false
PREFECT_TASK_DEFAULT_RETRIES
integer
default:0
PREFECT_FLOW_DEFAULT_RETRIES
integer
default:0
PREFECT_FLOW_DEFAULT_RETRY_DELAY_SECONDS
default:0
PREFECT_TASK_DEFAULT_RETRY_DELAY_SECONDS
default:0
PREFECT_TASK_RUN_TAG_CONCURRENCY_SLOT_WAIT_SECONDS
integer
default:30
PREFECT_LOCAL_STORAGE_PATH
string<path>
default:${PREFECT_HOME}/storage
PREFECT_MEMO_STORE_PATH
string<path>
default:${PREFECT_HOME}/memo_store.toml
PREFECT_MEMOIZE_BLOCK_AUTO_REGISTRATION
boolean
default:true
PREFECT_LOGGING_LEVEL
string
default:INFO
PREFECT_LOGGING_INTERNAL_LEVEL
string
default:ERROR
PREFECT_LOGGING_SERVER_LEVEL
string
default:WARNING
PREFECT_LOGGING_SETTINGS_PATH
string<path>
default:${PREFECT_HOME}/logging.yml
PREFECT_LOGGING_EXTRA_LOGGERS
string
default:""
PREFECT_LOGGING_LOG_PRINTS
boolean
default:false
PREFECT_LOGGING_TO_API_ENABLED
boolean
default:true
PREFECT_LOGGING_TO_API_BATCH_INTERVAL
number
default:2
PREFECT_LOGGING_TO_API_BATCH_SIZE
integer
default:4000000
PREFECT_LOGGING_TO_API_MAX_LOG_SIZE
integer
default:1000000
PREFECT_LOGGING_TO_API_WHEN_MISSING_FLOW
enum<string>
default:warn
Available options:
warn,
error,
ignore
PREFECT_SQLALCHEMY_POOL_SIZE
integer | null
PREFECT_SQLALCHEMY_MAX_OVERFLOW
integer | null
PREFECT_LOGGING_COLORS
boolean
default:true
PREFECT_LOGGING_MARKUP
boolean
default:false
PREFECT_ASYNC_FETCH_STATE_RESULT
boolean
default:false
PREFECT_API_BLOCKS_REGISTER_ON_START
boolean
default:true
PREFECT_API_DATABASE_PASSWORD
string | null
PREFECT_API_DATABASE_CONNECTION_URL
string | null
PREFECT_API_DATABASE_ECHO
boolean
default:false
PREFECT_API_DATABASE_MIGRATE_ON_START
boolean
default:true
PREFECT_API_DATABASE_TIMEOUT
number | null
default:10
PREFECT_API_DATABASE_CONNECTION_TIMEOUT
number | null
default:5
PREFECT_API_SERVICES_SCHEDULER_LOOP_SECONDS
number
default:60
PREFECT_API_SERVICES_SCHEDULER_DEPLOYMENT_BATCH_SIZE
integer
default:100
PREFECT_API_SERVICES_SCHEDULER_MAX_RUNS
integer
default:100
PREFECT_API_SERVICES_SCHEDULER_MIN_RUNS
integer
default:3
PREFECT_API_SERVICES_SCHEDULER_MAX_SCHEDULED_TIME
string<duration>
default:P100D
PREFECT_API_SERVICES_SCHEDULER_MIN_SCHEDULED_TIME
string<duration>
default:PT1H
PREFECT_API_SERVICES_SCHEDULER_INSERT_BATCH_SIZE
integer
default:500
PREFECT_API_SERVICES_LATE_RUNS_LOOP_SECONDS
number
default:5
PREFECT_API_SERVICES_LATE_RUNS_AFTER_SECONDS
string<duration>
default:PT15S
PREFECT_API_SERVICES_PAUSE_EXPIRATIONS_LOOP_SECONDS
number
default:5
PREFECT_API_SERVICES_CANCELLATION_CLEANUP_LOOP_SECONDS
number
default:20
PREFECT_API_SERVICES_FOREMAN_ENABLED
boolean
default:true
PREFECT_API_SERVICES_FOREMAN_LOOP_SECONDS
number
default:15
PREFECT_API_SERVICES_FOREMAN_INACTIVITY_HEARTBEAT_MULTIPLE
integer
default:3
PREFECT_API_SERVICES_FOREMAN_FALLBACK_HEARTBEAT_INTERVAL_SECONDS
integer
default:30
PREFECT_API_SERVICES_FOREMAN_DEPLOYMENT_LAST_POLLED_TIMEOUT_SECONDS
integer
default:60
PREFECT_API_SERVICES_FOREMAN_WORK_QUEUE_LAST_POLLED_TIMEOUT_SECONDS
integer
default:60
PREFECT_API_LOG_RETRYABLE_ERRORS
boolean
default:false
PREFECT_API_DEFAULT_LIMIT
integer
default:200
PREFECT_SERVER_API_HOST
string
default:127.0.0.1
PREFECT_SERVER_API_PORT
integer
default:4200
PREFECT_SERVER_API_KEEPALIVE_TIMEOUT
integer
default:5
PREFECT_SERVER_CSRF_PROTECTION_ENABLED
boolean
default:false
PREFECT_SERVER_CSRF_TOKEN_EXPIRATION
string<duration>
default:PT1H
PREFECT_UI_ENABLED
boolean
default:true
PREFECT_UI_API_URL
string | null
PREFECT_SERVER_ANALYTICS_ENABLED
boolean
default:true
PREFECT_API_SERVICES_SCHEDULER_ENABLED
boolean
default:true
PREFECT_API_SERVICES_LATE_RUNS_ENABLED
boolean
default:true
PREFECT_API_SERVICES_FLOW_RUN_NOTIFICATIONS_ENABLED
boolean
default:true
PREFECT_API_SERVICES_PAUSE_EXPIRATIONS_ENABLED
boolean
default:true
PREFECT_API_TASK_CACHE_KEY_MAX_LENGTH
integer
default:2000
PREFECT_API_SERVICES_CANCELLATION_CLEANUP_ENABLED
boolean
default:true
PREFECT_API_MAX_FLOW_RUN_GRAPH_NODES
integer
default:10000
PREFECT_API_MAX_FLOW_RUN_GRAPH_ARTIFACTS
integer
default:10000
PREFECT_EXPERIMENTAL_ENABLE_WORKERS
boolean
default:true
PREFECT_EXPERIMENTAL_WARN_WORKERS
boolean
default:false
PREFECT_EXPERIMENTAL_ENABLE_ENHANCED_CANCELLATION
boolean
default:true
PREFECT_EXPERIMENTAL_WARN_ENHANCED_CANCELLATION
boolean
default:false
PREFECT_RUNNER_PROCESS_LIMIT
integer
default:5
PREFECT_RUNNER_POLL_FREQUENCY
integer
default:10
PREFECT_RUNNER_SERVER_MISSED_POLLS_TOLERANCE
integer
default:2
PREFECT_RUNNER_SERVER_HOST
string
default:localhost
PREFECT_RUNNER_SERVER_PORT
integer
default:8080
PREFECT_RUNNER_SERVER_LOG_LEVEL
string
default:error
PREFECT_RUNNER_SERVER_ENABLE
boolean
default:false
PREFECT_DEPLOYMENT_SCHEDULE_MAX_SCHEDULED_RUNS
integer
default:50
PREFECT_WORKER_HEARTBEAT_SECONDS
number
default:30
PREFECT_WORKER_QUERY_SECONDS
number
default:10
PREFECT_WORKER_PREFETCH_SECONDS
number
default:10
PREFECT_WORKER_WEBSERVER_HOST
string
default:0.0.0.0
PREFECT_WORKER_WEBSERVER_PORT
integer
default:8080
PREFECT_API_SERVICES_TASK_SCHEDULING_ENABLED
boolean
default:true
PREFECT_TASK_SCHEDULING_DEFAULT_STORAGE_BLOCK
string
default:local-file-system/prefect-task-scheduling
PREFECT_TASK_SCHEDULING_DELETE_FAILED_SUBMISSIONS
boolean
default:true
PREFECT_TASK_SCHEDULING_MAX_SCHEDULED_QUEUE_SIZE
integer
default:1000
PREFECT_TASK_SCHEDULING_MAX_RETRY_QUEUE_SIZE
integer
default:100
PREFECT_TASK_SCHEDULING_PENDING_TASK_TIMEOUT
string<duration>
default:PT0S
PREFECT_EXPERIMENTAL_ENABLE_EXTRA_RUNNER_ENDPOINTS
boolean
default:false
PREFECT_EXPERIMENTAL_DISABLE_SYNC_COMPAT
boolean
default:false
PREFECT_EXPERIMENTAL_ENABLE_SCHEDULE_CONCURRENCY
boolean
default:false
PREFECT_DEFAULT_RESULT_STORAGE_BLOCK
string | null
PREFECT_DEFAULT_WORK_POOL_NAME
string | null
PREFECT_DEFAULT_DOCKER_BUILD_NAMESPACE
string | null
PREFECT_UI_SERVE_BASE
string
default:/
PREFECT_UI_STATIC_DIRECTORY
string | null
PREFECT_MESSAGING_BROKER
string
default:prefect.server.utilities.messaging.memory
PREFECT_MESSAGING_CACHE
string
default:prefect.server.utilities.messaging.memory
PREFECT_EVENTS_MAXIMUM_LABELS_PER_RESOURCE
integer
default:500
PREFECT_EVENTS_MAXIMUM_SIZE_BYTES
integer
default:1500000
PREFECT_API_SERVICES_TRIGGERS_ENABLED
boolean
default:true
PREFECT_EVENTS_EXPIRED_BUCKET_BUFFER
string<duration>
default:PT1M
PREFECT_EVENTS_PROACTIVE_GRANULARITY
string<duration>
default:PT5S
PREFECT_API_SERVICES_EVENT_PERSISTER_ENABLED
boolean
default:true
PREFECT_API_SERVICES_EVENT_PERSISTER_BATCH_SIZE
integer
default:20
Required range: x > 0
PREFECT_API_SERVICES_EVENT_PERSISTER_FLUSH_INTERVAL
number
default:5
Required range: x > 0
PREFECT_EVENTS_RETENTION_PERIOD
string<duration>
default:P7D
PREFECT_API_EVENTS_STREAM_OUT_ENABLED
boolean
default:true