API docs by Redocly

Login page API (1.0.0)

Download OpenAPI specification:

v2

Get login page configuration

query Parameters
domain
string

The domain used for retrieving configuration, if missing, the default domain will be used, or the global configuration if default domain is not set

Responses

Response samples

Content type
application/json
Example
{
  • "zimbraDomainName": "domain",
  • "zimbraPublicServiceHostname": "mail.domain.com",
  • "zimbraPublicServicePort": 443,
  • "zimbraPublicServiceProtocol": "https",
  • "loginPageSkinLogoAppBanner": "skinLogoAppBanner",
  • "loginPageSkinLogoUrl": "https://logo.url.com",
  • "loginPageBackgroundImage": "https://image.background.com",
  • "publicUrl": "https://mail.domain.com",
  • "loginPageLogo": "/tmp/logo.jpg",
  • "loginPageColorPalette": {
    },
  • "loginPageTitle": "My Awesome Title"
}

v3

Get login page configuration

query Parameters
domain
string

The domain used for retrieving configuration, if missing, the default domain will be used, or the global configuration if default domain is not set

Responses

Response samples

Content type
application/json
Example
{
  • "zimbraDomainName": "domain",
  • "zimbraPublicServiceHostname": "mail.domain.com",
  • "zimbraPublicServicePort": 443,
  • "zimbraPublicServiceProtocol": "https",
  • "loginPageSkinLogoAppBanner": "skinLogoAppBanner",
  • "loginPageSkinLogoUrl": "https://logo.url.com",
  • "loginPageBackgroundImage": "https://image.background.com",
  • "publicUrl": "https://mail.domain.com",
  • "loginPageLogo": "/tmp/logo.jpg",
  • "loginPageColorPalette": {
    },
  • "loginPageTitle": "My Awesome Title"
}

Get versions supported for login page

Used to obtain min/max version usable for retrieving assets and login page: /login/v2/... /login/v3/...

Responses

Response samples

Content type
application/json
{
  • "maxApiVersion": 1,
  • "minApiVersion": 3
}