diff --git a/versions/unreleased/api-ref/prefect/client/base/index.html b/versions/unreleased/api-ref/prefect/client/base/index.html index 8889f5dbdd..8dd4682fa3 100644 --- a/versions/unreleased/api-ref/prefect/client/base/index.html +++ b/versions/unreleased/api-ref/prefect/client/base/index.html @@ -9474,7 +9474,12 @@

388 389 390 -391
class PrefectHttpxClient(httpx.AsyncClient):
+391
+392
+393
+394
+395
+396
class PrefectHttpxClient(httpx.AsyncClient):
     """
     A Prefect wrapper for the async httpx client with support for retry-after headers
     for the provided status codes (typically 429, 502 and 503).
@@ -9485,11 +9490,18 @@ 

     [Configuring Cloudflare Rate Limiting](https://support.cloudflare.com/hc/en-us/articles/115001635128-Configuring-Rate-Limiting-from-UI)
     """
 
-    def __init__(self, *args, enable_csrf_support: bool = False, **kwargs):
+    def __init__(
+        self,
+        *args,
+        enable_csrf_support: bool = False,
+        raise_on_all_errors: bool = True,
+        **kwargs,
+    ):
         self.enable_csrf_support: bool = enable_csrf_support
         self.csrf_token: Optional[str] = None
         self.csrf_token_expiration: Optional[datetime] = None
         self.csrf_client_id: uuid.UUID = uuid.uuid4()
+        self.raise_on_all_errors: bool = raise_on_all_errors
 
         super().__init__(*args, **kwargs)
 
@@ -9637,10 +9649,8 @@ 

         # Convert to a Prefect response to add nicer errors messages
         response = PrefectResponse.from_httpx_response(response)
 
-        # Always raise bad responses
-        # NOTE: We may want to remove this and handle responses per route in the
-        #       `PrefectClient`
-        response.raise_for_status()
+        if self.raise_on_all_errors:
+            response.raise_for_status()
 
         return response
 
@@ -9725,14 +9735,7 @@ 

 
           

             Source code in prefect/client/base.py
-            
305
-306
-307
-308
-309
-310
-311
-312
+            
312
 313
 314
 315
@@ -9773,7 +9776,12 @@ 

 350
 351
 352
-353
async def send(self, request: Request, *args, **kwargs) -> Response:
+353
+354
+355
+356
+357
+358
async def send(self, request: Request, *args, **kwargs) -> Response:
     """
     Send a request with automatic retry behavior for the following status codes:
 
@@ -9816,10 +9824,8 @@ 

     # Convert to a Prefect response to add nicer errors messages
     response = PrefectResponse.from_httpx_response(response)
 
-    # Always raise bad responses
-    # NOTE: We may want to remove this and handle responses per route in the
-    #       `PrefectClient`
-    response.raise_for_status()
+    if self.raise_on_all_errors:
+        response.raise_for_status()
 
     return response
 

diff --git a/versions/unreleased/api-ref/prefect/settings/index.html b/versions/unreleased/api-ref/prefect/settings/index.html
index 8ab8ded8b6..64b55dce01 100644
--- a/versions/unreleased/api-ref/prefect/settings/index.html
+++ b/versions/unreleased/api-ref/prefect/settings/index.html
@@ -7502,6 +7502,39 @@
     
   
   
+
+      
+        
  • 
+  
+    
+      
+        PREFECT_API_SERVICES_EVENT_PERSISTER_ENABLED
+      
+    
+  
+  
+
    • 
+      
+        
  • 
+  
+    
+      
+        PREFECT_API_SERVICES_EVENT_PERSISTER_BATCH_SIZE
+      
+    
+  
+  
+
    • 
+      
+        
  • 
+  
+    
+      
+        PREFECT_API_SERVICES_EVENT_PERSISTER_FLUSH_INTERVAL
+      
+    
+  
+  
 
    • 
       
         
  • 
@@ -12421,6 +12454,39 @@
     
   
   
+
    • 
+      
+        
  • 
+  
+    
+      
+        PREFECT_API_SERVICES_EVENT_PERSISTER_ENABLED
+      
+    
+  
+  
+
    • 
+      
+        
  • 
+  
+    
+      
+        PREFECT_API_SERVICES_EVENT_PERSISTER_BATCH_SIZE
+      
+    
+  
+  
+
    • 
+      
+        
  • 
+  
+    
+      
+        PREFECT_API_SERVICES_EVENT_PERSISTER_FLUSH_INTERVAL
+      
+    
+  
+  
 
    • 
       
         
  • 
@@ -16244,6 +16310,69 @@ 
    
+
+
+
+
    
+          PREFECT_API_SERVICES_EVENT_PERSISTER_ENABLED = Setting(bool, default=True)
+  
+  
+      module-attribute
+  
+
+
    
+
+
+  
    
+  
+      
    Whether or not to start the event persister service in the server application.
    
+  
    
+
+
    • 
+
+
    
+
+
+
+
    
+          PREFECT_API_SERVICES_EVENT_PERSISTER_BATCH_SIZE = Setting(int, default=20, gt=0)
+  
+  
+      module-attribute
+  
+
+
    
+
+
+  
    
+  
+      
    The number of events the event persister will attempt to insert in one batch.
    
+  
    
+
+
    
+
+
    
+
+
+
+
    
+          PREFECT_API_SERVICES_EVENT_PERSISTER_FLUSH_INTERVAL = Setting(float, default=5, gt=0.0)
+  
+  
+      module-attribute
+  
+
+
    
+
+
+  
    
+  
+      
    The maximum number of seconds between flushes of the event persister.
    
+  
    
+
+
    
+
 
 
    
 
@@ -16759,23 +16888,7 @@ 
    
 
             
    
               Source code in prefect/settings.py
-              
    1723
-1724
-1725
-1726
-1727
-1728
-1729
-1730
-1731
-1732
-1733
-1734
-1735
-1736
-1737
-1738
-1739
+              
    1739
 1740
 1741
 1742
@@ -16913,7 +17026,23 @@ 
    
 1874
 1875
 1876
-1877
    @add_cloudpickle_reduction
+1877
+1878
+1879
+1880
+1881
+1882
+1883
+1884
+1885
+1886
+1887
+1888
+1889
+1890
+1891
+1892
+1893
    @add_cloudpickle_reduction
 class Settings(SettingsFieldsMixin):
     """
     Contains validated Prefect settings.
@@ -17100,14 +17229,14 @@ 
    
 
           
    
             Source code in prefect/settings.py
-            
    1742
-1743
-1744
-1745
-1746
-1747
-1748
-1749
    def value_of(self, setting: Setting[T], bypass_callback: bool = False) -> T:
+            
    1758
+1759
+1760
+1761
+1762
+1763
+1764
+1765
    def value_of(self, setting: Setting[T], bypass_callback: bool = False) -> T:
     """
     Retrieve a setting's value.
     """
@@ -17138,19 +17267,19 @@ 
    
 
           
    
             Source code in prefect/settings.py
-            
    1758
-1759
-1760
-1761
-1762
-1763
-1764
-1765
-1766
-1767
-1768
-1769
-1770
    @root_validator
+            
    1774
+1775
+1776
+1777
+1778
+1779
+1780
+1781
+1782
+1783
+1784
+1785
+1786
    @root_validator
 def post_root_validators(cls, values):
     """
     Add root validation functions for settings here.
@@ -17186,23 +17315,23 @@ 
    
             Source code in prefect/settings.py
-            
    1804
-1805
-1806
-1807
-1808
-1809
-1810
-1811
-1812
-1813
-1814
-1815
-1816
-1817
-1818
-1819
-1820
    def with_obfuscated_secrets(self):
+            
    1820
+1821
+1822
+1823
+1824
+1825
+1826
+1827
+1828
+1829
+1830
+1831
+1832
+1833
+1834
+1835
+1836
    def with_obfuscated_secrets(self):
     """
     Returns a copy of this settings object with secret setting values obfuscated.
     """
@@ -17243,13 +17372,13 @@ 
    
 
           
    
             Source code in prefect/settings.py
-            
    1822
-1823
-1824
-1825
-1826
-1827
-1828
    def hash_key(self) -> str:
+            
    1838
+1839
+1840
+1841
+1842
+1843
+1844
    def hash_key(self) -> str:
     """
     Return a hash key for the settings object.  This is needed since some
     settings may be unhashable.  An example is lists.
@@ -17351,23 +17480,7 @@ 
    
             Source code in prefect/settings.py
-            
    1830
-1831
-1832
-1833
-1834
-1835
-1836
-1837
-1838
-1839
-1840
-1841
-1842
-1843
-1844
-1845
-1846
+            
    1846
 1847
 1848
 1849
@@ -17395,7 +17508,23 @@ 
    1871
 1872
 1873
-1874
    def to_environment_variables(
+1874
+1875
+1876
+1877
+1878
+1879
+1880
+1881
+1882
+1883
+1884
+1885
+1886
+1887
+1888
+1889
+1890
    def to_environment_variables(
     self, include: Iterable[Setting] = None, exclude_unset: bool = False
 ) -> Dict[str, str]:
     """
@@ -17475,23 +17604,7 @@ 
    
 
             
    
               Source code in prefect/settings.py
-              
    1982
-1983
-1984
-1985
-1986
-1987
-1988
-1989
-1990
-1991
-1992
-1993
-1994
-1995
-1996
-1997
-1998
+              
    1998
 1999
 2000
 2001
@@ -17522,7 +17635,23 @@ 
    
 2026
 2027
 2028
-2029
    class Profile(BaseModel):
+2029
+2030
+2031
+2032
+2033
+2034
+2035
+2036
+2037
+2038
+2039
+2040
+2041
+2042
+2043
+2044
+2045
    class Profile(BaseModel):
     """
     A user profile containing settings.
     """
@@ -17626,18 +17755,18 @@ 
    
 
           
    
             Source code in prefect/settings.py
-            
    1995
-1996
-1997
-1998
-1999
-2000
-2001
-2002
-2003
-2004
-2005
-2006
    def validate_settings(self) -> None:
+            
    2011
+2012
+2013
+2014
+2015
+2016
+2017
+2018
+2019
+2020
+2021
+2022
    def validate_settings(self) -> None:
     """
     Validate the settings contained in this profile.
 
@@ -17674,25 +17803,25 @@ 
    
             Source code in prefect/settings.py
-            
    2008
-2009
-2010
-2011
-2012
-2013
-2014
-2015
-2016
-2017
-2018
-2019
-2020
-2021
-2022
-2023
-2024
+            
    2024
 2025
-2026
    def convert_deprecated_renamed_settings(self) -> List[Tuple[Setting, Setting]]:
+2026
+2027
+2028
+2029
+2030
+2031
+2032
+2033
+2034
+2035
+2036
+2037
+2038
+2039
+2040
+2041
+2042
    def convert_deprecated_renamed_settings(self) -> List[Tuple[Setting, Setting]]:
     """
     Update settings in place to replace deprecated settings with new settings when
     renamed.
@@ -17747,23 +17876,7 @@ 
    
 
             
    
               Source code in prefect/settings.py
-              
    2032
-2033
-2034
-2035
-2036
-2037
-2038
-2039
-2040
-2041
-2042
-2043
-2044
-2045
-2046
-2047
-2048
+              
    2048
 2049
 2050
 2051
@@ -17897,7 +18010,23 @@ 
    
 2179
 2180
 2181
-2182
    class ProfilesCollection:
+2182
+2183
+2184
+2185
+2186
+2187
+2188
+2189
+2190
+2191
+2192
+2193
+2194
+2195
+2196
+2197
+2198
    class ProfilesCollection:
     """ "
     A utility class for working with a collection of profiles.
 
@@ -18124,16 +18253,16 @@ 
    
 
           
    
             Source code in prefect/settings.py
-            
    2063
-2064
-2065
-2066
-2067
-2068
-2069
-2070
-2071
-2072
    def set_active(self, name: Optional[str], check: bool = True):
+            
    2079
+2080
+2081
+2082
+2083
+2084
+2085
+2086
+2087
+2088
    def set_active(self, name: Optional[str], check: bool = True):
     """
     Set the active profile name in the collection.
 
@@ -18171,23 +18300,7 @@ 
    
             Source code in prefect/settings.py
-            
    2074
-2075
-2076
-2077
-2078
-2079
-2080
-2081
-2082
-2083
-2084
-2085
-2086
-2087
-2088
-2089
-2090
+            
    2090
 2091
 2092
 2093
@@ -18207,7 +18320,23 @@ 
    2107
 2108
 2109
-2110
    def update_profile(
+2110
+2111
+2112
+2113
+2114
+2115
+2116
+2117
+2118
+2119
+2120
+2121
+2122
+2123
+2124
+2125
+2126
    def update_profile(
     self, name: str, settings: Mapping[Union[Dict, str], Any], source: Path = None
 ) -> Profile:
     """
@@ -18268,18 +18397,18 @@ 
    
             Source code in prefect/settings.py
-            
    2112
-2113
-2114
-2115
-2116
-2117
-2118
-2119
-2120
-2121
-2122
-2123
    def add_profile(self, profile: Profile) -> None:
+            
    2128
+2129
+2130
+2131
+2132
+2133
+2134
+2135
+2136
+2137
+2138
+2139
    def add_profile(self, profile: Profile) -> None:
     """
     Add a profile to the collection.
 
@@ -18314,11 +18443,11 @@ 
    
             Source code in prefect/settings.py
-            
    2125
-2126
-2127
-2128
-2129
    def remove_profile(self, name: str) -> None:
+            
    2141
+2142
+2143
+2144
+2145
    def remove_profile(self, name: str) -> None:
     """
     Remove a profile from the collection.
     """
@@ -18347,20 +18476,20 @@ 
    
             Source code in prefect/settings.py
-            
    2131
-2132
-2133
-2134
-2135
-2136
-2137
-2138
-2139
-2140
-2141
-2142
-2143
-2144
    def without_profile_source(self, path: Optional[Path]) -> "ProfilesCollection":
+            
    2147
+2148
+2149
+2150
+2151
+2152
+2153
+2154
+2155
+2156
+2157
+2158
+2159
+2160
    def without_profile_source(self, path: Optional[Path]) -> "ProfilesCollection":
     """
     Remove profiles that were loaded from a given path.
 
@@ -18891,18 +19020,18 @@ 
    
 
           
    
             Source code in prefect/settings.py
-            
    1886
-1887
-1888
-1889
-1890
-1891
-1892
-1893
-1894
-1895
-1896
-1897
    def get_current_settings() -> Settings:
+            
    1902
+1903
+1904
+1905
+1906
+1907
+1908
+1909
+1910
+1911
+1912
+1913
    def get_current_settings() -> Settings:
     """
     Returns a settings object populated with values from the current settings context
     or, if no settings context is active, the environment.
@@ -18940,22 +19069,22 @@ 
    
 
           
    
             Source code in prefect/settings.py
-            
    1900
-1901
-1902
-1903
-1904
-1905
-1906
-1907
-1908
-1909
-1910
-1911
-1912
-1913
-1914
-1915
    def get_settings_from_env() -> Settings:
+            
    1916
+1917
+1918
+1919
+1920
+1921
+1922
+1923
+1924
+1925
+1926
+1927
+1928
+1929
+1930
+1931
    def get_settings_from_env() -> Settings:
     """
     Returns a settings object populated with default values and overrides from
     environment variables, ignoring any values in profiles.
@@ -18997,27 +19126,27 @@ 
    
 
           
    
             Source code in prefect/settings.py
-            
    1918
-1919
-1920
-1921
-1922
-1923
-1924
-1925
-1926
-1927
-1928
-1929
-1930
-1931
-1932
-1933
-1934
+            
    1934
 1935
 1936
 1937
-1938
    def get_default_settings() -> Settings:
+1938
+1939
+1940
+1941
+1942
+1943
+1944
+1945
+1946
+1947
+1948
+1949
+1950
+1951
+1952
+1953
+1954
    def get_default_settings() -> Settings:
     """
     Returns a settings object populated with default values, ignoring any overrides
     from environment variables or profiles.
@@ -19081,23 +19210,7 @@ 
    
 
           
    
             Source code in prefect/settings.py
-            
    1941
-1942
-1943
-1944
-1945
-1946
-1947
-1948
-1949
-1950
-1951
-1952
-1953
-1954
-1955
-1956
-1957
+            
    1957
 1958
 1959
 1960
@@ -19119,7 +19232,23 @@ 
    
 1976
 1977
 1978
-1979
    @contextmanager
+1979
+1980
+1981
+1982
+1983
+1984
+1985
+1986
+1987
+1988
+1989
+1990
+1991
+1992
+1993
+1994
+1995
    @contextmanager
 def temporary_settings(
     updates: Optional[Mapping[Setting[T], Any]] = None,
     set_defaults: Optional[Mapping[Setting[T], Any]] = None,
@@ -19181,28 +19310,28 @@ 
    
 
           
    
             Source code in prefect/settings.py
-            
    2240
-2241
-2242
-2243
-2244
-2245
-2246
-2247
-2248
-2249
-2250
-2251
-2252
-2253
-2254
-2255
-2256
+            
    2256
 2257
 2258
 2259
 2260
-2261
    def load_profiles() -> ProfilesCollection:
+2261
+2262
+2263
+2264
+2265
+2266
+2267
+2268
+2269
+2270
+2271
+2272
+2273
+2274
+2275
+2276
+2277
    def load_profiles() -> ProfilesCollection:
     """
     Load all profiles from the default and current profile paths.
     """
@@ -19249,22 +19378,22 @@ 
    
 
           
    
             Source code in prefect/settings.py
-            
    2264
-2265
-2266
-2267
-2268
-2269
-2270
-2271
-2272
-2273
-2274
-2275
-2276
-2277
-2278
-2279
    def load_current_profile():
+            
    2280
+2281
+2282
+2283
+2284
+2285
+2286
+2287
+2288
+2289
+2290
+2291
+2292
+2293
+2294
+2295
    def load_current_profile():
     """
     Load the current profile from the default and current profile paths.
 
@@ -19303,13 +19432,13 @@ 
    
 
           
    
             Source code in prefect/settings.py
-            
    2282
-2283
-2284
-2285
-2286
-2287
-2288
    def save_profiles(profiles: ProfilesCollection) -> None:
+            
    2298
+2299
+2300
+2301
+2302
+2303
+2304
    def save_profiles(profiles: ProfilesCollection) -> None:
     """
     Writes all non-default profiles to the current profiles path.
     """
@@ -19339,15 +19468,15 @@ 
    
 
           
    
             Source code in prefect/settings.py
-            
    2291
-2292
-2293
-2294
-2295
-2296
-2297
-2298
-2299
    def load_profile(name: str) -> Profile:
+            
    2307
+2308
+2309
+2310
+2311
+2312
+2313
+2314
+2315
    def load_profile(name: str) -> Profile:
     """
     Load a single profile by name.
     """
@@ -19406,23 +19535,7 @@ 
    
 
           
    
             Source code in prefect/settings.py
-            
    2302
-2303
-2304
-2305
-2306
-2307
-2308
-2309
-2310
-2311
-2312
-2313
-2314
-2315
-2316
-2317
-2318
+            
    2318
 2319
 2320
 2321
@@ -19437,7 +19550,23 @@ 
    
 2330
 2331
 2332
-2333
    def update_current_profile(settings: Dict[Union[str, Setting], Any]) -> Profile:
+2333
+2334
+2335
+2336
+2337
+2338
+2339
+2340
+2341
+2342
+2343
+2344
+2345
+2346
+2347
+2348
+2349
    def update_current_profile(settings: Dict[Union[str, Setting], Any]) -> Profile:
     """
     Update the persisted data for the profile currently in-use.
 
diff --git a/versions/unreleased/api-ref/schema.json b/versions/unreleased/api-ref/schema.json
index 2b2ba17561..7d250ecee8 100644
--- a/versions/unreleased/api-ref/schema.json
+++ b/versions/unreleased/api-ref/schema.json
@@ -1 +1 @@
-{"openapi": "3.1.0", "info": {}, "paths": {"/api/health": {"get": {"tags": ["Root"], "summary": "Health Check", "operationId": "health_check_health_get", "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}}}}, "/api/version": {"get": {"tags": ["Root"], "summary": "Orion Info", "operationId": "orion_info_version_get", "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}}}}, "/api/flows/": {"post": {"tags": ["Flows"], "summary": "Create Flow", "description": "Gracefully creates a new flow from the provided schema. If a flow with the\nsame name already exists, the existing flow is returned.", "operationId": "create_flow_flows__post", "parameters": [{"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/FlowCreate"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Flow"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/flows/{id}": {"get": {"tags": ["Flows"], "summary": "Read Flow", "description": "Get a flow by id.", "operationId": "read_flow_flows__id__get", "parameters": [{"description": "The flow id", "required": true, "schema": {"type": "string", "format": "uuid", "title": "Id", "description": "The flow id"}, "name": "id", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Flow"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}, "delete": {"tags": ["Flows"], "summary": "Delete Flow", "description": "Delete a flow by id.", "operationId": "delete_flow_flows__id__delete", "parameters": [{"description": "The flow id", "required": true, "schema": {"type": "string", "format": "uuid", "title": "Id", "description": "The flow id"}, "name": "id", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "responses": {"204": {"description": "Successful Response"}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}, "patch": {"tags": ["Flows"], "summary": "Update Flow", "description": "Updates a flow.", "operationId": "update_flow_flows__id__patch", "parameters": [{"description": "The flow id", "required": true, "schema": {"type": "string", "format": "uuid", "title": "Id", "description": "The flow id"}, "name": "id", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/FlowUpdate"}}}, "required": true}, "responses": {"204": {"description": "Successful Response"}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/flows/count": {"post": {"tags": ["Flows"], "summary": "Count Flows", "description": "Count flows.", "operationId": "count_flows_flows_count_post", "parameters": [{"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Body_count_flows_flows_count_post"}}}}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"type": "integer", "title": "Response Count Flows Flows Count Post"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/flows/name/{name}": {"get": {"tags": ["Flows"], "summary": "Read Flow By Name", "description": "Get a flow by name.", "operationId": "read_flow_by_name_flows_name__name__get", "parameters": [{"description": "The name of the flow", "required": true, "schema": {"type": "string", "title": "Name", "description": "The name of the flow"}, "name": "name", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Flow"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/flows/filter": {"post": {"tags": ["Flows"], "summary": "Read Flows", "description": "Query for flows.", "operationId": "read_flows_flows_filter_post", "parameters": [{"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Body_read_flows_flows_filter_post"}}}}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/Flow"}, "type": "array", "title": "Response Read Flows Flows Filter Post"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/flow_runs/": {"post": {"tags": ["Flow Runs"], "summary": "Create Flow Run", "description": "Create a flow run. If a flow run with the same flow_id and\nidempotency key already exists, the existing flow run will be returned.\n\nIf no state is provided, the flow run will be created in a PENDING state.", "operationId": "create_flow_run_flow_runs__post", "parameters": [{"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/FlowRunCreate"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/FlowRunResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/flow_runs/{id}": {"get": {"tags": ["Flow Runs"], "summary": "Read Flow Run", "description": "Get a flow run by id.", "operationId": "read_flow_run_flow_runs__id__get", "parameters": [{"description": "The flow run id", "required": true, "schema": {"type": "string", "format": "uuid", "title": "Id", "description": "The flow run id"}, "name": "id", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/FlowRunResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}, "delete": {"tags": ["Flow Runs"], "summary": "Delete Flow Run", "description": "Delete a flow run by id.", "operationId": "delete_flow_run_flow_runs__id__delete", "parameters": [{"description": "The flow run id", "required": true, "schema": {"type": "string", "format": "uuid", "title": "Id", "description": "The flow run id"}, "name": "id", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "responses": {"204": {"description": "Successful Response"}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}, "patch": {"tags": ["Flow Runs"], "summary": "Update Flow Run", "description": "Updates a flow run.", "operationId": "update_flow_run_flow_runs__id__patch", "parameters": [{"description": "The flow run id", "required": true, "schema": {"type": "string", "format": "uuid", "title": "Id", "description": "The flow run id"}, "name": "id", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/FlowRunUpdate"}}}, "required": true}, "responses": {"204": {"description": "Successful Response"}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/flow_runs/count": {"post": {"tags": ["Flow Runs"], "summary": "Count Flow Runs", "description": "Query for flow runs.", "operationId": "count_flow_runs_flow_runs_count_post", "parameters": [{"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Body_count_flow_runs_flow_runs_count_post"}}}}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"type": "integer", "title": "Response Count Flow Runs Flow Runs Count Post"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/flow_runs/lateness": {"post": {"tags": ["Flow Runs"], "summary": "Average Flow Run Lateness", "description": "Query for average flow-run lateness in seconds.", "operationId": "average_flow_run_lateness_flow_runs_lateness_post", "parameters": [{"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Body_average_flow_run_lateness_flow_runs_lateness_post"}}}}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"type": "number", "title": "Response Average Flow Run Lateness Flow Runs Lateness Post"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/flow_runs/history": {"post": {"tags": ["Flow Runs"], "summary": "Flow Run History", "description": "Query for flow run history data across a given range and interval.", "operationId": "flow_run_history_flow_runs_history_post", "parameters": [{"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Body_flow_run_history_flow_runs_history_post"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/HistoryResponse"}, "type": "array", "title": "Response Flow Run History Flow Runs History Post"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/flow_runs/{id}/graph": {"get": {"tags": ["Flow Runs"], "summary": "Read Flow Run Graph V1", "description": "Get a task run dependency map for a given flow run.", "operationId": "read_flow_run_graph_v1_flow_runs__id__graph_get", "parameters": [{"description": "The flow run id", "required": true, "schema": {"type": "string", "format": "uuid", "title": "Id", "description": "The flow run id"}, "name": "id", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/DependencyResult"}, "type": "array", "title": "Response Read Flow Run Graph V1 Flow Runs  Id  Graph Get"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/flow_runs/{id}/graph-v2": {"get": {"tags": ["Flow Runs"], "summary": "Read Flow Run Graph V2", "description": "Get a graph of the tasks and subflow runs for the given flow run", "operationId": "read_flow_run_graph_v2_flow_runs__id__graph_v2_get", "parameters": [{"description": "The flow run id", "required": true, "schema": {"type": "string", "format": "uuid", "title": "Id", "description": "The flow run id"}, "name": "id", "in": "path"}, {"description": "Only include runs that start or end after this time.", "required": false, "schema": {"type": "string", "format": "date-time", "title": "Since", "description": "Only include runs that start or end after this time.", "default": "0001-01-01T00:00:00"}, "name": "since", "in": "query"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Graph"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/flow_runs/{id}/resume": {"post": {"tags": ["Flow Runs"], "summary": "Resume Flow Run", "description": "Resume a paused flow run.", "operationId": "resume_flow_run_flow_runs__id__resume_post", "parameters": [{"description": "The flow run id", "required": true, "schema": {"type": "string", "format": "uuid", "title": "Id", "description": "The flow run id"}, "name": "id", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Body_resume_flow_run_flow_runs__id__resume_post"}}}}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/OrchestrationResult"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/flow_runs/filter": {"post": {"tags": ["Flow Runs"], "summary": "Read Flow Runs", "description": "Query for flow runs.", "operationId": "read_flow_runs_flow_runs_filter_post", "parameters": [{"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Body_read_flow_runs_flow_runs_filter_post"}}}}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/FlowRunResponse"}, "type": "array", "title": "Response Read Flow Runs Flow Runs Filter Post"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/flow_runs/{id}/set_state": {"post": {"tags": ["Flow Runs"], "summary": "Set Flow Run State", "description": "Set a flow run state, invoking any orchestration rules.", "operationId": "set_flow_run_state_flow_runs__id__set_state_post", "parameters": [{"description": "The flow run id", "required": true, "schema": {"type": "string", "format": "uuid", "title": "Id", "description": "The flow run id"}, "name": "id", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Body_set_flow_run_state_flow_runs__id__set_state_post"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/OrchestrationResult"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/flow_runs/{id}/input": {"post": {"tags": ["Flow Runs"], "summary": "Create Flow Run Input", "description": "Create a key/value input for a flow run.", "operationId": "create_flow_run_input_flow_runs__id__input_post", "parameters": [{"description": "The flow run id", "required": true, "schema": {"type": "string", "format": "uuid", "title": "Id", "description": "The flow run id"}, "name": "id", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Body_create_flow_run_input_flow_runs__id__input_post"}}}, "required": true}, "responses": {"201": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/flow_runs/{id}/input/filter": {"post": {"tags": ["Flow Runs"], "summary": "Filter Flow Run Input", "description": "Filter flow run inputs by key prefix", "operationId": "filter_flow_run_input_flow_runs__id__input_filter_post", "parameters": [{"description": "The flow run id", "required": true, "schema": {"type": "string", "format": "uuid", "title": "Id", "description": "The flow run id"}, "name": "id", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Body_filter_flow_run_input_flow_runs__id__input_filter_post"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/FlowRunInput"}, "type": "array", "title": "Response Filter Flow Run Input Flow Runs  Id  Input Filter Post"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/flow_runs/{id}/input/{key}": {"get": {"tags": ["Flow Runs"], "summary": "Read Flow Run Input", "description": "Create a value from a flow run input", "operationId": "read_flow_run_input_flow_runs__id__input__key__get", "parameters": [{"description": "The flow run id", "required": true, "schema": {"type": "string", "format": "uuid", "title": "Id", "description": "The flow run id"}, "name": "id", "in": "path"}, {"description": "The input key", "required": true, "schema": {"type": "string", "title": "Key", "description": "The input key"}, "name": "key", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}, "delete": {"tags": ["Flow Runs"], "summary": "Delete Flow Run Input", "description": "Delete a flow run input", "operationId": "delete_flow_run_input_flow_runs__id__input__key__delete", "parameters": [{"description": "The flow run id", "required": true, "schema": {"type": "string", "format": "uuid", "title": "Id", "description": "The flow run id"}, "name": "id", "in": "path"}, {"description": "The input key", "required": true, "schema": {"type": "string", "title": "Key", "description": "The input key"}, "name": "key", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "responses": {"204": {"description": "Successful Response"}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/task_runs/": {"post": {"tags": ["Task Runs"], "summary": "Create Task Run", "description": "Create a task run. If a task run with the same flow_run_id,\ntask_key, and dynamic_key already exists, the existing task\nrun will be returned.\n\nIf no state is provided, the task run will be created in a PENDING state.", "operationId": "create_task_run_task_runs__post", "parameters": [{"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/TaskRunCreate"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TaskRun"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/task_runs/{id}": {"get": {"tags": ["Task Runs"], "summary": "Read Task Run", "description": "Get a task run by id.", "operationId": "read_task_run_task_runs__id__get", "parameters": [{"description": "The task run id", "required": true, "schema": {"type": "string", "format": "uuid", "title": "Id", "description": "The task run id"}, "name": "id", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/TaskRun"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}, "delete": {"tags": ["Task Runs"], "summary": "Delete Task Run", "description": "Delete a task run by id.", "operationId": "delete_task_run_task_runs__id__delete", "parameters": [{"description": "The task run id", "required": true, "schema": {"type": "string", "format": "uuid", "title": "Id", "description": "The task run id"}, "name": "id", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "responses": {"204": {"description": "Successful Response"}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}, "patch": {"tags": ["Task Runs"], "summary": "Update Task Run", "description": "Updates a task run.", "operationId": "update_task_run_task_runs__id__patch", "parameters": [{"description": "The task run id", "required": true, "schema": {"type": "string", "format": "uuid", "title": "Id", "description": "The task run id"}, "name": "id", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/TaskRunUpdate"}}}, "required": true}, "responses": {"204": {"description": "Successful Response"}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/task_runs/count": {"post": {"tags": ["Task Runs"], "summary": "Count Task Runs", "description": "Count task runs.", "operationId": "count_task_runs_task_runs_count_post", "parameters": [{"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Body_count_task_runs_task_runs_count_post"}}}}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"type": "integer", "title": "Response Count Task Runs Task Runs Count Post"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/task_runs/history": {"post": {"tags": ["Task Runs"], "summary": "Task Run History", "description": "Query for task run history data across a given range and interval.", "operationId": "task_run_history_task_runs_history_post", "parameters": [{"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Body_task_run_history_task_runs_history_post"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/HistoryResponse"}, "type": "array", "title": "Response Task Run History Task Runs History Post"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/task_runs/filter": {"post": {"tags": ["Task Runs"], "summary": "Read Task Runs", "description": "Query for task runs.", "operationId": "read_task_runs_task_runs_filter_post", "parameters": [{"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Body_read_task_runs_task_runs_filter_post"}}}}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/TaskRun"}, "type": "array", "title": "Response Read Task Runs Task Runs Filter Post"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/task_runs/{id}/set_state": {"post": {"tags": ["Task Runs"], "summary": "Set Task Run State", "description": "Set a task run state, invoking any orchestration rules.", "operationId": "set_task_run_state_task_runs__id__set_state_post", "parameters": [{"description": "The task run id", "required": true, "schema": {"type": "string", "format": "uuid", "title": "Id", "description": "The task run id"}, "name": "id", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Body_set_task_run_state_task_runs__id__set_state_post"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/OrchestrationResult"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/flow_run_states/{id}": {"get": {"tags": ["Flow Run States"], "summary": "Read Flow Run State", "description": "Get a flow run state by id.", "operationId": "read_flow_run_state_flow_run_states__id__get", "parameters": [{"description": "The flow run state id", "required": true, "schema": {"type": "string", "format": "uuid", "title": "Id", "description": "The flow run state id"}, "name": "id", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/State"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/flow_run_states/": {"get": {"tags": ["Flow Run States"], "summary": "Read Flow Run States", "description": "Get states associated with a flow run.", "operationId": "read_flow_run_states_flow_run_states__get", "parameters": [{"required": true, "schema": {"type": "string", "format": "uuid", "title": "Flow Run Id"}, "name": "flow_run_id", "in": "query"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/State"}, "type": "array", "title": "Response Read Flow Run States Flow Run States  Get"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/task_run_states/{id}": {"get": {"tags": ["Task Run States"], "summary": "Read Task Run State", "description": "Get a task run state by id.", "operationId": "read_task_run_state_task_run_states__id__get", "parameters": [{"description": "The task run state id", "required": true, "schema": {"type": "string", "format": "uuid", "title": "Id", "description": "The task run state id"}, "name": "id", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/State"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/task_run_states/": {"get": {"tags": ["Task Run States"], "summary": "Read Task Run States", "description": "Get states associated with a task run.", "operationId": "read_task_run_states_task_run_states__get", "parameters": [{"required": true, "schema": {"type": "string", "format": "uuid", "title": "Task Run Id"}, "name": "task_run_id", "in": "query"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/State"}, "type": "array", "title": "Response Read Task Run States Task Run States  Get"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/flow_run_notification_policies/": {"post": {"tags": ["Flow Run Notification Policies"], "summary": "Create Flow Run Notification Policy", "description": "Creates a new flow run notification policy.", "operationId": "create_flow_run_notification_policy_flow_run_notification_policies__post", "parameters": [{"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/FlowRunNotificationPolicyCreate"}}}, "required": true}, "responses": {"201": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/FlowRunNotificationPolicy"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/flow_run_notification_policies/{id}": {"get": {"tags": ["Flow Run Notification Policies"], "summary": "Read Flow Run Notification Policy", "description": "Get a flow run notification policy by id.", "operationId": "read_flow_run_notification_policy_flow_run_notification_policies__id__get", "parameters": [{"description": "The flow run notification policy id", "required": true, "schema": {"type": "string", "format": "uuid", "title": "Id", "description": "The flow run notification policy id"}, "name": "id", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/FlowRunNotificationPolicy"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}, "delete": {"tags": ["Flow Run Notification Policies"], "summary": "Delete Flow Run Notification Policy", "description": "Delete a flow run notification policy by id.", "operationId": "delete_flow_run_notification_policy_flow_run_notification_policies__id__delete", "parameters": [{"description": "The flow run notification policy id", "required": true, "schema": {"type": "string", "format": "uuid", "title": "Id", "description": "The flow run notification policy id"}, "name": "id", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "responses": {"204": {"description": "Successful Response"}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}, "patch": {"tags": ["Flow Run Notification Policies"], "summary": "Update Flow Run Notification Policy", "description": "Updates an existing flow run notification policy.", "operationId": "update_flow_run_notification_policy_flow_run_notification_policies__id__patch", "parameters": [{"description": "The flow run notification policy id", "required": true, "schema": {"type": "string", "format": "uuid", "title": "Id", "description": "The flow run notification policy id"}, "name": "id", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/FlowRunNotificationPolicyUpdate"}}}, "required": true}, "responses": {"204": {"description": "Successful Response"}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/flow_run_notification_policies/filter": {"post": {"tags": ["Flow Run Notification Policies"], "summary": "Read Flow Run Notification Policies", "description": "Query for flow run notification policies.", "operationId": "read_flow_run_notification_policies_flow_run_notification_policies_filter_post", "parameters": [{"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Body_read_flow_run_notification_policies_flow_run_notification_policies_filter_post"}}}}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/FlowRunNotificationPolicy"}, "type": "array", "title": "Response Read Flow Run Notification Policies Flow Run Notification Policies Filter Post"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/deployments/": {"post": {"tags": ["Deployments"], "summary": "Create Deployment", "description": "Gracefully creates a new deployment from the provided schema. If a deployment with\nthe same name and flow_id already exists, the deployment is updated.\n\nIf the deployment has an active schedule, flow runs will be scheduled.\nWhen upserting, any scheduled runs from the existing deployment will be deleted.", "operationId": "create_deployment_deployments__post", "parameters": [{"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/DeploymentCreate"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/DeploymentResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/deployments/{id}": {"get": {"tags": ["Deployments"], "summary": "Read Deployment", "description": "Get a deployment by id.", "operationId": "read_deployment_deployments__id__get", "parameters": [{"description": "The deployment id", "required": true, "schema": {"type": "string", "format": "uuid", "title": "Id", "description": "The deployment id"}, "name": "id", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/DeploymentResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}, "delete": {"tags": ["Deployments"], "summary": "Delete Deployment", "description": "Delete a deployment by id.", "operationId": "delete_deployment_deployments__id__delete", "parameters": [{"description": "The deployment id", "required": true, "schema": {"type": "string", "format": "uuid", "title": "Id", "description": "The deployment id"}, "name": "id", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "responses": {"204": {"description": "Successful Response"}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}, "patch": {"tags": ["Deployments"], "summary": "Update Deployment", "operationId": "update_deployment_deployments__id__patch", "parameters": [{"description": "The deployment id", "required": true, "schema": {"type": "string", "format": "uuid", "title": "Id", "description": "The deployment id"}, "name": "id", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/DeploymentUpdate"}}}, "required": true}, "responses": {"204": {"description": "Successful Response"}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/deployments/name/{flow_name}/{deployment_name}": {"get": {"tags": ["Deployments"], "summary": "Read Deployment By Name", "description": "Get a deployment using the name of the flow and the deployment.", "operationId": "read_deployment_by_name_deployments_name__flow_name___deployment_name__get", "parameters": [{"description": "The name of the flow", "required": true, "schema": {"type": "string", "title": "Flow Name", "description": "The name of the flow"}, "name": "flow_name", "in": "path"}, {"description": "The name of the deployment", "required": true, "schema": {"type": "string", "title": "Deployment Name", "description": "The name of the deployment"}, "name": "deployment_name", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/DeploymentResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/deployments/filter": {"post": {"tags": ["Deployments"], "summary": "Read Deployments", "description": "Query for deployments.", "operationId": "read_deployments_deployments_filter_post", "parameters": [{"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Body_read_deployments_deployments_filter_post"}}}}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/DeploymentResponse"}, "type": "array", "title": "Response Read Deployments Deployments Filter Post"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/deployments/get_scheduled_flow_runs": {"post": {"tags": ["Deployments"], "summary": "Get Scheduled Flow Runs For Deployments", "description": "Get scheduled runs for a set of deployments. Used by a runner to poll for work.", "operationId": "get_scheduled_flow_runs_for_deployments_deployments_get_scheduled_flow_runs_post", "parameters": [{"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Body_get_scheduled_flow_runs_for_deployments_deployments_get_scheduled_flow_runs_post"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/FlowRunResponse"}, "type": "array", "title": "Response Get Scheduled Flow Runs For Deployments Deployments Get Scheduled Flow Runs Post"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/deployments/count": {"post": {"tags": ["Deployments"], "summary": "Count Deployments", "description": "Count deployments.", "operationId": "count_deployments_deployments_count_post", "parameters": [{"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Body_count_deployments_deployments_count_post"}}}}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"type": "integer", "title": "Response Count Deployments Deployments Count Post"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/deployments/{id}/schedule": {"post": {"tags": ["Deployments"], "summary": "Schedule Deployment", "description": "Schedule runs for a deployment. For backfills, provide start/end times in the past.\n\nThis function will generate the minimum number of runs that satisfy the min\nand max times, and the min and max counts. Specifically, the following order\nwill be respected.\n\n    - Runs will be generated starting on or after the `start_time`\n    - No more than `max_runs` runs will be generated\n    - No runs will be generated after `end_time` is reached\n    - At least `min_runs` runs will be generated\n    - Runs will be generated until at least `start_time + min_time` is reached", "operationId": "schedule_deployment_deployments__id__schedule_post", "parameters": [{"description": "The deployment id", "required": true, "schema": {"type": "string", "format": "uuid", "title": "Id", "description": "The deployment id"}, "name": "id", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Body_schedule_deployment_deployments__id__schedule_post"}}}}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/deployments/{id}/set_schedule_active": {"post": {"tags": ["Deployments"], "summary": "Set Schedule Active", "description": "Set a deployment schedule to active. Runs will be scheduled immediately.", "operationId": "set_schedule_active_deployments__id__set_schedule_active_post", "parameters": [{"description": "The deployment id", "required": true, "schema": {"type": "string", "format": "uuid", "title": "Id", "description": "The deployment id"}, "name": "id", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/deployments/{id}/set_schedule_inactive": {"post": {"tags": ["Deployments"], "summary": "Set Schedule Inactive", "description": "Set a deployment schedule to inactive. Any auto-scheduled runs still in a Scheduled\nstate will be deleted.", "operationId": "set_schedule_inactive_deployments__id__set_schedule_inactive_post", "parameters": [{"description": "The deployment id", "required": true, "schema": {"type": "string", "format": "uuid", "title": "Id", "description": "The deployment id"}, "name": "id", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/deployments/{id}/create_flow_run": {"post": {"tags": ["Deployments"], "summary": "Create Flow Run From Deployment", "description": "Create a flow run from a deployment.\n\nAny parameters not provided will be inferred from the deployment's parameters.\nIf tags are not provided, the deployment's tags will be used.\n\nIf no state is provided, the flow run will be created in a SCHEDULED state.", "operationId": "create_flow_run_from_deployment_deployments__id__create_flow_run_post", "parameters": [{"description": "The deployment id", "required": true, "schema": {"type": "string", "format": "uuid", "title": "Id", "description": "The deployment id"}, "name": "id", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/DeploymentFlowRunCreate"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/FlowRunResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/deployments/{id}/work_queue_check": {"get": {"tags": ["Deployments"], "summary": "Work Queue Check For Deployment", "description": "Get list of work-queues that are able to pick up the specified deployment.\n\nThis endpoint is intended to be used by the UI to provide users warnings\nabout deployments that are unable to be executed because there are no work\nqueues that will pick up their runs, based on existing filter criteria. It\nmay be deprecated in the future because there is not a strict relationship\nbetween work queues and deployments.", "operationId": "work_queue_check_for_deployment_deployments__id__work_queue_check_get", "parameters": [{"description": "The deployment id", "required": true, "schema": {"type": "string", "format": "uuid", "title": "Id", "description": "The deployment id"}, "name": "id", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/WorkQueue"}, "type": "array", "title": "Response Work Queue Check For Deployment Deployments  Id  Work Queue Check Get"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}, "deprecated": true}}, "/api/deployments/{id}/schedules": {"get": {"tags": ["Deployments"], "summary": "Read Deployment Schedules", "operationId": "read_deployment_schedules_deployments__id__schedules_get", "parameters": [{"description": "The deployment id", "required": true, "schema": {"type": "string", "format": "uuid", "title": "Id", "description": "The deployment id"}, "name": "id", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/DeploymentSchedule"}, "type": "array", "title": "Response Read Deployment Schedules Deployments  Id  Schedules Get"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}, "post": {"tags": ["Deployments"], "summary": "Create Deployment Schedules", "operationId": "create_deployment_schedules_deployments__id__schedules_post", "parameters": [{"description": "The deployment id", "required": true, "schema": {"type": "string", "format": "uuid", "title": "Id", "description": "The deployment id"}, "name": "id", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/DeploymentScheduleCreate"}, "type": "array", "title": "Schedules", "description": "The schedules to create"}}}, "required": true}, "responses": {"201": {"description": "Successful Response", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/DeploymentSchedule"}, "type": "array", "title": "Response Create Deployment Schedules Deployments  Id  Schedules Post"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/deployments/{id}/schedules/{schedule_id}": {"delete": {"tags": ["Deployments"], "summary": "Delete Deployment Schedule", "operationId": "delete_deployment_schedule_deployments__id__schedules__schedule_id__delete", "parameters": [{"description": "The deployment id", "required": true, "schema": {"type": "string", "format": "uuid", "title": "Id", "description": "The deployment id"}, "name": "id", "in": "path"}, {"description": "The schedule id", "required": true, "schema": {"type": "string", "format": "uuid", "title": "Schedule Id", "description": "The schedule id"}, "name": "schedule_id", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "responses": {"204": {"description": "Successful Response"}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}, "patch": {"tags": ["Deployments"], "summary": "Update Deployment Schedule", "operationId": "update_deployment_schedule_deployments__id__schedules__schedule_id__patch", "parameters": [{"description": "The deployment id", "required": true, "schema": {"type": "string", "format": "uuid", "title": "Id", "description": "The deployment id"}, "name": "id", "in": "path"}, {"description": "The schedule id", "required": true, "schema": {"type": "string", "format": "uuid", "title": "Schedule Id", "description": "The schedule id"}, "name": "schedule_id", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"allOf": [{"$ref": "#/components/schemas/DeploymentScheduleUpdate"}], "title": "Schedule", "description": "The updated schedule"}}}, "required": true}, "responses": {"204": {"description": "Successful Response"}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/saved_searches/": {"put": {"tags": ["SavedSearches"], "summary": "Create Saved Search", "description": "Gracefully creates a new saved search from the provided schema.\n\nIf a saved search with the same name already exists, the saved search's fields are\nreplaced.", "operationId": "create_saved_search_saved_searches__put", "parameters": [{"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/SavedSearchCreate"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/SavedSearch"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/saved_searches/{id}": {"get": {"tags": ["SavedSearches"], "summary": "Read Saved Search", "description": "Get a saved search by id.", "operationId": "read_saved_search_saved_searches__id__get", "parameters": [{"description": "The saved search id", "required": true, "schema": {"type": "string", "format": "uuid", "title": "Id", "description": "The saved search id"}, "name": "id", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/SavedSearch"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}, "delete": {"tags": ["SavedSearches"], "summary": "Delete Saved Search", "description": "Delete a saved search by id.", "operationId": "delete_saved_search_saved_searches__id__delete", "parameters": [{"description": "The saved search id", "required": true, "schema": {"type": "string", "format": "uuid", "title": "Id", "description": "The saved search id"}, "name": "id", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "responses": {"204": {"description": "Successful Response"}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/saved_searches/filter": {"post": {"tags": ["SavedSearches"], "summary": "Read Saved Searches", "description": "Query for saved searches.", "operationId": "read_saved_searches_saved_searches_filter_post", "parameters": [{"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Body_read_saved_searches_saved_searches_filter_post"}}}}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/SavedSearch"}, "type": "array", "title": "Response Read Saved Searches Saved Searches Filter Post"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/logs/": {"post": {"tags": ["Logs"], "summary": "Create Logs", "description": "Create new logs from the provided schema.", "operationId": "create_logs_logs__post", "parameters": [{"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/LogCreate"}, "type": "array", "title": "Logs"}}}, "required": true}, "responses": {"201": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/logs/filter": {"post": {"tags": ["Logs"], "summary": "Read Logs", "description": "Query for logs.", "operationId": "read_logs_logs_filter_post", "parameters": [{"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Body_read_logs_logs_filter_post"}}}}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/Log"}, "type": "array", "title": "Response Read Logs Logs Filter Post"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/concurrency_limits/": {"post": {"tags": ["Concurrency Limits"], "summary": "Create Concurrency Limit", "operationId": "create_concurrency_limit_concurrency_limits__post", "parameters": [{"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/ConcurrencyLimitCreate"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ConcurrencyLimit"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/concurrency_limits/{id}": {"get": {"tags": ["Concurrency Limits"], "summary": "Read Concurrency Limit", "description": "Get a concurrency limit by id.\n\nThe `active slots` field contains a list of TaskRun IDs currently using a\nconcurrency slot for the specified tag.", "operationId": "read_concurrency_limit_concurrency_limits__id__get", "parameters": [{"description": "The concurrency limit id", "required": true, "schema": {"type": "string", "format": "uuid", "title": "Id", "description": "The concurrency limit id"}, "name": "id", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ConcurrencyLimit"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}, "delete": {"tags": ["Concurrency Limits"], "summary": "Delete Concurrency Limit", "operationId": "delete_concurrency_limit_concurrency_limits__id__delete", "parameters": [{"description": "The concurrency limit id", "required": true, "schema": {"type": "string", "format": "uuid", "title": "Id", "description": "The concurrency limit id"}, "name": "id", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/concurrency_limits/tag/{tag}": {"get": {"tags": ["Concurrency Limits"], "summary": "Read Concurrency Limit By Tag", "description": "Get a concurrency limit by tag.\n\nThe `active slots` field contains a list of TaskRun IDs currently using a\nconcurrency slot for the specified tag.", "operationId": "read_concurrency_limit_by_tag_concurrency_limits_tag__tag__get", "parameters": [{"description": "The tag name", "required": true, "schema": {"type": "string", "title": "Tag", "description": "The tag name"}, "name": "tag", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ConcurrencyLimit"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}, "delete": {"tags": ["Concurrency Limits"], "summary": "Delete Concurrency Limit By Tag", "operationId": "delete_concurrency_limit_by_tag_concurrency_limits_tag__tag__delete", "parameters": [{"description": "The tag name", "required": true, "schema": {"type": "string", "title": "Tag", "description": "The tag name"}, "name": "tag", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/concurrency_limits/filter": {"post": {"tags": ["Concurrency Limits"], "summary": "Read Concurrency Limits", "description": "Query for concurrency limits.\n\nFor each concurrency limit the `active slots` field contains a list of TaskRun IDs\ncurrently using a concurrency slot for the specified tag.", "operationId": "read_concurrency_limits_concurrency_limits_filter_post", "parameters": [{"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Body_read_concurrency_limits_concurrency_limits_filter_post"}}}}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/ConcurrencyLimit"}, "type": "array", "title": "Response Read Concurrency Limits Concurrency Limits Filter Post"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/concurrency_limits/tag/{tag}/reset": {"post": {"tags": ["Concurrency Limits"], "summary": "Reset Concurrency Limit By Tag", "operationId": "reset_concurrency_limit_by_tag_concurrency_limits_tag__tag__reset_post", "parameters": [{"description": "The tag name", "required": true, "schema": {"type": "string", "title": "Tag", "description": "The tag name"}, "name": "tag", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Body_reset_concurrency_limit_by_tag_concurrency_limits_tag__tag__reset_post"}}}}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/v2/concurrency_limits/": {"post": {"tags": ["Concurrency Limits V2"], "summary": "Create Concurrency Limit V2", "operationId": "create_concurrency_limit_v2_v2_concurrency_limits__post", "parameters": [{"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/ConcurrencyLimitV2Create"}}}, "required": true}, "responses": {"201": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ConcurrencyLimitV2"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/v2/concurrency_limits/{id_or_name}": {"get": {"tags": ["Concurrency Limits V2"], "summary": "Read Concurrency Limit V2", "operationId": "read_concurrency_limit_v2_v2_concurrency_limits__id_or_name__get", "parameters": [{"description": "The ID or name of the concurrency limit", "required": true, "schema": {"anyOf": [{"type": "string", "format": "uuid"}, {"type": "string"}], "title": "Id Or Name", "description": "The ID or name of the concurrency limit"}, "name": "id_or_name", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/ConcurrencyLimitV2"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}, "delete": {"tags": ["Concurrency Limits V2"], "summary": "Delete Concurrency Limit V2", "operationId": "delete_concurrency_limit_v2_v2_concurrency_limits__id_or_name__delete", "parameters": [{"description": "The ID or name of the concurrency limit", "required": true, "schema": {"anyOf": [{"type": "string", "format": "uuid"}, {"type": "string"}], "title": "Id Or Name", "description": "The ID or name of the concurrency limit"}, "name": "id_or_name", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "responses": {"204": {"description": "Successful Response"}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}, "patch": {"tags": ["Concurrency Limits V2"], "summary": "Update Concurrency Limit V2", "operationId": "update_concurrency_limit_v2_v2_concurrency_limits__id_or_name__patch", "parameters": [{"description": "The ID or name of the concurrency limit", "required": true, "schema": {"anyOf": [{"type": "string", "format": "uuid"}, {"type": "string"}], "title": "Id Or Name", "description": "The ID or name of the concurrency limit"}, "name": "id_or_name", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/ConcurrencyLimitV2Update"}}}, "required": true}, "responses": {"204": {"description": "Successful Response"}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/v2/concurrency_limits/filter": {"post": {"tags": ["Concurrency Limits V2"], "summary": "Read All Concurrency Limits V2", "operationId": "read_all_concurrency_limits_v2_v2_concurrency_limits_filter_post", "parameters": [{"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Body_read_all_concurrency_limits_v2_v2_concurrency_limits_filter_post"}}}}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/ConcurrencyLimitV2"}, "type": "array", "title": "Response Read All Concurrency Limits V2 V2 Concurrency Limits Filter Post"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/v2/concurrency_limits/increment": {"post": {"tags": ["Concurrency Limits V2"], "summary": "Bulk Increment Active Slots", "operationId": "bulk_increment_active_slots_v2_concurrency_limits_increment_post", "parameters": [{"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Body_bulk_increment_active_slots_v2_concurrency_limits_increment_post"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/MinimalConcurrencyLimitResponse"}, "type": "array", "title": "Response Bulk Increment Active Slots V2 Concurrency Limits Increment Post"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/v2/concurrency_limits/decrement": {"post": {"tags": ["Concurrency Limits V2"], "summary": "Bulk Decrement Active Slots", "operationId": "bulk_decrement_active_slots_v2_concurrency_limits_decrement_post", "parameters": [{"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Body_bulk_decrement_active_slots_v2_concurrency_limits_decrement_post"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/MinimalConcurrencyLimitResponse"}, "type": "array", "title": "Response Bulk Decrement Active Slots V2 Concurrency Limits Decrement Post"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/block_types/": {"post": {"tags": ["Block types"], "summary": "Create Block Type", "description": "Create a new block type", "operationId": "create_block_type_block_types__post", "parameters": [{"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/BlockTypeCreate"}}}, "required": true}, "responses": {"201": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BlockType"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/block_types/{id}": {"get": {"tags": ["Block types"], "summary": "Read Block Type By Id", "description": "Get a block type by ID.", "operationId": "read_block_type_by_id_block_types__id__get", "parameters": [{"description": "The block type ID", "required": true, "schema": {"type": "string", "format": "uuid", "title": "Id", "description": "The block type ID"}, "name": "id", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BlockType"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}, "delete": {"tags": ["Block types"], "summary": "Delete Block Type", "operationId": "delete_block_type_block_types__id__delete", "parameters": [{"description": "The block type ID", "required": true, "schema": {"type": "string", "format": "uuid", "title": "Id", "description": "The block type ID"}, "name": "id", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "responses": {"204": {"description": "Successful Response"}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}, "patch": {"tags": ["Block types"], "summary": "Update Block Type", "description": "Update a block type.", "operationId": "update_block_type_block_types__id__patch", "parameters": [{"description": "The block type ID", "required": true, "schema": {"type": "string", "format": "uuid", "title": "Id", "description": "The block type ID"}, "name": "id", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/BlockTypeUpdate"}}}, "required": true}, "responses": {"204": {"description": "Successful Response"}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/block_types/slug/{slug}": {"get": {"tags": ["Block types"], "summary": "Read Block Type By Slug", "description": "Get a block type by name.", "operationId": "read_block_type_by_slug_block_types_slug__slug__get", "parameters": [{"description": "The block type name", "required": true, "schema": {"type": "string", "title": "Slug", "description": "The block type name"}, "name": "slug", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BlockType"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/block_types/filter": {"post": {"tags": ["Block types"], "summary": "Read Block Types", "description": "Gets all block types. Optionally limit return with limit and offset.", "operationId": "read_block_types_block_types_filter_post", "parameters": [{"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Body_read_block_types_block_types_filter_post"}}}}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/BlockType"}, "type": "array", "title": "Response Read Block Types Block Types Filter Post"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/block_types/slug/{slug}/block_documents": {"get": {"tags": ["Block types", "Block types", "Block documents"], "summary": "Read Block Documents For Block Type", "operationId": "read_block_documents_for_block_type_block_types_slug__slug__block_documents_get", "parameters": [{"description": "The block type name", "required": true, "schema": {"type": "string", "title": "Slug", "description": "The block type name"}, "name": "slug", "in": "path"}, {"description": "Whether to include sensitive values in the block document.", "required": false, "schema": {"type": "boolean", "title": "Include Secrets", "description": "Whether to include sensitive values in the block document.", "default": false}, "name": "include_secrets", "in": "query"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/BlockDocument"}, "type": "array", "title": "Response Read Block Documents For Block Type Block Types Slug  Slug  Block Documents Get"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/block_types/slug/{slug}/block_documents/name/{block_document_name}": {"get": {"tags": ["Block types", "Block types", "Block documents"], "summary": "Read Block Document By Name For Block Type", "operationId": "read_block_document_by_name_for_block_type_block_types_slug__slug__block_documents_name__block_document_name__get", "parameters": [{"description": "The block type name", "required": true, "schema": {"type": "string", "title": "Slug", "description": "The block type name"}, "name": "slug", "in": "path"}, {"description": "The block type name", "required": true, "schema": {"type": "string", "title": "Block Document Name", "description": "The block type name"}, "name": "block_document_name", "in": "path"}, {"description": "Whether to include sensitive values in the block document.", "required": false, "schema": {"type": "boolean", "title": "Include Secrets", "description": "Whether to include sensitive values in the block document.", "default": false}, "name": "include_secrets", "in": "query"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BlockDocument"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/block_types/install_system_block_types": {"post": {"tags": ["Block types"], "summary": "Install System Block Types", "operationId": "install_system_block_types_block_types_install_system_block_types_post", "parameters": [{"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/block_documents/": {"post": {"tags": ["Block documents"], "summary": "Create Block Document", "description": "Create a new block document.", "operationId": "create_block_document_block_documents__post", "parameters": [{"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/BlockDocumentCreate"}}}, "required": true}, "responses": {"201": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BlockDocument"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/block_documents/filter": {"post": {"tags": ["Block documents"], "summary": "Read Block Documents", "description": "Query for block documents.", "operationId": "read_block_documents_block_documents_filter_post", "parameters": [{"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Body_read_block_documents_block_documents_filter_post"}}}}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/BlockDocument"}, "type": "array", "title": "Response Read Block Documents Block Documents Filter Post"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/block_documents/count": {"post": {"tags": ["Block documents"], "summary": "Count Block Documents", "description": "Count block documents.", "operationId": "count_block_documents_block_documents_count_post", "parameters": [{"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Body_count_block_documents_block_documents_count_post"}}}}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"type": "integer", "title": "Response Count Block Documents Block Documents Count Post"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/block_documents/{id}": {"get": {"tags": ["Block documents"], "summary": "Read Block Document By Id", "operationId": "read_block_document_by_id_block_documents__id__get", "parameters": [{"description": "The block document id", "required": true, "schema": {"type": "string", "format": "uuid", "title": "Id", "description": "The block document id"}, "name": "id", "in": "path"}, {"description": "Whether to include sensitive values in the block document.", "required": false, "schema": {"type": "boolean", "title": "Include Secrets", "description": "Whether to include sensitive values in the block document.", "default": false}, "name": "include_secrets", "in": "query"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BlockDocument"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}, "delete": {"tags": ["Block documents"], "summary": "Delete Block Document", "operationId": "delete_block_document_block_documents__id__delete", "parameters": [{"description": "The block document id", "required": true, "schema": {"type": "string", "format": "uuid", "title": "Id", "description": "The block document id"}, "name": "id", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "responses": {"204": {"description": "Successful Response"}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}, "patch": {"tags": ["Block documents"], "summary": "Update Block Document Data", "operationId": "update_block_document_data_block_documents__id__patch", "parameters": [{"description": "The block document id", "required": true, "schema": {"type": "string", "format": "uuid", "title": "Id", "description": "The block document id"}, "name": "id", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/BlockDocumentUpdate"}}}, "required": true}, "responses": {"204": {"description": "Successful Response"}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/work_pools/": {"post": {"tags": ["Work Pools"], "summary": "Create Work Pool", "description": "Creates a new work pool. If a work pool with the same\nname already exists, an error will be raised.", "operationId": "create_work_pool_work_pools__post", "parameters": [{"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/WorkPoolCreate"}}}, "required": true}, "responses": {"201": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/WorkPoolResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/work_pools/{name}": {"get": {"tags": ["Work Pools"], "summary": "Read Work Pool", "description": "Read a work pool by name", "operationId": "read_work_pool_work_pools__name__get", "parameters": [{"description": "The work pool name", "required": true, "schema": {"type": "string", "title": "Name", "description": "The work pool name"}, "name": "name", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/WorkPoolResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}, "delete": {"tags": ["Work Pools"], "summary": "Delete Work Pool", "description": "Delete a work pool", "operationId": "delete_work_pool_work_pools__name__delete", "parameters": [{"description": "The work pool name", "required": true, "schema": {"type": "string", "title": "Name", "description": "The work pool name"}, "name": "name", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "responses": {"204": {"description": "Successful Response"}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}, "patch": {"tags": ["Work Pools"], "summary": "Update Work Pool", "description": "Update a work pool", "operationId": "update_work_pool_work_pools__name__patch", "parameters": [{"description": "The work pool name", "required": true, "schema": {"type": "string", "title": "Name", "description": "The work pool name"}, "name": "name", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/WorkPoolUpdate"}}}, "required": true}, "responses": {"204": {"description": "Successful Response"}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/work_pools/filter": {"post": {"tags": ["Work Pools"], "summary": "Read Work Pools", "description": "Read multiple work pools", "operationId": "read_work_pools_work_pools_filter_post", "parameters": [{"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Body_read_work_pools_work_pools_filter_post"}}}}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/WorkPoolResponse"}, "type": "array", "title": "Response Read Work Pools Work Pools Filter Post"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/work_pools/count": {"post": {"tags": ["Work Pools"], "summary": "Count Work Pools", "description": "Count work pools", "operationId": "count_work_pools_work_pools_count_post", "parameters": [{"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Body_count_work_pools_work_pools_count_post"}}}}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"type": "integer", "title": "Response Count Work Pools Work Pools Count Post"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/work_pools/{name}/get_scheduled_flow_runs": {"post": {"tags": ["Work Pools"], "summary": "Get Scheduled Flow Runs", "description": "Load scheduled runs for a worker", "operationId": "get_scheduled_flow_runs_work_pools__name__get_scheduled_flow_runs_post", "parameters": [{"description": "The work pool name", "required": true, "schema": {"type": "string", "title": "Name", "description": "The work pool name"}, "name": "name", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Body_get_scheduled_flow_runs_work_pools__name__get_scheduled_flow_runs_post"}}}}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/WorkerFlowRunResponse"}, "type": "array", "title": "Response Get Scheduled Flow Runs Work Pools  Name  Get Scheduled Flow Runs Post"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/work_pools/{work_pool_name}/queues": {"post": {"tags": ["Work Pools"], "summary": "Create Work Queue", "description": "Creates a new work pool queue. If a work pool queue with the same\nname already exists, an error will be raised.", "operationId": "create_work_queue_work_pools__work_pool_name__queues_post", "parameters": [{"description": "The work pool name", "required": true, "schema": {"type": "string", "title": "Work Pool Name", "description": "The work pool name"}, "name": "work_pool_name", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/WorkQueueCreate"}}}, "required": true}, "responses": {"201": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/WorkQueueResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/work_pools/{work_pool_name}/queues/{name}": {"get": {"tags": ["Work Pools"], "summary": "Read Work Queue", "description": "Read a work pool queue", "operationId": "read_work_queue_work_pools__work_pool_name__queues__name__get", "parameters": [{"description": "The work pool name", "required": true, "schema": {"type": "string", "title": "Work Pool Name", "description": "The work pool name"}, "name": "work_pool_name", "in": "path"}, {"description": "The work pool queue name", "required": true, "schema": {"type": "string", "title": "Name", "description": "The work pool queue name"}, "name": "name", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/WorkQueueResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}, "delete": {"tags": ["Work Pools"], "summary": "Delete Work Queue", "description": "Delete a work pool queue", "operationId": "delete_work_queue_work_pools__work_pool_name__queues__name__delete", "parameters": [{"description": "The work pool name", "required": true, "schema": {"type": "string", "title": "Work Pool Name", "description": "The work pool name"}, "name": "work_pool_name", "in": "path"}, {"description": "The work pool queue name", "required": true, "schema": {"type": "string", "title": "Name", "description": "The work pool queue name"}, "name": "name", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "responses": {"204": {"description": "Successful Response"}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}, "patch": {"tags": ["Work Pools"], "summary": "Update Work Queue", "description": "Update a work pool queue", "operationId": "update_work_queue_work_pools__work_pool_name__queues__name__patch", "parameters": [{"description": "The work pool name", "required": true, "schema": {"type": "string", "title": "Work Pool Name", "description": "The work pool name"}, "name": "work_pool_name", "in": "path"}, {"description": "The work pool queue name", "required": true, "schema": {"type": "string", "title": "Name", "description": "The work pool queue name"}, "name": "name", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/WorkQueueUpdate"}}}, "required": true}, "responses": {"204": {"description": "Successful Response"}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/work_pools/{work_pool_name}/queues/filter": {"post": {"tags": ["Work Pools"], "summary": "Read Work Queues", "description": "Read all work pool queues", "operationId": "read_work_queues_work_pools__work_pool_name__queues_filter_post", "parameters": [{"description": "The work pool name", "required": true, "schema": {"type": "string", "title": "Work Pool Name", "description": "The work pool name"}, "name": "work_pool_name", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Body_read_work_queues_work_pools__work_pool_name__queues_filter_post"}}}}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/WorkQueueResponse"}, "type": "array", "title": "Response Read Work Queues Work Pools  Work Pool Name  Queues Filter Post"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/work_pools/{work_pool_name}/workers/heartbeat": {"post": {"tags": ["Work Pools"], "summary": "Worker Heartbeat", "operationId": "worker_heartbeat_work_pools__work_pool_name__workers_heartbeat_post", "parameters": [{"description": "The work pool name", "required": true, "schema": {"type": "string", "title": "Work Pool Name", "description": "The work pool name"}, "name": "work_pool_name", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Body_worker_heartbeat_work_pools__work_pool_name__workers_heartbeat_post"}}}, "required": true}, "responses": {"204": {"description": "Successful Response"}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/work_pools/{work_pool_name}/workers/filter": {"post": {"tags": ["Work Pools"], "summary": "Read Workers", "description": "Read all worker processes", "operationId": "read_workers_work_pools__work_pool_name__workers_filter_post", "parameters": [{"description": "The work pool name", "required": true, "schema": {"type": "string", "title": "Work Pool Name", "description": "The work pool name"}, "name": "work_pool_name", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Body_read_workers_work_pools__work_pool_name__workers_filter_post"}}}}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/WorkerResponse"}, "type": "array", "title": "Response Read Workers Work Pools  Work Pool Name  Workers Filter Post"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/work_pools/{work_pool_name}/workers/{name}": {"delete": {"tags": ["Work Pools"], "summary": "Delete Worker", "description": "Delete a work pool's worker", "operationId": "delete_worker_work_pools__work_pool_name__workers__name__delete", "parameters": [{"description": "The work pool name", "required": true, "schema": {"type": "string", "title": "Work Pool Name", "description": "The work pool name"}, "name": "work_pool_name", "in": "path"}, {"description": "The work pool's worker name", "required": true, "schema": {"type": "string", "title": "Name", "description": "The work pool's worker name"}, "name": "name", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "responses": {"204": {"description": "Successful Response"}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/work_queues/": {"post": {"tags": ["Work Queues"], "summary": "Create Work Queue", "description": "Creates a new work queue.\n\nIf a work queue with the same name already exists, an error\nwill be raised.", "operationId": "create_work_queue_work_queues__post", "parameters": [{"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/WorkQueueCreate"}}}, "required": true}, "responses": {"201": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/WorkQueueResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/work_queues/{id}": {"get": {"tags": ["Work Queues"], "summary": "Read Work Queue", "description": "Get a work queue by id.", "operationId": "read_work_queue_work_queues__id__get", "parameters": [{"description": "The work queue id", "required": true, "schema": {"type": "string", "format": "uuid", "title": "Id", "description": "The work queue id"}, "name": "id", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/WorkQueueResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}, "delete": {"tags": ["Work Queues"], "summary": "Delete Work Queue", "description": "Delete a work queue by id.", "operationId": "delete_work_queue_work_queues__id__delete", "parameters": [{"description": "The work queue id", "required": true, "schema": {"type": "string", "format": "uuid", "title": "Id", "description": "The work queue id"}, "name": "id", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "responses": {"204": {"description": "Successful Response"}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}, "patch": {"tags": ["Work Queues"], "summary": "Update Work Queue", "description": "Updates an existing work queue.", "operationId": "update_work_queue_work_queues__id__patch", "parameters": [{"description": "The work queue id", "required": true, "schema": {"type": "string", "format": "uuid", "title": "Id", "description": "The work queue id"}, "name": "id", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/WorkQueueUpdate"}}}, "required": true}, "responses": {"204": {"description": "Successful Response"}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/work_queues/name/{name}": {"get": {"tags": ["Work Queues"], "summary": "Read Work Queue By Name", "description": "Get a work queue by id.", "operationId": "read_work_queue_by_name_work_queues_name__name__get", "parameters": [{"description": "The work queue name", "required": true, "schema": {"type": "string", "title": "Name", "description": "The work queue name"}, "name": "name", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/WorkQueueResponse"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/work_queues/{id}/get_runs": {"post": {"tags": ["Work Queues"], "summary": "Read Work Queue Runs", "description": "Get flow runs from the work queue.", "operationId": "read_work_queue_runs_work_queues__id__get_runs_post", "parameters": [{"description": "The work queue id", "required": true, "schema": {"type": "string", "format": "uuid", "title": "Id", "description": "The work queue id"}, "name": "id", "in": "path"}, {"description": "A header to indicate this request came from the Prefect UI.", "required": false, "schema": {"type": "boolean", "title": "X-Prefect-Ui", "description": "A header to indicate this request came from the Prefect UI.", "default": false}, "name": "x-prefect-ui", "in": "header"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Body_read_work_queue_runs_work_queues__id__get_runs_post"}}}}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/FlowRunResponse"}, "type": "array", "title": "Response Read Work Queue Runs Work Queues  Id  Get Runs Post"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/work_queues/filter": {"post": {"tags": ["Work Queues"], "summary": "Read Work Queues", "description": "Query for work queues.", "operationId": "read_work_queues_work_queues_filter_post", "parameters": [{"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Body_read_work_queues_work_queues_filter_post"}}}}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/WorkQueueResponse"}, "type": "array", "title": "Response Read Work Queues Work Queues Filter Post"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/work_queues/{id}/status": {"get": {"tags": ["Work Queues"], "summary": "Read Work Queue Status", "description": "Get the status of a work queue.", "operationId": "read_work_queue_status_work_queues__id__status_get", "parameters": [{"description": "The work queue id", "required": true, "schema": {"type": "string", "format": "uuid", "title": "Id", "description": "The work queue id"}, "name": "id", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/WorkQueueStatusDetail"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/artifacts/": {"post": {"tags": ["Artifacts"], "summary": "Create Artifact", "operationId": "create_artifact_artifacts__post", "parameters": [{"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/ArtifactCreate"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Artifact"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/artifacts/{id}": {"get": {"tags": ["Artifacts"], "summary": "Read Artifact", "description": "Retrieve an artifact from the database.", "operationId": "read_artifact_artifacts__id__get", "parameters": [{"description": "The ID of the artifact to retrieve.", "required": true, "schema": {"type": "string", "format": "uuid", "title": "Id", "description": "The ID of the artifact to retrieve."}, "name": "id", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Artifact"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}, "delete": {"tags": ["Artifacts"], "summary": "Delete Artifact", "description": "Delete an artifact from the database.", "operationId": "delete_artifact_artifacts__id__delete", "parameters": [{"description": "The ID of the artifact to delete.", "required": true, "schema": {"type": "string", "format": "uuid", "title": "Id", "description": "The ID of the artifact to delete."}, "name": "id", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "responses": {"204": {"description": "Successful Response"}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}, "patch": {"tags": ["Artifacts"], "summary": "Update Artifact", "description": "Update an artifact in the database.", "operationId": "update_artifact_artifacts__id__patch", "parameters": [{"description": "The ID of the artifact to update.", "required": true, "schema": {"type": "string", "format": "uuid", "title": "Id", "description": "The ID of the artifact to update."}, "name": "id", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/ArtifactUpdate"}}}, "required": true}, "responses": {"204": {"description": "Successful Response"}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/artifacts/{key}/latest": {"get": {"tags": ["Artifacts"], "summary": "Read Latest Artifact", "description": "Retrieve the latest artifact from the artifact table.", "operationId": "read_latest_artifact_artifacts__key__latest_get", "parameters": [{"description": "The key of the artifact to retrieve.", "required": true, "schema": {"type": "string", "title": "Key", "description": "The key of the artifact to retrieve."}, "name": "key", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Artifact"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/artifacts/filter": {"post": {"tags": ["Artifacts"], "summary": "Read Artifacts", "description": "Retrieve artifacts from the database.", "operationId": "read_artifacts_artifacts_filter_post", "parameters": [{"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Body_read_artifacts_artifacts_filter_post"}}}}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/Artifact"}, "type": "array", "title": "Response Read Artifacts Artifacts Filter Post"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/artifacts/latest/filter": {"post": {"tags": ["Artifacts"], "summary": "Read Latest Artifacts", "description": "Retrieve artifacts from the database.", "operationId": "read_latest_artifacts_artifacts_latest_filter_post", "parameters": [{"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Body_read_latest_artifacts_artifacts_latest_filter_post"}}}}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/ArtifactCollection"}, "type": "array", "title": "Response Read Latest Artifacts Artifacts Latest Filter Post"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/artifacts/count": {"post": {"tags": ["Artifacts"], "summary": "Count Artifacts", "description": "Count artifacts from the database.", "operationId": "count_artifacts_artifacts_count_post", "parameters": [{"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Body_count_artifacts_artifacts_count_post"}}}}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"type": "integer", "title": "Response Count Artifacts Artifacts Count Post"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/artifacts/latest/count": {"post": {"tags": ["Artifacts"], "summary": "Count Latest Artifacts", "description": "Count artifacts from the database.", "operationId": "count_latest_artifacts_artifacts_latest_count_post", "parameters": [{"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Body_count_latest_artifacts_artifacts_latest_count_post"}}}}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"type": "integer", "title": "Response Count Latest Artifacts Artifacts Latest Count Post"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/block_schemas/": {"post": {"tags": ["Block schemas"], "summary": "Create Block Schema", "operationId": "create_block_schema_block_schemas__post", "parameters": [{"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/BlockSchemaCreate"}}}, "required": true}, "responses": {"201": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BlockSchema"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/block_schemas/{id}": {"get": {"tags": ["Block schemas"], "summary": "Read Block Schema By Id", "description": "Get a block schema by id.", "operationId": "read_block_schema_by_id_block_schemas__id__get", "parameters": [{"description": "The block schema id", "required": true, "schema": {"type": "string", "format": "uuid", "title": "Id", "description": "The block schema id"}, "name": "id", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BlockSchema"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}, "delete": {"tags": ["Block schemas"], "summary": "Delete Block Schema", "description": "Delete a block schema by id.", "operationId": "delete_block_schema_block_schemas__id__delete", "parameters": [{"description": "The block schema id", "required": true, "schema": {"type": "string", "format": "uuid", "title": "Id", "description": "The block schema id"}, "name": "id", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "responses": {"204": {"description": "Successful Response"}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/block_schemas/filter": {"post": {"tags": ["Block schemas"], "summary": "Read Block Schemas", "description": "Read all block schemas, optionally filtered by type", "operationId": "read_block_schemas_block_schemas_filter_post", "parameters": [{"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Body_read_block_schemas_block_schemas_filter_post"}}}}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/BlockSchema"}, "type": "array", "title": "Response Read Block Schemas Block Schemas Filter Post"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/block_schemas/checksum/{checksum}": {"get": {"tags": ["Block schemas"], "summary": "Read Block Schema By Checksum", "operationId": "read_block_schema_by_checksum_block_schemas_checksum__checksum__get", "parameters": [{"description": "The block schema checksum", "required": true, "schema": {"type": "string", "title": "Checksum", "description": "The block schema checksum"}, "name": "checksum", "in": "path"}, {"description": "Version of block schema. If not provided the most recently created block schema with the matching checksum will be returned.", "required": false, "schema": {"type": "string", "title": "Version", "description": "Version of block schema. If not provided the most recently created block schema with the matching checksum will be returned."}, "name": "version", "in": "query"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/BlockSchema"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/block_capabilities/": {"get": {"tags": ["Block capabilities"], "summary": "Read Available Block Capabilities", "operationId": "read_available_block_capabilities_block_capabilities__get", "parameters": [{"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"items": {"type": "string"}, "type": "array", "title": "Response Read Available Block Capabilities Block Capabilities  Get"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/collections/views/{view}": {"get": {"tags": ["Collections"], "summary": "Read View Content", "description": "Reads the content of a view from the prefect-collection-registry.", "operationId": "read_view_content_collections_views__view__get", "parameters": [{"required": true, "schema": {"type": "string", "title": "View"}, "name": "view", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"type": "object", "title": "Response Read View Content Collections Views  View  Get"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/variables/": {"post": {"tags": ["Variables"], "summary": "Create Variable", "operationId": "create_variable_variables__post", "parameters": [{"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/VariableCreate"}}}, "required": true}, "responses": {"201": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Variable"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/variables/{id}": {"get": {"tags": ["Variables"], "summary": "Read Variable", "operationId": "read_variable_variables__id__get", "parameters": [{"required": true, "schema": {"type": "string", "format": "uuid", "title": "Id"}, "name": "id", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Variable"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}, "delete": {"tags": ["Variables"], "summary": "Delete Variable", "operationId": "delete_variable_variables__id__delete", "parameters": [{"required": true, "schema": {"type": "string", "format": "uuid", "title": "Id"}, "name": "id", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "responses": {"204": {"description": "Successful Response"}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}, "patch": {"tags": ["Variables"], "summary": "Update Variable", "operationId": "update_variable_variables__id__patch", "parameters": [{"required": true, "schema": {"type": "string", "format": "uuid", "title": "Id"}, "name": "id", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/VariableUpdate"}}}, "required": true}, "responses": {"204": {"description": "Successful Response"}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/variables/name/{name}": {"get": {"tags": ["Variables"], "summary": "Read Variable By Name", "operationId": "read_variable_by_name_variables_name__name__get", "parameters": [{"required": true, "schema": {"type": "string", "title": "Name"}, "name": "name", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Variable"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}, "delete": {"tags": ["Variables"], "summary": "Delete Variable By Name", "operationId": "delete_variable_by_name_variables_name__name__delete", "parameters": [{"required": true, "schema": {"type": "string", "title": "Name"}, "name": "name", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "responses": {"204": {"description": "Successful Response"}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}, "patch": {"tags": ["Variables"], "summary": "Update Variable By Name", "operationId": "update_variable_by_name_variables_name__name__patch", "parameters": [{"required": true, "schema": {"type": "string", "title": "Name"}, "name": "name", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/VariableUpdate"}}}, "required": true}, "responses": {"204": {"description": "Successful Response"}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/variables/filter": {"post": {"tags": ["Variables"], "summary": "Read Variables", "operationId": "read_variables_variables_filter_post", "parameters": [{"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Body_read_variables_variables_filter_post"}}}}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/Variable"}, "type": "array", "title": "Response Read Variables Variables Filter Post"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/variables/count": {"post": {"tags": ["Variables"], "summary": "Count Variables", "operationId": "count_variables_variables_count_post", "parameters": [{"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Body_count_variables_variables_count_post"}}}}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"type": "integer", "title": "Response Count Variables Variables Count Post"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/csrf-token": {"get": {"summary": "Create Csrf Token", "description": "Create or update a CSRF token for a client", "operationId": "create_csrf_token_csrf_token_get", "parameters": [{"description": "The client to create a CSRF token for", "required": true, "schema": {"type": "string", "title": "Client", "description": "The client to create a CSRF token for"}, "name": "client", "in": "query"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CsrfToken"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/events": {"post": {"tags": ["Events"], "summary": "Create Events", "description": "Record a batch of Events", "operationId": "create_events_events_post", "parameters": [{"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/Event"}, "type": "array", "title": "Events"}}}, "required": true}, "responses": {"204": {"description": "Successful Response"}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/automations/": {"post": {"tags": ["Automations"], "summary": "Create Automation", "operationId": "create_automation_automations__post", "parameters": [{"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/AutomationCreate"}}}, "required": true}, "responses": {"201": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Automation"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/automations/{id}": {"get": {"tags": ["Automations"], "summary": "Read Automation", "operationId": "read_automation_automations__id__get", "parameters": [{"required": true, "schema": {"type": "string", "format": "uuid", "title": "Id"}, "name": "id", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Automation"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}, "put": {"tags": ["Automations"], "summary": "Update Automation", "operationId": "update_automation_automations__id__put", "parameters": [{"required": true, "schema": {"type": "string", "format": "uuid", "title": "Id"}, "name": "id", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/AutomationUpdate"}}}, "required": true}, "responses": {"204": {"description": "Successful Response"}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}, "delete": {"tags": ["Automations"], "summary": "Delete Automation", "operationId": "delete_automation_automations__id__delete", "parameters": [{"required": true, "schema": {"type": "string", "format": "uuid", "title": "Id"}, "name": "id", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "responses": {"204": {"description": "Successful Response"}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}, "patch": {"tags": ["Automations"], "summary": "Patch Automation", "operationId": "patch_automation_automations__id__patch", "parameters": [{"required": true, "schema": {"type": "string", "format": "uuid", "title": "Id"}, "name": "id", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/AutomationPartialUpdate"}}}, "required": true}, "responses": {"204": {"description": "Successful Response"}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/automations/filter": {"post": {"tags": ["Automations"], "summary": "Read Automations", "operationId": "read_automations_automations_filter_post", "parameters": [{"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Body_read_automations_automations_filter_post"}}}}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/Automation"}, "type": "array", "title": "Response Read Automations Automations Filter Post"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/automations/count": {"post": {"tags": ["Automations"], "summary": "Count Automations", "operationId": "count_automations_automations_count_post", "parameters": [{"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"type": "integer", "title": "Response Count Automations Automations Count Post"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/automations/related-to/{resource_id}": {"get": {"tags": ["Automations"], "summary": "Read Automations Related To Resource", "operationId": "read_automations_related_to_resource_automations_related_to__resource_id__get", "parameters": [{"required": true, "schema": {"type": "string", "title": "Resource Id"}, "name": "resource_id", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/Automation"}, "type": "array", "title": "Response Read Automations Related To Resource Automations Related To  Resource Id  Get"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/automations/owned-by/{resource_id}": {"delete": {"tags": ["Automations"], "summary": "Delete Automations Owned By Resource", "operationId": "delete_automations_owned_by_resource_automations_owned_by__resource_id__delete", "parameters": [{"required": true, "schema": {"type": "string", "title": "Resource Id"}, "name": "resource_id", "in": "path"}, {"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "responses": {"202": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/templates/validate": {"post": {"tags": ["Automations"], "summary": "Validate Template", "operationId": "validate_template_templates_validate_post", "parameters": [{"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"type": "string", "title": "Template", "default": ""}}}}, "responses": {"200": {"description": "Successful Response"}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/ui/flow_runs/history": {"post": {"tags": ["Flow Runs", "UI"], "summary": "Read Flow Run History", "operationId": "read_flow_run_history_ui_flow_runs_history_post", "parameters": [{"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Body_read_flow_run_history_ui_flow_runs_history_post"}}}}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/SimpleFlowRun"}, "type": "array", "title": "Response Read Flow Run History Ui Flow Runs History Post"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/ui/schemas/validate": {"post": {"tags": ["UI", "Schemas"], "summary": "Validate Obj", "operationId": "validate_obj_ui_schemas_validate_post", "parameters": [{"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Body_validate_obj_ui_schemas_validate_post"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/ui/task_runs/dashboard/counts": {"post": {"tags": ["Task Runs", "UI"], "summary": "Read Dashboard Task Run Counts", "operationId": "read_dashboard_task_run_counts_ui_task_runs_dashboard_counts_post", "parameters": [{"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Body_read_dashboard_task_run_counts_ui_task_runs_dashboard_counts_post"}}}, "required": true}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"items": {"$ref": "#/components/schemas/TaskRunCount"}, "type": "array", "title": "Response Read Dashboard Task Run Counts Ui Task Runs Dashboard Counts Post"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/ui/task_runs/count": {"post": {"tags": ["Task Runs", "UI"], "summary": "Read Task Run Counts By State", "operationId": "read_task_run_counts_by_state_ui_task_runs_count_post", "parameters": [{"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Body_read_task_run_counts_by_state_ui_task_runs_count_post"}}}}, "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/CountByState"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/admin/settings": {"get": {"tags": ["Admin"], "summary": "Read Settings", "description": "Get the current Prefect REST API settings.\n\nSecret setting values will be obfuscated.", "operationId": "read_settings_admin_settings_get", "parameters": [{"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/Settings"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/admin/version": {"get": {"tags": ["Admin"], "summary": "Read Version", "description": "Returns the Prefect version number", "operationId": "read_version_admin_version_get", "parameters": [{"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {"type": "string", "title": "Response Read Version Admin Version Get"}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/admin/database/clear": {"post": {"tags": ["Admin"], "summary": "Clear Database", "description": "Clear all database tables without dropping them.", "operationId": "clear_database_admin_database_clear_post", "parameters": [{"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Body_clear_database_admin_database_clear_post"}}}}, "responses": {"204": {"description": "Successful Response"}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/admin/database/drop": {"post": {"tags": ["Admin"], "summary": "Drop Database", "description": "Drop all database objects.", "operationId": "drop_database_admin_database_drop_post", "parameters": [{"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Body_drop_database_admin_database_drop_post"}}}}, "responses": {"204": {"description": "Successful Response"}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/admin/database/create": {"post": {"tags": ["Admin"], "summary": "Create Database", "description": "Create all database objects.", "operationId": "create_database_admin_database_create_post", "parameters": [{"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "requestBody": {"content": {"application/json": {"schema": {"$ref": "#/components/schemas/Body_create_database_admin_database_create_post"}}}}, "responses": {"204": {"description": "Successful Response"}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/hello": {"get": {"tags": ["Root"], "summary": "Hello", "description": "Say hello!", "operationId": "hello_hello_get", "parameters": [{"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}, "/api/ready": {"get": {"tags": ["Root"], "summary": "Perform Readiness Check", "operationId": "perform_readiness_check_ready_get", "parameters": [{"required": false, "schema": {"type": "string", "title": "X-Prefect-Api-Version"}, "name": "x-prefect-api-version", "in": "header"}], "responses": {"200": {"description": "Successful Response", "content": {"application/json": {"schema": {}}}}, "422": {"description": "Validation Error", "content": {"application/json": {"schema": {"$ref": "#/components/schemas/HTTPValidationError"}}}}}}}}, "components": {"schemas": {"Artifact": {"properties": {"id": {"type": "string", "format": "uuid", "title": "Id"}, "created": {"type": "string", "format": "date-time", "title": "Created"}, "updated": {"type": "string", "format": "date-time", "title": "Updated"}, "key": {"type": "string", "title": "Key", "description": "An optional unique reference key for this artifact."}, "type": {"type": "string", "title": "Type", "description": "An identifier that describes the shape of the data field. e.g. 'result', 'table', 'markdown'"}, "description": {"type": "string", "title": "Description", "description": "A markdown-enabled description of the artifact."}, "data": {"anyOf": [{"type": "object"}, {}], "title": "Data", "description": "Data associated with the artifact, e.g. a result.; structure depends on the artifact type."}, "metadata_": {"additionalProperties": {"type": "string"}, "type": "object", "title": "Metadata ", "description": "User-defined artifact metadata. Content must be string key and value pairs."}, "flow_run_id": {"type": "string", "format": "uuid", "title": "Flow Run Id", "description": "The flow run associated with the artifact."}, "task_run_id": {"type": "string", "format": "uuid", "title": "Task Run Id", "description": "The task run associated with the artifact."}}, "type": "object", "title": "Artifact", "description": "A PrefectBaseModel with an auto-generated UUID ID value and created /\nupdated timestamps, intended for compatibility with our standard ORM models.\n\nThe ID, created, and updated fields are reset on copy() and not included in\nequality comparisons."}, "ArtifactCollection": {"properties": {"id": {"type": "string", "format": "uuid", "title": "Id"}, "created": {"type": "string", "format": "date-time", "title": "Created"}, "updated": {"type": "string", "format": "date-time", "title": "Updated"}, "key": {"type": "string", "title": "Key", "description": "An optional unique reference key for this artifact."}, "latest_id": {"type": "string", "format": "uuid", "title": "Latest Id", "description": "The latest artifact ID associated with the key."}, "type": {"type": "string", "title": "Type", "description": "An identifier that describes the shape of the data field. e.g. 'result', 'table', 'markdown'"}, "description": {"type": "string", "title": "Description", "description": "A markdown-enabled description of the artifact."}, "data": {"anyOf": [{"type": "object"}, {}], "title": "Data", "description": "Data associated with the artifact, e.g. a result.; structure depends on the artifact type."}, "metadata_": {"additionalProperties": {"type": "string"}, "type": "object", "title": "Metadata ", "description": "User-defined artifact metadata. Content must be string key and value pairs."}, "flow_run_id": {"type": "string", "format": "uuid", "title": "Flow Run Id", "description": "The flow run associated with the artifact."}, "task_run_id": {"type": "string", "format": "uuid", "title": "Task Run Id", "description": "The task run associated with the artifact."}}, "type": "object", "required": ["key", "latest_id"], "title": "ArtifactCollection", "description": "A PrefectBaseModel with an auto-generated UUID ID value and created /\nupdated timestamps, intended for compatibility with our standard ORM models.\n\nThe ID, created, and updated fields are reset on copy() and not included in\nequality comparisons."}, "ArtifactCollectionFilter": {"properties": {"operator": {"allOf": [{"$ref": "#/components/schemas/Operator"}], "description": "Operator for combining filter criteria. Defaults to 'and_'.", "default": "and_"}, "latest_id": {"allOf": [{"$ref": "#/components/schemas/ArtifactCollectionFilterLatestId"}], "title": "Latest Id", "description": "Filter criteria for `Artifact.id`"}, "key": {"allOf": [{"$ref": "#/components/schemas/ArtifactCollectionFilterKey"}], "title": "Key", "description": "Filter criteria for `Artifact.key`"}, "flow_run_id": {"allOf": [{"$ref": "#/components/schemas/ArtifactCollectionFilterFlowRunId"}], "title": "Flow Run Id", "description": "Filter criteria for `Artifact.flow_run_id`"}, "task_run_id": {"allOf": [{"$ref": "#/components/schemas/ArtifactCollectionFilterTaskRunId"}], "title": "Task Run Id", "description": "Filter criteria for `Artifact.task_run_id`"}, "type": {"allOf": [{"$ref": "#/components/schemas/ArtifactCollectionFilterType"}], "title": "Type", "description": "Filter criteria for `Artifact.type`"}}, "additionalProperties": false, "type": "object", "title": "ArtifactCollectionFilter", "description": "Filter artifact collections. Only artifact collections matching all criteria will be returned"}, "ArtifactCollectionFilterFlowRunId": {"properties": {"any_": {"items": {"type": "string", "format": "uuid"}, "type": "array", "title": "Any ", "description": "A list of flow run IDs to include"}}, "additionalProperties": false, "type": "object", "title": "ArtifactCollectionFilterFlowRunId", "description": "Filter by `ArtifactCollection.flow_run_id`."}, "ArtifactCollectionFilterKey": {"properties": {"any_": {"items": {"type": "string"}, "type": "array", "title": "Any ", "description": "A list of artifact keys to include"}, "like_": {"type": "string", "title": "Like ", "description": "A string to match artifact keys against. This can include SQL wildcard characters like `%` and `_`.", "examples": ["my-artifact-%"]}, "exists_": {"type": "boolean", "title": "Exists ", "description": "If `true`, only include artifacts with a non-null key. If `false`, only include artifacts with a null key. Should return all rows in the ArtifactCollection table if specified."}}, "additionalProperties": false, "type": "object", "title": "ArtifactCollectionFilterKey", "description": "Filter by `ArtifactCollection.key`."}, "ArtifactCollectionFilterLatestId": {"properties": {"any_": {"items": {"type": "string", "format": "uuid"}, "type": "array", "title": "Any ", "description": "A list of artifact ids to include"}}, "additionalProperties": false, "type": "object", "title": "ArtifactCollectionFilterLatestId", "description": "Filter by `ArtifactCollection.latest_id`."}, "ArtifactCollectionFilterTaskRunId": {"properties": {"any_": {"items": {"type": "string", "format": "uuid"}, "type": "array", "title": "Any ", "description": "A list of task run IDs to include"}}, "additionalProperties": false, "type": "object", "title": "ArtifactCollectionFilterTaskRunId", "description": "Filter by `ArtifactCollection.task_run_id`."}, "ArtifactCollectionFilterType": {"properties": {"any_": {"items": {"type": "string"}, "type": "array", "title": "Any ", "description": "A list of artifact types to include"}, "not_any_": {"items": {"type": "string"}, "type": "array", "title": "Not Any ", "description": "A list of artifact types to exclude"}}, "additionalProperties": false, "type": "object", "title": "ArtifactCollectionFilterType", "description": "Filter by `ArtifactCollection.type`."}, "ArtifactCollectionSort": {"type": "string", "enum": ["CREATED_DESC", "UPDATED_DESC", "ID_DESC", "KEY_DESC", "KEY_ASC"], "title": "ArtifactCollectionSort", "description": "Defines artifact collection sorting options."}, "ArtifactCreate": {"properties": {"key": {"type": "string", "title": "Key", "description": "An optional unique reference key for this artifact."}, "type": {"type": "string", "title": "Type", "description": "An identifier that describes the shape of the data field. e.g. 'result', 'table', 'markdown'"}, "description": {"type": "string", "title": "Description", "description": "A markdown-enabled description of the artifact."}, "data": {"anyOf": [{"type": "object"}, {}], "title": "Data", "description": "Data associated with the artifact, e.g. a result.; structure depends on the artifact type."}, "metadata_": {"additionalProperties": {"type": "string"}, "type": "object", "title": "Metadata ", "description": "User-defined artifact metadata. Content must be string key and value pairs."}, "flow_run_id": {"type": "string", "format": "uuid", "title": "Flow Run Id", "description": "The flow run associated with the artifact."}, "task_run_id": {"type": "string", "format": "uuid", "title": "Task Run Id", "description": "The task run associated with the artifact."}}, "additionalProperties": false, "type": "object", "title": "ArtifactCreate", "description": "Data used by the Prefect REST API to create an artifact."}, "ArtifactFilter": {"properties": {"operator": {"allOf": [{"$ref": "#/components/schemas/Operator"}], "description": "Operator for combining filter criteria. Defaults to 'and_'.", "default": "and_"}, "id": {"allOf": [{"$ref": "#/components/schemas/ArtifactFilterId"}], "title": "Id", "description": "Filter criteria for `Artifact.id`"}, "key": {"allOf": [{"$ref": "#/components/schemas/ArtifactFilterKey"}], "title": "Key", "description": "Filter criteria for `Artifact.key`"}, "flow_run_id": {"allOf": [{"$ref": "#/components/schemas/ArtifactFilterFlowRunId"}], "title": "Flow Run Id", "description": "Filter criteria for `Artifact.flow_run_id`"}, "task_run_id": {"allOf": [{"$ref": "#/components/schemas/ArtifactFilterTaskRunId"}], "title": "Task Run Id", "description": "Filter criteria for `Artifact.task_run_id`"}, "type": {"allOf": [{"$ref": "#/components/schemas/ArtifactFilterType"}], "title": "Type", "description": "Filter criteria for `Artifact.type`"}}, "additionalProperties": false, "type": "object", "title": "ArtifactFilter", "description": "Filter artifacts. Only artifacts matching all criteria will be returned"}, "ArtifactFilterFlowRunId": {"properties": {"any_": {"items": {"type": "string", "format": "uuid"}, "type": "array", "title": "Any ", "description": "A list of flow run IDs to include"}}, "additionalProperties": false, "type": "object", "title": "ArtifactFilterFlowRunId", "description": "Filter by `Artifact.flow_run_id`."}, "ArtifactFilterId": {"properties": {"any_": {"items": {"type": "string", "format": "uuid"}, "type": "array", "title": "Any ", "description": "A list of artifact ids to include"}}, "additionalProperties": false, "type": "object", "title": "ArtifactFilterId", "description": "Filter by `Artifact.id`."}, "ArtifactFilterKey": {"properties": {"any_": {"items": {"type": "string"}, "type": "array", "title": "Any ", "description": "A list of artifact keys to include"}, "like_": {"type": "string", "title": "Like ", "description": "A string to match artifact keys against. This can include SQL wildcard characters like `%` and `_`.", "examples": ["my-artifact-%"]}, "exists_": {"type": "boolean", "title": "Exists ", "description": "If `true`, only include artifacts with a non-null key. If `false`, only include artifacts with a null key."}}, "additionalProperties": false, "type": "object", "title": "ArtifactFilterKey", "description": "Filter by `Artifact.key`."}, "ArtifactFilterTaskRunId": {"properties": {"any_": {"items": {"type": "string", "format": "uuid"}, "type": "array", "title": "Any ", "description": "A list of task run IDs to include"}}, "additionalProperties": false, "type": "object", "title": "ArtifactFilterTaskRunId", "description": "Filter by `Artifact.task_run_id`."}, "ArtifactFilterType": {"properties": {"any_": {"items": {"type": "string"}, "type": "array", "title": "Any ", "description": "A list of artifact types to include"}, "not_any_": {"items": {"type": "string"}, "type": "array", "title": "Not Any ", "description": "A list of artifact types to exclude"}}, "additionalProperties": false, "type": "object", "title": "ArtifactFilterType", "description": "Filter by `Artifact.type`."}, "ArtifactSort": {"type": "string", "enum": ["CREATED_DESC", "UPDATED_DESC", "ID_DESC", "KEY_DESC", "KEY_ASC"], "title": "ArtifactSort", "description": "Defines artifact sorting options."}, "ArtifactUpdate": {"properties": {"data": {"anyOf": [{"type": "object"}, {}], "title": "Data"}, "description": {"type": "string", "title": "Description"}, "metadata_": {"additionalProperties": {"type": "string"}, "type": "object", "title": "Metadata "}}, "additionalProperties": false, "type": "object", "title": "ArtifactUpdate", "description": "Data used by the Prefect REST API to update an artifact."}, "Automation": {"properties": {"name": {"type": "string", "title": "Name", "description": "The name of this automation"}, "description": {"type": "string", "title": "Description", "description": "A longer description of this automation", "default": ""}, "enabled": {"type": "boolean", "title": "Enabled", "description": "Whether this automation will be evaluated", "default": true}, "trigger": {"anyOf": [{"$ref": "#/components/schemas/EventTrigger"}, {"$ref": "#/components/schemas/CompoundTrigger"}, {"$ref": "#/components/schemas/SequenceTrigger"}], "title": "Trigger", "description": "The criteria for which events this Automation covers and how it will respond to the presence or absence of those events"}, "actions": {"items": {"anyOf": [{"$ref": "#/components/schemas/DoNothing"}, {"$ref": "#/components/schemas/RunDeployment"}, {"$ref": "#/components/schemas/PauseDeployment"}, {"$ref": "#/components/schemas/ResumeDeployment"}, {"$ref": "#/components/schemas/CancelFlowRun"}, {"$ref": "#/components/schemas/ChangeFlowRunState"}, {"$ref": "#/components/schemas/PauseWorkQueue"}, {"$ref": "#/components/schemas/ResumeWorkQueue"}, {"$ref": "#/components/schemas/SendNotification"}, {"$ref": "#/components/schemas/CallWebhook"}, {"$ref": "#/components/schemas/PauseAutomation"}, {"$ref": "#/components/schemas/ResumeAutomation"}, {"$ref": "#/components/schemas/SuspendFlowRun"}, {"$ref": "#/components/schemas/PauseWorkPool"}, {"$ref": "#/components/schemas/ResumeWorkPool"}]}, "type": "array", "title": "Actions", "description": "The actions to perform when this Automation triggers"}, "actions_on_trigger": {"items": {"anyOf": [{"$ref": "#/components/schemas/DoNothing"}, {"$ref": "#/components/schemas/RunDeployment"}, {"$ref": "#/components/schemas/PauseDeployment"}, {"$ref": "#/components/schemas/ResumeDeployment"}, {"$ref": "#/components/schemas/CancelFlowRun"}, {"$ref": "#/components/schemas/ChangeFlowRunState"}, {"$ref": "#/components/schemas/PauseWorkQueue"}, {"$ref": "#/components/schemas/ResumeWorkQueue"}, {"$ref": "#/components/schemas/SendNotification"}, {"$ref": "#/components/schemas/CallWebhook"}, {"$ref": "#/components/schemas/PauseAutomation"}, {"$ref": "#/components/schemas/ResumeAutomation"}, {"$ref": "#/components/schemas/SuspendFlowRun"}, {"$ref": "#/components/schemas/PauseWorkPool"}, {"$ref": "#/components/schemas/ResumeWorkPool"}]}, "type": "array", "title": "Actions On Trigger", "description": "The actions to perform when an Automation goes into a triggered state"}, "actions_on_resolve": {"items": {"anyOf": [{"$ref": "#/components/schemas/DoNothing"}, {"$ref": "#/components/schemas/RunDeployment"}, {"$ref": "#/components/schemas/PauseDeployment"}, {"$ref": "#/components/schemas/ResumeDeployment"}, {"$ref": "#/components/schemas/CancelFlowRun"}, {"$ref": "#/components/schemas/ChangeFlowRunState"}, {"$ref": "#/components/schemas/PauseWorkQueue"}, {"$ref": "#/components/schemas/ResumeWorkQueue"}, {"$ref": "#/components/schemas/SendNotification"}, {"$ref": "#/components/schemas/CallWebhook"}, {"$ref": "#/components/schemas/PauseAutomation"}, {"$ref": "#/components/schemas/ResumeAutomation"}, {"$ref": "#/components/schemas/SuspendFlowRun"}, {"$ref": "#/components/schemas/PauseWorkPool"}, {"$ref": "#/components/schemas/ResumeWorkPool"}]}, "type": "array", "title": "Actions On Resolve", "description": "The actions to perform when an Automation goes into a resolving state"}, "id": {"type": "string", "format": "uuid", "title": "Id"}, "created": {"type": "string", "format": "date-time", "title": "Created"}, "updated": {"type": "string", "format": "date-time", "title": "Updated"}}, "type": "object", "required": ["name", "trigger", "actions"], "title": "Automation", "description": "A PrefectBaseModel with an auto-generated UUID ID value and created /\nupdated timestamps, intended for compatibility with our standard ORM models.\n\nThe ID, created, and updated fields are reset on copy() and not included in\nequality comparisons."}, "AutomationCreate": {"properties": {"name": {"type": "string", "title": "Name", "description": "The name of this automation"}, "description": {"type": "string", "title": "Description", "description": "A longer description of this automation", "default": ""}, "enabled": {"type": "boolean", "title": "Enabled", "description": "Whether this automation will be evaluated", "default": true}, "trigger": {"anyOf": [{"$ref": "#/components/schemas/EventTrigger"}, {"$ref": "#/components/schemas/CompoundTrigger"}, {"$ref": "#/components/schemas/SequenceTrigger"}], "title": "Trigger", "description": "The criteria for which events this Automation covers and how it will respond to the presence or absence of those events"}, "actions": {"items": {"anyOf": [{"$ref": "#/components/schemas/DoNothing"}, {"$ref": "#/components/schemas/RunDeployment"}, {"$ref": "#/components/schemas/PauseDeployment"}, {"$ref": "#/components/schemas/ResumeDeployment"}, {"$ref": "#/components/schemas/CancelFlowRun"}, {"$ref": "#/components/schemas/ChangeFlowRunState"}, {"$ref": "#/components/schemas/PauseWorkQueue"}, {"$ref": "#/components/schemas/ResumeWorkQueue"}, {"$ref": "#/components/schemas/SendNotification"}, {"$ref": "#/components/schemas/CallWebhook"}, {"$ref": "#/components/schemas/PauseAutomation"}, {"$ref": "#/components/schemas/ResumeAutomation"}, {"$ref": "#/components/schemas/SuspendFlowRun"}, {"$ref": "#/components/schemas/PauseWorkPool"}, {"$ref": "#/components/schemas/ResumeWorkPool"}]}, "type": "array", "title": "Actions", "description": "The actions to perform when this Automation triggers"}, "actions_on_trigger": {"items": {"anyOf": [{"$ref": "#/components/schemas/DoNothing"}, {"$ref": "#/components/schemas/RunDeployment"}, {"$ref": "#/components/schemas/PauseDeployment"}, {"$ref": "#/components/schemas/ResumeDeployment"}, {"$ref": "#/components/schemas/CancelFlowRun"}, {"$ref": "#/components/schemas/ChangeFlowRunState"}, {"$ref": "#/components/schemas/PauseWorkQueue"}, {"$ref": "#/components/schemas/ResumeWorkQueue"}, {"$ref": "#/components/schemas/SendNotification"}, {"$ref": "#/components/schemas/CallWebhook"}, {"$ref": "#/components/schemas/PauseAutomation"}, {"$ref": "#/components/schemas/ResumeAutomation"}, {"$ref": "#/components/schemas/SuspendFlowRun"}, {"$ref": "#/components/schemas/PauseWorkPool"}, {"$ref": "#/components/schemas/ResumeWorkPool"}]}, "type": "array", "title": "Actions On Trigger", "description": "The actions to perform when an Automation goes into a triggered state"}, "actions_on_resolve": {"items": {"anyOf": [{"$ref": "#/components/schemas/DoNothing"}, {"$ref": "#/components/schemas/RunDeployment"}, {"$ref": "#/components/schemas/PauseDeployment"}, {"$ref": "#/components/schemas/ResumeDeployment"}, {"$ref": "#/components/schemas/CancelFlowRun"}, {"$ref": "#/components/schemas/ChangeFlowRunState"}, {"$ref": "#/components/schemas/PauseWorkQueue"}, {"$ref": "#/components/schemas/ResumeWorkQueue"}, {"$ref": "#/components/schemas/SendNotification"}, {"$ref": "#/components/schemas/CallWebhook"}, {"$ref": "#/components/schemas/PauseAutomation"}, {"$ref": "#/components/schemas/ResumeAutomation"}, {"$ref": "#/components/schemas/SuspendFlowRun"}, {"$ref": "#/components/schemas/PauseWorkPool"}, {"$ref": "#/components/schemas/ResumeWorkPool"}]}, "type": "array", "title": "Actions On Resolve", "description": "The actions to perform when an Automation goes into a resolving state"}, "owner_resource": {"type": "string", "title": "Owner Resource", "description": "The resource to which this automation belongs"}}, "additionalProperties": false, "type": "object", "required": ["name", "trigger", "actions"], "title": "AutomationCreate", "description": "Defines an action a user wants to take when a certain number of events\ndo or don't happen to the matching resources"}, "AutomationPartialUpdate": {"properties": {"enabled": {"type": "boolean", "title": "Enabled", "description": "Whether this automation will be evaluated", "default": true}}, "additionalProperties": false, "type": "object", "title": "AutomationPartialUpdate", "description": "A base pydantic.BaseModel for all Prefect schemas and pydantic models.\n\nAs the basis for most Prefect schemas, this base model usually ignores extra\nfields that are passed to it at instantiation. Because adding new fields to\nAPI payloads is not considered a breaking change, this ensures that any\nPrefect client loading data from a server running a possibly-newer version\nof Prefect will be able to process those new fields gracefully. However,\nwhen PREFECT_TEST_MODE is on, extra fields are forbidden in order to catch\nsubtle unintentional testing errors."}, "AutomationSort": {"type": "string", "enum": ["CREATED_DESC", "UPDATED_DESC", "NAME_ASC", "NAME_DESC"], "title": "AutomationSort", "description": "Defines automations sorting options."}, "AutomationUpdate": {"properties": {"name": {"type": "string", "title": "Name", "description": "The name of this automation"}, "description": {"type": "string", "title": "Description", "description": "A longer description of this automation", "default": ""}, "enabled": {"type": "boolean", "title": "Enabled", "description": "Whether this automation will be evaluated", "default": true}, "trigger": {"anyOf": [{"$ref": "#/components/schemas/EventTrigger"}, {"$ref": "#/components/schemas/CompoundTrigger"}, {"$ref": "#/components/schemas/SequenceTrigger"}], "title": "Trigger", "description": "The criteria for which events this Automation covers and how it will respond to the presence or absence of those events"}, "actions": {"items": {"anyOf": [{"$ref": "#/components/schemas/DoNothing"}, {"$ref": "#/components/schemas/RunDeployment"}, {"$ref": "#/components/schemas/PauseDeployment"}, {"$ref": "#/components/schemas/ResumeDeployment"}, {"$ref": "#/components/schemas/CancelFlowRun"}, {"$ref": "#/components/schemas/ChangeFlowRunState"}, {"$ref": "#/components/schemas/PauseWorkQueue"}, {"$ref": "#/components/schemas/ResumeWorkQueue"}, {"$ref": "#/components/schemas/SendNotification"}, {"$ref": "#/components/schemas/CallWebhook"}, {"$ref": "#/components/schemas/PauseAutomation"}, {"$ref": "#/components/schemas/ResumeAutomation"}, {"$ref": "#/components/schemas/SuspendFlowRun"}, {"$ref": "#/components/schemas/PauseWorkPool"}, {"$ref": "#/components/schemas/ResumeWorkPool"}]}, "type": "array", "title": "Actions", "description": "The actions to perform when this Automation triggers"}, "actions_on_trigger": {"items": {"anyOf": [{"$ref": "#/components/schemas/DoNothing"}, {"$ref": "#/components/schemas/RunDeployment"}, {"$ref": "#/components/schemas/PauseDeployment"}, {"$ref": "#/components/schemas/ResumeDeployment"}, {"$ref": "#/components/schemas/CancelFlowRun"}, {"$ref": "#/components/schemas/ChangeFlowRunState"}, {"$ref": "#/components/schemas/PauseWorkQueue"}, {"$ref": "#/components/schemas/ResumeWorkQueue"}, {"$ref": "#/components/schemas/SendNotification"}, {"$ref": "#/components/schemas/CallWebhook"}, {"$ref": "#/components/schemas/PauseAutomation"}, {"$ref": "#/components/schemas/ResumeAutomation"}, {"$ref": "#/components/schemas/SuspendFlowRun"}, {"$ref": "#/components/schemas/PauseWorkPool"}, {"$ref": "#/components/schemas/ResumeWorkPool"}]}, "type": "array", "title": "Actions On Trigger", "description": "The actions to perform when an Automation goes into a triggered state"}, "actions_on_resolve": {"items": {"anyOf": [{"$ref": "#/components/schemas/DoNothing"}, {"$ref": "#/components/schemas/RunDeployment"}, {"$ref": "#/components/schemas/PauseDeployment"}, {"$ref": "#/components/schemas/ResumeDeployment"}, {"$ref": "#/components/schemas/CancelFlowRun"}, {"$ref": "#/components/schemas/ChangeFlowRunState"}, {"$ref": "#/components/schemas/PauseWorkQueue"}, {"$ref": "#/components/schemas/ResumeWorkQueue"}, {"$ref": "#/components/schemas/SendNotification"}, {"$ref": "#/components/schemas/CallWebhook"}, {"$ref": "#/components/schemas/PauseAutomation"}, {"$ref": "#/components/schemas/ResumeAutomation"}, {"$ref": "#/components/schemas/SuspendFlowRun"}, {"$ref": "#/components/schemas/PauseWorkPool"}, {"$ref": "#/components/schemas/ResumeWorkPool"}]}, "type": "array", "title": "Actions On Resolve", "description": "The actions to perform when an Automation goes into a resolving state"}}, "additionalProperties": false, "type": "object", "required": ["name", "trigger", "actions"], "title": "AutomationUpdate", "description": "Defines an action a user wants to take when a certain number of events\ndo or don't happen to the matching resources"}, "BlockDocument": {"properties": {"id": {"type": "string", "format": "uuid", "title": "Id"}, "created": {"type": "string", "format": "date-time", "title": "Created"}, "updated": {"type": "string", "format": "date-time", "title": "Updated"}, "name": {"type": "string", "title": "Name", "description": "The block document's name. Not required for anonymous block documents."}, "data": {"type": "object", "title": "Data", "description": "The block document's data"}, "block_schema_id": {"type": "string", "format": "uuid", "title": "Block Schema Id", "description": "A block schema ID"}, "block_schema": {"allOf": [{"$ref": "#/components/schemas/BlockSchema"}], "title": "Block Schema", "description": "The associated block schema"}, "block_type_id": {"type": "string", "format": "uuid", "title": "Block Type Id", "description": "A block type ID"}, "block_type_name": {"type": "string", "title": "Block Type Name", "description": "The associated block type's name"}, "block_type": {"allOf": [{"$ref": "#/components/schemas/BlockType"}], "title": "Block Type", "description": "The associated block type"}, "block_document_references": {"additionalProperties": {"type": "object"}, "type": "object", "title": "Block Document References", "description": "Record of the block document's references"}, "is_anonymous": {"type": "boolean", "title": "Is Anonymous", "description": "Whether the block is anonymous (anonymous blocks are usually created by Prefect automatically)", "default": false}}, "type": "object", "required": ["block_schema_id", "block_type_id"], "title": "BlockDocument", "description": "An ORM representation of a block document."}, "BlockDocumentCreate": {"properties": {"name": {"type": "string", "title": "Name", "description": "The block document's name. Not required for anonymous block documents."}, "data": {"type": "object", "title": "Data", "description": "The block document's data"}, "block_schema_id": {"type": "string", "format": "uuid", "title": "Block Schema Id", "description": "A block schema ID"}, "block_type_id": {"type": "string", "format": "uuid", "title": "Block Type Id", "description": "A block type ID"}, "is_anonymous": {"type": "boolean", "title": "Is Anonymous", "description": "Whether the block is anonymous (anonymous blocks are usually created by Prefect automatically)", "default": false}}, "additionalProperties": false, "type": "object", "required": ["block_schema_id", "block_type_id"], "title": "BlockDocumentCreate", "description": "Data used by the Prefect REST API to create a block document."}, "BlockDocumentFilter": {"properties": {"operator": {"allOf": [{"$ref": "#/components/schemas/Operator"}], "description": "Operator for combining filter criteria. Defaults to 'and_'.", "default": "and_"}, "id": {"allOf": [{"$ref": "#/components/schemas/BlockDocumentFilterId"}], "title": "Id", "description": "Filter criteria for `BlockDocument.id`"}, "is_anonymous": {"allOf": [{"$ref": "#/components/schemas/BlockDocumentFilterIsAnonymous"}], "title": "Is Anonymous", "description": "Filter criteria for `BlockDocument.is_anonymous`. Defaults to excluding anonymous blocks.", "default": {"eq_": false}}, "block_type_id": {"allOf": [{"$ref": "#/components/schemas/BlockDocumentFilterBlockTypeId"}], "title": "Block Type Id", "description": "Filter criteria for `BlockDocument.block_type_id`"}, "name": {"allOf": [{"$ref": "#/components/schemas/BlockDocumentFilterName"}], "title": "Name", "description": "Filter criteria for `BlockDocument.name`"}}, "additionalProperties": false, "type": "object", "title": "BlockDocumentFilter", "description": "Filter BlockDocuments. Only BlockDocuments matching all criteria will be returned"}, "BlockDocumentFilterBlockTypeId": {"properties": {"any_": {"items": {"type": "string", "format": "uuid"}, "type": "array", "title": "Any ", "description": "A list of block type ids to include"}}, "additionalProperties": false, "type": "object", "title": "BlockDocumentFilterBlockTypeId", "description": "Filter by `BlockDocument.block_type_id`."}, "BlockDocumentFilterId": {"properties": {"any_": {"items": {"type": "string", "format": "uuid"}, "type": "array", "title": "Any ", "description": "A list of block ids to include"}}, "additionalProperties": false, "type": "object", "title": "BlockDocumentFilterId", "description": "Filter by `BlockDocument.id`."}, "BlockDocumentFilterIsAnonymous": {"properties": {"eq_": {"type": "boolean", "title": "Eq ", "description": "Filter block documents for only those that are or are not anonymous."}}, "additionalProperties": false, "type": "object", "title": "BlockDocumentFilterIsAnonymous", "description": "Filter by `BlockDocument.is_anonymous`."}, "BlockDocumentFilterName": {"properties": {"any_": {"items": {"type": "string"}, "type": "array", "title": "Any ", "description": "A list of block names to include"}, "like_": {"type": "string", "title": "Like ", "description": "A string to match block names against. This can include SQL wildcard characters like `%` and `_`.", "examples": ["my-block%"]}}, "additionalProperties": false, "type": "object", "title": "BlockDocumentFilterName", "description": "Filter by `BlockDocument.name`."}, "BlockDocumentSort": {"type": "string", "enum": ["NAME_DESC", "NAME_ASC", "BLOCK_TYPE_AND_NAME_ASC"], "title": "BlockDocumentSort", "description": "Defines block document sorting options."}, "BlockDocumentUpdate": {"properties": {"block_schema_id": {"type": "string", "format": "uuid", "title": "Block Schema Id", "description": "A block schema ID"}, "data": {"type": "object", "title": "Data", "description": "The block document's data"}, "merge_existing_data": {"type": "boolean", "title": "Merge Existing Data", "default": true}}, "additionalProperties": false, "type": "object", "title": "BlockDocumentUpdate", "description": "Data used by the Prefect REST API to update a block document."}, "BlockSchema": {"properties": {"id": {"type": "string", "format": "uuid", "title": "Id"}, "created": {"type": "string", "format": "date-time", "title": "Created"}, "updated": {"type": "string", "format": "date-time", "title": "Updated"}, "checksum": {"type": "string", "title": "Checksum", "description": "The block schema's unique checksum"}, "fields": {"type": "object", "title": "Fields", "description": "The block schema's field schema"}, "block_type_id": {"type": "string", "format": "uuid", "title": "Block Type Id", "description": "A block type ID"}, "block_type": {"allOf": [{"$ref": "#/components/schemas/BlockType"}], "title": "Block Type", "description": "The associated block type"}, "capabilities": {"items": {"type": "string"}, "type": "array", "title": "Capabilities", "description": "A list of Block capabilities"}, "version": {"type": "string", "title": "Version", "description": "Human readable identifier for the block schema", "default": "non-versioned"}}, "type": "object", "required": ["checksum", "block_type_id"], "title": "BlockSchema", "description": "An ORM representation of a block schema."}, "BlockSchemaCreate": {"properties": {"fields": {"type": "object", "title": "Fields", "description": "The block schema's field schema"}, "block_type_id": {"type": "string", "format": "uuid", "title": "Block Type Id", "description": "A block type ID"}, "capabilities": {"items": {"type": "string"}, "type": "array", "title": "Capabilities", "description": "A list of Block capabilities"}, "version": {"type": "string", "title": "Version", "description": "Human readable identifier for the block schema", "default": "non-versioned"}}, "additionalProperties": false, "type": "object", "required": ["block_type_id"], "title": "BlockSchemaCreate", "description": "Data used by the Prefect REST API to create a block schema."}, "BlockSchemaFilter": {"properties": {"operator": {"allOf": [{"$ref": "#/components/schemas/Operator"}], "description": "Operator for combining filter criteria. Defaults to 'and_'.", "default": "and_"}, "block_type_id": {"allOf": [{"$ref": "#/components/schemas/BlockSchemaFilterBlockTypeId"}], "title": "Block Type Id", "description": "Filter criteria for `BlockSchema.block_type_id`"}, "block_capabilities": {"allOf": [{"$ref": "#/components/schemas/BlockSchemaFilterCapabilities"}], "title": "Block Capabilities", "description": "Filter criteria for `BlockSchema.capabilities`"}, "id": {"allOf": [{"$ref": "#/components/schemas/BlockSchemaFilterId"}], "title": "Id", "description": "Filter criteria for `BlockSchema.id`"}, "version": {"allOf": [{"$ref": "#/components/schemas/BlockSchemaFilterVersion"}], "title": "Version", "description": "Filter criteria for `BlockSchema.version`"}}, "additionalProperties": false, "type": "object", "title": "BlockSchemaFilter", "description": "Filter BlockSchemas"}, "BlockSchemaFilterBlockTypeId": {"properties": {"any_": {"items": {"type": "string", "format": "uuid"}, "type": "array", "title": "Any ", "description": "A list of block type ids to include"}}, "additionalProperties": false, "type": "object", "title": "BlockSchemaFilterBlockTypeId", "description": "Filter by `BlockSchema.block_type_id`."}, "BlockSchemaFilterCapabilities": {"properties": {"all_": {"items": {"type": "string"}, "type": "array", "title": "All ", "description": "A list of block capabilities. Block entities will be returned only if an associated block schema has a superset of the defined capabilities.", "examples": [["write-storage", "read-storage"]]}}, "additionalProperties": false, "type": "object", "title": "BlockSchemaFilterCapabilities", "description": "Filter by `BlockSchema.capabilities`"}, "BlockSchemaFilterId": {"properties": {"any_": {"items": {"type": "string", "format": "uuid"}, "type": "array", "title": "Any ", "description": "A list of IDs to include"}}, "additionalProperties": false, "type": "object", "title": "BlockSchemaFilterId", "description": "Filter by BlockSchema.id"}, "BlockSchemaFilterVersion": {"properties": {"any_": {"items": {"type": "string"}, "type": "array", "title": "Any ", "description": "A list of block schema versions.", "examples": [["2.0.0", "2.1.0"]]}}, "additionalProperties": false, "type": "object", "title": "BlockSchemaFilterVersion", "description": "Filter by `BlockSchema.capabilities`"}, "BlockType": {"properties": {"id": {"type": "string", "format": "uuid", "title": "Id"}, "created": {"type": "string", "format": "date-time", "title": "Created"}, "updated": {"type": "string", "format": "date-time", "title": "Updated"}, "name": {"type": "string", "title": "Name", "description": "A block type's name"}, "slug": {"type": "string", "title": "Slug", "description": "A block type's slug"}, "logo_url": {"type": "string", "maxLength": 2083, "minLength": 1, "format": "uri", "title": "Logo Url", "description": "Web URL for the block type's logo"}, "documentation_url": {"type": "string", "maxLength": 2083, "minLength": 1, "format": "uri", "title": "Documentation Url", "description": "Web URL for the block type's documentation"}, "description": {"type": "string", "title": "Description", "description": "A short blurb about the corresponding block's intended use"}, "code_example": {"type": "string", "title": "Code Example", "description": "A code snippet demonstrating use of the corresponding block"}, "is_protected": {"type": "boolean", "title": "Is Protected", "description": "Protected block types cannot be modified via API.", "default": false}}, "type": "object", "required": ["name", "slug"], "title": "BlockType", "description": "An ORM representation of a block type"}, "BlockTypeCreate": {"properties": {"name": {"type": "string", "title": "Name", "description": "A block type's name"}, "slug": {"type": "string", "title": "Slug", "description": "A block type's slug"}, "logo_url": {"type": "string", "maxLength": 2083, "minLength": 1, "format": "uri", "title": "Logo Url", "description": "Web URL for the block type's logo"}, "documentation_url": {"type": "string", "maxLength": 2083, "minLength": 1, "format": "uri", "title": "Documentation Url", "description": "Web URL for the block type's documentation"}, "description": {"type": "string", "title": "Description", "description": "A short blurb about the corresponding block's intended use"}, "code_example": {"type": "string", "title": "Code Example", "description": "A code snippet demonstrating use of the corresponding block"}}, "additionalProperties": false, "type": "object", "required": ["name", "slug"], "title": "BlockTypeCreate", "description": "Data used by the Prefect REST API to create a block type."}, "BlockTypeFilter": {"properties": {"name": {"allOf": [{"$ref": "#/components/schemas/BlockTypeFilterName"}], "title": "Name", "description": "Filter criteria for `BlockType.name`"}, "slug": {"allOf": [{"$ref": "#/components/schemas/BlockTypeFilterSlug"}], "title": "Slug", "description": "Filter criteria for `BlockType.slug`"}}, "additionalProperties": false, "type": "object", "title": "BlockTypeFilter", "description": "Filter BlockTypes"}, "BlockTypeFilterName": {"properties": {"like_": {"type": "string", "title": "Like ", "description": "A case-insensitive partial match. For example,  passing 'marvin' will match 'marvin', 'sad-Marvin', and 'marvin-robot'.", "examples": ["marvin"]}}, "additionalProperties": false, "type": "object", "title": "BlockTypeFilterName", "description": "Filter by `BlockType.name`"}, "BlockTypeFilterSlug": {"properties": {"any_": {"items": {"type": "string"}, "type": "array", "title": "Any ", "description": "A list of slugs to match"}}, "additionalProperties": false, "type": "object", "title": "BlockTypeFilterSlug", "description": "Filter by `BlockType.slug`"}, "BlockTypeUpdate": {"properties": {"logo_url": {"type": "string", "maxLength": 2083, "minLength": 1, "format": "uri", "title": "Logo Url"}, "documentation_url": {"type": "string", "maxLength": 2083, "minLength": 1, "format": "uri", "title": "Documentation Url"}, "description": {"type": "string", "title": "Description"}, "code_example": {"type": "string", "title": "Code Example"}}, "additionalProperties": false, "type": "object", "title": "BlockTypeUpdate", "description": "Data used by the Prefect REST API to update a block type."}, "Body_average_flow_run_lateness_flow_runs_lateness_post": {"properties": {"flows": {"$ref": "#/components/schemas/FlowFilter"}, "flow_runs": {"$ref": "#/components/schemas/FlowRunFilter"}, "task_runs": {"$ref": "#/components/schemas/TaskRunFilter"}, "deployments": {"$ref": "#/components/schemas/DeploymentFilter"}, "work_pools": {"$ref": "#/components/schemas/WorkPoolFilter"}, "work_pool_queues": {"$ref": "#/components/schemas/WorkQueueFilter"}}, "type": "object", "title": "Body_average_flow_run_lateness_flow_runs_lateness_post"}, "Body_bulk_decrement_active_slots_v2_concurrency_limits_decrement_post": {"properties": {"slots": {"type": "integer", "exclusiveMinimum": 0.0, "title": "Slots"}, "names": {"items": {"type": "string"}, "type": "array", "minItems": 1, "title": "Names"}, "occupancy_seconds": {"type": "number", "exclusiveMinimum": 0.0, "title": "Occupancy Seconds"}}, "type": "object", "required": ["slots", "names"], "title": "Body_bulk_decrement_active_slots_v2_concurrency_limits_decrement_post"}, "Body_bulk_increment_active_slots_v2_concurrency_limits_increment_post": {"properties": {"slots": {"type": "integer", "exclusiveMinimum": 0.0, "title": "Slots"}, "names": {"items": {"type": "string"}, "type": "array", "minItems": 1, "title": "Names"}, "mode": {"type": "string", "enum": ["concurrency", "rate_limit"], "title": "Mode", "default": "concurrency"}}, "type": "object", "required": ["slots", "names"], "title": "Body_bulk_increment_active_slots_v2_concurrency_limits_increment_post"}, "Body_clear_database_admin_database_clear_post": {"properties": {"confirm": {"type": "boolean", "title": "Confirm", "description": "Pass confirm=True to confirm you want to modify the database.", "default": false}}, "type": "object", "title": "Body_clear_database_admin_database_clear_post"}, "Body_count_artifacts_artifacts_count_post": {"properties": {"artifacts": {"$ref": "#/components/schemas/ArtifactFilter"}, "flow_runs": {"$ref": "#/components/schemas/FlowRunFilter"}, "task_runs": {"$ref": "#/components/schemas/TaskRunFilter"}, "flows": {"$ref": "#/components/schemas/FlowFilter"}, "deployments": {"$ref": "#/components/schemas/DeploymentFilter"}}, "type": "object", "title": "Body_count_artifacts_artifacts_count_post"}, "Body_count_block_documents_block_documents_count_post": {"properties": {"block_documents": {"$ref": "#/components/schemas/BlockDocumentFilter"}, "block_types": {"$ref": "#/components/schemas/BlockTypeFilter"}, "block_schemas": {"$ref": "#/components/schemas/BlockSchemaFilter"}}, "type": "object", "title": "Body_count_block_documents_block_documents_count_post"}, "Body_count_deployments_deployments_count_post": {"properties": {"flows": {"$ref": "#/components/schemas/FlowFilter"}, "flow_runs": {"$ref": "#/components/schemas/FlowRunFilter"}, "task_runs": {"$ref": "#/components/schemas/TaskRunFilter"}, "deployments": {"$ref": "#/components/schemas/DeploymentFilter"}, "work_pools": {"$ref": "#/components/schemas/WorkPoolFilter"}, "work_pool_queues": {"$ref": "#/components/schemas/WorkQueueFilter"}}, "type": "object", "title": "Body_count_deployments_deployments_count_post"}, "Body_count_flow_runs_flow_runs_count_post": {"properties": {"flows": {"$ref": "#/components/schemas/FlowFilter"}, "flow_runs": {"$ref": "#/components/schemas/FlowRunFilter"}, "task_runs": {"$ref": "#/components/schemas/TaskRunFilter"}, "deployments": {"$ref": "#/components/schemas/DeploymentFilter"}, "work_pools": {"$ref": "#/components/schemas/WorkPoolFilter"}, "work_pool_queues": {"$ref": "#/components/schemas/WorkQueueFilter"}}, "type": "object", "title": "Body_count_flow_runs_flow_runs_count_post"}, "Body_count_flows_flows_count_post": {"properties": {"flows": {"$ref": "#/components/schemas/FlowFilter"}, "flow_runs": {"$ref": "#/components/schemas/FlowRunFilter"}, "task_runs": {"$ref": "#/components/schemas/TaskRunFilter"}, "deployments": {"$ref": "#/components/schemas/DeploymentFilter"}, "work_pools": {"$ref": "#/components/schemas/WorkPoolFilter"}}, "type": "object", "title": "Body_count_flows_flows_count_post"}, "Body_count_latest_artifacts_artifacts_latest_count_post": {"properties": {"artifacts": {"$ref": "#/components/schemas/ArtifactCollectionFilter"}, "flow_runs": {"$ref": "#/components/schemas/FlowRunFilter"}, "task_runs": {"$ref": "#/components/schemas/TaskRunFilter"}, "flows": {"$ref": "#/components/schemas/FlowFilter"}, "deployments": {"$ref": "#/components/schemas/DeploymentFilter"}}, "type": "object", "title": "Body_count_latest_artifacts_artifacts_latest_count_post"}, "Body_count_task_runs_task_runs_count_post": {"properties": {"flows": {"$ref": "#/components/schemas/FlowFilter"}, "flow_runs": {"$ref": "#/components/schemas/FlowRunFilter"}, "task_runs": {"$ref": "#/components/schemas/TaskRunFilter"}, "deployments": {"$ref": "#/components/schemas/DeploymentFilter"}}, "type": "object", "title": "Body_count_task_runs_task_runs_count_post"}, "Body_count_variables_variables_count_post": {"properties": {"variables": {"$ref": "#/components/schemas/VariableFilter"}}, "type": "object", "title": "Body_count_variables_variables_count_post"}, "Body_count_work_pools_work_pools_count_post": {"properties": {"work_pools": {"$ref": "#/components/schemas/WorkPoolFilter"}}, "type": "object", "title": "Body_count_work_pools_work_pools_count_post"}, "Body_create_database_admin_database_create_post": {"properties": {"confirm": {"type": "boolean", "title": "Confirm", "description": "Pass confirm=True to confirm you want to modify the database.", "default": false}}, "type": "object", "title": "Body_create_database_admin_database_create_post"}, "Body_create_flow_run_input_flow_runs__id__input_post": {"properties": {"key": {"type": "string", "title": "Key", "description": "The input key"}, "value": {"type": "string", "format": "binary", "title": "Value", "description": "The value of the input"}, "sender": {"type": "string", "title": "Sender", "description": "The sender of the input"}}, "type": "object", "required": ["key", "value"], "title": "Body_create_flow_run_input_flow_runs__id__input_post"}, "Body_drop_database_admin_database_drop_post": {"properties": {"confirm": {"type": "boolean", "title": "Confirm", "description": "Pass confirm=True to confirm you want to modify the database.", "default": false}}, "type": "object", "title": "Body_drop_database_admin_database_drop_post"}, "Body_filter_flow_run_input_flow_runs__id__input_filter_post": {"properties": {"prefix": {"type": "string", "title": "Prefix", "description": "The input key prefix"}, "limit": {"type": "integer", "title": "Limit", "description": "The maximum number of results to return", "default": 1}, "exclude_keys": {"items": {"type": "string"}, "type": "array", "title": "Exclude Keys", "description": "Exclude inputs with these keys", "default": []}}, "type": "object", "required": ["prefix"], "title": "Body_filter_flow_run_input_flow_runs__id__input_filter_post"}, "Body_flow_run_history_flow_runs_history_post": {"properties": {"history_start": {"type": "string", "format": "date-time", "title": "History Start", "description": "The history's start time."}, "history_end": {"type": "string", "format": "date-time", "title": "History End", "description": "The history's end time."}, "history_interval_seconds": {"type": "number", "format": "time-delta", "title": "History Interval Seconds", "description": "The size of each history interval, in seconds. Must be at least 1 second."}, "flows": {"$ref": "#/components/schemas/FlowFilter"}, "flow_runs": {"$ref": "#/components/schemas/FlowRunFilter"}, "task_runs": {"$ref": "#/components/schemas/TaskRunFilter"}, "deployments": {"$ref": "#/components/schemas/DeploymentFilter"}, "work_pools": {"$ref": "#/components/schemas/WorkPoolFilter"}, "work_queues": {"$ref": "#/components/schemas/WorkQueueFilter"}}, "type": "object", "required": ["history_start", "history_end", "history_interval_seconds"], "title": "Body_flow_run_history_flow_runs_history_post"}, "Body_get_scheduled_flow_runs_for_deployments_deployments_get_scheduled_flow_runs_post": {"properties": {"deployment_ids": {"items": {"type": "string", "format": "uuid"}, "type": "array", "title": "Deployment Ids", "description": "The deployment IDs to get scheduled runs for"}, "scheduled_before": {"type": "string", "format": "date-time", "title": "Scheduled Before", "description": "The maximum time to look for scheduled flow runs"}, "limit": {"type": "integer", "title": "Limit", "description": "Defaults to PREFECT_API_DEFAULT_LIMIT if not provided."}}, "type": "object", "required": ["deployment_ids"], "title": "Body_get_scheduled_flow_runs_for_deployments_deployments_get_scheduled_flow_runs_post"}, "Body_get_scheduled_flow_runs_work_pools__name__get_scheduled_flow_runs_post": {"properties": {"work_queue_names": {"items": {"type": "string"}, "type": "array", "title": "Work Queue Names", "description": "The names of work pool queues"}, "scheduled_before": {"type": "string", "format": "date-time", "title": "Scheduled Before", "description": "The maximum time to look for scheduled flow runs"}, "scheduled_after": {"type": "string", "format": "date-time", "title": "Scheduled After", "description": "The minimum time to look for scheduled flow runs"}, "limit": {"type": "integer", "title": "Limit", "description": "Defaults to PREFECT_API_DEFAULT_LIMIT if not provided."}}, "type": "object", "title": "Body_get_scheduled_flow_runs_work_pools__name__get_scheduled_flow_runs_post"}, "Body_read_all_concurrency_limits_v2_v2_concurrency_limits_filter_post": {"properties": {"offset": {"type": "integer", "minimum": 0.0, "title": "Offset", "default": 0}, "limit": {"type": "integer", "title": "Limit", "description": "Defaults to PREFECT_API_DEFAULT_LIMIT if not provided."}}, "type": "object", "title": "Body_read_all_concurrency_limits_v2_v2_concurrency_limits_filter_post"}, "Body_read_artifacts_artifacts_filter_post": {"properties": {"sort": {"allOf": [{"$ref": "#/components/schemas/ArtifactSort"}], "default": "ID_DESC"}, "offset": {"type": "integer", "minimum": 0.0, "title": "Offset", "default": 0}, "artifacts": {"$ref": "#/components/schemas/ArtifactFilter"}, "flow_runs": {"$ref": "#/components/schemas/FlowRunFilter"}, "task_runs": {"$ref": "#/components/schemas/TaskRunFilter"}, "flows": {"$ref": "#/components/schemas/FlowFilter"}, "deployments": {"$ref": "#/components/schemas/DeploymentFilter"}, "limit": {"type": "integer", "title": "Limit", "description": "Defaults to PREFECT_API_DEFAULT_LIMIT if not provided."}}, "type": "object", "title": "Body_read_artifacts_artifacts_filter_post"}, "Body_read_automations_automations_filter_post": {"properties": {"sort": {"allOf": [{"$ref": "#/components/schemas/AutomationSort"}], "default": "NAME_ASC"}, "offset": {"type": "integer", "minimum": 0.0, "title": "Offset", "default": 0}, "limit": {"type": "integer", "title": "Limit", "description": "Defaults to PREFECT_API_DEFAULT_LIMIT if not provided."}}, "type": "object", "title": "Body_read_automations_automations_filter_post"}, "Body_read_block_documents_block_documents_filter_post": {"properties": {"block_documents": {"$ref": "#/components/schemas/BlockDocumentFilter"}, "block_types": {"$ref": "#/components/schemas/BlockTypeFilter"}, "block_schemas": {"$ref": "#/components/schemas/BlockSchemaFilter"}, "include_secrets": {"type": "boolean", "title": "Include Secrets", "description": "Whether to include sensitive values in the block document.", "default": false}, "sort": {"allOf": [{"$ref": "#/components/schemas/BlockDocumentSort"}], "default": "NAME_ASC"}, "offset": {"type": "integer", "minimum": 0.0, "title": "Offset", "default": 0}, "limit": {"type": "integer", "title": "Limit", "description": "Defaults to PREFECT_API_DEFAULT_LIMIT if not provided."}}, "type": "object", "title": "Body_read_block_documents_block_documents_filter_post"}, "Body_read_block_schemas_block_schemas_filter_post": {"properties": {"block_schemas": {"$ref": "#/components/schemas/BlockSchemaFilter"}, "offset": {"type": "integer", "minimum": 0.0, "title": "Offset", "default": 0}, "limit": {"type": "integer", "title": "Limit", "description": "Defaults to PREFECT_API_DEFAULT_LIMIT if not provided."}}, "type": "object", "title": "Body_read_block_schemas_block_schemas_filter_post"}, "Body_read_block_types_block_types_filter_post": {"properties": {"block_types": {"$ref": "#/components/schemas/BlockTypeFilter"}, "block_schemas": {"$ref": "#/components/schemas/BlockSchemaFilter"}, "offset": {"type": "integer", "minimum": 0.0, "title": "Offset", "default": 0}, "limit": {"type": "integer", "title": "Limit", "description": "Defaults to PREFECT_API_DEFAULT_LIMIT if not provided."}}, "type": "object", "title": "Body_read_block_types_block_types_filter_post"}, "Body_read_concurrency_limits_concurrency_limits_filter_post": {"properties": {"offset": {"type": "integer", "minimum": 0.0, "title": "Offset", "default": 0}, "limit": {"type": "integer", "title": "Limit", "description": "Defaults to PREFECT_API_DEFAULT_LIMIT if not provided."}}, "type": "object", "title": "Body_read_concurrency_limits_concurrency_limits_filter_post"}, "Body_read_dashboard_task_run_counts_ui_task_runs_dashboard_counts_post": {"properties": {"task_runs": {"$ref": "#/components/schemas/TaskRunFilter"}, "flows": {"$ref": "#/components/schemas/FlowFilter"}, "flow_runs": {"$ref": "#/components/schemas/FlowRunFilter"}, "deployments": {"$ref": "#/components/schemas/DeploymentFilter"}, "work_pools": {"$ref": "#/components/schemas/WorkPoolFilter"}, "work_queues": {"$ref": "#/components/schemas/WorkQueueFilter"}}, "type": "object", "required": ["task_runs"], "title": "Body_read_dashboard_task_run_counts_ui_task_runs_dashboard_counts_post"}, "Body_read_deployments_deployments_filter_post": {"properties": {"offset": {"type": "integer", "minimum": 0.0, "title": "Offset", "default": 0}, "flows": {"$ref": "#/components/schemas/FlowFilter"}, "flow_runs": {"$ref": "#/components/schemas/FlowRunFilter"}, "task_runs": {"$ref": "#/components/schemas/TaskRunFilter"}, "deployments": {"$ref": "#/components/schemas/DeploymentFilter"}, "work_pools": {"$ref": "#/components/schemas/WorkPoolFilter"}, "work_pool_queues": {"$ref": "#/components/schemas/WorkQueueFilter"}, "sort": {"allOf": [{"$ref": "#/components/schemas/DeploymentSort"}], "default": "NAME_ASC"}, "limit": {"type": "integer", "title": "Limit", "description": "Defaults to PREFECT_API_DEFAULT_LIMIT if not provided."}}, "type": "object", "title": "Body_read_deployments_deployments_filter_post"}, "Body_read_flow_run_history_ui_flow_runs_history_post": {"properties": {"sort": {"allOf": [{"$ref": "#/components/schemas/FlowRunSort"}], "default": "EXPECTED_START_TIME_DESC"}, "limit": {"type": "integer", "maximum": 1000.0, "title": "Limit", "default": 1000}, "offset": {"type": "integer", "minimum": 0.0, "title": "Offset", "default": 0}, "flows": {"$ref": "#/components/schemas/FlowFilter"}, "flow_runs": {"$ref": "#/components/schemas/FlowRunFilter"}, "task_runs": {"$ref": "#/components/schemas/TaskRunFilter"}, "deployments": {"$ref": "#/components/schemas/DeploymentFilter"}, "work_pools": {"$ref": "#/components/schemas/WorkPoolFilter"}}, "type": "object", "title": "Body_read_flow_run_history_ui_flow_runs_history_post"}, "Body_read_flow_run_notification_policies_flow_run_notification_policies_filter_post": {"properties": {"flow_run_notification_policy_filter": {"$ref": "#/components/schemas/FlowRunNotificationPolicyFilter"}, "offset": {"type": "integer", "minimum": 0.0, "title": "Offset", "default": 0}, "limit": {"type": "integer", "title": "Limit", "description": "Defaults to PREFECT_API_DEFAULT_LIMIT if not provided."}}, "type": "object", "title": "Body_read_flow_run_notification_policies_flow_run_notification_policies_filter_post"}, "Body_read_flow_runs_flow_runs_filter_post": {"properties": {"sort": {"allOf": [{"$ref": "#/components/schemas/FlowRunSort"}], "default": "ID_DESC"}, "offset": {"type": "integer", "minimum": 0.0, "title": "Offset", "default": 0}, "flows": {"$ref": "#/components/schemas/FlowFilter"}, "flow_runs": {"$ref": "#/components/schemas/FlowRunFilter"}, "task_runs": {"$ref": "#/components/schemas/TaskRunFilter"}, "deployments": {"$ref": "#/components/schemas/DeploymentFilter"}, "work_pools": {"$ref": "#/components/schemas/WorkPoolFilter"}, "work_pool_queues": {"$ref": "#/components/schemas/WorkQueueFilter"}, "limit": {"type": "integer", "title": "Limit", "description": "Defaults to PREFECT_API_DEFAULT_LIMIT if not provided."}}, "type": "object", "title": "Body_read_flow_runs_flow_runs_filter_post"}, "Body_read_flows_flows_filter_post": {"properties": {"offset": {"type": "integer", "minimum": 0.0, "title": "Offset", "default": 0}, "flows": {"$ref": "#/components/schemas/FlowFilter"}, "flow_runs": {"$ref": "#/components/schemas/FlowRunFilter"}, "task_runs": {"$ref": "#/components/schemas/TaskRunFilter"}, "deployments": {"$ref": "#/components/schemas/DeploymentFilter"}, "work_pools": {"$ref": "#/components/schemas/WorkPoolFilter"}, "sort": {"allOf": [{"$ref": "#/components/schemas/FlowSort"}], "default": "NAME_ASC"}, "limit": {"type": "integer", "title": "Limit", "description": "Defaults to PREFECT_API_DEFAULT_LIMIT if not provided."}}, "type": "object", "title": "Body_read_flows_flows_filter_post"}, "Body_read_latest_artifacts_artifacts_latest_filter_post": {"properties": {"sort": {"allOf": [{"$ref": "#/components/schemas/ArtifactCollectionSort"}], "default": "ID_DESC"}, "offset": {"type": "integer", "minimum": 0.0, "title": "Offset", "default": 0}, "artifacts": {"$ref": "#/components/schemas/ArtifactCollectionFilter"}, "flow_runs": {"$ref": "#/components/schemas/FlowRunFilter"}, "task_runs": {"$ref": "#/components/schemas/TaskRunFilter"}, "flows": {"$ref": "#/components/schemas/FlowFilter"}, "deployments": {"$ref": "#/components/schemas/DeploymentFilter"}, "limit": {"type": "integer", "title": "Limit", "description": "Defaults to PREFECT_API_DEFAULT_LIMIT if not provided."}}, "type": "object", "title": "Body_read_latest_artifacts_artifacts_latest_filter_post"}, "Body_read_logs_logs_filter_post": {"properties": {"offset": {"type": "integer", "minimum": 0.0, "title": "Offset", "default": 0}, "logs": {"$ref": "#/components/schemas/LogFilter"}, "sort": {"allOf": [{"$ref": "#/components/schemas/LogSort"}], "default": "TIMESTAMP_ASC"}, "limit": {"type": "integer", "title": "Limit", "description": "Defaults to PREFECT_API_DEFAULT_LIMIT if not provided."}}, "type": "object", "title": "Body_read_logs_logs_filter_post"}, "Body_read_saved_searches_saved_searches_filter_post": {"properties": {"offset": {"type": "integer", "minimum": 0.0, "title": "Offset", "default": 0}, "limit": {"type": "integer", "title": "Limit", "description": "Defaults to PREFECT_API_DEFAULT_LIMIT if not provided."}}, "type": "object", "title": "Body_read_saved_searches_saved_searches_filter_post"}, "Body_read_task_run_counts_by_state_ui_task_runs_count_post": {"properties": {"flows": {"$ref": "#/components/schemas/FlowFilter"}, "flow_runs": {"$ref": "#/components/schemas/FlowRunFilter"}, "task_runs": {"$ref": "#/components/schemas/TaskRunFilter"}, "deployments": {"$ref": "#/components/schemas/DeploymentFilter"}}, "type": "object", "title": "Body_read_task_run_counts_by_state_ui_task_runs_count_post"}, "Body_read_task_runs_task_runs_filter_post": {"properties": {"sort": {"allOf": [{"$ref": "#/components/schemas/TaskRunSort"}], "default": "ID_DESC"}, "offset": {"type": "integer", "minimum": 0.0, "title": "Offset", "default": 0}, "flows": {"$ref": "#/components/schemas/FlowFilter"}, "flow_runs": {"$ref": "#/components/schemas/FlowRunFilter"}, "task_runs": {"$ref": "#/components/schemas/TaskRunFilter"}, "deployments": {"$ref": "#/components/schemas/DeploymentFilter"}, "limit": {"type": "integer", "title": "Limit", "description": "Defaults to PREFECT_API_DEFAULT_LIMIT if not provided."}}, "type": "object", "title": "Body_read_task_runs_task_runs_filter_post"}, "Body_read_variables_variables_filter_post": {"properties": {"offset": {"type": "integer", "minimum": 0.0, "title": "Offset", "default": 0}, "variables": {"$ref": "#/components/schemas/VariableFilter"}, "sort": {"allOf": [{"$ref": "#/components/schemas/VariableSort"}], "default": "NAME_ASC"}, "limit": {"type": "integer", "title": "Limit", "description": "Defaults to PREFECT_API_DEFAULT_LIMIT if not provided."}}, "type": "object", "title": "Body_read_variables_variables_filter_post"}, "Body_read_work_pools_work_pools_filter_post": {"properties": {"work_pools": {"$ref": "#/components/schemas/WorkPoolFilter"}, "offset": {"type": "integer", "minimum": 0.0, "title": "Offset", "default": 0}, "limit": {"type": "integer", "title": "Limit", "description": "Defaults to PREFECT_API_DEFAULT_LIMIT if not provided."}}, "type": "object", "title": "Body_read_work_pools_work_pools_filter_post"}, "Body_read_work_queue_runs_work_queues__id__get_runs_post": {"properties": {"scheduled_before": {"type": "string", "format": "date-time", "title": "Scheduled Before", "description": "Only flow runs scheduled to start before this time will be returned."}, "agent_id": {"type": "string", "format": "uuid", "title": "Agent Id", "description": "An optional unique identifier for the agent making this query. If provided, the Prefect REST API will track the last time this agent polled the work queue."}, "limit": {"type": "integer", "title": "Limit", "description": "Defaults to PREFECT_API_DEFAULT_LIMIT if not provided."}}, "type": "object", "title": "Body_read_work_queue_runs_work_queues__id__get_runs_post"}, "Body_read_work_queues_work_pools__work_pool_name__queues_filter_post": {"properties": {"work_queues": {"$ref": "#/components/schemas/WorkQueueFilter"}, "offset": {"type": "integer", "minimum": 0.0, "title": "Offset", "default": 0}, "limit": {"type": "integer", "title": "Limit", "description": "Defaults to PREFECT_API_DEFAULT_LIMIT if not provided."}}, "type": "object", "title": "Body_read_work_queues_work_pools__work_pool_name__queues_filter_post"}, "Body_read_work_queues_work_queues_filter_post": {"properties": {"offset": {"type": "integer", "minimum": 0.0, "title": "Offset", "default": 0}, "work_queues": {"$ref": "#/components/schemas/WorkQueueFilter"}, "limit": {"type": "integer", "title": "Limit", "description": "Defaults to PREFECT_API_DEFAULT_LIMIT if not provided."}}, "type": "object", "title": "Body_read_work_queues_work_queues_filter_post"}, "Body_read_workers_work_pools__work_pool_name__workers_filter_post": {"properties": {"workers": {"$ref": "#/components/schemas/WorkerFilter"}, "offset": {"type": "integer", "minimum": 0.0, "title": "Offset", "default": 0}, "limit": {"type": "integer", "title": "Limit", "description": "Defaults to PREFECT_API_DEFAULT_LIMIT if not provided."}}, "type": "object", "title": "Body_read_workers_work_pools__work_pool_name__workers_filter_post"}, "Body_reset_concurrency_limit_by_tag_concurrency_limits_tag__tag__reset_post": {"properties": {"slot_override": {"items": {"type": "string", "format": "uuid"}, "type": "array", "title": "Slot Override", "description": "Manual override for active concurrency limit slots."}}, "type": "object", "title": "Body_reset_concurrency_limit_by_tag_concurrency_limits_tag__tag__reset_post"}, "Body_resume_flow_run_flow_runs__id__resume_post": {"properties": {"run_input": {"type": "object", "title": "Run Input"}}, "type": "object", "title": "Body_resume_flow_run_flow_runs__id__resume_post"}, "Body_schedule_deployment_deployments__id__schedule_post": {"properties": {"start_time": {"type": "string", "format": "date-time", "title": "Start Time", "description": "The earliest date to schedule"}, "end_time": {"type": "string", "format": "date-time", "title": "End Time", "description": "The latest date to schedule"}, "min_time": {"type": "number", "format": "time-delta", "title": "Min Time", "description": "Runs will be scheduled until at least this long after the `start_time`"}, "min_runs": {"type": "integer", "title": "Min Runs", "description": "The minimum number of runs to schedule"}, "max_runs": {"type": "integer", "title": "Max Runs", "description": "The maximum number of runs to schedule"}}, "type": "object", "title": "Body_schedule_deployment_deployments__id__schedule_post"}, "Body_set_flow_run_state_flow_runs__id__set_state_post": {"properties": {"state": {"allOf": [{"$ref": "#/components/schemas/StateCreate"}], "title": "State", "description": "The intended state."}, "force": {"type": "boolean", "title": "Force", "description": "If false, orchestration rules will be applied that may alter or prevent the state transition. If True, orchestration rules are not applied.", "default": false}}, "type": "object", "required": ["state"], "title": "Body_set_flow_run_state_flow_runs__id__set_state_post"}, "Body_set_task_run_state_task_runs__id__set_state_post": {"properties": {"state": {"allOf": [{"$ref": "#/components/schemas/StateCreate"}], "title": "State", "description": "The intended state."}, "force": {"type": "boolean", "title": "Force", "description": "If false, orchestration rules will be applied that may alter or prevent the state transition. If True, orchestration rules are not applied.", "default": false}}, "type": "object", "required": ["state"], "title": "Body_set_task_run_state_task_runs__id__set_state_post"}, "Body_task_run_history_task_runs_history_post": {"properties": {"history_start": {"type": "string", "format": "date-time", "title": "History Start", "description": "The history's start time."}, "history_end": {"type": "string", "format": "date-time", "title": "History End", "description": "The history's end time."}, "history_interval_seconds": {"type": "number", "format": "time-delta", "title": "History Interval Seconds", "description": "The size of each history interval, in seconds. Must be at least 1 second."}, "flows": {"$ref": "#/components/schemas/FlowFilter"}, "flow_runs": {"$ref": "#/components/schemas/FlowRunFilter"}, "task_runs": {"$ref": "#/components/schemas/TaskRunFilter"}, "deployments": {"$ref": "#/components/schemas/DeploymentFilter"}}, "type": "object", "required": ["history_start", "history_end", "history_interval_seconds"], "title": "Body_task_run_history_task_runs_history_post"}, "Body_validate_obj_ui_schemas_validate_post": {"properties": {"schema": {"type": "object", "title": "Schema"}, "values": {"type": "object", "title": "Values"}}, "type": "object", "required": ["schema", "values"], "title": "Body_validate_obj_ui_schemas_validate_post"}, "Body_worker_heartbeat_work_pools__work_pool_name__workers_heartbeat_post": {"properties": {"name": {"type": "string", "title": "Name", "description": "The worker process name"}, "heartbeat_interval_seconds": {"type": "integer", "title": "Heartbeat Interval Seconds", "description": "The worker's heartbeat interval in seconds"}}, "type": "object", "required": ["name"], "title": "Body_worker_heartbeat_work_pools__work_pool_name__workers_heartbeat_post"}, "CallWebhook": {"properties": {"type": {"type": "string", "enum": ["call-webhook"], "title": "Type", "default": "call-webhook"}, "block_document_id": {"type": "string", "format": "uuid", "title": "Block Document Id", "description": "The identifier of the webhook block to use"}, "payload": {"type": "string", "title": "Payload", "description": "An optional templatable payload to send when calling the webhook.", "default": ""}}, "type": "object", "required": ["block_document_id"], "title": "CallWebhook", "description": "Call a webhook when an Automation is triggered."}, "CancelFlowRun": {"properties": {"type": {"type": "string", "enum": ["cancel-flow-run"], "title": "Type", "default": "cancel-flow-run"}}, "type": "object", "title": "CancelFlowRun", "description": "Cancels a flow run associated with the trigger"}, "ChangeFlowRunState": {"properties": {"type": {"type": "string", "enum": ["change-flow-run-state"], "title": "Type", "default": "change-flow-run-state"}, "name": {"type": "string", "title": "Name", "description": "The name of the state to change the flow run to"}, "state": {"allOf": [{"$ref": "#/components/schemas/StateType"}], "description": "The type of the state to change the flow run to"}, "message": {"type": "string", "title": "Message", "description": "An optional message to associate with the state change"}}, "type": "object", "required": ["state"], "title": "ChangeFlowRunState", "description": "Changes the state of a flow run associated with the trigger"}, "CompoundTrigger": {"properties": {"type": {"type": "string", "enum": ["compound"], "title": "Type", "default": "compound"}, "id": {"type": "string", "format": "uuid", "title": "Id", "description": "The unique ID of this trigger"}, "triggers": {"items": {"anyOf": [{"$ref": "#/components/schemas/EventTrigger"}, {"$ref": "#/components/schemas/CompoundTrigger"}, {"$ref": "#/components/schemas/SequenceTrigger"}]}, "type": "array", "title": "Triggers"}, "within": {"type": "number", "format": "time-delta", "title": "Within"}, "require": {"anyOf": [{"type": "integer"}, {"type": "string", "enum": ["any", "all"]}], "title": "Require"}}, "type": "object", "required": ["triggers", "require"], "title": "CompoundTrigger", "description": "A composite trigger that requires some number of triggers to have\nfired within the given time period"}, "ConcurrencyLimit": {"properties": {"id": {"type": "string", "format": "uuid", "title": "Id"}, "created": {"type": "string", "format": "date-time", "title": "Created"}, "updated": {"type": "string", "format": "date-time", "title": "Updated"}, "tag": {"type": "string", "title": "Tag", "description": "A tag the concurrency limit is applied to."}, "concurrency_limit": {"type": "integer", "title": "Concurrency Limit", "description": "The concurrency limit."}, "active_slots": {"items": {"type": "string", "format": "uuid"}, "type": "array", "title": "Active Slots", "description": "A list of active run ids using a concurrency slot"}}, "type": "object", "required": ["tag", "concurrency_limit"], "title": "ConcurrencyLimit", "description": "An ORM representation of a concurrency limit."}, "ConcurrencyLimitCreate": {"properties": {"tag": {"type": "string", "title": "Tag", "description": "A tag the concurrency limit is applied to."}, "concurrency_limit": {"type": "integer", "title": "Concurrency Limit", "description": "The concurrency limit."}}, "additionalProperties": false, "type": "object", "required": ["tag", "concurrency_limit"], "title": "ConcurrencyLimitCreate", "description": "Data used by the Prefect REST API to create a concurrency limit."}, "ConcurrencyLimitV2": {"properties": {"id": {"type": "string", "format": "uuid", "title": "Id"}, "created": {"type": "string", "format": "date-time", "title": "Created"}, "updated": {"type": "string", "format": "date-time", "title": "Updated"}, "active": {"type": "boolean", "title": "Active", "description": "Whether the concurrency limit is active.", "default": true}, "name": {"type": "string", "title": "Name", "description": "The name of the concurrency limit."}, "limit": {"type": "integer", "title": "Limit", "description": "The concurrency limit."}, "active_slots": {"type": "integer", "title": "Active Slots", "description": "The number of active slots.", "default": 0}, "denied_slots": {"type": "integer", "title": "Denied Slots", "description": "The number of denied slots.", "default": 0}, "slot_decay_per_second": {"type": "number", "title": "Slot Decay Per Second", "description": "The decay rate for active slots when used as a rate limit.", "default": 0}, "avg_slot_occupancy_seconds": {"type": "number", "title": "Avg Slot Occupancy Seconds", "description": "The average amount of time a slot is occupied.", "default": 2.0}}, "type": "object", "required": ["name", "limit"], "title": "ConcurrencyLimitV2", "description": "An ORM representation of a v2 concurrency limit."}, "ConcurrencyLimitV2Create": {"properties": {"active": {"type": "boolean", "title": "Active", "description": "Whether the concurrency limit is active.", "default": true}, "name": {"type": "string", "title": "Name", "description": "The name of the concurrency limit."}, "limit": {"type": "integer", "title": "Limit", "description": "The concurrency limit."}, "active_slots": {"type": "integer", "title": "Active Slots", "description": "The number of active slots.", "default": 0}, "denied_slots": {"type": "integer", "title": "Denied Slots", "description": "The number of denied slots.", "default": 0}, "slot_decay_per_second": {"type": "number", "title": "Slot Decay Per Second", "description": "The decay rate for active slots when used as a rate limit.", "default": 0}}, "additionalProperties": false, "type": "object", "required": ["name", "limit"], "title": "ConcurrencyLimitV2Create", "description": "Data used by the Prefect REST API to create a v2 concurrency limit."}, "ConcurrencyLimitV2Update": {"properties": {"active": {"type": "boolean", "title": "Active"}, "name": {"type": "string", "title": "Name"}, "limit": {"type": "integer", "title": "Limit"}, "active_slots": {"type": "integer", "title": "Active Slots"}, "denied_slots": {"type": "integer", "title": "Denied Slots"}, "slot_decay_per_second": {"type": "number", "title": "Slot Decay Per Second"}}, "additionalProperties": false, "type": "object", "title": "ConcurrencyLimitV2Update", "description": "Data used by the Prefect REST API to update a v2 concurrency limit."}, "Constant": {"properties": {"input_type": {"type": "string", "enum": ["constant"], "title": "Input Type", "default": "constant"}, "type": {"type": "string", "title": "Type"}}, "type": "object", "required": ["type"], "title": "Constant", "description": "Represents constant input value to a task run."}, "CountByState": {"properties": {"COMPLETED": {"type": "integer", "title": "Completed", "default": 0}, "PENDING": {"type": "integer", "title": "Pending", "default": 0}, "RUNNING": {"type": "integer", "title": "Running", "default": 0}, "FAILED": {"type": "integer", "title": "Failed", "default": 0}, "CANCELLED": {"type": "integer", "title": "Cancelled", "default": 0}, "CRASHED": {"type": "integer", "title": "Crashed", "default": 0}, "PAUSED": {"type": "integer", "title": "Paused", "default": 0}, "CANCELLING": {"type": "integer", "title": "Cancelling", "default": 0}, "SCHEDULED": {"type": "integer", "title": "Scheduled", "default": 0}}, "type": "object", "title": "CountByState", "description": "A base pydantic.BaseModel for all Prefect schemas and pydantic models.\n\nAs the basis for most Prefect schemas, this base model usually ignores extra\nfields that are passed to it at instantiation. Because adding new fields to\nAPI payloads is not considered a breaking change, this ensures that any\nPrefect client loading data from a server running a possibly-newer version\nof Prefect will be able to process those new fields gracefully. However,\nwhen PREFECT_TEST_MODE is on, extra fields are forbidden in order to catch\nsubtle unintentional testing errors."}, "CreatedBy": {"properties": {"id": {"type": "string", "format": "uuid", "title": "Id", "description": "The id of the creator of the object."}, "type": {"type": "string", "title": "Type", "description": "The type of the creator of the object."}, "display_value": {"type": "string", "title": "Display Value", "description": "The display value for the creator."}}, "type": "object", "title": "CreatedBy"}, "CronSchedule": {"properties": {"cron": {"type": "string", "title": "Cron", "examples": ["0 0 * * *"]}, "timezone": {"type": "string", "title": "Timezone", "examples": ["America/New_York"]}, "day_or": {"type": "boolean", "title": "Day Or", "description": "Control croniter behavior for handling day and day_of_week entries.", "default": true}}, "additionalProperties": false, "type": "object", "required": ["cron"], "title": "CronSchedule", "description": "Cron schedule\n\nNOTE: If the timezone is a DST-observing one, then the schedule will adjust\nitself appropriately. Cron's rules for DST are based on schedule times, not\nintervals. This means that an hourly cron schedule will fire on every new\nschedule hour, not every elapsed hour; for example, when clocks are set back\nthis will result in a two-hour pause as the schedule will fire *the first\ntime* 1am is reached and *the first time* 2am is reached, 120 minutes later.\nLonger schedules, such as one that fires at 9am every morning, will\nautomatically adjust for DST.\n\nArgs:\n    cron (str): a valid cron string\n    timezone (str): a valid timezone string in IANA tzdata format (for example,\n        America/New_York).\n    day_or (bool, optional): Control how croniter handles `day` and `day_of_week`\n        entries. Defaults to True, matching cron which connects those values using\n        OR. If the switch is set to False, the values are connected using AND. This\n        behaves like fcron and enables you to e.g. define a job that executes each\n        2nd friday of a month by setting the days of month and the weekday."}, "CsrfToken": {"properties": {"id": {"type": "string", "format": "uuid", "title": "Id"}, "created": {"type": "string", "format": "date-time", "title": "Created"}, "updated": {"type": "string", "format": "date-time", "title": "Updated"}, "token": {"type": "string", "title": "Token", "description": "The CSRF token"}, "client": {"type": "string", "title": "Client", "description": "The client id associated with the CSRF token"}, "expiration": {"type": "string", "format": "date-time", "title": "Expiration", "description": "The expiration time of the CSRF token"}}, "type": "object", "required": ["token", "client", "expiration"], "title": "CsrfToken", "description": "A PrefectBaseModel with an auto-generated UUID ID value and created /\nupdated timestamps, intended for compatibility with our standard ORM models.\n\nThe ID, created, and updated fields are reset on copy() and not included in\nequality comparisons."}, "DependencyResult": {"properties": {"id": {"type": "string", "format": "uuid", "title": "Id"}, "name": {"type": "string", "title": "Name"}, "upstream_dependencies": {"items": {"$ref": "#/components/schemas/TaskRunResult"}, "type": "array", "title": "Upstream Dependencies"}, "state": {"$ref": "#/components/schemas/State"}, "expected_start_time": {"type": "string", "format": "date-time", "title": "Expected Start Time"}, "start_time": {"type": "string", "format": "date-time", "title": "Start Time"}, "end_time": {"type": "string", "format": "date-time", "title": "End Time"}, "total_run_time": {"type": "number", "format": "time-delta", "title": "Total Run Time"}, "estimated_run_time": {"type": "number", "format": "time-delta", "title": "Estimated Run Time"}, "untrackable_result": {"type": "boolean", "title": "Untrackable Result"}}, "type": "object", "required": ["id", "name", "upstream_dependencies", "state", "untrackable_result"], "title": "DependencyResult", "description": "A base pydantic.BaseModel for all Prefect schemas and pydantic models.\n\nAs the basis for most Prefect schemas, this base model usually ignores extra\nfields that are passed to it at instantiation. Because adding new fields to\nAPI payloads is not considered a breaking change, this ensures that any\nPrefect client loading data from a server running a possibly-newer version\nof Prefect will be able to process those new fields gracefully. However,\nwhen PREFECT_TEST_MODE is on, extra fields are forbidden in order to catch\nsubtle unintentional testing errors."}, "DeploymentCreate": {"properties": {"infra_overrides": {"type": "object", "title": "Infra Overrides", "description": "Deprecated field. Use `job_variables` instead."}, "name": {"type": "string", "title": "Name", "description": "The name of the deployment.", "examples": ["my-deployment"]}, "flow_id": {"type": "string", "format": "uuid", "title": "Flow Id", "description": "The ID of the flow associated with the deployment."}, "is_schedule_active": {"type": "boolean", "title": "Is Schedule Active", "description": "Whether the schedule is active.", "default": true}, "paused": {"type": "boolean", "title": "Paused", "description": "Whether or not the deployment is paused.", "default": false}, "schedules": {"items": {"$ref": "#/components/schemas/DeploymentScheduleCreate"}, "type": "array", "title": "Schedules", "description": "A list of schedules for the deployment."}, "enforce_parameter_schema": {"type": "boolean", "title": "Enforce Parameter Schema", "description": "Whether or not the deployment should enforce the parameter schema.", "default": false}, "parameter_openapi_schema": {"type": "object", "title": "Parameter Openapi Schema", "description": "The parameter schema of the flow, including defaults."}, "parameters": {"type": "object", "title": "Parameters", "description": "Parameters for flow runs scheduled by the deployment."}, "tags": {"items": {"type": "string"}, "type": "array", "title": "Tags", "description": "A list of deployment tags.", "examples": [["tag-1", "tag-2"]]}, "pull_steps": {"items": {"type": "object"}, "type": "array", "title": "Pull Steps"}, "manifest_path": {"type": "string", "title": "Manifest Path"}, "work_queue_name": {"type": "string", "title": "Work Queue Name"}, "work_pool_name": {"type": "string", "title": "Work Pool Name", "description": "The name of the deployment's work pool.", "examples": ["my-work-pool"]}, "storage_document_id": {"type": "string", "format": "uuid", "title": "Storage Document Id"}, "infrastructure_document_id": {"type": "string", "format": "uuid", "title": "Infrastructure Document Id"}, "schedule": {"anyOf": [{"$ref": "#/components/schemas/IntervalSchedule"}, {"$ref": "#/components/schemas/CronSchedule"}, {"$ref": "#/components/schemas/RRuleSchedule"}], "title": "Schedule", "description": "The schedule for the deployment."}, "description": {"type": "string", "title": "Description"}, "path": {"type": "string", "title": "Path"}, "version": {"type": "string", "title": "Version"}, "entrypoint": {"type": "string", "title": "Entrypoint"}, "job_variables": {"type": "object", "title": "Job Variables", "description": "Overrides for the flow's infrastructure configuration."}}, "additionalProperties": false, "type": "object", "required": ["name", "flow_id"], "title": "DeploymentCreate", "description": "Data used by the Prefect REST API to create a deployment."}, "DeploymentFilter": {"properties": {"operator": {"allOf": [{"$ref": "#/components/schemas/Operator"}], "description": "Operator for combining filter criteria. Defaults to 'and_'.", "default": "and_"}, "id": {"allOf": [{"$ref": "#/components/schemas/DeploymentFilterId"}], "title": "Id", "description": "Filter criteria for `Deployment.id`"}, "name": {"allOf": [{"$ref": "#/components/schemas/DeploymentFilterName"}], "title": "Name", "description": "Filter criteria for `Deployment.name`"}, "paused": {"allOf": [{"$ref": "#/components/schemas/DeploymentFilterPaused"}], "title": "Paused", "description": "Filter criteria for `Deployment.paused`"}, "is_schedule_active": {"allOf": [{"$ref": "#/components/schemas/DeploymentFilterIsScheduleActive"}], "title": "Is Schedule Active", "description": "Filter criteria for `Deployment.is_schedule_active`"}, "tags": {"allOf": [{"$ref": "#/components/schemas/DeploymentFilterTags"}], "title": "Tags", "description": "Filter criteria for `Deployment.tags`"}, "work_queue_name": {"allOf": [{"$ref": "#/components/schemas/DeploymentFilterWorkQueueName"}], "title": "Work Queue Name", "description": "Filter criteria for `Deployment.work_queue_name`"}}, "additionalProperties": false, "type": "object", "title": "DeploymentFilter", "description": "Filter for deployments. Only deployments matching all criteria will be returned."}, "DeploymentFilterId": {"properties": {"any_": {"items": {"type": "string", "format": "uuid"}, "type": "array", "title": "Any ", "description": "A list of deployment ids to include"}}, "additionalProperties": false, "type": "object", "title": "DeploymentFilterId", "description": "Filter by `Deployment.id`."}, "DeploymentFilterIsScheduleActive": {"properties": {"eq_": {"type": "boolean", "title": "Eq ", "description": "Only returns where deployment schedule is/is not active"}}, "additionalProperties": false, "type": "object", "title": "DeploymentFilterIsScheduleActive", "description": "Legacy filter to filter by `Deployment.is_schedule_active` which\nis always the opposite of `Deployment.paused`."}, "DeploymentFilterName": {"properties": {"any_": {"items": {"type": "string"}, "type": "array", "title": "Any ", "description": "A list of deployment names to include", "examples": [["my-deployment-1", "my-deployment-2"]]}, "like_": {"type": "string", "title": "Like ", "description": "A case-insensitive partial match. For example,  passing 'marvin' will match 'marvin', 'sad-Marvin', and 'marvin-robot'.", "examples": ["marvin"]}}, "additionalProperties": false, "type": "object", "title": "DeploymentFilterName", "description": "Filter by `Deployment.name`."}, "DeploymentFilterPaused": {"properties": {"eq_": {"type": "boolean", "title": "Eq ", "description": "Only returns where deployment is/is not paused"}}, "additionalProperties": false, "type": "object", "title": "DeploymentFilterPaused", "description": "Filter by `Deployment.paused`."}, "DeploymentFilterTags": {"properties": {"operator": {"allOf": [{"$ref": "#/components/schemas/Operator"}], "description": "Operator for combining filter criteria. Defaults to 'and_'.", "default": "and_"}, "all_": {"items": {"type": "string"}, "type": "array", "title": "All ", "description": "A list of tags. Deployments will be returned only if their tags are a superset of the list", "examples": [["tag-1", "tag-2"]]}, "is_null_": {"type": "boolean", "title": "Is Null ", "description": "If true, only include deployments without tags"}}, "additionalProperties": false, "type": "object", "title": "DeploymentFilterTags", "description": "Filter by `Deployment.tags`."}, "DeploymentFilterWorkQueueName": {"properties": {"any_": {"items": {"type": "string"}, "type": "array", "title": "Any ", "description": "A list of work queue names to include", "examples": [["work_queue_1", "work_queue_2"]]}}, "additionalProperties": false, "type": "object", "title": "DeploymentFilterWorkQueueName", "description": "Filter by `Deployment.work_queue_name`."}, "DeploymentFlowRunCreate": {"properties": {"state": {"allOf": [{"$ref": "#/components/schemas/StateCreate"}], "title": "State", "description": "The state of the flow run to create"}, "name": {"type": "string", "title": "Name", "description": "The name of the flow run. Defaults to a random slug if not specified.", "examples": ["my-flow-run"]}, "parameters": {"type": "object", "title": "Parameters"}, "context": {"type": "object", "title": "Context"}, "infrastructure_document_id": {"type": "string", "format": "uuid", "title": "Infrastructure Document Id"}, "empirical_policy": {"allOf": [{"$ref": "#/components/schemas/FlowRunPolicy"}], "title": "Empirical Policy", "description": "The empirical policy for the flow run."}, "tags": {"items": {"type": "string"}, "type": "array", "title": "Tags", "description": "A list of tags for the flow run.", "examples": [["tag-1", "tag-2"]]}, "idempotency_key": {"type": "string", "title": "Idempotency Key", "description": "An optional idempotency key. If a flow run with the same idempotency key has already been created, the existing flow run will be returned."}, "parent_task_run_id": {"type": "string", "format": "uuid", "title": "Parent Task Run Id"}, "work_queue_name": {"type": "string", "title": "Work Queue Name"}, "job_variables": {"type": "object", "title": "Job Variables"}}, "additionalProperties": false, "type": "object", "title": "DeploymentFlowRunCreate", "description": "Data used by the Prefect REST API to create a flow run from a deployment."}, "DeploymentResponse": {"properties": {"id": {"type": "string", "format": "uuid", "title": "Id"}, "created": {"type": "string", "format": "date-time", "title": "Created"}, "updated": {"type": "string", "format": "date-time", "title": "Updated"}, "infra_overrides": {"type": "object", "title": "Infra Overrides", "description": "Deprecated field. Use `job_variables` instead."}, "name": {"type": "string", "title": "Name", "description": "The name of the deployment."}, "version": {"type": "string", "title": "Version", "description": "An optional version for the deployment."}, "description": {"type": "string", "title": "Description", "description": "A description for the deployment."}, "flow_id": {"type": "string", "format": "uuid", "title": "Flow Id", "description": "The flow id associated with the deployment."}, "schedule": {"anyOf": [{"$ref": "#/components/schemas/IntervalSchedule"}, {"$ref": "#/components/schemas/CronSchedule"}, {"$ref": "#/components/schemas/RRuleSchedule"}], "title": "Schedule", "description": "A schedule for the deployment."}, "is_schedule_active": {"type": "boolean", "title": "Is Schedule Active", "description": "Whether or not the deployment schedule is active.", "default": true}, "paused": {"type": "boolean", "title": "Paused", "description": "Whether or not the deployment is paused.", "default": false}, "schedules": {"items": {"$ref": "#/components/schemas/DeploymentSchedule"}, "type": "array", "title": "Schedules", "description": "A list of schedules for the deployment."}, "job_variables": {"type": "object", "title": "Job Variables", "description": "Overrides to apply to the base infrastructure block at runtime."}, "parameters": {"type": "object", "title": "Parameters", "description": "Parameters for flow runs scheduled by the deployment."}, "tags": {"items": {"type": "string"}, "type": "array", "title": "Tags", "description": "A list of tags for the deployment", "examples": [["tag-1", "tag-2"]]}, "work_queue_name": {"type": "string", "title": "Work Queue Name", "description": "The work queue for the deployment. If no work queue is set, work will not be scheduled."}, "last_polled": {"type": "string", "format": "date-time", "title": "Last Polled", "description": "The last time the deployment was polled for status updates."}, "parameter_openapi_schema": {"type": "object", "title": "Parameter Openapi Schema", "description": "The parameter schema of the flow, including defaults."}, "path": {"type": "string", "title": "Path", "description": "The path to the working directory for the workflow, relative to remote storage or an absolute path."}, "pull_steps": {"items": {"type": "object"}, "type": "array", "title": "Pull Steps", "description": "Pull steps for cloning and running this deployment."}, "entrypoint": {"type": "string", "title": "Entrypoint", "description": "The path to the entrypoint for the workflow, relative to the `path`."}, "manifest_path": {"type": "string", "title": "Manifest Path", "description": "The path to the flow's manifest file, relative to the chosen storage."}, "storage_document_id": {"type": "string", "format": "uuid", "title": "Storage Document Id", "description": "The block document defining storage used for this flow."}, "infrastructure_document_id": {"type": "string", "format": "uuid", "title": "Infrastructure Document Id", "description": "The block document defining infrastructure to use for flow runs."}, "created_by": {"allOf": [{"$ref": "#/components/schemas/CreatedBy"}], "title": "Created By", "description": "Optional information about the creator of this deployment."}, "updated_by": {"allOf": [{"$ref": "#/components/schemas/UpdatedBy"}], "title": "Updated By", "description": "Optional information about the updater of this deployment."}, "work_pool_name": {"type": "string", "title": "Work Pool Name", "description": "The name of the deployment's work pool."}, "status": {"allOf": [{"$ref": "#/components/schemas/DeploymentStatus"}], "description": "Whether the deployment is ready to run flows.", "default": "NOT_READY"}, "enforce_parameter_schema": {"type": "boolean", "title": "Enforce Parameter Schema", "description": "Whether or not the deployment should enforce the parameter schema.", "default": false}}, "type": "object", "required": ["name", "flow_id"], "title": "DeploymentResponse", "description": "A model mixin that handles the deprecated `infra_overrides` field.\n\nThe `infra_overrides` field has been renamed to `job_variables`. This mixin maintains\nbackwards compatibility with users of the `infra_overrides` field while presenting\n`job_variables` as the user-facing field.\n\nWhen we remove support for `infra_overrides`, we can remove this class as a parent of\nall schemas that use it, leaving them with only the `job_variables` field."}, "DeploymentSchedule": {"properties": {"id": {"type": "string", "format": "uuid", "title": "Id"}, "created": {"type": "string", "format": "date-time", "title": "Created"}, "updated": {"type": "string", "format": "date-time", "title": "Updated"}, "deployment_id": {"type": "string", "format": "uuid", "title": "Deployment Id", "description": "The deployment id associated with this schedule."}, "schedule": {"anyOf": [{"$ref": "#/components/schemas/IntervalSchedule"}, {"$ref": "#/components/schemas/CronSchedule"}, {"$ref": "#/components/schemas/RRuleSchedule"}], "title": "Schedule", "description": "The schedule for the deployment."}, "active": {"type": "boolean", "title": "Active", "description": "Whether or not the schedule is active.", "default": true}}, "type": "object", "required": ["schedule"], "title": "DeploymentSchedule", "description": "A PrefectBaseModel with an auto-generated UUID ID value and created /\nupdated timestamps, intended for compatibility with our standard ORM models.\n\nThe ID, created, and updated fields are reset on copy() and not included in\nequality comparisons."}, "DeploymentScheduleCreate": {"properties": {"active": {"type": "boolean", "title": "Active", "description": "Whether or not the schedule is active.", "default": true}, "schedule": {"anyOf": [{"$ref": "#/components/schemas/IntervalSchedule"}, {"$ref": "#/components/schemas/CronSchedule"}, {"$ref": "#/components/schemas/RRuleSchedule"}], "title": "Schedule", "description": "The schedule for the deployment."}}, "additionalProperties": false, "type": "object", "required": ["schedule"], "title": "DeploymentScheduleCreate", "description": "A base pydantic.BaseModel for all Prefect schemas and pydantic models.\n\nAs the basis for most Prefect schemas, this base model usually ignores extra\nfields that are passed to it at instantiation. Because adding new fields to\nAPI payloads is not considered a breaking change, this ensures that any\nPrefect client loading data from a server running a possibly-newer version\nof Prefect will be able to process those new fields gracefully. However,\nwhen PREFECT_TEST_MODE is on, extra fields are forbidden in order to catch\nsubtle unintentional testing errors."}, "DeploymentScheduleUpdate": {"properties": {"active": {"type": "boolean", "title": "Active", "description": "Whether or not the schedule is active."}, "schedule": {"anyOf": [{"$ref": "#/components/schemas/IntervalSchedule"}, {"$ref": "#/components/schemas/CronSchedule"}, {"$ref": "#/components/schemas/RRuleSchedule"}], "title": "Schedule", "description": "The schedule for the deployment."}}, "additionalProperties": false, "type": "object", "title": "DeploymentScheduleUpdate", "description": "A base pydantic.BaseModel for all Prefect schemas and pydantic models.\n\nAs the basis for most Prefect schemas, this base model usually ignores extra\nfields that are passed to it at instantiation. Because adding new fields to\nAPI payloads is not considered a breaking change, this ensures that any\nPrefect client loading data from a server running a possibly-newer version\nof Prefect will be able to process those new fields gracefully. However,\nwhen PREFECT_TEST_MODE is on, extra fields are forbidden in order to catch\nsubtle unintentional testing errors."}, "DeploymentSort": {"type": "string", "enum": ["CREATED_DESC", "UPDATED_DESC", "NAME_ASC", "NAME_DESC"], "title": "DeploymentSort", "description": "Defines deployment sorting options."}, "DeploymentStatus": {"type": "string", "enum": ["READY", "NOT_READY"], "title": "DeploymentStatus", "description": "Enumeration of deployment statuses."}, "DeploymentUpdate": {"properties": {"infra_overrides": {"type": "object", "title": "Infra Overrides", "description": "Deprecated field. Use `job_variables` instead."}, "version": {"type": "string", "title": "Version"}, "schedule": {"anyOf": [{"$ref": "#/components/schemas/IntervalSchedule"}, {"$ref": "#/components/schemas/CronSchedule"}, {"$ref": "#/components/schemas/RRuleSchedule"}], "title": "Schedule", "description": "The schedule for the deployment."}, "description": {"type": "string", "title": "Description"}, "is_schedule_active": {"type": "boolean", "title": "Is Schedule Active", "description": "Whether the schedule is active.", "default": true}, "paused": {"type": "boolean", "title": "Paused", "description": "Whether or not the deployment is paused.", "default": false}, "schedules": {"items": {"$ref": "#/components/schemas/DeploymentScheduleCreate"}, "type": "array", "title": "Schedules", "description": "A list of schedules for the deployment."}, "parameters": {"type": "object", "title": "Parameters", "description": "Parameters for flow runs scheduled by the deployment."}, "tags": {"items": {"type": "string"}, "type": "array", "title": "Tags", "description": "A list of deployment tags.", "examples": [["tag-1", "tag-2"]]}, "work_queue_name": {"type": "string", "title": "Work Queue Name"}, "work_pool_name": {"type": "string", "title": "Work Pool Name", "description": "The name of the deployment's work pool.", "examples": ["my-work-pool"]}, "path": {"type": "string", "title": "Path"}, "job_variables": {"type": "object", "title": "Job Variables", "description": "Overrides for the flow's infrastructure configuration."}, "entrypoint": {"type": "string", "title": "Entrypoint"}, "manifest_path": {"type": "string", "title": "Manifest Path"}, "storage_document_id": {"type": "string", "format": "uuid", "title": "Storage Document Id"}, "infrastructure_document_id": {"type": "string", "format": "uuid", "title": "Infrastructure Document Id"}, "enforce_parameter_schema": {"type": "boolean", "title": "Enforce Parameter Schema", "description": "Whether or not the deployment should enforce the parameter schema."}}, "additionalProperties": false, "type": "object", "title": "DeploymentUpdate", "description": "Data used by the Prefect REST API to update a deployment."}, "DoNothing": {"properties": {"type": {"type": "string", "enum": ["do-nothing"], "title": "Type", "default": "do-nothing"}}, "type": "object", "title": "DoNothing", "description": "Do nothing when an Automation is triggered"}, "Edge": {"properties": {"id": {"type": "string", "format": "uuid", "title": "Id"}}, "type": "object", "required": ["id"], "title": "Edge", "description": "A base pydantic.BaseModel for all Prefect schemas and pydantic models.\n\nAs the basis for most Prefect schemas, this base model usually ignores extra\nfields that are passed to it at instantiation. Because adding new fields to\nAPI payloads is not considered a breaking change, this ensures that any\nPrefect client loading data from a server running a possibly-newer version\nof Prefect will be able to process those new fields gracefully. However,\nwhen PREFECT_TEST_MODE is on, extra fields are forbidden in order to catch\nsubtle unintentional testing errors."}, "Event": {"properties": {"occurred": {"type": "string", "format": "date-time", "title": "Occurred", "description": "When the event happened from the sender's perspective"}, "event": {"type": "string", "title": "Event", "description": "The name of the event that happened"}, "resource": {"allOf": [{"$ref": "#/components/schemas/Resource"}], "title": "Resource", "description": "The primary Resource this event concerns"}, "related": {"items": {"$ref": "#/components/schemas/RelatedResource"}, "type": "array", "title": "Related", "description": "A list of additional Resources involved in this event"}, "payload": {"type": "object", "title": "Payload", "description": "An open-ended set of data describing what happened"}, "id": {"type": "string", "format": "uuid", "title": "Id", "description": "The client-provided identifier of this event"}, "follows": {"type": "string", "format": "uuid", "title": "Follows", "description": "The ID of an event that is known to have occurred prior to this one. If set, this may be used to establish a more precise ordering of causally-related events when they occur close enough together in time that the system may receive them out-of-order."}}, "type": "object", "required": ["occurred", "event", "resource", "id"], "title": "Event", "description": "The client-side view of an event that has happened to a Resource"}, "EventTrigger": {"properties": {"type": {"type": "string", "enum": ["event"], "title": "Type", "default": "event"}, "id": {"type": "string", "format": "uuid", "title": "Id", "description": "The unique ID of this trigger"}, "match": {"allOf": [{"$ref": "#/components/schemas/ResourceSpecification"}], "title": "Match", "description": "Labels for resources which this trigger will match."}, "match_related": {"allOf": [{"$ref": "#/components/schemas/ResourceSpecification"}], "title": "Match Related", "description": "Labels for related resources which this trigger will match."}, "after": {"items": {"type": "string"}, "type": "array", "uniqueItems": true, "title": "After", "description": "The event(s) which must first been seen to fire this trigger.  If empty, then fire this trigger immediately.  Events may include trailing wildcards, like `prefect.flow-run.*`"}, "expect": {"items": {"type": "string"}, "type": "array", "uniqueItems": true, "title": "Expect", "description": "The event(s) this trigger is expecting to see.  If empty, this trigger will match any event.  Events may include trailing wildcards, like `prefect.flow-run.*`"}, "for_each": {"items": {"type": "string"}, "type": "array", "uniqueItems": true, "title": "For Each", "description": "Evaluate the trigger separately for each distinct value of these labels on the resource.  By default, labels refer to the primary resource of the triggering event.  You may also refer to labels from related resources by specifying `related::