I am looking at docs here: CircleCI API and for status it says required but doesn’t show what could be the possible values. Where can i find the list of those values.
Hello,
The possible values for status are as follows:
- “success”
- “running”
- “not_run”
- “failed”
- “error”
- “failing”
- “on_hold”
- “canceled”
- “unauthorized”
This information can also be found by clicking on RESPONSE SCHEMA for each endpoint in the documentation.
The status key is required to be sent in the response from the API, but is not required to pass in when making a request to the API on your end. I believe for the endpoint you have linked to, only the workflow id is required.
Let me know if you have any additional questions regarding this.
I couldn’t find that response schema thats why i had to post it here. Also, where do blocked, queued fit in? are they part of the status as well? I have definitely seen jobs which are in these status.
@ryeparrotsavannahrye My apologies as the values I stated above were the possible statuses for workflows. You are correct in that the response schema is not listed for jobs. The possible values for job status are as follows:
- “unauthorized”
- “not_run”
- “queued”
- “not_running”
- “on_hold”
- “blocked”
- “running”
- “canceled”
- “infrastructure_fail”
- “retried”
- “timedout”
- “failed”
- “success”
- “terminated-unknown”
Thanks. Are they listed somewhere in documentation? Moving forward if i have to verify if any of these has cahnged or a new value has been added, how would i do that?
@ryeparrotsavannahrye
I believe the best way to check for updates in the future is to reference:
https://circleci.com/api/v2/openapi.yml
or
https://circleci.com/api/v2/openapi.json
The job statues are not currently publicly documented in one location, but we are working on getting the documentation updated.
Hello,
I was trying to find job statuses in the api docs and it seems they still have not been added. Is there a plan to? It’s been close to a year.