Update a deployment forwarding destination

put

https://staging.ankatech.co/api/v3/admin/platform/event-forwarding/destinations/{id}

Replaces the destination wholesale. 🔴 An OMITTED transport.trustAnchorsPem REMOVES the anchor, like any other omitted member of a replaced record — the read returns the canonical PEM, so an edit form opens populated and omitting the field is a deliberate un-pinning rather than an accident. That transition widens what the forwarder will trust, so it is recorded under its own audit action rather than being left to be inferred from a diff. A submitted anchor is bounded, CA-checked and canonically re-encoded before anything is written. Required scope: admin.platform.event-forwarding.manage.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

uuid

required

Body Params

name

string

required

length between 0 and 64

^[A-Za-z0-9][A-Za-z0-9 ._-]{0,63}$

Unique destination display label within its plane.

formatter

string

enum

required

Wire encoding the event is rendered into.

Allowed:

sinkType

string

enum

required

Transport/sink driver.

Allowed:

transport

required

Non-secret per-sink transport parameters; the concrete shape is selected by the sibling sinkType discriminator (SPLUNK_HEC/SENTINEL/WEBHOOK/SYSLOG) via EventForwardingDestinationRequestDeserializer.

minSeverity

string

length between 0 and 16

Minimum severity floor a source event must meet.

eventTypeWhitelist

array of strings

Event types to forward exclusively (empty = all).

eventTypeWhitelist

eventTypeBlacklist

array of strings

Event types to drop (empty = drop none).

eventTypeBlacklist

keyIdWhitelist

array of strings

Key ids to forward events for exclusively (empty = all).

keyIdWhitelist

enabled

boolean

Whether this destination is active.

secret

string

Sink credential (write-only). Omit on update to keep unchanged; the mask sentinel is rejected.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

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

application/json

application/problem+json

200The destination after the replace, with the sink credential masked and each pinned trust anchor described.

401Missing or invalid JWT.

403Missing the admin.platform.event-forwarding.manage scope, or the caller is not the platform (ROOT) tenant. The refusal is identical either way and the trust material is not decoded at all.

404No such deployment destination. Identical to the refusal for one that exists on another plane, so a caller cannot enumerate.

409A deployment destination of that name exists.