Skip to main content
POST
/
environments
/
{environment}
/
purge-edge-cache
Purge edge cache
curl --request POST \
  --url https://cloud.laravel.com/api/environments/{environment}/purge-edge-cache \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "id": "<string>",
    "links": {
      "self": {
        "href": "<string>",
        "rel": "<string>",
        "describedby": "<string>",
        "title": "<string>",
        "type": "<string>",
        "hreflang": "<string>",
        "meta": {}
      }
    },
    "attributes": {
      "name": "<string>",
      "slug": "<string>",
      "created_from_automation": true,
      "vanity_domain": "<string>",
      "build_command": "<string>",
      "deploy_command": "<string>",
      "uses_octane": true,
      "uses_push_to_deploy": true,
      "uses_deploy_hook": true,
      "environment_variables": [
        {
          "key": "<string>",
          "value": "<string>"
        }
      ],
      "network_settings": {
        "cache": {
          "strategy": "<string>"
        },
        "response_headers": {
          "frame": "<string>",
          "content_type": "<string>",
          "hsts": {
            "max_age": 123,
            "include_subdomains": true,
            "preload": true
          }
        },
        "firewall": {
          "bot_categories": [],
          "rate_limit": {
            "429": true,
            "4xx": true
          },
          "under_attack_mode_started_at": "<string>",
          "block_path": true
        },
        "content_converter": true
      },
      "created_at": "2023-11-07T05:31:56Z"
    },
    "relationships": {
      "application": {
        "data": {
          "id": "<string>"
        }
      },
      "branch": {
        "data": {
          "id": "<string>"
        }
      },
      "deployments": {
        "data": [
          {
            "id": "<string>"
          }
        ]
      },
      "currentDeployment": {
        "data": {
          "id": "<string>"
        }
      },
      "domains": {
        "data": [
          {
            "id": "<string>"
          }
        ]
      },
      "primaryDomain": {
        "data": {
          "id": "<string>"
        }
      },
      "instances": {
        "data": [
          {
            "id": "<string>"
          }
        ]
      },
      "database": {
        "data": {
          "id": "<string>"
        }
      },
      "cache": {
        "data": {
          "id": "<string>"
        }
      },
      "buckets": {
        "data": [
          {
            "id": "<string>"
          }
        ]
      },
      "websocketApplication": {
        "data": {
          "id": "<string>"
        }
      }
    }
  },
  "included": [
    {
      "id": "<string>",
      "attributes": {
        "name": "<string>",
        "slug": "<string>",
        "slack_channel": "<string>",
        "avatar_url": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "repository": {
          "full_name": "<string>",
          "default_branch": "<string>"
        }
      },
      "relationships": {
        "repository": {
          "data": {
            "id": "<string>"
          }
        },
        "organization": {
          "data": {
            "id": "<string>"
          }
        },
        "environments": {
          "data": [
            {
              "id": "<string>"
            }
          ]
        },
        "deployments": {
          "data": [
            {
              "id": "<string>"
            }
          ]
        },
        "defaultEnvironment": {
          "data": {
            "id": "<string>"
          }
        }
      }
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://cloud.laravel.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

The Bearer Token generated on the Cloud UI.

Path Parameters

environment
string
required

The environment identifier

Response

EnvironmentResource

data
EnvironmentResource · object
required
included
(ApplicationResource · object | BranchResource · object | DeploymentResource · object | DomainResource · object | InstanceResource · object | DatabaseSchemaResource · object | CacheResource · object | FilesystemResource · object | WebsocketApplicationResource · object)[]