Admin
Read Settings
Get the current Prefect REST API settings.
Secret setting values will be obfuscated.
get/api/admin/settings
Headers
x-prefect-api-versionstring
Response
Successful Response
PREFECT_HOMEstring path
PREFECT_EXTRA_ENTRYPOINTSstring
PREFECT_DEBUG_MODEboolean
PREFECT_CLI_COLORSboolean
PREFECT_CLI_PROMPTboolean
PREFECT_CLI_WRAP_LINESboolean
PREFECT_TEST_MODEboolean
PREFECT_UNIT_TEST_MODEboolean
PREFECT_UNIT_TEST_LOOP_DEBUGboolean
{"stackTrail":"components:schemas:Settings:properties:PREFECT_TEST_SETTING","oasType":"schema","type":"unknown","title":"Prefect Test Setting"}
PREFECT_API_TLS_INSECURE_SKIP_VERIFYboolean
PREFECT_API_SSL_CERT_FILEstring
PREFECT_API_URLstring
PREFECT_SILENCE_API_URL_MISCONFIGURATIONboolean
PREFECT_API_KEYstring
PREFECT_API_ENABLE_HTTP2boolean
PREFECT_CLIENT_MAX_RETRIESinteger
PREFECT_CLIENT_RETRY_JITTER_FACTORnumber
PREFECT_CLIENT_RETRY_EXTRA_CODESstring
PREFECT_CLIENT_CSRF_SUPPORT_ENABLEDboolean
PREFECT_CLOUD_API_URLstring
PREFECT_CLOUD_URLstring
PREFECT_UI_URLstring
PREFECT_CLOUD_UI_URLstring
PREFECT_API_REQUEST_TIMEOUTnumber
PREFECT_EXPERIMENTAL_WARNboolean
PREFECT_PROFILES_PATHstring path
PREFECT_RESULTS_DEFAULT_SERIALIZERstring
PREFECT_RESULTS_PERSIST_BY_DEFAULTboolean
PREFECT_TASKS_REFRESH_CACHEboolean
PREFECT_TASK_DEFAULT_RETRIESinteger
PREFECT_FLOW_DEFAULT_RETRIESinteger
PREFECT_TASK_RUN_TAG_CONCURRENCY_SLOT_WAIT_SECONDSinteger
PREFECT_LOCAL_STORAGE_PATHstring path
PREFECT_MEMO_STORE_PATHstring path
PREFECT_MEMOIZE_BLOCK_AUTO_REGISTRATIONboolean
PREFECT_LOGGING_LEVELstring
PREFECT_LOGGING_INTERNAL_LEVELstring
PREFECT_LOGGING_SERVER_LEVELstring
PREFECT_LOGGING_SETTINGS_PATHstring path
PREFECT_LOGGING_EXTRA_LOGGERSstring
PREFECT_LOGGING_LOG_PRINTSboolean
PREFECT_LOGGING_TO_API_ENABLEDboolean
PREFECT_LOGGING_TO_API_BATCH_INTERVALnumber
PREFECT_LOGGING_TO_API_BATCH_SIZEinteger
PREFECT_LOGGING_TO_API_MAX_LOG_SIZEinteger
PREFECT_LOGGING_TO_API_WHEN_MISSING_FLOW'warn' | 'error' | 'ignore'
PREFECT_SQLALCHEMY_POOL_SIZEinteger
PREFECT_SQLALCHEMY_MAX_OVERFLOWinteger
PREFECT_LOGGING_COLORSboolean
PREFECT_LOGGING_MARKUPboolean
PREFECT_TASK_INTROSPECTION_WARN_THRESHOLDnumber
PREFECT_AGENT_QUERY_INTERVALnumber
PREFECT_AGENT_PREFETCH_SECONDSinteger
PREFECT_ASYNC_FETCH_STATE_RESULTboolean
PREFECT_API_BLOCKS_REGISTER_ON_STARTboolean
PREFECT_API_DATABASE_PASSWORDstring
PREFECT_API_DATABASE_CONNECTION_URLstring
PREFECT_API_DATABASE_ECHOboolean
PREFECT_API_DATABASE_MIGRATE_ON_STARTboolean
PREFECT_API_DATABASE_TIMEOUTnumber
PREFECT_API_DATABASE_CONNECTION_TIMEOUTnumber
PREFECT_API_SERVICES_SCHEDULER_LOOP_SECONDSnumber
PREFECT_API_SERVICES_SCHEDULER_DEPLOYMENT_BATCH_SIZEinteger
PREFECT_API_SERVICES_SCHEDULER_MAX_RUNSinteger
PREFECT_API_SERVICES_SCHEDULER_MIN_RUNSinteger
PREFECT_API_SERVICES_SCHEDULER_MAX_SCHEDULED_TIMEnumber
PREFECT_API_SERVICES_SCHEDULER_MIN_SCHEDULED_TIMEnumber
PREFECT_API_SERVICES_SCHEDULER_INSERT_BATCH_SIZEinteger
PREFECT_API_SERVICES_LATE_RUNS_LOOP_SECONDSnumber
PREFECT_API_SERVICES_LATE_RUNS_AFTER_SECONDSnumber
PREFECT_API_SERVICES_PAUSE_EXPIRATIONS_LOOP_SECONDSnumber
PREFECT_API_SERVICES_CANCELLATION_CLEANUP_LOOP_SECONDSnumber
PREFECT_API_SERVICES_FOREMAN_ENABLEDboolean
PREFECT_API_SERVICES_FOREMAN_LOOP_SECONDSnumber
PREFECT_API_SERVICES_FOREMAN_INACTIVITY_HEARTBEAT_MULTIPLEinteger
PREFECT_API_SERVICES_FOREMAN_FALLBACK_HEARTBEAT_INTERVAL_SECONDSinteger
PREFECT_API_SERVICES_FOREMAN_DEPLOYMENT_LAST_POLLED_TIMEOUT_SECONDSinteger
PREFECT_API_SERVICES_FOREMAN_WORK_QUEUE_LAST_POLLED_TIMEOUT_SECONDSinteger
PREFECT_API_DEFAULT_LIMITinteger
PREFECT_SERVER_API_HOSTstring
PREFECT_SERVER_API_PORTinteger
PREFECT_SERVER_API_KEEPALIVE_TIMEOUTinteger
PREFECT_SERVER_CSRF_PROTECTION_ENABLEDboolean
PREFECT_SERVER_CSRF_TOKEN_EXPIRATIONnumber
PREFECT_UI_ENABLEDboolean
PREFECT_UI_API_URLstring
PREFECT_SERVER_ANALYTICS_ENABLEDboolean
PREFECT_API_SERVICES_SCHEDULER_ENABLEDboolean
PREFECT_API_SERVICES_LATE_RUNS_ENABLEDboolean
PREFECT_API_SERVICES_FLOW_RUN_NOTIFICATIONS_ENABLEDboolean
PREFECT_API_SERVICES_PAUSE_EXPIRATIONS_ENABLEDboolean
PREFECT_API_TASK_CACHE_KEY_MAX_LENGTHinteger
PREFECT_API_SERVICES_CANCELLATION_CLEANUP_ENABLEDboolean
PREFECT_API_MAX_FLOW_RUN_GRAPH_NODESinteger
PREFECT_API_MAX_FLOW_RUN_GRAPH_ARTIFACTSinteger
PREFECT_EXPERIMENTAL_ENABLE_ARTIFACTS_ON_FLOW_RUN_GRAPHboolean
PREFECT_EXPERIMENTAL_ENABLE_STATES_ON_FLOW_RUN_GRAPHboolean
PREFECT_EXPERIMENTAL_ENABLE_WORK_POOLSboolean
PREFECT_EXPERIMENTAL_WARN_WORK_POOLSboolean
PREFECT_EXPERIMENTAL_ENABLE_WORKERSboolean
PREFECT_EXPERIMENTAL_WARN_WORKERSboolean
PREFECT_EXPERIMENTAL_WARN_VISUALIZEboolean
PREFECT_EXPERIMENTAL_ENABLE_ENHANCED_CANCELLATIONboolean
PREFECT_EXPERIMENTAL_WARN_ENHANCED_CANCELLATIONboolean
PREFECT_EXPERIMENTAL_ENABLE_DEPLOYMENT_STATUSboolean
PREFECT_EXPERIMENTAL_WARN_DEPLOYMENT_STATUSboolean
PREFECT_EXPERIMENTAL_FLOW_RUN_INPUTboolean
PREFECT_EXPERIMENTAL_WARN_FLOW_RUN_INPUTboolean
PREFECT_EXPERIMENTAL_EVENTSboolean
PREFECT_RUNNER_PROCESS_LIMITinteger
PREFECT_RUNNER_POLL_FREQUENCYinteger
PREFECT_RUNNER_SERVER_MISSED_POLLS_TOLERANCEinteger
PREFECT_RUNNER_SERVER_HOSTstring
PREFECT_RUNNER_SERVER_PORTinteger
PREFECT_RUNNER_SERVER_LOG_LEVELstring
PREFECT_RUNNER_SERVER_ENABLEboolean
PREFECT_DEPLOYMENT_SCHEDULE_MAX_SCHEDULED_RUNSinteger
PREFECT_WORKER_HEARTBEAT_SECONDSnumber
PREFECT_WORKER_QUERY_SECONDSnumber
PREFECT_WORKER_PREFETCH_SECONDSnumber
PREFECT_WORKER_WEBSERVER_HOSTstring
PREFECT_WORKER_WEBSERVER_PORTinteger
PREFECT_TASK_SCHEDULING_DEFAULT_STORAGE_BLOCKstring
PREFECT_TASK_SCHEDULING_DELETE_FAILED_SUBMISSIONSboolean
PREFECT_TASK_SCHEDULING_MAX_SCHEDULED_QUEUE_SIZEinteger
PREFECT_TASK_SCHEDULING_MAX_RETRY_QUEUE_SIZEinteger
PREFECT_TASK_SCHEDULING_PENDING_TASK_TIMEOUTnumber
PREFECT_EXPERIMENTAL_ENABLE_EXTRA_RUNNER_ENDPOINTSboolean
PREFECT_EXPERIMENTAL_ENABLE_ARTIFACTSboolean
PREFECT_EXPERIMENTAL_WARN_ARTIFACTSboolean
PREFECT_EXPERIMENTAL_ENABLE_WORKSPACE_DASHBOARDboolean
PREFECT_EXPERIMENTAL_WARN_WORKSPACE_DASHBOARDboolean
PREFECT_EXPERIMENTAL_ENABLE_TASK_SCHEDULINGboolean
PREFECT_EXPERIMENTAL_ENABLE_WORK_QUEUE_STATUSboolean
PREFECT_EXPERIMENTAL_ENABLE_NEW_ENGINEboolean
PREFECT_EXPERIMENTAL_DISABLE_SYNC_COMPATboolean
PREFECT_DEFAULT_RESULT_STORAGE_BLOCKstring
PREFECT_DEFAULT_WORK_POOL_NAMEstring
PREFECT_DEFAULT_DOCKER_BUILD_NAMESPACEstring
PREFECT_UI_SERVE_BASEstring
PREFECT_UI_STATIC_DIRECTORYstring
PREFECT_MESSAGING_BROKERstring
PREFECT_MESSAGING_CACHEstring
PREFECT_EVENTS_MAXIMUM_LABELS_PER_RESOURCEinteger
PREFECT_EVENTS_MAXIMUM_RELATED_RESOURCESinteger
PREFECT_EVENTS_MAXIMUM_SIZE_BYTESinteger
PREFECT_API_SERVICES_EVENT_LOGGER_ENABLEDboolean
PREFECT_API_SERVICES_TRIGGERS_ENABLEDboolean
PREFECT_EVENTS_EXPIRED_BUCKET_BUFFERnumber
PREFECT_EVENTS_PROACTIVE_GRANULARITYnumber
PREFECT_API_SERVICES_EVENT_PERSISTER_ENABLEDboolean
PREFECT_API_SERVICES_EVENT_PERSISTER_BATCH_SIZEinteger
PREFECT_API_SERVICES_EVENT_PERSISTER_FLUSH_INTERVALnumber
PREFECT_EVENTS_RETENTION_PERIODnumber
PREFECT_API_EVENTS_STREAM_OUT_ENABLEDboolean
PREFECT_API_EVENTS_RELATED_RESOURCE_CACHE_TTLnumber
PREFECT_RUN_ON_COMPLETION_HOOKS_ON_CACHEDboolean