Laravel

Laravel Deployments API

The Deployments API from Laravel — 13 operation(s) for deployments.

GitHub OpenAPI
Business capability
Deployment Orchestration BC-4210.40

Operations 23

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}/deployments List deployments for a Cloud environment · List deployments #
Ask an LLM
“Which deployments have run against my Laravel Cloud environment?”
“Can I filter an environment's deployments by branch name or commit hash?”
Tell an agent
List the deployments for environment {environment}.
Show environment {environment} deployments from branch {branch}.
POST /environments/{environment}/deployments Deploy a Cloud environment · Initiate deployment #
Ask an LLM
“How do I kick off a new deployment of a cloud environment?”
“Can an agent start an environment deploy without opening the dashboard?”
Tell an agent
Start a deployment of environment {environment}.
Redeploy the cloud environment {environment} now.
GET /deployments/{deployment} Get a Cloud deployment's details · Get deployment #
Ask an LLM
“What is the status of a specific cloud deployment I started?”
“Which commit and branch did a given environment deployment use?”
Tell an agent
Show the details of cloud deployment {deployment}.
Check whether cloud deployment {deployment} has finished.
GET /deployments/{deployment}/logs Read build and deploy logs for a Cloud deployment · Get deployment logs #
Ask an LLM
“Where can I see the build logs for a cloud deployment that failed?”
“Does the API return both build and deploy step logs for an environment deployment?”
Tell an agent
Fetch the build and deploy logs for cloud deployment {deployment}.
Show me why cloud deployment {deployment} broke by pulling its logs.
GET /orgs/{organization}/servers/{server}/sites/{site}/webhooks List deployment webhooks for a Forge site · List site webhooks #
Ask an LLM
“Which webhook URLs get notified when my Forge site deploys?”
“Can I page through and sort a site's deployment webhooks?”
Tell an agent
List the deployment webhooks on site {site} of server {server} in organization {organization}.
Show every webhook configured for site {site} on server {server}, org {organization}.
POST /orgs/{organization}/servers/{server}/sites/{site}/webhooks Add a deployment webhook to a site · Create site webhook #
Ask an LLM
“How can I get pinged at my own URL every time a site finishes deploying?”
“Can I register a webhook endpoint for a Forge site's deployments?”
Tell an agent
Add a deployment webhook to {url} for site {site} on server {server} in org {organization}.
Notify {url} whenever site {site} on server {server} ({organization}) deploys.
GET /orgs/{organization}/servers/{server}/sites/{site}/webhooks/{deploymentWebhook} Get one deployment webhook on a site · Get site webhook #
Ask an LLM
“What URL does a particular site deployment webhook point to?”
“Can I look up a single site webhook by its ID?”
Tell an agent
Show webhook {deploymentWebhook} on site {site}, server {server}, organization {organization}.
Get the details of deployment webhook {deploymentWebhook} for site {site} on server {server} in {organization}.
DELETE /orgs/{organization}/servers/{server}/sites/{site}/webhooks/{deploymentWebhook} Remove a deployment webhook from a site · Delete site webhook #
Ask an LLM
“How do I stop a site from calling an old webhook URL after deploys?”
“Can I delete just one deployment webhook and keep the others on the site?”
Tell an agent destructive · confirm first
Delete webhook {deploymentWebhook} from site {site} on server {server} in org {organization}.
Remove deployment webhook {deploymentWebhook} from site {site}, server {server}, {organization}.
GET /orgs/{organization}/servers/{server}/sites/{site}/deployments List recent deployments of a Forge site · List deployments #
Ask an LLM
“What were the recent deployments of my Forge site?”
“Can I filter a site's deployment history by commit author or commit message?”
Tell an agent
List recent deployments for site {site} on server {server} in organization {organization}.
Find deployments of site {site} on server {server} ({organization}) authored by {author}.
POST /orgs/{organization}/servers/{server}/sites/{site}/deployments Trigger a deployment of a Forge site · Create deployment #
Ask an LLM
“How do I deploy the latest code to a site on my server?”
“Can I trigger a site deployment from a script instead of the deploy button?”
Tell an agent
Deploy site {site} on server {server} in organization {organization}.
Trigger a new deployment for site {site} on server {server}, org {organization}.
GET /orgs/{organization}/servers/{server}/sites/{site}/deployments/status Check a site's current deployment state · Get deployment status #
Ask an LLM
“Is a deployment currently running on my site right now?”
“What deployment state is a Forge site stuck in?”
Tell an agent
Check the current deployment status of site {site} on server {server} in {organization}.
Tell me if site {site} on server {server} ({organization}) is mid-deploy.
DELETE /orgs/{organization}/servers/{server}/sites/{site}/deployments/status Reset a site's stuck deployment state · Update deployment state #
Ask an LLM
“My site says it's still deploying but nothing is happening — can I reset that?”
“How do I clear a stuck deployment state on a site?”
Tell an agent destructive · confirm first
Reset the deployment state for site {site} on server {server} in organization {organization}.
Clear the stuck deploy status on site {site}, server {server}, {organization}.
GET /orgs/{organization}/servers/{server}/sites/{site}/deployments/script View a site's deployment script · Get deployment script #
Ask an LLM
“What commands run when my site deploys?”
“Where can I read the current deploy script for a site?”
Tell an agent
Show the deployment script for site {site} on server {server} in {organization}.
Print the deploy script of site {site}, server {server}, organization {organization}.
PUT /orgs/{organization}/servers/{server}/sites/{site}/deployments/script Replace a site's deployment script · Update deployment script #
Ask an LLM
“Can I change the commands my site runs on deploy, like adding a migration step?”
“Is there an option to auto-source environment variables in the deploy script?”
Tell an agent
Set the deploy script for site {site} on server {server} in {organization} to {content}.
Replace site {site}'s deploy script on server {server} ({organization}) with {content} and auto-source env {auto_source}.
GET /orgs/{organization}/servers/{server}/sites/{site}/deployments/deploy-hook Get a site's deployment trigger URL · Get the deployment trigger URL #
Ask an LLM
“What URL can my CI call to trigger a deploy of a site?”
“Where do I find the deploy hook URL for a site?”
Tell an agent
Get the deployment trigger URL for site {site} on server {server} in {organization}.
Show the deploy hook URL of site {site}, server {server}, org {organization}.
PUT /orgs/{organization}/servers/{server}/sites/{site}/deployments/deploy-hook Regenerate a site's deploy hook token · Update deployment trigger URL #
Ask an LLM
“My deploy trigger URL leaked — can I rotate its token?”
“How do I regenerate the token in a site's deployment trigger URL?”
Tell an agent
Regenerate the deploy hook token for site {site} on server {server} in {organization}.
Rotate the deployment trigger URL of site {site}, server {server}, organization {organization}.
POST /orgs/{organization}/servers/{server}/sites/{site}/deployments/push-to-deploy Enable push to deploy for a site · Create push to deploy configuration #
Ask an LLM
“Can my site deploy automatically every time I push to the repository?”
“How do I turn on push to deploy for a site?”
Tell an agent
Enable push to deploy on site {site} on server {server} in {organization}.
Make site {site} on server {server} ({organization}) auto-deploy on every git push.
DELETE /orgs/{organization}/servers/{server}/sites/{site}/deployments/push-to-deploy Disable push to deploy for a site · Delete push to deploy configuration #
Ask an LLM
“Can I stop a site from auto-deploying when I push code?”
“What turns off push to deploy so I deploy manually again?”
Tell an agent destructive · confirm first
Disable push to deploy on site {site} on server {server} in {organization}.
Turn off automatic git-push deploys for site {site}, server {server}, org {organization}.
GET /orgs/{organization}/servers/{server}/sites/{site}/deployments/{deployment} Get one deployment of a Forge site · Get deployment #
Ask an LLM
“Which commit did a particular site deployment ship?”
“Can I look up a single past deployment on a Forge site?”
Tell an agent
Show deployment {deployment} of site {site} on server {server} in {organization}.
Get the details of site deployment {deployment} for site {site}, server {server}, org {organization}.
GET /orgs/{organization}/servers/{server}/sites/{site}/deployments/{deployment}/log Read the output of a site deployment · Get deployment output #
Ask an LLM
“What did the deploy script print during a specific site deployment?”
“Where is the output of a site deployment that failed on my server?”
Tell an agent
Show the output of deployment {deployment} on site {site}, server {server}, {organization}.
Fetch the deploy script output for site {site} deployment {deployment} on server {server} in {organization}.
GET /orgs/{organization}/servers/{server}/sites/{site}/deploy-key Get a site's repository deploy key · Get deploy key #
Ask an LLM
“What SSH deploy key should I add to my git repository for this site?”
“Does my site already have a deploy key?”
Tell an agent
Show the deploy key for site {site} on server {server} in {organization}.
Get the public deploy key of site {site}, server {server}, org {organization}.
POST /orgs/{organization}/servers/{server}/sites/{site}/deploy-key Create a repository deploy key for a site · Create deploy key #
Ask an LLM
“How do I generate a deploy key so the site can pull from a private repo?”
“What happens if I create a deploy key for a site that already has one?”
Tell an agent
Create a deploy key for site {site} on server {server} in {organization}.
Generate a repository deploy key for site {site}, server {server}, org {organization}.
DELETE /orgs/{organization}/servers/{server}/sites/{site}/deploy-key Remove a site's repository deploy key · Delete deploy key #
Ask an LLM
“Can I revoke the deploy key a site uses to access its repository?”
“How do I delete a site's deploy key?”
Tell an agent destructive · confirm first
Delete the deploy key for site {site} on server {server} in {organization}.
Remove the repository deploy key from site {site}, server {server}, org {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-deployments-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-deployments-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-deployments-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Laravel Deployments API
  version: 0.0.1
  description: 'Operations tagged Deployments 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 (72 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/laravel/refs/heads/main/openapi/laravel-deployments-api-openapi.yml