workflow-migration

Get Migration Plan

Every job in the repository's workflows, and what would change.

Read-only. Returns permissions_pending rather than an error when the GitHub App installation has not yet been granted the permissions this needs — that is an expected state for every installation predating the permission change, not a failure.

get/workflow-migration/plan

Request

  • Base URL: https://api.incredibuild.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.incredibuild.com/workflow-migration/plan
  • Auth: HTTP bearer

Query parameters

repositorystring nullable

Repository to inspect, as "owner/repo", exactly as the user selected it in the previous wizard step. Resolved against this tenant's own hosted grids, so it can only ever name a repository the tenant has already set up a runner for; anything else answers state no_runner, with nothing read from GitHub. Preferred over grid_public_id.

grid_public_idstring uuid nullable

Hosted grid whose repository to inspect. Kept for the add-another-runner surface, which holds a grid id rather than a repository. With neither given, the tenant's most recent GitHub grid is used -- the returning-user entry, which opens straight on this step with nothing selected.

Headers

x-public-tenant-idstring uuid nullable
x-public-user-idstring uuid nullable

Response

Successful Response

state'ready' | 'permissions_pending' | 'no_workflows' | 'existing_pr' | 'service_unavailable' | 'service_not_configured' | 'rate_limited' | 'app_not_installed' | 'app_credentials_rejected' | 'repository_not_accessible' | 'repository_moved' | 'no_runner' | 'archived' | 'error' required
repo_full_namestring nullable
default_branchstring nullable
target_labelstring required
existing_pr_urlstring nullable
missing_permissionsstring[]

Changes

No recorded changes to this operation across all 1 revision of this API.