Stream a deployment's build log
const url = 'https://apibase.ecomweb.app/api/v1/stores/example/hosting/deployments/example/logs';const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}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
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”The deployment ID.
The store’s ref, as returned by GET /stores.
Responses
Section titled “Responses”A stream of Server-Sent Events: log, ping and a final end.
The key is missing, invalid, revoked or expired.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
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.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}The resource does not exist in this store.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}