For up-to-date product documentation, see the IBM MobileFirst Foundation Developer Center.

Get GCM Settings (GET)

Retrieves GCM 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/gcmConf

Example

https://www.example.com/mfpadmin/management-apis/2.0/runtimes/myruntime/notifications/applications/myapplication/gcmConf?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 GCM credentials.

JSON Example

{
  "apiKey" : "AIzaSyBnWWReKAFrOPiw75QQAcRM",
  "productVersion" : "8.0",
  "senderId" : "11639055112",
}

XML Example

<?xml version="1.0" encoding="UTF-8"?>
<pushGCM
  apiKey="AIzaSyBnWWReKAFrOPiw75QQAcRM"
  productVersion="8.0"
  senderId="11639055112"/>

Response Properties

The response has the following properties:

apiKey

GCM Api Key

productVersion

The exact product version.

senderId

The project ID that is signed up at the Google API console.

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.

Parent topic: REST API for the MobileFirst Server administration service