Skip to main content

Update Domain Setting

Description

Added in CloudShell 2024.1.

Updates a specific setting for a domain. Use this to configure per-domain behavior such as email notification timing.

URL

http://{Admin API IP}:{port#}/api/v1/domains/{id}/settings

ParameterDescription/Comments
ID(string) Domain's ID. Can be retrieved via Get all domains.

HTTP method

PUT

Request

Headers

Example header format:

Authorization: Basic <authorization token returned from the login method>

Content-Type: application/json

Request body
ParameterDescription/Comments
NameThe name of the domain setting to update. (string)
ValueThe new value for the setting. (string)
Request example
{
"Name": "NotificationMinutesBeforeEnd",
"Value": "15"
}

Response

Response code
200 OK

Available Domain Settings

Setting NameDescription
NotificationMinutesBeforeEndNumber of minutes before sandbox end time to send an email notification to the sandbox owner.