Skip to content

Previews transferring a project to a different organizations, shows eligibility and impact

post/v2/projects/{ref}/transfers/previews

The fine-grained token must include the following permissions to access this endpoint:

  • project_admin_read

Path parameters

  • ref
    Required
    string

    Project ref

Body

  • data
    Required
    object

Response codes

  • 200
  • 401
  • 403
  • 429

Response (200)

{
"data": {
"type": "project_transfer_result",
"attributes": {
"valid": true,
"warnings": [
{
"key": "lorem",
"message": "lorem"
}
],
"errors": [
{
"key": "lorem",
"message": "lorem"
}
],
"info": [
{
"key": "lorem",
"message": "lorem"
}
]
}
}
}
{
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Resource type.",
"enum": [
"project_transfer_result"
]
},
"attributes": {
"type": "object",
"properties": {
"valid": {
"type": "boolean"
},
"warnings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"key",
"message"
]
}
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"key",
"message"
]
}
},
"info": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"message": {
"type": "string"
}
},
"required": [
"key",
"message"
]
}
}
},
"required": [
"valid",
"warnings",
"errors",
"info"
]
}
},
"required": [
"type",
"attributes"
]
}
},
"required": [
"data"
]
}