Rivier/ Reference/ hosting

Deploy the site from the request body

post/hosting/sites/{id}/deployments

Deploy the site from the request body: a gzip tar with index.html at its top. ?preview=1 makes a preview at its own address.

Before you call

Credential
Authorization: Bearer $KEY
Scope
hosting:write
Sdk
hosting.deployment.create
Cli
hosting deployment create
Events
hosting.deployment.created

Parameters

  • idstring (uuid)required
    In the path
  • previewstring
    In the query
  • refstring
    In the query

Request bodyapplication/octet-stream, required

string (binary)

Responses

  • 201application/json
    Success
    • idstring (uuid)required
    • projectIdstring (uuid)required
    • kindstringrequired
      One of: production, preview.
    • statestringrequired
    • sourcestringrequired
    • refstringrequired
    • bundleBytesnumberrequired
    • urlstring or nullrequired
    • releasestring or nullrequired
    • promotedFromstring (uuid) or nullrequired
    • errorstring or nullrequired
    • expiresAtstring or nullrequired
    • createdBystringrequired
    • createdAtstringrequired
    • 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

This page as Markdown