Search documentation
karat

+

K

User Documentation ↗
Version 2.0

Update Export Settings For Connection

POST/api/v2/connectivity/connections/{connectionRid}/updateExportSettings
Warning

This endpoint is in preview and may be modified or removed at any time. To use this endpoint, add preview=true to the request query parameters.

Updates the export settings on the Connection. Only users with Information Security Officer role can modify the export settings.

Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:connectivity-connection-write.

Path parameters

connectionRid
string

The Resource Identifier (RID) of a Connection (also known as a source).

Query parameters

preview
boolean
optional

Enables the use of preview functionality.

Request body

UpdateExportSettingsForConnectionRequest
object
Hide child attributes

Hide child attributes

exportSettings
object
Show child attributes

Show child attributes

Examples

Request

Copied!
1 2 3 4 5 curl -X POST \ \t-H "Content-type: application/json" \ \t-H "Authorization: Bearer $TOKEN" \ "https://$HOSTNAME/api/v2/connectivity/connections/ri.magritte..source.c078b71b-92f9-41b6-b0df-3760f411120b/updateExportSettings?preview=true" \ -d '{"exportSettings":{"exportsEnabled":true,"exportEnabledWithoutMarkingsValidation":false}}'

Error responses

Error Name
UpdateExportSettingsForConnectionPermissionDeniedError CodePERMISSION_DENIED
Status Code403
DescriptionCould not updateExportSettings the Connection.
ParametersconnectionRid