VMware Developer Documentation
API Reference PowerCLI Reference
[{"label":"Latest (v1.0)","version":"latest"}]
vmware-sase-platform
VMware Sase Platform API VMware SD-WAN Orchestration API v2 Monitor Customers

Create Enterprise

Description

Create a Customer

Request

Request

URL

URL

post
https://{api_host}//api/sdwan/v2/enterprises
Copy
Query Parameters

Query Parameters

string
include Optional

A comma-separated list of field names corresponding to linked resources. Where supported, the server will resolve resource attributes for the specified resources.

Request Body

Request Body

CreateEnterpriseSchema of mimetype application/json Optional

Enterprise creation schema

{
	"gatewayPool": "string",
	"name": "string",
	"operatorProfiles": [
		"string"
	]
}
string
gatewayPool Required

A globally-unique UUIDv4-formatted identifer
array of string
operatorProfiles Required

Array of globally-unique UUIDv4-formatted identifers representing operator Profile logicalIds. First item in the array is the default operator profile (inherited by all Edges by default)
string
name Required

Enterprise unique name
string
accountNumber Optional
string
contactName Optional
string
contactPhone Optional
string
country Optional
boolean
delegateEdgeImageManagementToEnterprise Optional
string
description Optional
string
domain Optional
boolean
enableEnterpriseDelegationToOperator Optional
boolean
enableEnterpriseDelegationToProxy Optional
boolean
enableEnterpriseUserManagementDelegationToOperator Optional
boolean
enableExportRestriction Optional
string
endpointPkiMode Optional

Possible values are: CERTIFICATE_DISABLED , CERTIFICATE_OPTIONAL , CERTIFICATE_REQUIRED

string
contactMobile Optional
number as float
lat Optional
array of string
licenses Optional

Array of globally-unique UUIDv4-formatted identifers
string
locale Optional
number as float
lon Optional
string
contactEmail Optional
string
city Optional
string
postalCode Optional
CreateEnterpriseServiceLicenses
serviceLicenses Optional
string
state Optional
string
streetAddress Optional
string
streetAddress2 Optional
string
timezone Optional
CreateEnterpriseUserSchema
user Optional
Response

Response

Response Body

Response Body

201 Created

Returns EnterpriseResource of type application/json

Request successfully processed

{
	"_href": "string",
	"accountNumber": "string",
	"alertsEnabled": false,
	"bastionState": "UNCONFIGURED",
	"city": "string",
	"contactEmail": "string",
	"contactMobile": "string",
	"contactName": "string",
	"contactPhone": "string",
	"country": "string",
	"created": "string",
	"description": "string",
	"domain": "string",
	"endpointPkiMode": "CERTIFICATE_DISABLED",
	"gatewayPool": {
		"_href": "string"
	},
	"lat": 0,
	"locale": "string",
	"logicalId": "string",
	"lon": 0,
	"modified": "string",
	"name": "string",
	"operatorAlertsEnabled": false,
	"postalCode": "string",
	"prefix": "string",
	"state": "string",
	"streetAddress": "string",
	"streetAddress2": "string",
	"timezone": "string"
}
string
_href Optional
string
accountNumber Optional
boolean
alertsEnabled Optional
string
bastionState Optional

Possible values are: UNCONFIGURED , STAGE_REQUESTED , UNSTAGE_REQUESTED , STAGED , UNSTAGED

string
city Optional
string
contactEmail Optional
string
contactMobile Optional
string
contactName Optional
string
contactPhone Optional
string
country Optional
string as date-time
created Optional
string
description Optional
string
domain Optional
string
endpointPkiMode Optional

Possible values are: CERTIFICATE_DISABLED , CERTIFICATE_OPTIONAL , CERTIFICATE_REQUIRED

BaseApiResource
gatewayPool Optional
number as float
lat Optional
string
locale Optional
string
logicalId Optional

A globally-unique UUIDv4-formatted identifer
number as float
lon Optional
string as date-time
modified Optional
string
name Optional
boolean
operatorAlertsEnabled Optional
string
postalCode Optional
string
prefix Optional
string
state Optional
string
streetAddress Optional
string
streetAddress2 Optional
string
timezone Optional
Errors

Errors

ValidationError
400

ValidationError
UnAuthorized
401

Unauthorized
ResourceNotFoundError
404

Resource not found
UnsupportedMediaTypeError
415

UnsupportedMediaTypeError
DataValidationError
422

DataValidationError
RateLimitExceededError
429

Rate Limit Exceeded
InternalServerError
500

Internal server error
Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"accountNumber":"string","city":"string","contactEmail":"string","contactMobile":"string","contactName":"string","contactPhone":"string","country":"string","delegateEdgeImageManagementToEnterprise":false,"description":"string","domain":"string","enableEnterpriseDelegationToOperator":false,"enableEnterpriseDelegationToProxy":false,"enableEnterpriseUserManagementDelegationToOperator":false,"enableExportRestriction":false,"endpointPkiMode":"CERTIFICATE_DISABLED","gatewayPool":"string","lat":0,"licenses":["string"],"locale":"string","lon":0,"name":"string","operatorProfiles":["string"],"postalCode":"string","serviceLicenses":{"CWS":{"enabled":false},"ENI":{"enabled":false},"MCS":{"enabled":false},"PICS":{"enabled":false},"SDWAN":{"enabled":false},"ZTNAD":{"enabled":false}},"state":"string","streetAddress":"string","streetAddress2":"string","timezone":"string","user":{"email":"string","firstName":"string","lastName":"string","mobilePhone":"string","officePhone":"string","password":"string","password2":"string","username":"string"}}' https://{api_host}/api/sdwan/v2/enterprises

Generated on: 01 Jun 23 10:48 UTC
[{"label":"Latest (v1.0)","version":"latest"}]
vmware-sase-platform
On This Page
Monitor Operations
post
Create Enterprise
delete
Delete Enterprise
get
Get Enterprise
get
Get Enterprise Aggregate Health Stats
get
Get Enterprise Application By ID
get
Get Enterprise Applications
get
Get Enterprise Firewall Stats
get
Get Enterprise Flow Metrics
get
Get Enterprise Link Metrics
get
Get Enterprise Nni Metrics
get
Get Enterprise Nni Series
get
Get Enterprises
Feedback

Was this page helpful?

© 2023 VMware Inc. Terms of Use Privacy Your California Privacy Rights Accessibility Trademarks Glossary Help Contact Us