Skip to content
Updawg

`POST /v1/orgs/{org}/proposals/{proposal_id}/halt` (DAWG-100).

POST
/v1/orgs/{org}/proposals/{proposal_id}/halt
curl --request POST \
  --url https://api.updawg.net/v1/orgs/example/proposals/example/halt

Stop a rollout: the proposal goes halted and every job no host has picked up yet is cancelled. Jobs a host already holds are not: an agent that holds a verified job runs it, so they finish and report as normal, and still_out says how many there are.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
org
required
string

Organization slug.

proposal_id
required
string

The prp_… id.

Responses

Section titled “Responses”

200

Section titled “200”

Halted.

Media typeapplication/json

What halting or cancelling did.

object
cancelled
required

Jobs cancelled before any host had them.

integer format: int64
id
required
string
status
required

halted or failed.

string
still_out
required

Jobs a host already holds. Not cancelled: they finish and report as normal, because an agent that holds a verified job runs it.

integer format: int64
Examplegenerated
{
  "cancelled": 1,
  "id": "example",
  "status": "example",
  "still_out": 1
}

401

Section titled “401”

No session.

Media typeapplication/json
object
detail
string | null
status
required
integer format: int32
title
required
string
type
required
string
Examplegenerated
{
  "detail": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

403

Section titled “403”

Not permitted for this role.

Media typeapplication/json
object
detail
string | null
status
required
integer format: int32
title
required
string
type
required
string
Examplegenerated
{
  "detail": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

404

Section titled “404”

No such proposal here.

Media typeapplication/json
object
detail
string | null
status
required
integer format: int32
title
required
string
type
required
string
Examplegenerated
{
  "detail": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

409

Section titled “409”

Not rolling out.

Media typeapplication/json
object
detail
string | null
status
required
integer format: int32
title
required
string
type
required
string
Examplegenerated
{
  "detail": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

429

Section titled “429”

Over the organization’s request limit. Retry-After says when to try again; RateLimit-Limit is the burst.

Media typeapplication/json
object
detail
string | null
status
required
integer format: int32
title
required
string
type
required
string
Examplegenerated
{
  "detail": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}