Get user environment information
Purpose - Retrieve all environment information for a specific user, including: environment ID, applications in the environment, custom roles created in that environment, and more.
URL - https://<frontdoor-url>/api/environment/{customer}/{name}
Note: Replace <frontdoor-url> with the Frontdoor
URL for the region your Apptio product is hosted in.
Method - GET
URL path parameters:
| Parameter | Description |
|---|---|
| Customer | Name of the customer, for example, newco.com |
| name | Name of the environment to read, for example, main |
Headers - Pass apptio-opentoken header received as a response from the authentication call. See Basic authentication using user name and password.
Required permissions - The caller must have READ permissions in the environment. A user can READ an environment if they have any role granted in the environment.
Sample request:
curl -X GET https://frontdoor.apptio.com/api/environment/newco.com/main -H 'accept: application/json' -H 'apptio-opentoken: 40ffaaa19c936e201b5152573850a3c0016645d4da62d282fea9ccb9177dd070946df38bebd3c4b4ae1e3cd725f05b72'Return codes:
| HTTP Status Code | Reason |
|---|---|
| 200 | Environment found. |
| 400 | Invalid request. Customer specified NOT found. |
| 403 | You don't have the required permissions to perform this operation. |
| 404 | Environment NOT found. |