Addons /
Get addon version details
Required permission
Project > Addons > General > Read
Path parameters
projectId
string requiredID of the project
addonId
string requiredID of the addon
Response body
- {object}
Response object.
data
{object} requiredResult data.
version
string requiredThe version of the addon running.
upgradeTo
[array] requiredAvailable versions that the addon can be upgraded to.
- {object}
version
string requiredThe version of the addon to upgrade to.
type
string requiredWhether the version is a major or minor version.
one ofmajor, minor, patchlifecycleStatus
string requiredThe support status of the current addon version.
one ofactive, deprecated, discontinueddiscontinuedBy
stringThe date that the current addon version will be discontinued.
upgradeHistory
[array] requiredData about the upgrade history of this addon.
- {object}
Details about a previous upgrade.
upgradeId
string requiredThe unique identifier of the addon upgrade.
status
{object} requiredDetails about the upgrade status.
status
string requiredThe status of the addon upgrade.
one ofscheduled, in-progress, completed, aborting, aborted, failed, not-supportedcreatedAt
string requiredThe time the upgrade was initiated.
upgradeType
string requiredWhether the version updated to is a major or minor version.
one ofmajor, minor, patchpreviousVersion
string requiredThe version upgraded from.
newVersion
string requiredThe version upgraded to.
completedAt
stringThe time the upgrade was completed.
GET /v1/projects/{projectId}/addons/{addonId}/version
Example response
200 OK
JSON
{
"data": {
"version": "4.2.14",
"upgradeTo": [
{
"version": "4.2.15",
"type": "minor"
}
],
"lifecycleStatus": "deprecated",
"discontinuedBy": "01.08.2021",
"upgradeHistory": [
{
"upgradeId": "611d0da52cd838bbdeec4792",
"status": {
"status": "completed"
},
"createdAt": "2021-08-18 13:39:49.475Z",
"upgradeType": "minor",
"previousVersion": "4.2.14",
"newVersion": "4.2.15",
"completedAt": "2021-08-18T13:40:51.685Z"
}
]
}
}