Install Application Request

---

The install application request installs the server application provided in the included JSON content. The application file name is a URL path that should begin with the virtual resource name Applications and may contain sub-folders, but must refer to an existing valid server application file already present on the web server. Please see the Web Server Administration API - Files topic for more information on the virtual resource names used when managing files on the web server. If there is no active session or the session is not authenticated, the request will result in a 403 Forbidden HTTP response.

HTTP Method: POST

HTTP Request Content Type: application/json; charset=utf-8

Example Request:

https://localhost/administration?method=installapplication

Example Request Content:

{
   "Name": "MusicCollection",
   "FileName": "Applications\/musiccollection.wba"
}

HTTP Response: 200 on success, 403 if not authenticated, and 500 on error


Rename Application Request

---

The remame application request renames the server application provided in the included JSON content to a new name. If there is no active session or the session is not authenticated, the request will result in a 403 Forbidden HTTP response.

HTTP Method: POST

HTTP Request Content Type: application/json; charset=utf-8

Example Request:

https://localhost/administration?method=renameapplication

Example Request Content:

{
   "Name": "MusicCollection",
   "NewName": "MusicCollectionApplication"
}

HTTP Response: 200 on success, 403 if not authenticated, and 500 on error


Uninstall Application Request

---

The uninstall application request uninstalls the server application provided in the included JSON content. If there is no active session or the session is not authenticated, the request will result in a 403 Forbidden HTTP response.


HTTP Method: POST

HTTP Request Content Type: application/json; charset=utf-8

Example Request:

https://localhost/administration?method=uninstallapplication

Example Request Content:

{
   "Name": "MusicCollection"
}

HTTP Response: 200 on success, 403 if not authenticated, and 500 on error


Get Application Privileges Request

---

The get application privileges request retrieves the execute privilege assigned to the server application provided in the included JSON content. If the execute privilege has not been specified, then the server application is accessible to all users. If there is no active session or the session is not authenticated, the request will result in a 403 Forbidden HTTP response.

HTTP Method: GET

HTTP Request Content Type: application/json; charset=utf-8
HTTP Response Content Type: application/json; charset=utf-8

Example Request:

https://localhost/administration?method=getapplicationprivileges

Example Request Content:

{
   "Name": "MusicCollection"
}

Example Response Content:

{
   "Privilege": "ExecuteMusicCollection"]
}

HTTP Response: 200 on success, 403 if not authenticated, and 500 on error


Set Application Privileges Request

---

The set application privileges request assigns the execute privilege for the server application provided in the included JSON content. If the execute privilege is not specified, then the server application will be accessible to all users. If there is no active session or the session is not authenticated, the request will result in a 403 Forbidden HTTP response.

HTTP Method: POST

HTTP Request Content Type: application/json; charset=utf-8

Example Request:

https://localhost/administration?method=setapplicationprivileges

Example Request Content:

{
   "Name": "MusicCollection"
   "Privilege": "ExecuteMusicCollection"
}

HTTP Response: 200 on success, 403 if not authenticated, and 500 on error


Get Applications Request

---

The get applications request enumerates all of the server applications installed on the web server. If there is no active session or the session is not authenticated, the request will result in a 403 Forbidden HTTP response.

HTTP Method: GET

Example Request:

https://localhost/administration?method=getapplications

Example Response Content:

{
   "Applications": [{ "Name": "MusicCollection",
                 "FileName": "Applications\/musiccollection.wba",
                 "Privilege": "" }]
}

HTTP Response: 200 on success, 403 if not authenticated, and 500 on error