Skip to content

edit-domain.md

Latest commit

 

History

History
80 lines (55 loc) · 1.47 KB

edit-domain.md

File metadata and controls

80 lines (55 loc) · 1.47 KB
sidebar_position 6

Edit domain

Description

Gets a list of all domains in CloudShell

URL

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

Parameter Description/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 | 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](./get-all-license-pools.md). |
Request example 
{
    "Name": "MyFirstDomain",
    "Description": "Updated domain",
    "EndTime": "05/20/2023 4:37:00 PM",  
    "Archived": true,
    "LicensePoolId": "7932E56D-057E-47FE-8E37-B00600A97C7F"

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

Response

Response code 
200 Ok