eventDestinations operations
MCP tools and operation permissions for eventDestinations.
Generated from the shared operation catalog. Use the JSON catalog for complete input schemas. Required dependency checks can be stricter than the resource permission listed below.
events_destination_list
List event storage destinations in the current workspace, including Docker on a saved server, Oblien cloud and custom services. Returns state, version and public ingestion URLs without stored secrets.
- HTTP:
GET /api/events/destinations - SDK:
client.eventDestinations.list(input) - Access: workspace; settings / read
- Effect annotation: Read-only
See the JSON schema for this input contract.
events_destination_read
Read an event destination identity, deployment kind, linked server or cloud connection, state, version and public ingestion URL. Does not return private configuration or stored secrets.
- HTTP:
GET /api/events/destinations/:id - SDK:
client.eventDestinations.get(input) - Access: workspace; settings / read
- Effect annotation: Read-only
| Input | Requirement | Description |
|---|---|---|
id | Required | string |
events_destination_create
Configure an event destination using an existing saved server for Docker, a cloud connection for Oblien, or a compatible custom service. Creating a draft does not provision workloads. Secrets are write-only and sealed; use existing saved connections and never invent credentials. Requires workspace settings write permission.
- HTTP:
POST /api/events/destinations - SDK:
client.eventDestinations.create(input) - Access: workspace; settings / write
- Effect annotation: May change state or run effects
| Input | Requirement | Description |
|---|---|---|
name | Required | string |
kind | Required | See schema |
serverId | Optional | See schema |
cloudConnectionId | Optional | See schema |
ingestUrl | Optional | See schema |
config | Optional | object |
secrets | Optional | object |
events_destination_update
Rename an event destination without interrupting its workload, or update an unused destination ingestion URL, operator configuration or write-only credentials using its current version. Connection changes return it to draft; destinations with linked datasets cannot be reconfigured. Requires workspace settings write permission.
- HTTP:
PATCH /api/events/destinations/:id - SDK:
client.eventDestinations.update(input) - Access: workspace; settings / write
- Effect annotation: May change state or run effects
| Input | Requirement | Description |
|---|---|---|
id | Required | string |
version | Required | integer |
name | Optional | string |
ingestUrl | Optional | See schema |
config | Optional | object |
secrets | Optional | object |
events_destination_provision
Provision the configured event service, queue and ClickHouse workloads for a Docker or Oblien destination, or verify a custom destination. Use the current version and an existing configured destination. Requires workspace settings write permission; infrastructure may be created.
- HTTP:
POST /api/events/destinations/:id/provision - SDK:
client.eventDestinations.provision(input) - Access: workspace; settings / write
- Effect annotation: May change state or run effects
| Input | Requirement | Description |
|---|---|---|
id | Required | string |
version | Required | integer |
events_destination_status_read
Refresh an event destination workload status and connection health. Returns the latest readiness, version, checked time and error code without stored secrets; does not start or provision workloads.
- HTTP:
POST /api/events/destinations/:id/status - SDK:
client.eventDestinations.status(input) - Access: workspace; settings / read
- Effect annotation: Read-only
| Input | Requirement | Description |
|---|---|---|
id | Required | string |
events_destination_start
Start an existing event destination workload using its current version and verify ingestion and query connectivity. Requires workspace settings write permission.
- HTTP:
POST /api/events/destinations/:id/start - SDK:
client.eventDestinations.start(input) - Access: workspace; settings / write
- Effect annotation: May change state or run effects
| Input | Requirement | Description |
|---|---|---|
id | Required | string |
version | Required | integer |
events_destination_stop
Stop an event destination workload using its current version. Datasets linked to it cannot ingest or query until it is started again. Requires workspace settings write permission.
- HTTP:
POST /api/events/destinations/:id/stop - SDK:
client.eventDestinations.stop(input) - Access: workspace; settings / write
- Effect annotation: May change state or run effects
| Input | Requirement | Description |
|---|---|---|
id | Required | string |
version | Required | integer |
events_destination_delete
Delete an unused event destination and remove its managed Docker or Oblien workloads. Linked datasets must be removed or moved first. Requires the current version and workspace settings administration permission; removes managed infrastructure and stored destination credentials.
- HTTP:
DELETE /api/events/destinations/:id - SDK:
client.eventDestinations.remove(input) - Access: workspace; settings / admin
- Effect annotation: May change state or run effects; destructive operation
| Input | Requirement | Description |
|---|---|---|
id | Required | string |
version | Required | integer |