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

Returns the public key or certificate stored for the specified app.

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

This topic includes the following sections:

HTTP Method

GET

URL

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

Sample Request

The example below shows a request for the key info for the specified app version.

Sample request URL

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

Sample request headers

Accept: application/json
X-Csrf-Token_acmepaymentscorp: TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample request body

Not applicable.

Request Headers

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

Header	Description
Accept	application/json, application/vnd.soa.v71+json, application/vnd.soa.v72+json, application/vnd.soa.v80+json, application/vnd.soa.v81+json
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

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

Response

If successful, this operation returns HTTP status code 200, with the key information in JSON format.

Sample Response

The sample response below shows successful completion of the operation.

Sample response headers

Status Code: 200 OK
Content-Type: application/json
Date: Thu, 30 May 2013 19:03:03 GMT

Sample response body

{
  "CSR" : "MIICkDCCAfmgAwIBAgICBB4wDQYJKoZIhvcNAQEFBQAwSjELMAkGA1UEBhMCc3MxCjAIBgNVBAgMAWMxCjAIBgNVBAcMAWMxCjAIBgNVBAoMAWMxCzAJBgNVBAsMA
mNjMQowCAYDVQQDDAFjMB4XDTEzMDUzMDE4MzUyMloXDTIwMDUxNTEyMDAwMFowTTELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAkNBMRQwEgYDVQQHEwtMb3MgQW5nZWxlczEbMBkGA
1UEChMSUGFhc3RpbWUgQXBwcyBJbmMuMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA51vHxc6+sST/l5EtSxKeu2QEZVPQ+scVspMhxX9Wr7N8cqVPGocUFqL3Mr9+l
5lN+MvddQdYqdXg9XFkqNld7pNqIn0wyUeTtgwTvnkpQFNVoWgzvSa2Uq2ZGK+GV8bG+yP7px6cY85YlXWNJs0DheVI0HdN33Ura6C0r/84zgchne+iIivNioTYLI+jTJfnIfoau
8J75IzeMKxnW9ftx8hDq5YqTEhU7ligg7qv1l3l94PkOam18A3HO9/u+t4JYMYX6vNdbOq80ywpdxvzURCru4brl9pQRefxg5wXi39KHfMnqMHTw7QFTmDdgVXEcDTYxNxtZ00
EI/jhWd6hjwIDAQABMA0GCSqGSIb3DQEBBQUAA4GBAAYjQLRKAacSS9LK4r/Qrfv1AJ+v2j7fc/6Xz78VMej1hpMASPvsmmMHduYc8hRVMC0R8lPSHTjE81yOdugyxajr4KfV1Jx8
bqQvI1XdIMAJJ8kt2eo4p8XcDO9ngR7YLg4/S5R4ydkdpkxvrY2ulGp0sDUIFOV4m8I9rtRNcSfY"
}

Response Headers

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

Header	Description
Content-Type	application/json, application/vnd.soa.v71+json, application/vnd.soa.v72+json, application/vnd.soa.v80+json, application/vnd.soa.v81+json

Response Body

Name	Type	Description
ApplicationKeyInfo	ApplicationKeyInfo	The current secret key or certificate for the specified 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.

Related Topics