iam.audit-destinations.updateRename, pause, resume, change the filter, or replay from the start or skip to now
Request syntax
PATCH /iam/api/audit-destinations/{id}
{
"name": "string",
"enabled": "boolean",
"filterActions": "array of string",
"filterOutcome": "enum",
"resumeFrom": "enum"
}Path parameters
idRequiredstring
Constraints: uuid
Request body
nameOptionalstring
A new name, unique in the organization
Constraints: 1-64 chars, /^[A-Za-z0-9 ._-]+$/
enabledOptionalboolean
false pauses delivery; true resumes it where it stopped
filterActionsOptionalarray of string
Replaces the action patterns, e.g. iam:*; an empty list sends every action
Constraints: /^[a-z0-9*-]+:[A-Za-z0-9*]+$/
filterOutcomeOptionalenum
Send only entries with this outcome: success (Succeeded), error (Failed) or failure (Denied); null sends every outcome
One of:
success,error,failureMay be null.
resumeFromOptionalenum
now skips every entry not yet delivered; start replays every entry still stored; omitted: delivery carries on where it stands
One of:
now,start
Response
200 with the updated destination, as get describes it.
A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.
Errors
- 400The request does not pass the schema above. The body is { "error": …, "issues": […] }, one issue per field.
- 401No credentials, or an access key that is unknown, revoked or expired.
- 403The caller's policies do not allow iam:UpdateAuditDestination on this resource. The body names the action and the resource, and the refusal is recorded in the audit log.
- 404The resource does not exist in your organization.
Examples
The required parameters only, with example values. Replace id and the other placeholders with your own.
dcloud iam audit-destinations update idcurl -X PATCH "https://console.platform-development.deutschecloud.app/iam/api/audit-destinations/id" \
-H "Authorization: EWS-ACCESS-KEY $ACCESS_KEY" \
-H "Content-Type: application/json" \
-d '{}'Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_iam_audit-destinations_update.