PUT /katello/api/environments/:id
Update an environment

PUT /katello/api/organizations/:organization_id/environments/:id
Update an environment in an organization

Examples

PUT /katello/api/organizations/114267492/environments/1028819239
{
  "environment": {
    "new_name": "New Name",
    "label": "New Label",
    "registry_name_pattern": "<%= repository.label %> <%= organization.label %>"
  }
}
200
{
  "library": false,
  "registry_name_pattern": "<%= repository.label %> <%= organization.label %>",
  "registry_unauthenticated_pull": false,
  "id": 1028819239,
  "name": "New Name",
  "label": "staging_label",
  "description": "Staging environment.",
  "organization_id": 114267492,
  "organization": {
    "name": "Empty Organization",
    "label": "Empty_Organization",
    "id": 114267492
  },
  "created_at": "2023-08-23 19:55:45 UTC",
  "updated_at": "2023-08-23 20:04:02 UTC",
  "prior": {
    "name": "Library",
    "id": 562075838
  },
  "successor": null,
  "counts": {
    "content_hosts": 0,
    "content_views": 1
  },
  "permissions": {
    "create_lifecycle_environments": true,
    "view_lifecycle_environments": true,
    "edit_lifecycle_environments": true,
    "destroy_lifecycle_environments": true,
    "promote_or_remove_content_views_to_environments": true
  },
  "content_views": [
    {
      "name": "Published Library - dev - staging view",
      "id": 419082953
    }
  ]
}

Params

Param name Description
id
required

ID of the environment

Validations:

  • Must be a number.
organization_id
optional

name of the organization

Validations:

  • Must be a number.
new_name
optional

new name to be given to the environment

Validations:

  • String
description
optional

description of the environment

Validations:

  • String
registry_name_pattern
optional

pattern for container image names

Validations:

  • String
registry_unauthenticated_pull
optional

allow unauthenticed pull of container images

Validations:

  • Must be one of: true, false, 1, 0.
async
optional

Do not wait for the update action to finish. Default: true

Validations:

  • Must be one of: true, false, 1, 0.