Get Enterprise

Get Enterprise

Fetch a customer

Request
URI
GET
https://{api_host}/api/sdwan/v2/enterprises/{enterpriseLogicalId}/
COPY
Path Parameters
string
enterpriseLogicalId
Required

The logicalId GUID for the target enterprise

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.

Responses
200

Request successfully processed

Returns EnterpriseResource of type(s) application/json 
{
    "_href": "string",
    "created": "string",
    "alertsEnabled": false,
    "operatorAlertsEnabled": false,
    "endpointPkiMode": "string",
    "name": "string",
    "domain": "string",
    "prefix": "string",
    "logicalId": "string",
    "accountNumber": "string",
    "description": "string",
    "contactName": "string",
    "contactPhone": "string",
    "contactMobile": "string",
    "contactEmail": "string",
    "streetAddress": "string",
    "streetAddress2": "string",
    "city": "string",
    "state": "string",
    "postalCode": "string",
    "country": "string",
    "lat": "number",
    "lon": "number",
    "timezone": "string",
    "locale": "string",
    "modified": "string",
    "gatewayPool": {
        "_href": "string"
    },
    "bastionState": "string"
}
string
_href
Optional

_href

string As date-time As date-time
created
Optional

created

boolean
alertsEnabled
Optional

alertsEnabled

boolean
operatorAlertsEnabled
Optional

operatorAlertsEnabled

string
endpointPkiMode
Optional

endpointPkiMode

Possible values are : CERTIFICATE_DISABLED, CERTIFICATE_OPTIONAL, CERTIFICATE_REQUIRED,
string
name
Optional

name

string
domain
Optional

domain

string
prefix
Optional

prefix

string
logicalId
Optional

A globally-unique UUIDv4-formatted identifer

string
accountNumber
Optional

accountNumber

string
description
Optional

description

string
contactName
Optional

contactName

string
contactPhone
Optional

contactPhone

string
contactMobile
Optional

contactMobile

string
contactEmail
Optional

contactEmail

string
streetAddress
Optional

streetAddress

string
streetAddress2
Optional

streetAddress2

string
city
Optional

city

string
state
Optional

state

string
postalCode
Optional

postalCode

string
country
Optional

country

number As float As float
lat
Optional

lat

number As float As float
lon
Optional

lon

string
timezone
Optional

timezone

string
locale
Optional

locale

string As date-time As date-time
modified
Optional

modified

BaseApiResource
gatewayPool
Optional

gatewayPool

string
bastionState
Optional

bastionState

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

401

Unauthorized

Returns UnAuthorized of type(s) application/json 
{
    "code": "string",
    "property": "string",
    "message": "string",
    "displayMessage": "string",
    "documentation": "string"
}
string
code
Optional

A unique error code

string
property
Optional

The name of the property to which the error applies, if applicable

string
message
Optional

A detailed description of the error condition intended for developers of API clients, which may include recommendations for resolution

string
displayMessage
Optional

A non-technical description of the error condition

string
documentation
Optional

A link to applicable external documentation


404

Resource not found

Returns ResourceNotFoundError of type(s) application/json 
{
    "code": "string",
    "property": "string",
    "message": "string",
    "displayMessage": "string",
    "documentation": "string"
}
string
code
Optional

A unique error code

string
property
Optional

The name of the property to which the error applies, if applicable

string
message
Optional

A detailed description of the error condition intended for developers of API clients, which may include recommendations for resolution

string
displayMessage
Optional

A non-technical description of the error condition

string
documentation
Optional

A link to applicable external documentation


429

Rate Limit Exceeded

Returns RateLimitExceededError of type(s) application/json 
{
    "code": "string",
    "property": "string",
    "message": "string",
    "displayMessage": "string",
    "documentation": "string"
}
string
code
Optional

A unique error code

string
property
Optional

The name of the property to which the error applies, if applicable

string
message
Optional

A detailed description of the error condition intended for developers of API clients, which may include recommendations for resolution

string
displayMessage
Optional

A non-technical description of the error condition

string
documentation
Optional

A link to applicable external documentation


500

Internal server error

Returns InternalServerError of type(s) application/json 
{
    "code": "string",
    "property": "string",
    "message": "string",
    "displayMessage": "string",
    "documentation": "string"
}
string
code
Optional

A unique error code

string
property
Optional

The name of the property to which the error applies, if applicable

string
message
Optional

A detailed description of the error condition intended for developers of API clients, which may include recommendations for resolution

string
displayMessage
Optional

A non-technical description of the error condition

string
documentation
Optional

A link to applicable external documentation


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 Edge Summary Metrics
GET
Get Enterprise Flow Metrics
GET
Get Enterprise Link Metrics
GET
Get Enterprise Nni Metrics
GET
Get Enterprise Nni Series
GET
Get Enterprises