Read Settings

curl --request GET \
  --url https://api.example.com/admin/settings

import requests

url = "https://api.example.com/admin/settings"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://api.example.com/admin/settings', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/admin/settings",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/admin/settings"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.example.com/admin/settings")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/admin/settings")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "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": {},
    "server_version_check_enabled": true,
    "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"
  },
  "events": {
    "worker_max_queue_size": 0
  },
  "experiments": {
    "warn": true
  },
  "flows": {
    "heartbeat_frequency": 180,
    "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"
    }
  },
  "plugins": {
    "enabled": false,
    "allow": [
      "<string>"
    ],
    "deny": [
      "<string>"
    ],
    "setup_timeout_seconds": 20,
    "strict": false,
    "safe_mode": false
  },
  "results": {
    "default_serializer": "pickle",
    "persist_by_default": false,
    "default_storage_block": "<string>",
    "local_storage_path": "<string>"
  },
  "runner": {
    "process_limit": 5,
    "poll_frequency": 10,
    "crash_on_cancellation_failure": false,
    "auto_install_dependencies": false,
    "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": "*",
      "websocket_ping_interval": 20,
      "websocket_ping_timeout": 20,
      "max_parameter_size": 524288
    },
    "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>",
      "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,
        "cancelling_timeout_seconds": 300
      },
      "db_vacuum": {
        "enabled": [
          "events"
        ],
        "loop_seconds": 3600,
        "retention_period": "P90D",
        "batch_size": 200,
        "event_retention_overrides": {
          "prefect.flow-run.heartbeat": "P7D"
        }
      },
      "event_persister": {
        "enabled": true,
        "batch_size": 20,
        "read_batch_size": 1,
        "flush_interval": 5,
        "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
      },
      "cleanup_reconciler": {
        "enabled": true,
        "loop_seconds": 5,
        "batch_size": 100
      },
      "task_run_recorder": {
        "enabled": true,
        "read_batch_size": 1,
        "batch_size": 1,
        "flush_interval": 5
      },
      "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": 10,
      "max_cache_key_length": 2000,
      "scheduling": {
        "max_scheduled_queue_size": 1000,
        "max_retry_queue_size": 100,
        "pending_task_timeout": "PT0S"
      }
    },
    "ui": {
      "enabled": true,
      "v2_enabled": false,
      "api_url": "<string>",
      "serve_base": "/",
      "static_directory": "<string>",
      "show_promotional_content": true
    },
    "worker_channel": {
      "cleanup_queue_storage": "prefect.server.worker_communication.cleanup_queue.memory",
      "cleanup_lease_seconds": 30,
      "cleanup_max_delivery_attempts": 3,
      "cleanup_completed_idempotency_retention_seconds": 1
    }
  },
  "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
    }
  },
  "telemetry": {
    "enable_resource_metrics": true,
    "resource_metrics_interval_seconds": 10
  },
  "testing": {
    "test_mode": false,
    "unit_test_mode": false,
    "unit_test_loop_debug": true,
    "test_setting": "FOO"
  },
  "worker": {
    "debug_mode": false,
    "heartbeat_seconds": 30,
    "query_seconds": 10,
    "prefetch_seconds": 10,
    "enable_cancellation": false,
    "cancellation_poll_seconds": 120,
    "webserver": {
      "host": "0.0.0.0",
      "port": 8080
    }
  },
  "ui_url": "<string>",
  "silence_api_url_misconfiguration": false
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

GET

admin

settings

Read Settings

curl --request GET \
  --url https://api.example.com/admin/settings

import requests

url = "https://api.example.com/admin/settings"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://api.example.com/admin/settings', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/admin/settings",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/admin/settings"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.example.com/admin/settings")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/admin/settings")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "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": {},
    "server_version_check_enabled": true,
    "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"
  },
  "events": {
    "worker_max_queue_size": 0
  },
  "experiments": {
    "warn": true
  },
  "flows": {
    "heartbeat_frequency": 180,
    "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"
    }
  },
  "plugins": {
    "enabled": false,
    "allow": [
      "<string>"
    ],
    "deny": [
      "<string>"
    ],
    "setup_timeout_seconds": 20,
    "strict": false,
    "safe_mode": false
  },
  "results": {
    "default_serializer": "pickle",
    "persist_by_default": false,
    "default_storage_block": "<string>",
    "local_storage_path": "<string>"
  },
  "runner": {
    "process_limit": 5,
    "poll_frequency": 10,
    "crash_on_cancellation_failure": false,
    "auto_install_dependencies": false,
    "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": "*",
      "websocket_ping_interval": 20,
      "websocket_ping_timeout": 20,
      "max_parameter_size": 524288
    },
    "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>",
      "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,
        "cancelling_timeout_seconds": 300
      },
      "db_vacuum": {
        "enabled": [
          "events"
        ],
        "loop_seconds": 3600,
        "retention_period": "P90D",
        "batch_size": 200,
        "event_retention_overrides": {
          "prefect.flow-run.heartbeat": "P7D"
        }
      },
      "event_persister": {
        "enabled": true,
        "batch_size": 20,
        "read_batch_size": 1,
        "flush_interval": 5,
        "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
      },
      "cleanup_reconciler": {
        "enabled": true,
        "loop_seconds": 5,
        "batch_size": 100
      },
      "task_run_recorder": {
        "enabled": true,
        "read_batch_size": 1,
        "batch_size": 1,
        "flush_interval": 5
      },
      "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": 10,
      "max_cache_key_length": 2000,
      "scheduling": {
        "max_scheduled_queue_size": 1000,
        "max_retry_queue_size": 100,
        "pending_task_timeout": "PT0S"
      }
    },
    "ui": {
      "enabled": true,
      "v2_enabled": false,
      "api_url": "<string>",
      "serve_base": "/",
      "static_directory": "<string>",
      "show_promotional_content": true
    },
    "worker_channel": {
      "cleanup_queue_storage": "prefect.server.worker_communication.cleanup_queue.memory",
      "cleanup_lease_seconds": 30,
      "cleanup_max_delivery_attempts": 3,
      "cleanup_completed_idempotency_retention_seconds": 1
    }
  },
  "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
    }
  },
  "telemetry": {
    "enable_resource_metrics": true,
    "resource_metrics_interval_seconds": 10
  },
  "testing": {
    "test_mode": false,
    "unit_test_mode": false,
    "unit_test_loop_debug": true,
    "test_setting": "FOO"
  },
  "worker": {
    "debug_mode": false,
    "heartbeat_seconds": 30,
    "query_seconds": 10,
    "prefetch_seconds": 10,
    "enable_cancellation": false,
    "cancellation_poll_seconds": 120,
    "webserver": {
      "host": "0.0.0.0",
      "port": 8080
    }
  },
  "ui_url": "<string>",
  "silence_api_url_misconfiguration": false
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Headers

x-prefect-api-version

string

Response

Successful Response

Settings for Prefect using Pydantic settings.

See https://docs.pydantic.dev/latest/concepts/pydantic_settings

home

string<path>

default:~/.prefect

The path to the Prefect home directory. Defaults to ~/.prefect

profiles_path

string<path>

The path to a profiles configuration file. Supports $PREFECT_HOME templating. Defaults to $PREFECT_HOME/profiles.toml.

debug_mode

boolean

default:false

If True, enables debug mode which may provide additional logging and debugging features.

api

APISettings · object

Settings for interacting with the Prefect API

Show child attributes

cli

CLISettings · object

Settings for controlling CLI behavior

Show child attributes

client

ClientSettings · object

Settings for controlling API client behavior

Show child attributes

cloud

CloudSettings · object

Settings for interacting with Prefect Cloud

Show child attributes

deployments

DeploymentsSettings · object

Settings for configuring deployments defaults

Show child attributes

events

EventsSettings · object

Settings for controlling events behavior

Show child attributes

experiments

ExperimentsSettings · object

Settings for controlling experimental features

Show child attributes

flows

FlowsSettings · object

Settings for controlling flow behavior

Show child attributes

internal

InternalSettings · object

Settings for internal Prefect machinery

Show child attributes

logging

LoggingSettings · object

Settings for controlling logging behavior

Show child attributes

plugins

PluginsSettings · object

Settings for the plugin system.

Show child attributes

results

ResultsSettings · object

Settings for controlling result storage behavior

Show child attributes

runner

RunnerSettings · object

Settings for controlling runner behavior

Show child attributes

server

ServerSettings · object

Settings for controlling server behavior

Show child attributes

tasks

TasksSettings · object

Settings for controlling task behavior

Show child attributes

telemetry

TelemetrySettings · object

Settings for configuring telemetry collection

Show child attributes

testing

TestingSettings · object

Settings used during testing

Show child attributes

worker

WorkerSettings · object

Settings for controlling worker behavior

Show child attributes

ui_url

string | null

The URL of the Prefect UI. If not set, the client will attempt to infer it.

silence_api_url_misconfiguration

boolean

default:false

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`.

Validate Template Read Version

⌘I