Skip to content
KataraKatara documentation

setEventSourceEnabled

POST
/katara/v1/orgs/{org_id}/environments/{environment_id}/event-sources/activation
curl --request POST \
  --url https://api.katara.com/katara/v1/orgs/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/environments/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/event-sources/activation \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: example' \
  --header 'X-Katara-CSRF: 1' \
  --data '{ "version": { "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "version": 1, "integrity": "example" }, "expected_generation": 1, "expected_environment_epoch": 1, "expected_reset_generation": 1, "enabled": true }'

Requires current synapse:event_sources:write authority in the exact environment. Publication pins only a public Ed25519 signing key, event age and capacity bounds, input mode, and the complete run configuration. It neither activates nor starts a run. Activation and retirement require human sessions; enabling also requires an available event admission worker. Preserve exact request and key after an unknown mutation. No automatic retry. Fixed mode refuses event input overrides; event_reference requires an exact current approved JSON content reference, never a raw event body. Replies expose execution_ready; false refuses enabling. Test and Live authority, reset and funding remain separate. Signing private keys must stay with the external source. This metadata API does not expose event admission receipts.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
org_id
required
string format: uuid
/^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/
Allowed value: 00000000-0000-0000-0000-000000000000
environment_id
required
string format: uuid
/^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/
Allowed value: 00000000-0000-0000-0000-000000000000

Header Parameters

Section titled “Header Parameters”
Idempotency-Key
required
string
/^[A-Za-z0-9._:-]{8,128}$/
X-Katara-CSRF
Allowed value: 1

Browser cookie mutations require value 1 and an allowed Origin. Session bearer clients may omit this header.

X-Katara-Account-ID
string format: uuid
/^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/

Required for cookie-authenticated changes. Use the UUID of the account that loaded the application. A different current cookie account returns account_changed before the handler runs. Session bearer and API key clients do not require this header.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
version
required
object
id
required
string format: uuid
/^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/
Allowed value: 00000000-0000-0000-0000-000000000000
version
required
integer
>= 1 <= 9223372036854776000
integrity
required
string
/^sha256:[a-f0-9]{64}$/
expected_generation
required
integer
<= 9007199254740990
expected_environment_epoch
required
integer
>= 1 <= 9007199254740991
expected_reset_generation
required
integer
>= 1 <= 9007199254740991
enabled
required
boolean
Examplegenerated
{
  "version": {
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "version": 1,
    "integrity": "example"
  },
  "expected_generation": 1,
  "expected_environment_epoch": 1,
  "expected_reset_generation": 1,
  "enabled": true
}

Responses

Section titled “Responses”

200

Section titled “200”

Event-source metadata or completed immutable operation; no execution implied.

Media typeapplication/json
object
operation_id
required
string format: uuid
/^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/
Allowed value: 00000000-0000-0000-0000-000000000000
resource_id
required
string format: uuid
/^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/
Allowed value: 00000000-0000-0000-0000-000000000000
completed
required
boolean
Examplegenerated
{
  "operation_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "resource_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "completed": true
}

Headers

Section titled “Headers”
Cache-Control
string
Allowed value: no-store

503

Section titled “503”

Event_source_execution_unavailable: scheduler runtime is unavailable; no activation was performed.

default

Section titled “default”

Request error

Media typeapplication/json
object
error
required
object
message
required
string
>= 1 characters <= 500 characters
type
required
string
>= 1 characters <= 100 characters
code
required

Stable; branch on it. Any operation can answer invalid_request, with param naming the refused field when there is one; human_session_required, when an API key, service account or workload calls an operation only a signed-in person may perform; reauthentication_required, when a person’s sign-in is too old for the operation; permission_denied; route_not_found and method_not_allowed, when no operation matches the path or method; and feature_unavailable, when the operation’s service is not enabled on this deployment.

string
>= 1 characters <= 100 characters
param
required

The request field a refusal is about, such as the agent_id or run_id query parameter; null when the refusal is not about one field.

string | null
request_id
required
string
>= 1 characters <= 100 characters
upstream_status
required
integer | null
action
Allowed values: sign_in reauthenticate request_access review fund retry reconcile refresh support
operation_id
string format: uuid
/^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/
Allowed value: 00000000-0000-0000-0000-000000000000
snapshot_ref
string format: uuid
/^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/
Allowed value: 00000000-0000-0000-0000-000000000000
Example
{
  "error": {
    "action": "sign_in"
  }
}