Examples

PUT /api/environments/687036938
{
  "environment": {
    "location_ids": [
      255093256
    ]
  }
}
200
{
  "created_at": "2018-11-16 10:03:26 UTC",
  "updated_at": "2018-11-16 10:03:26 UTC",
  "name": "environment12",
  "id": 687036938,
  "template_combinations": [],
  "puppetclasses": [],
  "locations": [
    {
      "id": 255093256,
      "name": "Location 1",
      "title": "Location 1",
      "description": null
    }
  ],
  "organizations": []
}

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Must be a Integer

organization_id
optional

Scope by organizations

Validations:

  • Must be a Integer

id
required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

environment
required

Validations:

  • Must be a Hash

environment[name]
optional

Validations:

  • Must be a String

environment[location_ids]
optional , nil allowed

REPLACE locations with given ids

Validations:

  • Must be an array of any type

environment[organization_ids]
optional , nil allowed

REPLACE organizations with given ids.

Validations:

  • Must be an array of any type