Services & configuration

GETGet service

/api/services/{id}

Read a service’s current state, source configuration, plan, and exposed ports..

GETGet scaling

/api/services/{id}/scaling

Read the instance floor, autoscaling ceiling, and effective service capacity..

GETGet dependencies

/api/services/{id}/dependencies

Inspect dependency issues that can prevent a service from starting correctly..

POSTCreate service

/api/services

Create a service from a Git repository or container image.

PATCHUpdate build settings

/api/services/{id}/build

Update the build directory, builder, and build or runtime commands for a service..

PATCHSet read-only filesystem

/api/services/{id}/security

Configure a read-only root filesystem for the service’s next deployment..

PATCHScale service

/api/services/{id}/scaling

Set the service’s instance count and, optionally, its autoscaling targets and ceiling..

POSTStop service

/api/services/{id}/stop

Stop a running service.

DELETEDelete service

/api/services/{id}

Delete a service and place eligible resources within the restoration window..

POSTRestore service

/api/services/{id}/restore

Restore an eligible deleted service and redeploy it with its retained configuration..

PATCHSet service image

/api/services/{id}/image

Change a service’s container image and optionally deploy it immediately..

PATCHSet plan

/api/services/{id}/plan

Move a service to another available compute plan..