Get Database Schema Version Diff

Structural diff between two published versions of a database schema.

A schema defines a collection's fields, types, and validation. Schemas support drafts, versions, and publishing.

This endpoint returns a single database schema version diff by id.

Structural diff between two published versions of a database schema

get

Authorizations

HTTPRequired

JWT Bearer Authorization

Path parameters

versionstring · nullableRequired

The CodeMash API version used to fetch data from the API. If not specified, the last version will be used. E.g.: v3

Query parameters

Idstring · nullableRequired

Schema id from get_database_schemas.

FromVersioninteger · int32Required

Earlier published version number to diff from. Get valid values from get_database_schema_versions.

ToVersioninteger · int32Required

Later published version number to diff to. Get valid values from get_database_schema_versions.

Header parameters

norbix-project-idstring · nullableRequired

ID of your project. Can be passed in a header as norbix-project-id.

norbix-envstring · nullableOptional

Target environment for this request (e.g. TEST, STAGING). Optional — when omitted the request runs against PROD. Can be passed in a header as norbix-env.

CultureCodestring · nullableOptional

Specify culture code when your response from the API should be localised. E.g.: en

TimeZoneIdstring · nullableOptional

TimeZone

CorrelationIdstring · nullableOptional

CorrelationId for each request

Responses

200

Success

application/json

GetDatabaseSchemaVersionDiffResponse

get/{version}/database/schemas/{Id}/versions/diff

GET /{version}/database/schemas/{Id}/versions/diff?Id=text&FromVersion=1&ToVersion=1 HTTP/1.1
Host: hub.norbix.ai
Authorization: Bearer YOUR_SECRET_TOKEN
norbix-project-id: text
Accept: */*

200

Success

{
  "item": {
    "fromVersion": 10,
    "toVersion": 10,
    "added": [],
    "removed": [],
    "typeChanged": [],
    "validatorTightened": []
  },
  "responseStatus": {
    "isSuccess": true
  }
}

In Cloud

Manage this visually in Cloud — see Database.

Use it from code

Every Norbix SDK exposes this endpoint as a method — see Get Database Schema Version Diff in the SDK reference, with examples in every language.