---
title: "Start the GitHub OAuth flow"
method: GET
path: "/api/auth/github"
tags: ["Auth"]
---

# Start the GitHub OAuth flow

`GET /api/auth/github`

## Request

- Base URL: `https://hiveship.app/api`
- URL: `https://hiveship.app/api/api/auth/github`
- Auth: none required

Sets a signed state cookie and 302-redirects to `github.com/login/oauth/authorize`. Not callable from the Swagger UI "try-it-out" — open in a browser tab instead.

## Other responses

- `302`: Redirect to GitHub OAuth consent screen

---

[API](https://skmtc.dev/hiveship/apis/hiveship-api.md) · [All operations](https://skmtc.dev/hiveship/apis/hiveship-api/llms.txt) · [OpenAPI document](https://skmtc.dev/hiveship/apis/hiveship-api/revisions/73d3e26544e4?raw)
