Skip to content

Update Sandbox

PUT
/v1/org/{org_identifier}/product/{product_identifier}/sandbox/{sandbox_identifier}

Update sandbox details, requires sandbox:config:edit permission

Authorizations

Parameters

Path Parameters

org_identifier
required
Any of:
string format: uuid

Organization ID or short name

product_identifier
required
Any of:
string format: uuid

Product ID or short name

sandbox_identifier
required
Any of:
string format: uuid

Sandbox ID or short name

Request Body required

object
name
required
string
primary_contact_email
required
string
short_name
required
string
archive
boolean
classic_support_tool_url

URL to the classic support tool

string

Responses

200

Successful Response

object
sandbox_id
required
string format: uuid
product_id
required

Product that owns this sandbox

string format: uuid
name

Official Full Name

string
""
primary_contact_email

Email Address for the primary point of contact

string
""
short_name
required

Name used in URLs

string
>= 1 characters
last_modified_timestamp
required
string format: date-time
created_timestamp
required
string format: date-time
classic_support_tool_url

URL to the classic support tool

string
archive
required
boolean

404

Not Found

422

Validation Error

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