Get the active schema migration

get

https://api.andesine.app/collections/{collectionID}/schema-migration

Returns the active migration for a collection, or null when none is active.

Required API key permissions: read:collections. Write permissions also grant read access for the same resource.

Authentication

apiKeyhttp, bearer, Andesine API key

Use an Andesine API key as a Bearer token

oauthhttp, bearer, Andesine OAuth access token

Use an OAuth access token with andesine:api scope. Send x-workspace-id for workspace operations. Current user permissions apply.

Path parameters

collectionID*string

ID of the affected collection

Headers

x-workspace-idstring

Required for OAuth: ID of the workspace to access. API keys use their own workspace.

Responses

200OKapplication/json

Bodyany of

Options

Any of

SchemaMigrationobject

id*string

ID of the schema migration

schemaID*any of

Local schema that initiated the migration

Options

Any of

Option 1string

Option 2null

schemaVersionID*any of

Schema version applied by the migration

Options

Any of

Option 1string

Option 2null

status*SchemaMigrationStatus

One of: "queued", "running", "rolling_back", "completed", "failed"

totalEntries*number

processedEntries*number

error*any of

Options

Any of

Option 1string

Option 2null

initiatedBy*any of

Options

Any of

Option 1string

Option 2null

startedAt*any of

Options

Any of

Option 1string

Option 2null

completedAt*any of

Options

Any of

Option 1string

Option 2null

createdAt*string

updatedAt*string

Option 2null

400Bad Requestapplication/json

Bodyone of

Options

One of

Option 1object

defined*constant

Value: true

code*constant

Value: "BAD_REQUEST"

status*constant

Value: 400

message*string

Default: "Bad Request"

dataValidationErrorData

2 fields

hintsarray of string

Suggested next steps. Wording can change; use error codes and structured data for program logic.

issuesarray of ValidationIssue

3 fields

message*string

codestring

patharray of any of

Options

Any of

Option 1string

Option 2number

Option 3object

key*any of

Options

Any of

Option 1string

Option 2number

Option 2object

defined*constant

Value: false

code*string

status*number

message*string

dataany

401Unauthorizedapplication/json

Bodyone of

Options

One of

Option 1object

defined*constant

Value: true

code*constant

Value: "UNAUTHORIZED"

status*constant

Value: 401

message*string

Default: "Unauthorized"

dataErrorData

1 field

hintsarray of string

Suggested next steps. Wording can change; use error codes and structured data for program logic.

Option 2object

defined*constant

Value: false

code*string

status*number

message*string

dataany

403Forbiddenapplication/json

Bodyone of

Options

One of

Option 1object

defined*constant

Value: true

code*constant

Value: "FORBIDDEN"

status*constant

Value: 403

message*string

Default: "Forbidden"

dataForbiddenErrorData

4 fields

hintsarray of string

Suggested next steps. Wording can change; use error codes and structured data for program logic.

missingPermissionsarray of string

requiredPlanconstant

Value: "pro"

actionstring

The requested action that was denied

Option 2object

defined*constant

Value: false

code*string

status*number

message*string

dataany

404Not Foundapplication/json

Bodyone of

Options

One of

Option 1object

defined*constant

Value: true

code*constant

Value: "NOT_FOUND"

status*constant

Value: 404

message*string

Default: "Not Found"

dataErrorData

1 field

hintsarray of string

Suggested next steps. Wording can change; use error codes and structured data for program logic.

Option 2object

defined*constant

Value: false

code*string

status*number

message*string

dataany

409Conflictapplication/json

Bodyone of

Options

One of

Option 1object

defined*constant

Value: true

code*constant

Value: "CONFLICT"

status*constant

Value: 409

message*string

Default: "Conflict"

dataErrorData

1 field

hintsarray of string

Suggested next steps. Wording can change; use error codes and structured data for program logic.

Option 2object

defined*constant

Value: false

code*string

status*number

message*string

dataany

429Too Many Requestsapplication/json

Bodyone of

Options

One of

Option 1object

defined*constant

Value: true

code*constant

Value: "TOO_MANY_REQUESTS"

status*constant

Value: 429

message*string

Default: "Too Many Requests"

dataRateLimitErrorData

3 fields

hintsarray of string

Suggested next steps. Wording can change; use error codes and structured data for program logic.

limitstring

The limit that was reached: a short-term rate limit, or a monthly API call, AI credit, or spending limit

One of: "rate", "api-calls", "ai-credits", "spending"

retryAfterSecondsnumber

Minimum delay before another attempt, in seconds. Also sent in Retry-After.

Option 2object

defined*constant

Value: false

code*string

status*number

message*string

dataany

500Internal Server Errorapplication/json

Bodyone of

Options

One of

Option 1object

defined*constant

Value: true

code*constant

Value: "INTERNAL_SERVER_ERROR"

status*constant

Value: 500

message*string

Default: "Internal Server Error"

dataErrorData

1 field

hintsarray of string

Suggested next steps. Wording can change; use error codes and structured data for program logic.

Option 2object

defined*constant

Value: false

code*string

status*number

message*string

dataany

503Service Unavailableapplication/json

Bodyone of

Options

One of

Option 1object

defined*constant

Value: true

code*constant

Value: "SERVICE_UNAVAILABLE"

status*constant

Value: 503

message*string

Default: "Service Unavailable"

dataErrorData

1 field

hintsarray of string

Suggested next steps. Wording can change; use error codes and structured data for program logic.

Option 2object

defined*constant

Value: false

code*string

status*number

message*string

dataany

Request

bash

curl --request GET \
  --url 'https://api.andesine.app/collections/coll_example/schema-migration' \
  --header 'Authorization: Bearer <token>'

javascript

const response = await fetch("https://api.andesine.app/collections/coll_example/schema-migration", {
  method: "GET",
  headers: {
    "Authorization": "Bearer <token>"
  }
});

const data = await response.json();

python

import requests

response = requests.get(
    "https://api.andesine.app/collections/coll_example/schema-migration",
    headers={
        "Authorization": "Bearer <token>",
    },
)

print(response.json())

typescript

import { createClient } from "@andesine/sdk";

const client = createClient({ apiKey: process.env.ANDESINE_API_KEY });

await client.schemaMigrations.getActive({
  collectionID: "coll_example"
});

Response

json

{
  "id": "string",
  "schemaID": "string",
  "schemaVersionID": "string",
  "status": "queued",
  "totalEntries": 0,
  "processedEntries": 0,
  "error": "string",
  "initiatedBy": "string",
  "startedAt": "string",
  "completedAt": "string",
  "createdAt": "string",
  "updatedAt": "string"
}

json

{
  "defined": true,
  "code": "BAD_REQUEST",
  "status": 400,
  "message": "Bad Request",
  "data": {
    "hints": [
      "string"
    ],
    "issues": [
      {
        "message": "string",
        "code": "string",
        "path": [
          "string"
        ]
      }
    ]
  }
}

json

{
  "defined": true,
  "code": "UNAUTHORIZED",
  "status": 401,
  "message": "Unauthorized",
  "data": {
    "hints": [
      "string"
    ]
  }
}

json

{
  "defined": true,
  "code": "FORBIDDEN",
  "status": 403,
  "message": "Forbidden",
  "data": {
    "hints": [
      "string"
    ],
    "missingPermissions": [
      "string"
    ],
    "requiredPlan": "pro",
    "action": "string"
  }
}

json

{
  "defined": true,
  "code": "NOT_FOUND",
  "status": 404,
  "message": "Not Found",
  "data": {
    "hints": [
      "string"
    ]
  }
}

json

{
  "defined": true,
  "code": "CONFLICT",
  "status": 409,
  "message": "Conflict",
  "data": {
    "hints": [
      "string"
    ]
  }
}

json

{
  "defined": true,
  "code": "TOO_MANY_REQUESTS",
  "status": 429,
  "message": "Too Many Requests",
  "data": {
    "hints": [
      "string"
    ],
    "limit": "rate",
    "retryAfterSeconds": 0
  }
}

json

{
  "defined": true,
  "code": "INTERNAL_SERVER_ERROR",
  "status": 500,
  "message": "Internal Server Error",
  "data": {
    "hints": [
      "string"
    ]
  }
}

json

{
  "defined": true,
  "code": "SERVICE_UNAVAILABLE",
  "status": 503,
  "message": "Service Unavailable",
  "data": {
    "hints": [
      "string"
    ]
  }
}