ServerActionUpgradePlesk - Revision history

Mike.robski: 1 revision: Release 86

2013-10-11T17:00:55Z

1 revision: Release 86

Emanuela.mitreva at 11:34, 12 July 2013

2013-07-12T11:34:07Z

Mike.robski: 1 revision

2013-05-24T15:24:59Z

1 revision

Mike.robski at 13:13, 20 May 2013

2013-05-20T13:13:25Z

Administrator at 01:16, 13 April 2013

2013-04-13T01:16:08Z

Mike.robski at 22:45, 14 December 2012

2012-12-14T22:45:47Z

Mike.robski at 20:34, 14 December 2012

2012-12-14T20:34:11Z

Administrator at 21:16, 4 July 2012

2012-07-04T21:16:13Z

Administrator: Created page with "This operation will upgrade the Plesk license for the specified server. ='''POST''' /servers/'''id'''/action= == Parameters == ; id : The unique identifier of the server..."

2012-07-04T21:15:54Z

Created page with "This operation will upgrade the Plesk license for the specified server. ='''POST''' /servers/'''id'''/action= == Parameters == ; id : The unique identifier of the server..."

New page

This operation will upgrade the Plesk license for the specified [[server]].

='''POST''' /servers/'''id'''/action=

== Parameters ==
; id
: The unique identifier of the server.

== Request==
=== JSON ===
<nowiki>
{
"upgradePlesk" : {
"username": "{plesk_server_username}",
"password": "{plesk_server_password}",
"port_number": "{plesk_server_port}",
"addon_textkey": "{plesk_addon_textkey}"
}
}</nowiki>

====upgradePlesk====
; username - ''string''
: The username used for authentication for managing Plesk license.

; password - ''string''
: The password used for authentication for managing Plesk license.

; port_number - ''string''
: The port used for managing Plesk license.

; addon_textkey - ''string''
: Plesk addon textkey to upgrade to.

== Response Codes ==
; Success:
: ''HTTP/1.1 202 Accepted'' : The request is accepted for processing.

; Failure:
: ''HTTP/1.1 400 Bad Request'' : Check your parameter / Server not found
: ''HTTP/1.1 401 Unauthorized'' : This server could not verify that you are authorized to access the document you requested. Either you supplied the wrong credentials (e.g., bad password), or your browser does not understand how to supply the credentials required.
: ''HTTP/1.1 403 Forbidden'' : The server understood the request, but is refusing to fulfill it.
: ''HTTP/1.1 404 Not Found'' : The resource does not exist.
: ''HTTP/1.1 409 Conflict'' : The request could not be completed due to a conflict with the current state of the resource. / Wrong Addon TextKey

== Examples ==
'''Successfully upgrade Plesk server license'''
:'''POST''' http(s)://{api_server}/servers/test_server_0013/action

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

''Request Body:''
{
"upgradePlesk" : {
"username": "plesk-username",
"password": "plesk-password",
"port_number": "12",
"addon_textkey": "plesk.9.linux.powerpack"
}
}

''Response Code:''
<pre>HTTP/1.1 202 Accepted</pre>

'''Failure while trying to upgrade Plesk while server is processing another task'''
:'''POST''' http(s)://{api_server}/servers/test_server_0013/action

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

''Request Body:''
{
"upgradePlesk" : {
"username": "plesk-username",
"password": "plesk-password",
"port_number": "12",
"addon_textkey": "plesk.9.linux.powerpack"
}
}

''Response Code:''
<pre>HTTP/1.1 409 Conflict</pre>

''Response Body:''
{
"conflict": {
"message": "PleskStillUpgrading",
"code": 409,
"details": "Some task is in processing for this instance. please wait for a while"
}
}

'''Unauthorized access'''
:'''POST''' http(s)://{api_server}/servers/test_server_0013/action

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded fake_authentication_string

''Request Body:''
{
"upgradePlesk" : {
"username": "plesk-username",
"password": "plesk-password",
"port_number": "12",
"addon_textkey": "plesk.9.linux.powerpack"
}
}

''Response Code:''
<pre>HTTP/1.1 401 Unauthorized</pre>

''Response Body:''
401 Unauthorized
This server could not verify that you are authorized to
access the document you requested. Either you supplied the
wrong credentials (e.g., bad password), or your browser
does not understand how to supply the credentials required.

'''Failure while trying to upgrade Plesk with an empty parameter body'''
:'''POST''' http(s)://{api_server}/servers/test_server_0013/action

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

''Request Body:''
{
empty
}

''Response Code:''
<pre>HTTP/1.1 400 Bad Request</pre>

''Response Body:''
{
"badRequest": {
"message": "Bad Request",
"code": 400,
"details": "Multiple actions per request are not allowed"
}
}

'''Failure while trying to upgrade Plesk with incorrect Plesk server credentials'''
:'''POST''' http(s)://{api_server}/servers/test_server_0013/action

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

''Request Body:''
{
"upgradePlesk" : {
"username": "fake-plesk-username",
"password": "fake-plesk-password",
"port_number": "12",
"addon_textkey": "plesk.9.linux.powerpack"
}
}

''Response Code:''
<pre>HTTP/1.1 403 Forbidden</pre>

''Response Body:''
{
"forbidden": {
"message": "WrongPleskAuthentication",
"code": 403,
"details": "Could not login to Plesk vm, check your VM login information"
}
}

'''Failure while trying to upgrade Plesk for a non-existent port server'''
:'''POST''' http(s)://{api_server}/servers/test_server_0013/action

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

''Request Body:''
{
"upgradePlesk" : {
"username": "plesk-username",
"password": "plesk-password",
"port_number": "1222",
"addon_textkey": "plesk.9.linux.powerpack"
}
}

''Response Code:''
<pre>HTTP/1.1 403 Forbidden</pre>

''Response Body:''
{
"forbidden": {
"message": "WrongPleskAuthentication",
"code": 403,
"details": "Could not login to Plesk vm, check your VM login information"
}
}

'''Failure while trying to upgrade Plesk for a non-existent Plesk addon textkey'''
:'''POST''' http(s)://{api_server}/servers/test_server_0013/action

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

''Request Body:''
{
"upgradePlesk" : {
"username": "plesk-username",
"password": "plesk-password",
"port_number": "12",
"addon_textkey": "fake.plesk.addon.textkey"
}
}

''Response Code:''
<pre>HTTP/1.1 409 Conflict</pre>

''Response Body:''
{
"conflict": {
"message": "WrongAddonTextkey",
"code": 409,
"details": "Please specify proper addon textkey"
}
}

'''Failure while trying to upgrade Plesk for a non-existent Plesk server'''
:'''POST''' http(s)://{api_server}/servers/fake_server_name/action

''Request Headers:''
Content-Type:application/json
Charset=UTF-8
Authorization:Base64-encoded username & password string

''Request Body:''
{
"upgradePlesk" : {
"username": "plesk-username",
"password": "plesk-password",
"port_number": "12",
"addon_textkey": "plesk.9.linux.powerpack"
}
}

''Response Code:''
<pre>HTTP/1.1 404 Not Found</pre>

''Response Body:''
{
"itemNotFound": {
"message": "Resource not found",
"code": 404,
"details": ""
}
}



{{#widget:DISQUS
|id=hostway
|uniqid={{PAGENAME}}
|url={{fullurl:{{PAGENAME}}}}
}}

← Older revision		Revision as of 01:16, 13 April 2013
Line 1:		Line 1:
−	~~=='''POST''' /servers/'''id'''/action==~~
	This operation will upgrade the Plesk license for the specified [[Server]].		This operation will upgrade the Plesk license for the specified [[Server]].
		+
		+	=='''POST''' /servers/'''id'''/action==

	=== Parameters ===		=== Parameters ===

← Older revision		Revision as of 20:34, 14 December 2012
Line 268:		Line 268:
	}		}

		+
		+	[[Category:API]]

	<!-- THIS CODE ENABLES DISQUS COMMENTS ON THE PAGE - DELETE TO DISABLE COMMENTING-->		<!-- THIS CODE ENABLES DISQUS COMMENTS ON THE PAGE - DELETE TO DISABLE COMMENTING-->

← Older revision		Revision as of 21:16, 4 July 2012
Line 1:		Line 1:
−	This operation will upgrade the Plesk license for the specified [[~~server~~]].	+	This operation will upgrade the Plesk license for the specified [[Server]].

	='''POST''' /servers/'''id'''/action=		='''POST''' /servers/'''id'''/action=

@@ Line 1: / Line 1: @@
 This operation will upgrade the Plesk license for the specified [[Server]].
-='''POST''' /servers/'''id'''/action=
+='''POST''' /accounts/''{accountId}''/flexcloud/servers/''{id}''/action=
 == Parameters ==
 ; id
 : The unique identifier of the server.
@@ Line 45: / Line 48: @@
 == Examples ==
 '''Successfully upgrade Plesk server license'''
-:'''POST''' http(s)://{api_server}/servers/test_server_0013/action
+:'''POST''' http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/test_server_0013/action
 ''Request Headers:''
@@ Line 66: / Line 69: @@
 '''Failure while trying to upgrade Plesk while server is processing another task'''
-:'''POST''' http(s)://{api_server}/servers/test_server_0013/action
+:'''POST''' http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/test_server_0013/action
 ''Request Headers:''
@@ Line 97: / Line 100: @@
 '''Unauthorized access'''
-:'''POST''' http(s)://{api_server}/servers/test_server_0013/action
+:'''POST''' http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/test_server_0013/action
 ''Request Headers:''
@@ Line 125: / Line 128: @@
 '''Failure while trying to upgrade Plesk with an empty parameter body'''
-:'''POST''' http(s)://{api_server}/servers/test_server_0013/action
+:'''POST''' http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/test_server_0013/action
 ''Request Headers:''
@@ Line 151: / Line 154: @@
 '''Failure while trying to upgrade Plesk with incorrect Plesk server credentials'''
-:'''POST''' http(s)://{api_server}/servers/test_server_0013/action
+:'''POST''' http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/test_server_0013/action
 ''Request Headers:''
@@ Line 182: / Line 185: @@
 '''Failure while trying to upgrade Plesk for a non-existent port server'''
-:'''POST''' http(s)://{api_server}/servers/test_server_0013/action
+:'''POST''' http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/test_server_0013/action
 ''Request Headers:''
@@ Line 213: / Line 216: @@
 '''Failure while trying to upgrade Plesk for a non-existent Plesk addon textkey'''
-:'''POST''' http(s)://{api_server}/servers/test_server_0013/action
+:'''POST''' http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/test_server_0013/action
 ''Request Headers:''
@@ Line 244: / Line 247: @@
 '''Failure while trying to upgrade Plesk for a non-existent Plesk server'''
-:'''POST''' http(s)://{api_server}/servers/<span style="color:red">fake_server_name</span>/action
+:'''POST''' http(s)://{api_server}/accounts/{accountId}/flexcloud/servers/<span style="color:red">fake_server_name</span>/action
 ''Request Headers:''
@@ Line 273: / Line 276: @@
+    }
+  }
 [[Category:Hostway API]]
 [[Category:FlexCloud Server API]]

@@ Line 1: / Line 1: @@
 This operation will upgrade the Plesk license for the specified [[Server]].
-=='''POST''' /servers/'''id'''/action==
+='''POST''' /servers/'''id'''/action=
-=== Parameters ===
+== Parameters ==
 ; id
 : The unique identifier of the server.
-=== Request===
+== Request==
-==== JSON ====
+=== JSON ===
   <nowiki>
+  {
@@ Line 19: / Line 19: @@
   }</nowiki>
-=====upgradePlesk=====
+====upgradePlesk====
 ; username - ''string''
 : The username used for authentication for managing Plesk license.
@@ Line 32: / Line 32: @@
 : Plesk addon textkey to upgrade to.
-=== Response Codes ===
+== Response Codes ==
 ; Success:
 : ''HTTP/1.1 202 Accepted'' : The request is accepted for processing.
@@ Line 43: / Line 43: @@
 : ''HTTP/1.1 409 Conflict'' : The request could not be completed due to a conflict with the current state of the resource. / Wrong Addon TextKey
-=== Examples ===
+== Examples ==
 '''Successfully upgrade Plesk server license'''
 :'''POST''' http(s)://{api_server}/servers/test_server_0013/action
@@ Line 91: / Line 91: @@
        "message": "PleskStillUpgrading",
        "code": 409,
-       "details": "Some task is in processing for this instance. please wait for a while"
+       "details": "Some task is in processing for this instance. please wait for a while",
+    }
+  }
@@ Line 144: / Line 145: @@
        "message": "Bad Request",
        "code": 400,
-       "details": "Multiple actions per request are not allowed"
+       "details": "Multiple actions per request are not allowed",
+    }
+  }
@@ Line 174: / Line 176: @@
        "message": "WrongPleskAuthentication",
        "code": 403,
-       "details": "Could not login to Plesk vm, check your VM login information"
+       "details": "Could not login to Plesk vm, check your VM login information",
+    }
+  }
@@ Line 204: / Line 207: @@
        "message": "WrongPleskAuthentication",
        "code": 403,
-       "details": "Could not login to Plesk vm, check your VM login information"
+       "details": "Could not login to Plesk vm, check your VM login information",
+    }
+  }
@@ Line 234: / Line 238: @@
        "message": "WrongAddonTextkey",
        "code": 409,
-       "details": "Please specify proper addon textkey"
+       "details": "Please specify proper addon textkey",
+    }
+  }
@@ Line 264: / Line 269: @@
        "message": "Resource not found",
        "code": 404,
-       "details": ""
+       "details": "",
+    }
+  }
@@ Line 270: / Line 276: @@
 [[Category:Hostway API]]
 [[Category:FlexCloud Server API]]