Build caches
A BuildCache is a per-project cache.
This method is not served on the public API.
api.sylphx.comdoes not route this call: its backend is not deployed behind the public API, or does not implement the call. This page documents the contract. It is kept out of the sidebar and of search engines.
A BuildCache is a per-project cache. It makes builds faster and never changes their result; a missing or unreachable cache only slows a build.
Service Sylphx Build · Resource type build.sylphx.com/BuildCache · Name pattern orgs/{org}/projects/{project}/build_caches/{build_cache} · Shape spec_status
Fields
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}/build_caches/{build_cache}. |
uid | string | bch_<cell><ulid>; never reused. Output only. |
meta | ResourceMeta | Resource metadata. |
spec | BuildCacheSpec | Desired state. Required. |
status | BuildCacheStatus | Observed state. Output only. |
Methods
Every method of the collection, in the registry's order, with the scope it needs. The full request, response and examples are one link away.
| Method | Call | What it does |
|---|---|---|
GET | get | Gets a build cache. |
GET | list | Lists build caches in a project. |
PATCH | update | Updates a build cache. |
DELETE | delete | Deletes a build cache. |
POST | mint_env | Mints the settings a build that runs elsewhere (a laptop, a CI runner) uses to reach the cache: the sccache, Turbo and crates mirror doors and a short-lived token, as environment variables. |
POST | purge | Empties a build cache and keeps the cache. The undo is that the next build refills it. |
get
Gets a build cache.
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/build_caches/build-cache · scope build:read · effect read · Request, response and examples
list
Lists build caches in a project.
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/build_caches · scope build:read · effect read · paginated · Request, response and examples
update
Updates a build cache.
PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/build_caches/build-cache · scope build:write · effect write · Request, response and examples
delete
Deletes a build cache.
DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/build_caches/build-cache · scope build:write · effect destructive · Request, response and examples
mint_env
Mints the settings a build that runs elsewhere (a laptop, a CI runner) uses to reach the cache: the sccache, Turbo and crates mirror doors and a short-lived token, as environment variables.
POST https://api.sylphx.com/v1/orgs/acme/projects/shop/build_caches/build-cache:mintEnv · scope build:run · effect write · Request, response and examples
purge
Empties a build cache and keeps the cache. The undo is that the next build refills it.
POST https://api.sylphx.com/v1/orgs/acme/projects/shop/build_caches/build-cache:purge · scope build:write · effect destructive · validate_only · long-running · Request, response and examples