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

Get banner

GET
http://localhost:3000/customization/banner
GET
/customization/banner
$curl http://localhost:3000/customization/banner \
>     -u "<username>:<password>"
1{
2  "result": {
3    "active": true,
4    "text": "string",
5    "dismissible": true,
6    "startTime": "2018-08-02T15:56:12.912Z",
7    "allPages": true,
8    "_id": "5cb7b531d06cceb89fd21b1c",
9    "backgroundColor": "#fff",
10    "endTime": "2018-08-02T15:56:12.912Z",
11    "image": "string",
12    "messageLastUpdated": "2018-08-02T15:56:12.912Z"
13  }
14}
Returns banner for customization.
Was this page helpful?
Previous

Update the banner

Next
Built with

Authentication

AuthorizationBasic

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

Response

The banner object from the database
resultobject
The root schema comprises the entire JSON document.

Errors

500
Internal Server Error