Migration Progress

`POST` /v1/minecraft/migration/progress

Report or update the progress of an ongoing migration. This endpoint is used to track how many records have been processed and to communicate the current status of the migration operation.

Authentication

Requires the X-API-Key header with your server's API key.

X-API-Key: your-api-key-here

Request

Headers

Header	Type	Required	Description
`X-API-Key`	string	Yes	Your server's API key.
`Content-Type`	string	Yes	Must be `application/json`.

Body

Field	Type	Required	Description
`status`	string	Yes	The current status of the migration (e.g., `processing`, `completed`, `failed`).
`message`	string	Yes	A human-readable message describing the current progress.
`processed`	integer	No	The number of records processed so far.
`total`	integer	No	The total number of records to process.

{
  "status": "processing",
  "message": "Importing player records...",
  "processed": 500,
  "total": 2000
}

Response

`200 OK`

{
  "success": true
}

Error Responses

Status Code	Description
`400`	Invalid request body. Missing required fields or invalid status value.
`401`	Missing or invalid API key.
`429`	Rate limit exceeded.
`500`	Internal server error.

Migration Progress

On this page