Class SyncPrefectClient

src/prefect/client/orchestration/__init__.py:1228–2121

A synchronous client for interacting with the [Prefect REST API](https://docs.prefect.io/v3/api-ref/rest-api/). Args: api: the REST API URL or FastAPI application to connect to api_key: An optional API key for authentication. api_version: The API version this client

class SyncPrefectClient(
    ArtifactClient,
    ArtifactCollectionClient,
    LogClient,
    VariableClient,
    ConcurrencyLimitClient,
    DeploymentClient,
    AutomationClient,
    SlaClient,
    FlowRunClient,
    FlowClient,
    BlocksDocumentClient,
    BlocksSchemaClient,
    BlocksTypeClient,
    WorkPoolClient,
    EventClient,
):
    """
    A synchronous client for interacting with the [Prefect REST API](https://docs.prefect.io/v3/api-ref/rest-api/).

    Args:
        api: the REST API URL or FastAPI application to connect to
        api_key: An optional API key for authentication.
        api_version: The API version this client is compatible with.
        httpx_settings: An optional dictionary of settings to pass to the underlying
            `httpx.Client`

    Examples:

        Say hello to a Prefect REST API

        ```python
        with get_client(sync_client=True) as client:
            response = client.hello()

        print(response.json())
        👋
        ```
    """

    def __init__(
        self,
        api: Union[str, ASGIApp],
        *,
        auth_string: Optional[str] = None,
        api_key: Optional[str] = None,
        api_version: Optional[str] = None,
        httpx_settings: Optional[dict[str, Any]] = None,
        server_type: Optional[ServerType] = None,
    ) -> None:
        httpx_settings = httpx_settings.copy() if httpx_settings else {}
        httpx_settings.setdefault("headers", {})

        tls_verify = httpx_settings.get("verify")
        if not tls_verify or not isinstance(tls_verify, ssl.SSLContext):
            if PREFECT_API_TLS_INSECURE_SKIP_VERIFY:
                # Create an unverified context for insecure connections
                ctx = ssl.create_default_context()