Enterprise Get Enterprise Route Table

Enterprise Get Enterprise Route Table

Gets the composite enterprise route table, optionally scoped by profile(s). The returned routes include static routes, directly connected routes, and learned routes.

Privileges required:

READ ENTERPRISE_PROFILE

Request
URI
POST
https://{api_host}/portal/rest/enterprise/getEnterpriseRouteTable
COPY
Request Body
{
    "enterpriseId": 0,
    "profiles": [
        0
    ],
    "filter": {
        "limit": 0,
        "rules": [
            {
                "field": "string",
                "op": "string",
                "values": [
                    "string"
                ]
            }
        ]
    }
}
integer
enterpriseId
Optional

enterpriseId

array of integer
profiles
Optional

profiles

object
filter
Optional

filter

Responses
200

Request was successfully processed

Returns enterprise_get_enterprise_route_table_result of type(s) application/json 
{
    "profiles": [
        {
            "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
        }
    ],
    "subnets": [
        {
            "eligableExits": [
                {
                    "type": "string",
                    "exitType": "string",
                    "edgeId": 0,
                    "edgeName": "string",
                    "profileId": 0,
                    "cidrIp": "string",
                    "cost": 0,
                    "advertise": false,
                    "order": 0
                }
            ],
            "preferredExits": [
                {
                    "type": "string",
                    "exitType": "string",
                    "edgeId": 0,
                    "edgeName": "string",
                    "profileId": 0,
                    "cidrIp": "string",
                    "cost": 0,
                    "advertise": false,
                    "order": 0
                }
            ],
            "subnet": "string"
        }
    ],
    "exits": {
        "edges": [
            {
                "id": 0,
                "name": "string",
                "logicalId": "string",
                "type": "string"
            }
        ],
        "hubs": [
            {
                "id": 0,
                "name": "string",
                "logicalId": "string",
                "type": "string"
            }
        ],
        "gateways": [
            {
                "id": 0,
                "name": "string",
                "logicalId": "string",
                "type": "string"
            }
        ],
        "nvs": [
            {
                "id": 0,
                "name": "string",
                "logicalId": "string",
                "type": "string"
            }
        ]
    }
}
array of object
profiles
Optional

profiles

array of object
subnets
Optional

subnets

object
exits
Optional

exits


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/enterprise/getEnterpriseRouteTable
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