Get App Notification Config

1min

GET
https://{base_url}/core/api/v1/notification-service/apps/{appId}/notification
This endpoint retrieves App Notification configuration by app ID.
PathDescriptionType
appId *Unique Internal App Id generated by notification service.string
*This is required.
HTTP Status Code Summary
CodeDescription
200 - OKEverything worked as expected.
400 - Bad RequestThe request was unacceptable, often due to missing a required parameter.
401 - UnauthorizedNo valid API key provided.
403 - ForbiddenThe API key doesn't have permissions to perform the request.
404 - Not FoundThe requested resource doesn't exist.
Path Parameters
appId
AppId
*
Header Parameters
X-COREOS-REQUEST-ID
string
*
X-COREOS-TID
string
*
X-COREOS-ACCESS
string
*
X-COREOS-USERINFO
string
Responses
200
OK
AppNotificationConfigGetResponse
All Of
SuccessResponse  +
error
Error
request
Request
*
data
object
All Of
object  +
400
Bad request - The server is unable to process the request due to something that is perceived to be a client error.
ErrorResponse
error
Error
*
request
Request
*
401
Unauthorized -  The client's identity is unknown to the server. Verify that you are accessing the correct tenant and that your client ID and client secret are valid on that tenant.
ErrorResponse
error
Error
*
request
Request
*
403
Forbidden - The client's identity is known to the server, but it does not have access rights to the requested resource. Verify that you're using the correct client ID and client secret or grant the client the necessary roles to access the resource.
ErrorResponse
error
Error
*
request
Request
*
404
Not found - The server can not find the requested resource.
ErrorResponse
error
Error
*
request
Request
*
Curl
JS
Ruby
Python
curl --location --globoff 'https://{base_url}/core/api/v1/notification-service/apps/{appId}/notification' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
curl --location --globoff 'https://{base_url}/core/api/v1/notification-service/apps/{appId}/notification' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
Responses
200
400
401
403
404
// OK 
{
  "error": {
    "code": "",
    "description": "",
    "additionalInfo": {}
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  },
  "data": {}
}
// OK 
{
  "error": {
    "code": "",
    "description": "",
    "additionalInfo": {}
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  },
  "data": {}
}
﻿
﻿

Path	Description	Type
`appId` *	Unique Internal App Id generated by notification service.	string
*This is required.

Code	Description
200 - OK	Everything worked as expected.
400 - Bad Request	The request was unacceptable, often due to missing a required parameter.
401 - Unauthorized	No valid API key provided.
403 - Forbidden	The API key doesn't have permissions to perform the request.
404 - Not Found	The requested resource doesn't exist.

Updated 23 Apr 2024

Did this page help you?

Add app notification configuration

Update App Notification Config