Skip to main content
POST
/
environments
/
{environment}
/
start
Start environment
curl --request POST \
  --url https://cloud.laravel.com/api/environments/{environment}/start \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "redeploy": true
}
'
{
  "data": {
    "id": "<string>",
    "type": "deployments",
    "links": {
      "self": {
        "href": "<string>",
        "rel": "<string>",
        "describedby": "<string>",
        "title": "<string>",
        "type": "<string>",
        "hreflang": "<string>",
        "meta": {}
      }
    },
    "relationships": {}
  },
  "included": [
    {
      "id": "<string>",
      "type": "environments",
      "links": {
        "self": {
          "href": "<string>",
          "rel": "<string>",
          "describedby": "<string>",
          "title": "<string>",
          "type": "<string>",
          "hreflang": "<string>",
          "meta": {}
        }
      },
      "relationships": {}
    }
  ]
}

Authorizations

Authorization
string
header
required

The Bearer Token generated on the Cloud UI.

Path Parameters

environment
string
required

The environment identifier

Body

application/json
redeploy
boolean | null

Pass true to redeploy the environment with the same commit as the latest deployment. Otherwise, the latest commit will be used.

Response

DeploymentResource

data
DeploymentResource · object
required
included
(EnvironmentResource · object | UserResource · object)[]