ORorgo
deploys

Cancel a queued or running deployment (the live release stays live)

Changed on
post/api/computers/{id}/deployments/{deploymentId}/cancel

Request

  • Base URL
    https://www.orgo.ai
  • Auth
    HTTP bearer

Path parameters

idstring required

Computer id.

deploymentIdstring uuid required

Response

Cancelled (a queued one) or being cancelled (a running one).

idstring uuid required
project_idstring uuid required
trigger'push' | 'manual' | 'rollback' | 'redeploy' required
state'queued' | 'running' | 'succeeded' | 'failed' | 'cancelled' | 'superseded' required
phase'preparing' | 'cloning' | 'detecting' | 'installing' | 'building' | 'starting' | 'health_check' | 'live' | 'null' nullable
branchstring required
source_versionstring nullable

An Ingot repo’s: the changeset it builds, once known (the one asked for, else the one the runner found newest on main). A rollback: the changeset of the release it went back to.

commit_shastring nullable
commit_messagestring nullable
commit_authorstring nullable
frameworkstring nullable
error_codestring nullable

Failed: build_timeout, runner_lost, computer_not_running, github_token, clone_failed, detect_failed, install_failed, build_failed, docker_unavailable, start_failed, health_check_failed, release_gone, apply_failed, ingot_missing.

errorstring nullable
rollback_ofstring uuid nullable
currentboolean

This deployment is the project’s live one. After a rollback it is the rollback, not the deployment it went back to.

release_liveboolean

Its release is the one live now, through this deployment or another of the same release (a rollback to it, or the one this rollback went back to). Nothing to roll back to or build again.

can_rollbackboolean

Its release is still on the computer and is not the one live now.

created_atstring date-time
started_atstring date-time nullable
finished_atstring date-time nullable

Changes