[{"label":"Latest (2022-09-01)","version":"latest"},{"version":"v1.0"}]
vmware-sase-platform

Get Enterprise

Description

Fetch a customer

Request

Request

URL

URL


get
https://{api_host}//api/sdwan/v2/enterprises/{enterpriseLogicalId}
Copy

Path Parameters

Path Parameters

string
enterpriseLogicalId Required

The logicalId GUID for the target enterprise


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.


Response

Response

Response Body

Response Body

200 OK

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: UNCONFIGUREDSTAGE_REQUESTEDUNSTAGE_REQUESTEDSTAGEDUNSTAGED


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_DISABLEDCERTIFICATE_OPTIONALCERTIFICATE_REQUIRED



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

401

Unauthorized


404

Resource not found


429

Rate Limit Exceeded


500

Internal server error

Code Samples

Code Samples

cURL Command

curl https://{api_host}/api/sdwan/v2/enterprises/{enterpriseLogicalId}


Feedback

Was this page helpful?