Edit a Package Management Environment

PUT /api/v1.2/package/<Env ID>/update_environment

Use this API to edit a package management environment. You cannot change the Python and R versions.

Required Role

The following roles can make this API call:

• A user who is part of the system-user/system-admin group.
• A user invoking this API must be part of a group associated with a role that allows updating an environment. See Managing Groups and Managing Roles for more information.

Parameters

Note

Parameters marked in bold are mandatory. Others are optional and have default values.

Parameter	Description
name	Edit the name if it is required.
description	You can add a brief description about the environment.

Request API Syntax

curl -X PUT -H "X-AUTH-TOKEN: <API-TOKEN>" -H "Content-Type: application/json" -H "Accept: application/json" \
-d '{"name": "<EnvironmentName>", "description": "<Description>"}' \
"https://api.qubole.com/api/v1.2/package/<env ID>/update_environment"

Note

The above syntax uses https://api.qubole.com as the endpoint. Qubole provides other endpoints to access QDS that are described in Supported Qubole Endpoints on Different Cloud Providers.

Sample API Request

Here is a sample request to edit a package environment that has 97 as its ID.

curl -X PUT -H "X-AUTH-TOKEN: <API-TOKEN>" -H "Content-Type: application/json" -H "Accept: application/json" \
-d '{"name": "PackageEnv1", "description": "Environment for adding Python and R packages"}' \
"https://api.qubole.com/api/v1.2/package/97/update_environment"