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
| Parameter | Type | Required | Description |
|---|---|---|---|
teamId | string | No | Team ID to use for this operation. |
slug | string | No | Team slug to use for this operation. Use instead of teamId. |
requestBody | object | Yes | Request body for this tool. |
Get the status of Remote Caching for this principal.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
teamId | string | No | Team ID to use for this operation. |
slug | string | No | Team slug to use for this operation. Use instead of teamId. |
Invalidate by source image.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
projectIdOrName | string | Yes | The project ID or name. |
teamId | string | No | Team ID to use for this operation. |
slug | string | No | Team slug to use for this operation. Use instead of teamId. |
requestBody | object | No | Request body for this tool. |
Invalidate by tag.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
projectIdOrName | string | Yes | The project ID or name. |
teamId | string | No | Team ID to use for this operation. |
slug | string | No | Team slug to use for this operation. Use instead of teamId. |
requestBody | object | No | Request body for this tool. |
Record an artifacts cache usage event.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
xArtifactClientCi | string | No | The continuous integration or delivery environment where this artifact is downloaded. |
xArtifactClientInteractive | integer | No | 1 if the client is an interactive shell. Otherwise 0 Minimum: 0. Maximum: 1. |
teamId | string | No | Team ID to use for this operation. |
slug | string | No | Team slug to use for this operation. Use instead of teamId. |
requestBody | Array<object> | Yes | Request body for this tool. |
Upload a cache artifact.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
contentLength | number | Yes | The artifact size in bytes |
xArtifactDuration | number | No | The time taken to generate the uploaded artifact in milliseconds. |
xArtifactClientCi | string | No | The continuous integration or delivery environment where this artifact was generated. |
xArtifactClientInteractive | integer | No | 1 if the client is an interactive shell. Otherwise 0 Minimum: 0. Maximum: 1. |
xArtifactTag | string | No | The base64 encoded tag for this artifact. The value is sent back to clients when the artifact is downloaded as the header x-artifact-tag |
xArtifactSha | string | No | The SHA of the source control revision that generated this artifact. |
xArtifactDirtyHash | string | No | A hash representing uncommitted changes in the working directory when this artifact was generated. |
hash | string | Yes | The artifact hash |
teamId | string | No | Team ID to use for this operation. |
slug | string | No | Team slug to use for this operation. Use instead of teamId. |
requestBody | string | Yes | Provide this binary value as a base64 string. |
Was this helpful?