How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Laravel Sites API

The Sites API from Laravel — 30 operation(s) for sites.

Laravel Sites API is one of 42 APIs that Laravel publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Sites. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 54 operations across 30 paths, and defines 67 schemas. It is described by OpenAPI 3.1.0, at version 0.0.1.

Requests are made against a single base URL, https://cloud.laravel.com/api.

54 operations 30 paths 67 schemas 9 DELETE26 GET1 PATCH9 POST9 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
0.0.1
Base URL
https://forge.laravel.com/api
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Laravel Sites API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearer) (http). By default, every request must be authenticated.

  • http — The Bearer Token generated on the Cloud UI.

Paths & Operations 54

Across 30 paths, the API surfaces 54 operations — 9 DELETE, 26 GET, 1 PATCH, 9 POST, 9 PUT. Each is listed below with its method, path, parameters, and response codes.

Sites 54
GET
/sites
List sites
sites.index 4 params → 200403
GET
/orgs/{organization}/sites
List sites for Organization
organizations.sites.index 5 params → 200404403
GET
/orgs/{organization}/sites/{site}
Get site
organizations.sites.show 2 params → 200404403
GET
/orgs/{organization}/servers/{server}/sites
List sites for server
organizations.servers.sites.index 7 params → 200404403
POST
/orgs/{organization}/servers/{server}/sites
Create site
organizations.servers.sites.store 2 params body → 202404403422
POST
/orgs/{organization}/servers/{server}/sites/balancer
Create site on a load balancer
organizations.servers.sites.storeOnBalancer 2 params body → 202404403422
PUT
/orgs/{organization}/servers/{server}/sites/{site}
Update site
organizations.servers.sites.update 3 params body → 202404403422
DELETE
/orgs/{organization}/servers/{server}/sites/{site}
Delete site
organizations.servers.sites.destroy 3 params → 202404403
GET
/orgs/{organization}/servers/{server}/sites/{site}/certificates
List site certificates
organizations.servers.sites.certificates.index 3 params → 200404403
GET
/orgs/{organization}/servers/{server}/sites/{site}/domains
List domains
organizations.servers.sites.domains.index 8 params → 200404403
POST
/orgs/{organization}/servers/{server}/sites/{site}/domains
Create domain
organizations.servers.sites.domains.store 3 params body → 202404403422
GET
/orgs/{organization}/servers/{server}/sites/{site}/domains/{domainRecord}
Get domain
organizations.servers.sites.domains.show 4 params → 200404403
PATCH
/orgs/{organization}/servers/{server}/sites/{site}/domains/{domainRecord}
Update domain
organizations.servers.sites.domains.update 4 params body → 200404403422
DELETE
/orgs/{organization}/servers/{server}/sites/{site}/domains/{domainRecord}
Delete domain
organizations.servers.sites.domains.destroy 4 params → 204404403
GET
/orgs/{organization}/servers/{server}/sites/{site}/domains/{domainRecord}/configurations
Get domain DNS configuration
organizations.servers.sites.domains.configurations 4 params → 200404403
POST
/orgs/{organization}/servers/{server}/sites/{site}/domains/{domainRecord}/actions
Create domain action
organizations.servers.sites.domains.actions.store 4 params body → 202404403422
GET
/orgs/{organization}/servers/{server}/sites/{site}/domains/{domainRecord}/nginx
Get domain Nginx configuration
organizations.servers.sites.domains.nginx.show 4 params → 200404403
PUT
/orgs/{organization}/servers/{server}/sites/{site}/domains/{domainRecord}/nginx
Update domain Nginx configuration
organizations.servers.sites.domains.nginx.update 4 params body → 202404403422
GET
/orgs/{organization}/servers/{server}/sites/{site}/domains/{domainRecord}/certificate
Get active domain certificate
organizations.servers.sites.domains.certificate.show 4 params → 200404403
GET
/orgs/{organization}/servers/{server}/sites/{site}/domains/{domainRecord}/certificates
List domain certificates
organizations.servers.sites.domains.certificates.index 4 params → 200404403
POST
/orgs/{organization}/servers/{server}/sites/{site}/domains/{domainRecord}/certificates
Create domain certificate
organizations.servers.sites.domains.certificates.store 4 params body → 202404403422
GET
/orgs/{organization}/servers/{server}/sites/{site}/domains/{domainRecord}/certificates/active
Get active domain certificate
organizations.servers.sites.domains.certificates.active 4 params → 200404403
GET
/orgs/{organization}/servers/{server}/sites/{site}/domains/{domainRecord}/certificates/{certificate}
Get domain certificate
organizations.servers.sites.domains.certificates.show 5 params → 200404403
DELETE
/orgs/{organization}/servers/{server}/sites/{site}/domains/{domainRecord}/certificates/{certificate}
Delete domain certificate
organizations.servers.sites.domains.certificates.destroy 5 params → 202404403
POST
/orgs/{organization}/servers/{server}/sites/{site}/domains/{domainRecord}/certificates/{certificate}/actions
Create domain certificate action
organizations.servers.sites.domains.certificates.actions.store 5 params body → 202404403422
GET
/orgs/{organization}/servers/{server}/sites/{site}/healthcheck
Get healthcheck endpoint
organizations.servers.sites.healthcheck.show 3 params → 200404403
PUT
/orgs/{organization}/servers/{server}/sites/{site}/healthcheck
Update healthcheck endpoint
organizations.servers.sites.healthcheck.update 3 params body → 204404403422
GET
/orgs/{organization}/servers/{server}/sites/{site}/environment
Get .env content
organizations.servers.sites.environment.show 3 params → 200404403
PUT
/orgs/{organization}/servers/{server}/sites/{site}/environment
Update .env content
organizations.servers.sites.environment.update 3 params body → 202422404403
GET
/orgs/{organization}/servers/{server}/sites/{site}/nginx
Get Nginx configuration
organizations.servers.sites.nginx.show 3 params → 200404403
PUT
/orgs/{organization}/servers/{server}/sites/{site}/nginx
Update Nginx configuration
organizations.servers.sites.nginx.update 3 params body → 202404403422
GET
/orgs/{organization}/servers/{server}/sites/{site}/composer/credentials
Get composer credentials for the site
organizations.servers.sites.composer.credentials.index 3 params → 200404403
POST
/orgs/{organization}/servers/{server}/sites/{site}/composer/credentials
Create composer credentials for the site
organizations.servers.sites.composer.credentials.store 3 params body → 202404403422
GET
/orgs/{organization}/servers/{server}/sites/{site}/composer/credentials/{repository}
Get composer credential for the site
organizations.servers.sites.composer.credentials.show 4 params → 200404403
PUT
/orgs/{organization}/servers/{server}/sites/{site}/composer/credentials/{repository}
Update composer credentials for the site
organizations.servers.sites.composer.credentials.update 4 params body → 202404403422
DELETE
/orgs/{organization}/servers/{server}/sites/{site}/composer/credentials/{repository}
Delete composer credentials for the site
organizations.servers.sites.composer.credentials.destroy 4 params → 202404403
GET
/orgs/{organization}/servers/{server}/sites/{site}/npm/credentials
Get NPM credentials for the site
organizations.servers.sites.npm.credentials.index 3 params → 200404403
POST
/orgs/{organization}/servers/{server}/sites/{site}/npm/credentials
Create NPM credentials for the site
organizations.servers.sites.npm.credentials.store 3 params body → 202404403422
GET
/orgs/{organization}/servers/{server}/sites/{site}/npm/credentials/{registry}
Get NPM credential for the site
organizations.servers.sites.npm.credentials.show 4 params → 200404403
PUT
/orgs/{organization}/servers/{server}/sites/{site}/npm/credentials/{registry}
Update NPM credentials for the site
organizations.servers.sites.npm.credentials.update 4 params body → 202404403422
DELETE
/orgs/{organization}/servers/{server}/sites/{site}/npm/credentials/{registry}
Delete npm credentials for the site
organizations.servers.sites.npm.credentials.destroy 4 params → 202404403
GET
/orgs/{organization}/servers/{server}/sites/{site}/load-balancing-nodes
List load balancing nodes
organizations.servers.sites.load-balancing-nodes.index 6 params → 200404403
PUT
/orgs/{organization}/servers/{server}/sites/{site}/load-balancing-nodes
Update load balancing nodes
organizations.servers.sites.load-balancing-nodes.update 3 params body → 202404403422
GET
/orgs/{organization}/servers/{server}/sites/{site}/logs/nginx-access
Get Nginx access log content
organizations.servers.sites.logs.nginx-access.show 3 params → 200404403
DELETE
/orgs/{organization}/servers/{server}/sites/{site}/logs/nginx-access
Delete Nginx access log content
organizations.servers.sites.logs.nginx-access.destroy 3 params → 202404403
GET
/orgs/{organization}/servers/{server}/sites/{site}/logs/nginx-error
Get Nginx error log content
organizations.servers.sites.logs.nginx-error.show 3 params → 200404403
DELETE
/orgs/{organization}/servers/{server}/sites/{site}/logs/nginx-error
Delete Nginx error log content
organizations.servers.sites.logs.nginx-error.destroy 3 params → 202404403
GET
/orgs/{organization}/servers/{server}/sites/{site}/logs/application
Get site log content
organizations.servers.sites.logs.application.show 3 params → 200404403
DELETE
/orgs/{organization}/servers/{server}/sites/{site}/logs/application
Delete site log content
organizations.servers.sites.logs.application.destroy 3 params → 202404403
GET
/orgs/{organization}/servers/{server}/sites/{site}/heartbeats
List heartbeats
organizations.servers.sites.heartbeats.index 5 params → 200404403
POST
/orgs/{organization}/servers/{server}/sites/{site}/heartbeats
Create heartbeat
organizations.servers.sites.heartbeats.store 3 params body → 200404403422
GET
/orgs/{organization}/servers/{server}/sites/{site}/heartbeats/{heartbeat}
Get heartbeat
organizations.servers.sites.heartbeats.show 4 params → 200404403
PUT
/orgs/{organization}/servers/{server}/sites/{site}/heartbeats/{heartbeat}
Update heartbeat
organizations.servers.sites.heartbeats.update 4 params body → 200404403422
DELETE
/orgs/{organization}/servers/{server}/sites/{site}/heartbeats/{heartbeat}
Delete heartbeat
organizations.servers.sites.heartbeats.destroy 4 params → 204404403

Schemas 67

The contract defines 67 schemas that model the data the API accepts and returns. The most detailed are CreateSiteRequest (33 properties), UpdateSiteRequest (7 properties), Link (7 properties), CreateDomainCertificateRequest (6 properties). Each schema is shown below with its type and property counts.

SourceControlProvider
string
All supported source control providers.
HeartbeatResource
object
4 properties 3 required
CreateDomainRequest
object
3 properties 3 required
CertificateKeyType
string
CertificateType
string
Link
object
7 properties 1 required
NginxConfigResource
object
4 properties 3 required
AppType
string
LoadBalancingNodeResource
object
3 properties 2 required
NginxAccessLogResource
object
4 properties 3 required
DomainCertificateActionRequest
object
1 property 1 required
NpmCredentialResource
object
4 properties 3 required
UpdateLoadBalancerRequest
object
3 properties 2 required
CreateSiteRequest
object
33 properties 1 required
SecurityRuleResourceIdentifier
object
2 properties 2 required
SecurityRuleResource
object
4 properties 3 required
NodeBalancerMethod
string
RedirectRuleResource
object
4 properties 3 required
RedirectRuleType
string
DomainRecordConfigurationResource
object
3 properties 2 required
UpdateNginxConfigurationRequest
object
1 property 1 required
CertificateVerificationMethod
string
DomainRecordStatus
string
EnvironmentResource
object
4 properties 3 required
TagResourceIdentifier
object
2 properties 2 required
DomainRecordCertificateAction
string
SiteStatus
string
UpdateHealthcheckEndpointRequest
object
1 property
CreateComposerCredentialRequest
object
3 properties 3 required
UpdateHeartbeatRequest
object
4 properties 3 required
DomainRecordResource
object
4 properties 3 required
CreateLoadBalancerSiteRequest
object
5 properties 1 required
ResourceState
string
HeartbeatGracePeriod
integer
ApplicationLogResource
object
4 properties 3 required
DeploymentResourceIdentifier
object
2 properties 2 required
PhpVersion
string
CreateDomainCertificateRequest
object
6 properties 1 required
DomainActionRequest
object
1 property 1 required
CreateHeartbeatRequest
object
4 properties 3 required
DeploymentStatus
string
SiteType
string
UpdateSiteRequest
object
7 properties
CreateSiteDomainMode
string
ComposerCredentialResource
object
4 properties 3 required
WwwRedirectType
string
ServerType
string
RepositoryStatus
string
NginxErrorLogResource
object
4 properties 3 required
MaintenanceModeStatus
string
TagResource
object
3 properties 2 required
ServerResource
object
5 properties 3 required
CreateNpmCredentialRequest
object
3 properties 2 required
DomainRecordAction
string
RedirectRuleResourceIdentifier
object
2 properties 2 required
UpdateEnvironmentRequest
object
4 properties 1 required
UpdateDomainRequest
object
2 properties 1 required
HealthcheckEndpointResource
object
4 properties 3 required
ServerResourceIdentifier
object
2 properties 2 required
UpdateNpmCredentialRequest
object
3 properties 2 required
CertificateResource
object
3 properties 2 required
SiteResource
object
5 properties 3 required
HeartbeatFrequency
integer
DeploymentResource
object
3 properties 2 required
HeartbeatStatus
string
UpdateComposerCredentialRequest
object
3 properties 3 required
CertificateRequestStatus
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

laravel-sites-api-openapi.yml Raw ↑

Other APIs Laravel publishes across the network.

Laravel Forge API (Legacy v1)
Envoyer API
Laravel Applications API
Laravel Background Processes API
Laravel Backups API
Laravel Bucket Keys API
Laravel Caches API
Laravel Commands API
Laravel Database Clusters API
Laravel Database Restores API
Laravel Database Snapshots API
Laravel Databases API
Where this information came from

This is an independent, third-party profile of Laravel Sites API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.