WebSockets are here. Bring real-time functionality to your apps, powered by Reverb →
cURL
curl --request GET \ --url https://app.laravel.cloud/api/background-processes/{backgroundProcess} \ --header 'Authorization: Bearer <token>'
{ "data": { "id": "<string>", "type": "background_processes", "attributes": { "type": "worker", "processes": 123, "command": "<string>", "config": [ "<unknown>" ], "strategy_type": "none", "strategy_threshold": 123, "created_at": "2023-11-07T05:31:56Z" }, "relationships": { "instance": { "data": { "type": "instances", "id": "<string>" } } } }, "included": [ { "id": "<string>", "type": "instances", "attributes": { "name": "<string>", "type": "app", "size": "flex.c-1vcpu-256mb", "scaling_type": "none", "min_replicas": 123, "max_replicas": 123, "uses_scheduler": true, "scaling_cpu_threshold_percentage": 123, "scaling_memory_threshold_percentage": 123, "created_at": "2023-11-07T05:31:56Z" }, "relationships": { "environment": { "data": { "type": "environments", "id": "<string>" } }, "backgroundProcesses": { "data": [ { "type": "background_processes", "id": "<string>" } ] } } } ] }
Get the details of a specific background process.
The Bearer Token generated on the Cloud UI.
The background process identifier
Available includes are instance. You can include multiple options by separating them with a comma.
instance
BackgroundProcessResource
Show child attributes
Was this page helpful?