Skip to main content
POST
/
v1
/
admin
/
settlements
/
{settlement_id}
/
transition
Force a manual state transition
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({reason: '<string>', target_state: '<string>', confirm: true})
};

fetch('https://api.keystoneos.xyz/v1/admin/settlements/{settlement_id}/transition', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "settlement_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "previous_state": "<string>",
  "current_state": "<string>",
  "action": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.keystoneos.xyz/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Auth0 JWT access token. See Authentication for details.

Path Parameters

​
settlement_id
string<uuid>
required

Body

application/json

Request to force a manual state transition (escape hatch).

​
reason
string
required
​
target_state
string
required
​
confirm
boolean
required

Response

Successful Response

Response for all intervention actions.

​
settlement_id
string<uuid>
required
​
previous_state
string
required
​
current_state
string
required
​
action
string
required