v7

latestOpenAPI 3.1.0MITraw.githubusercontent.com2026-07-07355390.1 KB
service

Modify service state

Modifies the K/V state of a Virtual Object. For a detailed description of this API and how to use it, see the state documentation.

post/services/{service}/state

Path parameters

servicestring required

Fully qualified service name.

Request body

new_stateobject required

New State

The new state to replace the previous state with

object_keystring required

Service key

To what virtual object key to apply this change

scopestring nullable

Scope

Optional scope for the virtual object instance. When set, targets the scoped instance instead of the unscoped one. Since v1.7.0.

versionstring nullable

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