SetPlatformApplicationAttributes
Written by
Updated at April 17, 2025
Setting up mobile push notification channel or in-browser push notification channel parameters.
HTTP request
POST https://notifications.yandexcloud.net/
Query parameters
| Parameter | Description |
|---|---|
Action |
string Required field. Operation type parameter. Value: SetPlatformApplicationAttributes. |
PlatformApplicationArn |
string Required field. Notification channel name. Example: arn:aws:sns::aoegtvhtp8ob********:app/GCM/test-cns-9990. |
Attributes.entry.N.key |
string Required field. Attribute key. N is a numeric value.Example: Attributes.entry.1.key=PlatformPrincipal&Attributes.entry.2.key=PlatformCredential. |
Attributes.entry.N.value |
string Required field. Attribute value. N is a numeric value.Example: Attributes.entry.1.value=c8gzjriSVxDDzX2fAV********&Attributes.entry.2.value=CgB6e3x9iW/qiE9l9wAUPK0e/bJQe5uIgTlYUD4bP********. |
ResponseFormat |
string Response format. The possible values are:
|
Attributes
Common attributes
| Attribute | Description |
|---|---|
Description |
string Application description. Example: Test application |
APNS and APNS_SANDBOX attributes
| Attribute | Description |
|---|---|
PlatformPrincipal |
string Token in .p8 format or SSL certificate in .p12 format. Token-based authentication is preferred as a more modern option. |
PlatformCredential |
string Token ID or private key of the SSL certificate. |
ApplePlatformTeamID |
string Developer ID, only when using a token. |
ApplePlatformBundleID |
string App ID (bundle ID), only when using a token. |
FCM attributes
| Attribute | Description |
|---|---|
PlatformCredential |
string Key of the Google Cloud service account in JSON format for authentication with the HTTP v1 API or API key (server key) for authentication with the legacy API. The HTTP v1 API is preferred as FCM will no longer support the legacy API starting from June 2024. |
HMS attributes
| Attribute | Description |
|---|---|
PlatformPrincipal |
string Key ID. |
PlatformCredential |
string API key. |
RUSTORE attributes
| Attribute | Description |
|---|---|
PlatformPrincipal |
string Project ID. |
PlatformCredential |
string Service token. |
For more information about authentication attributes, see the Mobile push notification channels subsection.
Response
Successful response
If there are no errors, Cloud Notification Service returns the 200 HTTP code.
A successful response contains additional data in XML or JSON format depending on the specified ResponseFormat parameter.
Data schema:
XML
JSON
<?xml version="1.0" encoding="UTF-8"?>
<SetPlatformApplicationAttributes>
<ResponseMetadata>
<RequestId>string</RequestId>
</ResponseMetadata>
</SetPlatformApplicationAttributes>
{
"ResponseMetadata": {
"RequestId": "string"
}
}
Where RequestId is the request ID.
Error response
In case of an error, Cloud Notification Service returns a message with the appropriate HTTP code.
For a list of common error codes for all actions, see Errors.