Create Org

Create Org

Create a new organization

Request
URI
POST
https://{api_host}/cloudapi/1.0.0/orgs
COPY
Request Body
Org of type(s) application/json
Optional 
{
    "id": "string",
    "name": "string",
    "displayName": "string",
    "description": "string",
    "isEnabled": false,
    "orgVdcCount": 0,
    "catalogCount": 0,
    "vappCount": 0,
    "runningVMCount": 0,
    "userCount": 0,
    "diskCount": 0,
    "canPublish": false
}
string
id
Optional

A unique identifier for the organization.

string As ^[a-zA-Z0-9_\-\.\!\'\(\),\$]+$
name
Required

Name of the organization.

string As (?=.*\S.*)^[^\p{Zl}\p{Zp}\p{C}]*$
displayName
Required

Full display name of the organization.

string
description
Optional

Description of the organization.

boolean
isEnabled
Optional

Whether the organization is enabled or not.

integer
orgVdcCount
Optional

The number of VDCs in the org.

integer
catalogCount
Optional

The number of catalogs in the org.

integer
vappCount
Optional

The number of vApps in the org.

integer
runningVMCount
Optional

The number of running VMs in the org.

integer
userCount
Optional

The number of users in the org.

integer
diskCount
Optional

The number of disks in the org.

boolean
canPublish
Optional

Whether the organization can publish catalogs externally.

Authentication
This operation uses the following authentication methods.
Responses
201

Created

Returns Org of type(s) application/json;version=37.0 
{
    "id": "string",
    "name": "string",
    "displayName": "string",
    "description": "string",
    "isEnabled": false,
    "orgVdcCount": 0,
    "catalogCount": 0,
    "vappCount": 0,
    "runningVMCount": 0,
    "userCount": 0,
    "diskCount": 0,
    "canPublish": false
}
string
id
Optional

A unique identifier for the organization.

string As ^[a-zA-Z0-9_\-\.\!\'\(\),\$]+$
name
Required

Name of the organization.

string As (?=.*\S.*)^[^\p{Zl}\p{Zp}\p{C}]*$
displayName
Required

Full display name of the organization.

string
description
Optional

Description of the organization.

boolean
isEnabled
Optional

Whether the organization is enabled or not.

integer
orgVdcCount
Optional

The number of VDCs in the org.

integer
catalogCount
Optional

The number of catalogs in the org.

integer
vappCount
Optional

The number of vApps in the org.

integer
runningVMCount
Optional

The number of running VMs in the org.

integer
userCount
Optional

The number of users in the org.

integer
diskCount
Optional

The number of disks in the org.

boolean
canPublish
Optional

Whether the organization can publish catalogs externally.


Availability
Added in 36.0
On This Page
Org Operations
POST
Create Org
DELETE
Delete Org
GET
Get Org
GET
Query Orgs
PUT
Update Org