GET /api/apps/versions/{AppVersionID}/certificate

Returns the security certificate for an app version.

Authorization Roles/Permissions: App team member, Business Admin, or Site Admin.

This topic includes the following sections:

HTTP Method

GET

Back to top

URL

https://{hostname}/api/apps/versions/{AppVersionID}/certificate

Back to top

Sample Request

The example below shows a request for the CSR certificate for the specified app version.

Sample request URL

https://{hostname}/api/apps/versions/4iXro2Uxs2h4LviCshR9pK9w.acmepaymentscorp/certificate

Sample request headers

Accept: application/octet-stream
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 application/octet-stream

Back to top

Request Parameters

Parameter Parm Type Data Type Required Description
AppVersionID Path string Required The unique ID for a specific app version.

Back to top

Response

If successful, this operation returns HTTP status code 200, with the certificate as a file attachment.

Back to top

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers

Status Code: 200 OK
Content-Disposition: attachment;filename="certificate.cer"
Content-Type: application/octet-stream
Date: Thu, 30 May 2013 18:41:41 GMT

Sample response body

The response body is the certificate file.

Back to top

Response Headers

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

Header Description
Content-Type application/octet-stream
Content-Disposition attachment;filename="certificate.cer"

Back to top

Response Body

Name Type Description
certificate.cer File attachment The certificate file for the specified 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.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics