Skip to main content
POST
/
environments
/
{environment}
/
deployments
Initiate deployment
curl --request POST \
  --url https://app.laravel.cloud/api/environments/{environment}/deployments \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "id": "<string>",
    "type": "deployments",
    "attributes": {
      "status": "pending",
      "branch_name": "<string>",
      "commit_hash": "<string>",
      "commit_message": "<string>",
      "failure_reason": "<string>",
      "php_major_version": "8.2",
      "build_command": "<string>",
      "node_version": "20",
      "uses_web_server": true,
      "uses_octane": true,
      "uses_hibernation": true,
      "started_at": "2023-11-07T05:31:56Z",
      "finished_at": "2023-11-07T05:31:56Z"
    },
    "relationships": {
      "environment": {
        "data": {
          "type": "environments",
          "id": "<string>"
        }
      },
      "initiator": {
        "data": {
          "type": "users",
          "id": "<string>"
        }
      }
    },
    "links": {
      "self": {
        "href": "<string>",
        "rel": "<string>",
        "describedby": "<string>",
        "title": "<string>",
        "type": "<string>",
        "hreflang": "<string>",
        "meta": {}
      }
    }
  }
}

Authorizations

Authorization
string
header
required

The Bearer Token generated on the Cloud UI.

Path Parameters

environment
string
required

The environment identifier

Response

DeploymentResource

data
object
required