Get APNs Settings (GET)

Retrieves APNs credentials for the application.

Roles

Users in the following roles are authorized to perform this operation:

  • mfpadmin
  • mfpdeployer
  • mfpmonitor
  • mfpoperator

Method

GET

Path

/management-apis/2.0/runtimes/runtime-name/notifications/applications/application-name/apnsConf

Example

https://www.example.com/mfpadmin/management-apis/2.0/runtimes/myruntime/notifications/applications/myapplication/apnsConf?locale=de_DE

Path Parameters

runtime-name
The name of the runtime. This is the context root of the runtime web application, without the leading slash.
application-name
The name of the application.

Query Parameters

Query parameters are optional.

locale
The locale used for error messages.

Produces

application/json, application/xml, text/xml

Response

The metadata of the APNS certificate.

JSON Example

{
  "certificate" : "apns-certificate-sandbox.p12",
  "isSandBox" : true,
  "productVersion" : "8.0",
  "validUntil" : "2016-09-10T09:32:30.000Z",
}

XML Example

<?xml version="1.0" encoding="UTF-8"?>
<pushAPNS
  certificate="apns-certificate-sandbox.p12"
  isSandBox="true"
  productVersion="8.0"
  validUntil="2016-09-10T09:32:30.000Z"/>

Response Properties

The response has the following properties:

certificate
The name of the APNS certificate
isSandBox
Is this certificate for SandBox or Production?
productVersion
The exact product version.
validUntil
The expiration date for the certificate

Errors

400
The request was not understood by the push server.
403
The user is not authorized to call this service.
404
The corresponding runtime or application is not found or not running.
500
An internal error occurred.