Rivier/ Reference/ hosting

Cancel a build that has not started

post/hosting/sites/{id}/builds/{bid}/cancel

Before you call

Credential
Authorization: Bearer $KEY
Scope
hosting:write
Mcp
rivier_hosting_build_cancel
Graphql
Mutation.hostingBuildCancel
Sdk
hosting.build.cancel
Cli
hosting build cancel

Parameters

  • idstring (uuid)required
    In the path
  • bidstring (uuid)required
    In the path

Responses

  • 200application/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

This page as Markdown