Patch State

Replace the actor's current state.

This writes state directly and bypasses actor actions. Use it only for inspection and recovery.

PATCH https://api.rivet.dev/gateway/{actor}/inspector/state

Examples

curl -X PATCH "https://api.rivet.dev/gateway/$ACTOR_ID/inspector/state" \
  -H "Authorization: Bearer $INSPECTOR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "state": {
      "count": 2
    }
  }'

const endpoint = "https://api.rivet.dev";
const response = await fetch(
	`${endpoint}/gateway/${process.env.ACTOR_ID}/inspector/state`,
	{
		method: "PATCH",
		headers: {
			Authorization: `Bearer ${process.env.INSPECTOR_TOKEN}`,
			"Content-Type": "application/json",
		},
		body: JSON.stringify({ state: { count: 2 } }),
	},
);
console.log(await response.json());
export {};

Authentication

Inspector endpoints do not accept namespace tokens. Send the actor’s inspector token as a bearer token in the Authorization header. Each actor generates its own inspector token on first start and stores it in its KV storage under the single byte 0x03. Read it through the control plane with GET /actors/{actor_id}/kv/keys/Aw==?namespace={namespace} using a namespace token; the response value is the token, base64-encoded. The dashboard does this for you.

Path Parameters

Headers

Actor Selector

{actor} accepts an actor ID, an actor ID with an inline routing token ({actor_id}@{token}), or an actor name combined with the rvt-* query parameters below. See Actor Routing for the full rules.

Request Body

Content type: application/json (optional).

Responses

200

The state was saved.

{
  "ok": true
}

401

The inspector token is missing or invalid.