Uh oh!
There was an error while loading. Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork 3
Server Information API
Richard Thombs edited this page Jul 19, 2014
·
10 revisions
The Server Information API returns a set of information about a TeamHaven server.
This API can be used to check that a given domain name is actually hosted by a TeamHaven server. If a 404 - Not Found status code is received, then it's not a TeamHaven server. This can be useful when validating domain names entered by users.
GET /api/server
Gets information about the configuration of a TeamHaven server.
Note: No authorization is required for this API call.
{Dedicated: true,// If true then this server is dedicated to a single TeamHaven AccountName: 'Our Company Name',// The name of this server. If dedicated, then this is the Account NameDomain: 'company.teamhaven.com',// The server's canonical domain nameHttpUrl: 'http://company.teamhaven.com:80',// The URL to use when connecting via HTTPHttpsURl: 'https://company.teamhaven.com:443',// The URL to use when connecting via HTTPSWhiteLabel: false,// If TRUE, then there should be no TeamHaven branding visible while connected to this serverTheme:
{AccentForegroundColor: '#FF3399',// The foreground color to use when displaying an accented blockAccentBackgroundColor: '#FFFFFF',// The background color to use when displaying an accented blockAccentBorderColor: '#FF0099',// The border color to use when displaying an accented blockBoxBackgroundColor: '#FFFFFF',// The background color to use when displaying a boxLogo: '//ourcompany.com/images/logo.png',// The logo to use for this server},Support:
{Email: 'support@ourcompany.com',// An email address to send support requests toTelephone: '+1 949 555 1234',// A telephone number to callUrl: 'http://www.ourcompany.com',// A URL to go toTwitter: 'ourcompany',// A Twitter account (without the @)Facebook: 'ourcompany'// A Facebook account}}Notes:
- The HttpUrl and HttpsUrl might be a different domain name than the one used in your request. You should always prefer to use the ones in the response, as this will aid migrations between servers. For example,
ourcompany.teamhaven.com/api/server, might return a response with URLs pointing to a customth.ourcompany.comdomain name.