Service-Worker-Allowed header

Syntax

Service-Worker-Allowed: <scope>

Directives

<scope>

A string representing a URL that defines a service worker's registration scope; that is, what range of URLs a service worker can control.

Examples

Using Service-Worker-Allowed to broaden service worker scope

The JavaScript example below is included in example.com/product/index.html, and attempts to register a service worker with a scope that applies to all resources under example.com/.

navigator.serviceWorker.register("./sw.js", { scope: "/" }).then(
  (registration) => {
    console.log("Install succeeded, scoped to '/'", registration);
  },
  (error) => {
    console.error(`Service worker registration failed: ${error}`);
  },
);

The HTTP response to the service worker's script resource request (./sw.js) includes the Service-Worker-Allowed header set to /:

HTTP/1.1 200 OK
Date: Mon, 16 Dec 2024 14:37:20 GMT
Service-Worker-Allowed: /

// sw.js contents…

If the server doesn't set the header, the service worker registration will fail, as the scope option ({ scope: "/" }) requests a scope broader than the directory where the service worker script is located (/product/sw.js).

Specifications

Browser compatibility

See also

• Service-Worker header
• Service worker API
• ServiceWorkerRegistration
• Why is my service worker failing to register in Using Service Workers.