Skip to content
Matthew Martin edited this page Jun 12, 2020 · 5 revisions

/x-epi/update

GET

Returns the current version numbers of all ePi applications

HTTP Status Code: 200

Body: application/json

{
    "server": 
    {
        "version": string - in format Major.Minor.Patch.Build,
        "date": string - date and time in ISO format of the last build
    },
    "player3":
    {
        "version": string - in format Major.Minor.Patch.Build,
        "date": string - date and time in ISO format of the last build
    },
    "player67"::
    {
        "version": string - in format Major.Minor.Patch.Build,
        "date": string - date and time in ISO format of the last build
    }
}    

PUT

Updates a particular application

Body: multipart/form-data

  • application: string - the name of the application. One of "episerver", "player3" or "player67",
  • file: file - the updated application

HTTP Status Code: 200

The application has been successfully updated.

Body: application/json

{
    "result": true,
    "restart": boolean - true if the application updated is currently running and will finish updating when it restarts
}

HTTP Status Code: 400

The data uploaded is incorrect in some way

Body: application/json

{
    "result": boolean - false, 
    "reason": [ an array of strings giving the reasons for the failure ]
}

HTTP Status Code: 500

The application cannot be updated for some reason

Body: application/json

{
    "result": boolean - false, 
    "reason": [ an array of strings giving the reasons for the failure ]
}

HTTP Status Code: 423

Returned when the system has been locked using the Status API endpoint

Body: application/json

{
    "result": false,
    "reason": 
    [
        "the system is locked"
    ]
}
Clone this wiki locally