Announcement banner

Get announcement banner configuration

Changed on

Returns the current announcement banner configuration.

Permissions required: Administer Jira global permission.

get/rest/api/3/announcementBanner

Request

  • Base URL
    https://your-domain.atlassian.net
  • URL
    https://your-domain.atlassian.net/rest/api/3/announcementBanner
  • Auth
    • HTTP basic
    • or OAuth 2
      Authorization code: 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

  • 5021849ab549Revision changes
    • warning

      added the new private enum value to the response property for the response status

    • warning

      added the new public enum value to the response property for the response status

    • info

      removed the PRIVATE enum value from the response property for the response status

    • info

      removed the PUBLIC enum value from the response property for the response status