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: App team member, Business Admin

This topic includes the following sections:

HTTP Method

DELETE

Back to top

URL

https://{hostname}/api/apps/{AppID}[?comment]

Back to top

Sample Request

The example below shows a request to delete a specific app.

Sample request URL

https://{hostname}/api/apps/app10035.acmepaymentscorp

Sample request headers

DELETE /api/apps/app10035.acmepaymentscorp HTTP/1.1
Content-Type: text/plain
Accept: text/plain
X-Csrf-Token_{tenant}: {TokenID}

Sample request body

None.

Back to top

Request Headers

For general information on request header values, refer to HTTP Request Headers.

Header Description
Accept text/plain
Content-Type Any format (*/*)
X-Csrf-Token_{fedmemberID} The CSRF prevention header; may or may not be required, depending on platform settings. See CSRF Prevention on the Platform.

Back to top

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.

Back to top

Response

If successful, this operation returns HTTP status code 200, with the AppID of the deleted app, as shown in the example below.

Back to top

Sample Response

The sample response below shows that the deletion was successful.

Sample response headers

Status Code: 200 OK
Atmo-Renew-Token: renew
Content-Type: text/plain
Date: Tue, 02 Oct 2012 18:18:40 GMT

Sample response body

app10035.acmepaymentscorp

Back to top

Response Headers

For general information on response header values, refer to HTTP Response Headers.

Header Description
Content-Type text/plain
Atmo-Renew-Token renew

Back to top

Response Body

Name Type Description
AppID string The unique ID for a specific app.

Back to top

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.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics