Connections Health API

openapi: 3.2.0
info:
  title: Connections Icu Health API
  version: '1.0'
  description: 'Operations tagged Health across 6 of this provider''s published API definitions: connections-icu-analytics-openapi-original.json, connections-icu-events-openapi-original.json, connections-icu-studio-openapi-original.json, connections-icu-analytics-openapi.yml, connections-icu-events-openapi.yml, connections-icu-studio-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://analytics.connectionsapi.com
- url: https://events.connectionsapi.com
- url: https://studio.connectionsapi.com
tags:
- name: Health
paths:
  /health:
    get:
      summary: Health check
      description: Liveness probe.
      responses:
        '200':
          description: ok
      tags:
      - Health
      operationId: getHealth
      x-operation-id-source: derived
    servers:
    - url: https://analytics.connectionsapi.com
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: 'A Studio-minted cnx_live_ key carrying analytics:read (analytics:write to provision sites). The SAME key is also accepted as Authorization: Bearer (see BearerAuth). Studio is the sole key issuer. The legacy per-plane argus_live_ key class was retired 2026-06-21.'
    memberSession:
      type: http
      scheme: bearer
      description: The member's Connections session access token, exactly as this product's app sends it. Only operations that declare this scheme accept one.
      x-connections-credential: member-session
    cnxKey:
      type: http
      scheme: bearer
      description: A cnx_live_ key minted in Studio. It acts as the member who minted it, within its scopes.
      x-connections-credential: connections-key
    BearerAuth:
      type: http
      scheme: bearer
      description: A cnx_live_ key carrying analytics:read, sent as a bearer token.
    aegisBearer:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: The AEGIS SSO access token (Cognito JWT from the shared sign-in) presented as a Bearer on every /v1 call.
    apiKey:
      type: http
      scheme: bearer
      bearerFormat: cnx_live_* | cnx_pub_*
      description: 'A key minted in the console, sent as a bearer token. `cnx_live_` carries cross-plane data scopes AND (when granted) Studio management scopes (apps:*, keys:*, projects:*, webhooks:*) that authorize the console-management operations below. `cnx_pub_` is the publishable, browser-safe tier (Stripe''s pk_ model): mint-time capped to :read scopes, requires a non-empty allowed-origins allowlist, refused on any non-GET/HEAD route, and rate-limited - safe to embed in client-side code.'
    oauthUserToken:
      type: http
      scheme: bearer
      description: EITHER (a) a Sign-in-with-Connections USER access token issued by accounts.connectionsapi.com to a registered OAuth app - the app acts on behalf of its signed-in user, rows are keyed by the token's own sub + client_id; OR (b) an app-bound publishable key (cnx_pub_, minted with an appId) presented on X-Connections-Api-Key ALONGSIDE the signed-in user's own plain AEGIS bearer on Authorization - the server derives (app_id, sub) from the two verified credentials. The publishable key alone authorizes nothing; both credentials are required. This second form is for a developer who wants the locker without standing up a full OAuth client - mint one publishable key bound to a registered app instead.
x-refined-from:
- connections-icu-analytics-openapi-original.json
- connections-icu-events-openapi-original.json
- connections-icu-studio-openapi-original.json
- connections-icu-analytics-openapi.yml
- connections-icu-events-openapi.yml
- connections-icu-studio-openapi.yml