Download a cache artifact
Downloads a cache artifact identified by its hash specified on the request path. The artifact is downloaded as an octet-stream (binary data).
The artifact data is a gzip-compressed tarball containing the cached task outputs. The client will verify the content-length header against the response body size.
/artifacts/{hash}AuthorizationBearer token · headerrequiredBearer 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
hashstringrequiredThe artifact hash. This is a content-addressable hash that uniquely identifies the cached artifact based on task inputs.
teamIdstringThe team identifier to perform the request on behalf of. Used for multi-tenant cache implementations where artifacts are scoped to teams.
slugstringThe team slug to perform the request on behalf of. Alternative to teamId for identifying the team.
x-artifact-client-cistringThe continuous integration or delivery environment where this artifact operation is being performed. Examples: github-actions, circleci, jenkins.
x-artifact-client-interactiveintegerIndicates whether the client is running in an interactive shell. 1 for interactive, 0 for non-interactive (CI/scripts).
01Artifact downloaded successfully
anyBad request. One or more of the provided values in the request query, headers, or body is invalid.
codestringrequiredA machine-readable error code
messagestringrequiredA human-readable error message
Unauthorized. The request is missing a valid authentication token or the token is invalid.
codestringrequiredA machine-readable error code
messagestringrequiredA human-readable error message
Forbidden. The authenticated user does not have permission to access this resource.
codestringrequiredA machine-readable error code
messagestringrequiredA human-readable error message
Artifact not found. No artifact with the specified hash exists.
codestringrequiredA machine-readable error code
messagestringrequiredA human-readable error message