---
title: "Finishes a GitHub App installation: apps/web forwards the installation_id + state GitHub redirected to its Setup URL with here"
method: POST
path: "/github/complete-install"
tags: ["GitHub"]
---

# Finishes a GitHub App installation: apps/web forwards the installation_id + state GitHub redirected to its Setup URL with here

`POST /github/complete-install`

## Request

- Base URL: `https://hostingsurge.com/api/v1`
- URL: `https://hostingsurge.com/api/v1/github/complete-install`
- Auth: one of:
  - HTTP bearer
  - API key in cookie `__Host-hs_session`

## Request body

- object
  - `installationId` string, required
  - `state` string, required
  - `code` string

## Response `200`

Installation now linked to the organization the install started from

- object
  - `installation` object, required
    - `id` string, required
    - `account` string, nullable, required
    - `accountType` 'User' | 'Organization' | 'null', nullable, required
    - `avatarUrl` string, nullable, required

## Other responses

- `400`: Invalid request (code invalid_request)
- `401`: Missing or invalid session/token (code unauthorized)
- `403`: Authenticated but not permitted (code forbidden)
- `404`: Not found or not visible to the caller (code not_found)
- `409`: Conflicting state (code conflict)
- `429`: Too many requests (code rate_limited); see Retry-After
- `503`: Hosting engine unavailable (code provider_unavailable)

---

[API](https://skmtc.dev/hostingsurge/apis/hostingsurge-platform-api.md) · [All operations](https://skmtc.dev/hostingsurge/apis/hostingsurge-platform-api/llms.txt) · [OpenAPI document](https://skmtc.dev/hostingsurge/apis/hostingsurge-platform-api/revisions/4d08337cdff1?raw)
