POST /command/config/set-disclaimer

On this page:

Change the disclaimer text that is on the PE console login page.

Request format

This endpoint requires authentication, and the requesting user must have the configuration:edit_disclaimer permission.

When Forming RBAC API requests to this endpoint, the content type is application/json. The body must be a JSON object containing the disclaimer key, which accepts string-formatted disclaimer text. For example:

curl -X POST "https://$(puppet config print server):4433/rbac-api/v1/command/config/set-disclaimer" \
-H 'Content-Type: application/json' \
-H "X-Authentication: $(puppet access show)" \
-d '{ "disclaimer": "Unauthorized access prohibited." }' \

To remove the disclaimer text, use POST /command/config/remove-disclaimer. Setting disclaimer to an empty string or whitespace-only string causes the Disclaimer banner to be present, but empty, on the console login page.

Response format

A successful request returns 204 No Content.

Error responses

Returns 403 Not Permitted if you don't have the configuration:edit_disclaimer permission.

Returns 400 Bad Request if the disclaimer value is not a string.

For other errors, refer to RBAC service errors .