Get all migrations
GET/v1/migrations
This route allows you to fetch all migrations (both past and present) in your Port organization.
The call will perform a logical AND operation on the query parameters below, and return all migrations that match the criteria.
Request
Parameters (JSON)
{
"parameters": [
{
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"COMPLETED",
"RUNNING",
"PENDING",
"INITIALIZING",
"FAILURE",
"CANCELLED",
"PENDING_CANCELLATION"
]
}
},
"in": "query",
"name": "status",
"required": false,
"style": "form",
"explode": true
},
{
"schema": {
"type": "string"
},
"in": "query",
"name": "actor",
"required": false,
"description": "The identifier of the user who initiated the migration. You can use the [Get user](https://docs.port.io/api-reference/get-a-user/) route to get a user's identifier."
},
{
"schema": {
"type": "string"
},
"in": "query",
"name": "blueprint",
"required": false,
"description": "The identifier of the blueprint associated with the migration."
}
]
}Request body schema (JSON)
{
"title": "Body"
}Responses
- 401
- 404
Default Response
A resource with the provided identifier was not found
Responses (JSON)
{
"responses": {
"401": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"properties": {
"ok": {
"const": false
},
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"ok",
"error"
],
"additionalProperties": false
}
}
}
},
"404": {
"description": "A resource with the provided identifier was not found",
"content": {
"application/json": {
"schema": {
"properties": {
"ok": {
"const": false
},
"error": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"ok",
"error",
"message"
],
"additionalProperties": false,
"description": "A resource with the provided identifier was not found"
}
}
}
}
}
}