Update an ingest route

patch

https://{customerid}.observeinc.com/v1/ingest/routes/{type}/{id}

Beta — schema may still change; breaking changes are coordinated with affected customers. Suitable for evaluation, not production reliance.

Update an ingest route configuration. The destination ID must be the ID of
a source dataset whose type matches the type path parameter.

Use PATCH /v1/ingest/routes/{type} to change priority order. This
endpoint does not change priority.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

type

string

enum

required

The type of the ingest route to query. These types correspond to the various source dataset schemas supported by Observe.
any refers to the "default" generic source dataset schema with the FIELDS and EXTRA columns. All of the others
correspond to direct-write source datasets. Each type is also associated with particular ingest HTTP endpoints that emit
compatible data for that type. Incoming data on a given endpoint is routable to any dataset of the corresponding type.

The following [type -> ingest path] mappings are defined:

otellogs <-> /v1/otel/v1/logs
otelmetrics <-> /v1/otel/v1/metrics
oteltraces <-> /v1/otel/v1/traces
prometheus <-> /v1/prometheus
k8sentity <-> /v1/kubernetes
any <-> /v1/*

Allowed:

string

required

The id of the ingest route

Body Params

Merge-patch payload (RFC 7396). Only fields explicitly present are updated; omitted fields keep their current value. Priority is not settable here — use PATCH /v1/ingest/routes/{type} to reorder.

secondaryDestinationId accepts an explicit null to clear it.

pipeline

string

Replacement OPAL match predicate, subject to the same compilation and per-type restrictions as on create.

layout

object

Opaque JSON blob round-tripped to the frontend; not interpreted by the server. Ignored for a type's default route.

destinationId

string

Replacement primary destination dataset ID. Must be a source dataset whose type matches the route's type.

secondaryDestinationId

string | null

Replacement secondary destination dataset ID, subject to the same type check. Pass null to remove the secondary destination.

enabled

boolean

Set true to start evaluating this route against incoming data. New routes are created disabled, so this is the call that puts a route into service.

Responses

Language

Credentials

Bearer

Authorization: Bearer <customerid> <apitoken>

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Ingest route updated successfully

400Bad request

401Unauthorized

403Forbidden

404Resource not found

429Rate limit reached

5XXInternal server error