Enterprise Get Enterprise Configurations

Enterprise Get Enterprise Configurations

Gets all configuration profiles, with optional Edge and/or module details, for the specified enterprise.

Privileges required:

READ ENTERPRISE_PROFILE

Request
URI
POST
https://{api_host}/portal/rest/enterprise/getEnterpriseConfigurations
COPY
Request Body

Show optional properties

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

enterpriseId

string
configurationType
Optional

configurationType

Possible values are : NETWORK_BASED, SEGMENT_BASED,
array of string
with
Optional

with

Possible values are : edges, modules, edgeCount, refs, deviceSettings,
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,
        "edges": [
            {
                "name": "string",
                "buildNumber": "string",
                "softwareVersion": "string",
                "modelNumber": "string",
                "activationState": "string",
                "logicalId": "string",
                "id": 0,
                "lastContact": "string"
            }
        ]
    }
]
array of enterprise_get_enterprise_configurations_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 '{"enterpriseId:"integer"}' https://{api_host}/portal/rest/enterprise/getEnterpriseConfigurations
On This Page
All Operations
POST
Enterprise Get Enterprise Alert Definitions
POST
Enterprise Delete Enterprise
POST
Enterprise Delete Enterprise Gateway Records
POST
Enterprise Delete Enterprise Network Allocation
POST
Enterprise Delete Enterprise Network Segment
POST
Enterprise Delete Enterprise Service
POST
Enterprise Fix Superaltgateway
POST
Enterprise Get Enterprise Addresses
POST
Enterprise Get Enterprise Alert Configurations
POST
Enterprise Get Enterprise Alerts
POST
Enterprise Get Enterprise All Alert Recipients
POST
Enterprise Get Enterprise Configurations
POST
Enterprise Get Enterprise Network Allocations
POST
Enterprise Get Enterprise Network Segments
POST
Enterprise Get Enterprise Operator Configuration
POST
Enterprise Get Enterprise Route Configuration
POST
Enterprise Get Enterprise Route Table
POST
Enterprise Get Enterprise Services
POST
Enterprise Get Enterprises Missinggateway
POST
Enterprise Insert Enterprise Service
POST
Enterprise Insert Or Update Enterprise Alert Configurations
POST
Enterprise Set Enterprise All Alert Recipients
POST
Enterprise Set Enterprise Operator Configuration
POST
Enterprise Update Enterprise Route
POST
Enterprise Update Enterprise Route Configuration
POST
Enterprise Update Enterprise Service