Skip to content
On this page

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 / schemaDiff

Function: schemaDiff()

schemaDiff<Schema>(snapshot, force): RestCommand<SchemaDiffOutput, Schema>

Compare the current instance's schema against the schema snapshot in JSON request body and retrieve the difference. This endpoint is only available to admin users.

Type parameters

Schema extends object


snapshot: SchemaSnapshotOutput

JSON object containing collections, fields, and relations to apply.

force: boolean= false

Bypass version and database vendor restrictions.


RestCommand<SchemaDiffOutput, Schema>

Returns the differences between the current instance's schema and the schema passed in the request body.