Learn

List environments

Environments include one ore more tenants that share resources and settings while maintaining data and authorization isolation. Refer to the Management API overview for more information.

Make the following request to list all your available environments:

Request

http
Copy to clipboard.
1POST https://manage.mattr.global/v1/environments

Response

json
Copy to clipboard.
1{
2    "id": "354038cd-ec18-489e-999a-10f354a23",
3    "name": "Private US West Oregon",
4    "domain": "yours.mattr.global",
5    "authorizationServerDomain": "auth.mattr.global",
6    "deploymentModel": "private",
7    "region": {
8        "id": "cd714552-b008-4c2a-a3a6",
9        "name": "nz02",
10        "displayName": "Oregon, West US"
11    }
12},
13{
14    "id": "6aa264d5-f6c0-4839-bbb5-2623",
15    "name": "Private Australia Sydney",
16    "domain": "yours2.mattr.global",
17    "authorizationServerDomain": "auth.mattr.global",
18    "deploymentModel": "private",
19    "region": {
20        "id": "32d02d55-8b77-4900-a2a3-2525",
21        "name": "nz01",
22        "displayName": "Sydney, Australia"
23    }
24}

  • id: Unique environment identifier. This is required for creating new tenants in this environment.

  • name: Environment name.

  • domain: Environment MATTR VII domain.

  • authorizationServerDomain: Environment authorisation server.

  • deploymentModel: Deployment model can be either private or public.

  • region: Region details (id, name, displayName).