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

The Environments API from Laravel — 9 operation(s) for environments.

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

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

This API exposes 12 operations across 9 paths, and defines 66 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.

12 operations 9 paths 66 schemas 1 DELETE4 GET1 PATCH6 POST

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 Environments 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 12

Across 9 paths, the API surfaces 12 operations — 1 DELETE, 4 GET, 1 PATCH, 6 POST. Each is listed below with its method, path, parameters, and response codes.

Environments 12
GET
/applications/{application}/environments
List environments
public.applications.environments.index 5 params → 200404403
POST
/applications/{application}/environments
Create environment
public.applications.environments.store 1 param body → 201404403422
GET
/environments/{environment}/logs
List environment logs
public.environments.logs.index 9 params → 200404403422
GET
/environments/{environment}
Get environment
public.environments.show 2 params → 200404403
PATCH
/environments/{environment}
Update environment
public.environments.update 1 param body → 200404403422
DELETE
/environments/{environment}
Delete environment
public.environments.destroy 1 param → 204404403422
POST
/environments/{environment}/start
Start environment
public.environments.start 1 param body → 200404403422
POST
/environments/{environment}/stop
Stop environment
public.environments.stop 1 param → 200404403422
POST
/environments/{environment}/purge-edge-cache
Purge edge cache
public.environments.purge-edge-cache 1 param → 200404403422
POST
/environments/{environment}/variables
Add environment variables
public.environments.variables.store 1 param body → 200404403422
POST
/environments/{environment}/variables/delete
Delete environment variables
public.environments.variables.destroy 1 param body → 200404403422
GET
/environments/{environment}/metrics
Get environment metrics
public.environments.metrics 2 params → 200404403422

Schemas 66

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

CloudRegion
string
CacheSize
string
MetricPeriod
string
WebsocketApplicationResource
object
4 properties 2 required
InstanceType
string
FilesystemVisibility
string
WebsocketServerResourceIdentifier
object
2 properties 2 required
FilesystemType
string
Link
object
7 properties 1 required
BranchResourceIdentifier
object
2 properties 2 required
UserResourceIdentifier
object
2 properties 2 required
FilesystemKeyResourceIdentifier
object
2 properties 2 required
DatabaseSchemaResource
object
4 properties 2 required
ApplicationResourceIdentifier
object
2 properties 2 required
FilesystemResourceIdentifier
object
2 properties 2 required
StartEnvironmentRequest
object
1 property
RepositoryResourceIdentifier
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
RateLimitLevel
string
WebsocketApplicationResourceIdentifier
object
2 properties 2 required
DatabaseResourceIdentifier
object
2 properties 2 required
EnvironmentStatus
string
CacheResource
object
4 properties 2 required
CacheType
string
BackgroundProcessResourceIdentifier
object
2 properties 2 required
DatabaseSchemaResourceIdentifier
object
2 properties 2 required
InstanceScalingType
string
NormalizedLogResource
object
5 properties 5 required
DomainType
string
DeploymentResourceIdentifier
object
2 properties 2 required
RobotsTag
string
PhpVersion
string
DomainResourceIdentifier
object
2 properties 2 required
DeleteEnvironmentVariablesRequest
object
1 property 1 required
StoreEnvironmentVariablesRequest
object
2 properties 2 required
FilesystemStatus
string
FilesystemResource
object
4 properties 2 required
BranchResource
object
4 properties 2 required
InstanceResource
object
4 properties 2 required
Frame
string
DeploymentStatus
string
CreateEnvironmentRequest
object
3 properties 2 required
DomainStatus
string
ContentType
string
EnvironmentVariablesInsertMethod
string
CacheStatus
string
OrganizationResourceIdentifier
object
2 properties 2 required
DomainResource
object
5 properties 3 required
SqsQueueStatus
string
UpdateEnvironmentRequest
object
29 properties
BotControlCategory
string
NodeVersion
string
DomainCloudflareStrategy
string
DomainRedirect
string
CacheStrategy
string
RateLimitPerMinute
integer
ApplicationResource
object
4 properties 2 required
EnvironmentColor
string
EnvironmentResourceIdentifier
object
2 properties 2 required
DeploymentResource
object
5 properties 3 required
InstanceSize
string
DomainActionRequired
string
FilesystemJurisdiction
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

laravel-environments-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 Environments 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.