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 Deployments API

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

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

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

This API exposes 23 operations across 13 paths, and defines 31 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.

23 operations 13 paths 31 schemas 4 DELETE12 GET5 POST2 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 Deployments 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 23

Across 13 paths, the API surfaces 23 operations — 4 DELETE, 12 GET, 5 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Deployments 23
GET
/environments/{environment}/deployments
List deployments
public.environments.deployments.index 5 params → 200404403
POST
/environments/{environment}/deployments
Initiate deployment
public.environments.deployments.store 1 param → 200404403422
GET
/deployments/{deployment}
Get deployment
public.deployments.show 2 params → 200404403
GET
/deployments/{deployment}/logs
Get deployment logs
public.deployments.logs 1 param → 200422404403
GET
/orgs/{organization}/servers/{server}/sites/{site}/webhooks
List site webhooks
organizations.servers.sites.webhooks.index 6 params → 200404403
POST
/orgs/{organization}/servers/{server}/sites/{site}/webhooks
Create site webhook
organizations.servers.sites.webhooks.store 3 params body → 202404403422
GET
/orgs/{organization}/servers/{server}/sites/{site}/webhooks/{deploymentWebhook}
Get site webhook
organizations.servers.sites.webhooks.show 4 params → 200404403
DELETE
/orgs/{organization}/servers/{server}/sites/{site}/webhooks/{deploymentWebhook}
Delete site webhook
organizations.servers.sites.webhooks.destroy 4 params → 202404403
GET
/orgs/{organization}/servers/{server}/sites/{site}/deployments
List deployments
organizations.servers.sites.deployments.index 9 params → 200404403
POST
/orgs/{organization}/servers/{server}/sites/{site}/deployments
Create deployment
organizations.servers.sites.deployments.store 3 params → 202404403
GET
/orgs/{organization}/servers/{server}/sites/{site}/deployments/status
Get deployment status
organizations.servers.sites.deployments.status.show 3 params → 200404403
DELETE
/orgs/{organization}/servers/{server}/sites/{site}/deployments/status
Update deployment state
organizations.servers.sites.deployments.status.destroy 3 params → 202404403
GET
/orgs/{organization}/servers/{server}/sites/{site}/deployments/script
Get deployment script
organizations.servers.sites.deployments.script.show 3 params → 200404403
PUT
/orgs/{organization}/servers/{server}/sites/{site}/deployments/script
Update deployment script
organizations.servers.sites.deployments.script.update 3 params body → 200404403422
GET
/orgs/{organization}/servers/{server}/sites/{site}/deployments/deploy-hook
Get the deployment trigger URL
organizations.servers.sites.deployments.deploy-hook.show 3 params → 200404403
PUT
/orgs/{organization}/servers/{server}/sites/{site}/deployments/deploy-hook
Update deployment trigger URL
organizations.servers.sites.deployments.deploy-hook.update 3 params → 200404403
POST
/orgs/{organization}/servers/{server}/sites/{site}/deployments/push-to-deploy
Create push to deploy configuration
organizations.servers.sites.deployments.push-to-deploy.store 3 params → 202404403
DELETE
/orgs/{organization}/servers/{server}/sites/{site}/deployments/push-to-deploy
Delete push to deploy configuration
organizations.servers.sites.deployments.push-to-deploy.destroy 3 params → 202404403
GET
/orgs/{organization}/servers/{server}/sites/{site}/deployments/{deployment}
Get deployment
organizations.servers.sites.deployments.show 4 params → 200404403
GET
/orgs/{organization}/servers/{server}/sites/{site}/deployments/{deployment}/log
Get deployment output
organizations.servers.sites.deployments.log.show 4 params → 200404403
GET
/orgs/{organization}/servers/{server}/sites/{site}/deploy-key
Get deploy key
organizations.servers.sites.deploy-key.show 3 params → 200404403
POST
/orgs/{organization}/servers/{server}/sites/{site}/deploy-key
Create deploy key
organizations.servers.sites.deploy-key.store 3 params → 200404403
DELETE
/orgs/{organization}/servers/{server}/sites/{site}/deploy-key
Delete deploy key
organizations.servers.sites.deploy-key.destroy 3 params → 204404403

Schemas 31

The contract defines 31 schemas that model the data the API accepts and returns. The most detailed are Link (7 properties), EnvironmentResource (5 properties), DeploymentResource (5 properties), DeployKeyResource (4 properties). Each schema is shown below with its type and property counts.

DeploymentStatusResource
object
4 properties 3 required
Link
object
7 properties 1 required
BranchResourceIdentifier
object
2 properties 2 required
UserResourceIdentifier
object
2 properties 2 required
CreateDeploymentWebhookRequest
object
1 property 1 required
UpdateDeploymentScriptRequest
object
2 properties 1 required
ApplicationResourceIdentifier
object
2 properties 2 required
FilesystemResourceIdentifier
object
2 properties 2 required
EnvironmentResource
object
5 properties 3 required
UserResource
object
3 properties 2 required
InstanceResourceIdentifier
object
2 properties 2 required
CacheResourceIdentifier
object
2 properties 2 required
DeploymentScriptResource
object
4 properties 3 required
WebsocketApplicationResourceIdentifier
object
2 properties 2 required
RateLimitLevel
string
DeploymentOutputResource
object
4 properties 3 required
EnvironmentStatus
string
DatabaseSchemaResourceIdentifier
object
2 properties 2 required
DeploymentStatus_2
string
DeploymentResource_2
object
3 properties 2 required
DeploymentResourceIdentifier
object
2 properties 2 required
DomainResourceIdentifier
object
2 properties 2 required
DeploymentStatus
string
DeployHookResource
object
4 properties 3 required
DeploymentWebhookResource
object
4 properties 3 required
BotControlCategory
string
NodeVersion
string
RateLimitPerMinute
integer
DeployKeyResource
object
4 properties 3 required
EnvironmentResourceIdentifier
object
2 properties 2 required
DeploymentResource
object
5 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

laravel-deployments-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 Deployments 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.