GET /api/openapi.json; no token is needed to read it. Customer data and deployment operations still require authentication. The interactive reference is in the app.
Authenticated operations accept Authorization: Bearer $SPRINGWINTER_TOKEN. Cookie mutations require a CSRF token. Signed webhooks use their own signature checks. Read each operation’s security setting.
POST /api/github/installation_setup
Start GitHub App install
Stores a CSRF-like state and an allowlisted return page in the session. Returns the GitHub App install URL. Only /onboarding?step=github selects onboarding; other values use Source control settings.
{
"tags": [
"GitHub"
],
"summary": "Start GitHub App install",
"description": "Stores a CSRF-like `state` and an allowlisted return page in the session. Returns the GitHub App install URL. Only `/onboarding?step=github` selects onboarding; other values use Source control settings.",
"operationId": "createGithubInstallationSetup",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"return_to": {
"type": "string",
"enum": [
"/onboarding?step=github",
"/dashboard/settings/source"
]
}
}
}
}
}
},
"responses": {
"200": {
"description": "Redirect the browser to `install_url`",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"state",
"install_url"
],
"properties": {
"state": {
"type": "string"
},
"install_url": {
"type": "string",
"format": "uri"
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthenticated"
},
"422": {
"$ref": "#/components/responses/InvalidCsrf"
}
},
"parameters": []
}
GET /api/github/installations
List GitHub App installations
{
"tags": [
"GitHub"
],
"summary": "List GitHub App installations",
"operationId": "listGithubInstallations",
"responses": {
"200": {
"description": "Remembered installations",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"installations"
],
"properties": {
"installations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GithubInstallation"
}
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthenticated"
}
},
"parameters": []
}
POST /api/github/installations
Complete GitHub App install
{
"tags": [
"GitHub"
],
"summary": "Complete GitHub App install",
"operationId": "createGithubInstallation",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"installation"
],
"properties": {
"installation": {
"type": "object",
"required": [
"installation_id",
"state"
],
"properties": {
"installation_id": {
"type": "string"
},
"setup_action": {
"type": "string"
},
"state": {
"type": "string"
}
}
}
}
}
}
}
},
"responses": {
"201": {
"description": "Installation stored. Return the browser to the session return_to page.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"installation"
],
"properties": {
"installation": {
"$ref": "#/components/schemas/GithubInstallation"
},
"return_to": {
"type": "string",
"enum": [
"/onboarding?step=github",
"/dashboard/settings/source"
]
}
}
}
}
}
},
"400": {
"$ref": "#/components/responses/InvalidParameters"
},
"401": {
"$ref": "#/components/responses/Unauthenticated"
},
"422": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"enum": [
"invalid_install_state",
"installation_unavailable",
"invalid_csrf_token"
]
},
"return_to": {
"type": "string"
}
},
"required": [
"error"
]
}
}
}
}
},
"parameters": []
}
DELETE /api/github/installations/{installation_id}
Forget a GitHub installation
{
"tags": [
"GitHub"
],
"summary": "Forget a GitHub installation",
"operationId": "deleteGithubInstallation",
"parameters": [
{
"$ref": "#/components/parameters/InstallationId"
}
],
"responses": {
"204": {
"description": "Removed"
},
"401": {
"$ref": "#/components/responses/Unauthenticated"
},
"404": {
"description": "Unknown installation"
},
"422": {
"$ref": "#/components/responses/InvalidCsrf"
}
}
}
GET /api/github/installations/{installation_id}/repositories
List installation repositories
{
"tags": [
"GitHub"
],
"summary": "List installation repositories",
"operationId": "listGithubRepositories",
"parameters": [
{
"$ref": "#/components/parameters/InstallationId"
}
],
"responses": {
"200": {
"description": "Repository full names",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"repositories"
],
"properties": {
"repositories": {
"type": "array",
"items": {
"type": "object",
"required": [
"full_name"
],
"properties": {
"full_name": {
"type": "string"
}
}
}
}
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Unauthenticated"
},
"404": {
"description": "Unknown installation"
},
"422": {
"description": "GitHub API unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
},
"example": {
"error": "repositories_unavailable"
}
}
}
}
}
}
POST /api/github/webhook
GitHub App webhook
Unauthenticated. Verifies X-Hub-Signature-256 with the app webhook secret. Handles installation, installation_repositories, and push (auto-deploy).
{
"tags": [
"GitHub"
],
"summary": "GitHub App webhook",
"description": "Unauthenticated. Verifies `X-Hub-Signature-256` with the app webhook secret. Handles `installation`, `installation_repositories`, and `push` (auto-deploy).",
"operationId": "githubWebhook",
"security": [],
"parameters": [
{
"name": "X-GitHub-Event",
"in": "header",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "X-Hub-Signature-256",
"in": "header",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": true
}
}
}
},
"responses": {
"204": {
"description": "Accepted"
},
"400": {
"description": "Payload is not JSON",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
},
"example": {
"error": "invalid_payload"
}
}
}
},
"401": {
"description": "Signature mismatch",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
},
"example": {
"error": "invalid_signature"
}
}
}
}
}
}
Referenced definitions
These keys resolve the local references in the operations above.{
"#/components/parameters/InstallationId": {
"name": "installation_id",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
"#/components/responses/InvalidCsrf": {
"description": "Missing or stale CSRF token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
},
"example": {
"error": "invalid_csrf_token"
}
}
}
},
"#/components/responses/InvalidParameters": {
"description": "Missing or malformed JSON parameters",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
},
"example": {
"error": "invalid_parameters"
}
}
}
},
"#/components/responses/Unauthenticated": {
"description": "No session cookie",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
},
"example": {
"error": "unauthenticated"
}
}
}
},
"#/components/schemas/Error": {
"type": "object",
"required": [
"error"
],
"properties": {
"error": {
"type": "string"
},
"actions": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"#/components/schemas/GithubInstallation": {
"type": "object",
"properties": {
"installation_id": {
"type": "string"
},
"account_login": {
"type": [
"string",
"null"
]
},
"account_type": {
"type": [
"string",
"null"
]
},
"repository_selection": {
"type": [
"string",
"null"
]
},
"status": {
"type": "string"
}
}
}
}