Delete application

1 min

DELETE

/_cms/v1/applications/{key}

Deletes the application with the provided key.

Path Parameters

keystringrequired
Description
The key of the application to delete.

Header Parameters

Preferstring[]
Example
```
[
  "return=representation"
]
```
Description
Indicates client preference for the response content as per IETF RFC7240. Currently only supports 'return=representation' which can be used to indicate a preference to receive a representation of the resource that has been altered in the response.
If-Matchstring
Description
If provided, the DELETE request will only be considered if the value matches the RFC7232 ETag of the current resource. Weak ETags will always be ignored.
If-Unmodified-Sincestring<http-date>
Description
If provided, the DELETE request will only be considered if the resource has not been modified since the provided date. This parameter will be ignored if an 'If-Match' parameter is also provided.
Format
http-date

Responses

200OK

Application
Description
Represents a CMS application (website or remote website).
- keystring
  Description
  The unique identifier (key) of the resource.
  Min Length
  2
  Max Length
  255
  Pattern
  ^[A-Za-z][_0-9A-Za-z]+$
- displayNamestringrequired
  Description
  The display name of this Application.
  Min Length
  1
  Max Length
  255
- typeApplicationTyperequired
  Description
  Represents the type of an Application.
- sourcestring
  Description
  A string that is used to indicate the source of this Application.
- entryPointstring<uri>required
  Description
  A reference to the entry point (start page) content for this application.
  Format
  uri
- isDefaultboolean
  Description
  Whether this is the default application.
- useApplicationSpecificAssetsboolean
  Description
  Whether this application uses a dedicated assets folder.
- assetsRootstring<uri>
  Description
  Returns the root for application-specific assets, if UseApplicationSpecificAssets is true.
  Format
  uri
- hostsApplicationHost[]
  Description
  The hosts assigned to this application.
  - authoritystringrequired
    Description
    The DNS host name or IP address and optional port of this host.
    Min Length
    1
    Max Length
    255
  - typeApplicationHostType
    Description
    Represents the type of an ApplicationHost.
  - localestring
    Description
    The locale associated with this host.
  - preferredUrlSchemeUrlScheme
    Description
    Specifies the preferred URL scheme to be used when accessing a host.
- usePreviewTokensboolean
  Description
  Whether to use preview tokens for this application. Only applicable when the type is 'website'.
- previewUrlFormatsmap<string, string>
  Description
  A dictionary of preview URL formats keyed by content type base or content type key. Only applicable when the type is 'website'.
- createdstring<date-time>
  Description
  A timestamp indicating when this resource was first created.
  Format
  date-time
- createdBystring
  Description
  The name of the user or application that created this resource.
- lastModifiedstring<date-time>
  Description
  Indicates the last time this resource was modified.
  Format
  date-time
- lastModifiedBystring
  Description
  The name of the user or application that last modified this resource.

Response Headers

Preference-Applied

204No Content

400Bad Request

401Unauthorized

403Forbidden

404Not Found

412Precondition Failed

500Internal Server Error

curl

curl --request DELETE \
     --url /_cms/v1/applications/{key} \
     --header 'accept: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var requestOptions = {
   method: 'DELETE',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("/_cms/v1/applications/{key}", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("/_cms/v1/applications/{key}")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Delete.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

response = http.request(request)
puts response.read_body

python

import requests
import json

url = "/_cms/v1/applications/{key}"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("DELETE", url, headers=headers, data=payload)

print(response.text)

200

// OK
{
  "key": "",
  "displayName": "",
  "type": {},
  "source": "",
  "entryPoint": "",
  "isDefault": false,
  "useApplicationSpecificAssets": false,
  "assetsRoot": "",
  "hosts": [
    {
      "authority": "",
      "type": {},
      "locale": "",
      "preferredUrlScheme": {}
    }
  ],
  "usePreviewTokens": false,
  "previewUrlFormats": "",
  "created": "",
  "createdBy": "",
  "lastModified": "",
  "lastModifiedBy": ""
}

204

// No Content

400

// Bad Request

401

// Unauthorized

403

// Forbidden

404

// Not Found

412

// Precondition Failed

500

// Internal Server Error