ScalixScalix Docs

Migrations API

Database migration management

REST API endpoints for Migrations. 2 operations.

Register a migration

plaintext
POST /api/v1/tenants/{tenant_id}/migrations

Registers a database migration for a tenant.

Auth: Bearer API key

Parameters

NameInTypeRequiredDescription
tenant_idpathstringYesTenant id (UUID)

Responses

StatusDescription
200Migration registered
401Missing or invalid API key
500Internal error

operationId: registerMigration

Get the migration plan

plaintext
GET /api/v1/tenants/{tenant_id}/migrations/plan

Returns the pending migrations for a tenant.

Auth: Bearer API key

Parameters

NameInTypeRequiredDescription
tenant_idpathstringYesTenant id (UUID)

Responses

StatusDescription
200Pending migrations
401Missing or invalid API key
500Internal error

operationId: getMigrationPlan