Skip to content
Docs

Caching

Manage cached build artifacts and check Remote Caching status for your account or team. You can also invalidate cached content by tag or source image when it needs to refresh.

Query information about an artifact.

Parameters

ParameterTypeRequiredDescription
teamIdstringNoTeam ID to use for this operation.
slugstringNoTeam slug to use for this operation. Use instead of teamId.
requestBodyobjectYesRequest body for this tool.

Get the status of Remote Caching for this principal.

Parameters

ParameterTypeRequiredDescription
teamIdstringNoTeam ID to use for this operation.
slugstringNoTeam slug to use for this operation. Use instead of teamId.

Invalidate by source image.

Parameters

ParameterTypeRequiredDescription
projectIdOrNamestringYesThe project ID or name.
teamIdstringNoTeam ID to use for this operation.
slugstringNoTeam slug to use for this operation. Use instead of teamId.
requestBodyobjectNoRequest body for this tool.

Invalidate by tag.

Parameters

ParameterTypeRequiredDescription
projectIdOrNamestringYesThe project ID or name.
teamIdstringNoTeam ID to use for this operation.
slugstringNoTeam slug to use for this operation. Use instead of teamId.
requestBodyobjectNoRequest body for this tool.

Record an artifacts cache usage event.

Parameters

ParameterTypeRequiredDescription
xArtifactClientCistringNoThe continuous integration or delivery environment where this artifact is downloaded.
xArtifactClientInteractiveintegerNo1 if the client is an interactive shell. Otherwise 0 Minimum: 0. Maximum: 1.
teamIdstringNoTeam ID to use for this operation.
slugstringNoTeam slug to use for this operation. Use instead of teamId.
requestBodyArray<object>YesRequest body for this tool.

Upload a cache artifact.

Parameters

ParameterTypeRequiredDescription
contentLengthnumberYesThe artifact size in bytes
xArtifactDurationnumberNoThe time taken to generate the uploaded artifact in milliseconds.
xArtifactClientCistringNoThe continuous integration or delivery environment where this artifact was generated.
xArtifactClientInteractiveintegerNo1 if the client is an interactive shell. Otherwise 0 Minimum: 0. Maximum: 1.
xArtifactTagstringNoThe base64 encoded tag for this artifact. The value is sent back to clients when the artifact is downloaded as the header x-artifact-tag
xArtifactShastringNoThe SHA of the source control revision that generated this artifact.
xArtifactDirtyHashstringNoA hash representing uncommitted changes in the working directory when this artifact was generated.
hashstringYesThe artifact hash
teamIdstringNoTeam ID to use for this operation.
slugstringNoTeam slug to use for this operation. Use instead of teamId.
requestBodystringYesProvide this binary value as a base64 string.

Was this helpful?

supported.