App Version Lock (PUT)
Locks a specific app version.
Description
A locked app version cannot be updated anymore.
Roles
Users in the following roles are authorized to perform this operation:
- worklightadmin
- worklightdeployer
- worklightoperator
Method
PUT
Path
/management-apis/1.0/runtimes/runtime-name/applications/application-name/application-env/application-version/lock
Example
https://www.example.com/worklightadmin/management-apis/1.0/runtimes/myruntime/applications/myapplication/android/1.0/lock?locale=de_DE
Path Parameters
- runtime-name
- The name of the runtime. This is the context root of the runtime web application, without the leading slash.
- application-name
- The name of the application.
- application-env
- The application environment.
- application-version
- The application version number.
Query Parameters
Query parameters are optional.
- locale
- The locale used for error messages.
Consumes
application/json
Produces
application/json, application/xml, text/xml
Payload
JSON Example
{
"lock" : true,
"warning" : "true",
}
Payload Properties
The payload has the following properties:- lock
- Whether the app version is locked.
- warning
- When a warning happens, provides the details.
Response
JSON Example
{
"ok" : true,
"warning" : "true",
}
XML Example
<?xml version="1.0" encoding="UTF-8"?>
<set-appversion-lock-result
ok="true"
warning="true"/>
Response Properties
The response has the following properties:
- ok
- Whether the operation was successful.
- warning
- When a warning happens, provides the details.
Errors
400The payload is invalid.
403 The user is not authorized to call this service.
404 The corresponding runtime or the app version is not found.
500 An internal error occurred.