Archives the run for every reader, idempotently: an archived run keeps its first archived_at.
POST
/v1/m/sessions/runs/{ref}/archive
const url = 'https://example.com/v1/m/sessions/runs/example/archive';const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/v1/m/sessions/runs/example/archive \ --header 'Authorization: Bearer <token>'Archives the run for every reader, idempotently: an archived run keeps its first archived_at.
Authorizations
Section titled “ Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “ Path Parameters ” ref
required
string
Path parameter ref.
Header Parameters
Section titled “ Header Parameters ” X-Olivares-Tenant
string format: uuid
Target tenant id; required when the principal can act in more than one tenant.
Responses
Section titled “ Responses ”The run resource after the change
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"}Bad request
Media type application/json
object
Example generated
{}Unauthenticated
Media type application/json
object
Example generated
{}Forbidden
Media type application/json
object
Example generated
{}Not found
Media type application/json
object
Example generated
{}Conflict / setup required
Media type application/json
object
Example generated
{}Rate limited
Media type application/json
object
Example generated
{}