Skip to content
RallyHere Docs
GitHub

Update Environment

PUT
/v1/product/{product_id}/environment/{environment_id}

Create an environment

Authorizations

  • HTTPBearer

Parameters

Path Parameters

environment_id
required

The environment ID

string format: uuid

The environment ID

product_id
required

Product ID

string format: uuid

Product ID

Request Body required

object
name
required

The name of the environment

string
>= 1 characters <= 200 characters
short_name
required

The short name of the environment

string
>= 1 characters <= 100 characters
unique_name

Unique name used during environment spin up. Must be unique across all products

string
base_url

The base url for this environment

string
>= 1 characters <= 200 characters
primary_contact_email

The primary contact email for the environment

string
>= 1 characters <= 200 characters
sandbox_id

The id of the sandbox this environment uses

string format: uuid
archive

Determines if the Loot is active. Inactive Loot will not be fulfilled

boolean
deployed

Whether or not this environment is deployed

boolean
state

The current state of the environment

string
Allowed values: on off initializing terminating
authentication_state

The type of authentication that is currently available for the environment

string
Allowed values: open limited locked
classic_support_tool_url

URL to the classic support tool

string

Responses

200

Successful Response

object
name
required

The name of the environment

string
>= 1 characters <= 200 characters
short_name
required

The short name of the environment

string
>= 1 characters <= 100 characters
unique_name

Unique name used during environment spin up. Must be unique across all products

string
base_url

The base url for this environment

string
>= 1 characters <= 200 characters
primary_contact_email

The primary contact email for the environment

string
>= 1 characters <= 200 characters
sandbox_id

The id of the sandbox this environment uses

string format: uuid
archive

Determines if the Loot is active. Inactive Loot will not be fulfilled

boolean
deployed

Whether or not this environment is deployed

boolean
state

The current state of the environment

string
Allowed values: on off initializing terminating
authentication_state

The type of authentication that is currently available for the environment

string
Allowed values: open limited locked
classic_support_tool_url

URL to the classic support tool

string
environment_id
required
string format: uuid
last_modified_timestamp

Timestamp of when the resource was last modified

string format: date-time
product_id
required

Product that owns this sandbox

string format: uuid

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string