API reference

Apps

Git-deployed apps (PHP, Node.js, Python), releases, processes, environment, Redis, GitHub connections.

List apps

GET/api/v1/accounts/{id}/apps

Who: root, reseller (ACL: create-user-session); customer
API tokens: admin token area: accounts; account token area: apps
Feature: apps
Operation: appList · ky call appList

Parameters

Name	In
`id`	path

Responses

200 OK
Body
Field Type
items array of AppView
401 Unauthorized: no session, or an invalid or expired token
403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)
404 Not Found: not-found
409 Conflict: not-ready
500 Internal Server Error: internal

Field	Type
`items`	array of AppView

Create an app

POST/api/v1/accounts/{id}/apps

Who: root, reseller (ACL: create-user-session); customer
API tokens: admin token area: accounts; account token area: apps
Feature: apps
Operation: appCreate · ky call appCreate

Parameters

Name	In
`id`	path

Request body

Field	Type
`branch`	string
`composer_auth`	string
`create_database`	boolean
`deploy_script`	string
`deploy_timeout`	integer
`domain_id`	string
`git_connection_id`	string
`health_path`	string
`inject_env`	boolean
`keep_releases`	integer
`name`	string
`php_version`	string
`push_to_deploy`	boolean
`repo_full_name`	string
`repo_url`	string
`runtime_version`	string
`scheduler`	boolean
`shared_paths`	array of string
`start_command`	string
`type`	string
`web_dir`	string

Responses

201 Created
Body
Field Type
app AppView
webhook_secret string
400 Bad Request: validation
401 Unauthorized: no session, or an invalid or expired token
403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)
404 Not Found: not-found
409 Conflict: limit-reached, not-ready, validation
500 Internal Server Error: internal

Field	Type
`app`	AppView
`webhook_secret`	string

Delete an app

DELETE/api/v1/accounts/{id}/apps/{aid}

Who: root, reseller (ACL: create-user-session); customer
API tokens: admin token area: accounts; account token area: apps
Feature: apps
Operation: appDelete · ky call appDelete

Parameters

Name	In
`id`	path
`aid`	path
`confirm`	query

Responses

204 Done, no content
400 Bad Request: confirmation-required
401 Unauthorized: no session, or an invalid or expired token
403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)
404 Not Found: not-found
409 Conflict: not-ready
500 Internal Server Error: internal

Get an app

GET/api/v1/accounts/{id}/apps/{aid}

Who: root, reseller (ACL: create-user-session); customer
API tokens: admin token area: accounts; account token area: apps
Feature: apps
Operation: appGet · ky call appGet

Parameters

Name	In
`id`	path
`aid`	path

Responses

200 OK
Body
Field Type
app AppView
401 Unauthorized: no session, or an invalid or expired token
403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)
404 Not Found: not-found
409 Conflict: not-ready
500 Internal Server Error: internal

Field	Type
`app`	AppView

Update an app

PUT/api/v1/accounts/{id}/apps/{aid}

Who: root, reseller (ACL: create-user-session); customer
API tokens: admin token area: accounts; account token area: apps
Feature: apps
Operation: appUpdate · ky call appUpdate

Parameters

Name	In
`id`	path
`aid`	path

Request body

Field	Type
`branch`	string
`composer_auth`	string
`create_database`	boolean
`deploy_script`	string
`deploy_timeout`	integer
`domain_id`	string
`git_connection_id`	string
`health_path`	string
`inject_env`	boolean
`keep_releases`	integer
`name`	string
`php_version`	string
`push_to_deploy`	boolean
`repo_full_name`	string
`repo_url`	string
`runtime_version`	string
`scheduler`	boolean
`shared_paths`	array of string
`start_command`	string
`type`	string
`web_dir`	string

Responses

200 OK
Body
Field Type
app AppView
400 Bad Request: validation
401 Unauthorized: no session, or an invalid or expired token
403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)
404 Not Found: not-found
409 Conflict: not-ready
500 Internal Server Error: internal

Field	Type
`app`	AppView

Run a command in the app's directory

POST/api/v1/accounts/{id}/apps/{aid}/command

Who: root, reseller (ACL: create-user-session); customer
API tokens: admin token area: accounts; account token area: apps
Feature: apps
Operation: appCommand · ky call appCommand

Parameters

Name	In
`id`	path
`aid`	path

Request body

Field	Type
`command`	string

Responses

200 OK
Body
map of any
400 Bad Request: validation
401 Unauthorized: no session, or an invalid or expired token
403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)
404 Not Found: not-found
409 Conflict: not-deployed, not-ready
500 Internal Server Error: internal

Start, stop or restart the app's processes

POST/api/v1/accounts/{id}/apps/{aid}/ctl

Who: root, reseller (ACL: create-user-session); customer
API tokens: admin token area: accounts; account token area: apps
Feature: apps
Operation: appControl · ky call appControl

Parameters

Name	In
`id`	path
`aid`	path

Request body

Field	Type
`action`	string
`proc`	string

Responses

200 OK
400 Bad Request: validation
401 Unauthorized: no session, or an invalid or expired token
403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)
404 Not Found: not-found
409 Conflict: not-ready
500 Internal Server Error: internal
502 Bad Gateway: ctl-failed

Deploy the app

POST/api/v1/accounts/{id}/apps/{aid}/deploy

Who: root, reseller (ACL: create-user-session); customer
API tokens: admin token area: accounts; account token area: apps
Feature: apps
Operation: appDeploy · ky call appDeploy

Parameters

Name	In
`id`	path
`aid`	path

Request body

Field	Type
`commit`	string

Responses

202 Accepted (runs in the background)
Body
Field Type
deployment StoreDeployment
400 Bad Request: validation
401 Unauthorized: no session, or an invalid or expired token
403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)
404 Not Found: not-found
409 Conflict: deploy-busy, not-ready
500 Internal Server Error: internal

Field	Type
`deployment`	StoreDeployment

Remove the app's deploy hook URL

DELETE/api/v1/accounts/{id}/apps/{aid}/deploy-hook

Who: root, reseller (ACL: create-user-session); customer
API tokens: admin token area: accounts; account token area: apps
Feature: apps
Operation: appHookDelete · ky call appHookDelete

Parameters

Name	In
`id`	path
`aid`	path

Responses

204 Done, no content
401 Unauthorized: no session, or an invalid or expired token
403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)
404 Not Found: not-found
409 Conflict: not-ready
500 Internal Server Error: internal

Create or rotate the app's deploy hook URL

POST/api/v1/accounts/{id}/apps/{aid}/deploy-hook

Who: root, reseller (ACL: create-user-session); customer
API tokens: admin token area: accounts; account token area: apps
Feature: apps
Operation: appHookRotate · ky call appHookRotate

Parameters

Name	In
`id`	path
`aid`	path

Responses

200 OK
Body
Field Type
url string
401 Unauthorized: no session, or an invalid or expired token
403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)
404 Not Found: not-found
409 Conflict: not-ready
500 Internal Server Error: internal

Field	Type
`url`	string

List deployments

GET/api/v1/accounts/{id}/apps/{aid}/deployments

Who: root, reseller (ACL: create-user-session); customer
API tokens: admin token area: accounts; account token area: apps
Feature: apps
Operation: appDeployments · ky call appDeployments

Parameters

Name	In
`id`	path
`aid`	path

Responses

200 OK
Body
Field Type
items array of StoreDeployment
401 Unauthorized: no session, or an invalid or expired token
403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)
404 Not Found: not-found
409 Conflict: not-ready
500 Internal Server Error: internal

Field	Type
`items`	array of StoreDeployment

Get a deployment

GET/api/v1/accounts/{id}/apps/{aid}/deployments/{did}

Who: root, reseller (ACL: create-user-session); customer
API tokens: admin token area: accounts; account token area: apps
Feature: apps
Operation: appDeployment · ky call appDeployment

Parameters

Name	In
`id`	path
`aid`	path
`did`	path

Responses

200 OK
Body
Field Type
deployment StoreDeployment
401 Unauthorized: no session, or an invalid or expired token
403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)
404 Not Found: not-found
409 Conflict: not-ready
500 Internal Server Error: internal

Field	Type
`deployment`	StoreDeployment

Cancel a deployment

POST/api/v1/accounts/{id}/apps/{aid}/deployments/{did}/cancel

Who: root, reseller (ACL: create-user-session); customer
API tokens: admin token area: accounts; account token area: apps
Feature: apps
Operation: appDeployCancel · ky call appDeployCancel

Parameters

Name	In
`id`	path
`aid`	path
`did`	path

Responses

204 Done, no content
401 Unauthorized: no session, or an invalid or expired token
403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)
404 Not Found: not-found
409 Conflict: not-ready, not-running
500 Internal Server Error: internal

Deployment log

GET/api/v1/accounts/{id}/apps/{aid}/deployments/{did}/log

Who: root, reseller (ACL: create-user-session); customer
API tokens: admin token area: accounts; account token area: apps
Feature: apps
Operation: appDeployLog · ky call appDeployLog

Parameters

Name	In
`id`	path
`aid`	path
`did`	path
`offset`	query

Responses

200 OK
Body
Field Type
offset integer
size integer
status string
text string
401 Unauthorized: no session, or an invalid or expired token
403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)
404 Not Found: not-found
409 Conflict: not-ready
500 Internal Server Error: internal

Field	Type
`offset`	integer
`size`	integer
`status`	string
`text`	string

Get the app's environment file

GET/api/v1/accounts/{id}/apps/{aid}/env

Who: root, reseller (ACL: create-user-session); customer
API tokens: admin token area: accounts; account token area: apps
Feature: apps
Operation: appEnvGet · ky call appEnvGet

Parameters

Name	In
`id`	path
`aid`	path

Responses

200 OK
Body
Field Type
content string
400 Bad Request: file-operation
401 Unauthorized: no session, or an invalid or expired token
403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)
404 Not Found: not-found
409 Conflict: not-ready
500 Internal Server Error: internal

Field	Type
`content`	string

Save the app's environment file

PUT/api/v1/accounts/{id}/apps/{aid}/env

Who: root, reseller (ACL: create-user-session); customer
API tokens: admin token area: accounts; account token area: apps
Feature: apps
Operation: appEnvPut · ky call appEnvPut

Parameters

Name	In
`id`	path
`aid`	path

Request body

Field	Type
`config_cache`	boolean
`content`	string
`restart_queues`	boolean

Responses

200 OK
Body
Field Type
notes array of string
saved boolean
400 Bad Request: file-operation, validation
401 Unauthorized: no session, or an invalid or expired token
403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)
404 Not Found: not-found
409 Conflict: not-ready
500 Internal Server Error: internal

Field	Type
`notes`	array of string
`saved`	boolean

List versions of the environment file

GET/api/v1/accounts/{id}/apps/{aid}/env/history

Who: root, reseller (ACL: create-user-session); customer
API tokens: admin token area: accounts; account token area: apps
Feature: apps
Operation: appEnvHistory · ky call appEnvHistory

Parameters

Name	In
`id`	path
`aid`	path

Responses

200 OK
Body
Field Type
items array of StoreEnvVersion
401 Unauthorized: no session, or an invalid or expired token
403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)
404 Not Found: not-found
409 Conflict: not-ready
500 Internal Server Error: internal

Field	Type
`items`	array of StoreEnvVersion

Get a version of the environment file

GET/api/v1/accounts/{id}/apps/{aid}/env/history/{vid}

Who: root, reseller (ACL: create-user-session); customer
API tokens: admin token area: accounts; account token area: apps
Feature: apps
Operation: appEnvVersion · ky call appEnvVersion

Parameters

Name	In
`id`	path
`aid`	path
`vid`	path

Responses

200 OK
Body
Field Type
content string
created_at integer
created_by string
401 Unauthorized: no session, or an invalid or expired token
403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)
404 Not Found: not-found
409 Conflict: not-ready
500 Internal Server Error: internal

Field	Type
`content`	string
`created_at`	integer
`created_by`	string

Pin the Git server's host keys again

POST/api/v1/accounts/{id}/apps/{aid}/known-hosts

Reads the Git server's host keys again and pins them (after the server changed its keys).

Who: root, reseller (ACL: create-user-session); customer
API tokens: admin token area: accounts; account token area: apps
Feature: apps
Operation: appKnownHosts · ky call appKnownHosts

Parameters

Name	In
`id`	path
`aid`	path

Responses

200 OK
Body
Field Type
host_key_fingerprints array of string
400 Bad Request: not-ssh
401 Unauthorized: no session, or an invalid or expired token
403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)
404 Not Found: not-found
409 Conflict: not-ready
500 Internal Server Error: internal
502 Bad Gateway: keyscan-failed

Field	Type
`host_key_fingerprints`	array of string

App logs

GET/api/v1/accounts/{id}/apps/{aid}/logs

Who: root, reseller (ACL: create-user-session); customer
API tokens: admin token area: accounts; account token area: apps
Feature: apps
Operation: appLogs · ky call appLogs

Parameters

Name	In
`id`	path
`aid`	path
`file`	query

Responses

200 OK
Body
map of any
400 Bad Request: file-operation
401 Unauthorized: no session, or an invalid or expired token
403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)
404 Not Found: not-found
409 Conflict: not-ready
500 Internal Server Error: internal

List the app's processes (workers, queues, scheduler)

GET/api/v1/accounts/{id}/apps/{aid}/processes

Who: root, reseller (ACL: create-user-session); customer
API tokens: admin token area: accounts; account token area: apps
Feature: apps
Operation: appProcesses · ky call appProcesses

Parameters

Name	In
`id`	path
`aid`	path

Responses

200 OK
Body
Field Type
items array of StoreAppProcess
status any
401 Unauthorized: no session, or an invalid or expired token
403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)
404 Not Found: not-found
409 Conflict: not-ready
500 Internal Server Error: internal

Field	Type
`items`	array of StoreAppProcess
`status`	any

Add a process

POST/api/v1/accounts/{id}/apps/{aid}/processes

Who: root, reseller (ACL: create-user-session); customer
API tokens: admin token area: accounts; account token area: apps
Feature: apps
Operation: postAccountsIdAppsAidProcesses · ky call postAccountsIdAppsAidProcesses

Parameters

Name	In
`id`	path
`aid`	path

Request body

Field	Type
`command`	string
`enabled`	boolean
`instances`	integer
`kind`	string
`name`	string
`stop_wait`	integer
`worker`	HostingWorkerOptions

Responses

200 OK
Body
Field Type
process StoreAppProcess
400 Bad Request: validation
401 Unauthorized: no session, or an invalid or expired token
403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)
404 Not Found: not-found
409 Conflict: not-ready
500 Internal Server Error: internal
502 Bad Gateway: apply-failed

Field	Type
`process`	StoreAppProcess

Delete a process

DELETE/api/v1/accounts/{id}/apps/{aid}/processes/{pid}

Who: root, reseller (ACL: create-user-session); customer
API tokens: admin token area: accounts; account token area: apps
Feature: apps
Operation: appProcessDelete · ky call appProcessDelete

Parameters

Name	In
`id`	path
`aid`	path
`pid`	path

Responses

204 Done, no content
401 Unauthorized: no session, or an invalid or expired token
403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)
404 Not Found: not-found
409 Conflict: not-ready
500 Internal Server Error: internal

Update a process

PUT/api/v1/accounts/{id}/apps/{aid}/processes/{pid}

Who: root, reseller (ACL: create-user-session); customer
API tokens: admin token area: accounts; account token area: apps
Feature: apps
Operation: putAccountsIdAppsAidProcessesPid · ky call putAccountsIdAppsAidProcessesPid

Parameters

Name	In
`id`	path
`aid`	path
`pid`	path

Request body

Field	Type
`command`	string
`enabled`	boolean
`instances`	integer
`kind`	string
`name`	string
`stop_wait`	integer
`worker`	HostingWorkerOptions

Responses

200 OK
Body
Field Type
process StoreAppProcess
400 Bad Request: validation
401 Unauthorized: no session, or an invalid or expired token
403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)
404 Not Found: not-found
409 Conflict: not-ready
500 Internal Server Error: internal
502 Bad Gateway: apply-failed

Field	Type
`process`	StoreAppProcess

List releases

GET/api/v1/accounts/{id}/apps/{aid}/releases

Who: root, reseller (ACL: create-user-session); customer
API tokens: admin token area: accounts; account token area: apps
Feature: apps
Operation: appReleases · ky call appReleases

Parameters

Name	In
`id`	path
`aid`	path

Responses

200 OK
401 Unauthorized: no session, or an invalid or expired token
403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)
404 Not Found: not-found
409 Conflict: not-ready
500 Internal Server Error: internal

Roll back to a previous release

POST/api/v1/accounts/{id}/apps/{aid}/rollback

Who: root, reseller (ACL: create-user-session); customer
API tokens: admin token area: accounts; account token area: apps
Feature: apps
Operation: appRollback · ky call appRollback

Parameters

Name	In
`id`	path
`aid`	path

Request body

Field	Type
`release`	string

Responses

202 Accepted (runs in the background)
Body
Field Type
deployment StoreDeployment
400 Bad Request: validation
401 Unauthorized: no session, or an invalid or expired token
403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)
404 Not Found: not-found
409 Conflict: already-live, deploy-busy, not-ready
500 Internal Server Error: internal

Get the app's push-to-deploy webhook

GET/api/v1/accounts/{id}/apps/{aid}/webhook

Who: root, reseller (ACL: create-user-session); customer
API tokens: admin token area: accounts; account token area: apps
Feature: apps
Operation: appWebhookGet · ky call appWebhookGet

Parameters

Name	In
`id`	path
`aid`	path

Responses

200 OK
Body
Field Type
secret string
url string
401 Unauthorized: no session, or an invalid or expired token
403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)
404 Not Found: not-found
409 Conflict: not-ready
500 Internal Server Error: internal

Rotate the app's push-to-deploy webhook

POST/api/v1/accounts/{id}/apps/{aid}/webhook/rotate

Who: root, reseller (ACL: create-user-session); customer
API tokens: admin token area: accounts; account token area: apps
Feature: apps
Operation: appWebhookRotate · ky call appWebhookRotate

Parameters

Name	In
`id`	path
`aid`	path

Responses

200 OK
Body
Field Type
secret string
url string
401 Unauthorized: no session, or an invalid or expired token
403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)
404 Not Found: not-found
409 Conflict: not-ready
500 Internal Server Error: internal

Options for a new app (runtimes, domains, versions)

GET/api/v1/accounts/{id}/apps/options

Who: root, reseller (ACL: create-user-session); customer
API tokens: admin token area: accounts; account token area: apps
Feature: apps
Operation: appOptions · ky call appOptions

Parameters

Name	In
`id`	path

Responses

200 OK
Body
Field Type
node_versions array of string
php_versions array of string
python_versions array of string
types array of map of any
401 Unauthorized: no session, or an invalid or expired token
403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)

List Git connections

GET/api/v1/accounts/{id}/git/connections

Who: root, reseller (ACL: create-user-session); customer
API tokens: admin token area: accounts; account token area: git
Feature: apps
Operation: gitConnections · ky call gitConnections

Parameters

Name	In
`id`	path

Responses

200 OK
Body
Field Type
github_app string
github_available boolean
items array of StoreGitConnection
users array of UserView
401 Unauthorized: no session, or an invalid or expired token
403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)
404 Not Found: not-found
409 Conflict: not-ready
500 Internal Server Error: internal

Remove a Git connection

DELETE/api/v1/accounts/{id}/git/connections/{cid}

Who: root, reseller (ACL: create-user-session); customer
API tokens: admin token area: accounts; account token area: git
Feature: apps
Operation: gitConnectionDelete · ky call gitConnectionDelete

Parameters

Name	In
`id`	path
`cid`	path

Responses

204 Done, no content
401 Unauthorized: no session, or an invalid or expired token
403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)
404 Not Found: not-found
409 Conflict: not-ready
500 Internal Server Error: internal

Rename a Git connection

PUT/api/v1/accounts/{id}/git/connections/{cid}

Who: root, reseller (ACL: create-user-session); customer
API tokens: admin token area: accounts; account token area: git
Feature: apps
Operation: gitConnectionRename · ky call gitConnectionRename

Parameters

Name	In
`id`	path
`cid`	path

Request body

Field	Type
`nickname`	string

Responses

200 OK
Body
Field Type
connection StoreGitConnection
400 Bad Request: validation
401 Unauthorized: no session, or an invalid or expired token
403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)
404 Not Found: not-found
409 Conflict: not-ready
500 Internal Server Error: internal

List a repository's branches

GET/api/v1/accounts/{id}/git/connections/{cid}/branches

Who: root, reseller (ACL: create-user-session); customer
API tokens: admin token area: accounts; account token area: git
Feature: apps
Operation: gitConnectionBranches · ky call gitConnectionBranches

Parameters

Name	In
`id`	path
`cid`	path
`repo`	query
`repo_id`	query

Responses

200 OK
Body
Field Type
items array of string
400 Bad Request: validation
401 Unauthorized: no session, or an invalid or expired token
403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)
404 Not Found: not-found
409 Conflict: not-ready
500 Internal Server Error: internal
502 Bad Gateway: github-failed

Detect the PHP version a repository needs

GET/api/v1/accounts/{id}/git/connections/{cid}/php

Who: root, reseller (ACL: create-user-session); customer
API tokens: admin token area: accounts; account token area: git
Feature: apps
Operation: gitConnectionPHP · ky call gitConnectionPHP

Parameters

Name	In
`id`	path
`cid`	path
`branch`	query
`repo`	query
`repo_id`	query

Responses

200 OK
Body
Field Type
constraint string
version string
400 Bad Request: validation
401 Unauthorized: no session, or an invalid or expired token
403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)
404 Not Found: not-found
409 Conflict: not-ready
500 Internal Server Error: internal
502 Bad Gateway: github-failed

List repositories

GET/api/v1/accounts/{id}/git/connections/{cid}/repos

Who: root, reseller (ACL: create-user-session); customer
API tokens: admin token area: accounts; account token area: git
Feature: apps
Operation: gitConnectionRepos · ky call gitConnectionRepos

Parameters

Name	In
`id`	path
`cid`	path

Responses

200 OK
Body
Field Type
items array of GithubRepo
401 Unauthorized: no session, or an invalid or expired token
403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)
404 Not Found: not-found
409 Conflict: not-ready
500 Internal Server Error: internal
502 Bad Gateway: github-failed

Connect a GitHub account or organization

POST/api/v1/accounts/{id}/git/connections/github

Who: root, reseller (ACL: create-user-session); customer
API tokens: admin token area: accounts; account token area: git
Feature: apps
Operation: gitConnectGitHub · ky call gitConnectGitHub

Parameters

Name	In
`id`	path

Request body

Field	Type
`mode`	string

Responses

200 OK
Body
Field Type
url string
401 Unauthorized: no session, or an invalid or expired token
403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)
404 Not Found: not-found
409 Conflict: github-off, not-ready
500 Internal Server Error: internal

Remove a GitHub user and its connections

DELETE/api/v1/accounts/{id}/git/users/{uid}

Who: root, reseller (ACL: create-user-session); customer
API tokens: admin token area: accounts; account token area: git
Feature: apps
Operation: gitUserDelete · ky call gitUserDelete

Parameters

Name	In
`id`	path
`uid`	path

Responses

204 Done, no content
401 Unauthorized: no session, or an invalid or expired token
403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)
404 Not Found: not-found
409 Conflict: not-ready
500 Internal Server Error: internal

Rename a GitHub user

PUT/api/v1/accounts/{id}/git/users/{uid}

Who: root, reseller (ACL: create-user-session); customer
API tokens: admin token area: accounts; account token area: git
Feature: apps
Operation: gitUserRename · ky call gitUserRename

Parameters

Name	In
`id`	path
`uid`	path

Request body

Field	Type
`nickname`	string

Responses

204 Done, no content
400 Bad Request: validation
401 Unauthorized: no session, or an invalid or expired token
403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)
404 Not Found: not-found
409 Conflict: not-ready
500 Internal Server Error: internal

Turn off Redis (Valkey)

DELETE/api/v1/accounts/{id}/valkey

Who: root, reseller (ACL: create-user-session); customer
API tokens: admin token area: accounts; account token area: valkey
Feature: apps
Operation: valkeyDelete · ky call valkeyDelete

Parameters

Name	In
`id`	path

Responses

204 Done, no content
401 Unauthorized: no session, or an invalid or expired token
403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)
404 Not Found: not-found
409 Conflict: not-ready
500 Internal Server Error: internal

Get the Redis (Valkey) instance

GET/api/v1/accounts/{id}/valkey

Who: root, reseller (ACL: create-user-session); customer
API tokens: admin token area: accounts; account token area: valkey
Feature: apps
Operation: valkeyGet · ky call valkeyGet

Parameters

Name	In
`id`	path

Responses

200 OK
Body
Field Type
enabled always boolean
host string
maxmemory_mb integer
password string
port integer
status string
401 Unauthorized: no session, or an invalid or expired token
403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)
404 Not Found: not-found
409 Conflict: not-ready
500 Internal Server Error: internal

Turn on or resize Redis (Valkey)

PUT/api/v1/accounts/{id}/valkey

Who: root, reseller (ACL: create-user-session); customer
API tokens: admin token area: accounts; account token area: valkey
Feature: apps
Operation: valkeyPut · ky call valkeyPut

Parameters

Name	In
`id`	path

Request body

Field	Type
`maxmemory_mb`	integer

Responses

200 OK
Body
Field Type
enabled always boolean
host string
maxmemory_mb integer
password string
port integer
status string
400 Bad Request: validation
401 Unauthorized: no session, or an invalid or expired token
403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)
404 Not Found: not-found
409 Conflict: not-ready
500 Internal Server Error: internal
502 Bad Gateway: valkey-failed

Delete the server's GitHub App

DELETE/api/v1/github/app

Who: root
API tokens: admin token area: server
Operation: githubAppDelete · ky call githubAppDelete

Responses

204 Done, no content
401 Unauthorized: no session, or an invalid or expired token
403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)
500 Internal Server Error: internal

Get the server's GitHub App

GET/api/v1/github/app

Who: root
API tokens: admin token area: server
Operation: githubAppGet · ky call githubAppGet

Responses

200 OK
Body
Field Type
app HostingGitHubAppView
panel_url string
401 Unauthorized: no session, or an invalid or expired token
403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)
500 Internal Server Error: internal

Finish creating the GitHub App (GitHub redirect)

GET/api/v1/github/app/created

Who: public
API tokens: not needed
Operation: githubAppCreated · ky call githubAppCreated

Parameters

Name	In
`code`	query
`state`	query

Responses

303 Redirect

Start creating the GitHub App

POST/api/v1/github/app/manifest

Returns the form the browser posts to GitHub ("Create GitHub App" page, back to /created).

Who: root
API tokens: admin token area: server
Operation: githubAppManifest · ky call githubAppManifest

Request body

Field	Type
`org`	string

Responses

200 OK
Body
Field Type
action string
manifest string
400 Bad Request: validation
401 Unauthorized: no session, or an invalid or expired token
403 Forbidden: the caller can't use this (privileges, token scope, feature turned off)
500 Internal Server Error: internal

GitHub installation callback

GET/api/v1/github/callback

Is where GitHub sends a customer after installing or authorizing the app.

Who: public
API tokens: not needed
Operation: githubCallback · ky call githubCallback

Parameters

Name	In
`code`	query
`installation_id`	query
`state`	query

Responses

303 Redirect

Field	Type
`node_versions`	array of string
`php_versions`	array of string
`python_versions`	array of string
`types`	array of map of any

Field	Type
`github_app`	string
`github_available`	boolean
`items`	array of StoreGitConnection
`users`	array of UserView

Field	Type
`enabled` always	boolean
`host`	string
`maxmemory_mb`	integer
`password`	string
`port`	integer
`status`	string

Apps

#List apps

Parameters

Responses

#Create an app

Parameters

Request body

Responses

#Delete an app

Parameters

Responses

#Get an app

Parameters

Responses

#Update an app

Parameters

Request body

Responses

#Run a command in the app's directory

Parameters

Request body

Responses

#Start, stop or restart the app's processes

Parameters

Request body

Responses

#Deploy the app

Parameters

Request body

Responses

#Remove the app's deploy hook URL

Parameters

Responses

#Create or rotate the app's deploy hook URL

Parameters

Responses

#List deployments

Parameters

Responses

#Get a deployment

Parameters

Responses

#Cancel a deployment

Parameters

Responses

#Deployment log

Parameters

Responses

#Get the app's environment file

Parameters

Responses

#Save the app's environment file

Parameters

Request body

Responses

#List versions of the environment file

Parameters

Responses

#Get a version of the environment file

Parameters

Responses

#Pin the Git server's host keys again

Parameters

Responses

#App logs

Parameters

Responses

#List the app's processes (workers, queues, scheduler)

Parameters

Responses

#Add a process

Parameters

Request body

Responses

#Delete a process

Parameters

Responses

#Update a process

Parameters

Request body

List apps

Create an app

Delete an app

Get an app

Update an app

Run a command in the app's directory

Start, stop or restart the app's processes

Deploy the app

Remove the app's deploy hook URL

Create or rotate the app's deploy hook URL

List deployments

Get a deployment

Cancel a deployment

Deployment log

Get the app's environment file

Save the app's environment file

List versions of the environment file

Get a version of the environment file

Pin the Git server's host keys again

App logs

List the app's processes (workers, queues, scheduler)

Add a process

Delete a process

Update a process

List releases

Roll back to a previous release

Get the app's push-to-deploy webhook

Rotate the app's push-to-deploy webhook

Options for a new app (runtimes, domains, versions)

List Git connections

Remove a Git connection

Rename a Git connection

List a repository's branches

Detect the PHP version a repository needs

List repositories

Connect a GitHub account or organization

Remove a GitHub user and its connections

Rename a GitHub user

Turn off Redis (Valkey)

Get the Redis (Valkey) instance

Turn on or resize Redis (Valkey)

Delete the server's GitHub App

Get the server's GitHub App

Finish creating the GitHub App (GitHub redirect)

Start creating the GitHub App

GitHub installation callback