Skip to main content
PATCH
Update background process

Authorizations

Authorization
string
header
required

The Bearer Token generated on the Cloud UI.

Path Parameters

backgroundProcess
string | null
required

The background process identifier

Body

application/json
type
enum<string>
Available options:
worker,
custom
processes
integer
Required range: 1 <= x <= 10
command
string

Custom command to run. Required when type is 'custom'. Not applicable for 'worker' type.

Example:

"php artisan my:command"

config
object

Response

BackgroundProcessResource

data
BackgroundProcessResource · object
required
included
InstanceResource · object[]