PUT /api/environments/:id
Update an environment

Examples

PUT /api/environments/687036942
{
  "environment": {
    "organization_ids": [
      114267492
    ]
  }
}
200
{
  "created_at": "2020-05-20 13:41:13 UTC",
  "updated_at": "2020-05-20 13:41:13 UTC",
  "name": "environment310",
  "id": 687036942,
  "template_combinations": [],
  "puppetclasses": [],
  "locations": [
    {
      "id": 255093256,
      "name": "Location 1",
      "title": "Location 1",
      "description": null
    }
  ],
  "organizations": [
    {
      "id": 114267492,
      "name": "Empty Organization",
      "title": "Empty Organization",
      "description": null
    }
  ]
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optional

Set the current organization context for the request

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