Skip to main content
POST
/
v2
/
schema-migrations
/
{id}
/
cancel
Cancel Schema Migration
curl --request POST \
  --url https://public.api.serval.com/v2/schema-migrations/{id}/cancel \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "id": "<string>",
    "entityTypeId": "<string>",
    "details": {
      "changeFieldType": {
        "fieldId": "<string>",
        "fieldKey": "<string>"
      }
    },
    "actorUserId": "<string>",
    "startedAt": "2023-11-07T05:31:56Z",
    "completedAt": "2023-11-07T05:31:56Z",
    "error": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

The ID of the schema migration to cancel. Only a migration still in the PENDING state can be cancelled; once the worker has started applying it the request fails with FailedPrecondition.

Response

Success

​
data
data · object

The cancelled migration (status CANCELLED).