Configuration Get Configuration

Configuration Get Configuration

Gets the specified configuration profile, optionally with module details.

Privileges required:

READ ENTERPRISE_PROFILE, or

READ OPERATOR_PROFILE

Request
URI
POST
https://{api_host}/portal/rest/configuration/getConfiguration
COPY
Request Body

Show optional properties

{
    "id": 0
}
{
    "id": 0,
    "enterpriseId": 0,
    "with": [
        "string"
    ]
}
integer
id
Required

id

integer
enterpriseId
Optional

enterpriseId

array of string
with
Optional

with

Possible values are : modules, edgeCount, enterprises, enterpriseCount, counts,
Responses
200

Request was successfully processed

Returns configuration_get_configuration_result of type(s) application/json
This response body class contains all of the following: Inlineconfiguration_get_configuration_result0 
{
    "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
}

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 '{"id:"integer"}' https://{api_host}/portal/rest/configuration/getConfiguration
On This Page
All Operations
POST
Configuration Clone Enterprise Template
POST
Configuration Delete Configuration
POST
Configuration Get Configuration
POST
Configuration Get Identifiable Applications
POST
Configuration Get Routable Applications
POST
Configuration Update Application Map Content
POST
Configuration Update Application Map Profiles