Public API to get Workflow build Status

 

Currently we use the public API to get the status of our master builds. However, since we have moved over everything to use Circle 2 and have started using workflows the existing api is insufficient. I know you added an api to launch workflows but how about getting the status of a workflow. Is this something you can add to the API? It would be immensely valuable for us as we run continuous deploy and need to know as soon as possible when a master build fails.

 

  • Guest
  • Aug 24 2018
  • Shipped
API
  • Attach files
  • Admin
    Liya Ai commented
    15 Jul 18:50

    As part of our effort to be more responsive to feature requests, we wanted to close the loop on this. In December of last year, we shipped the API V2 & you should be able to get build status from the API endpoint. More info here: https://circleci.com/docs/api/v2/#get-a-workflow

  • Guest commented
    December 24, 2019 03:04

    Are there any plans to update the UI to use this API so that unauthenticated users can view open source projects' workflows? (Related - https://ideas.circleci.com/ideas/CCI-I-903)

  • Nathan Dintenfass commented
    July 31, 2019 05:43

    We are now in live preview release of our v2 API that has what most folks on this thread are looking for. Please take a look, and let us know if this will suit your needs: https://github.com/CircleCI-Public/api-preview-docs

  • Jean-Sébatien DIDIERLAURENT commented
    April 07, 2019 16:44

    Any updates on this ? :)

  • Nathan Dintenfass commented
    March 18, 2019 17:22

    @Rafael We are preparing to roll out a new version of the API that will include this. I hope to have a preview available "soon" -- will update here as it becomes available.

  • Rafael Petry commented
    March 18, 2019 15:10

    Nathan, any update on this, and where it sits relative to other priorities?

  • James Turley commented
    February 11, 2019 09:55

    Excellent news - thanks.

  • Nathan Dintenfass commented
    February 11, 2019 07:11

    This work is now in our "next up" pool - we are very aware of the need.

  • Rafael Petry commented
    February 11, 2019 04:38

    Any updates on this? Our team was previously using the CCTray feed for our build monitor (https://circleci.com/cc.xml?circle-token=<api-token>), but since moving to Circle 2 that is no longer useful, since it only returns the last build status, even if something else in the workflow failed.

  • George Speake commented
    January 24, 2019 00:22
  • James Turley commented
    January 11, 2019 10:14

    Additionally, we put time and effort into optimising our build times. This often ends up being a tradeoff between parallelism and queue time, so easy ac cess to information about workflows would help us great deal, even if it was just two timestamps for queued_at and stopped_at and a status. There are workarounds - by reducing over the job queue - but these are quite unwieldy in practice and make it very difficult, for example, to publish timings as a single Prometheus data point or something like that. Thanks for considering!