Skip to main content
GET/migrations

List Applied Migrations

Returns the migration history for the project — the ordered list of migrations that have been applied to the project's schema, corresponding to the k9o migration status CLI command.

Authorized by the IAM action migrations:read (every project role holds it by default; a workload needs it on its bound IAM policy; a project service token reads as its scope's role).

Parameters
projectSlug *path

The project's slug: the path segment after @.

It is unique within the org.

Responses
HTTPK9O CodeDescription
200Success
401K9O_SESSION_EXPIREDYour session has expired; re-authenticate and retry.
403K9O_ACCESS_DENIEDYou must be a project member to list applied migrations.
403K9O_IAM_POLICY_DENIEDThe bound IAM policy ceiling denies migrations:read (for a workload: its bound policy does not grant it).
Response body (200)
data *object[]

The project's applied migrations, oldest version first.

With ?collection=, only those that touched that collection.

version *integer

The migration's version, an integer from 1 to 2147483647.

Versions apply in ascending order.

slug *string

The migration's slug, as given when it was submitted.

appliedAt *string <date-time>

When the migration was applied.

checksum *string

SHA-256 (hex) of the migration's canonical JSON (version, slug, up, down, policy).

Re-applying a version with a different checksum is refused.

noPolicy *boolean

True when the migration was recorded as declaring no access policy.

affectedCollections *string[]

The collections the migration's operations and policy section touch.

meta *any

Request metadata: cost, timing and correlation ids.

TypeScript
// const k9o = new K9o({ orgSlug: 'playground', projectSlug: 'storefront', apiKey: 'k9o_…' })
const { data } = await k9o.migrations.list()

Showing example in TypeScript

Response example (200)
{
  "data": [
    {
      "version": 0,
      "slug": "string",
      "appliedAt": "string",
      "checksum": "string",
      "noPolicy": false,
      "affectedCollections": [
        "string"
      ]
    }
  ]
}

More in Storage & Schema