MAmacrometa
Environments

Create an environment

Creates a new environment.

Note: Requires administrator permissions.

post/_api/environments

Request

Request body

namestring required

Has to contain a valid environment name.

tenantstring

Name of the tenant to associate with environment. This option is applicable and optional when system tenant _mm invokes the API. Other tenants should not specify this option as the tenant invoking API shall be associated with environment.

usersstring[]

Enter an array of user ids that has admin access to the new environment. If this field is left blank, the default user root has admin access.

Example request

{
  "options": {
    "metadata": {
      "key": "value"
    }
  }
}

Response

Successfully created new environment.

codeinteger

HTTP response code.

errorboolean

Flag if there is an error in response. False for this response.

resultboolean

Whether the environment was created successfully.

Example response

{
  "code": 201,
  "result": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.