Skip to content
KataraKatara documentation

listEventSources

GET
/katara/v1/orgs/{org_id}/environments/{environment_id}/event-sources
curl --request GET \
  --url 'https://api.katara.com/katara/v1/orgs/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/environments/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/event-sources?limit=25&include_retired=false' \
  --header 'Authorization: Bearer <token>'

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

Query Parameters

Section titled “Query Parameters”
after
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
limit
integer
default: 25 >= 1 <= 50
include_retired
boolean

Responses

Section titled “Responses”

200

Section titled “200”

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

Media typeapplication/json
object
items
required
Array<object>
<= 50 items
object
source_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
name
required
string
>= 1 characters <= 120 characters
reference
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}$/
activation
required
Any of:
object
generation
required
integer
>= 1 <= 9007199254740991
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}$/
enabled
required
boolean
changed_by
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
changed_at
required
string format: date-time
/^\d{4}-\d\d-\d\dT\d\d:\d\d:\d\d(?:\.\d{0,8}[1-9])?Z$/
Allowed value: 0001-01-01T00:00:00Z
retired_at
required
Any of:
string format: date-time
/^\d{4}-\d\d-\d\dT\d\d:\d\d:\d\d(?:\.\d{0,8}[1-9])?Z$/
Allowed value: 0001-01-01T00:00:00Z
next_cursor
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
execution_ready
required
boolean
Examplegenerated
{
  "items": [
    {
      "source_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "name": "example",
      "reference": {
        "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "version": 1,
        "integrity": "example"
      },
      "activation": {
        "generation": 1,
        "version": {
          "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
          "version": 1,
          "integrity": "example"
        },
        "enabled": true,
        "changed_by": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "changed_at": "2026-04-15T12:00:00Z"
      },
      "retired_at": "2026-04-15T12:00:00Z"
    }
  ],
  "next_cursor": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "execution_ready": true
}

Headers

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

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"
  }
}