Previous Topic: app ObjectNext Topic: config_boundary Method (app Object)


rename Method (app Object)
Description

Rename an application

Syntax
/api/v1/app/rename?app=application&new_name=new-application&vdc=controller-name 
Arguments
app

Name of the application to be renamed

new_name

New name of the application

vdc

Name of the target virtual data center

Transaction Type

synchronous

Request Type

GET

Examples

Rename an application named test to test2.

GET http://192.168.123.200/api/v1/app/rename?app=test&new_name=test2&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 (new_name). - Argument new=new-name missing in the request.

404.1

Entity not found – Permission denied – application ‘test123’ does not exist.

config Method (app Object)
Description

Retrieve application configuration parameters

Syntax
/api/v1/app/config?app=application&vdc=controller-name 
Arguments
app

Name of the application

vdc

Name of the target virtual data center

Options

See Application Control in the Command Line Shell Reference for descriptions of the options available for this command.

Transaction Type

synchronous

Request Type

GET

Examples

Retrieve configuration parameters for application test.

GET http://192.168.123.200/api/v1/app/config?app=test&vdc=mygrid 
Sample Output
XML:
<config>
   <name>test</name>
   <__description>Virtual Dedicated Server - Based on CentOS 5.1 (v1.0.14-1)</__description>
   <__doc_url>http://doc.3tera.net/AppLogic27/RefAppsVdsLinux.html</__doc_url> 
   <__template>0</__template>
</config>
JSON:
{
   "__doc_url" : "http://doc.3tera.net/AppLogic27/RefAppsVdsLinux.html",
   "__template" : "0",
   "__description" : "Virtual Dedicated Server - Based on CentOS 5.1 (v1.0.14-1)",
   "name" : "test"
} 
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.

404.1

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