Laravel Sites API
The Sites API from Laravel — 30 operation(s) for sites.
Operations 54
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
Ask an LLM
“Can I see every Forge site my API token has access to, across all organizations?”
“Which sites can this token reach without picking an organization first?”
Tell an agent
List all sites my token can access, across every organization.
Find sites named {name} among everything my token can access.
Ask an LLM
“What sites does one organization have across all of its servers?”
“Can I filter an organization's sites by name?”
Tell an agent
List every site in organization {organization}.
Find sites named {name} in organization {organization}.
Ask an LLM
“Can I look up a site by its ID without knowing which server it lives on?”
“What are the details of one specific site in my organization?”
Tell an agent
Show site {site} in organization {organization}.
Get the details of site {site} under {organization}, no server needed.
GET
/orgs/{organization}/servers/{server}/sites
List the sites hosted on a server · List sites for server
#
Ask an LLM
“Which sites are hosted on a particular server?”
“Can I sort the sites on one server and filter them by name?”
Tell an agent
List the sites hosted on server {server} in {organization}.
Show sites on server {server} in {organization} sorted by {sort}.
Ask an LLM
“How do I add a new site to one of my Forge servers?”
“Can I attach a Git repository and branch when creating a site?”
Tell an agent
Create a {type} site named {name} on server {server} in {organization}.
Add a {type} site to server {server} in {organization} from repo {repository} on branch {branch}.
POST
/orgs/{organization}/servers/{server}/sites/balancer
Create a site on a load balancer · Create site on a load balancer
#
Ask an LLM
“Can I set up a site on a load balancer server rather than an app server?”
“Which balancing method can a new load-balanced site use?”
Tell an agent
Create a load-balanced site for {domain} on balancer server {server} in {organization}.
Add {domain} to load balancer {server} in {organization} using the {balancer_method} method.
PUT
/orgs/{organization}/servers/{server}/sites/{site}
Update an existing site's settings · Update site
#
Ask an LLM
“Can I change the PHP version an existing site runs?”
“How do I switch the deploy branch or turn on push-to-deploy for a site I already have?”
Tell an agent
Switch site {site} on server {server} in {organization} to PHP {php_version}.
Change the deploy branch of site {site} on server {server} in {organization} to {repository_branch}.
DELETE
/orgs/{organization}/servers/{server}/sites/{site}
Delete a site from a server · Delete site
#
Ask an LLM
“How do I remove a site from a server entirely?”
“Does deleting a site happen right away or in the background?”
Tell an agent destructive · confirm first
Delete site {site} from server {server} in {organization}.
Remove the whole site {site} from server {server} in {organization}.
GET
/orgs/{organization}/servers/{server}/sites/{site}/certificates
List certificates across all of a site's domains · List site certificates
#
Ask an LLM
“Can I see every SSL certificate a site has, across all its domains at once?”
“Which certificates are installed for a site regardless of domain?”
Tell an agent
List all certificates for site {site} on server {server} in {organization}, across every domain.
Show every SSL certificate attached to any domain of site {site} on {server} in {organization}.
GET
/orgs/{organization}/servers/{server}/sites/{site}/domains
List a site's domains · List domains
#
Ask an LLM
“What domains are attached to a site?”
“Can I filter a site's domains by status or type?”
Tell an agent
List the domains on site {site} on server {server} in {organization}.
Show domains on site {site} on server {server} in {organization} with status {status}.
POST
/orgs/{organization}/servers/{server}/sites/{site}/domains
Add a domain to a site · Create domain
#
Ask an LLM
“How do I point another domain name at an existing site?”
“Can a new domain on a site allow wildcard subdomains and a www redirect?”
Tell an agent
Add domain {name} to site {site} on server {server} in {organization} with www redirect {www_redirect_type} and wildcard subdomains {allow_wildcard_subdomains}.
Attach {name} to site {site} on {server} in {organization}, redirect {www_redirect_type}, wildcards {allow_wildcard_subdomains}.
GET
/orgs/{organization}/servers/{server}/sites/{site}/domains/{domainRecord}
Get one domain on a site · Get domain
#
Ask an LLM
“What is the current status and setup of one domain on my site?”
“Can I fetch a single domain record by its ID?”
Tell an agent
Show domain {domainRecord} on site {site} on server {server} in {organization}.
Get the details of domain record {domainRecord} for site {site} on {server} in {organization}.
PATCH
/orgs/{organization}/servers/{server}/sites/{site}/domains/{domainRecord}
Change a domain's www redirect or wildcard setting · Update domain
#
Ask an LLM
“Can I change the www redirect on a domain that is already attached to my site?”
“Is it possible to turn wildcard subdomains on for an existing domain?”
Tell an agent
Set the www redirect of domain {domainRecord} on site {site} on {server} in {organization} to {www_redirect_type}.
Update domain {domainRecord} on site {site} on {server} in {organization}: redirect {www_redirect_type}, wildcards {allow_wildcard_subdomains}.
DELETE
/orgs/{organization}/servers/{server}/sites/{site}/domains/{domainRecord}
Remove a domain from a site · Delete domain
#
Ask an LLM
“How do I detach a domain name from a site?”
“Can I drop one domain without deleting the whole site?”
Tell an agent destructive · confirm first
Remove domain {domainRecord} from site {site} on server {server} in {organization}.
Delete domain record {domainRecord} from site {site} on {server} in {organization}, keeping the site.
GET
/orgs/{organization}/servers/{server}/sites/{site}/domains/{domainRecord}/configurations
Get DNS setup instructions for a domain · Get domain DNS configuration
#
Ask an LLM
“What DNS records do I need to create so my domain points at the site?”
“Where can I find the DNS configuration instructions for a domain I just added?”
Tell an agent
Show the DNS configuration instructions for domain {domainRecord} on site {site} on {server} in {organization}.
Tell me which DNS records to set for domain {domainRecord} of site {site} on {server} in {organization}.
POST
/orgs/{organization}/servers/{server}/sites/{site}/domains/{domainRecord}/actions
Run an action on a site domain · Create domain action
#
Ask an LLM
“Can I trigger an action against a domain on my site, such as re-checking it?”
“What kind of actions can be run on a domain record?”
Tell an agent
Run the {action} action on domain {domainRecord} of site {site} on {server} in {organization}.
Trigger domain action {action} for domain record {domainRecord} on site {site}, server {server}, org {organization}.
GET
/orgs/{organization}/servers/{server}/sites/{site}/domains/{domainRecord}/nginx
View the Nginx config for one domain · Get domain Nginx configuration
#
Ask an LLM
“Can I read the Nginx server block for a single domain rather than the whole site?”
“What does the per-domain Nginx configuration look like right now?”
Tell an agent
Show the Nginx configuration for domain {domainRecord} on site {site} on {server} in {organization}.
Fetch the domain-level Nginx config of {domainRecord} for site {site} on {server} in {organization}.
PUT
/orgs/{organization}/servers/{server}/sites/{site}/domains/{domainRecord}/nginx
Replace the Nginx config for one domain · Update domain Nginx configuration
#
Ask an LLM
“How do I edit the Nginx configuration of just one domain on my site?”
“Can I push a custom Nginx server block for a specific domain?”
Tell an agent
Replace the Nginx config for domain {domainRecord} on site {site} on {server} in {organization} with {config}.
Update the domain-level Nginx block of {domainRecord} (site {site}, server {server}, org {organization}) to {config}.
GET
/orgs/{organization}/servers/{server}/sites/{site}/domains/{domainRecord}/certificate
Get a domain's active certificate (singular path) · Get active domain certificate
#
Ask an LLM
“Which certificate is currently active on a domain, via the single /certificate endpoint?”
“Can I fetch the live SSL certificate for a domain from the older singular certificate route?”
Tell an agent
Get the active certificate of domain {domainRecord} on site {site} on {server} in {organization} using the singular /certificate route.
Show which certificate domain {domainRecord} serves now, via the /certificate endpoint, for site {site} on {server} in {organization}.
GET
/orgs/{organization}/servers/{server}/sites/{site}/domains/{domainRecord}/certificates
List all certificates for one domain · List domain certificates
#
Ask an LLM
“What certificates, active or not, exist for a single domain?”
“Can I see the certificate history of one domain on my site?”
Tell an agent
List all certificates for domain {domainRecord} on site {site} on {server} in {organization}.
Show every certificate issued for domain record {domainRecord} only, site {site}, server {server}, org {organization}.
POST
/orgs/{organization}/servers/{server}/sites/{site}/domains/{domainRecord}/certificates
Create or install a certificate for a domain · Create domain certificate
#
Ask an LLM
“How do I get a Let's Encrypt certificate for a domain on my site?”
“Can I install an existing certificate or generate a CSR for a domain instead?”
Tell an agent
Create a {type} certificate for domain {domainRecord} on site {site} on {server} in {organization}.
Issue a {type} certificate for domain {domainRecord} (site {site}, server {server}, org {organization}) and enable it: {enable}.
GET
/orgs/{organization}/servers/{server}/sites/{site}/domains/{domainRecord}/certificates/active
Get a domain's active certificate (certificates/active) · Get active domain certificate
#
Ask an LLM
“Which of a domain's certificates is the active one, using the certificates/active endpoint?”
“Can I check the active certificate from the plural certificates collection of a domain?”
Tell an agent
Get the active entry from the certificates collection of domain {domainRecord}, site {site}, server {server}, org {organization}.
Call certificates/active for domain {domainRecord} on site {site} on {server} in {organization}.
GET
/orgs/{organization}/servers/{server}/sites/{site}/domains/{domainRecord}/certificates/{certificate}
Get a specific certificate on a domain · Get domain certificate
#
Ask an LLM
“Can I look up one certificate on a domain by its certificate ID?”
“What are the details of a particular certificate, not necessarily the active one?”
Tell an agent
Show certificate {certificate} on domain {domainRecord} of site {site} on {server} in {organization}.
Get the details of certificate ID {certificate} for domain {domainRecord}, site {site}, server {server}, org {organization}.
DELETE
/orgs/{organization}/servers/{server}/sites/{site}/domains/{domainRecord}/certificates/{certificate}
Delete a certificate from a domain · Delete domain certificate
#
Ask an LLM
“How do I remove an old SSL certificate from a domain?”
“Can I delete one specific certificate without touching the domain?”
Tell an agent destructive · confirm first
Delete certificate {certificate} from domain {domainRecord} on site {site} on {server} in {organization}.
Remove certificate {certificate} of domain record {domainRecord}, site {site}, server {server}, org {organization}.
POST
/orgs/{organization}/servers/{server}/sites/{site}/domains/{domainRecord}/certificates/{certificate}/actions
Run an action on a domain certificate · Create domain certificate action
#
Ask an LLM
“Can I trigger an action, like activating, on a specific certificate of a domain?”
“What actions can be run against an installed domain certificate?”
Tell an agent
Run the {action} action on certificate {certificate} of domain {domainRecord}, site {site}, server {server}, org {organization}.
Apply certificate action {action} to {certificate} on domain {domainRecord} of site {site} on {server} in {organization}.
GET
/orgs/{organization}/servers/{server}/sites/{site}/healthcheck
Get a site's healthcheck endpoint · Get healthcheck endpoint
#
Ask an LLM
“What healthcheck URL is configured for my site?”
“Has a healthcheck endpoint been set on this site yet?”
Tell an agent
Show the healthcheck endpoint for site {site} on server {server} in {organization}.
Tell me which healthcheck URL site {site} on {server} in {organization} uses.
PUT
/orgs/{organization}/servers/{server}/sites/{site}/healthcheck
Set a site's healthcheck endpoint · Update healthcheck endpoint
#
Ask an LLM
“How do I change the healthcheck URL used for my site?”
“Can I point the site's healthcheck at a custom endpoint like /up?”
Tell an agent
Set the healthcheck endpoint of site {site} on server {server} in {organization} to {healthcheck_endpoint}.
Change site {site}'s healthcheck on {server} in {organization} to {healthcheck_endpoint}.
GET
/orgs/{organization}/servers/{server}/sites/{site}/environment
Read a site's .env file · Get .env content
#
Ask an LLM
“Can I read the current .env file of a site?”
“What environment variables is my site configured with?”
Tell an agent
Show the .env contents of site {site} on server {server} in {organization}.
Fetch the environment file for site {site} on {server} in {organization}.
PUT
/orgs/{organization}/servers/{server}/sites/{site}/environment
Replace a site's .env file · Update .env content
#
Ask an LLM
“How do I update the environment variables in a site's .env file?”
“Can I refresh the config cache or restart queues when saving a new .env?”
Tell an agent
Replace the .env of site {site} on server {server} in {organization} with {environment}.
Save new .env {environment} for site {site} on {server} in {organization} and restart queues: {queues}.
GET
/orgs/{organization}/servers/{server}/sites/{site}/nginx
View a site's Nginx configuration · Get Nginx configuration
#
Ask an LLM
“What does my site's main Nginx configuration file contain?”
“Can I read the site-wide Nginx config before editing it?”
Tell an agent
Show the site-wide Nginx configuration of site {site} on server {server} in {organization}.
Fetch the Nginx config file for the whole site {site} on {server} in {organization}.
PUT
/orgs/{organization}/servers/{server}/sites/{site}/nginx
Replace a site's Nginx configuration · Update Nginx configuration
#
Ask an LLM
“How do I edit the Nginx configuration for a whole site?”
“Can I overwrite a site's Nginx file with my own server config?”
Tell an agent
Replace the site-wide Nginx config of site {site} on server {server} in {organization} with {config}.
Update the main Nginx file for site {site} on {server} in {organization} to {config}.
GET
/orgs/{organization}/servers/{server}/sites/{site}/composer/credentials
List a site's Composer credentials · Get composer credentials for the site
#
Ask an LLM
“Which private Composer repositories has my site been given credentials for?”
“Can I see all Composer auth entries configured on a site?”
Tell an agent
List the Composer credentials for site {site} on server {server} in {organization}.
Show all Composer repository logins configured on site {site} on {server} in {organization}.
POST
/orgs/{organization}/servers/{server}/sites/{site}/composer/credentials
Add Composer credentials to a site · Create composer credentials for the site
#
Ask an LLM
“How do I let my site install packages from a private Composer repository?”
“Can I store a username and password for a Composer repo on a site?”
Tell an agent
Add Composer credentials for {repository} with user {username} and password {password} to site {site} on {server} in {organization}.
Give site {site} on {server} in {organization} access to Composer repo {repository} as {username} / {password}.
GET
/orgs/{organization}/servers/{server}/sites/{site}/composer/credentials/{repository}
Get a site's Composer credential for a repository · Get composer credential for the site
#
Ask an LLM
“Can I check the Composer credential stored for one specific repository on my site?”
“What username is saved for a given private Composer repository?”
Tell an agent
Show the Composer credential for repository {repository} on site {site} on {server} in {organization}.
Get the stored Composer login for {repository} on site {site}, server {server}, org {organization}.
PUT
/orgs/{organization}/servers/{server}/sites/{site}/composer/credentials/{repository}
Update a site's Composer credentials · Update composer credentials for the site
#
Ask an LLM
“How do I rotate the password for a private Composer repository on my site?”
“Can I change the username saved for an existing Composer credential?”
Tell an agent
Update the Composer credential {repository} on site {site} on {server} in {organization} to user {username} and password {password}.
Rotate the Composer password for existing repo {repository} on site {site}, server {server}, org {organization}, to {password} for {username}.
DELETE
/orgs/{organization}/servers/{server}/sites/{site}/composer/credentials/{repository}
Delete a site's Composer credentials · Delete composer credentials for the site
#
Ask an LLM
“How do I remove access to a private Composer repository from a site?”
“Can I delete one Composer credential and keep the others?”
Tell an agent destructive · confirm first
Delete the Composer credential for {repository} from site {site} on {server} in {organization}.
Remove Composer repo login {repository} on site {site}, server {server}, org {organization}.
GET
/orgs/{organization}/servers/{server}/sites/{site}/npm/credentials
List a site's NPM registry credentials · Get NPM credentials for the site
#
Ask an LLM
“Which private NPM registries does my site have tokens for?”
“Can I list all NPM credentials on a site?”
Tell an agent
List the NPM credentials for site {site} on server {server} in {organization}.
Show every NPM registry token configured on site {site} on {server} in {organization}.
POST
/orgs/{organization}/servers/{server}/sites/{site}/npm/credentials
Add NPM registry credentials to a site · Create NPM credentials for the site
#
Ask an LLM
“How do I let a site's build install packages from a private NPM registry?”
“Can I limit a new NPM registry token to certain package scopes?”
Tell an agent
Add an NPM token {token} for registry {registry} to site {site} on {server} in {organization}.
Configure NPM registry {registry} with token {token} for scopes {scopes} on site {site}, server {server}, org {organization}.
GET
/orgs/{organization}/servers/{server}/sites/{site}/npm/credentials/{registry}
Get a site's NPM credential for a registry · Get NPM credential for the site
#
Ask an LLM
“Can I look at the NPM credential saved for one particular registry?”
“Which scopes are attached to a site's NPM registry credential?”
Tell an agent
Show the NPM credential for registry {registry} on site {site} on {server} in {organization}.
Get the saved NPM token entry for {registry} on site {site}, server {server}, org {organization}.
PUT
/orgs/{organization}/servers/{server}/sites/{site}/npm/credentials/{registry}
Update a site's NPM registry credentials · Update NPM credentials for the site
#
Ask an LLM
“How do I rotate the token for a private NPM registry on my site?”
“Can I change the scopes on an existing NPM credential?”
Tell an agent
Update NPM registry credential {registry} on site {site} on {server} in {organization} with new token {token}.
Rotate the existing NPM token for {registry} on site {site}, server {server}, org {organization}, to {token} with scopes {scopes}.
DELETE
/orgs/{organization}/servers/{server}/sites/{site}/npm/credentials/{registry}
Delete a site's NPM registry credentials · Delete npm credentials for the site
#
Ask an LLM
“How do I revoke a site's access to a private NPM registry?”
“Can I delete the NPM token for one registry only?”
Tell an agent destructive · confirm first
Delete the NPM credential for registry {registry} from site {site} on {server} in {organization}.
Remove NPM registry token {registry} from site {site}, server {server}, org {organization}.
GET
/orgs/{organization}/servers/{server}/sites/{site}/load-balancing-nodes
List a load-balanced site's backend nodes · List load balancing nodes
#
Ask an LLM
“Which servers is my load balancer currently sending traffic to for this site?”
“Can I sort the load balancing nodes of a site?”
Tell an agent
List the load balancing nodes for site {site} on balancer {server} in {organization}.
Show the backend servers behind load-balanced site {site} on {server} in {organization}.
PUT
/orgs/{organization}/servers/{server}/sites/{site}/load-balancing-nodes
Change a site's load balancing nodes and method · Update load balancing nodes
#
Ask an LLM
“How do I change which servers a load-balanced site sends traffic to?”
“Can I switch an existing load balancer to a different balancing method?”
Tell an agent
Set the nodes of load-balanced site {site} on {server} in {organization} to {balancing} using {balancer_method}.
Rebalance site {site} on balancer {server} in {organization} across {balancing} with method {balancer_method}.
GET
/orgs/{organization}/servers/{server}/sites/{site}/logs/nginx-access
Read a site's Nginx access log · Get Nginx access log content
#
Ask an LLM
“Can I see which requests have hit my site in the Nginx access log?”
“Where do I read the access log for one site?”
Tell an agent
Show the Nginx access log for site {site} on server {server} in {organization}.
Fetch recent access log entries for site {site} on {server} in {organization}.
DELETE
/orgs/{organization}/servers/{server}/sites/{site}/logs/nginx-access
Clear a site's Nginx access log · Delete Nginx access log content
#
Ask an LLM
“How do I wipe the Nginx access log for a site?”
“Can I clear a site's access log to free up space?”
Tell an agent destructive · confirm first
Clear the Nginx access log of site {site} on server {server} in {organization}.
Empty the access log for site {site} on {server} in {organization}.
GET
/orgs/{organization}/servers/{server}/sites/{site}/logs/nginx-error
Read a site's Nginx error log · Get Nginx error log content
#
Ask an LLM
“Why is my site returning 502s? Can I read its Nginx error log?”
“Where can I view the web server error log for one site?”
Tell an agent
Show the Nginx error log for site {site} on server {server} in {organization}.
Fetch the web server error entries for site {site} on {server} in {organization}.
DELETE
/orgs/{organization}/servers/{server}/sites/{site}/logs/nginx-error
Clear a site's Nginx error log · Delete Nginx error log content
#
Ask an LLM
“How do I clear out the Nginx error log for a site after fixing an issue?”
“Can I reset a site's web server error log?”
Tell an agent destructive · confirm first
Clear the Nginx error log of site {site} on server {server} in {organization}.
Empty the web server error log for site {site} on {server} in {organization}.
GET
/orgs/{organization}/servers/{server}/sites/{site}/logs/application
Read a site's application log · Get site log content
#
Ask an LLM
“Can I read my Laravel app's own log file for a site?”
“Where do I see the application exceptions a site has logged?”
Tell an agent
Show the application log for site {site} on server {server} in {organization}.
Fetch the Laravel app log content of site {site} on {server} in {organization}.
DELETE
/orgs/{organization}/servers/{server}/sites/{site}/logs/application
Clear a site's application log · Delete site log content
#
Ask an LLM
“How do I truncate my site's application log?”
“Can I delete the Laravel log content for one site?”
Tell an agent destructive · confirm first
Clear the application log of site {site} on server {server} in {organization}.
Empty the Laravel app log for site {site} on {server} in {organization}.
GET
/orgs/{organization}/servers/{server}/sites/{site}/heartbeats
List a site's heartbeats · List heartbeats
#
Ask an LLM
“What heartbeat checks are set up for my site?”
“Can I page through all the heartbeats on a site?”
Tell an agent
List the heartbeats for site {site} on server {server} in {organization}.
Show every heartbeat monitor configured on site {site} on {server} in {organization}.
POST
/orgs/{organization}/servers/{server}/sites/{site}/heartbeats
Create a heartbeat for a site · Create heartbeat
#
Ask an LLM
“How do I get alerted when a scheduled task on my site stops checking in?”
“Can a heartbeat use a custom frequency and grace period?”
Tell an agent
Create a heartbeat named {name} on site {site} on {server} in {organization}, every {frequency} with a {grace_period} grace period.
Add heartbeat {name} to site {site} on {server} in {organization} with frequency {frequency}, custom {custom_frequency}, grace {grace_period}.
GET
/orgs/{organization}/servers/{server}/sites/{site}/heartbeats/{heartbeat}
Get one heartbeat on a site · Get heartbeat
#
Ask an LLM
“Is a particular heartbeat on my site currently healthy?”
“Can I fetch one heartbeat's settings by its ID?”
Tell an agent
Show heartbeat {heartbeat} on site {site} on server {server} in {organization}.
Get the status of heartbeat {heartbeat} for site {site} on {server} in {organization}.
PUT
/orgs/{organization}/servers/{server}/sites/{site}/heartbeats/{heartbeat}
Update a site heartbeat · Update heartbeat
#
Ask an LLM
“Can I change how often an existing heartbeat expects a ping?”
“How do I lengthen the grace period on a heartbeat I already created?”
Tell an agent
Update heartbeat {heartbeat} on site {site} on {server} in {organization}: name {name}, frequency {frequency}, grace {grace_period}.
Change existing heartbeat {heartbeat} ({name}) on site {site}, server {server}, org {organization} to grace {grace_period} at {frequency}.
DELETE
/orgs/{organization}/servers/{server}/sites/{site}/heartbeats/{heartbeat}
Delete a site heartbeat · Delete heartbeat
#
Ask an LLM
“How do I stop monitoring a heartbeat I no longer need?”
“Can I delete a single heartbeat from a site?”
Tell an agent destructive · confirm first
Delete heartbeat {heartbeat} from site {site} on server {server} in {organization}.
Remove the heartbeat check {heartbeat} on 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