Create Environment

Creates an environment for the organization resolved from the access token and returns it with the Jamf-assigned id to assign tenants against.

The environment is created empty. metaRegion fixes the region every tenant assigned to it must be in and cannot be changed afterwards; omit it to create a global environment, which accepts tenants from any region. label describes what the environment is for and carries no behavior of its own.

Names are not required to be unique and are trimmed of surrounding whitespace. Nothing here rejects a combination of tenants — the eligibility rules are checked when tenants are assigned.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The environment to create.

An environment to create. It is created empty.

string
required
length between 1 and 255

Display name for the environment, shown to administrators in Jamf Account. Trimmed of surrounding whitespace, and not required to be unique.

string
enum
required

What the environment is for. Descriptive only — it does not change what can be assigned to the environment.

Allowed:
string
enum

Region every tenant assigned to this environment must be in. Omit to create a global environment, which accepts tenants from any region. Cannot be changed once the environment exists.

Allowed:
Responses

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