Create Environment

v1.0.0

A sample body is added to the request that conforms to the following JSON schema:

json

{  "type": "object",  "properties": {    "environment": {      "type": "object",      "properties": {        "name": {              "type": "string",              "maxLength": 254,              "minLength": 1            },        "values": {          "type": "array",          "maxItems": 100,          "additionalItems": false,          "items": {              "type": "object",              "properties": {                "key": {                  "type": "string",                  "maxLength": 254                  "minLength": 1                },                "value": { "type": "string" },                "enabled": { "type": "boolean" }              },              "required": ["key", "value"]            }        }      },      "required": ["name"]    }  },  "required": ["environment"]}

On successful creation of the environment, the API returns the environment name and id.

You can also specify the context of a workspace to create an environment in directly by passing the workspace as a query param.

Requires as X-Api-Key request header or apikey URL query parameter.

Input

{
  "type": "object",
  "properties": {
    "environment": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "values": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "key": {
                "type": "string"
              },
              "value": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  }
}

Output

{
  "type": "object",
  "properties": {
    "environment": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "uid": {
          "type": "string"
        }
      }
    }
  }
}