FLABBY
MENU
OPEN SOURCE

Signal Cloud API Getting Started

Use the Signal Cloud API reference as the source of truth for the operations and schemas published on this site. The current document is OpenAPI 3.1 and describes version 1.0.0 of the Console-facing API contract.

Browse the contract

  1. Open the API reference and select the Signal Cloud specification.
  2. Use its operation list to find the Events, Analytics, Server Status, Detection, Notifications, or Maintenance endpoint you need.
  3. Read the operation's parameters, request schema, responses, and permission note before integrating with it.
  4. Use the raw YAML link when you need the machine-readable document.

The OpenAPI server URL contains a configurable cloudHost variable with an example default. It is not a promise that this example host is a live service address. Use the host supplied for your deployment.

First read-only request

For a first event query, open GET /v1/events in the reference and confirm its security and response details. In the default explorer view, supply both occurred_from (inclusive) and occurred_to (exclusive) as date-time values. Use the deployment's host and an authorized signal_session cookie in an approved client; this guide does not explain how to obtain the session.

The documented success response is 200 with an events array and a page object containing snapshot_at and next_cursor. The array may be empty when the selected time range has no matching events. To use the live polling projection instead, set view=live and follow that operation's limit and cursor schema rather than supplying the explorer range.

Troubleshooting a documented request

  • If the explorer request returns 400, check that both range endpoints are present and that filters match the operation schema.
  • If the operation returns 403, check its listed permission and community scope, then ask the deployment's access administrator if access is missing.
  • If a request returns a documented 500, keep its request_id with the support request. Do not retry a write just because a response was lost; inspect that operation's idempotency rules first.

Know the boundary

This document covers Console-facing API operations. It does not describe event ingestion, adapter recovery, health, identity, administration, or operator operations. It also does not provide a product account setup or onboarding flow. Do not infer those workflows from this reference.

For endpoint-level details, continue to the API reference. This site does not publish a Signal Cloud account or access-provisioning workflow; use the support channel provided for your deployment when you need product access.

Source