Get Database Schema

List tables, views, and columns in the actor's SQLite database.

GET https://api.rivet.dev/gateway/{actor}/inspector/database/schema

Examples

curl "https://api.rivet.dev/gateway/$ACTOR_ID/inspector/database/schema" \
  -H "Authorization: Bearer $INSPECTOR_TOKEN"

const endpoint = "https://api.rivet.dev";
const response = await fetch(
	`${endpoint}/gateway/${process.env.ACTOR_ID}/inspector/database/schema`,
	{ 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. 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

Responses

200

The actor database schema.

{
  "schema": {
    "tables": [
      {
        "name": "my-actor",
        "type": "table",
        "columns": [
          {
            "name": "my-actor",
            "type": "<type>",
            "notnull": false,
            "pk": false
          }
        ]
      }
    ]
  }
}

401

The inspector token is missing or invalid.