Bases: PrefectBaseSettings
Settings for interacting with the Prefect API
Source code in src/prefect/settings/models/api.py
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41 | class APISettings(PrefectBaseSettings):
"""
Settings for interacting with the Prefect API
"""
model_config = _build_settings_config(("api",))
url: Optional[str] = Field(
default=None,
description="The URL of the Prefect API. If not set, the client will attempt to infer it.",
)
key: Optional[SecretStr] = Field(
default=None,
description="The API key used for authentication with the Prefect API. Should be kept secret.",
)
tls_insecure_skip_verify: bool = Field(
default=False,
description="If `True`, disables SSL checking to allow insecure requests. This is recommended only during development, e.g. when using self-signed certificates.",
)
ssl_cert_file: Optional[str] = Field(
default=os.environ.get("SSL_CERT_FILE"),
description="This configuration settings option specifies the path to an SSL certificate file.",
)
enable_http2: bool = Field(
default=False,
description="If true, enable support for HTTP/2 for communicating with an API. If the API does not support HTTP/2, this will have no effect and connections will be made via HTTP/1.1.",
)
request_timeout: float = Field(
default=60.0,
description="The default timeout for requests to the API",
)
|