wizard

Get a setup run's status

Changed on

Get the status of a cloud setup run, its task list, the pull request link once it exists, and a next step to relay to the user.

get/api/projects/{project_id}/wizard/installs/{run_id}/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/wizard/installs/{run_id}/
  • Auth: HTTP bearer

Path parameters

project_idstring required

Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

run_idstring required

Response

status'created' | 'running' | 'completed' | 'failed' | 'cancelled' required
  • created - created
  • running - running
  • completed - completed
  • failed - failed
  • cancelled - cancelled
error_codestring nullable required

Machine-readable failure reason, or null if the run has not failed.

error_messagestring nullable required

Failure explanation, or null if the run has not failed.

pull_request_urlstring uri nullable required

Pull request with the setup changes, or null until the run opens one.

next_stepstring required

What happens next, in a sentence to relay to the user.

Changes