Inspector

Clear Queue

Remove all pending messages from the actor's queue.

The inspector API is subject to change without notice. Do not build production integrations on it.

DELETE https://rivet.example.com/gateway/{actor}/inspector/queue

Examples

curl -X DELETE "https://rivet.example.com/gateway/$ACTOR_ID/inspector/queue" \
  -H "Authorization: Bearer $INSPECTOR_TOKEN"

const endpoint = "https://api.rivet.dev";
const response = await fetch(
	`${endpoint}/gateway/${process.env.ACTOR_ID}/inspector/queue`,
	{
		method: "DELETE",
		headers: { Authorization: `Bearer ${process.env.INSPECTOR_TOKEN}` },
	},
);
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.

Path Parameters

Name	Type	Required	Description
`actor`	`string`	Yes	Actor ID, actor ID with an inline token (`{actor_id}@{token}`), or actor name combined with the `rvt-*` query parameters.

Headers

Name	Type	Required	Description
`Authorization`	`string`	No	Bearer token for inspector authentication. Required in production, optional in development.

Responses

200

The queue was cleared.

{}

401

The inspector token is missing or invalid.