Skip to content
Console
Menu

Alerts and status pages

App store purchases

Credits

Knowledge

KV

Notifications

Organizations

Storage

Workflows

API reference

Getting Started

Authentication

KV Store

Sign vapid assertion on a connection

Signs an RFC 8292 assertion using a committed same-org Web Push Connection.

Signs an RFC 8292 assertion using a committed same-org Web Push Connection. The stored contact supplies the subject; an ordinary caller must hold broker:exchange on this exact Connection and satisfy its TrustPolicy.

  • Path POST https://api.sylphx.com/v1/orgs/acme/connections/connection:signVapidAssertion
  • Scope broker:exchange
  • Effect read — nothing is written.
  • Collection connections

#Request

FieldTypeWhat it is
namestringExact same-org Web Push Connection. Required.
audiencestringHTTPS origin only, without explicit path, userinfo, query or fragment. Required.
ttldurationPositive whole seconds; default 43200s, maximum 86400s and policy ceiling.

#Response

FieldTypeWhat it is
authorizationstringComplete RFC 8292 Authorization header, returned only on this call. Never returned again.
jwtstringCompact ES256 JWT, returned only on this call. Never returned again.
application_server_keybytesThe raw 65-byte uncompressed P-256 public point. ProtoJSON uses padded standard base64; decode it to bytes before passing it to PushManager.
expire_timetimestampWhen the push service stops honoring this assertion.

#Errors

  • UNAUTHENTICATED — No valid key or token was presented.
  • PERMISSION_DENIED — The key lacks the method's permission.
  • RESOURCE_NOT_FOUND — The named Resource does not exist or is not visible.
  • INVALID_FIELD — A field failed validation.
  • INVALID_STATE — The Resource is in a state that forbids the call.
  • UNKNOWN_FIELD — The request has a field the schema does not know.
  • ETAG_MISMATCH — The etag sent does not match the Resource's current etag.
  • UNAVAILABLE — The Resource store, the owning service's backend, or the key verifier's snapshot is unavailable; retry after Retry-After.
  • RATE_LIMITED — The rate limit is reached; see Retry-After.

Every error arrives in the body Errors describes.

#Examples

curl -X POST "https://api.sylphx.com/v1/orgs/acme/connections/connection:signVapidAssertion" \
  -H "Authorization: Bearer $SYLPHX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"audience":"…"}'