242 lines
4.7 KiB
Markdown
242 lines
4.7 KiB
Markdown
[Skip to content](https://coolify.io/docs/api-reference/api/operations/create-private-github-app-application#VPContent)
|
||
|
||
Return to top
|
||
|
||
Create (Private - GH App)[](https://coolify.io/docs/api-reference/api/operations/create-private-github-app-application#create-private-gh-app)
|
||
|
||
===============================================================================================================================================
|
||
|
||
POST
|
||
|
||
/applications/private-github-app
|
||
|
||
Create new application based on a private repository through a Github App.
|
||
|
||
Authorizations[](https://coolify.io/docs/api-reference/api/operations/create-private-github-app-application#authorizations)
|
||
|
||
-----------------------------------------------------------------------------------------------------------------------------
|
||
|
||
bearerAuth
|
||
|
||
Go to `Keys & Tokens` / `API tokens` and create a new token. Use the token as the bearer token.
|
||
|
||
Type
|
||
|
||
HTTP (bearer)
|
||
|
||
Request Body[](https://coolify.io/docs/api-reference/api/operations/create-private-github-app-application#request-body)
|
||
|
||
-------------------------------------------------------------------------------------------------------------------------
|
||
|
||
application/json
|
||
|
||
SchemaJSON
|
||
|
||
JSON
|
||
|
||
{
|
||
|
||
"project\_uuid": "string",
|
||
|
||
"server\_uuid": "string",
|
||
|
||
"environment\_name": "string",
|
||
|
||
"environment\_uuid": "string",
|
||
|
||
"github\_app\_uuid": "string",
|
||
|
||
"git\_repository": "string",
|
||
|
||
"git\_branch": "string",
|
||
|
||
"ports\_exposes": "string",
|
||
|
||
"destination\_uuid": "string",
|
||
|
||
"build\_pack": "string",
|
||
|
||
"name": "string",
|
||
|
||
"description": "string",
|
||
|
||
"domains": "string",
|
||
|
||
"git\_commit\_sha": "string",
|
||
|
||
"docker\_registry\_image\_name": "string",
|
||
|
||
"docker\_registry\_image\_tag": "string",
|
||
|
||
"is\_static": true,
|
||
|
||
"is\_spa": true,
|
||
|
||
"is\_auto\_deploy\_enabled": true,
|
||
|
||
"is\_force\_https\_enabled": true,
|
||
|
||
"static\_image": "string",
|
||
|
||
"install\_command": "string",
|
||
|
||
"build\_command": "string",
|
||
|
||
"start\_command": "string",
|
||
|
||
"ports\_mappings": "string",
|
||
|
||
"base\_directory": "string",
|
||
|
||
"publish\_directory": "string",
|
||
|
||
"health\_check\_enabled": true,
|
||
|
||
"health\_check\_path": "string",
|
||
|
||
"health\_check\_port": "string",
|
||
|
||
"health\_check\_host": "string",
|
||
|
||
"health\_check\_method": "string",
|
||
|
||
"health\_check\_return\_code": 0,
|
||
|
||
"health\_check\_scheme": "string",
|
||
|
||
"health\_check\_response\_text": "string",
|
||
|
||
"health\_check\_interval": 0,
|
||
|
||
"health\_check\_timeout": 0,
|
||
|
||
"health\_check\_retries": 0,
|
||
|
||
"health\_check\_start\_period": 0,
|
||
|
||
"limits\_memory": "string",
|
||
|
||
"limits\_memory\_swap": "string",
|
||
|
||
"limits\_memory\_swappiness": 0,
|
||
|
||
"limits\_memory\_reservation": "string",
|
||
|
||
"limits\_cpus": "string",
|
||
|
||
"limits\_cpuset": "string",
|
||
|
||
"limits\_cpu\_shares": 0,
|
||
|
||
"custom\_labels": "string",
|
||
|
||
"custom\_docker\_run\_options": "string",
|
||
|
||
"post\_deployment\_command": "string",
|
||
|
||
"post\_deployment\_command\_container": "string",
|
||
|
||
"pre\_deployment\_command": "string",
|
||
|
||
"pre\_deployment\_command\_container": "string",
|
||
|
||
"manual\_webhook\_secret\_github": "string",
|
||
|
||
"manual\_webhook\_secret\_gitlab": "string",
|
||
|
||
"manual\_webhook\_secret\_bitbucket": "string",
|
||
|
||
"manual\_webhook\_secret\_gitea": "string",
|
||
|
||
"redirect": "string",
|
||
|
||
"instant\_deploy": true,
|
||
|
||
"dockerfile": "string",
|
||
|
||
"dockerfile\_location": "string",
|
||
|
||
"docker\_compose\_location": "string",
|
||
|
||
"docker\_compose\_custom\_start\_command": "string",
|
||
|
||
"docker\_compose\_custom\_build\_command": "string",
|
||
|
||
"docker\_compose\_domains": \[\
|
||
\
|
||
{\
|
||
\
|
||
"name": "string",\
|
||
\
|
||
"domain": "string"\
|
||
\
|
||
}\
|
||
\
|
||
\],
|
||
|
||
"watch\_paths": "string",
|
||
|
||
"use\_build\_server": true,
|
||
|
||
"is\_http\_basic\_auth\_enabled": true,
|
||
|
||
"http\_basic\_auth\_username": "string",
|
||
|
||
"http\_basic\_auth\_password": "string",
|
||
|
||
"connect\_to\_docker\_network": true,
|
||
|
||
"force\_domain\_override": true,
|
||
|
||
"autogenerate\_domain": true,
|
||
|
||
"is\_container\_label\_escape\_enabled": true,
|
||
|
||
"is\_preserve\_repository\_enabled": false
|
||
|
||
}
|
||
|
||
Responses[](https://coolify.io/docs/api-reference/api/operations/create-private-github-app-application#responses)
|
||
|
||
-------------------------------------------------------------------------------------------------------------------
|
||
|
||
201400401409
|
||
|
||
Application created successfully.
|
||
|
||
Content-Type
|
||
|
||
application/json
|
||
|
||
SchemaJSON
|
||
|
||
JSON
|
||
|
||
{
|
||
|
||
"uuid": "string"
|
||
|
||
}
|
||
|
||
POST
|
||
|
||
/applications/private-github-app
|
||
|
||
Playground[](https://coolify.io/docs/api-reference/api/operations/create-private-github-app-application#playground)
|
||
|
||
---------------------------------------------------------------------------------------------------------------------
|
||
|
||
Authorization
|
||
|
||
bearerAuth
|
||
|
||
Body
|
||
|
||
Try it out
|
||
|
||
Samples[](https://coolify.io/docs/api-reference/api/operations/create-private-github-app-application#samples)
|
||
|
||
---------------------------------------------------------------------------------------------------------------
|
||
|
||
Powered by [VitePress OpenAPI](https://github.com/enzonotario/vitepress-openapi)
|