Disables a banner.
POST /api/admin/banners/:id/off
Disables an existing banner, identified by its id.
Request
Path Parameters
- id string required
- 200
- 401
- 403
- 404
bannerSchema
- application/json
- Schema
- Example (from schema)
Schema
- id integer required
Possible values:
>= 1The 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.
- message string required
The message to display to all users. Supports markdown.
- enabled boolean
Whether the banner should be displayed currently. If not specified, defaults to true.
- variant string
The variant of the banner. One of "info", "warning", "error", or "success". If not specified, defaults to "info".
- sticky boolean
Whether the banner should be sticky on the screen. If not specified, defaults to
false. - icon string nullable
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.
- link string nullable
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.
- linkText string nullable
The text to display on the link. If not specified, will be displayed as "More info".
- dialogTitle string nullable
The title to display on the dialog. If not specified, this will be the same as
linkText. - dialog string nullable
The markdown to display on the dialog. If not specified, no dialog will be displayed.
- createdAt date-time required
The date and time of when the banner was created.
{
"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"
}
Authorization information is missing or invalid. Provide a valid API token as the authorization header, e.g. authorization:*.*.my-admin-token.
- application/json
- Schema
- Example (from schema)
Schema
- id string
The ID of the error instance
- name string
The name of the error kind
- message string
A description of what went wrong.
{
"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."
}
The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation
- application/json
- Schema
- Example (from schema)
Schema
- id string
The ID of the error instance
- name string
The name of the error kind
- message string
A description of what went wrong.
{
"id": "9c40958a-daac-400e-98fb-3bb438567008",
"name": "NoAccessError",
"message": "You need the \"UPDATE_ADDON\" permission to perform this action in the \"development\" environment."
}
The requested resource was not found.
- application/json
- Schema
- Example (from schema)
Schema
- id string
The ID of the error instance
- name string
The name of the error kind
- message string
A description of what went wrong.
{
"id": "9c40958a-daac-400e-98fb-3bb438567008",
"name": "NotFoundError",
"message": "Could not find the addon with ID \"12345\"."
}