Laravel Integrations API
The Integrations API from Laravel — 7 operation(s) for integrations.
Operations 20
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
/orgs/{organization}/servers/{server}/sites/{site}/integrations/horizon
Check whether Horizon is enabled on a site · Get Laravel Horizon integration status
#
Ask an LLM
“Is Laravel Horizon set up to run the queue workers on my site?”
“Can I check the Horizon integration status for a Forge site?”
Tell an agent
Check the Horizon integration status of site {site} on server {server} in {organization}.
Tell me if Horizon is enabled for site {site}, server {server}, org {organization}.
POST
/orgs/{organization}/servers/{server}/sites/{site}/integrations/horizon
Enable Laravel Horizon on a site · Create Laravel Horizon integration
#
Ask an LLM
“How do I turn on Horizon so my site's Redis queues are managed?”
“Can I enable the Horizon integration through the API?”
Tell an agent
Enable Horizon on site {site} on server {server} in {organization}.
Set up the Laravel Horizon integration for site {site}, server {server}, org {organization}.
DELETE
/orgs/{organization}/servers/{server}/sites/{site}/integrations/horizon
Disable Laravel Horizon on a site · Delete Laravel Horizon integration
#
Ask an LLM
“Can I remove Horizon from a site that no longer uses queues?”
“What turns off the Horizon integration for a site?”
Tell an agent destructive · confirm first
Disable Horizon on site {site} on server {server} in {organization}.
Remove the Laravel Horizon integration from site {site}, server {server}, org {organization}.
GET
/orgs/{organization}/servers/{server}/sites/{site}/integrations/octane
Check whether Octane is enabled on a site · Get Laravel Octane integration status
#
Ask an LLM
“Is my site being served by Laravel Octane?”
“How can I see if the Octane integration is turned on for a site?”
Tell an agent
Check the Octane integration status of site {site} on server {server} in {organization}.
Tell me whether Octane is enabled for site {site}, server {server}, org {organization}.
POST
/orgs/{organization}/servers/{server}/sites/{site}/integrations/octane
Enable Laravel Octane on a site · Create Laravel Octane integration
#
Ask an LLM
“Can I run my site on Octane with a specific port and server engine?”
“Which settings does enabling Octane on a site require?”
Tell an agent
Enable Octane on site {site} (server {server}, {organization}) using the {engine} engine on port {port}.
Turn on Laravel Octane for site {site} on server {server} in {organization} listening on port {port}, engine {engine}.
DELETE
/orgs/{organization}/servers/{server}/sites/{site}/integrations/octane
Disable Laravel Octane on a site · Delete Laravel Octane integration
#
Ask an LLM
“How do I move a site off Octane back to regular PHP-FPM serving?”
“Can I switch off the Octane integration for one site?”
Tell an agent destructive · confirm first
Disable Octane on site {site} on server {server} in {organization}.
Remove the Laravel Octane integration from site {site}, server {server}, org {organization}.
GET
/orgs/{organization}/servers/{server}/sites/{site}/integrations/reverb
Check whether Reverb is enabled on a site · Get Laravel Reverb integration status
#
Ask an LLM
“Is the Reverb WebSocket server running for my site?”
“Can I check the Reverb integration status of a site?”
Tell an agent
Check the Reverb integration status of site {site} on server {server} in {organization}.
Tell me whether Reverb is enabled for site {site}, server {server}, org {organization}.
POST
/orgs/{organization}/servers/{server}/sites/{site}/integrations/reverb
Enable Laravel Reverb on a site · Create Laravel Reverb integration
#
Ask an LLM
“How do I set up Reverb WebSockets on a site with my own host, port and connection limit?”
“What do I need to provide to enable Reverb for a site?”
Tell an agent
Enable Reverb on site {site} (server {server}, {organization}) at host {host}, port {port}, max {connections} connections.
Set up Laravel Reverb for site {site} on server {server} in {organization} with host {host}, port {port} and {connections} connections.
DELETE
/orgs/{organization}/servers/{server}/sites/{site}/integrations/reverb
Disable Laravel Reverb on a site · Delete Laravel Reverb integration
#
Ask an LLM
“Can I shut down the Reverb WebSocket server for a site?”
“What removes the Reverb integration from a site?”
Tell an agent destructive · confirm first
Disable Reverb on site {site} on server {server} in {organization}.
Remove the Laravel Reverb integration from site {site}, server {server}, org {organization}.
GET
/orgs/{organization}/servers/{server}/sites/{site}/integrations/inertia
Check whether Inertia SSR is enabled on a site · Get Inertia integration status
#
Ask an LLM
“Is Inertia server-side rendering enabled for my site?”
“Can I check a site's Inertia SSR integration status?”
Tell an agent
Check the Inertia SSR status of site {site} on server {server} in {organization}.
Tell me whether Inertia SSR is on for site {site}, server {server}, org {organization}.
POST
/orgs/{organization}/servers/{server}/sites/{site}/integrations/inertia
Enable Inertia SSR on a site · Create Inertia integration
#
Ask an LLM
“How do I turn on Inertia server-side rendering for a site?”
“Can the Inertia SSR process be enabled from the API?”
Tell an agent
Enable Inertia SSR on site {site} on server {server} in {organization}.
Set up the Inertia integration for site {site}, server {server}, org {organization}.
GET
/orgs/{organization}/servers/{server}/sites/{site}/integrations/pulse
Check whether Pulse is enabled on a site · Get Laravel Pulse integration status
#
Ask an LLM
“Is Laravel Pulse monitoring switched on for my site?”
“Can I check a site's Pulse integration status?”
Tell an agent
Check the Pulse integration status of site {site} on server {server} in {organization}.
Tell me whether Pulse is enabled for site {site}, server {server}, org {organization}.
POST
/orgs/{organization}/servers/{server}/sites/{site}/integrations/pulse
Enable Laravel Pulse on a site · Create Laravel Pulse integration
#
Ask an LLM
“How do I start collecting Pulse performance metrics for a site?”
“Can the Pulse integration be enabled through the API?”
Tell an agent
Enable Pulse on site {site} on server {server} in {organization}.
Set up the Laravel Pulse integration for site {site}, server {server}, org {organization}.
DELETE
/orgs/{organization}/servers/{server}/sites/{site}/integrations/pulse
Disable Laravel Pulse on a site · Delete Laravel Pulse integration
#
Ask an LLM
“Can I turn off Pulse monitoring for a site?”
“What removes the Pulse integration from a site?”
Tell an agent destructive · confirm first
Disable Pulse on site {site} on server {server} in {organization}.
Remove the Laravel Pulse integration from site {site}, server {server}, org {organization}.
GET
/orgs/{organization}/servers/{server}/sites/{site}/integrations/laravel-maintenance
Check whether a site is in maintenance mode · Get Laravel Maintenance integration status
#
Ask an LLM
“Is my site currently down for maintenance?”
“Can I check a site's maintenance mode status?”
Tell an agent
Check whether site {site} on server {server} in {organization} is in maintenance mode.
Show the maintenance mode status of site {site}, server {server}, org {organization}.
POST
/orgs/{organization}/servers/{server}/sites/{site}/integrations/laravel-maintenance
Put a site into maintenance mode · Create Laravel Maintenance integration
#
Ask an LLM
“How do I take my site down for maintenance with a bypass secret?”
“Can maintenance mode redirect visitors and return a custom HTTP status?”
Tell an agent
Put site {site} on server {server} in {organization} into maintenance mode with status {status}.
Enable maintenance on site {site} (server {server}, {organization}) returning {status}, bypass secret {secret}, redirect to {redirect}.
DELETE
/orgs/{organization}/servers/{server}/sites/{site}/integrations/laravel-maintenance
Bring a site out of maintenance mode · Delete Laravel Maintenance integration
#
Ask an LLM
“How do I bring my site back online after maintenance?”
“Can an agent lift maintenance mode on a site?”
Tell an agent destructive · confirm first
Take site {site} on server {server} in {organization} out of maintenance mode.
Disable maintenance mode for site {site}, server {server}, org {organization}.
GET
/orgs/{organization}/servers/{server}/sites/{site}/integrations/laravel-scheduler
Check whether the Laravel scheduler runs for a site · Get Laravel Scheduler integration job
#
Ask an LLM
“Is the scheduler cron job running my site's scheduled tasks?”
“Can I check if the Laravel Scheduler integration is enabled on a site?”
Tell an agent
Check the scheduler integration status of site {site} on server {server} in {organization}.
Tell me whether schedule:run is set up for site {site}, server {server}, org {organization}.
POST
/orgs/{organization}/servers/{server}/sites/{site}/integrations/laravel-scheduler
Enable the Laravel scheduler job for a site · Create Laravel Scheduler integration job
#
Ask an LLM
“How do I get my site's scheduled commands to actually run on the server?”
“Can I create the scheduler job for a site through the API?”
Tell an agent
Enable the Laravel Scheduler job for site {site} on server {server} in {organization}.
Start running scheduled tasks for site {site}, server {server}, org {organization}.
DELETE
/orgs/{organization}/servers/{server}/sites/{site}/integrations/laravel-scheduler
Disable the Laravel scheduler job for a site · Delete Laravel Scheduler integration job
#
Ask an LLM
“Can I stop a site's scheduled tasks from running?”
“What removes the scheduler integration job from a site?”
Tell an agent destructive · confirm first
Remove the Laravel Scheduler job from site {site} on server {server} in {organization}.
Stop scheduled tasks running for 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