Skip to main content
PATCH
Update app service

Authorizations

X-API-Key
string
header
required

API key for authentication. Each key is bound to a specific account.

Path Parameters

service_id
string
required

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

Body

application/json

Every field is optional. Leave a field out to keep it.

name
string

Display name (the address does not change)

description
string

Send "" to clear it

tier_id
integer

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

start_command
string
http_port
integer

Web and private apps only

health_check_path
string

Must start with /

cron_schedule
string

Cron apps only

cron_timezone
string
cron_concurrency
enum<string>
Available options:
forbid,
allow,
replace
repo_branch
string

GitHub apps only

repo_root_dir
string
dockerfile_path
string
previews_enabled
boolean

Pull request previews (web apps from GitHub)

redeploy
boolean

Deploy now even when the change alone would not

Response

App updated. deployment_id is set when a deployment started.

success
boolean
service
object

An app service on the Raff PaaS — a web service, private service, worker, cron job, or one-off job.

deployment_id
string<uuid>
Last modified on October 19, 2026