Skip to main content
GET
Get an onboarding app

Authorizations

ankra_session
string
cookie
required

Browser session. Mutations also require X-Ankra-CSRF.

Path Parameters

app_id
string<uuid>
required

Response

The onboarding app.

The onboarding wizard's app: an existing repository registered as an application on the cluster, with AI code review, pull request previews, backups, merge-when-green on the setup pull request and the first deploy turned on. The id is the application's id.

id
string<uuid>
required
cluster_id
string<uuid>
required
application_id
string<uuid> | null
required
repository
string
required

owner/name of the repository.

state
enum<string>
required
Available options:
setting_up,
live,
failed
url
string | null
required

The app's public address once known.

message
string | null
required

One user-facing sentence for the current state.

steps
OnboardingAppStep · object[]
required

Always all seven steps, in the order application, pipeline, code_review, previews, backups, auto_merge, deploy.

dependencies
enum<string>[]
required
Available options:
postgres,
redis,
mongodb,
mysql
created_at
string<date-time>
required
updated_at
string<date-time>
required