This guide covers the REST API provided by Layer0.

To gain access to the api, provide a deploy token via the x-api-key header. Deploy tokens can be created from a site's settings tab in the Layer0 Developer Console.


Purges entries from the cache for a specific environment. You can purge specific paths or surrogate keys. If no paths or surrogate keys are provided all entries will be purged.

The following request headers are required:

  • x-api-key: A site deploy token
  • content-type: "application/json"

Provide the following parameters as JSON in the post body:

  "team": "the team name",
  "site": "the site name",
  "environment": "the environment name",
  "paths": ["Optional. An array of paths to clear. Use * as a wildcard."],
  "surrogateKeys": ["Optional. An array of surrogate keys to clear"]

const fetch = require('node-fetch')

const deployToken = '*****'
const team = 'my-team'
const site = 'my-site'
const environment = 'production'
const paths = ['/some/path']

async function clearCache() {
  const res = await fetch('', {
    method: 'POST',
    headers: {
      'content-type': 'application/json',
      'x-api-key': deployToken,
    body: JSON.stringify({

  console.log('Status:', res.status, res.statusText)
  console.log('Body:', await res.text())

Edit this guide on GitHub