Sign in
Schema

Retrieve Schema Difference

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

post/schema/diff

Query parameters

forceboolean

Bypass version and database vendor restrictions.

Request body

Example request

{
  "data": {
    "version": 1,
    "collections": [
      {
        "collection": "customers"
      }
    ],
    "fields": [
      {
        "collection": "about_us",
        "field": "id"
      }
    ],
    "relations": [
      {
        "id": 1,
        "many_collection": "directus_activity",
        "many_field": "user",
        "one_collection": "directus_users"
      }
    ]
  }
}

Response

Successful request

Changes