Laravel

Laravel Instances API

The Instances API from Laravel — 10 operation(s) for instances.

GitHub OpenAPI
Business capability
IT Infrastructure Management BC-600.50

Operations 13

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 /environments/{environment}/instances List an environment's instances · List instances #
Ask an LLM
“What compute instances are running in one of my Laravel Cloud environments?”
“Can I filter an environment's instances by type, size or scaling type?”
Tell an agent
List the instances in environment {environment}.
Show {type} instances of size {size} in environment {environment}.
POST /environments/{environment}/instances Create an instance in an environment · Create instance #
Ask an LLM
“How do I add a worker or managed queue instance to an environment?”
“Can a new instance autoscale between a minimum and maximum number of replicas?”
Tell an agent
Create a {type} instance named {name} of size {size} in environment {environment} with {scaling_type} scaling and at least {min_replicas} replicas.
Add instance {name} to {environment}: type {type}, size {size}, scaling {scaling_type}, {min_replicas}-{max_replicas} replicas.
GET /instances/sizes List available instance sizes · List instance sizes #
Ask an LLM
“What instance sizes can I choose from, grouped by category?”
“Which compute sizes are available before I create or resize an instance?”
Tell an agent
List all available instance sizes.
Show me the instance size options grouped by category.
GET /instances/{instance} Get an instance's details · Get instance #
Ask an LLM
“What size and replica settings does one of my instances have?”
“Can I look up a single instance by its ID?”
Tell an agent
Show instance {instance}.
Get the details and scaling settings of instance {instance}.
PATCH /instances/{instance} Resize or reconfigure an instance · Update instance #
Ask an LLM
“Can I change the size or replica limits of an existing instance?”
“How do I set the hibernation timeout or turn on Octane for an instance?”
Tell an agent
Resize instance {instance} to {size}.
Set instance {instance} to scale between {min_replicas} and {max_replicas} replicas.
DELETE /instances/{instance} Delete an instance · Delete instance #
Ask an LLM
“How do I remove an instance I no longer need from my environment?”
“Can I delete a single compute instance?”
Tell an agent destructive · confirm first
Delete instance {instance}.
Remove compute instance {instance} permanently.
POST /instances/{instance}/pause Pause a managed queue · Pause a managed queue #
Ask an LLM
“Can I stop workers from picking up jobs without losing what is queued?”
“Are queued messages kept when I pause a managed queue?”
Tell an agent
Pause managed queue {instance}.
Stop dispatching jobs from queue {instance} but keep its messages.
POST /instances/{instance}/resume Resume a paused managed queue · Resume a managed queue #
Ask an LLM
“How do I start a paused queue processing jobs again?”
“Can workers resume a managed queue after it was paused?”
Tell an agent
Resume managed queue {instance}.
Start dispatching jobs again on paused queue {instance}.
POST /instances/{instance}/purge Purge all messages from a managed queue · Purge a managed queue #
Ask an LLM
“How do I empty every pending message from a managed queue?”
“Can a purged queue's messages be recovered afterwards?”
Tell an agent destructive · confirm first
Purge all messages from managed queue {instance}.
Permanently clear the backlog in queue {instance}.
POST /instances/{instance}/default Make a managed queue the environment default · Set the default managed queue #
Ask an LLM
“Which queue do jobs go to when they don't name one, and can I change it?”
“How do I set the default managed queue for an environment?”
Tell an agent
Make managed queue {instance} the environment's default queue.
Route jobs without a named queue to {instance}.
GET /instances/{instance}/failed-jobs List failed jobs on a managed queue · List managed queue failed jobs #
Ask an LLM
“Which jobs have failed on my managed queue?”
“Can I see the failed jobs for a queue before retrying them?”
Tell an agent
List the failed jobs on managed queue {instance}.
Show what has failed on queue {instance}.
POST /instances/{instance}/failed-jobs/{jobId}/retry Retry a failed job on a managed queue · Retry a managed queue failed job #
Ask an LLM
“Can I re-queue a failed job so it runs again?”
“How do I retry one specific failed job on a managed queue?”
Tell an agent
Retry failed job {jobId} on managed queue {instance}.
Put failed job {jobId} back on queue {instance} for another attempt.
DELETE /instances/{instance}/failed-jobs/{jobId} Delete a failed job from a managed queue · Delete a managed queue failed job #
Ask an LLM
“How do I discard a failed job I don't want to retry?”
“Is removing a failed job from a managed queue permanent?”
Tell an agent destructive · confirm first
Delete failed job {jobId} from managed queue {instance}.
Discard failed job {jobId} on queue {instance} without retrying it.

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-instances-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-instances-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-instances-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Laravel Cloud Instances API
  version: 0.0.1
servers:
- url: https://cloud.laravel.com/api
security:
- http: []
tags:


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