Skip to main content
GET
/
background-processes
/
{backgroundProcess}
Get background process
curl --request GET \
  --url https://cloud.laravel.com/api/background-processes/{backgroundProcess} \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "id": "<string>",
    "type": "background_processes",
    "relationships": {}
  },
  "included": [
    {
      "id": "<string>",
      "type": "instances",
      "relationships": {}
    }
  ]
}

Authorizations

Authorization
string
header
required

The Bearer Token generated on the Cloud UI.

Path Parameters

backgroundProcess
string | null
required

The background process identifier

Query Parameters

include
string

Available includes are instance. You can include multiple options by separating them with a comma.

Response

BackgroundProcessResource

data
BackgroundProcessResource · object
required
included
InstanceResource · object[]