Setting the Custom Banners
Setting the Custom Banners
Set the values of custom banners.
Request
URI
PUT
https://{opsmanager-installation}/api/v0/settings/banner
COPY
Request Body
BannerSetting
of type(s)
application/json
Optional
{
"ui_banner_contents": "string",
"ssh_banner_contents": "string"
}
string
ui_banner_contents
Optional
This text will be shown in a banner in the Operations Manager web UI on every page. By default this is null which means that no banner will be shown.
string
ssh_banner_contents
Optional
This text will be shown as the SSH banner whenever a user connects to an OpsManager over SSH. By default this is null which means that no banner will be shown.
Responses
200
OK
Returns
EmptyResponse
of type(s)
application/json
Operation doesn't return any data structure
400
Setup is not completed
Returns
RequireSetupCompleted
of type(s)
application/json
{
"errors": {
"errors": [
"string"
]
}
}
401
Unauthorized
Returns
UnauthorizedResponse
of type(s)
application/json
{
"errors": {
"errors": [
"string"
]
}
}
403
Forbidden
Returns
ForbiddenResponse
of type(s)
application/json
{
"errors": {
"errors": [
"string"
]
}
}Code Samples
COPY
curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '}' https://{api_host}/api/v0/settings/banner