Skip to main content
POST
/
services
/
{service}
/
state
Modify service state
curl --request POST \
  --url https://api.example.com/services/{service}/state \
  --header 'Content-Type: application/json' \
  --data '
{
  "new_state": {},
  "object_key": "<string>",
  "version": "<string>"
}
'
{
  "message": "<string>",
  "restate_code": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.restate.dev/llms.txt

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

Path Parameters

​
service
string
required

Fully qualified service name.

Body

application/json
​
new_state
object
required

New State

The new state to replace the previous state with

​
object_key
string
required

Service key

To what virtual object key to apply this change

​
version
string | null

Version

If set, the latest version of the state is compared with this value and the operation will fail when the versions differ.

Response

State modification request accepted and will be applied asynchronously