Files
Anthony ShewandGitHub c4be53cc57 chore: Move applications to apps/ directory (#11613)
## Summary

- Moves `docs/site` to `apps/docs`
- Moves `packages/coverage-reporter` to `apps/coverage-reporter`

These are applications (Next.js sites), not packages meant to be
consumed by other packages. Moving them to `apps/` follows monorepo
conventions and makes the distinction clear.

## Changes

- Created `apps/` directory
- Updated `pnpm-workspace.yaml` to include `apps/*`
- Updated path references in:
  - Root `package.json` (`docs:dev` script)
  - `.gitignore` and `.prettierignore`
  - `apps/docs/components/geistdocs/edit-source.tsx` (GitHub edit URL)
  - `apps/docs/package.json` (link-checker path)
  - `docs/link-checker/package.json` (path to docs content)
2026-01-31 20:48:07 -07:00

45 lines
2.0 KiB
Plaintext

---
title: Remote Cache API
description: OpenAPI specification for self-hosted Remote Cache servers.
---
# Remote Cache API
The Turborepo Remote Cache API defines the HTTP interface that any remote cache server must implement to be compatible with Turborepo.
## Overview
The remote cache stores build artifacts identified by content-addressable hashes. When Turborepo encounters a task that matches a previously cached result, it can download the artifact instead of re-executing the task.
## Authentication
All endpoints require Bearer token authentication:
```bash
Authorization: Bearer <token>
```
For self-hosted implementations, the token format and validation logic is up to the implementer.
## Endpoints
### Artifacts
| Method | Path | Description |
| ------ | --------------------------------------------------------------------- | ------------------------------------------ |
| `GET` | [`/artifacts/status`](/repo/docs/openapi/artifacts/status) | Check remote caching status |
| `HEAD` | [`/artifacts/{hash}`](/repo/docs/openapi/artifacts/artifact-exists) | Check if artifact exists |
| `GET` | [`/artifacts/{hash}`](/repo/docs/openapi/artifacts/download-artifact) | Download a cache artifact |
| `PUT` | [`/artifacts/{hash}`](/repo/docs/openapi/artifacts/upload-artifact) | Upload a cache artifact |
| `POST` | [`/artifacts`](/repo/docs/openapi/artifacts/artifact-query) | Query information about multiple artifacts |
### Analytics
| Method | Path | Description |
| ------ | ----------------------------------------------------------------- | ------------------------- |
| `POST` | [`/artifacts/events`](/repo/docs/openapi/artifacts/record-events) | Record cache usage events |
## Download the spec
The full OpenAPI specification is available at [`/api/remote-cache-spec`](/api/remote-cache-spec).