{"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"push-status","__idx":0},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["push-status"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This command is used with Reunite products only."," ","It provides details about files, deployments, and API scorecards, using a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["<pushId>"]}," that is returned by an earlier ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["push"]}," command."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["push-status"]}," command can be used whenever the application or process executing a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["push"]}," command (without ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["--wait-for-deployment"]}," option) returns the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pushId"]},"."," ","This identifier can be used by subsequent systems to perform custom logic when the deployment is completed."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"prerequisites","__idx":1},"children":["Prerequisites"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Have the following before you use the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["push-status"]}," command:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A user account in a ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"https://auth.cloud.redocly.com/"},"children":["Reunite project"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["An active organization ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"https://redocly.com/docs/realm/setup/how-to/api-keys"},"children":["API key"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/cli/v2/installation"},"children":["Redocly CLI"]}," v1.10.x or later."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"authentication","__idx":2},"children":["Authentication"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["REDOCLY_AUTHORIZATION"]}," environment variable to set the API key."," ","See the ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"https://redocly.com/docs/realm/setup/how-to/api-keys"},"children":["Manage API keys"]}," page in the documentation for details on how to get your API key in Reunite."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"usage","__idx":3},"children":["Usage"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"REDOCLY_AUTHORIZATION=<api-key> redocly push-status <pushId> --organization <organizationId> --project <projectId> [--wait] [--continue-on-deploy-failures] [--max-execution-time <timeInSeconds>]\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"options","__idx":4},"children":["Options"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Option"},"children":["Option"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["pushId"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["REQUIRED."]}," Identifier of the push you are tracking. Returned as result of the ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/cli/v2/commands/push"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["push"]}]}," command."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["--organization, -o"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["REQUIRED."]}," ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"#find-ids"},"children":["Organization ID"]},", for example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["org_01h1s5z6vf2mm1mz3hevnn9va7"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["--project, -p"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["REQUIRED."]}," ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"#find-ids"},"children":["Project ID"]},", for example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prj_01hh1t9sa6gwfv5naz04gr7ehm"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["--domain, -d"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The domain that the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["push"]}," command pushed to. Default value is ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"https://app.cloud.redocly.com"},"children":["https://app.cloud.redocly.com"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["--wait"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Waits until the build is completed if it is in progress. Default value is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["--max-execution-time"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["number"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Maximum wait time for build completion in seconds (used in conjunction with the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["--wait"]}," option). Default value is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["1200"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["--continue-on-deploy-failures"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Prevents the command from returning a non-zero exit code when the deployment fails. Default value is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]},"."]}]}]}]}]},{"$$mdtype":"Tag","name":"details","attributes":{},"children":[{"$$mdtype":"Tag","name":"summary","attributes":{},"children":["How to find the organization and project IDs",{"$$mdtype":"Tag","name":"Link","attributes":{"id":"find-ids"},"children":[]}]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Log in to Reunite."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Open ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Organization settings"]}," and copy the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Organization ID"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Open the project and copy the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Project ID"]}," from ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Project settings"]},"."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Organization and project slugs are still accepted and resolved to IDs, but they are deprecated."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"examples","__idx":5},"children":["Examples"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["push"]}," is performed from the repository's default branch, a preview build is automatically followed by a production build; this command can send only the completed builds or wait for uncompleted builds to complete."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"get-the-build-status-of-a-specific-push","__idx":6},"children":["Get the build status of a specific push"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following example command prints the status of completed preview and production builds as well as scorecards if they exist for the push with the ID ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["push_01hkw0p0wg348n3gtxmv8rt6hy"]}," in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["redocly"]}," organization and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["awesome-api-docs"]}," project:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"REDOCLY_AUTHORIZATION='api-key' redocly push-status push_01hkw0p0wg348n3gtxmv8rt6hy -o=org_01h1s5z6vf2mm1mz3hevnn9va7 -p=prj_01hh1t9sa6gwfv5naz04gr7ehm\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If there are preview or production builds that haven't completed yet for the push ID, they are not included in the output of this command."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"get-build-status-for-a-specific-push-and-wait-until-it-is-completed","__idx":7},"children":["Get build status for a specific push and wait until it is completed"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can configure the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["push-status"]}," command to check the deployment statuses of the preview build (and subsequent production build if applicable), and if the builds are not complete, check every 5 seconds until the builds are complete."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following example command prints the status for the preview and production builds as well as scorecards if they exist for the push with the ID ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["push_01hkw0p0wg348n3gtxmv8rt6hy"]}," in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["redocly"]}," organization and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["awesome-api-docs"]}," project:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"REDOCLY_AUTHORIZATION='api-key' redocly push-status push_01hkw0p0wg348n3gtxmv8rt6hy -o=org_01h1s5z6vf2mm1mz3hevnn9va7 -p=prj_01hh1t9sa6gwfv5naz04gr7ehm --wait\n","lang":"bash"},"children":[]}]},"frontmatter":{},"tagList":["html"],"title":"push-status","lastModified":"2026-10-05T07:10:52.000Z"}