Skip to main content
Version: 8.4 / 3.12.0

Disable sharing

This API allows users to disable the sharing functionality for all reports and dashboards in Optimize. Note that this setting will be permanently persisted in memory and will take precedence over any other previous configurations (e.g. configuration files).

When sharing is disabled, previously shared URLs will no longer be accessible. Upon re-enabling sharing, the previously shared URLs will work once again under the same address as before. Calling this endpoint when sharing is already disabled will have no effect.

Method & HTTP target resource

POST api/public/share/disable

Request headers

The following request headers must be provided with every request:

HeaderConstraintsValue
AuthenticationREQUIREDSee authentication

Query parameters

No query parameters necessary.

Request body

An empty request body should be sent.

Response codes

Possible HTTP Response Status codes:

CodeDescription
204Request successful.
401Secret incorrect or missing in HTTP Header. See authentication on how to authenticate.
500Some error occurred while processing the request, best check the Optimize log.

Example

Disable sharing

POST api/public/share/disable

Request header

Authorization: Bearer mySecret

Response

Status 204 (Successful)

Response content

no content