Skip to content
KataraKatara documentation

getNotificationPushConfiguration

GET
/katara/v1/notifications/push/configuration
curl --request GET \
  --url https://api.katara.com/katara/v1/notifications/push/configuration \
  --header 'Authorization: Bearer <token>'

Human-session Web Push device lifecycle. Exact account, organization, environment, mode and reset are checked; mutation also requires recent local sign-in. Browser endpoint, auth secret and P-256 key are transient registration intake only and never returned by metadata APIs. The reviewed public VAPID key, enrolled provider and explicit maximum-30-day deadline are immutable. At most eight unexpired devices per account/environment. Preserve exact UUID key and metadata after unknown results; inspect its operation receipt before an explicit retry. A receipt is historical, not current usability. Push category preferences are separate opt-in; Test delivery is intercepted. No external provider or browser installation acceptance is implied.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Safe current metadata or immutable historical operation metadata.

Media typeapplication/json
object
application_server_key
required
string
/^B[A-Za-z0-9_-]{86}$/
providers
required
Array<object>
>= 1 items <= 16 items
object
id
required
string
/^[A-Za-z0-9_-]{1,64}$/
origin
required
string format: uri
<= 2048 characters /^https:///
path_prefix
required
string
<= 128 characters /^/[A-Za-z0-9/_-]+/$/
maximum_devices
required
Allowed value: 8
maximum_authorization_seconds
required
Allowed value: 2592000
Example
{
  "maximum_devices": 8,
  "maximum_authorization_seconds": 2592000
}

Headers

Section titled “Headers”
Cache-Control
string
Allowed value: no-store

default

Section titled “default”

Request refused or service unavailable

Media typeapplication/json
object
error
required
object
message
required
string
>= 1 characters <= 500 characters
type
required
string
>= 1 characters <= 100 characters
code
required

Stable; branch on it. Any operation can answer invalid_request, with param naming the refused field when there is one; human_session_required, when an API key, service account or workload calls an operation only a signed-in person may perform; reauthentication_required, when a person’s sign-in is too old for the operation; permission_denied; route_not_found and method_not_allowed, when no operation matches the path or method; and feature_unavailable, when the operation’s service is not enabled on this deployment.

string
>= 1 characters <= 100 characters
param
required

The request field a refusal is about, such as the agent_id or run_id query parameter; null when the refusal is not about one field.

string | null
request_id
required
string
>= 1 characters <= 100 characters
upstream_status
required
integer | null
action
Allowed values: sign_in reauthenticate request_access review fund retry reconcile refresh support
operation_id
string format: uuid
/^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/
Allowed value: 00000000-0000-0000-0000-000000000000
snapshot_ref
string format: uuid
/^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/
Allowed value: 00000000-0000-0000-0000-000000000000
Example
{
  "error": {
    "action": "sign_in"
  }
}