Create queue worker

Create a new queue worker for your site.

POST/api/servers/{server}/sites/{id}/queues

Create queue worker

This endpoint creates a new queue worker. Preferably used for Laravel-driven applications (including frameworks or CMS's that use Laravel such as Statamic).

Required parameters

Name
connection
Type
string
Description
The queue connection name.
Name
queue
Type
string
Description
The queue name.
Name
maximum_seconds
Type
integer
Description
Maximum seconds to process a job. Min: 0, Max: 60000.
Name
sleep
Type
integer
Description
Seconds to sleep when no job is available. Min: 0, Max: 60000.
Name
processes
Type
integer
Description
Number of worker processes. Min: 1, Max: 120.
Name
backoff
Type
integer
Description
Seconds to wait before retrying a failed job. Min: 0.

Optional parameters

Name
maximum_tries
Type
integer
Description
Maximum number of attempts. Min: 1, Max: 60000.

Request

POST

/api/servers/{server}/sites/{id}/queues

curl -X POST "https://ploi.io/api/servers/{server}/sites/{id}/queues" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "connection": "database",
    "queue": "default",
    "maximum_seconds": "30",
    "sleep": "30",
    "processes": "2",
    "backoff": "10",
    "maximum_tries": "3"
  }'

Response

{
  "data": {
    "id": 1,
    "connection": "database",
    "queue": "default",
    "maximum_seconds": 30,
    "maximum_tries": null,
    "enviroment": null,
    "sleep": 10,
    "processes": 1,
    "backoff": 10,
    "status": "created",
    "site_id": 1,
    "server_id": 1
  }
}