Announcement banner

Get announcement banner configuration

Returns the current announcement banner configuration.

Permissions required: Administer Jira global permission.

get/rest/api/2/announcementBanner

Request

  • Base URL: https://your-domain.atlassian.net
  • URL: https://your-domain.atlassian.net/rest/api/2/announcementBanner
  • Auth: one of:
    • HTTP basic
    • OAuth 2 (authorization code, authorization URL https://auth.atlassian.com/authorize, token URL https://auth.atlassian.com/oauth/token, scopes: manage:jira-configuration)

Response

Returned if the request is successful.

hashIdstring

Hash of the banner data. The client detects updates by comparing hash IDs.

isDismissibleboolean

Flag indicating if the announcement banner can be dismissed by the user.

isEnabledboolean

Flag indicating if the announcement banner is enabled or not.

messagestring

The text on the announcement banner.

visibility'public' | 'private'

Visibility of the announcement banner.

Changes

No recorded changes to this operation across all 26 revisions of this API.