Join Slack

Not obvious how I get the current status of a flow run via the REST API

# ask-community

Tony Piazza

01/27/2023, 10:33 PM

Not obvious how I get the current status of a flow run via the REST API

Zanie

01/27/2023, 10:34 PM

Using the Python client or another HTTP client?

Tony Piazza

01/27/2023, 10:34 PM

Another client

Tony Piazza

01/27/2023, 10:34 PM

So I need raw request

Zanie

01/27/2023, 10:35 PM

Is the documentation here sufficient? https://app.prefect.cloud/api/docs#tag/Flow-Runs/operation/read_flow_run_api_accounts__account_id__workspaces__workspace_id__flow_runs__id__get

James Gatter

01/27/2023, 10:35 PM

I did this in curl:

James Gatter

01/27/2023, 10:35 PM

Copy code

curl -X GET \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    <http://127.0.0.1:4200/api/health>

James Gatter

01/27/2023, 10:36 PM

Ah sorry that's for my Orion instance, not a flow

Zanie

01/27/2023, 10:36 PM

If you’re running the API locally, it’s easy to view the documentation at http://localhost:4200/api/docs

Zanie

01/27/2023, 10:36 PM

http://localhost:4200/api/docs#/Flow%20Runs/read_flow_run_flow_runs__id__get

Zanie

01/27/2023, 10:37 PM

The state is attached to the returned flow run, presumably you’re interested in the state’s type which is an enum.

Tony Piazza

01/27/2023, 10:38 PM

We need this on the front end to query the state of the flow launched via a deployment

Tony Piazza

01/27/2023, 10:53 PM

This is exactly what I needed. Thanks @Zanie and @James Gatter for your fast response. Have an awesome weekend!

122 Views

Open in Slack

Previous Next

Prefect Community

Bring your towel and join one of the fastest growing data communities. Welcome to our second-generation open source orchestration platform, a completely rethought approach to dataflow automation.