Delete Web App

Delete the specified web app.

Request

  • Method: DELETE
  • Server: https://[app key here]-[site_ID here]-apps.worldsecuresystems.com. Take a look at the Authorize your API calls document for more info on how this URL is formed.
    • Note: When building apps always use relative request URLs. Do not use the "full" URL above because you might have problems running your app on a different site as the site_ID parameter will be different.
  • Path: /api/v2/admin/sites/current/webapps/[NAME]
    • Alternatively use siteID instead of 'current'
  • Authorization header: This should contain the authorization token. Here is how to obtain the token.
  • Required Permissions: Webapp Delete

Parameters

Use the name of the webapp as part of the URL (see Path)

Response

A 204 No Content is returned if deletion is successful.

Examples

The request body should not contain any data. The response will contain no data in case of success.

Request:

DELETE /api/v2/admin/sites/current/webapps/WEBAPP NAME HTTPS/1.1
Authorization: 14f87f21c5ea4830a06a6314a8aad82b45bc61dc08f24a0fb55599cea83ca811
Connection: keep-alive

Response:

HTTP/1.1 204 No Content

Sample code

var request = $.ajax({
    url: "/api/v2/admin/sites/current/webapps/test app",
    type: "DELETE",
    contentType: "application/json",headers: {
        "Authorization": $.cookie('access_token')
    }
});
request.done(function (msg) {
    console.log(msg);
})
request.fail(function (jqXHR) {
    console.log("Request failed.");
    console.log("Error code: " + jqXHR.status);
    console.log("Error text: " + jqXHR.statusText);
    console.log("Response text: " + jqXHR.responseText);
})


Error codes

This method will return the following error codes:

  • 204 - No content, on success
  • 401 - unauthorized - when the Authorization header is not present, or contains an invalid site token
    • 101000 - sub-error code
  • 403 - forbidden : this is returned when the user trying to access the API does not have the proper permissions
  • 404 - if trying to access a webapp that does not exist
    • 190001 - sub-error code