Skip to main content
GET
/
background-processes
/
{backgroundProcess}
Get background process
curl --request GET \
  --url https://app.laravel.cloud/api/background-processes/{backgroundProcess} \
  --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>"
        }
      }
    }
  }
}

Authorizations

Authorization
string
header
required

The Bearer Token generated on the Cloud UI.

Path Parameters

backgroundProcess
string | null
required

The background process identifier

Response

BackgroundProcessResource

data
object
required