Cloud observation

Start or replay guided cloud setup

Requires an API key owned by a user who is currently a team administrator. Keys without a user owner do not inherit administrator access. The console uses the same service with its authenticated session. Creates setup intent only. Requires configured guided deployment settings for the selected provider. Same normalized settings and key return the same session without extending expiry. Changed settings or more than five active sessions return 409 cloud_onboarding_conflict. Missing deployment settings return 503 cloud_setup_unavailable. No observation connection is created until verification succeeds.

post/v1/cloud-onboarding-sessions

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    HTTP bearer

Headers

Idempotency-Keystring required

Stable key for this setup, at most 200 UTF-8 bytes with no control characters. Reuse after an uncertain response.

Request body

provider'aws' | 'gcp' required
namestring

Optional name, trimmed on submission. Empty or omitted values become AWS or Google Cloud for the selected provider. At most 100 UTF-8 bytes.

regionsstring[] nullable

Commercial AWS regions only. GovCloud and China partitions are not supported by this connection flow. Omitted, null, or empty discovers all enabled account regions. A nonempty list restricts collection. Region order does not affect idempotency. GCP requires an empty list.

project_idstring

Google Cloud project ID. Required for GCP and omitted for AWS.

billing_location'US' | 'EU'

Location of the dedicated Google Cloud billing dataset. Defaults to US for GCP and is omitted for AWS.

Response

Start or replay guided cloud setup

Changes

No recorded changes to this operation across all 70 revisions of this API.