Skip to content

Stream a deployment's build log

GET
/stores/{storeRef}/hosting/deployments/{id}/logs
curl --request GET \
--url https://apibase.ecomweb.app/api/v1/stores/example/hosting/deployments/example/logs \
--header 'x-api-key: <x-api-key>'

Streams the build output of a deployment as Server-Sent Events. Each log event carries new output as data: {"chunks": ["..."]}. A ping event with the current status keeps a quiet connection open. The final end event carries the status the build ended with, as data: {"status": "built"}, and the stream then closes. For a build that has already ended, the stream replays the stored output and then sends end. The log is the output of the build, so keep secrets out of build commands and output.

Required scopes: deploy:storefront

id
required
string

The deployment ID.

storeRef
required
string

The store’s ref, as returned by GET /stores.

A stream of Server-Sent Events: log, ping and a final end.

Media typetext/event-stream
string

The key is missing, invalid, revoked or expired.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}

The key may not do this: a missing scope, a readonly key, a publishable key on a Store API route, or a disallowed origin.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}

The resource does not exist in this store.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}