Create background process

Create a new background process for an instance.

post/instances/{instance}/background-processes

Request

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

Path parameters

instancestring required

The instance identifier

Request body

type'worker' | 'custom' required

processesinteger required

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.