ReferenceHTTP APIWorkspace settings

Every GitHub App connection of the workspace (owner or admin)

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

Each registered App connection, author ones first and oldest first within a role, with its connection_id, as stored: nothing is asked of GitHub. A role may have several connections; …/github-apps/{connection_id} reads, rotates the key of, or removes one. 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 connections; never a private key.

application/json
  1. response
github_apps*array<>
Example Request
curl -X GET 'https://example.com/v1/workspaces/497f6eca-6276-4993-bfeb-53cbbbba6f08/github-apps'
Example Response
{  "github_apps": []}