Skip to content

Latest commit

 

History

History
302 lines (184 loc) · 6.91 KB

SettingsApi.md

File metadata and controls

302 lines (184 loc) · 6.91 KB
Raw

SettingsApi

All URIs are relative to https://<JIRA_URL>/rest/bootstrapi/1

Method HTTP request Description
getBanner GET /settings/banner Get the banner
getBrandingColorScheme GET /settings/branding/color-scheme Get the color scheme
getBrandingFavicon GET /settings/branding/favicon Get the favicon
getBrandingLogo GET /settings/branding/logo Get the logo
getSettings GET /settings Get the general settings
getSettingsSecurity GET /settings/security Get the security settings
setBanner PUT /settings/banner Set the banner
setBrandingColorScheme PUT /settings/branding/color-scheme Set the color scheme
setBrandingFavicon PUT /settings/branding/favicon Set the favicon
setBrandingLogo PUT /settings/branding/logo Set the logo
setSettings PUT /settings Set the general settings
setSettingsSecurity PUT /settings/security Set the security settings

getBanner

SettingsBannerBean getBanner()

Get the banner

Parameters

This endpoint does not need any parameter.

Return type

SettingsBannerBean

Authorization

basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getBrandingColorScheme

SettingsBrandingColorSchemeBean getBrandingColorScheme()

Get the color scheme

Parameters

This endpoint does not need any parameter.

Return type

SettingsBrandingColorSchemeBean

Authorization

basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getBrandingFavicon

Object getBrandingFavicon()

Get the favicon

Parameters

This endpoint does not need any parameter.

Return type

Object

Authorization

basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/octet-stream

getBrandingLogo

Object getBrandingLogo()

Get the logo

Parameters

This endpoint does not need any parameter.

Return type

Object

Authorization

basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/octet-stream

getSettings

SettingsBean getSettings()

Get the general settings

Parameters

This endpoint does not need any parameter.

Return type

SettingsBean

Authorization

basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getSettingsSecurity

SettingsSecurityBean getSettingsSecurity()

Get the security settings

Parameters

This endpoint does not need any parameter.

Return type

SettingsSecurityBean

Authorization

basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

setBanner

SettingsBannerBean setBanner(SettingsBannerBean)

Set the banner

Parameters

Name Type Description Notes
SettingsBannerBean SettingsBannerBean

Return type

SettingsBannerBean

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

setBrandingColorScheme

SettingsBrandingColorSchemeBean setBrandingColorScheme(SettingsBrandingColorSchemeBean)

Set the color scheme

Parameters

Name Type Description Notes
SettingsBrandingColorSchemeBean SettingsBrandingColorSchemeBean

Return type

SettingsBrandingColorSchemeBean

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

setBrandingFavicon

setBrandingFavicon(body)

Set the favicon

Parameters

Name Type Description Notes
body Object

Return type

null (empty response body)

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/octet-stream
  • Accept: application/json

setBrandingLogo

setBrandingLogo(body)

Set the logo

Parameters

Name Type Description Notes
body Object

Return type

null (empty response body)

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/octet-stream
  • Accept: application/json

setSettings

SettingsBean setSettings(SettingsBean)

Set the general settings

Parameters

Name Type Description Notes
SettingsBean SettingsBean

Return type

SettingsBean

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

setSettingsSecurity

SettingsSecurityBean setSettingsSecurity(SettingsSecurityBean)

Set the security settings

Parameters

Name Type Description Notes
SettingsSecurityBean SettingsSecurityBean

Return type

SettingsSecurityBean

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json