DELETE /api/apps/{AppID}
Deletes an app (all versions).
Note: If you want to completely remove an app, use DELETE /api/apps/{AppID}. If you want to delete the only existing app version, but keep the app, first add a new version, using POST /api/apps/{AppID}/versions, and then delete the old version using DELETE /api/apps/versions/{AppVersionID}. An app cannot exist in the Akana API Platform without at least one valid version.
Authorization Roles/Permissions: Must be logged in. App team member, Business Admin
This topic includes the following sections:
HTTP Method
DELETE
URL
https://{hostname}/api/apps/{AppID}[?comment]
Sample Request
The example below shows a request to delete a specific app.
Sample request URL
https://{hostname}/api/apps/eed508de-422a-4a66-823b-4309dca3ebfe.acmepaymentscorp
Sample request headers
DELETE /api/apps/eed508de-422a-4a66-823b-4309dca3ebfe.acmepaymentscorp HTTP/1.1
Host:{hostname}
X-Csrf-Token_acmepaymentscorp: TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...
Sample request body
None.
Request Headers
For general information on request header values, refer to HTTP Request Headers.
| Header | Description |
|---|---|
| Accept | text/plain |
| Content-Type | Any format (*/*) |
| Cookie | AtmoAuthToken_{fedmemberid}={cookie value, which usually starts with TokenID}—The platform cookie. This is the Akana API Platform authorization token, and must be sent with every API request that requires login. For more information and an example, see Session cookies. |
| X-Csrf-Token_{fedmemberID} | The CSRF prevention header; may or may not be required, depending on platform settings. See CSRF Prevention on the Platform. By default, the CSRF header is not required for GET operations and is required for all others, with a few exceptions relating to user login. |
Request Parameters
The comment is passed as an optional parameter.
| Parameter | Parm Type | Data Type | Required | Description |
|---|---|---|---|---|
| AppID | Path | string | Required | The unique ID for a specific app. |
| Comment | Query | string | Optional | A comment entered by the user deleting the app. |
Response
If successful, this operation returns HTTP status code 200, with the AppID of the deleted app, as shown in the example below.
Sample Response
The sample response below shows that the deletion was successful.
Sample response headers
Status Code: 200 OK Date: Wed, 25 Nov 2020 22:15:13 GMT Content-Type: text/plain Atmo-Renew-Token: renew Set-Cookie: Csrf-Token_acmepaymentscorp=TokenID%3D68b24a75-c5dc- ... AtmoAuthToken_acmepaymentscorp=TokenID%3Dcd36a4bd-e600-4e99-961a-c4ca0cfc93cd%2Cclaimed_id%3Durn%3Aatmosphere%3Auser%3Aacmepaymentscorp%3A14b1902f-3dfc-43e3-b09a-81137f091b96%2CissueTime%3D1614802132363%2CexpirationTime%3D1614803992357%2C...
Sample response body
eed508de-422a-4a66-823b-4309dca3ebfe.acmepaymentscorp
Response Headers
For general information on response header values, refer to HTTP Response Headers.
| Header | Description |
|---|---|
| Content-Type | text/plain |
| Atmo-Renew-Token | renew |
Response Body
| Name | Type | Description |
|---|---|---|
| AppID | string | The unique ID for a specific app. |
Error Codes/Messages
If the call is unsuccessful an error code/message is returned. One or more examples of possible errors for this operation are shown below.
| Item | Value |
|---|---|
| 401 | Unauthorized. For example, you would get this response if you didn't include the custom X-Csrf-Token_{fedmemberID} header in the request, when it was required by the platform settings; or if you included an invalid or expired value for this header. You would also get this response for any operation that requires login (almost all) if the login cookie was missing. |
| 500 | An error occurred processing the call. |
More information about Akana API Platform API error messages.