Background Processes

Update background process

Update a background process.

patch/background-processes/{backgroundProcess}

Request

  • Base URL
    https://cloud.laravel.com/api
  • Auth
    HTTP bearer

Path parameters

backgroundProcessstring nullable required

The background process identifier

Request body

type'worker' | 'custom'
processesinteger
commandstring

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

Example request

{
  "command": "php artisan my:command",
  "config": {
    "connection": "redis",
    "queue": "default,emails",
    "tries": 3,
    "backoff": 30,
    "sleep": 3,
    "timeout": 60
  }
}

Response

BackgroundProcessResource

Changes

No recorded changes to this operation across all 1 revision of this API.