DELETE /api/apps/versions/{AppVersionID}/keyinfo

Deletes an app's public key or certificate.

Workflow: This operation checks whether the resource is governed by a workflow, and if so whether the action is valid based on the current state of the resource. If the action is not valid, the operation will fail.

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/versions/{AppVersionID}/keyinfo

Back to top

Sample Request

The example below shows a request to delete the public key credentials for the specified app version.

Sample request URL

https://{hostname}/api/apps/versions/24kAuJa8ie9vsJNUdopeG61X.acmepaymentscorp/keyinfo?Comments=Removing+old+credentials%2C+pending+new+certificate.

Sample request headers

DELETE /api/apps/versions/24kAuJa8ie9vsJNUdopeG61X.acmepaymentscorp/keyinfo?Comments=Removing+old+credentials%2C+pending+new+certificate. HTTP/1.1
Host: {hostname}
Accept: text/plain, */*; q=0.01
Content-Type: application/x-www-form-urlencoded
X-Csrf-Token_{tenant}: {TokenID}

Sample request body

Not applicable

Back to top

Request Headers

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

Header Description
Accept Any Accept header value that supports a response Content-Type of text/plain is valid; for example, */*.
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

Parameter Parm Type Data Type Required Description
AppVersionID Path string Required The unique ID for a specific app version.
Comments Form string Required Comments entered by the user performing the action.

Back to top

Response

If successful, this operation returns HTTP status code 200, with the AppVersionID returned in the response.

Back to top

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers

HTTP/1.1 200 OK
Content-Type: text/plain
Expires: Mon, 05 Jan 2015 11:14:29 GMT

Sample response body

24kAuJa8ie9vsJNUdopeG61X.acmepaymentscorp

Back to top

Response Headers

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

Header Description
Content-Type text/plain

Back to top

Response Body

Name Type Description
Response AppVersionID The unique ID for a specific app version.

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.
404 The resource could not be found.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics