リファレンスHTTP APIWorkspace settings

The workspace's GitHub App and where it is installed (owner or admin)

GET
/v1/workspaces/{id}/github-app

The App registered in the console (its id, name and page, and when and by whom the private key was last set; never the key), then GitHub's answer for it now, asked with the App's own JWT: its installations, and for each catalog repository written as auth: { kind: github_app } the installation that covers it (null when the App is not installed there). check is null with no App registered, and failed when GitHub did not answer (github_unreachable) or refused the App (github_rejected: a revoked key or a deleted App). API keys are refused.

Auth: cookie session only; no scope.

Authorization

cookieSession
cookie__Host-werft_session<token>

For the web console: the browser session cookie set by POST /v1/auth/login. It holds the scopes of the user's workspace role (owner: all; admin and member: all but sessions:recover). Requests other than GET must also send X-Requested-With: werft-web.

Path Parameters

id*string

The workspace's id.

Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid

Response Body

The App and its installations; never the private key.

application/json
  1. response
github_app*|null
check*||null
installations*array<>
repositories*array<>
manifest_blocked?|null
usage?|null
Example Request
curl -X GET 'https://example.com/v1/workspaces/497f6eca-6276-4993-bfeb-53cbbbba6f08/github-app'
Example Response
{  "github_app": {    "app_id": 123456,    "slug": "acme-agents",    "name": "Acme agents",    "html_url": "https://github.com/apps/acme-agents",    "private_key": {      "updated_at": "2026-10-30T09:00:00Z",      "updated_by": {        "user_id": "3e7f1a90-5c2d-4b8e-8f61-2a9d0c4b7e35",        "display_name": "Jae"      }    },    "created_at": "2026-10-30T09:00:00Z",    "updated_at": "2026-10-30T09:00:00Z"  },  "check": {    "state": "ok"  },  "installations": [    {      "id": 7654321,      "account": "acme",      "repository_selection": "selected",      "html_url": "https://github.com/organizations/acme/settings/installations/7654321"    }  ],  "repositories": [    {      "id": "app",      "url": "https://github.com/acme/app.git",      "installation_id": 7654321    }  ]}