RArafftechnologies
Raff Apps

Update app service

Changed on

Change an app's settings. Fields you leave out stay as they are. A change to how a live app runs (size, start command, port, health check, schedule) rolls out as a new deployment of the current image, and a change to a failed app deploys it. A paused app keeps the change and applies it when resumed. Scaling has its own endpoint.

patch/api/v1/apps/services/{service_id}

Request

  • Base URL
    https://api.rafftechnologies.com
  • URL
    https://api.rafftechnologies.com/api/v1/apps/services/{service_id}
  • Auth
    API key in header X-API-Key

Path parameters

service_idstring required

App service ID (UUID) or short id (the service_id field)

Request body

namestring

Display name (the address does not change)

descriptionstring

Send "" to clear it

tier_idinteger

New size (see GET /api/v1/apps/tiers). Apps on a subscription change size through support for now.

start_commandstring
http_portinteger

Web and private apps only

health_check_pathstring

Must start with /

cron_schedulestring

Cron apps only

cron_timezonestring
cron_concurrency'forbid' | 'allow' | 'replace'
repo_branchstring

GitHub apps only

repo_root_dirstring
dockerfile_pathstring
previews_enabledboolean

Pull request previews (web apps from GitHub)

redeployboolean

Deploy now even when the change alone would not

Response

App updated. deployment_id is set when a deployment started.

successboolean
deployment_idstring uuid

Changes