Skip to content
RallyHere Docs

Update Environment

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

Update an environment

Authorizations

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
base_url

The base url for this environment. This must start with https://

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
state

The current state of the environment

string
Allowed values: creating created on off initializing terminating destroying destroyed
authentication_state

The type of authentication that is currently available for the environment

string
Allowed values: open limited locked
kick_before_hint

Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone

string format: date-time
classic_support_tool_url

URL to the classic support tool

string
usage

Specified what the environment will be used for

string
Allowed values: dev live

Responses

200

Successful Response

object
unique_name

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

string
config_db_name

Name of Config DB to create and/or set up for this environment

string
game_db_name

Name of Game DB to create and/or set up for this environment

string
log_db_name

Name of Log DB to create and/or set up for this environment

string
match_db_name

Name of Match DB to create and/or set up for this environment

string
person_db_name

Name of Person DB to create and/or set up for this environment

string
reputation_db_name

Name of reputation DB to create and/or set up for this environment

string
schedule_db_name

Name of schedule DB to create and/or set up for this environment

string
stats_db_name

Name of stats DB to create and/or set up for this environment

string
support_db_name

Name of support DB to create and/or set up for this environment

string
file_api_db_name

Name of file API DB to create and/or set up for this environment

string
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
base_url

The base url for this environment. This must start with https://

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
state

The current state of the environment

string
Allowed values: creating created on off initializing terminating destroying destroyed
authentication_state

The type of authentication that is currently available for the environment

string
Allowed values: open limited locked
kick_before_hint

Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone

string format: date-time
classic_support_tool_url

URL to the classic support tool

string
usage

Specified what the environment will be used for

string
Allowed values: dev live
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