Edit domain

Description

Gets a list of all domains in CloudShell

HTTP method

PUT

Request

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

Example header format:

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

Content-Type: application/json

Parameter Description/Comments
id

(string) Domain's id.

 
{
    "Name": "MyFirstDomain",
    "Description": "Updated domain",
    "EndTime": "05/20/2023 4:37:00 PM",  
    "Archived": true,{
    "LicensePoolId": "7932E56D-057E-47FE-8E37-B00600A97C7F"

}
Parameter Description/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. 
{
  "Description": "domain's new description",
  "Name": "domain's new name"  
}

Response

200 OK