Record one

POST

/provision/databases/{id}/migrations

Operations, not SQL. The checksum is taken over the structured
definition, so the same migration against two engines is one migration —
and one whose definition changed after being recorded is caught when it
is applied. Recorded pending; nothing runs until
POST /provision/databases/{id}/migrations/apply (or /migrate). The
operations are compiled now as well, so one the engine cannot express
is a 400 here rather than a failed migration later.

Capability: migration:write (area resource, on the database).

Request

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢201

application/json

Recorded, with the statements it will run

Bodyapplication/json

🟠400

🟠409

🟠401KlockUnauthorized

🟠404NotFound

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.prod-orm.io/provision/databases//migrations' \
--header 'Content-Type: application/json' \
--data '{
    "version": "0001",
    "name": "posts",
    "operations": [
        {
            "op": "createTable",
            "table": "posts",
            "columns": {
                "id": {
                    "type": "INTEGER",
                    "primaryKey": true,
                    "autoIncrement": true
                },
                "title": {
                    "type": "VARCHAR(200)"
                }
            }
        },
        {
            "op": "addIndex",
            "table": "posts",
            "name": "posts_title_idx",
            "fields": [
                "title"
            ]
        }
    ]
}'

Response Example

201 - Example 1

{
    "migration": {
        "id": 0,
        "version": "string",
        "name": "string",
        "state": "pending",
        "checksum": "string",
        "operations": [
            {
                "op": "createTable",
                "table": "string",
                "name": "string",
                "columns": {},
                "definition": {},
                "fields": [
                    "string"
                ]
            }
        ],
        "sql": "string",
        "appliedAt": "2019-08-24T14:15:22.123Z",
        "durationMs": 0,
        "reversible": true
    },
    "statements": [
        "string"
    ]
}

Modified at 2026-10-05 14:01:12

The migrations recorded for it

Apply everything recorded and not yet run