---
title: "Create GitHub connector"
method: POST
path: "/api/v1/github-connector"
tags: ["GitHub Connector"]
---

# Create GitHub connector

`POST /api/v1/github-connector`

## Request

- Base URL: `http://:8080`
- URL: `http://:8080/api/v1/github-connector`
- Auth: none declared

Create GitHub connector.

Auth: Required (bearer token).
Scope: Organization-scoped in authenticated context.
Side effects: May mutate server state.

## Headers

- `Accept` string

## Request body `*/*`

- CreateGithubConnectorRequest: CreateGithubConnectorRequest schema
  - `app_id` string, uuid: GitHub App ID. Required if providing custom app credentials
  - `client_id` string, uuid: GitHub App OAuth client ID
  - `client_secret` string: GitHub App OAuth client secret
  - `installation_id` string, uuid, nullable: GitHub App installation ID
  - `pem` string: GitHub App private key in PEM format
  - `slug` string: GitHub App slug
  - `webhook_secret` string: GitHub App webhook secret

## Response `201`

Created

- MessageResponse: MessageResponse schema
  - `message` string
  - `status` string

## Other responses

- `400`: Bad Request _(validation or deserialization error)_
- `500`: Internal Server Error _(panics)_
- `default`

## Changes

- **2026-04-26** `09f18af670c4`: 1 breaking, 3 info
  - removed the success response with the status `200`
  - api tag `GitHub Connector` added
  - api tag `api/v1/github-connector` removed
  - added the success response with the status `201`
- **2026-04-02** `2beb810c5221`: 24 warning, 13 info
  - removed the optional property `detail` from the response with the `400` status (media type: application/json)
  - removed the optional property `detail` from the response with the `400` status (media type: application/xml)
  - removed the optional property `detail` from the response with the `500` status (media type: application/json)
  - removed the optional property `detail` from the response with the `500` status (media type: application/xml)
  - …33 more
- **2026-03-26** `e34b00e45318`: 8 breaking, 4 warning, 25 info
  - removed the required property `code` from the response with the `400` status (media type: application/json)
  - removed the required property `code` from the response with the `400` status (media type: application/xml)
  - removed the required property `code` from the response with the `500` status (media type: application/json)
  - removed the required property `code` from the response with the `500` status (media type: application/xml)
  - …33 more
- …earlier changes not shown

[Operation history](https://skmtc.dev/nixopus/apis/nixopus-api/changes/api/v1/github-connector/post.md)

---

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