Create or update a reporter

Idempotent create-or-update. Uses the key field in the body to identify the reporter within the domain. On first apply the reporter is created; subsequent applies update it. The system flag is immutable; changing it requires deleting and recreating the reporter.

orgIdstring required

Identifier of the organization that owns the environment.

envIdstring required

Identifier of the environment the domain belongs to.

domainKeystring required

Key of the domain: its stable, immutable Automation identifier within the environment.

Request body

configurationstring

Plugin-specific configuration as a JSON-encoded string. Its shape is defined by the selected reporter type.

createdAtstring date-time

Creation timestamp (ISO-8601 / RFC 3339, UTC). Read-only.

dataTypestring

Category of data the reporter handles, derived from its type. Read-only.

enabledboolean

Whether the reporter is enabled.

keystring required

Stable, immutable identifier for the reporter within its domain. Lowercase alphanumeric and hyphens, starting and ending with an alphanumeric character. Used to identify the reporter on create-or-update.

namestring

Human-readable name of the reporter.

systemboolean

Whether this is the domain's system reporter. Immutable after creation. When true, only key is required; the reporter is built from the domains.reporters.default.* and repository system settings and the name, type, and configuration fields are ignored.

typestring

Reporter plugin type identifier. Immutable after creation.

updatedAtstring date-time

Last-update timestamp (ISO-8601 / RFC 3339, UTC). Read-only.

Example request

{
  "configuration": "{\"bootstrapServers\":\"kafka:9092\",\"topic\":\"audit\"}",
  "key": "audit-kafka",
  "name": "Audit events to Kafka",
  "type": "reporter-am-kafka"
}

Response

The created or updated reporter