About the Frontdoor API

The Frontdoor API enables programmatic access to user management and environment access. The Frontdoor API implementation is based on REST principles. You should find the interface to be predictable with use of resource-oriented URLs and reliance on standard HTTP features that are generally understood by off-the-shelf HTTP clients. For example the API relies on HTTP basic auth for authentication, HTTP verbs (methods such as GET,PUT...) for actions and standard HTTP response codes to indicate API errors or otherwise. Most API responses are returned as JSON. A few endpoints return CSV, these are noted in the documentation for the endpoint.

Authentication Overview

The Frontdoor API supports authentication via local user credentials or via API Key. Both the local user and the API Key authentication APIs return a temporary token along with a valid_till value that indicates when the token will expire. The token must be passed into the apptio-opentoken header for all other Frontdoor API calls. This token will be used to authenticate and authorize the request. It is recommended that you use the same token for all calls to Frontdoor until it expires or is close to expiring, at which point you authenticate again to get a new token. The valid_till value is determined by the Session Valid Length setting on the user's Domain.

Frontdoor API URL

Frontdoor runs in several geographical regions and the URL that you will use for the Frontdoor API depends on which region your Apptio product is hosted in. To find your Frontdoor URL, login to your Apptio Application and click on the User Profile button. This will take you to your Profile in Access Administration. Click on the Apptio logo at the top left to navigate to the Frontdoor homepage.

On the Frontdoor homepage, note the URL in your browser's navigation bar. Everything before /home is your Frontdoor URL.

Topics

Authentication topics include the following:

User management topics include the following:

Environment topics include the following:

Example topics include the following: