Manage Actors

Sleep Actor

Put an actor to sleep. The actor runs its shutdown sequence and persists its state, then wakes on the next request.

POST https://api.rivet.dev/actors/{actor_id}/sleep

Examples

curl -X POST "https://api.rivet.dev/actors/$ACTOR_ID/sleep?namespace=$RIVET_NAMESPACE" \
  -H "Authorization: Bearer $RIVET_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

const endpoint = "https://api.rivet.dev";
const namespace = process.env.RIVET_NAMESPACE ?? "default";
const token = process.env.RIVET_TOKEN ?? "";
const actorId = "00000000-0000-0000-0000-000000000000";

const response = await fetch(
	`${endpoint}/actors/${actorId}/sleep?namespace=${namespace}`,
	{
		method: "POST",
		headers: {
			Authorization: `Bearer ${token}`,
			"Content-Type": "application/json",
		},
		body: "{}",
	},
);

if (!response.ok) {
	throw new Error(`Failed to sleep actor: ${await response.text()}`);
}

export {};

Authentication

Send your namespace token as a bearer token in the Authorization header. Every control plane request also requires the namespace query parameter. See Authentication.

Path Parameters

Name	Type	Required	Description
`actor_id`	`string`	Yes	ID of the actor.

Query Parameters

Name	Type	Required	Description
`namespace`	`string`	Yes	Name of the namespace to operate in.

Request Body

Content type: application/json.

Send an empty JSON object: {}.

Responses

200

{}

Lifecycle