Appearance

On this page

Directus Cloud

Everything you need to start building. Provisioned in 90 seconds. Starting at $15/month.

Get Started

This is an auto-generated document to support extension builders understand the internal packages they can utilize. To find our written guides, tutorials, and API/SDK reference, check out our main docs .

Directus / @directus/sdk / rest / schemaSnapshot

Function: schemaSnapshot() ​

schemaSnapshot<Schema>(): RestCommand<SchemaSnapshotOutput, Schema>

Retrieve the current schema. This endpoint is only available to admin users.

Type Parameters ​

• Schema

Returns ​

RestCommand<SchemaSnapshotOutput, Schema>

Returns the JSON object containing schema details.

Defined in ​

rest/commands/schema/snapshot.ts:18