Skip to main content

Edit domain

Description​

Updates a domain's settings. Only the parameters included in the request body are changed

URL​

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

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
Name(string) Domain name.
Description(string) Domain description.
EndTime(string) End time of domain's validity. When the end time is reached, the domain will be accessible but no longer in use.
Archived(bool) true to archive the domain.
LicensePoolId(string) Id of the license pool. Can be retrieved via Get all license pools.
MinimumLeadTimeMinutes(int) Minimum number of minutes between the time a sandbox is reserved and its start time. For example, 60 means the sandbox must start at least 60 minutes from now. 0 removes the restriction. Can also be set in Resource Manager (domain Properties page).
Request example
{
    "Name": "MyFirstDomain",
    "Description": "Updated domain",
    "EndTime": "05/20/2023 4:37:00 PM",  
    "Archived": true,
    "LicensePoolId": "7932E56D-057E-47FE-8E37-B00600A97C7F",
    "MinimumLeadTimeMinutes": 120

}
{
  "Description": "domain's new description",
  "Name": "domain's new name"  
}

Response​

Response code
200 Ok