Get Enterprises

Get Enterprises

List Customers

Request
URI
GET
https://{api_host}/api/sdwan/v2/enterprises/
COPY
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.

string
prevPageLink
Optional

A prevPageLink value, as fetched via a past call to a list API method. When a prevPageLink value is specified, any other query parameters that may ordinarily be used to sort or filter the result set are ignored.

string
nextPageLink
Optional

A nextPageLink value, as fetched via a past call to a list API method. When a nextPageLink value is specified, any other query parameters that may ordinarily be used to sort or filter the result set are ignored.

integer,null
limit
Optional

Limits the maximum size of the result set.

string
sortBy
Optional

sortBy query param to sort the resultset. Format of sortBy is <ASC | DESC>

string
name[contains]
Optional

Filter by name[contains]

string
name[notContains]
Optional

Filter by name[notContains]

string
accountNumber[contains]
Optional

Filter by accountNumber[contains]

string
accountNumber[notContains]
Optional

Filter by accountNumber[notContains]

string
domain[contains]
Optional

Filter by domain[contains]

string
domain[notContains]
Optional

Filter by domain[notContains]


Responses
200

Request successfully processed

Returns EnterpriseResourceCollection of type(s) application/json
{
    "_href": "string",
    "data": [
        {
            "_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"
        }
    ],
    "metaData": {
        "prevPageLink": "string",
        "nextPageLink": "string",
        "limit": 0,
        "more": false
    }
}
string
_href
Optional

_href

data
Optional

data

metaData
Optional

metaData


400

ValidationError

Returns ValidationError of type(s) application/json
{
    "code": "string",
    "property": "string",
    "message": "string",
    "displayMessage": "string",
    "documentation": "string",
    "errors": [
        {
            "message": "string",
            "path": "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

errors
Optional

A list of property-specific errors


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