---
title: "POST /github/link-repo"
method: POST
path: "/github/link-repo"
tags: ["github"]
---

# POST /github/link-repo

`POST /github/link-repo`

Links a github repo to a Scalar github project

## Request body

- object
  - `uid` string, required
  - `repositoryId` number, required
  - `configPath` string, required
  - `branch` string, required
  - `publishOnMerge` boolean, required
  - `publishPreviews` boolean, required
  - `prComments` boolean, required
  - `isPrivate` boolean, required
  - `accessGroups` string[], required

## Response `200`

Default Response

- unknown

## Other responses

- `400` — Bad request
- `401` — No auth
- `403` — Forbidden
- `404` — Not found
- `422` — Invalid payload
- `500` — Uncaught error

---

[API](https://skmtc.net/scalar/apis/core.md) · [All operations](https://skmtc.net/scalar/apis/core/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/scalar/core/revisions/0c91bf5ab53c/schema)