For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Open sourceSupportFAQsDocs Home
DocumentationAPI referenceRelease notes
DocumentationAPI referenceRelease notes
  • Introduction
    • Overview
    • Authentication
  • Guides
    • Operations Manager search APIs
    • Search API
    • URL query parameters
    • Use query parameters in API requests
  • Reference
        • GETGet banner
        • PUTUpdate the banner
LogoLogo
Open sourceSupportFAQsDocs Home
ReferenceCustomization

Update the banner

PUT
http://localhost:3000/customization/banner
PUT
/customization/banner
$curl -X PUT http://localhost:3000/customization/banner \
>     -H "Content-Type: application/json" \
>     -u "<username>:<password>" \
>     -d '{
>  "active": true,
>  "text": "string",
>  "dismissible": true,
>  "startTime": "2018-08-02T15:56:12.912Z",
>  "allPages": true
>}'
1{
2  "status": "OK",
3  "message": "A sample success message"
4}
Updates the banner.
Was this page helpful?
Previous

Get device count history

Next
Built with

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Request

updates
activebooleanRequired
A flag indicating if the banner will be displayed to users
textstringRequired
Text in the banner when displayed
dismissiblebooleanRequired
A flag indicating if a banner should be dismissible by users
startTimestringRequiredformat: "^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{3}Z$"
An ISO Timestring value indicating when the banner will show
allPagesbooleanRequired
A flag indicating if the banner should show on all pages or only the IAP home page
_idstringOptionalformat: "^[0-9a-f]{24}$"
String representation of a MongoDB ObjectId
backgroundColorstringOptional
The background color for the banner displayed
endTimestringOptionalformat: "^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{3}Z$"
A, ISO Timestring value indicating when the banner will no longer show
imagestringOptional
A base64 image string containing the image that will be shown on the banner
messageLastUpdatedstringOptionalformat: "^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{3}Z$"
An ISO Timestring value indicating when the banner message was last updated

Response

The result from the database
statusenum
The status of the API request.
Allowed values:
messagestring
Message containing either confirmation of the operation or the reason for the failure of the operation.

Errors

500
Internal Server Error