Edge Get Edge Configuration Stack

Edge Get Edge Configuration Stack

Gets the complete configuration profile (including all modules) of the specified Edge (by edgeId).

Privileges required:

READ EDGE

READ ENTERPRISE_PROFILE

Request
URI
POST
https://{api_host}/portal/rest/edge/getEdgeConfigurationStack
COPY
Request Body

Show optional properties

{
    "edgeId": 0
}
{
    "edgeId": 0,
    "enterpriseId": 0
}
integer
edgeId
Required

edgeId

integer
enterpriseId
Optional

enterpriseId

Responses
200

Request was successfully processed

[
    {
        "configurationType": "string",
        "created": "string",
        "description": "string",
        "edgeCount": 0,
        "effective": "string",
        "id": 0,
        "logicalId": "string",
        "modified": "string",
        "modules": [
            {
                "created": "string",
                "effective": "string",
                "modified": "string",
                "id": 0,
                "name": "string",
                "type": "string",
                "description": "string",
                "configurationId": 0,
                "data": {},
                "schemaVersion": "string",
                "version": "string",
                "metadata": {},
                "refs": {}
            }
        ],
        "name": "string",
        "schemaVersion": "string",
        "version": "string",
        "isStaging": 0
    }
]
array of edge_get_edge_configuration_stack_result_item
Optional

400
Returns generic_400 of type(s) application/json
Operation doesn't return any data structure

500
Returns generic_500 of type(s) application/json
Operation doesn't return any data structure

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"edgeId:"integer"}' https://{api_host}/portal/rest/edge/getEdgeConfigurationStack
On This Page
Edge Operations
POST
Edge Edge Cancel Reactivation
POST
Edge Edge Provision
POST
Edge Edge Request Reactivation
POST
Edge Get Client Visibility Mode
POST
Edge Get Edge
POST
Edge Get Edge Configuration Modules
POST
Edge Get Edge Configuration Stack
POST
Edge Get Edge Sdwan Peers
POST
Edge Update Edge Admin Password
POST
Edge Update Edge Attributes
POST
Edge Update Edge Credentials By Configuration