Enables a banner.

POST 
<your-unleash-url>/api/admin/banners/:id/on

Enables an existing banner, identified by its id.

Request

Path Parameters

id stringrequired

Responses

200

bannerSchema

application/json

Schema

Schema

idintegerrequired
The banner's ID. Banner IDs are incrementing integers. In other words, a more recently created banner will always have a higher ID than an older one.
Possible values: >= 1
Example: 7
messagestringrequired
The message to display to all users. Supports markdown.
Example: **Reminder to everyone**: Maintenance is scheduled for *2337-12-27*.
enabledboolean
Whether the banner should be displayed currently. If not specified, defaults to true.
Example: true
variantstring
The variant of the banner. One of "info", "warning", "error", or "success". If not specified, defaults to "info".
Example: info
stickyboolean
Whether the banner should be sticky on the screen. If not specified, defaults to false.
Example: true
iconstringnullable
The icon to display on the banner. Can be one of https://fonts.google.com/icons. If not specified, this will be the default icon for the variant. If "none", no icon will be displayed.
Example: build
linkstringnullable
The link to display on the banner. Can either be an absolute or a relative link (e.g. absolute: "https://example.com" or relative: "/admin/service-accounts"). If "dialog", will display a dialog when clicked. If not specified, no link will be displayed.
Example: dialog
linkTextstringnullable
The text to display on the link. If not specified, will be displayed as "More info".
Example: Learn more
dialogTitlestringnullable
The title to display on the dialog. If not specified, this will be the same as linkText.
Example: Learn more about it here
dialogstringnullable
The markdown to display on the dialog. If not specified, no dialog will be displayed.
Example: # Information Maintenance is **scheduled**. ## More details This is an example dialog that supports Markdown.
createdAtdate-timerequired
The date and time of when the banner was created.
Example: 2023-12-27T13:37:00+01:00

Example (auto)

{
  "id": 7,
  "message": "**Reminder to everyone**: Maintenance is scheduled for *2337-12-27*.",
  "enabled": true,
  "variant": "info",
  "sticky": true,
  "icon": "build",
  "link": "dialog",
  "linkText": "Learn more",
  "dialogTitle": "Learn more about it here",
  "dialog": "# Information\n\nMaintenance is **scheduled**.\n\n## More details\n\nThis is an example dialog that supports Markdown.",
  "createdAt": "2023-12-27T13:37:00+01:00"
}

401

Authorization information is missing or invalid. Provide a valid API token as the authorization header, e.g. authorization:*.*.my-admin-token.

application/json

Schema

Schema

idstring
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
namestring
The name of the error kind
Example: AuthenticationRequired
messagestring
A description of what went wrong.
Example: You must log in to use Unleash. Your request had no authorization header, so we could not authorize you. Try logging in at /auth/simple/login.

Example (auto)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "AuthenticationRequired",
  "message": "You must log in to use Unleash. Your request had no authorization header, so we could not authorize you. Try logging in at /auth/simple/login."
}

403

The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation

application/json

Schema

Schema

idstring
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
namestring
The name of the error kind
Example: NoAccessError
messagestring
A description of what went wrong.
Example: You need the "UPDATE_ADDON" permission to perform this action in the "development" environment.

Example (auto)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "NoAccessError",
  "message": "You need the \"UPDATE_ADDON\" permission to perform this action in the \"development\" environment."
}

404

The requested resource was not found.

application/json

Schema

Schema

idstring
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
namestring
The name of the error kind
Example: NotFoundError
messagestring
A description of what went wrong.
Example: Could not find the addon with ID "12345".

Example (auto)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "NotFoundError",
  "message": "Could not find the addon with ID \"12345\"."
}

Authorization: Authorization

name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X POST '<your-unleash-url>/api/admin/banners/:id/on' \
-H 'Accept: application/json' \
-H 'Authorization: <Authorization>'

Request Collapse all

Base URL

<your-unleash-url>

Auth

Security Scheme

apiKeybearerToken

apiKey

Parameters

id — pathrequired

ResponseClear

Click the Send API Request button above and see the response here!