Authorizations
The Bearer Token generated on the Cloud UI.
Path Parameters
The instance identifier
curl --request GET \
--url https://app.laravel.cloud/api/instances/{instance}/background-processes \
--header 'Authorization: Bearer <token>'{
"data": [
{
"id": "<string>",
"type": "<string>",
"attributes": {
"type": "<string>",
"processes": "<string>",
"command": "<string>",
"config": "<string>",
"strategy_type": "<string>",
"strategy_threshold": "<string>",
"created_at": "<string>"
},
"relationships": {
"instance": {
"data": {
"type": "instances",
"id": "<string>"
}
}
}
}
],
"links": {
"first": "<string>",
"last": "<string>",
"prev": "<string>",
"next": "<string>"
},
"meta": {
"current_page": 123,
"from": 123,
"last_page": 123,
"links": [
{
"url": "<string>",
"label": "<string>",
"active": true
}
],
"path": "<string>",
"per_page": 123,
"to": 123,
"total": 123
},
"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": "<string>",
"id": "<string>"
}
]
}
}
}
]
}Get a list of all background processes for the given instance.
curl --request GET \
--url https://app.laravel.cloud/api/instances/{instance}/background-processes \
--header 'Authorization: Bearer <token>'{
"data": [
{
"id": "<string>",
"type": "<string>",
"attributes": {
"type": "<string>",
"processes": "<string>",
"command": "<string>",
"config": "<string>",
"strategy_type": "<string>",
"strategy_threshold": "<string>",
"created_at": "<string>"
},
"relationships": {
"instance": {
"data": {
"type": "instances",
"id": "<string>"
}
}
}
}
],
"links": {
"first": "<string>",
"last": "<string>",
"prev": "<string>",
"next": "<string>"
},
"meta": {
"current_page": 123,
"from": 123,
"last_page": 123,
"links": [
{
"url": "<string>",
"label": "<string>",
"active": true
}
],
"path": "<string>",
"per_page": 123,
"to": 123,
"total": 123
},
"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": "<string>",
"id": "<string>"
}
]
}
}
}
]
}The Bearer Token generated on the Cloud UI.
The instance identifier
Was this page helpful?