Skip to content
Console
On this page

Mint env on a build cache

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…

This method is not served on the public API. api.sylphx.com does 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.

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.

  • Path POST https://api.sylphx.com/v1/orgs/acme/projects/shop/build_caches/build-cache:mintEnv
  • Scope build:run
  • Effect write — a successful call changes state.
  • Collection build_caches

Request

FieldTypeWhat it is
namestringThe name of the build cache. Required.
accessBuildCacheAccessWhat the token may do; default READ. One of read, read_write.

Response

FieldTypeWhat it is
envmap<string, string>Environment variables by name: SCCACHE_WEBDAV_ENDPOINT, SCCACHE_WEBDAV_TOKEN, TURBO_API, TURBO_TEAM, TURBO_TOKEN, SYLPHX_CRATES_MIRROR. Never returned again.
expire_timetimestampWhen the token in env stops verifying.

Errors

Every error arrives in the body Errors describes.

Examples

curl -X POST "https://api.sylphx.com/v1/orgs/acme/projects/shop/build_caches/build-cache:mintEnv" \
  -H "Authorization: Bearer $SYLPHX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'