SCscalr
environments

Update Environment

patch/environments/{environment}

Request

  • Base URL
    https://example.scalr.io/api/iacp/v3
  • URL
    https://example.scalr.io/api/iacp/v3/environments/{environment}
  • Auth
    HTTP bearer

Path parameters

environmentstring required

The ID of the environment to update.

Query parameters

accountsstring

The comma-separated list of fields to return in response for Account resource.

agent-poolsstring

The comma-separated list of fields to return in response for AgentPool resource.

drift-detection-schedulestring

The comma-separated list of fields to return in response for DriftDetectionSchedule resource.

environmentsstring

The comma-separated list of fields to return in response for Environment resource.

policy-groupsstring

The comma-separated list of fields to return in response for PolicyGroup resource.

provider-configurationsstring

The comma-separated list of fields to return in response for ProviderConfiguration resource.

storage-profilesstring

The comma-separated list of fields to return in response for StorageProfile resource.

tagsstring

The comma-separated list of fields to return in response for Tag resource.

usersstring

The comma-separated list of fields to return in response for User resource.

The value of the fields[resource-type] parameter is a comma-separated list that refers to the name of the fields to be returned for the resource. An empty value indicates that no fields should be returned.

Request body

includedobject[]
metaobject

Response

Successfully updated the environment.

includedobject[]
metaobject

Changes

No recorded changes to this operation across all 2 revisions of this API.