Build a static site from source sent as a gzip tar in the request body

Before you call

Credential

Authorization: Bearer $KEY

Scope

hosting:write

Sdk

hosting.build.upload

Cli

hosting build upload

Events

hosting.build.started

Parameters

• idstring (uuid)required
  In the path
• outDirstring
  In the query
• installstring
  In the query
• buildstring
  In the query
• previewstring
  In the query

Request bodyapplication/octet-stream, required

string (binary)

Responses

• 201application/json
  Success
  • idstring (uuid)required
  • projectIdstringrequired
  • sourceobjectrequired
    • typestringrequired
      One of: upload, repo.
    • urlstring
    • refstring
    • bundleShastring
  • outDirstringrequired
  • installbooleanrequired
  • buildbooleanrequired
  • previewbooleanrequired
  • statestringrequired
    One of: queued, running, succeeded, failed, timeout, cancelled.
  • logstringrequired
  • errorstring or nullrequired
  • deploymentIdstring or nullrequired
  • secondsnumberrequired
  • createdAtstringrequired
  • startedAtstring or nullrequired
  • finishedAtstring or nullrequired
• 400application/json
  The request was malformed
  • errorstringrequired
  • messagestring
• 401application/json
  No valid credential
  • errorstringrequired
  • messagestring
• 403application/json
  The credential lacks the scope, origin or address
  • errorstringrequired
  • messagestring
• 429application/json
  Over the key's rate limit; see Retry-After
  • errorstringrequired
  • messagestring