Laravel

Laravel Environments API

The Environments API from Laravel — 9 operation(s) for environments.

GitHub OpenAPI
Business capability
Environment Management BC-4210.20

Operations 15

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 /applications/{application}/environments List an application's environments · List environments #
Ask an LLM
“Which environments does my Laravel Cloud application have?”
“Can I filter an app's environments by status or name?”
Tell an agent
List environments for application {application}.
Show environments of {application} with status {status}.
POST /applications/{application}/environments Create an environment for an application · Create environment #
Ask an LLM
“How do I add a staging environment to my application?”
“Can a new environment deploy from a different git branch?”
Tell an agent
Create environment {name} on application {application} from branch {branch}.
Add a {name} environment to {application} tracking branch {branch} on cluster {cluster_id}.
GET /environments/{environment}/logs Search an environment's logs · List environment logs #
Ask an LLM
“Where can I read the application logs for an environment over a time range?”
“Can I search environment logs for a word with case sensitivity?”
Tell an agent
Get logs for environment {environment} from {from} to {to}.
Search logs of {environment} for {query} between {from} and {to}.
GET /environments/{environment} Get an environment's details · Get environment #
Ask an LLM
“What are the settings of a specific environment?”
“Which branch and PHP version does an environment use?”
Tell an agent
Show environment {environment}.
Get details of environment {environment} including {include}.
PATCH /environments/{environment} Change an environment's settings · Update environment #
Ask an LLM
“How do I change the branch or PHP version an environment deploys?”
“Can I turn on Octane or push-to-deploy for an environment?”
Tell an agent
Set the PHP version of environment {environment} to {php_version}.
Change environment {environment} to deploy branch {branch} with build command {build_command}.
DELETE /environments/{environment} Delete an environment · Delete environment #
Ask an LLM
“How do I delete an environment I no longer need?”
“Can I permanently remove a preview environment?”
Tell an agent destructive · confirm first
Delete environment {environment}.
Tear down and remove environment {environment}.
POST /environments/{environment}/start Start an environment and deploy · Start environment #
Ask an LLM
“How do I start a stopped environment?”
“Can I restart an environment on the same commit instead of the latest one?”
Tell an agent
Start environment {environment}.
Start {environment} and redeploy the last commit: {redeploy}.
POST /environments/{environment}/stop Stop an environment · Stop environment #
Ask an LLM
“How do I stop an environment that is running?”
“Will stopping an environment cancel the deployment in progress?”
Tell an agent destructive · confirm first
Stop environment {environment}.
Shut down {environment} and cancel its running deployment.
POST /environments/{environment}/purge-edge-cache Purge an environment's edge cache · Purge edge cache #
Ask an LLM
“How do I clear the CDN cache for all my environment's domains?”
“Can I purge cached pages at the edge after a content change?”
Tell an agent
Purge the edge cache for environment {environment}.
Clear cached responses at the edge for every domain on {environment}.
PUT /environments/{environment}/vanity-domain Update vanity domain #
POST /environments/{environment}/variables Add environment variables · Add environment variables #
Ask an LLM
“How do I add .env variables to an environment?”
“Can I append variables or must I replace the whole set?”
Tell an agent
Add variables {variables} to environment {environment}.
Set environment variables {variables} on {environment} using method {method}.
POST /environments/{environment}/variables/delete Remove environment variables by key · Delete environment variables #
Ask an LLM
“How do I delete specific .env keys from an environment?”
“What happens if one of the variable keys I remove doesn't exist?”
Tell an agent destructive · confirm first
Delete variables {keys} from environment {environment}.
Remove env keys {keys} from {environment}.
GET /environments/{environment}/metrics Get an environment's metrics · Get environment metrics #
Ask an LLM
“How is my environment performing in terms of CPU and requests?”
“Can I see environment metrics for a chosen time period?”
Tell an agent
Show metrics for environment {environment}.
Get metrics for {environment} over period {period}.
POST /environments/{environment}/secrets Attach secrets to environment #
DELETE /environments/{environment}/secrets/{secret} Detach secret from environment #

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://artifacts.apis.io/laravel/openapi/laravel-environments-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-environments-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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


# --- truncated at 32 KB (107 KB total) ---
# Full source: https://artifacts.apis.io/laravel/openapi/laravel-environments-api-openapi.yml