Get remote caching status

Check the status of Remote Caching for the authenticated user or team. Returns a JSON-encoded status indicating if Remote Caching is enabled, disabled, or disabled due to usage limits.

Implementers should return enabled if the authenticated principal is allowed to use the cache, or disabled if not. The over_limit and paused statuses are optional and can be used to indicate usage limits or temporary suspension.

GET/artifacts/status

Authorization

AuthorizationBearer token · headerrequired

Bearer token authentication. Pass your authentication token in the Authorization header as Bearer <token>.

For self-hosted implementations, the token format and validation logic is up to the implementer. Common approaches include:

Static tokens for simple setups
JWT tokens for stateless authentication
OAuth2 tokens for integration with identity providers

Query parameters

teamIdstring

The team identifier to perform the request on behalf of. Used for multi-tenant cache implementations where artifacts are scoped to teams.

slugstring

The team slug to perform the request on behalf of. Alternative to teamId for identifying the team.

Responses

200

Remote caching status retrieved successfully

statusCachingStatusrequired

The status of remote caching for the authenticated principal.

enabled: Remote caching is enabled and available
disabled: Remote caching is disabled
over_limit: Remote caching is disabled due to usage limits (optional)
paused: Remote caching is temporarily paused (optional)

Allowed:disabledenabledover_limitpaused

400

Bad request. One or more of the provided values in the request query, headers, or body is invalid.

codestringrequired

A machine-readable error code

messagestringrequired

A human-readable error message

401

Unauthorized. The request is missing a valid authentication token or the token is invalid.

codestringrequired

A machine-readable error code

messagestringrequired

A human-readable error message

403

Forbidden. The authenticated user does not have permission to access this resource.

codestringrequired

A machine-readable error code

messagestringrequired

A human-readable error message

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Parameters

teamIdqueryThe team identifier to perform the request on behalf of. Used for multi-tenant cache implementations where artifacts are scoped to teams.slugqueryThe team slug to perform the request on behalf of. Alternative to `teamId` for identifying the team.

Request

curl -X GET 'https://turborepo-remote-cache.example.workers.dev/v8/artifacts/status' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'

const response = await fetch("https://turborepo-remote-cache.example.workers.dev/v8/artifacts/status", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json"
  }
});

import requests

response = requests.get(
    "https://turborepo-remote-cache.example.workers.dev/v8/artifacts/status",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json"
    },
)

Response

{
  "status": "disabled"
}

{
  "code": "string",
  "message": "string"
}

{
  "code": "string",
  "message": "string"
}

{
  "code": "string",
  "message": "string"
}