Laravel

Laravel Background Processes API

The Background Processes API from Laravel — 5 operation(s) for background processes.

GitHub OpenAPI

Operations 11

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /instances/{instance}/background-processes List background processes on a Cloud instance · List background processes #
Ask an LLM
“What background processes are running on one of my Laravel Cloud instances?”
“Can I see the queue workers configured on a Cloud instance?”
Tell an agent
List the background processes on Cloud instance {instance}.
Show the workers configured for instance {instance}.
POST /instances/{instance}/background-processes Add a background process to a Cloud instance · Create background process #
Ask an LLM
“How do I add a queue worker to a Cloud instance?”
“Can I run a custom long-running command as a background process on an instance?”
Tell an agent
Add a {type} background process with {processes} processes to Cloud instance {instance}.
Run custom command {command} as {processes} {type} processes on instance {instance}.
GET /background-processes/{backgroundProcess} Get a Cloud background process · Get background process #
Ask an LLM
“What command and process count does a Cloud background process use?”
“Can I look up a Laravel Cloud background process by ID alone?”
Tell an agent
Show Cloud background process {backgroundProcess}.
Get the configuration of background process {backgroundProcess} on Laravel Cloud.
PATCH /background-processes/{backgroundProcess} Update a Cloud background process · Update background process #
Ask an LLM
“Can I change the number of processes a Cloud worker runs?”
“How do I change the command of an existing Laravel Cloud background process?”
Tell an agent
Scale Cloud background process {backgroundProcess} to {processes} processes.
Change the command of Cloud background process {backgroundProcess} to {command}.
DELETE /background-processes/{backgroundProcess} Delete a Cloud background process · Delete background process #
Ask an LLM
“How do I stop and remove a worker from a Laravel Cloud instance?”
“Can I delete a Cloud background process by its ID?”
Tell an agent destructive · confirm first
Delete Cloud background process {backgroundProcess}.
Remove worker {backgroundProcess} from Laravel Cloud.
GET /orgs/{organization}/servers/{server}/background-processes List background processes on a Forge server · List background processes #
Ask an LLM
“Which supervisor daemons are running on my Forge server?”
“Can I filter a server's background processes by user, site or directory?”
Tell an agent
List the background processes on Forge server {server} in {organization}.
Show daemons on server {server} in {organization} running as user {user}.
POST /orgs/{organization}/servers/{server}/background-processes Create a supervisor daemon on a Forge server · Create background process #
Ask an LLM
“How do I keep a command running permanently under supervisor on my server?”
“Can I choose the user, directory and stop signal for a new daemon?”
Tell an agent
Create a daemon named {name} on server {server} in {organization} running {command} as {user} with {processes} processes.
Start background process {name} on {server} in {organization}: run {command} as {user} from {directory}, {processes} processes.
GET /orgs/{organization}/servers/{server}/background-processes/{backgroundProcess} Get a background process on a Forge server · Get background process #
Ask an LLM
“What are the settings of one daemon on my Forge server?”
“Can I check a server background process by its ID?”
Tell an agent
Show background process {backgroundProcess} on server {server} in {organization}.
Get daemon {backgroundProcess} details from Forge server {server} in {organization}.
PUT /orgs/{organization}/servers/{server}/background-processes/{backgroundProcess} Update a daemon's supervisor configuration · Update background process #
Ask an LLM
“How do I edit the supervisor config of a daemon on my server?”
“Can I rename a background process on a Forge server?”
Tell an agent
Rename daemon {backgroundProcess} on server {server} in {organization} to {name}.
Update the supervisor config of daemon {backgroundProcess} ({name}) on {server} in {organization} to {config}.
DELETE /orgs/{organization}/servers/{server}/background-processes/{backgroundProcess} Delete a daemon from a Forge server · Delete background process #
Ask an LLM
“How do I remove a supervisor daemon from my server?”
“Can I delete a server background process I no longer need?”
Tell an agent destructive · confirm first
Delete daemon {backgroundProcess} from server {server} in {organization}.
Remove background process {backgroundProcess} on Forge server {server} in {organization}.
GET /orgs/{organization}/servers/{server}/background-processes/{backgroundProcess}/log Read a daemon's log output · Get background process log #
Ask an LLM
“Why does my daemon keep restarting? Can I read its log?”
“Where do I see the output of a background process on my server?”
Tell an agent
Show the log of daemon {backgroundProcess} on server {server} in {organization}.
Fetch the output log for background process {backgroundProcess} on {server} in {organization}.

Documentation

📖
Documentation
https://forge.laravel.com/docs/api-reference/introduction
📖
APIReference
https://forge.laravel.com/docs/api-reference/introduction
📖
Documentation
https://cloud.laravel.com/docs/api/authentication
📖
APIReference
https://cloud.laravel.com/docs/api/authentication

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/laravel/refs/heads/main/openapi/laravel-background-processes-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/laravel:laravel-background-processes-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

laravel-background-processes-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Laravel Background Processes API
  version: 0.0.1
  description: 'Operations tagged Background Processes across 2 of this provider''s published API definitions: laravel-cloud-openapi.json, laravel-forge-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://cloud.laravel.com/api
- url: https://forge.laravel.com/api
tags:


# --- truncated at 32 KB (43 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/laravel/refs/heads/main/openapi/laravel-background-processes-api-openapi.yml