---
title: "Read Settings"
method: GET
path: "/api/admin/settings"
tags: ["Admin"]
---

# Read Settings

`GET /api/admin/settings`

Get the current Prefect REST API settings.

Secret setting values will be obfuscated.

## Headers

- `x-prefect-api-version` string

## Response `200`

Successful Response

- Settings — Contains validated Prefect settings. Settings should be accessed using the relevant `Setting` object. For example: ```python from prefect.settings import PREFECT_HOME PREFECT_HOME.value() ``` Accessing a setting attribute directly will ignore any `value_callback` mutations. This is not recommended: ```python from prefect.settings import Settings Settings().PREFECT_PROFILES_PATH # PosixPath('${PREFECT_HOME}/profiles.toml') ```
  - `PREFECT_HOME` string, path
  - `PREFECT_EXTRA_ENTRYPOINTS` string
  - `PREFECT_DEBUG_MODE` boolean
  - `PREFECT_CLI_COLORS` boolean
  - `PREFECT_CLI_PROMPT` boolean
  - `PREFECT_CLI_WRAP_LINES` boolean
  - `PREFECT_TEST_MODE` boolean
  - `PREFECT_UNIT_TEST_MODE` boolean
  - `PREFECT_UNIT_TEST_LOOP_DEBUG` boolean
  - `PREFECT_TEST_SETTING` unknown
  - `PREFECT_API_TLS_INSECURE_SKIP_VERIFY` boolean
  - `PREFECT_API_SSL_CERT_FILE` string
  - `PREFECT_API_URL` string
  - `PREFECT_SILENCE_API_URL_MISCONFIGURATION` boolean
  - `PREFECT_API_KEY` string
  - `PREFECT_API_ENABLE_HTTP2` boolean
  - `PREFECT_CLIENT_MAX_RETRIES` integer
  - `PREFECT_CLIENT_RETRY_JITTER_FACTOR` number
  - `PREFECT_CLIENT_RETRY_EXTRA_CODES` string
  - `PREFECT_CLIENT_CSRF_SUPPORT_ENABLED` boolean
  - `PREFECT_CLOUD_API_URL` string
  - `PREFECT_CLOUD_URL` string
  - `PREFECT_UI_URL` string
  - `PREFECT_CLOUD_UI_URL` string
  - `PREFECT_API_REQUEST_TIMEOUT` number
  - `PREFECT_EXPERIMENTAL_WARN` boolean
  - `PREFECT_PROFILES_PATH` string, path
  - `PREFECT_RESULTS_DEFAULT_SERIALIZER` string
  - `PREFECT_RESULTS_PERSIST_BY_DEFAULT` boolean
  - `PREFECT_TASKS_REFRESH_CACHE` boolean
  - `PREFECT_TASK_DEFAULT_RETRIES` integer
  - `PREFECT_FLOW_DEFAULT_RETRIES` integer
  - `PREFECT_FLOW_DEFAULT_RETRY_DELAY_SECONDS` union
    - integer
    - number
  - `PREFECT_TASK_DEFAULT_RETRY_DELAY_SECONDS` union
    - number
    - integer
    - number[]
  - `PREFECT_TASK_RUN_TAG_CONCURRENCY_SLOT_WAIT_SECONDS` integer
  - `PREFECT_LOCAL_STORAGE_PATH` string, path
  - `PREFECT_MEMO_STORE_PATH` string, path
  - `PREFECT_MEMOIZE_BLOCK_AUTO_REGISTRATION` boolean
  - `PREFECT_LOGGING_LEVEL` string
  - `PREFECT_LOGGING_INTERNAL_LEVEL` string
  - `PREFECT_LOGGING_SERVER_LEVEL` string
  - `PREFECT_LOGGING_SETTINGS_PATH` string, path
  - `PREFECT_LOGGING_EXTRA_LOGGERS` string
  - `PREFECT_LOGGING_LOG_PRINTS` boolean
  - `PREFECT_LOGGING_TO_API_ENABLED` boolean
  - `PREFECT_LOGGING_TO_API_BATCH_INTERVAL` number
  - `PREFECT_LOGGING_TO_API_BATCH_SIZE` integer
  - `PREFECT_LOGGING_TO_API_MAX_LOG_SIZE` integer
  - `PREFECT_LOGGING_TO_API_WHEN_MISSING_FLOW` 'warn' | 'error' | 'ignore'
  - `PREFECT_SQLALCHEMY_POOL_SIZE` integer
  - `PREFECT_SQLALCHEMY_MAX_OVERFLOW` integer
  - `PREFECT_LOGGING_COLORS` boolean
  - `PREFECT_LOGGING_MARKUP` boolean
  - `PREFECT_TASK_INTROSPECTION_WARN_THRESHOLD` number
  - `PREFECT_AGENT_QUERY_INTERVAL` number
  - `PREFECT_AGENT_PREFETCH_SECONDS` integer
  - `PREFECT_ASYNC_FETCH_STATE_RESULT` boolean
  - `PREFECT_API_BLOCKS_REGISTER_ON_START` boolean
  - `PREFECT_API_DATABASE_PASSWORD` string
  - `PREFECT_API_DATABASE_CONNECTION_URL` string
  - `PREFECT_API_DATABASE_ECHO` boolean
  - `PREFECT_API_DATABASE_MIGRATE_ON_START` boolean
  - `PREFECT_API_DATABASE_TIMEOUT` number
  - `PREFECT_API_DATABASE_CONNECTION_TIMEOUT` number
  - `PREFECT_API_SERVICES_SCHEDULER_LOOP_SECONDS` number
  - `PREFECT_API_SERVICES_SCHEDULER_DEPLOYMENT_BATCH_SIZE` integer
  - `PREFECT_API_SERVICES_SCHEDULER_MAX_RUNS` integer
  - `PREFECT_API_SERVICES_SCHEDULER_MIN_RUNS` integer
  - `PREFECT_API_SERVICES_SCHEDULER_MAX_SCHEDULED_TIME` number
  - `PREFECT_API_SERVICES_SCHEDULER_MIN_SCHEDULED_TIME` number
  - `PREFECT_API_SERVICES_SCHEDULER_INSERT_BATCH_SIZE` integer
  - `PREFECT_API_SERVICES_LATE_RUNS_LOOP_SECONDS` number
  - `PREFECT_API_SERVICES_LATE_RUNS_AFTER_SECONDS` number
  - `PREFECT_API_SERVICES_PAUSE_EXPIRATIONS_LOOP_SECONDS` number
  - `PREFECT_API_SERVICES_CANCELLATION_CLEANUP_LOOP_SECONDS` number
  - `PREFECT_API_DEFAULT_LIMIT` integer
  - `PREFECT_SERVER_API_HOST` string
  - `PREFECT_SERVER_API_PORT` integer
  - `PREFECT_SERVER_API_KEEPALIVE_TIMEOUT` integer
  - `PREFECT_SERVER_CSRF_PROTECTION_ENABLED` boolean
  - `PREFECT_SERVER_CSRF_TOKEN_EXPIRATION` number
  - `PREFECT_UI_ENABLED` boolean
  - `PREFECT_UI_API_URL` string
  - `PREFECT_SERVER_ANALYTICS_ENABLED` boolean
  - `PREFECT_API_SERVICES_SCHEDULER_ENABLED` boolean
  - `PREFECT_API_SERVICES_LATE_RUNS_ENABLED` boolean
  - `PREFECT_API_SERVICES_FLOW_RUN_NOTIFICATIONS_ENABLED` boolean
  - `PREFECT_API_SERVICES_PAUSE_EXPIRATIONS_ENABLED` boolean
  - `PREFECT_API_TASK_CACHE_KEY_MAX_LENGTH` integer
  - `PREFECT_API_SERVICES_CANCELLATION_CLEANUP_ENABLED` boolean
  - `PREFECT_API_MAX_FLOW_RUN_GRAPH_NODES` integer
  - `PREFECT_API_MAX_FLOW_RUN_GRAPH_ARTIFACTS` integer
  - `PREFECT_EXPERIMENTAL_ENABLE_ARTIFACTS_ON_FLOW_RUN_GRAPH` boolean
  - `PREFECT_EXPERIMENTAL_ENABLE_STATES_ON_FLOW_RUN_GRAPH` boolean
  - `PREFECT_EXPERIMENTAL_ENABLE_EVENTS_CLIENT` boolean
  - `PREFECT_EXPERIMENTAL_WARN_EVENTS_CLIENT` boolean
  - `PREFECT_EXPERIMENTAL_ENABLE_WORK_POOLS` boolean
  - `PREFECT_EXPERIMENTAL_WARN_WORK_POOLS` boolean
  - `PREFECT_EXPERIMENTAL_ENABLE_WORKERS` boolean
  - `PREFECT_EXPERIMENTAL_WARN_WORKERS` boolean
  - `PREFECT_EXPERIMENTAL_WARN_VISUALIZE` boolean
  - `PREFECT_EXPERIMENTAL_ENABLE_ENHANCED_CANCELLATION` boolean
  - `PREFECT_EXPERIMENTAL_WARN_ENHANCED_CANCELLATION` boolean
  - `PREFECT_EXPERIMENTAL_ENABLE_DEPLOYMENT_STATUS` boolean
  - `PREFECT_EXPERIMENTAL_WARN_DEPLOYMENT_STATUS` boolean
  - `PREFECT_EXPERIMENTAL_FLOW_RUN_INPUT` boolean
  - `PREFECT_EXPERIMENTAL_WARN_FLOW_RUN_INPUT` boolean
  - `PREFECT_EXPERIMENTAL_EVENTS` boolean
  - `PREFECT_RUNNER_PROCESS_LIMIT` integer
  - `PREFECT_RUNNER_POLL_FREQUENCY` integer
  - `PREFECT_RUNNER_SERVER_MISSED_POLLS_TOLERANCE` integer
  - `PREFECT_RUNNER_SERVER_HOST` string
  - `PREFECT_RUNNER_SERVER_PORT` integer
  - `PREFECT_RUNNER_SERVER_LOG_LEVEL` string
  - `PREFECT_RUNNER_SERVER_ENABLE` boolean
  - `PREFECT_WORKER_HEARTBEAT_SECONDS` number
  - `PREFECT_WORKER_QUERY_SECONDS` number
  - `PREFECT_WORKER_PREFETCH_SECONDS` number
  - `PREFECT_WORKER_WEBSERVER_HOST` string
  - `PREFECT_WORKER_WEBSERVER_PORT` integer
  - `PREFECT_TASK_SCHEDULING_DEFAULT_STORAGE_BLOCK` string
  - `PREFECT_TASK_SCHEDULING_DELETE_FAILED_SUBMISSIONS` boolean
  - `PREFECT_TASK_SCHEDULING_MAX_SCHEDULED_QUEUE_SIZE` integer
  - `PREFECT_TASK_SCHEDULING_MAX_RETRY_QUEUE_SIZE` integer
  - `PREFECT_TASK_SCHEDULING_PENDING_TASK_TIMEOUT` number
  - `PREFECT_EXPERIMENTAL_ENABLE_FLOW_RUN_INFRA_OVERRIDES` boolean
  - `PREFECT_EXPERIMENTAL_WARN_FLOW_RUN_INFRA_OVERRIDES` boolean
  - `PREFECT_EXPERIMENTAL_ENABLE_EXTRA_RUNNER_ENDPOINTS` boolean
  - `PREFECT_EXPERIMENTAL_ENABLE_ARTIFACTS` boolean
  - `PREFECT_EXPERIMENTAL_WARN_ARTIFACTS` boolean
  - `PREFECT_EXPERIMENTAL_ENABLE_WORKSPACE_DASHBOARD` boolean
  - `PREFECT_EXPERIMENTAL_WARN_WORKSPACE_DASHBOARD` boolean
  - `PREFECT_EXPERIMENTAL_ENABLE_TASK_SCHEDULING` boolean
  - `PREFECT_EXPERIMENTAL_ENABLE_WORK_QUEUE_STATUS` boolean
  - `PREFECT_DEFAULT_RESULT_STORAGE_BLOCK` string
  - `PREFECT_DEFAULT_WORK_POOL_NAME` string
  - `PREFECT_DEFAULT_DOCKER_BUILD_NAMESPACE` string
  - `PREFECT_UI_SERVE_BASE` string
  - `PREFECT_UI_STATIC_DIRECTORY` string
  - `PREFECT_MESSAGING_BROKER` string
  - `PREFECT_MESSAGING_CACHE` string
  - `PREFECT_EVENTS_MAXIMUM_LABELS_PER_RESOURCE` integer
  - `PREFECT_EVENTS_MAXIMUM_RELATED_RESOURCES` integer
  - `PREFECT_EVENTS_MAXIMUM_SIZE_BYTES` integer
  - `PREFECT_API_SERVICES_EVENT_LOGGER_ENABLED` boolean

## Other responses

- `422` — Validation Error

## Changes

- **2024-04-02** `f46191402d91` — 1 info
  - the `PREFECT_UNIT_TEST_LOOP_DEBUG` response's property default value changed from `false` to `true` for the status `200`
- **2024-04-01** `7f19b59c24ca` — 3 info
  - added the optional property `PREFECT_API_SERVICES_EVENT_LOGGER_ENABLED` to the response with the `200` status
  - added the optional property `PREFECT_EVENTS_MAXIMUM_SIZE_BYTES` to the response with the `200` status
  - added the optional property `PREFECT_UNIT_TEST_LOOP_DEBUG` to the response with the `200` status
- **2024-03-29** `3224964213fa` — 3 info
  - added the optional property `PREFECT_MESSAGING_BROKER` to the response with the `200` status
  - added the optional property `PREFECT_MESSAGING_CACHE` to the response with the `200` status
  - the `PREFECT_SERVER_CSRF_PROTECTION_ENABLED` response's property default value changed from `true` to `false` for the status `200`
- **2024-03-28** `f5252435d157` — 1 warning, 1 info
  - removed the optional property `PREFECT_EXPERIMENTAL_ENABLE_PYDANTIC_V2_INTERNALS` from the response with the `200` status
  - the `PREFECT_API_SERVICES_LATE_RUNS_AFTER_SECONDS` response's property default value changed from `5` to `15` for the status `200`
- **2024-03-26** `34528b837afa` — 2 info
  - added the optional property `PREFECT_EVENTS_MAXIMUM_LABELS_PER_RESOURCE` to the response with the `200` status
  - added the optional property `PREFECT_EVENTS_MAXIMUM_RELATED_RESOURCES` to the response with the `200` status

[Full history](https://skmtc.dev/prefecthq/apis/untitled-api-2/changes/api/admin/settings/get.md)

---

[API](https://skmtc.dev/prefecthq/apis/untitled-api-2.md) · [All operations](https://skmtc.dev/prefecthq/apis/untitled-api-2/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/prefecthq/untitled-api-2/revisions/93ae2b3f2efd/schema)