Agents Setup

Analyzes local capture, historian, or export metadata to prepare agent mappings; it does not read a customer system directly. An API key is required. It consumes no run or quota, has no billing/email side effect, and returns local setup guidance.

post/api/agents/setup

Request

  • Base URL: https://opwhcervi3.execute-api.ca-central-1.amazonaws.com
  • URL: https://opwhcervi3.execute-api.ca-central-1.amazonaws.com/api/agents/setup
  • Auth: API key in header X-Api-Key

Headers

X-Api-Keystring nullable

Request body

target_agentsstring[] nullable

Response

Successful Response

configobject nullable
health'healthy' | 'partial' | 'not-ready' required
mappingobject required
namespace_recommendationsobject[]
next_stepsstring[]
problemsstring[]
target_agentsstring[] required

Changes

No recorded changes to this operation across all 1 revision of this API.