240db4e2a7
Some checks failed
Server CI / Postgres (shard 0) (push) Has been skipped
Server CI / Postgres (shard 3) (push) Has been skipped
BuildEnv Docker Image / build-image (push) Failing after 4s
BuildEnv Docker Image / build-image-fips (push) Failing after 4s
Migration Review & Release Notes / Generate migration review & release notes (push) Failing after 3s
Server CI / Build Environment (push) Failing after 3s
Server CI / Postgres (shard 1) (push) Has been skipped
Tools CI / check-style (mattermost-govet) (push) Failing after 4s
Server CI / Postgres (shard 2) (push) Has been skipped
Tools CI / check-style (mmgotool) (push) Failing after 3s
Server CI / Elasticsearch v8 Compatibility (push) Has been skipped
Server CI / OpenSearch v2 Compatibility (push) Has been skipped
Server CI / Postgres FIPS (shard 0) (push) Has been skipped
Tools CI / Test (mattermost-govet) (push) Failing after 3s
Server CI / Postgres FIPS (shard 1) (push) Has been skipped
Server CI / Postgres FIPS (shard 2) (push) Has been skipped
Tools CI / Test (mmgotool) (push) Failing after 3s
Server CI / Postgres FIPS (shard 3) (push) Has been skipped
Server CI / Run mmctl tests (push) Has been skipped
Server CI / Run mmctl tests (FIPS) (push) Has been skipped
Server CI / Merge Postgres Test Results (push) Has been skipped
Server CI / Merge Postgres FIPS Test Results (push) Has been skipped
Server CI / Check backport migrations (push) Has been skipped
Server CI / Check generated files (push) Has been skipped
Server CI / check-style (push) Has been skipped
Server CI / Vet API (push) Has been skipped
Server CI / Build mattermost server app (push) Has been skipped
Server CI / Server CI Complete (push) Failing after 2s
Server CI / Server CI Artifacts (push) Has been skipped
Server CI / Sentry Upload (push) Has been skipped
Server CI / Server CI Report (push) Failing after 5m1s
Server CI Nightly Race / Race Detector (push) Has been skipped
CodeQL / Analyze (go) (push) Has been cancelled
CodeQL / Analyze (javascript) (push) Has been cancelled
Webapp CI Cache Warm / Warm Webapp node_modules Cache (push) Has been cancelled
E2E CI Cache Warm / Warm E2E npm Registry Cache (push) Has been cancelled
API / build (push) Has been cancelled
Web App CI / check-types (push) Has been cancelled
Web App CI / check-lint (push) Has been cancelled
Web App CI / check-i18n (push) Has been cancelled
Web App CI / check-external-links (push) Has been cancelled
Web App CI / test (platform) (push) Has been cancelled
Web App CI / test (mattermost-redux) (push) Has been cancelled
Web App CI / test (channels shard 1/4) (push) Has been cancelled
Web App CI / test (channels shard 2/4) (push) Has been cancelled
Web App CI / test (channels shard 3/4) (push) Has been cancelled
Web App CI / test (channels shard 4/4) (push) Has been cancelled
Web App CI / upload-coverage (push) Has been cancelled
Web App CI / build (push) Has been cancelled
YAML Lint / yamllint (push) Has been cancelled
Push mirrored docker images / cd/Push mirrored docker images (push) Has been cancelled
docs-cd / Build and deploy docs (push) Has been cancelled
Docs CI / build (push) Has been cancelled
E2E Cache Warm: Cypress deps / Warm Cypress deps cache (push) Has been cancelled
Scorecards supply-chain security / Scorecard analysis (push) Has been cancelled
Server CI Weekly / Postgres FIPS (push) Has been skipped
Server CI Weekly / Run mmctl tests (FIPS) (push) Has been skipped
Server CI Weekly / Postgres with binary parameters (push) Has been skipped
Server CI Weekly / Build Environment (push) Failing after 1s
Server CI Nightly Race / Build Environment (push) Failing after 1s
Server CI Cache Warm / Warm Go Module and Build Cache (push) Failing after 2s
68 lines
3.2 KiB
YAML
68 lines
3.2 KiB
YAML
/api/v4/delivery_tracking/config:
|
|
get:
|
|
summary: Get the post delivery audit logging configuration
|
|
description: |
|
|
Returns the post delivery audit logging configuration: whether the feature is enabled, whether it applies to
|
|
all channels, and the ids of the channels deliveries are recorded in.
|
|
|
|
Requires an Enterprise Advanced license and the `PostDeliveryTracking` feature flag. Only system admins can
|
|
access this endpoint.
|
|
tags:
|
|
- Delivery Tracking
|
|
operationId: GetDeliveryTrackingConfig
|
|
responses:
|
|
'200':
|
|
description: Configuration retrieved successfully
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/DeliveryTrackingConfig"
|
|
'403':
|
|
description: User does not have permission to manage system configuration.
|
|
'500':
|
|
description: Internal server error.
|
|
'404':
|
|
description: |
|
|
The endpoint is not registered because the `PostDeliveryTracking` feature flag was disabled at server start. Enabling the flag requires a server restart.
|
|
'501':
|
|
description: An Enterprise Advanced license is not available, or the `PostDeliveryTracking` feature flag was disabled after the server started.
|
|
put:
|
|
summary: Update the post delivery audit logging configuration
|
|
description: |
|
|
Updates the post delivery audit logging configuration.
|
|
|
|
`ChannelIds` fully replaces the stored list. Omit the field to leave the stored list unchanged; send an empty
|
|
array to clear it. An empty array is only accepted when the resulting configuration is still valid, which means
|
|
`EnableForAllChannels` must be true. Turning `Enable` off does not clear the list.
|
|
|
|
Direct and group message channels can never be recorded. The request is rejected in full if any submitted
|
|
channel is a DM or GM, or does not exist.
|
|
|
|
Requires an Enterprise Advanced license and the `PostDeliveryTracking` feature flag. Only system admins can
|
|
access this endpoint.
|
|
tags:
|
|
- Delivery Tracking
|
|
operationId: UpdateDeliveryTrackingConfig
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "#/components/schemas/DeliveryTrackingConfig"
|
|
responses:
|
|
'200':
|
|
description: Configuration updated successfully
|
|
'400':
|
|
description: |
|
|
Bad request. Returned when `EnableForAllChannels` is false and no channels are selected, when a channel id
|
|
is malformed, when a submitted channel does not exist, or when a submitted channel is a DM or GM.
|
|
'403':
|
|
description: User does not have permission to manage system configuration.
|
|
'500':
|
|
description: Internal server error.
|
|
'404':
|
|
description: |
|
|
The endpoint is not registered because the `PostDeliveryTracking` feature flag was disabled at server start. Enabling the flag requires a server restart.
|
|
'501':
|
|
description: An Enterprise Advanced license is not available, or the `PostDeliveryTracking` feature flag was disabled after the server started.
|