Get pgroll migration job status for the branch
https://{your-workspace-slug}.{region}.xata.sh/db/db_branch_name/pgroll/status
Get pgroll migration job status for the branch
Expected parameters
Name | Description | In | Required | Schema |
---|---|---|---|---|
db_branch_name | The DBBranchName matches the pattern | path | ✅ | string |
Get Pgroll Status
GEThttps://{your-workspace-slug}.{region}.xata.sh/db/db_branch_name/pgroll/status
Responses
type PgRollStatus = {
/**
* The id of the migration job
*/
jobID: string;
/**
* The type of the migration job
*/
type: PgRollJobType;
/**
* The status of the migration job
*/
status: PgRollJobStatus;
/**
* The error message associated with the migration job
*/
error?: string;
};
type PgRollJobType = "apply" | "start" | "complete" | "rollback";
type PgRollJobStatus = "pending" | "in_progress" | "completed" | "failed";
type PgRollStatus = void;
type PgRollStatus = {
id?: string;
message: string;
};
{
"message": "invalid API key"
}
type PgRollStatus = {
id?: string;
message: string;
};
type PgRollStatus = void;
type PgRollStatus = void;