Disable Sharing
Purpose
This API allows users to disable the sharing functionality for all reports and dashboards in Optimize. Please 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 have to be provided with every request:
| Header | Constraints | Value |
|---|---|---|
| Authorization | REQUIRED | See Authorization. |
Query Parameters
No query parameters necessary.
Request Body
An empty request body should be sent.
Response Codes
Possible HTTP Response Status codes:
| Code | Description |
|---|---|
| 204 | Request successful. |
| 401 | Secret incorrect or missing in HTTP Header. See Authorization for more information. |
| 500 | Some 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