Laravel Cloud

https://laravel.com/cloud/docs
Admin
Laravel Cloud provides comprehensive documentation for deploying, managing, and scaling Laravel...
Tokens:77,401
Snippets:799
Trust Score:9.4
Update:2 months ago
Show doc for...
Tokens:
Raw
### Install and Initialize Stripe Projects Plugin

Source: https://laravel.com/cloud/docs/api/stripe-projects

Install the necessary Stripe CLI plugin and initialize the projects environment.

```bash
stripe plugin install projects
stripe projects init
```

--------------------------------

### Configure Skill Installation Scope

Source: https://laravel.com/cloud/docs/api/cli

Forces installation to either the global directory or the current project directory.

```bash
# Install globally (e.g. ~/.claude/skills)
cloud skills:install --global

# Install to the current project (e.g. .claude/skills)
cloud skills:install --project
```

--------------------------------

### Install Laravel PDF package

Source: https://laravel.com/cloud/docs/knowledge-base/generating-pdfs

Install the Spatie Laravel PDF package via Composer.

```bash
composer require spatie/laravel-pdf
```

--------------------------------

### Install Agent Skills

Source: https://laravel.com/cloud/docs/api/cli

Installs AI agent skills from the laravel/agent-skills repository.

```bash
cloud skills:install
```

--------------------------------

### Initialize and deploy an application

Source: https://laravel.com/cloud/docs/api/cli

Use the ship command to guide the creation and deployment process for a new application.

```bash
cloud ship
```

--------------------------------

### Configure Private Composer Packages for Laravel

Source: https://laravel.com/cloud/docs/environments

Authentication setup for private Composer packages before running the installation command.

```shell
composer config http-basic.composer.fluxui.dev your-username your-license-key

composer install --no-dev
```

--------------------------------

### Configure Private Composer Packages for Symfony

Source: https://laravel.com/cloud/docs/environments

Authentication setup for private Composer packages before running the installation command.

```shell
composer config http-basic.example.com your-username your-license-key

composer install --no-dev
```

--------------------------------

### Install Laravel Cloud CLI

Source: https://laravel.com/cloud/docs/api/cli

Install the CLI globally using Composer. Ensure the global vendor binaries directory is included in your system PATH.

```bash
composer global require laravel/cloud-cli
```

--------------------------------

### Install Skills for Specific Agents

Source: https://laravel.com/cloud/docs/api/cli

Installs skills for selected agents without interactive prompts.

```bash
cloud skills:install --agent=claude --agent=cursor
```

--------------------------------

### GET /instances/{instance}/background-processes

Source: https://laravel.com/cloud/docs/api/background-processes/list-background-processes

Retrieves a list of all background processes for the specified instance.

```APIDOC
## GET /instances/{instance}/background-processes

### Description
Get a list of all background processes for the given instance.

### Method
GET

### Endpoint
/instances/{instance}/background-processes

### Parameters
#### Path Parameters
- **instance** (string) - Required - The instance identifier

#### Query Parameters
- **include** (array) - Optional - List of related resources to include (e.g., 'instance')

### Response
#### Success Response (200)
- **data** (array) - Paginated set of BackgroundProcessResource
- **links** (object) - Pagination links
- **meta** (object) - Pagination metadata
- **included** (array) - Included InstanceResource objects
```

--------------------------------

### Configure Build and Deploy Commands

Source: https://laravel.com/cloud/docs/quickstart

Commands used to install dependencies, compile assets, and run database migrations during the deployment process.

```sh
composer install --no-dev && npm run build
```

```sh
php artisan migrate --force
```

--------------------------------

### Define Next.js and Nuxt Build Commands

Source: https://laravel.com/cloud/docs/environments

Standard build commands for installing Node dependencies and compiling frontend applications.

```shell
npm ci && npm run build
```

--------------------------------

### Set the build command for Nuxt

Source: https://laravel.com/cloud/docs/quickstart

Use these commands to install dependencies and compile a Nuxt application, with an option for static site generation.

```sh
npm ci --audit false
npm run build

# alternatively for static site generation
# npx nuxt generate
```

--------------------------------

### GET /applications/{application}

Source: https://laravel.com/cloud/docs/api/applications/get-application

Retrieves the details of a specific application. You can optionally include related resources such as the organization, environments, or the default environment.

```APIDOC
## GET /applications/{application}

### Description
Get a specific application by its identifier.

### Method
GET

### Endpoint
/applications/{application}

### Parameters
#### Path Parameters
- **application** (string) - Required - The application identifier

#### Query Parameters
- **include** (array) - Optional - Related resources to include (organization, environments, defaultEnvironment)

### Response
#### Success Response (200)
- **data** (object) - The ApplicationResource object
```

--------------------------------

### Deploy an application

Source: https://laravel.com/cloud/docs/api/cli

Execute a deployment for the current project directory using the deploy command.

```bash
cloud deploy
```

```bash
cloud deploy --open
```

```bash
cloud deploy:monitor
```

--------------------------------

### Provision Multiple Resources

Source: https://laravel.com/cloud/docs/api/stripe-projects

Provision a plan, an application, and a database resource sequentially.

```bash
stripe projects add laravel_cloud/starter --name my-plan
stripe projects add laravel_cloud/application --config '{"name":"My App","repository":"laravel/laravel","region":"us-east-1"}'
stripe projects add laravel_cloud/mysql --name my-database
```

--------------------------------

### Open Application

Source: https://laravel.com/cloud/docs/api/cli

Opens the current application in the browser.

```bash
cloud browser
```

--------------------------------

### Install Symfony Cloud package

Source: https://laravel.com/cloud/docs/queues

Install the required package for Symfony Messenger integration via Composer.

```sh
composer require laravel/symfony-on-cloud
```

--------------------------------

### Install AWS SDK for PHP

Source: https://laravel.com/cloud/docs/private-cloud/iam-roles

Run this command if your environment uses managed queues and the deployment fails due to a missing AWS SDK package.

```bash
composer require aws/aws-sdk-php
```

--------------------------------

### Create a Laravel Application

Source: https://laravel.com/cloud/docs/api/stripe-projects

Provision a new application by specifying the repository and region in the configuration JSON.

```bash
stripe projects add laravel_cloud/application --config '{"name":"My App","repository":"owner/repo","region":"us-east-1"}'
```

--------------------------------

### OpenAPI Specification for Get Background Process

Source: https://laravel.com/cloud/docs/api/background-processes/get-background-process

Defines the GET endpoint for retrieving a specific background process by its identifier, including optional inclusion of instance data.

```yaml
openapi: 3.1.0
info:
  title: Laravel Cloud
  version: 0.0.1
servers:
  - url: https://cloud.laravel.com/api
security:
  - http: []
tags:
  - name: Applications
  - name: Environments
  - name: Domains
  - name: Commands
  - name: Deployments
  - name: Instances
  - name: Background Processes
  - name: Database Clusters
  - name: Databases
  - name: Database Snapshots
  - name: Database Restores
  - name: Object Storage Buckets
  - name: Bucket Keys
  - name: Caches
  - name: WebSocket Clusters
  - name: WebSocket Applications
  - name: Dedicated Clusters
  - name: Usage
  - name: Meta
  - name: Databases (Legacy)
paths:
  /background-processes/{backgroundProcess}:
    get:
      tags:
        - Background Processes
      summary: Get background process
      description: Get the details of a specific background process.
      operationId: public.background-processes.show
      parameters:
        - name: backgroundProcess
          in: path
          required: true
          description: The background process identifier
          schema:
            type:
              - string
              - 'null'
        - name: include
          in: query
          schema:
            type: array
            items:
              type: string
              enum:
                - instance
          explode: false
      responses:
        '200':
          description: '`BackgroundProcessResource`'
          content:
            application/vnd.api+json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/BackgroundProcessResource'
                  included:
                    type: array
                    items:
                      $ref: '#/components/schemas/InstanceResource'
                required:
                  - data
        '403':
          $ref: '#/components/responses/AuthorizationException'
        '404':
          $ref: '#/components/responses/ModelNotFoundException'
components:
  schemas:
    BackgroundProcessResource:
      type: object
      properties:
        id:
          type: string
        type:
          type: string
          enum:
            - background_processes
        attributes:
          type: object
          properties:
            type:
              $ref: '#/components/schemas/DaemonType'
            processes:
              type: integer
            command:
              type: string
            config:
              type: array
              items: {}
            strategy_type:
              $ref: '#/components/schemas/DaemonStrategyType'
            strategy_threshold:
              type:
                - integer
                - 'null'
            created_at:
              type:
                - string
                - 'null'
              format: date-time
          required:
            - type
            - processes
            - command
            - config
            - strategy_type
            - strategy_threshold
            - created_at
        relationships:
          type: object
          properties:
            instance:
              type: object
              properties:
                data:
                  anyOf:
                    - $ref: '#/components/schemas/InstanceResourceIdentifier'
                    - type: 'null'
              required:
                - data
      required:
        - id
        - type
      title: BackgroundProcessResource
    InstanceResource:
      type: object
      properties:
        id:
          type: string
        type:
          type: string
          enum:
            - instances
        attributes:
          type: object
          properties:
            name:
              type: string
            type:
              $ref: '#/components/schemas/InstanceType'
            size:
              $ref: '#/components/schemas/InstanceSize'
            scaling_type:
              $ref: '#/components/schemas/InstanceScalingType'
            min_replicas:
              type: integer
            max_replicas:
              type: integer
            queue_status:
              anyOf:
                - $ref: '#/components/schemas/SqsQueueStatus'
                  description: >-
                    Current lifecycle status of the managed queue. Null for
                    non-queue instances.
                - type: 'null'
            paused:
              type:
                - boolean
                - 'null'
              description: >-
                Whether the managed queue is currently paused. Null for
                non-queue instances.
```

--------------------------------

### Verify DNS records via terminal

Source: https://laravel.com/cloud/docs/domains

Use these commands to check DNS propagation and record visibility for your domain. Replace example.com with your specific domain.

```bash
# Which DNS provider is responsible for your domain?
dig NS example.com +short
nslookup -type=NS example.com

# Are your origin records resolving? (use the record type you configured — A or CNAME)
dig A example.com +short
dig CNAME example.com +short
nslookup -type=A example.com
nslookup -type=CNAME example.com

# Is the ownership verification record visible?
dig TXT _cf-custom-hostname.example.com +short
nslookup -type=TXT _cf-custom-hostname.example.com

# Are the SSL validation records visible? (may be TXT or CNAME depending on your setup)
dig TXT _acme-challenge.example.com +short
dig CNAME _acme-challenge.example.com +short
nslookup -type=TXT _acme-challenge.example.com
nslookup -type=CNAME _acme-challenge.example.com
```

--------------------------------

### POST /applications

Source: https://laravel.com/cloud/docs/api/applications/create-application

Creates a new application by providing the repository, name, and region. Optional parameters include source control provider, root directory, and cluster ID.

```APIDOC
## POST /applications

### Description
Create a new application.

### Method
POST

### Endpoint
/applications

### Parameters
#### Request Body
- **repository** (string) - Required - The repository name.
- **name** (string) - Required - The application name (3-40 characters).
- **region** (string) - Required - The cloud region.
- **source_control_provider_type** (string) - Optional - The source control provider.
- **root_directory** (string) - Optional - The root directory path.
- **cluster_id** (string) - Optional - The identifier of a dedicated cluster.

### Response
#### Success Response (201)
- **data** (object) - The created ApplicationResource.
```

--------------------------------

### GET /applications

Source: https://laravel.com/cloud/docs/api/introduction

Retrieves a list of applications associated with the authenticated organization.

```APIDOC
## GET /applications

### Description
Returns a JSON:API list of your applications.

### Method
GET

### Endpoint
https://cloud.laravel.com/api/applications

### Request Example
curl https://cloud.laravel.com/api/applications \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json"
```

--------------------------------

### GET /background-processes/{backgroundProcess}

Source: https://laravel.com/cloud/docs/api/background-processes/get-background-process

Retrieves the details of a specific background process.

```APIDOC
## GET /background-processes/{backgroundProcess}

### Description
Get the details of a specific background process.

### Method
GET

### Endpoint
/background-processes/{backgroundProcess}

### Parameters
#### Path Parameters
- **backgroundProcess** (string) - Required - The background process identifier

#### Query Parameters
- **include** (array) - Optional - Related resources to include (e.g., instance)

### Response
#### Success Response (200)
- **data** (BackgroundProcessResource) - The background process resource object
- **included** (array) - Optional list of related InstanceResource objects
```

--------------------------------

### GET /bucket-keys/{filesystemKey}

Source: https://laravel.com/cloud/docs/api/bucket-keys/get-object-storage-key

Retrieves the details of a specific object storage key.

```APIDOC
## GET /bucket-keys/{filesystemKey}

### Description
Get a specific object storage key.

### Method
GET

### Endpoint
/bucket-keys/{filesystemKey}

### Parameters
#### Path Parameters
- **filesystemKey** (string) - Required - The filesystem key identifier

#### Query Parameters
- **include** (array) - Optional - Include related resources (e.g., filesystem)

### Response
#### Success Response (200)
- **data** (FilesystemKeyResource) - The requested object storage key resource.
- **included** (array) - Related filesystem resources if requested.
```

--------------------------------

### Overwrite Existing Skills

Source: https://laravel.com/cloud/docs/api/cli

Uses the force flag to overwrite previously installed skills.

```bash
cloud skills:install --force
```

--------------------------------

### Configure PHP for local Datadog agent

Source: https://laravel.com/cloud/docs/private-cloud/build-configuration

Use this command to create a PHP configuration file that points to a local Datadog trace agent running on localhost.

```bash
cat > /usr/local/etc/php/conf.d/99-datadog.ini <<'EOF'
datadog.trace.agent_url = http://localhost:8126
datadog.trace.agent_connect_timeout = 2000
datadog.trace.agent_timeout = 5000
datadog.service = foo-bar-api
datadog.env = staging
datadog.trace.sample_rate = 1.0
datadog.trace.enabled = On
EOF
```

--------------------------------

### POST /instances/{instance}/background-processes

Source: https://laravel.com/cloud/docs/api/background-processes/create-background-process

Creates a new background process for the specified instance. Supports configuring worker-specific settings or custom commands.

```APIDOC
## POST /instances/{instance}/background-processes

### Description
Create a new background process for an instance.

### Method
POST

### Endpoint
/instances/{instance}/background-processes

### Parameters
#### Path Parameters
- **instance** (string) - Required - The instance identifier

#### Request Body
- **type** (DaemonType) - Required - The type of background process
- **processes** (integer) - Required - Number of processes (1-10)
- **command** (string) - Optional - Custom command to run (required when type is 'custom')
- **config** (object) - Optional - Configuration object for 'worker' type processes:
  - **connection** (string) - Optional - The queue connection name
  - **queue** (string) - Optional - The queue name(s)
  - **tries** (integer) - Optional - Number of attempts
  - **backoff** (integer) - Optional - Seconds to wait before retrying
  - **sleep** (integer) - Optional - Seconds to sleep when no jobs available
  - **rest** (integer) - Optional - Seconds to rest between jobs
  - **timeout** (integer) - Optional - Seconds before job timeout
  - **force** (boolean) - Optional - Force worker in maintenance mode

### Response
#### Success Response (201)
- **data** (BackgroundProcessResource) - The created background process resource
- **included** (array) - Included instance resources
```

--------------------------------

### Manage Instances

Source: https://laravel.com/cloud/docs/api/cli

Perform CRUD operations and view available sizes for instances.

```bash
cloud instance:list
cloud instance:get
cloud instance:create
cloud instance:update
cloud instance:delete
cloud instance:sizes
```

--------------------------------

### Install WebSocket Dependencies

Source: https://laravel.com/cloud/docs/resources/websockets

Required packages for Laravel and Symfony applications to communicate with WebSocket clusters.

```sh
composer require laravel/reverb
npm install --save-dev laravel-echo pusher-js
```

```sh
composer require pusher/pusher-php-server
npm install pusher-js
```

--------------------------------

### GET /buckets/{filesystem}/keys

Source: https://laravel.com/cloud/docs/api/bucket-keys/list-object-storage-keys

Retrieves a list of all keys for a specific object storage bucket.

```APIDOC
## GET /buckets/{filesystem}/keys

### Description
Get a list of all keys for a specific object storage bucket.

### Method
GET

### Endpoint
/buckets/{filesystem}/keys

### Parameters
#### Path Parameters
- **filesystem** (string) - Required - The filesystem identifier

#### Query Parameters
- **include** (array) - Optional - List of related resources to include (e.g., filesystem)

### Response
#### Success Response (200)
- **data** (array) - Paginated set of FilesystemKeyResource
- **links** (object) - Pagination links
- **meta** (object) - Pagination metadata
```

--------------------------------

### Configure PHP for remote Datadog agent

Source: https://laravel.com/cloud/docs/private-cloud/build-configuration

Use this command to create a PHP configuration file that points to a remote Datadog trace agent.

```bash
cat > /usr/local/etc/php/conf.d/99-datadog.ini <<'EOF'
datadog.trace.agent_url = https://your-hostname.tld:8126
datadog.trace.agent_connect_timeout = 2000
datadog.trace.agent_timeout = 5000
datadog.service = foo-bar-api
datadog.env = staging
datadog.trace.sample_rate = 1.0
datadog.trace.enabled = On
EOF
```

--------------------------------

### Configure repository defaults

Source: https://laravel.com/cloud/docs/api/cli

Save application and organization IDs to a local configuration file to avoid repeated manual input.

```bash
cloud repo:config
```

--------------------------------

### Install Laravel Nightwatch package

Source: https://laravel.com/cloud/docs/knowledge-base/nightwatch-on-cloud

Use Composer to add the Laravel Nightwatch package to your local application.

```bash
composer require laravel/nightwatch
```

--------------------------------

### GET /api/ip

Source: https://laravel.com/cloud/docs/network

Retrieves a list of outbound IP addresses for Laravel Cloud applications, organized by region.

```APIDOC
## GET /api/ip

### Description
Retrieves a JSON object containing the current outbound IPv4 and IPv6 addresses for Laravel Cloud, categorized by region.

### Method
GET

### Endpoint
https://cloud.laravel.com/api/ip

### Response
#### Success Response (200)
- **region** (object) - A map of region names to their respective IP address configurations.
- **ipv4** (array) - List of IPv4 addresses for the region.
- **ipv6** (array) - List of IPv6 address ranges for the region.

#### Response Example
{
  "us-east-2": {
    "ipv4": ["3.140.62.214", "3.139.253.68"],
    "ipv6": ["2600:1f16:e0:8500::/56"]
  },
  "eu-west-2": {
    "ipv4": ["35.178.113.65"],
    "ipv6": ["2a05:d01c:243:e500::/56"]
  }
}
```

--------------------------------

### Open Laravel Cloud Dashboard

Source: https://laravel.com/cloud/docs/api/stripe-projects

Launch the Laravel Cloud dashboard for advanced resource management.

```bash
stripe projects open laravel_cloud
```
Tokens:
Raw