GitHub Apps

Create GitHub App

Changed on

Create a new GitHub app.

post/github-apps

Request

  • Base URL: https://app.coolify.io/api/v1
  • URL: https://app.coolify.io/api/v1/github-apps
  • Auth: HTTP bearer

Request body

namestring required

Name of the GitHub app.

organizationstring nullable

Organization to associate the app with.

api_urlstring

API URL for the GitHub app (e.g., https://api.github.com).

html_urlstring required

HTML URL for the GitHub app (e.g., https://github.com).

custom_userstring

Custom user for SSH access (default: git).

custom_portinteger

Custom port for SSH access (default: 22).

app_idinteger required

GitHub App ID from GitHub.

installation_idinteger required

GitHub Installation ID.

client_idstring required

GitHub OAuth App Client ID.

client_secretstring required

GitHub OAuth App Client Secret.

webhook_secretstring

Webhook secret for GitHub webhooks.

private_key_uuidstring required

UUID of an existing private key for GitHub App authentication.

is_system_wideboolean

Is this app system-wide (cloud only).

Response

GitHub app created successfully.

idinteger
uuidstring
namestring
organizationstring nullable
api_urlstring
html_urlstring
custom_userstring
custom_portinteger
app_idinteger
installation_idinteger
client_idstring
private_key_idinteger
is_system_wideboolean
team_idinteger

Changes