-
Notifications
You must be signed in to change notification settings - Fork 3
Server Information API
Richard Thombs edited this page May 11, 2014
·
10 revisions
The Server Information API returns a set of information about the server. This API can also be used to ensure that a given URL is actually a TeamHaven server - If you get a 404 response, then it's not a TeamHaven server!
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 Account
Name: 'Our Company Name', // The name of this server. If dedicated, then this is the Account Name
HttpUrl: 'http://company.teamhaven.com:80', // The URL to use when connecting via HTTP
HttpsURl: 'https://company.teamhaven.com:443', // The URL to use when connecting via HTTPS
WhiteLabel: false, // If TRUE, then there should be no TeamHaven branding visible while connected to this server
Theme:
{
AccentForegroundColor: '#FF3399', // The foreground color to use when displaying an accented block
AccentBackgroundColor: '#FFFFFF', // The background color to use when displaying an accented block
AccentBorderColor: '#FF0099', // The border color to use when displaying an accented block
BoxBackgroundColor: '#FFFFFF', // The background color to use when displaying a box
Logo: '//ourcompany.com/images/logo.png', // The logo to use for this server
},
Support:
{
Email: 'support@ourcompany.com', // An email address to send support requests to
Telephone: '+1 949 555 1234', // A telephone number to call
Url: 'http://www.ourcompany.com', // A URL to go to
Twitter: '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.