Enterprise Get Enterprise

Enterprise Get Enterprise

Gets data for the specified enterprise with optional proxy (partner) detail.

Privileges required:

READ ENTERPRISE

Request
URI
POST
https://{api_host}/portal/rest/enterprise/getEnterprise
COPY
Request Body
{
    "id": 0,
    "enterpriseId": 0,
    "with": [
        "string"
    ]
}
integer
id
Optional

id

integer
enterpriseId
Optional

enterpriseId

array of string
with
Optional

with

Responses
200

Request was successfully processed

Returns enterprise_get_enterprise_result of type(s) application/json
This response body class contains all of the following: Inlineenterprise_get_enterprise_result0 
{
    "id": 0,
    "created": "string",
    "networkId": 0,
    "gatewayPoolId": 0,
    "alertsEnabled": 0,
    "operatorAlertsEnabled": 0,
    "endpointPkiMode": "string",
    "name": "string",
    "domain": "string",
    "prefix": "string",
    "logicalId": "string",
    "accountNumber": "string",
    "description": "string",
    "contactName": "string",
    "contactPhone": "string",
    "contactMobile": "string",
    "contactEmail": "string",
    "streetAddress": "string",
    "streetAddress2": "string",
    "city": "string",
    "state": "string",
    "postalCode": "string",
    "country": "string",
    "lat": "number",
    "lon": "number",
    "timezone": "string",
    "locale": "string",
    "modified": "string",
    "enterpriseProxy": {
        "id": 0,
        "created": "string",
        "networkId": 0,
        "proxyType": "string",
        "operateGateways": false,
        "logicalId": "string",
        "name": "string",
        "domain": "string",
        "prefix": "string",
        "description": "string",
        "contactName": "string",
        "contactPhone": "string",
        "contactMobile": "string",
        "contactEmail": "string",
        "streetAddress": "string",
        "streetAddress2": "string",
        "city": "string",
        "state": "string",
        "postalCode": "string",
        "country": "string",
        "lat": "number",
        "lon": "number",
        "modified": "string"
    }
}

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/getEnterprise
On This Page
Enterprise Operations
POST
Analytics Get Analytics System Url
POST
Add Enterprise Operator Configuration
POST
Enterprise Assign Enterprise Operator Configurations
POST
Enterprise Clone Enterprise V2
POST
Enterprise Decode Enterprise Key
POST
Enterprise Delete Object Group
POST
Enterprise Encode Enterprise Key
POST
Enterprise Get Analytics Configuration
POST
Enterprise Get Enterprise
POST
Enterprise Get Enterprise Capabilities
POST
Enterprise Get Enterprise Distributed Cost Calculation
POST
Enterprise Get Enterprise Edges
POST
Enterprise Get Enterprise Gateway Handoff
POST
Enterprise Get Enterprise Maximum Segments
POST
Enterprise Get Enterprise Network Allocation
POST
Enterprise Get Enterprise Property
POST
Enterprise Get Enterprise Rate Limits
POST
Enterprise Get Enterprises With Property
POST
Enterprise Get Object Groups
POST
Enterprise Insert Enterprise
POST
Enterprise Insert Enterprise Network Allocation
POST
Enterprise Insert Enterprise Network Segment
POST
Enterprise Insert Object Group
POST
Enterprise Insert Or Update Analytics Configuration
POST
Enterprise Insert Or Update Enterprise Capability
POST
Enterprise Insert Or Update Enterprise Gateway Handoff
POST
Enterprise Insert Or Update Enterprise Property
POST
Enterprise Insert Or Update Enterprise Specific Rate Limits
POST
Enterprise Is Enterprise Upgraded Later Than
POST
Enterprise Set Enterprise Refresh Routes Version
POST
Set Default Enterprise Operator Configuration
POST
Enterprise Set Enterprise Distributed Cost Calculation
POST
Enterprise Set Enterprise Maximum Segments
POST
Enterprise Update Enterprise
POST
Enterprise Update Enterprise Network Allocation
POST
Enterprise Update Enterprise Network Segment
POST
Enterprise Update Enterprise Security Policy
POST
Enterprise Update Object Group
POST
Enterprise Proxy Get Enterprise Proxy Enterprises With Property