Skip to content

create-domain.md

Latest commit

 

History

History
80 lines (56 loc) · 1.39 KB

create-domain.md

File metadata and controls

80 lines (56 loc) · 1.39 KB
sidebar_position 4

Create domain

Description

Creates a new domain in CloudShell.

URL

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

HTTP method

POST

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) License pool name.
Description (string) License pool's description.
Archived (bool) (Optional) Specify "true" to create an archived domain.
EndTime (Optional) (string) (Optional) Domain's expiration time. When this time is reached, the domain will still be accessible but no longer in use.
LicensePoolId (string) (Optional) Name of the license pool to use for the domain.
Description (string) (Optional) Domain's name.
Request example 
{
  "Archived": true,
  "EndTime": "string",
  "LicensePoolId": "string",
  "EndTime": "05/20/2023 4:37:00 PM"
  "Description": "string",
  "Name": "string"
}

Response

Response example 
{
    "Id": "e7d4289c-4355-435e-bc8f-aea0591af53c"
}
Response code 
201 Created