Coolify Octri Demo
PATCH/github-apps/{github_app_id}

Update a GitHub app

Updates the configuration of an existing GitHub app. Supply the app's ID and any configuration fields you want to change; the request body does not specify fields as required. The response includes the updated GitHub app data.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 13 body fields
github_app_idintegerrequired
The numeric ID of the GitHub app to update.

GitHub app configuration fields to update.

api_urlstringoptional
GitHub API URL
app_idintegeroptional
GitHub App ID
client_idstringoptional
GitHub Client ID
client_secretstringoptional
GitHub Client Secret
custom_portintegeroptional
Custom port for SSH
custom_userstringoptional
Custom user for SSH
html_urlstringoptional
GitHub HTML URL
installation_idintegeroptional
GitHub Installation ID
is_system_widebooleanoptional
Is system wide (non-cloud instances only)
namestringoptional
GitHub App name
organizationstringoptional
GitHub organization
private_key_uuidstringoptional
Private key UUID
webhook_secretstringoptional
GitHub Webhook Secret

4 status codes
200Returns the updated GitHub app data and a message.
dataobjectoptional
Updated GitHub app data
messagestringoptional
401Returned when the request is unauthorized.
404Returned when the GitHub app is not found.
422Returned when the request fails validation.
errorsobjectoptional
messagestringoptional

Error handling

A 401 is returned when the request is unauthorized; a 404 is returned when the GitHub app is not found; and a 422 is returned when the request fails validation. The github_app_id path parameter must identify an existing GitHub app.