Edge Get Edge Configuration Modules

Edge Get Edge Configuration Modules

Returns the "composite" configuration modules for the specified Edge (by edgeId), in precisely the same format that those modules are dispatched to the Edge. This method operates by reconciling elements from the various profile- and edge-level modules that comprise an Edge's configuration stack (see edge/getEdgeConfigurationStack). For example, the "effective" set of firewall rules for a given segment is determined by concatenating the rule sets defined in the profile-level firewall module for that segment, and those defined in the Edge-specific firewall module for the same segment (if any).

Privileges required:

READ EDGE

READ ENTERPRISE_PROFILE

Request
URI
POST
https://{api_host}/portal/rest/edge/getEdgeConfigurationModules
COPY
Request Body
edge_get_edge_configuration_modules of type(s) application/json
Required 
{
    "edgeId": 0,
    "enterpriseId": 0,
    "modules": [
        "string"
    ]
}
integer
edgeId
Optional

edgeId

integer
enterpriseId
Optional

enterpriseId

array of string
modules
Optional

modules

Possible values are : imageUpdate, controlPlane, managementPlane, firewall, QOS, deviceSettings, WAN, metaData, properties, analyticsSettings, atpMetadata,
Responses
200

Request was successfully processed

{
    "deviceSettings": {
        "version": "string",
        "schemaVersion": "string",
        "type": "string",
        "data": "edgeDeviceSettingsData Object"
    },
    "firewall": {
        "version": "string",
        "schemaVersion": "string",
        "type": "string",
        "data": "firewall_data Object"
    },
    "QOS": {
        "version": "string",
        "schemaVersion": "string",
        "type": "string",
        "data": "QOSData Object"
    },
    "WAN": {
        "version": "string",
        "schemaVersion": "string",
        "type": "string",
        "data": "WAN_data Object"
    },
    "controlPlane": {
        "version": "string",
        "schemaVersion": "string",
        "type": "string",
        "data": "control_plane_data Object"
    },
    "managementPlane": {
        "version": "string",
        "schemaVersion": "string",
        "type": "string",
        "data": "management_plane_data Object"
    },
    "imageUpdate": {
        "version": "string",
        "schemaVersion": "string",
        "type": "string",
        "data": "image_update_data Object"
    }
}
object
deviceSettings
Optional

deviceSettings

object
firewall
Optional

firewall

object
QOS
Optional

QOS

object
WAN
Optional

WAN

object
controlPlane
Optional

controlPlane

object
managementPlane
Optional

managementPlane

object
imageUpdate
Optional

imageUpdate


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 '{}' https://{api_host}/portal/rest/edge/getEdgeConfigurationModules
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 Get Secure Device Secrets Option
POST
Edge Set Bastion State
POST
Edge Set Secure Device Secrets Option
POST
Edge Sync Ofc Routes
POST
Edge Update Analytics Settings For Edges
POST
Edge Update Edge Admin Password
POST
Edge Update Edge Attributes
POST
Edge Update Edge Credentials By Configuration
POST
Link Update Link Attributes
POST
Edge Get Edge Csr
POST
Edge Get Edge Pending Csrs
POST
Edge Insert Edge Certificate