APIs & SDKs

POSThttps://api.vercel.com/v8/artifacts/events

Vercel SDK

Records an artifacts cache usage event. The body of this request is an array of cache usage events. The supported event types are HIT and MISS. The source is either LOCAL the cache event was on the users filesystem cache or REMOTE if the cache event is for a remote cache. When the event is a HIT the request also accepts a number duration which is the time taken to generate the artifact in the cache.

Record an artifacts cache usage event

Authentication

AuthorizationbearerToken

Default authentication mechanism

Our Services

The Team slug to perform the request on behalf of.

Query parameters

The Team identifier to perform the request on behalf of.

string

Optional

x-artifact-client-interactive

teamId

Brand & Design

1 if the client is an interactive shell. Otherwise 0

slug

string

Optional

x-artifact-client-ci

Header parameters

The continuous integration or delivery environment where this artifact is downloaded.

Optional

string

integer

Optional

Response

200Success. Event recorded.

Errors

410Error

401The request is not authorized.

403The customer has reached their spend cap limit and has been paused. An owner can disable the cap or raise the limit in settings. The Remote Caching usage limit has been reached for this account for this billing cycle. Remote Caching has been disabled for this team or user. An owner can enable it in the billing settings. You do not have permission to access this resource.

400One of the provided values in the request body is invalid. One of the provided values in the headers is invalid

402The account is missing a payment so payment method must be updated