Integration Guides › Web Service API Reference Guide › Valid Web API Objects › app Object › lock Method (app Object)

lock Method (app Object)

Description

Lock an application

Syntax

/api/v1/app/lock?app=application&pwd=password&vdc=controller-name 

Arguments

app

Name of the application

pwd

Password

vdc

Name of the target virtual data center

Transaction Type

synchronous

Request Type

GET

Examples

Lock application test.

GET http://192.168.123.200/api/v1/app/lock?app=test&pwd=password&vdc=mygrid 

Sample Output

XML:

<opt></opt>

JSON:

{} 

HTTP Error Codes

404

Entity vdc mygrid not found - A VDC name was specified that is not configured in the WS_API application.

400.4

Missing required arguments (app). - Argument app=app missing in the request.

400.4

Missing required arguments (pwd). - Argument pwd=password missing in the request.

404.1

Application test does not exist. - An invalid application name was specified in the request.

Note: The password that is used to lock an application is required to unlock the application. When an application is locked, no volumes belonging to the application may be managed and the application may not be modified in any way.