Skip to content
SupaCloud Docs
Select themeSelect language

`GET /api/organization/runners/onboarding-status` — whether owner runner-onboarding is enabled instance-wide (#716 E-6). Any active org member may read (`OrgAction::Read`); the FE gates the Enroll CTA on it. A small dedicated read so the array-shaped `GET /api/organization/runners` list contract stays untouched.

GET
/api/organization/runners/onboarding-status
curl --request GET \
  --url https://example.com/api/organization/runners/onboarding-status

Responses

Section titled “Responses”

200

Section titled “200”

Whether owner runner-onboarding is enabled instance-wide

Media typeapplication/json

The org-runner onboarding capability (#716 E-6). Whether the instance-global runner_onboarding_by_owner switch is on — the org Enroll CTA reads this so it can disable-with-tooltip instead of opening the wizard just to have the mint 403.

object
owner_onboarding_enabled
required

True when an org owner may self-enroll an edge runner (the fail-closed global runner_onboarding_by_owner switch, absent ⇒ false = system-admin-only onboarding).

boolean
Examplegenerated
{
  "owner_onboarding_enabled": true
}

401

Section titled “401”

Authentication required

Media typeapplication/json

The canonical JSON body of every error response — the single source of truth the frontend binds to. Every AppError serializes as this exact shape, and the generated OpenAPI component ApiErrorBody (with its ErrorCode enum) is what the frontend error schema is generated from, so there is no hand-written error schema on either end.

object
code
required

Machine-readable, stable error code.

string
Allowed values: not_found unauthorized forbidden bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited quota_exceeded database_error docker_error vault_error internal_error
details
One of:
null
error
required

Human-readable message (the server’s English text; the client may localize by code).

string
Example
{
  "code": "not_found"
}

403

Section titled “403”

Organization access required

Media typeapplication/json

The canonical JSON body of every error response — the single source of truth the frontend binds to. Every AppError serializes as this exact shape, and the generated OpenAPI component ApiErrorBody (with its ErrorCode enum) is what the frontend error schema is generated from, so there is no hand-written error schema on either end.

object
code
required

Machine-readable, stable error code.

string
Allowed values: not_found unauthorized forbidden bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited quota_exceeded database_error docker_error vault_error internal_error
details
One of:
null
error
required

Human-readable message (the server’s English text; the client may localize by code).

string
Example
{
  "code": "not_found"
}

500

Section titled “500”

Structured server error

Media typeapplication/json

The canonical JSON body of every error response — the single source of truth the frontend binds to. Every AppError serializes as this exact shape, and the generated OpenAPI component ApiErrorBody (with its ErrorCode enum) is what the frontend error schema is generated from, so there is no hand-written error schema on either end.

object
code
required

Machine-readable, stable error code.

string
Allowed values: not_found unauthorized forbidden bad_request unprocessable precondition_failed conflict method_not_allowed rate_limited quota_exceeded database_error docker_error vault_error internal_error
details
One of:
null
error
required

Human-readable message (the server’s English text; the client may localize by code).

string
Example
{
  "code": "not_found"
}