v1
Double column
API
CLI
JS Client

Addons /

Get addon version details

Gets details about the current addon version including available upgrades and upgrade history.

Required permission

Project > Addons > General > Read

Path parameters

    • projectId

      string required

      ID of the project

    • addonId

      string required

      ID of the addon

Response body

  • {object}

    Response object.

    • data

      {object} required

      Result data.

      • version

        string required

        The version of the addon running.

      • upgradeTo

        [array] required

        Available versions that the addon can be upgraded to.

        • {object}
          • version

            string required

            The version of the addon to upgrade to.

          • type

            string required

            Whether the version is a major or minor version.

            one of
            major, minor, patch
      • lifecycleStatus

        string required

        The support status of the current addon version.

        one of
        active, deprecated, discontinued
      • discontinuedBy

        string

        The date that the current addon version will be discontinued.

      • upgradeHistory

        [array] required

        Data about the upgrade history of this addon.

        • {object}

          Details about a previous upgrade.

          • upgradeId

            string required

            The unique identifier of the addon upgrade.

          • status

            {object} required

            Details about the upgrade status.

            • status

              string required

              The status of the addon upgrade.

              one of
              scheduled, in-progress, completed, aborting, aborted, failed, not-supported
          • createdAt

            string required

            The time the upgrade was initiated.

          • type

            string required

            Whether the version updated to is a major or minor version.

            one of
            major, minor, patch
          • previousVersion

            string required

            The version upgraded from.

          • newVersion

            string required

            The version upgraded to.

          • completedAt

            string

            The time the upgrade was completed.

API
CLI
JS Client

GET /v1/projects/{projectId}/addons/{addonId}/version

Example response

200 OK

Details about the current version of the addon.

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",
        "type": "minor",
        "previousVersion": "4.2.14",
        "newVersion": "4.2.15",
        "completedAt": "2021-08-18T13:40:51.685Z"
      }
    ]
  }
}

© 2022 Northflank Ltd. All rights reserved.