Get Enterprise Application By Id

Get Enterprise Application By Id

Fetch enterprise applications

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

The logicalId GUID for the target enterprise

integer
appId
Required

The appId for the target application

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 Array of ApplicationResource of type(s) application/json 
[
    {
        "_href": "string",
        "name": "string",
        "displayName": "string",
        "class": 0,
        "description": "string",
        "knownIpPortMapping": {},
        "protocolPortMapping": {},
        "mustNotPerformDpi": 0
    }
]

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