How an import started with startPlatformImport is doing: its status,
what it makes and what became of each item so far. Owners and admins.
API key access: read.
apiKeyAuthorizationBearer <pyo_…>An API key from the dashboard's API keys page: Authorization: Bearer pyo_…. Keys can expire, and an expired one gets a 401.
id*stringThe import's id.
The import.
application/jsonAn import, as it runs on the server and once it's done.
id*stringteamId*stringplatform*stringstatus*string"reading" (the platform), "importing", "done", "failed" (error says why) or "interrupted" (Pyo restarted during it: import again, what's there is skipped).
deploy*booleanitems*array<>What it makes, once the platform is read.
results*array<>What became of each item, as each one finishes.
error?stringcreatedBy*stringcreatedAt*integerUnix milliseconds.
int64finishedAt?|int64curl -X GET 'https://your-pyo.example.com/api/v1/platform-imports/string'{
"id": "string",
"teamId": "string",
"platform": "string",
"status": "string",
"deploy": true,
"items": [
{
"key": "string",
"name": "string",
"kind": "string"
}
],
"results": [
{
"key": "string",
"name": "string",
"state": "string",
"message": "string",
"id": "string",
"projectId": "string",
"connected": [
{
"database": "string",
"databaseId": "string",
"variables": [
"string"
]
}
]
}
],
"error": "string",
"createdBy": "string",
"createdAt": 0,
"finishedAt": 0
}