sessions module route (requires sessions:run:admin)

POST

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

curl --request POST \
  --url https://example.com/v1/m/sessions/runs/example/cleanup \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "discard_worktree": true }'

• this engine

Cleans up the resources of one finished session run.

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

object

discard_worktree

Any of:

boolean

Confirms that the session’s git worktree and branch may be removed although the branch is not merged, the worktree has uncommitted files or its HEAD is off the branch, and lets the release go on, leaving the worktree where it is, when this node cannot reach it. Absent, null or false removes them only when the branch is merged and the worktree is clean.

boolean

null

null

Example ^generated

{
  "discard_worktree": true
}

Responses

200

OK

Media type application/json

object

Example ^generated

{}

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

{}