Configuration Get Configuration Modules

Gets all configuration modules for the specified configuration profile.

Privileges required:

READ ENTERPRISE_PROFILE, or

READ OPERATOR_PROFILE

Request

URI

POST

https://{api_host}/portal/rest/configuration/getConfigurationModules

COPY

Request Body

Show optional properties

{
    "configurationId": 0
}

{
    "configurationId": 0,
    "enterpriseId": 0,
    "noData": false,
    "modules": [
        "string"
    ]
}

integer

configurationId

Required

configurationId

integer

enterpriseId

Optional

enterpriseId

boolean

noData

Optional

noData

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

Returns Array of configuration_get_configuration_modules_result_item of type(s) application/json

[
    {
        "created": "string",
        "effective": "string",
        "modified": "string",
        "id": 0,
        "name": "string",
        "type": "string",
        "description": "string",
        "configurationId": 0,
        "enterpriseLogicalId": "string",
        "data": {},
        "schemaVersion": "string",
        "version": "string",
        "metadata": {},
        "refs": {}
    }
]

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 '{"configurationId:"integer"}' https://{api_host}/portal/rest/configuration/getConfigurationModules

On This Page

Description

Request

Request Body

Response

200 Response Body

Errors

Configuration Operations

POST

Configuration Clone And Convert Configuration

POST

Configuration Clone Configuration