Push Application Settings (GET)

Retrieves appplication settings

Description

This can be used to find the mode of the application.

Method

GET

Path

/apps/applicationId/settings

Example

https://example.com:443/imfpush/v1/apps/myapp/settings

Path Parameters

applicationId
The name or identifier of the application

Header Parameters

Some header parameters are optional.

Accept-Language
(Optional) The preferred language to use for error messages. Default:en-US
Authorization
The token with the scope "settings.read" and "push.application.<applicationId>" obtained using the confidential client in the format Bearer token.. This parameter has to be mandatorily set.

Produces

application/json

Response

Retrieve application settings.

JSON Example

{
  "apnsConf" : "https://example.com:443/imfpush/v1/apps/testApp/settings/apnsConf",
  "applicationId" : "testApp",
  "gcmConf" : "https://example.com:443/imfpush/v1/apps/testApp/settings/gcmConf",
  "mode" : "PRODUCTION",
}

Response Properties

The response has the following properties:

apnsConf
Reference link to APNS settings.
applicationId
The application Id.
gcmConf
Reference link to GCM settings.
mode
The operation mode

Errors

401
Unauthorized - The caller is either not authenticated or not authorized to make this request.
404
The application does not exist.
406
Unsupported Accept type - The content type specified in Accept header is not application/json.
500
An internal error occurred.