wizard

Start a setup run

Changed on

Start the setup agent in the cloud on a GitHub repository of this project. It adds PostHog to the code and opens a pull request. Each user can have one setup run active per project at a time.

post/api/projects/{project_id}/wizard/installs/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/wizard/installs/
  • 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/.

Request body

repositorystring required

GitHub repository to set up, in owner/name format. The project's GitHub connection must have access to it.

branchstring

Branch to start from and to open the pull request against. Defaults to the repository's default branch.

idempotency_keystring

Unique key for this request. A retry with the same key returns the same run instead of starting another.

Response

A retry returned the run it already started.

run_idstring uuid required

ID of the setup run. Pass it to the status endpoint.

status'created' | 'running' | 'completed' | 'failed' | 'cancelled' required
  • created - created
  • running - running
  • completed - completed
  • failed - failed
  • cancelled - cancelled
urlstring uri required

PostHog page where the user can follow their setup runs.

Changes