Create a banner.

POST 
/api/admin/banners

Creates a new banner.

Request

application/json

Body

required

createBannerSchema

message stringrequired
The message to display to all users. Supports markdown.
Example: **Reminder to everyone**: Maintenance is scheduled for *2337-12-27*.
enabled boolean
Whether the banner should be displayed currently. If not specified, defaults to true.
Example: true
variant string
The variant of the banner. One of "info", "warning", "error", or "success". If not specified, defaults to "info".
Example: info
sticky boolean
Whether the banner should be sticky on the screen. If not specified, defaults to false.
Example: true
icon stringnullable
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
link stringnullable
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
linkText stringnullable
The text to display on the link. If not specified, will be displayed as "More info".
Example: Learn more
dialogTitle stringnullable
The title to display on the dialog. If not specified, this will be the same as linkText.
Example: Learn more about it here
dialog stringnullable
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.

Responses

201

The resource was successfully created.

Response Headers

• location

  string

  The location of the newly created resource.

application/json

Schema

Schema

id integerrequired
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
message stringrequired
The message to display to all users. Supports markdown.
Example: **Reminder to everyone**: Maintenance is scheduled for *2337-12-27*.
enabled boolean
Whether the banner should be displayed currently. If not specified, defaults to true.
Example: true
variant string
The variant of the banner. One of "info", "warning", "error", or "success". If not specified, defaults to "info".
Example: info
sticky boolean
Whether the banner should be sticky on the screen. If not specified, defaults to false.
Example: true
icon stringnullable
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
link stringnullable
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
linkText stringnullable
The text to display on the link. If not specified, will be displayed as "More info".
Example: Learn more
dialogTitle stringnullable
The title to display on the dialog. If not specified, this will be the same as linkText.
Example: Learn more about it here
dialog stringnullable
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.
createdAt date-timerequired
The date and time of when the banner was created.
Example: 2023-12-27T13:37:00+01:00

Example (from schema)

{
  "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"
}

400

The request data does not match what we expect.

application/json

Schema

Schema

id string
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
name string
The name of the error kind
Example: ValidationError
message string
A description of what went wrong.
Example: The request payload you provided doesn't conform to the schema. The .parameters property should be object. You sent [].

Example (from schema)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "ValidationError",
  "message": "The request payload you provided doesn't conform to the schema. The .parameters property should be object. You sent []."
}

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

id string
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
name string
The name of the error kind
Example: AuthenticationRequired
message string
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 (from schema)

{
  "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

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

Example (from schema)

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

415

The operation does not support request payloads of the provided type. Please ensure that you're using one of the listed payload types and that you have specified the right content type in the "content-type" header.

application/json

Schema

Schema

id string
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
name string
The name of the error kind
Example: ContentTypeerror
message string
A description of what went wrong.
Example: We do not accept the content-type you provided (application/xml). Try using one of the content-types we do accept instead (application/json) and make sure the body is in the corresponding format.

Example (from schema)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "ContentTypeerror",
  "message": "We do not accept the content-type you provided (application/xml). Try using one of the content-types we do accept instead (application/json) and make sure the body is in the corresponding format."
}

Loading...