Skip to main content
GET
/
instances
/
{instance}
/
background-processes
List background processes
curl --request GET \
  --url https://app.laravel.cloud/api/instances/{instance}/background-processes \
  --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>"
          }
        }
      }
    }
  ],
  "links": {
    "first": "<string>",
    "last": "<string>",
    "prev": "<string>",
    "next": "<string>"
  },
  "meta": {
    "current_page": 2,
    "from": 2,
    "last_page": 2,
    "links": [
      {
        "url": "<string>",
        "label": "<string>",
        "active": true
      }
    ],
    "path": "<string>",
    "per_page": 1,
    "to": 2,
    "total": 1
  },
  "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>"
            }
          ]
        }
      }
    }
  ]
}

Authorizations

Authorization
string
header
required

The Bearer Token generated on the Cloud UI.

Path Parameters

instance
string
required

The instance identifier

Query Parameters

include
string

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

Response

Paginated set of BackgroundProcessResource

data
BackgroundProcessResource · object[]
required
meta
object
required
included
InstanceResource · object[]