sessions module route (requires sessions:run:write)

POST

/v1/m/sessions/runs/{ref}/stop

curl --request POST \
  --url https://example.com/v1/m/sessions/runs/example/stop \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "reason": "example", "work_lease_fence": 1 }'

• this engine

Stops one session run; a fenced stop carries the lease fence, and a reason without a fence is refused.

Authorizations

• bearerAuth
• browserSession

Parameters

Path Parameters

ref

required

string

Path parameter ref.

Header Parameters

X-Olivares-Tenant

string format: uuid

Target tenant id; required when the principal can act in more than one tenant.

Request Body

Media type application/json

Optional fenced stop command. An empty body preserves legacy non-work run behavior; reason requires a positive work_lease_fence.

object

reason

string

>= 1 characters <= 512 characters

work_lease_fence

integer format: int64

>= 1

Example ^generated

{
  "reason": "example",
  "work_lease_fence": 1
}

Responses

200

The run resource after the control was applied

Media type application/json

object

run_ref

required

The operated session’s stable reference.

string

state

required

The run’s derived lifecycle state after the control.

string

key

additional properties

any

Example ^generated

{
  "run_ref": "example",
  "state": "example"
}

400

Bad request

Media type application/json

object

Example ^generated

{}

401

Unauthenticated

Media type application/json

object

Example ^generated

{}

403

Forbidden

Media type application/json

object

Example ^generated

{}

404

Not found

Media type application/json

object

Example ^generated

{}

409

Conflict / setup required

Media type application/json

object

Example ^generated

{}

429

Rate limited

Media type application/json

object

Example ^generated

{}

503

The outcome is UNKNOWN: required authority, evidence or store could not be observed, and any external effect may or may not have crossed

Media type application/json

object

code

required

The durable outcome name, e.g. work_input_ambiguous or evidence_unavailable.

string

error

required

object

code

required

string

message

required

string

key

additional properties

any

evidence_ref

Present when the refusal names the field or evidence it could not resolve.

string

verdict

required

The uncertain verdict: the outcome could not be observed.

string

Allowed values: NO_HE_PODIDO_MIRAR

key

additional properties

any

Example

{
  "verdict": "NO_HE_PODIDO_MIRAR"
}