Update Environment

Replaces the name and label of an environment belonging to the organization resolved from the access token.

Both fields are required and are a full replacement, not a patch: omitting one is a 400 rather than leaving it unchanged, so read GET /environments first if you only mean to change one of them.

metaRegion is not part of the request. An environment cannot be moved between regions once tenants have been assigned against its region, so it is fixed at creation. Tenant membership is not part of the request either — use PUT /environments/{environmentId}/tenants.

The response has no body.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length between 1 and 64

Jamf-assigned identifier of the environment, as returned in the id field of an environment. Treat it as an opaque string.

Body Params

The complete name and label of the environment.

The complete name and label of an existing environment. A full replacement, not a patch.

string
required
length between 1 and 255

Display name for the environment. Trimmed of surrounding whitespace, and not required to be unique.

string
enum
required

What the environment is for.

Allowed:
Responses
204

The environment was updated. The response has no body.

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json