openapi: 3.0.0 info: title: VeloCloud Orchestrator API description: > ##

The VeloCloud Orchestrator (VCO) powers the management plane in the VMware SD-WAN solution. It offers a broad range of configuration, monitoring and troubleshooting functionality to service providers and enterprises alike. The principal web service with which users interact in order to exercise this functionality is called the VCO Portal.

The VCO Portal

The VCO Portal allows network administrators (or scripts and applications acting on their behalf) to manage network and device configuration and query current or historical network and device state. API clients may interact with the Portal via a JSON-RPC interface or a REST-like interface. It is possible to invoke all of the methods described in this document using either interface; there is no Portal functionality for which access is constrained exclusively to either JSON-RPC clients or REST-like ones.

Both interfaces accept exclusively HTTP POST requests. Both also expect that request bodies, when present, are JSON-formatted -- consistent with RFC 2616, clients are furthermore expected to formally assert where this is the case using the `Content-Type` request header, e.g. `Content-Type: application/json`.

JSON-RPC Interface

The JSON-RPC API accepts calls via the `/portal` URL path (e.g. vco.velocloud.net/portal). Consistent with v2.0 of the JSON-RPC specification, the API expects JSON-encoded request payloads that consist of a method name (`method`), a parameters object (`params`), a user-specified unique request identifier (`id`, by convention an integer such as a millisecond-precision epoch timestamp), and a JSON-RPC specification version identifier (`jsonrpc`). The VCO supports only the 2.0 iteration of the JSON-RPC specification, and so the value of the `jsonrpc` parameter should always be the string `"2.0"`. A sample request follows:

curl --header 'Content-Type: application/json' --data '{"jsonrpc":"2.0","method":"event/getEnterpriseEvents","params":{"enterpriseId":1},"id":1}' --cookie cookies.txt -X POST https://vco.velocloud.net/portal/

REST-like Interface

The REST-like interface eliminates some of the protocol "overhead" imposed by the JSON-RPC interface, and may feel more familiar to those familiar with URL-based REST semantics. It also offers a greater degree of interoperability with a range of client-side tools designed for use with traditional REST APIs. The interface is accessible via the `/portal/rest/` base path. In processing REST-like requests, the VCO parses the method name from the portion of the URL path that follows the base path. The request body need contain only the method parameters, e.g.:

curl --header 'Content-Type: application/json' --data '{"enterpriseId":1}' --cookie cookies.txt -X POST https://vco.velocloud.net/portal/rest/event/getEnterpriseEvents

Authentication

The VCO API supports cookie-based authentication. Most programming languages and HTTP client applications expose libraries or options that facilitate the management and use of session cookies, which clients are free to leverage in working with the VCO (e.g. curl exposes the `--cookie-jar` and `--cookie` options, Python's `requests` library exposes a Session interface, etc.). Numerous code samples, wherein authentication is demonstrated in a variety of programming languages, are available via VMware Sample Exchange.

Clients initiate sessions by invoking either the `login/enterpriseLogin` or the `login/operatorLogin` method, depending on the user type associated with the client's credentials (Partner and Customer Admins should use the former method, and Operator Admins the latter). In the event of a successful authentication call, the API responds with an HTTP 200 status code and embeds a `velocloud.session` cookie in a `Set-Cookie` response header. When authentication is unsuccessful, the API responds with an HTTP 302 status code and includes a short message elaborating on the failure in a `velocloud.message` cookie. A sample authentication call is demonstrated with the curl command-line utility below (response truncated for brevity):

curl --cookie-jar /tmp/cookie.txt -i -X POST https://vco.velocloud.net/portal/rest/login/enterpriseLogin --data '{"username":"admin@velocloud.net","password":"'$SECRET'"}'
< HTTP/1.1 200 OK
< Set-Cookie: velocloud.session=<token>; <attributes>

Once a client has successfully retrieved a session cookie, it may begin to make API calls to API methods that require authentication by embedding the `velocloud.session` cookie in a `Cookie` request header (programming languages and other client utilities typically provide interfaces that simplify this).

Session cookies typically expire after a period of 24 hours (though liftetimes are configurable and may vary across VCO deployments). It is considered best practice to invalidate cookies whenever they are no longer required by initiating a call to the `logout` API method:

curl --cookie /tmp/cookie.txt -X POST https://vco.velocloud.net/portal/rest/logout

Data Model & Terminology

The terminology of the VCO API schema doesn't always align with the terminology of the Web Console. Consider this a "cheat sheat" to aid in interpreting API constructs:

Common Parameters

A few parameters appear repeatedly throughout the API schema:

`enterpriseId`

The Portal API enforces that an `enterpriseId` parameter is required on any request initiated by an Operator or Partner Administrator that accesses, or operates upon, a Customer-managed resource (e.g. Edges, Profiles, network services). `enterpriseId` is never required for API calls initiated by Customer Administrators (in such cases it is inferred based on the user's credential).

`enterpriseProxyId`

Similar to the `enterpriseId` parameter, the Portal API enforces that an `enterpriseProxyId` parameter is required on any request initiated by an Operator Administrator that accesses, or operates upon, a Partner-managed resource (e.g. Partner Events, Partner Gateway Pools, etc.). `enterpriseProxyId` is never required for API calls initiated by Partner Administrators (in such cases it is inferred based on the user's credential).

`with`

Many "fetch" API methods support a `with` parameter, which allows the user to optionally resolve related entities. `recentLinks` is a special instance of one such option that is supported by methods that fetch Edges, which will cause the API to resolve WAN links for which activity has been recorded in the last 24 hours. This should generally be preferred to the `links` option on methods where it is supported.

`interval`

Many methods, such as those that query events or volumetric flow data, support a query `interval`. The default query interval, inferred by the server when none is otherwise specified, is the most recent 12 hour period.

The VCO exposes time series data (e.g. device system health metrics such as CPU and memory usage, network metrics such as latency/jitter/loss, volumetric traffic flow data) via various API methods that accept query intervals. By default, Edges and Gateways report new statistics to the Orchestrator every five minutes. Due to various factors (clock drift, network jitter, server-side processing delays), statistics associated with a given interval beginning at time `t` are often not reflected in API output until time `t + 10 minutes`. As such, we do not recommend using query intervals smaller than 10 minutes in time for these methods.

Datetimes

The Orchestrator API uses UTC time universally. Whenever a method request schema calls for a datetime value, and whenever a response includes a datetime value, the timezone should be inferred to be UTC.

The VCO accepts the following datetime formats:


contact: name: VMware SD-WAN by VeloCloud url: https://www.vmware.com/products/sd-wan-by-velocloud.html version: '3.3.2' servers: - url: https://{defaultHost} variables: defaultHost: default: www.example.com/portal/rest paths: /login/operatorLogin: post: tags: - all - login summary: login_operator_login description: "Authenticates an operator user and, upon successful login, returns a velocloud.session cookie. Pass this session cookie in the authentication header in subsequent VCO calls.\n If you are using an HTTP client (e.g. Postman) that is configured to automatically follow HTTP redirects, a successful authentication request will cause your client to follow an HTTP 302 redirect to the portal 'Home' web page. Your session cookie can then be used to make VCO API calls. \n Note that session cookies expire after a period of time specified in the VCO configuration (default is 24 hours)." operationId: login_operator_login parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/auth_object' required: true responses: '200': description: If you are using an HTTP client that is configured to automatically follow HTTP redirects (e.g. Postman), a successful authentication request will cause your client to follow a HTTP 302 redirect to the portal 'Home' web page. Your session cookie may then be used to make API calls. headers: {} content: {} '302': description: An HTTP 302 response is returned on both successful and failed authentication attempts. If the response includes a Set-Cookie header specifying a non-empty velocloud.session cookie, authentication was successful and this cookie may be used to make API calls. headers: {} content: {} deprecated: false /login/enterpriseLogin: post: tags: - all - login summary: login_enterprise_login description: >- Authenticates an enterprise or partner (MSP) user and, upon successful login, returns a velocloud.session cookie. Pass this session cookie in the authentication header in subsequent VCO calls. If you are using an HTTP client (e.g. Postman) that is configured to automatically follow HTTP redirects, a successful authentication request will cause your client to follow an HTTP 302 redirect to the portal 'Home' web page. Your session cookie can then be used to make VCO API calls. Note that session cookies expire after a period of time specified in the VCO configuration (default is 24 hours). operationId: login_enterprise_login parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/auth_object' required: true responses: '200': description: If you are using an HTTP client that is configured to automatically follow HTTP redirects (e.g. Postman), a successful authentication request will cause your client to follow an HTTP 302 redirect to the portal 'Home' web page. Your session cookie may then be used to make API calls. headers: {} content: {} '302': description: An HTTP 302 response is returned on both successful and failed authentication attempts. If the response includes a Set-Cookie header specifying a non-empty velocloud.session cookie, authentication was successful and this cookie may be used to make API calls. headers: {} content: {} deprecated: false /logout: post: tags: - all - login summary: logout description: Logs out the VCO API user and invalidates the session cookie. operationId: logout parameters: [] responses: '200': description: If you are using an HTTP client that is configured to automatically follow HTTP redirects (e.g. Postman), a successful logout request will cause your client to follow an HTTP 302 redirect to the portal login web page. headers: {} content: {} '302': description: An HTTP 302 (redirect) response is returned on both successful and failed logout attempts. headers: {} content: {} deprecated: false /meta/{apiPath}: post: tags: - all - meta summary: meta description: Gets the Swagger specification for any VCO API call. operationId: meta parameters: - name: apiPath in: path description: the path to another api method, starting after /rest/ required: true style: simple schema: type: string responses: '200': description: Request successful headers: {} content: application/json: schema: $ref: '#/components/schemas/metaResponse' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: true /configuration/cloneEnterpriseTemplate: post: tags: - all - configuration summary: configuration_clone_enterprise_template description: >- Creates a new enterprise configuration from the enterprise default configuration. On success, returns the `id` of the newly created configuration object. Privileges required: `CREATE` `ENTERPRISE_PROFILE`, or `CREATE` `OPERATOR_PROFILE` operationId: configuration_clone_enterprise_template parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/configuration_clone_enterprise_template' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/configuration_clone_enterprise_template_result' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /configuration/deleteConfiguration: post: tags: - all - configuration summary: configuration_delete_configuration description: >- Deletes the specified configuration profile (by `id`). On success, returns an object indicating the number of objects (rows) deleted (1 or 0). Privileges required: `DELETE` `ENTERPRISE_PROFILE`, or `DELETE` `OPERATOR_PROFILE` operationId: configuration_delete_configuration parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/configuration_delete_configuration' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/deletion_confirmation' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /configuration/getConfiguration: post: tags: - all - configuration summary: configuration_get_configuration description: >- Gets the specified configuration profile, optionally with module details. Privileges required: `READ` `ENTERPRISE_PROFILE`, or `READ` `OPERATOR_PROFILE` operationId: configuration_get_configuration parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/configuration_get_configuration' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/configuration_get_configuration_result' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /configuration/getIdentifiableApplications: post: tags: - all - configuration summary: configuration_get_identifiable_applications description: >- Gets all applications that are identifiable through DPI. If called from an operator or MSP context, then `enterpriseId` is required. Privileges required: `READ` `ENTERPRISE_PROFILE` operationId: configuration_get_identifiable_applications parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/enterprise_get_enterprise_configurations_with_policies' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/configuration_get_identifiable_applications_result' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /configuration/getRoutableApplications: post: tags: - all - configuration summary: configuration_get_routable_applications description: >- Gets all applications that are first packet routable. If called from an operator or MSP context, then `enterpriseId` is required.Optionally, specify `edgeId` to get the map for a specific Edge. Privileges required: `VIEW_FLOW_STATS` `undefined` operationId: configuration_get_routable_applications parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/configuration_get_routable_applications' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/configuration_get_routable_applications_result' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /disasterRecovery/configureActiveForReplication: post: tags: - all - disasterRecovery summary: disaster_recovery_configure_active_for_replication description: >- Configures the current Orchestrator to be active and the specified Orchestrator to be standby for Orchestrator disaster recovery replication. Required attributes: 1) `standbyList`, a single-entry array containing the `standbyAddress` and `standbyUuid`, 2) `drVCOUser`, a Orchestrator super user available on both the active and standby VCOs, and 3) `drVCOPassword`, the password of `drVCOUser` on the standby Orchestrator (unless the `autoConfigStandby` option is specified as `false`). The call sets up the active Orchestrator to allow replication from the standby and then (unless `autoConfigStandby` is `false`) makes a `transitionToStandby` API call to the specified standby, expected to have been previously placed in `STANDBY_CANDIDATE` state via `prepareForStandby`. After this call, the active and standby VCOs should be polled via `getReplicationStatus` until they both reach `STANDBY_RUNNING` `drState` (or a configuration error is reported). (Note: `drVCOPassword` is not persisted.) Privileges required: `CREATE` `REPLICATION` operationId: disaster_recovery_configure_active_for_replication parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/disaster_recovery_configure_active_for_replication' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/rows_modified_confirmation' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /disasterRecovery/demoteActive: post: tags: - all - disasterRecovery summary: disaster_recovery_demote_active description: >- Demotes the current VCO from active to zombie. No input parameters are required. The active server is expected to be in the `drState` `FAILURE_GET_STANDBY_STATUS` or `FAILURE_MYSQL_ACTIVE_STATUS`, meaning that DR protection had been engaged (with the last successful replication status observed at `lastDRProtectedTime`) but that active failed a health check since that time. If the active server is in the `drState` `STANDBY_RUNNING`, meaning that it has detected no problems in interacting with the standby server, the operator can force demotion of the active using the optional `force` parameter passed with value of `true`; in this case, the operator must ensure that the standby server has already been successfully promoted. Privileges required: `CREATE` `REPLICATION` operationId: disaster_recovery_demote_active parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/disaster_recovery_demote_active' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/rows_modified_confirmation' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /disasterRecovery/getReplicationBlob: post: tags: - all - disasterRecovery summary: disaster_recovery_get_replication_blob description: >- Gets from the active Orchestrator the blob needed to configure replication on the standby. Used only when `configureActiveForReplication` was called with `autoConfigStandby` set to `false` [`true` by default]. Privileges required: `CREATE` `REPLICATION` operationId: disaster_recovery_get_replication_blob parameters: [] requestBody: description: '' content: text/plain: schema: type: object required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/disaster_recovery_get_replication_blob_result' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /disasterRecovery/getReplicationStatus: post: tags: - all - disasterRecovery summary: disaster_recovery_get_replication_status description: >- Gets the disaster recovery replication status, optionally with client contact, state transition history, and storage information. No input parameters are required. Can optionally specify one or more of the following `with` parameters: `clientContact`, `clientCount`, `stateHistory`, and `storageInfo`. Privileges required: `READ` `REPLICATION` operationId: disaster_recovery_get_replication_status parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/disaster_recovery_get_replication_status' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/disaster_recovery_get_replication_status_result' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /disasterRecovery/prepareForStandby: post: tags: - all - disasterRecovery summary: disaster_recovery_prepare_for_standby description: >- Transitions the current Orchestrator to a quiesced state, ready to be configured as a standby system. No input parameters are required. After this call, the Orchestrator will be restarted in standby mode. The caller should subsequently poll `getReplicationStatus` until `drState` is `STANDBY_CANDIDATE`. This is the first step in configuring Orchestrator disaster recovery. Privileges required: `CREATE` `REPLICATION` operationId: disaster_recovery_prepare_for_standby parameters: [] requestBody: description: '' content: text/plain: schema: type: object required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/rows_modified_confirmation' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /disasterRecovery/promoteStandbyToActive: post: tags: - all - disasterRecovery summary: disaster_recovery_promote_standby_to_active description: "Promotes the current server to take over as the single standalone VCO. The current server is expected to be a standby in the `drState` `FAILURE_MYSQL_STANDBY_STATUS`, meaning that DR protection had been engaged (with the last successful replication status observed at `lastDRProtectedTime`), but that standby has been unable to replicate since that time. \n If the standby server is in the `drState` `STANDBY_RUNNING`, meaning that it has detected no problems in replicating from the active server, the operator can force promotion of the standby using the optional `force` parameter passed with a value of `true`. In this case, the standby server will call `demoteActive/force` on the active server. The operator should, if possible, ensure that the formerly active server is demoted by running `demoteServer` directly on that server if the standby server was unable to do so successfully.\n\nPrivileges required:\n\n`CREATE` `REPLICATION`" operationId: disaster_recovery_promote_standby_to_active parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/disaster_recovery_promote_standby_to_active' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/rows_modified_confirmation' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /disasterRecovery/removeStandby: post: tags: - all - disasterRecovery summary: disaster_recovery_remove_standby description: >- Removes disaster recovery on the current server. In addition, makes a best-effort call to `removeStandby` on the paired disaster recovery server. No input parameters are required. Privileges required: `CREATE` `REPLICATION` operationId: disaster_recovery_remove_standby parameters: [] requestBody: description: '' content: text/plain: schema: type: object required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/rows_modified_confirmation' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /disasterRecovery/transitionToStandby: post: tags: - all - disasterRecovery summary: disaster_recovery_transition_to_standby description: >- Configures the current Orchestrator to transition to standby in a disaster recovery active/standby pair. Requires the `activeAccessFromStandby` parameter that contains the data needed to configure standby. This data is produced by `configureActiveForReplication`, which by default automatically calls `transitionToStandby`; an explicit call is needed (with a blob obtained from `getReplicationBlob`), only if `configureActiveForReplication` is called with `autoConfigStandby` set to `false`. Privileges required: `CREATE` `REPLICATION` operationId: disaster_recovery_transition_to_standby parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/disaster_recovery_transition_to_standby' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/rows_modified_confirmation' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /edge/deleteEdge: post: tags: - all - edge summary: edge_delete_edge description: >- Deletes the specified Edge(s) (by `id` or an array of `ids`). Privileges required: `DELETE` `EDGE` operationId: edge_delete_edge parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/edge_delete_edge' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/deletion_confirmation' description: '' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /edge/deleteEdgeBgpNeighborRecords: post: tags: - all - edge summary: edge_delete_edge_bgp_neighbor_records description: >- Deletes BGP record(s) matching the specified record keys (`neighborIp`) on the Edges with the specified `edgeId`s, if they exist. Privileges required: `DELETE` `NETWORK_SERVICE` operationId: edge_delete_edge_bgp_neighbor_records parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/edge_delete_edge_bgp_neighbor_records' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/deletion_confirmation' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /edge/setEdgeEnterpriseConfiguration: post: tags: - all - edge summary: edge_set_edge_enterprise_configuration description: >- Sets the enterprise configuration for the specified Edge (by `edgeId`). Privileges required: `UPDATE` `EDGE` `UPDATE` `ENTERPRISE_PROFILE` operationId: edge_set_edge_enterprise_configuration parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/edge_set_edge_enterprise_configuration' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/insertion_confirmation' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /edge/setEdgeHandOffGateways: post: tags: - all - edge summary: edge_set_edge_hand_off_gateways description: >- Sets the on-premise hand off gateways for the specified Edge (by `edgeId`). A primary and secondary gateway are defined. The primary is required, the secondary is optional. Moves all existing Edge-gateway hand-off relationships and replaces them with the specified primary and secondary gateways. Privileges required: `UPDATE` `EDGE` operationId: edge_set_edge_hand_off_gateways parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/edge_set_edge_hand_off_gateways' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/rows_modified_confirmation' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /edge/setEdgeOperatorConfiguration: post: tags: - all - edge summary: edge_set_edge_operator_configuration description: >- Sets the operator configuration for the specified Edge (by `edgeId`). This overrides any enterprise-assigned operator configuration and the network default operator configuration. Privileges required: `UPDATE` `EDGE` `READ` `OPERATOR_PROFILE` operationId: edge_set_edge_operator_configuration parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/edge_set_edge_operator_configuration' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/insertion_confirmation' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /enterprise/deleteEnterprise: post: tags: - all - enterprise summary: enterprise_delete_enterprise description: >- Deletes the specified enterprise (by `id` or `enterpriseId`). Privileges required: `DELETE` `ENTERPRISE` operationId: enterprise_delete_enterprise parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/enterprise_get_enterprise_configurations_with_policies' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/deletion_confirmation' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /enterprise/deleteEnterpriseGatewayRecords: post: tags: - all - enterprise summary: enterprise_delete_enterprise_gateway_records description: >- Deletes the enterprise gateway BGP neighbor record(s) matching the specified gateway id(s) (`gatewayId`) and neighbor IP addresses (`neighborIp`). Privileges required: `DELETE` `NETWORK_SERVICE` operationId: enterprise_delete_enterprise_gateway_records parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/enterprise_delete_enterprise_gateway_records' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/deletion_confirmation' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /enterprise/deleteEnterpriseNetworkAllocation: post: tags: - all - enterprise summary: enterprise_delete_enterprise_network_allocation description: >- Deletes the specified enterprise network allocation (by `id`). Privileges required: `DELETE` `NETWORK_ALLOCATION` operationId: enterprise_delete_enterprise_network_allocation parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/enterprise_delete_enterprise_network_allocation' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/deletion_confirmation' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /enterprise/deleteEnterpriseNetworkSegment: post: tags: - all - enterprise summary: enterprise_delete_enterprise_network_segment description: >- Delete an enterprise network segment, by id. Privileges required: `DELETE` `NETWORK_ALLOCATION` operationId: enterprise_delete_enterprise_network_segment parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/enterprise_delete_enterprise_network_segment' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/deletion_confirmation' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /enterprise/deleteEnterpriseService: post: tags: - all - enterprise summary: enterprise_delete_enterprise_service description: >- Deletes the specified enterprise network service (by `id`). Privileges required: `DELETE` `NETWORK_SERVICE` operationId: enterprise_delete_enterprise_service parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/enterprise_delete_enterprise_service' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/deletion_confirmation' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /enterprise/getEnterpriseAddresses: post: tags: - all - enterprise summary: enterprise_get_enterprise_addresses description: >- Gets all public IP address information for the management and control entities associated with the specified enterprise, including Orchestrator(s), Gateway(s), and datacenter(s). Privileges required: `READ` `ENTERPRISE` operationId: enterprise_get_enterprise_addresses parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/enterprise_get_enterprise_addresses' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/enterprise_get_enterprise_addresses_result_item' description: '' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /enterprise/getEnterpriseAlertConfigurations: post: tags: - all - enterprise summary: enterprise_get_enterprise_alert_configurations description: >- Gets all alert configuration(s) for the specified enterprise. Privileges required: `READ` `ENTERPRISE_ALERT` operationId: enterprise_get_enterprise_alert_configurations parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/enterprise_get_enterprise_configurations_with_policies' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/enterprise_get_enterprise_alert_configurations_result_item' description: '' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /enterprise/getEnterpriseAlerts: post: tags: - all - enterprise summary: enterprise_get_enterprise_alerts description: >- Gets past triggered alerts for the specified enterprise. Privileges required: `READ` `ENTERPRISE_ALERT` operationId: enterprise_get_enterprise_alerts parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/enterprise_get_enterprise_alerts' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/enterprise_get_enterprise_alerts_result' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /enterprise/getEnterpriseAllAlertsRecipients: post: tags: - all - enterprise summary: enterprise_get_enterprise_all_alert_recipients description: >- Gets all recipients configured to receive all alerts for the specified enterprise. Privileges required: `READ` `ENTERPRISE_ALERT` operationId: enterprise_get_enterprise_all_alert_recipients parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/enterprise_get_enterprise_configurations_with_policies' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/enterprise_get_enterprise_all_alert_recipients_result' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /enterprise/getEnterpriseConfigurations: post: tags: - all - enterprise summary: enterprise_get_enterprise_configurations description: >- Gets all configuration profiles, with optional Edge and/or module details, for the specified enterprise. Privileges required: `READ` `ENTERPRISE_PROFILE` operationId: enterprise_get_enterprise_configurations parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/enterprise_get_enterprise_configurations' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/enterprise_get_enterprise_configurations_result_item' description: '' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /enterprise/getEnterpriseNetworkAllocations: post: tags: - all - enterprise summary: enterprise_get_enterprise_network_allocations description: >- Gets all network allocations for the specified enterprise. Privileges required: `READ` `NETWORK_ALLOCATION` operationId: enterprise_get_enterprise_network_allocations parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/enterprise_get_enterprise_network_allocations' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/enterprise_object_base' description: '' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /enterprise/getEnterpriseNetworkSegments: post: tags: - all - enterprise summary: enterprise_get_enterprise_network_segments description: >- Retrieve a list of all of the network segments defined forthe given enterprise. Privileges required: `READ` `NETWORK_ALLOCATION` operationId: enterprise_get_enterprise_network_segments parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/enterprise_get_enterprise_network_segments' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/enterprise_get_enterprise_network_segments_result_item' description: '' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /enterprise/getEnterpriseRouteConfiguration: post: tags: - all - enterprise summary: enterprise_get_enterprise_route_configuration description: >- Gets all global routing preferences for the specified enterprise, incuding enterprise route advertisement, routing preferences, OSPF, and BGP advertisement policy. Privileges required: `READ` `ENTERPRISE_PROFILE` operationId: enterprise_get_enterprise_route_configuration parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/enterprise_get_enterprise_configurations_with_policies' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/enterprise_object_base' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /enterprise/getEnterpriseRouteTable: post: tags: - all - enterprise summary: enterprise_get_enterprise_route_table description: >- 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` operationId: enterprise_get_enterprise_route_table parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/enterprise_get_enterprise_route_table' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/enterprise_get_enterprise_route_table_result' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /enterprise/getEnterpriseServices: post: tags: - all - enterprise summary: enterprise_get_enterprise_services description: >- Gets all network service JSON objects defined for the specified enterprise. Privileges required: `READ` `NETWORK_SERVICE` operationId: enterprise_get_enterprise_services parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/enterprise_get_enterprise_services' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/enterprise_get_enterprise_services_result_item' description: '' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /enterprise/insertEnterpriseService: post: tags: - all - enterprise summary: enterprise_insert_enterprise_service description: >- Creates a new enterprise service for the specified enterprise. Privileges required: `CREATE` `NETWORK_SERVICE` operationId: enterprise_insert_enterprise_service parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/enterprise_insert_enterprise_service' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/insertion_confirmation' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /enterprise/insertOrUpdateEnterpriseAlertConfigurations: post: tags: - all - enterprise summary: enterprise_insert_or_update_enterprise_alert_configurations description: >- Creates, updates, or deletes alert configurations for the specified enterprise. Returns the array of alert configurations submitted, with ids added for the entries that have been successfully created. If an entry is not successfully created or updated, an `error` property is included in the response. Privileges required: `CREATE` `ENTERPRISE_ALERT` operationId: enterprise_insert_or_update_enterprise_alert_configurations parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/enterprise_insert_or_update_enterprise_alert_configurations' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/enterprise_insert_or_update_enterprise_alert_configurations_result' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /enterprise/setEnterpriseAllAlertsRecipients: post: tags: - all - enterprise summary: enterprise_set_enterprise_all_alert_recipients description: >- Specifies the recipients who should receive all alerts for the specified enterprise. Privileges required: `UPDATE` `ENTERPRISE_ALERT` operationId: enterprise_set_enterprise_all_alert_recipients parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/enterprise_set_enterprise_all_alert_recipients' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/enterprise_get_enterprise_all_alert_recipients_result' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /enterprise/setEnterpriseOperatorConfiguration: post: tags: - all - enterprise summary: enterprise_set_enterprise_operator_configuration description: >- Sets the operator configuration for the specified enterprise (by `enterpriseId`). This overrides any network-assigned operator configuration and the network default operator configuration. Privileges required: `UPDATE` `ENTERPRISE` operationId: enterprise_set_enterprise_operator_configuration parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/enterprise_set_enterprise_operator_configuration' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/insertion_confirmation' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /enterprise/updateEnterpriseRoute: post: tags: - all - enterprise summary: enterprise_update_enterprise_route description: >- Updates the specified enterprise route, set advertisement, and cost values. Required parameters include the original route, as returned by `enterprise/getEnterpriseRouteTable`, and the updated route with modified advertisement and route preference ordering. Privileges required: `UPDATE` `ENTERPRISE_PROFILE` operationId: enterprise_update_enterprise_route parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/enterprise_update_enterprise_route' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/enterprise_update_enterprise_route_result' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /enterprise/updateEnterpriseRouteConfiguration: post: tags: - all - enterprise summary: enterprise_update_enterprise_route_configuration description: >- Updates the specified enterprise global routing preferences as specified by configuration `id` or logicalId. Privileges required: `UPDATE` `ENTERPRISE_PROFILE` operationId: enterprise_update_enterprise_route_configuration parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/enterprise_update_enterprise_route_configuration' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/rows_modified_confirmation' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /enterprise/updateEnterpriseService: post: tags: - all - enterprise summary: enterprise_update_enterprise_service description: >- Updates the enterprise service for the specified enterprise (by `id` or `enterpriseId`). Expects an `_update` object containing the field(s) to be updated and their corresponding value(s). Privileges required: `UPDATE` `NETWORK_SERVICE` operationId: enterprise_update_enterprise_service parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/enterprise_update_enterprise_service' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/rows_modified_confirmation' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /enterpriseProxy/deleteEnterpriseProxyUser: post: tags: - all - userMaintenance summary: enterprise_proxy_delete_enterprise_proxy_user description: >- Deletes the specified enterprise proxy user (by `id` or `username`). Note: `enterpriseProxyId` is a required parameter when invoking this method as an operator or as a partner user. Privileges required: `DELETE` `PROXY_USER` operationId: enterprise_proxy_delete_enterprise_proxy_user parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/enterprise_proxy_delete_enterprise_proxy_user' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/rows_modified_confirmation' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /enterpriseProxy/getEnterpriseProxyEdgeInventory: post: tags: - all - enterpriseProxy summary: enterprise_proxy_get_enterprise_proxy_edge_inventory description: >- Gets all partner enterprises and their associated Edge inventory. Privileges required: `READ` `ENTERPRISE` operationId: enterprise_proxy_get_enterprise_proxy_edge_inventory parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/enterprise_proxy_get_enterprise_proxy_edge_inventory' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/proxy_edge_inventory_object' description: '' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /enterpriseProxy/getEnterpriseProxyEnterprises: post: tags: - all - enterpriseProxy summary: enterprise_proxy_get_enterprise_proxy_enterprises description: >- Gets all partner enterprises. Optionally includes all Edges or Edge counts. Privileges required: `READ` `ENTERPRISE` operationId: enterprise_proxy_get_enterprise_proxy_enterprises parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/enterprise_proxy_get_enterprise_proxy_enterprises' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/enterprise_proxy_get_enterprise_proxy_enterprises_result_item' description: '' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /enterpriseProxy/getEnterpriseProxyGatewayPools: post: tags: - all - enterpriseProxy summary: enterprise_proxy_get_enterprise_proxy_gateway_pools description: >- Gets all gateway pools associated with the specified enterprise proxy. Optionally includes all gateways or enterprises belonging to each pool. Privileges required: `READ` `GATEWAY` operationId: enterprise_proxy_get_enterprise_proxy_gateway_pools parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/enterprise_proxy_get_enterprise_proxy_gateway_pools' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/enterprise_proxy_get_enterprise_proxy_gateway_pools_result_item' description: '' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /enterpriseProxy/getEnterpriseProxyOperatorProfiles: post: tags: - all - enterpriseProxy summary: enterprise_proxy_get_enterprise_proxy_operator_profiles description: >- Gets all operator profiles associated with the specified partner (MSP), as assigned by the operator. Privileges required: `READ` `OPERATOR_PROFILE` operationId: enterprise_proxy_get_enterprise_proxy_operator_profiles parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/enterprise_proxy_get_enterprise_proxy_operator_profiles' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/enterprise_proxy_get_enterprise_proxy_operator_profiles_result_item' description: '' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /enterpriseProxy/getEnterpriseProxyUser: post: tags: - all - userMaintenance summary: enterprise_proxy_get_enterprise_proxy_user description: >- Gets the specified enterprise proxy user (by `id` or `username`). Privileges required: `READ` `PROXY_USER` `READ` `PROXY` operationId: enterprise_proxy_get_enterprise_proxy_user parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/enterprise_proxy_get_enterprise_proxy_user' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/enterprise_proxy_get_enterprise_proxy_user_result' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /enterpriseProxy/insertEnterpriseProxyUser: post: tags: - all - userMaintenance summary: enterprise_proxy_insert_enterprise_proxy_user description: >- Creates a new partner admin user. Privileges required: `CREATE` `PROXY_USER` operationId: enterprise_proxy_insert_enterprise_proxy_user parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/new_enterprise_user' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/insertion_confirmation' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /enterpriseProxy/updateEnterpriseProxyUser: post: tags: - all - userMaintenance summary: enterprise_proxy_update_enterprise_proxy_user description: >- Updates the specified enterprise proxy admin user (by object `id` or other identifying attribute). Expects an `_update` object containing the field(s) to be updated and their corresponding value(s). Privileges required: `UPDATE` `PROXY_USER` operationId: enterprise_proxy_update_enterprise_proxy_user parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/enterprise_proxy_update_enterprise_proxy_user' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/rows_modified_confirmation' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /enterpriseUser/deleteEnterpriseUser: post: tags: - all - userMaintenance summary: enterprise_user_delete_enterprise_user description: >- Deletes the specified enterprise user (by `id` or `username`). Note: `enterpriseId` is a required parameter when invoking this method as an operator or as a partner user. Privileges required: `DELETE` `ENTERPRISE_USER` operationId: enterprise_user_delete_enterprise_user parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/enterprise_user_delete_enterprise_user' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/deletion_confirmation' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /enterpriseUser/getEnterpriseUser: post: tags: - all - userMaintenance summary: enterprise_user_get_enterprise_user description: >- Gets the specified enterprise user (by `id` or `username`). Privileges required: `READ` `ENTERPRISE_USER` operationId: enterprise_user_get_enterprise_user parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/enterprise_user_get_enterprise_user' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/enterprise_user_get_enterprise_user_result' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /enterpriseUser/updateEnterpriseUser: post: tags: - all - userMaintenance summary: enterprise_user_update_enterprise_user description: >- Updates the specified enterprise user (by object `id` or other identifying attribute). Expects an `_update` object containing the field(s) to be updated and their corresponding value(s). Privileges required: `UPDATE` `ENTERPRISE_USER`, or `UPDATE` `OPERATOR_USER` operationId: enterprise_user_update_enterprise_user parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/enterprise_user_update_enterprise_user1' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/rows_modified_confirmation' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /metrics/getEdgeAppLinkMetrics: post: tags: - all - metrics summary: metrics_get_edge_app_link_metrics description: >- Gets flow metric summaries for the specified time interval by link. On success, this method returns an array of flow data in which each entry corresponds to a link on the specified Edge. In the request body, the `id` and `edgeId` property names are interchangeable. The `enterpriseId` property is required when this method is invoked in the operator context. Privileges required: `READ` `EDGE` `VIEW_FLOW_STATS` `undefined` operationId: metrics_get_edge_app_link_metrics parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/metrics_get_edge_app_link_metrics' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/metrics_get_edge_app_link_metrics_result_item' description: '' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /metrics/getEdgeAppLinkSeries: post: tags: - all - metrics summary: metrics_get_edge_app_link_series description: >- Gets flow metric time series data for the specified time interval by link. On success, this method returns an array of flow data in which each entry corresponds to a link on the specified Edge. In the request body, the `id` and `edgeId` property names are interchangeable. The `enterpriseId` property is required when this method is invoked in the operator context. Privileges required: `READ` `EDGE` `VIEW_FLOW_STATS` `undefined` operationId: metrics_get_edge_app_link_series parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/metrics_get_edge_app_link_series' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/metrics_get_edge_app_link_series_result_item' description: '' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /metrics/getEdgeAppMetrics: post: tags: - all - metrics summary: metrics_get_edge_app_metrics description: >- Gets flow metric summaries for the specified Edge over the specified time interval by application. On success, this method returns an array of flow data in which each entry corresponds to a single application. Privileges required: `READ` `EDGE` `VIEW_FLOW_STATS` `undefined` operationId: metrics_get_edge_app_metrics parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/metrics_get_edge_app_metrics' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/metrics_get_edge_app_metrics_result_item' description: '' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /metrics/getEdgeAppSeries: post: tags: - all - metrics summary: metrics_get_edge_app_series description: >- Gets flow metric time series data for the specified time interval by application. On success, this method returns an array of flow data in which each entry corresponds to a single application. Privileges required: `READ` `EDGE` `VIEW_FLOW_STATS` `undefined` operationId: metrics_get_edge_app_series parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/metrics_get_edge_app_series' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/metrics_get_edge_app_series_result_item' description: '' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /metrics/getEdgeCategoryMetrics: post: tags: - all - metrics summary: metrics_get_edge_category_metrics description: >- Gets flow metric summaries for the specified time interval by application category. On success, this method returns an array of flow data in which each entry corresponds to a category of application traffic that has traversed the specified Edge. In the request body, the `id` and `edgeId` property names are interchangeable. The `enterpriseId` property is required when this method is invoked in the operator context. Privileges required: `READ` `EDGE` `VIEW_FLOW_STATS` `undefined` operationId: metrics_get_edge_category_metrics parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/metrics_get_edge_category_metrics' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/metrics_get_edge_category_metrics_result_item' description: '' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /metrics/getEdgeCategorySeries: post: tags: - all - metrics summary: metrics_get_edge_category_series description: >- Gets flow metric time series data for the specified time interval by application category. On success, this method returns an array of flow data in which each entry corresponds to a category of application traffic that has traversed the specified Edge. In the request body, the `id` and `edgeId` property names are interchangeable. The `enterpriseId` property is required when this method is invoked in the operator context. Privileges required: `READ` `EDGE` `VIEW_FLOW_STATS` `undefined` operationId: metrics_get_edge_category_series parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/metrics_get_edge_category_series' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/metrics_get_edge_category_series_result_item' description: '' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /metrics/getEdgeDestMetrics: post: tags: - all - metrics summary: metrics_get_edge_dest_metrics description: >- Gets flow metric summaries for the specified time interval by destination. On success, this method returns an array of flow data in which each entry corresponds to a distinct traffic destination. In the request body, the `id` and `edgeId` property names are interchangeable. The `enterpriseId` property is required when this method is invoked in the operator context. Privileges required: `READ` `EDGE` `VIEW_FLOW_STATS` `undefined` operationId: metrics_get_edge_dest_metrics parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/metrics_get_edge_dest_metrics' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/metrics_get_edge_dest_metrics_result_item' description: '' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /metrics/getEdgeDestSeries: post: tags: - all - metrics summary: metrics_get_edge_dest_series description: >- Gets flow metric time series data for the specified time interval by destination. On success, this method returns an array of flow data in which each entry corresponds to a distinct traffic destination. In the request body, the `id` and `edgeId` property names are interchangeable. The `enterpriseId` property is required when this method is invoked in the operator context. Privileges required: `READ` `EDGE` `VIEW_FLOW_STATS` `undefined` operationId: metrics_get_edge_dest_series parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/metrics_get_edge_dest_series' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/metrics_get_edge_dest_series_result_item' description: '' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /metrics/getEdgeDeviceMetrics: post: tags: - all - metrics summary: metrics_get_edge_device_metrics description: >- Gets flow metric summaries for the specified time interval by client device. On success, this method returns an array of flow data in which each entry corresponds to a distinct device. In the request body, the `id` and `edgeId` property names are interchangeable. The `enterpriseId` property is required when this method is invoked in the operator context. Privileges required: `READ` `EDGE` `VIEW_USER_IDENTIFIABLE_FLOW_STATS` `undefined` operationId: metrics_get_edge_device_metrics parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/metrics_get_edge_device_metrics' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/metrics_get_edge_device_metrics_result_item' description: '' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /metrics/getEdgeDeviceSeries: post: tags: - all - metrics summary: metrics_get_edge_device_series description: >- Gets flow metric time series data for the specified time interval by client device. On success, this method returns an array of flow data in which each entry corresponds to a distinct device. In the request body, the `id` and `edgeId` property names are interchangeable. The `enterpriseId` property is required when this method is invoked in the operator context. Privileges required: `READ` `EDGE` `VIEW_USER_IDENTIFIABLE_FLOW_STATS` `undefined` operationId: metrics_get_edge_device_series parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/metrics_get_edge_device_series' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/metrics_get_edge_device_series_result_item' description: '' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /metrics/getEdgeLinkMetrics: post: tags: - all - metrics summary: metrics_get_edge_link_metrics description: >- Fetches summary transport metrics by link for the specified Edge over the specified time interval. On success, this method returns an array where each entry corresponds to a WAN link for which the Edge reported some activity over the time period covered by the request interval. Privileges required: `READ` `EDGE` operationId: metrics_get_edge_link_metrics parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/metrics_get_edge_link_metrics' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/metrics_get_edge_link_metrics_result_item' description: '' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /metrics/getEdgeLinkSeries: post: tags: - all - metrics summary: metrics_get_edge_link_series description: >- Fetches link/transport metric time series data for WAN links belonging to the specified Edge over the specified interval. On success, this method returns an array where each entry corresponds to a link on the specified Edge. Privileges required: `READ` `EDGE` operationId: metrics_get_edge_link_series parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/metrics_get_edge_link_series' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/metrics_get_edge_link_series_result_item' description: '' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /metrics/getEdgeOsMetrics: post: tags: - all - metrics summary: metrics_get_edge_os_metrics description: >- Gets flow metric summaries for the specified time interval by client OS. On success, this method returns an array of flow data in which each entry corresponds to a distinct OS on a client device. In the request body, the `id` and `edgeId` property names are interchangeable. The `enterpriseId` property is required when this method is invoked in the operator context. Privileges required: `READ` `EDGE` `VIEW_FLOW_STATS` `undefined` operationId: metrics_get_edge_os_metrics parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/metrics_get_edge_os_metrics' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/metrics_get_edge_os_metrics_result_item' description: '' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /metrics/getEdgeOsSeries: post: tags: - all - metrics summary: metrics_get_edge_os_series description: >- Gets flow metric time series data for the specified time interval by client OS. On success, this method returns an array of flow data in which each entry corresponds to a distinct OS on a client device. In the request body, the `id` and `edgeId` property names are interchangeable. The `enterpriseId` property is required when this method is invoked in the operator context. Privileges required: `READ` `EDGE` `VIEW_FLOW_STATS` `undefined` operationId: metrics_get_edge_os_series parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/metrics_get_edge_os_series' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/metrics_get_edge_os_series_result_item' description: '' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /metrics/getEdgeSegmentMetrics: post: tags: - all - metrics summary: metrics_get_edge_segment_metrics description: >- Gets flow metric summaries for the specified time interval by segment id. On success, this method returns an array of flow data where each entry corresponds to a segment id traffic that has traversed the specified Edge. In the request body, the `id` and `edgeId` property names are interchangeable. The `enterpriseId` property is required when this method is invoked in the operator context. Privileges required: `READ` `EDGE` `VIEW_FLOW_STATS` `undefined` operationId: metrics_get_edge_segment_metrics parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/metrics_get_edge_segment_metrics' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/metrics_get_edge_segment_metrics_result_item' description: '' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /metrics/getEdgeSegmentSeries: post: tags: - all - metrics summary: metrics_get_edge_segment_series description: >- Gets flow metric time series data for the specified time interval by segment id. On success, this method returns an array of flow data in which each entry corresponds to a segment id of traffic that has traversed the specified Edge. In the request body, the `id` and `edgeId` property names are interchangeable. The `enterpriseId` property is required when this method is invoked in the operator context. Privileges required: `READ` `EDGE` `VIEW_FLOW_STATS` `undefined` operationId: metrics_get_edge_segment_series parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/metrics_get_edge_segment_series' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/metrics_get_edge_segment_series_result_item' description: '' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /metrics/getEdgeStatusMetrics: post: tags: - all - metrics summary: metrics_get_edge_status_metrics description: >- Fetch healthStats metric summaries for the given edge, time interval and list of metrics. On success, this method returns anhealthsStats object with min, max and average values of requested metrics Privileges required: `READ` `EDGE` operationId: metrics_get_edge_status_metrics parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/metrics_get_edge_status_metrics' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/edge_status_metrics_summary' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /metrics/getEdgeStatusSeries: post: tags: - all - metrics summary: metrics_get_edge_status_series description: >- Fetch healthStats time series for the given edge, time interval and list of metrics. On success, this method returns anarray of healthsStats series of requested metrics Privileges required: `READ` `EDGE` operationId: metrics_get_edge_status_series parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/metrics_get_edge_status_series' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/edge_status_metrics_time_series_result' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /metrics/getGatewayStatusMetrics: post: tags: - all - metrics summary: metrics_get_gateway_status_metrics description: >- Fetch health metric summaries given a target gateway, time interval and list of metrics. On success, this method returns an object containing min, max and average values of requested metrics Privileges required: `READ` `GATEWAY` operationId: metrics_get_gateway_status_metrics parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/metrics_get_gateway_status_metrics' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/metrics_get_gateway_status_metrics_result' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /metrics/getGatewayStatusSeries: post: tags: - all - metrics summary: metrics_get_gateway_status_series description: >- Fetch health metric time series given a target gateway, time interval and list of metrics. On success, this method returns an array of time series, one per metric. Privileges required: `READ` `GATEWAY` operationId: metrics_get_gateway_status_series parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/metrics_get_gateway_status_series' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/gateway_status_metrics_time_series_result' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /monitoring/getAggregateEdgeLinkMetrics: post: tags: - all - monitoring summary: monitoring_get_aggregate_edge_link_metrics description: >- Gets aggregate link/transport metrics for all active Edge WAN links (across all Edges available for the specified Enterprises) over the specified interval. A link is considered to be active if an Edge has reported any activity for it in the last 24 hours. On success, this method returns an array of network utilization metrics where each element corresponds to a link. Privileges required: `READ` `ENTERPRISE` `READ` `EDGE` operationId: monitoring_get_aggregate_edge_link_metrics parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/monitoring_get_aggregate_edge_link_metrics' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/monitoring_get_aggregate_edge_link_metrics_result_item' description: '' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /monitoring/getAggregateEnterpriseEvents: post: tags: - all - monitoring summary: monitoring_get_aggregate_enterprise_events description: >- Gets events across all enterprises in a paginated list. When called in the MSP/Partner context, queries only enterprises managed by the MSP. Privileges required: `READ` `ENTERPRISE` `READ` `EDGE` operationId: monitoring_get_aggregate_enterprise_events parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/monitoring_get_aggregate_enterprise_events' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/monitoring_get_aggregate_enterprise_events_result' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /monitoring/getAggregates: post: tags: - all - monitoring summary: monitoring_get_aggregates description: >- Gets a comprehensive listing of all enterprises and Edges on a network. Returns an object containing an aggregate `edgeCount`, a list (`enterprises`) containing enterprise objects, and a map (`edges`) that provides Edge counts per enterprise. Privileges required: `READ` `ENTERPRISE` `READ` `EDGE` operationId: monitoring_get_aggregates parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/monitoring_get_aggregates' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/monitoring_get_aggregates_result' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /monitoring/getEnterpriseBgpPeerStatus: post: tags: - all - monitoring summary: monitoring_get_enterprise_bgp_peer_status description: >- Gets the gateway BGP peer status for all enterprise gateways. Returns an array in which each entry corresponds to a gateway and contains an associated set of BGP peers with state records. Privileges required: `READ` `NETWORK_SERVICE` operationId: monitoring_get_enterprise_bgp_peer_status parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/enterprise_get_enterprise_configurations_with_policies' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/monitoring_get_enterprise_bgp_peer_status_result_item' description: '' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /monitoring/getEnterpriseEdgeBgpPeerStatus: post: tags: - all - monitoring summary: monitoring_get_enterprise_edge_bgp_peer_status description: >- Gets the Edge BGP peer status for all enterprise Edges. Returns an array in which each entry corresponds to an Edge and contains an associated set of BGP peers and state records. Privileges required: `READ` `EDGE` operationId: monitoring_get_enterprise_edge_bgp_peer_status parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/enterprise_get_enterprise_configurations_with_policies' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/monitoring_get_enterprise_edge_bgp_peer_status_result_item' description: '' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /monitoring/getEnterpriseEdgeClusterStatus: post: tags: - all - monitoring summary: monitoring_get_enterprise_edge_cluster_status description: >- Get edge`s utilization data by clusters Privileges required: `READ` `EDGE` operationId: monitoring_get_enterprise_edge_cluster_status parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/monitoring_get_enterprise_edge_cluster_status' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/monitoring_get_enterprise_edge_cluster_statusResponse' description: '' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /monitoring/getEnterpriseEdgeLinkStatus: post: tags: - all - monitoring summary: monitoring_get_enterprise_edge_link_status description: >- Gets the current Edge and Edge-link status for all enterprises. edges. Privileges required: `READ` `ENTERPRISE` `READ` `EDGE` operationId: monitoring_get_enterprise_edge_link_status parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/body2' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/monitored_link' description: '' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /network/getNetworkConfigurations: post: tags: - all - network summary: network_get_network_configurations description: >- Gets all operator configuration profiles associated with an operator's network. Optionally includes the modules associated with each profile. This call does not return templates. Privileges required: `READ` `OPERATOR_PROFILE` operationId: network_get_network_configurations parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/network_get_network_configurations' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/network_get_network_configurations_result_item' description: '' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /network/getNetworkEnterprises: post: tags: - all - network summary: network_get_network_enterprises description: >- Gets all enterprises existing on a network, optionally including all Edges or Edge counts. The `edgeConfigUpdate` "with" option may also be passed to check whether the application of configuration updates to Edges is enabled for each enterprise. Privileges required: `READ` `ENTERPRISE` operationId: network_get_network_enterprises parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/network_get_network_enterprises' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/network_get_network_enterprises_result_item' description: '' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /network/getNetworkGatewayPools: post: tags: - all - network summary: network_get_network_gateway_pools description: >- Gets all gateway pools associated with the specified network. Optionally includes the gateways or enterprises belonging to each pool. Privileges required: `READ` `GATEWAY` operationId: network_get_network_gateway_pools parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/network_get_network_gateway_pools' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/network_get_network_gateway_pools_result_item' description: '' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /network/getNetworkOperatorUsers: post: tags: - all - network summary: network_get_network_operator_users description: >- Gets all operator users associated with the specified network. Privileges required: `READ` `OPERATOR_USER` operationId: network_get_network_operator_users parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/network_get_network_operator_users' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/operator_user_with_role_info' description: '' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /operatorUser/deleteOperatorUser: post: tags: - all - userMaintenance summary: operator_user_delete_operator_user description: >- Deletes the specified operator user (by `id` or `username`). Privileges required: `DELETE` `OPERATOR_USER` operationId: operator_user_delete_operator_user parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/operator_user_delete_operator_user' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/deletion_confirmation' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /operatorUser/getOperatorUser: post: tags: - all - userMaintenance summary: operator_user_get_operator_user description: >- Gets the specified operator user object (by `id` or `username`). Privileges required: `READ` `OPERATOR_USER` operationId: operator_user_get_operator_user parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/operator_user_get_operator_user' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/operator_user_with_role_info' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /operatorUser/insertOperatorUser: post: tags: - all - userMaintenance summary: operator_user_insert_operator_user description: >- Creates an operator user and associates it with the operator's network. Privileges required: `CREATE` `OPERATOR_USER` operationId: operator_user_insert_operator_user parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/operator_user_insert_operator_user' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/operator_user_with_role_info' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /operatorUser/updateOperatorUser: post: tags: - all - userMaintenance summary: operator_user_update_operator_user description: >- Updates the specified operator user (by object `id` or `username`). Expects an `_update` object containing the field(s) to be updated and their corresponding value(s). Privileges required: `UPDATE` `OPERATOR_USER` operationId: operator_user_update_operator_user parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/operator_user_update_operator_user1' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/rows_modified_confirmation' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /role/createRoleCustomization: post: tags: - all - role summary: role_create_role_customization description: >- Creates a role customization specified by `roleId` and an array of `privilegeIds`. Privileges required: `UPDATE` `NETWORK` operationId: role_create_role_customization parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/role_create_role_customization' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: type: object '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /role/deleteRoleCustomization: post: tags: - all - role summary: role_delete_role_customization description: >- Deletes the specified role customization (by `name` or `forRoleId`). Privileges required: `UPDATE` `NETWORK` operationId: role_delete_role_customization parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/role_delete_role_customization' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/deletion_confirmation' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /role/getUserTypeRoles: post: tags: - all - role summary: role_get_user_type_roles description: >- Gets all roles defined for the specified `userType`. Privileges required: `READ` `ENTERPRISE_USER`, or `READ` `PROXY_USER`, or `READ` `OPERATOR_USER` operationId: role_get_user_type_roles parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/role_get_user_type_roles' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/role_get_user_type_roles_result_item' description: '' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /vcoDiagnostics/getVcoDbDiagnostics: post: tags: - all - vcoDiagnostics summary: vco_diagnostics_get_vco_db_diagnostics description: >- Gets the diagnostic information of the VCO database. Privileges required: `READ` `VCO_DIAGNOSTICS` operationId: vco_diagnostics_get_vco_db_diagnostics parameters: [] requestBody: description: '' content: text/plain: schema: type: object required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/vco_diagnostics_get_vco_db_diagnosticsResponse' description: '' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /vcoInventory/associateEdge: post: tags: - all - vcoInventory summary: vco_inventory_associate_edge description: >- Assigns an Edge in the inventory to the specified enterprise. To perform the action, the Edge should already be in a `STAGING` state. The assignment can be done at an enterprise level, without selecting a destination Edge profile. In such a case, the inventory Edge is assigned to a staging profile within the enterprise. Optionally, a profile or destination Edge can be assigned to this inventory Edge. The Edge in the inventory can be assigned to any profile. The inventory Edge can be assigned to an enterprise Edge only if it is in a `PENDING` or `REACTIVATION_PENDING` state. Privileges required: `CREATE` `ENTERPRISE` operationId: vco_inventory_associate_edge parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/vco_inventory_associate_edge' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/vco_inventory_associate_edgeResponse' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /vcoInventory/getInventoryItems: post: tags: - all - vcoInventory summary: vco_inventory_get_inventory_items description: "Gets all of the inventory information available with this VCO. This method does not have required parameters. The optional parameters are \n`enterpriseId` - Returns inventory items belonging to the specified enterprise. If the caller context is an enterprise, then this value will be taken from the token itself.\n`modifiedSince` - Returns inventory items that have been modified in the last `modifiedSince` hours.\n`with` - Array containing the string \"edge\" to get details about the provisioned Edge, if any.\n\nPrivileges required:\n\n`READ` `INVENTORY`" operationId: vco_inventory_get_inventory_items parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/vco_inventory_get_inventory_items' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/inventory_item' description: '' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /vpn/generateVpnGatewayConfiguration: post: tags: - all - vpn summary: vpn_generate_vpn_gateway_configuration description: >- Provision a non-SD-WAN site (e.g. a data center or cloud service PoP) and generate VPN configuration. Privileges required: `CREATE` `NETWORK_SERVICE` operationId: vpn_generate_vpn_gateway_configuration parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/vpn_generate_vpn_gateway_configuration' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/vpn_generate_vpn_gateway_configuration_result' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /clientDevice/setClientDeviceHostName: post: tags: - clientDevice - all summary: set_client_device_host_name description: >- Sets the `hostName` for client device Privileges required: `UPDATE` `CLIENT_DEVICE` operationId: set_client_device_host_name parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/set_client_device_host_name' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/rows_modified_confirmation' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /configuration/cloneAndConvertConfiguration: post: tags: - configuration - all summary: configuration_clone_and_convert_configuration description: >- Clones and converts the specified network configuration (by `configurationId`). Accepts an `enterpriseId` or `networkId` to associate the new configuration with an enterprise or network. On success, returns the ID of the newly created configuration object. Privileges required: `CREATE` `ENTERPRISE_PROFILE`, or `CREATE` `OPERATOR_PROFILE` operationId: configuration_clone_and_convert_configuration parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/configuration_clone_and_convert_configuration' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/configuration_clone_and_convert_configuration_result' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /configuration/cloneConfiguration: post: tags: - configuration - all summary: configuration_clone_configuration description: >- Clones the specified configuration (by `configurationId`) and all associated configuration modules. Accepts an `enterpriseId` or `networkId` to associate the new configuration with an enterprise or network. Select modules may also be specified. On success, returns the `id` of the newly created configuration object. Privileges required: `CREATE` `ENTERPRISE_PROFILE`, or `CREATE` `OPERATOR_PROFILE` operationId: configuration_clone_configuration parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/configuration_clone_configuration' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/configuration_clone_configuration_result' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /configuration/getConfigurationModules: post: tags: - configuration - all summary: configuration_get_configuration_modules description: >- Gets all configuration modules for the specified configuration profile. Privileges required: `READ` `ENTERPRISE_PROFILE`, or `READ` `OPERATOR_PROFILE` operationId: configuration_get_configuration_modules parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/configuration_get_configuration_modules' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/configuration_module' description: '' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /configuration/insertConfigurationModule: post: tags: - configuration - all summary: configuration_insert_configuration_module description: >- Creates a new configuration module for the specified configuration profile. Privileges required: `UPDATE` `ENTERPRISE_PROFILE`, or `UPDATE` `OPERATOR_PROFILE` operationId: configuration_insert_configuration_module parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/configuration_insert_configuration_module' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/configuration_insert_configuration_module_result' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /configuration/updateConfiguration: post: tags: - configuration - all summary: configuration_update_configuration description: >- Updates the specified configuration profile record according to the attribute:value mappings specified in the `_update` object. Privileges required: `UPDATE` `ENTERPRISE_PROFILE`, or `UPDATE` `OPERATOR_PROFILE` operationId: configuration_update_configuration parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/configuration_update_configuration' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/rows_modified_confirmation' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /configuration/updateConfigurationModule: post: tags: - configuration - all summary: configuration_update_configuration_module description: >- Updates the specified configuration module. Expects an `_update` object containing the field(s) to be updated and their corresponding value(s). For most use cases, configuration module `data` should be the only module attribute that it is necessary to update. This method does not support partial updates on specific sub-sections of the `data` object. Privileges required: `UPDATE` `ENTERPRISE_PROFILE`, or `UPDATE` `OPERATOR_PROFILE` operationId: configuration_update_configuration_module parameters: [] requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/configuration_update_configuration_module' - example: enterpriseId: 4 configurationModuleId: 5161 _update: data: inbound: [] segments: - segment: segmentId: 0 name: Global Segment type: REGULAR segmentLogicalId: 0f966250-942d-48cc-be87-d656734f6449 firewall_logging_enabled: false outbound: - name: Block Google DNS match: appid: -1 classid: -1 dscp: -1 sip: any smac: any sport_high: -1 sport_low: -1 ssm: 255.255.255.255 svlan: -1 os_version: -1 hostname: '' dip: 8.8.8.8 dport_low: 53 dport_high: 53 dsm: 255.255.255.255 dvlan: -1 proto: 6 s_rule_type: prefix d_rule_type: exact action: allow_or_deny: deny loggingEnabled: false firewall_enabled: true firewall_logging_enabled: true example: enterpriseId: 4 configurationModuleId: 5161 _update: data: inbound: [] segments: - segment: segmentId: 0 name: Global Segment type: REGULAR segmentLogicalId: 0f966250-942d-48cc-be87-d656734f6449 firewall_logging_enabled: false outbound: - name: Block Google DNS match: appid: -1 classid: -1 dscp: -1 sip: any smac: any sport_high: -1 sport_low: -1 ssm: 255.255.255.255 svlan: -1 os_version: -1 hostname: '' dip: 8.8.8.8 dport_low: 53 dport_high: 53 dsm: 255.255.255.255 dvlan: -1 proto: 6 s_rule_type: prefix d_rule_type: exact action: allow_or_deny: deny loggingEnabled: false firewall_enabled: true firewall_logging_enabled: true required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/rows_modified_confirmation' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /edge/edgeCancelReactivation: post: tags: - edge - all summary: edge_edge_cancel_reactivation description: >- Cancels a pending Edge reactivation request for the specified Edge (by `edgeId`). Privileges required: `CREATE` `EDGE` operationId: edge_edge_cancel_reactivation parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/edge_edge_cancel_reactivation' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/rows_modified_confirmation' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /edge/edgeProvision: post: tags: - edge - all summary: edge_edge_provision description: >- Provisions an Edge before activation. Privileges required: `CREATE` `EDGE` operationId: edge_edge_provision parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/edge_edge_provision' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/edge_edge_provision_result' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /edge/edgeRequestReactivation: post: tags: - edge - all summary: edge_edge_request_reactivation description: >- Updates the activation state of the specified Edge to `REACTIVATION_PENDING`. Privileges required: `CREATE` `EDGE` operationId: edge_edge_request_reactivation parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/edge_edge_request_reactivation' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/edge_edge_request_reactivation_result' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /edge/getClientVisibilityMode: post: tags: - edge - all summary: edge_get_client_visibility_mode description: >- Retrieve an edge's client visibility mode. Privileges required: `READ` `EDGE` `VIEW_FLOW_STATS` `undefined` operationId: edge_get_client_visibility_mode parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/edge_get_client_visibility_mode' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/edge_get_client_visibility_mode_result' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /edge/getEdge: post: tags: - edge - all summary: edge_get_edge description: >- Gets the specified Edge with optional link, site, configuration, certificate, orenterprise details. Supports queries by Edge `id`, `deviceId`, `activationKey`, and `logicalId`. Privileges required: `READ` `EDGE` operationId: edge_get_edge parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/edge_get_edge' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/edge_get_edge_result' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /edge/getEdgeConfigurationModules: post: tags: - edge - all summary: edge_get_edge_configuration_modules description: >- Gets edge composite configuration modules for the specified Edge (by `edgeId`). Privileges required: `READ` `EDGE` `READ` `ENTERPRISE_PROFILE` operationId: edge_get_edge_configuration_modules parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/edge_get_edge_configuration_modules' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/edge_get_edge_configuration_modules_result' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /edge/getEdgeConfigurationStack: post: tags: - edge - all summary: edge_get_edge_configuration_stack description: >- Gets the complete configuration profile (including all modules) of the specified Edge (by `edgeId`). Privileges required: `READ` `EDGE` `READ` `ENTERPRISE_PROFILE` operationId: edge_get_edge_configuration_stack parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/edge_get_edge_configuration_stack' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/edge_get_edge_configuration_stack_result_item' description: '' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /edge/updateEdgeAdminPassword: post: tags: - edge - all summary: edge_update_edge_admin_password description: >- Requests an update to the Edge's local UI authentication credentials. On success, returns a JSON object with the ID of the action queued, the status of which can be queried using the `edgeAction/getEdgeAction` API. Privileges required: `UPDATE` `EDGE` `UPDATE` `ENTERPRISE_KEYS` operationId: edge_update_edge_admin_password parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/edge_update_edge_admin_password' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/edge_update_edge_admin_password_result' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /edge/updateEdgeAttributes: post: tags: - edge - all summary: edge_update_edge_attributes description: >- Updates basic attributes (including Edge name, description, site information, and serial number) for the specified Edge. Expects an `_update` object containing the field(s) to be updated and their corresponding value(s). Privileges required: `UPDATE` `EDGE` operationId: edge_update_edge_attributes parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/edge_update_edge_attributes' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/rows_modified_confirmation' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /edge/updateEdgeCredentialsByConfiguration: post: tags: - edge - all summary: edge_update_edge_credentials_by_configuration description: >- Requests an update to the Edge-local UI authentication credentials for all Edges belonging to the specified configuration profile. On success, returns a JSON object containing a list of each of the action IDs queued. Privileges required: `UPDATE` `EDGE` `UPDATE` `ENTERPRISE_KEYS` operationId: edge_update_edge_credentials_by_configuration parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/edge_update_edge_credentials_by_configuration' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/edge_update_edge_credentials_by_configuration_result' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /enterprise/decodeEnterpriseKey: post: tags: - enterprise - all summary: enterprise_decode_enterprise_key description: >- Decrypt an enterprise key Privileges required: `READ` `ENTERPRISE_KEYS` operationId: enterprise_decode_enterprise_key parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/enterprise_encode_enterprise_key_result' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/enterprise_decode_enterprise_key_result' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /enterprise/encodeEnterpriseKey: post: tags: - enterprise - all summary: enterprise_encode_enterprise_key description: >- Encrypt an enterprise key Privileges required: `CREATE` `ENTERPRISE_KEYS` operationId: enterprise_encode_enterprise_key parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/enterprise_encode_enterprise_key_result' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/enterprise_encode_enterprise_key_result' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /enterprise/getEnterprise: post: tags: - enterprise - all summary: enterprise_get_enterprise description: >- Gets data for the specified enterprise with optional proxy (partner) detail. Privileges required: `READ` `ENTERPRISE` operationId: enterprise_get_enterprise parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/enterprise_get_enterprise' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/enterprise_get_enterprise_result' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /enterprise/getEnterpriseCapabilities: post: tags: - enterprise - all summary: enterprise_get_enterprise_capabilities description: >- Gets all enterprise capabilities (e.g. BGP, COS mapping, PKI, etc.) currently enabled/disabled for the specified enterprise. Privileges required: `READ` `ENTERPRISE` operationId: enterprise_get_enterprise_capabilities parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/enterprise_get_enterprise_configurations_with_policies' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/enterprise_get_enterprise_capabilities_result' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /enterprise/getEnterpriseEdges: post: tags: - enterprise - all summary: enterprise_get_enterprise_edges description: >- Gets all Edges associated with the specified enterprise, including optional site, link, and configuration details. Privileges required: `READ` `EDGE` operationId: enterprise_get_enterprise_edges parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/enterprise_get_enterprise_edges' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/enterprise_get_enterprise_edges_result_item' description: '' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /enterprise/getEnterpriseGatewayHandoff: post: tags: - enterprise - all summary: enterprise_get_enterprise_gateway_handoff description: >- Gets the gateway handoff configuration for the specified enterprise. Privileges required: `READ` `ENTERPRISE` operationId: enterprise_get_enterprise_gateway_handoff parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/enterprise_get_enterprise_gateway_handoff' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/enterprise_get_enterprise_gateway_handoff_result' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /enterprise/getEnterpriseMaximumSegments: post: tags: - enterprise - all summary: enterprise_get_enterprise_maximum_segments description: >- Gets maximum segments for the specified enterprise. Privileges required: `READ` `ENTERPRISE` operationId: enterprise_get_enterprise_maximum_segments parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/enterprise_get_enterprise_configurations_with_policies' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/enterprise_get_enterprise_property_result' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /enterprise/getEnterpriseNetworkAllocation: post: tags: - enterprise - all summary: enterprise_get_enterprise_network_allocation description: >- Gets the specified network allocation object (by `id`) for the specified enterprise. Privileges required: `READ` `NETWORK_ALLOCATION` operationId: enterprise_get_enterprise_network_allocation parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/enterprise_get_enterprise_network_allocation' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/enterprise_object_base' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /enterprise/getEnterpriseProperty: post: tags: - enterprise - all summary: enterprise_get_enterprise_property description: >- Get a enterprise property by object id or other attribute. Privileges required: `READ` `ENTERPRISE` operationId: enterprise_get_enterprise_property parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/enterprise_get_enterprise_property' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/enterprise_get_enterprise_property_result' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /enterprise/insertEnterprise: post: tags: - enterprise - all summary: enterprise_insert_enterprise description: >- Creates a new enterprise, which is owned by the operator. Privileges required: `CREATE` `ENTERPRISE` operationId: enterprise_insert_enterprise parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/enterprise_insert_enterprise' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/insertion_confirmation' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /enterprise/insertEnterpriseNetworkAllocation: post: tags: - enterprise - all summary: enterprise_insert_enterprise_network_allocation description: >- Creates a new network allocation for the specified enterprise. Privileges required: `CREATE` `NETWORK_ALLOCATION` operationId: enterprise_insert_enterprise_network_allocation parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/enterprise_insert_enterprise_network_allocation' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/insertion_confirmation' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /enterprise/insertEnterpriseNetworkSegment: post: tags: - enterprise - all summary: enterprise_insert_enterprise_network_segment description: >- Creates a new network segment for the specified enterprise. Privileges required: `CREATE` `NETWORK_ALLOCATION` operationId: enterprise_insert_enterprise_network_segment parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/enterprise_insert_enterprise_network_segment' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/insertion_confirmation' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /enterprise/insertOrUpdateEnterpriseCapability: post: tags: - enterprise - all summary: enterprise_insert_or_update_enterprise_capability description: >- Creates or updates the specified capability (`name`, `value`) for the specified enterprise (by `enterpriseId`). Privileges required: `UPDATE` `ENTERPRISE` operationId: enterprise_insert_or_update_enterprise_capability parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/enterprise_insert_or_update_enterprise_capability' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/insertion_confirmation' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /enterprise/insertOrUpdateEnterpriseGatewayHandoff: post: tags: - enterprise - all summary: enterprise_insert_or_update_enterprise_gateway_handoff description: >- Creates or updates a gateway handoff configuration for the specified enterprise (by `enterpriseId`). Privileges required: `UPDATE` `ENTERPRISE` `UPDATE` `GATEWAY` operationId: enterprise_insert_or_update_enterprise_gateway_handoff parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/gateway_handoff' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/insertion_confirmation' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /enterprise/insertOrUpdateEnterpriseProperty: post: tags: - enterprise - all summary: enterprise_insert_or_update_enterprise_property description: >- Insert a enterprise property. If property with the given name already exists, the property will be updated. Privileges required: `UPDATE` `ENTERPRISE` operationId: enterprise_insert_or_update_enterprise_property parameters: [] requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/enterprise_insert_or_update_enterprise_property' - example: enterpriseId: 1532 name: vco.enterprise.authentication.twoFactor.enable dataType: BOOLEAN value: 'true' example: enterpriseId: 1532 name: vco.enterprise.authentication.twoFactor.enable dataType: BOOLEAN value: 'true' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/insertion_confirmation' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /enterprise/setEnterpriseMaximumSegments: post: tags: - enterprise - all summary: enterprise_set_enterprise_maximum_segments description: >- Set maximum segments for the specified enterprise (by `enterpriseId`). Privileges required: `UPDATE` `ENTERPRISE` operationId: enterprise_set_enterprise_maximum_segments parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/enterprise_set_enterprise_maximum_segments' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/insertion_confirmation' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /enterprise/updateEnterprise: post: tags: - enterprise - all summary: enterprise_update_enterprise description: >- Updates the specified enterprise (by `enterpriseId` or `name`). Expects an `_update` object containing the field(s) to be updated and their corresponding value(s). Privileges required: `UPDATE` `ENTERPRISE` operationId: enterprise_update_enterprise parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/enterprise_update_enterprise1' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/enterprise_update_enterprise_result' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /enterprise/updateEnterpriseNetworkAllocation: post: tags: - enterprise - all summary: enterprise_update_enterprise_network_allocation description: >- Updates the specified enterprise network allocation (by `id`). Expects an `_update` object containing the field(s) to be updated and their corresponding value(s). Privileges required: `UPDATE` `NETWORK_ALLOCATION` operationId: enterprise_update_enterprise_network_allocation parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/enterprise_update_enterprise_network_allocation' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/rows_modified_confirmation' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /enterprise/updateEnterpriseNetworkSegment: post: tags: - enterprise - all summary: enterprise_update_enterprise_network_segment description: >- Update an enterprise network segment. Privileges required: `UPDATE` `NETWORK_ALLOCATION` operationId: enterprise_update_enterprise_network_segment parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/enterprise_update_enterprise_network_segment' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/rows_modified_confirmation' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /enterprise/updateEnterpriseSecurityPolicy: post: tags: - enterprise - all summary: enterprise_update_enterprise_security_policy description: >- Updates the security policy for the specified enterprise (by `enterpriseId`) using the passed in `ipsec` settings. Privileges required: `UPDATE` `ENTERPRISE_PROFILE` operationId: enterprise_update_enterprise_security_policy parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/enterprise_update_enterprise_security_policy' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/rows_modified_confirmation' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /enterprise/getEnterpriseProxyProperty: post: tags: - enterprise - all summary: enterprise_proxy_get_enterprise_proxy_property description: >- Get a enterprise proxy property by object id or other attribute. Privileges required: `READ` `PROXY` operationId: enterprise_proxy_get_enterprise_proxy_property parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/enterprise_proxy_get_enterprise_proxy_property' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/enterprise_proxy_get_enterprise_proxy_property_result' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /enterprise/getEnterpriseUsers: post: tags: - userMaintenance - all summary: enterprise_get_enterprise_users description: >- Gets all enterprise users for the specified enterprise (by `enterpriseId`). Privileges required: `READ` `ENTERPRISE` `READ` `ENTERPRISE_USER` operationId: enterprise_get_enterprise_users parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/enterprise_get_enterprise_users' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/enterprise_get_enterprise_users_result_item' description: '' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /enterprise/insertEnterpriseUser: post: tags: - userMaintenance - all summary: enterprise_insert_enterprise_user description: >- Creates a new enterprise user. Privileges required: `CREATE` `ENTERPRISE_USER` operationId: enterprise_insert_enterprise_user parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/new_enterprise_user' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/insertion_confirmation' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /enterpriseProxy/getEnterpriseProxyUsers: post: tags: - userMaintenance - all summary: enterprise_proxy_get_enterprise_proxy_users description: >- Gets all proxy admin users for the specified enterprise. Privileges required: `READ` `ENTERPRISE` `READ` `PROXY_USER` operationId: enterprise_proxy_get_enterprise_proxy_users parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/enterprise_proxy_get_enterprise_proxy_users' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/enterprise_proxy_get_enterprise_proxy_users_result_item' description: '' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /enterpriseProxy/getEnterpriseProxyGateways: post: tags: - enterpriseProxy - all summary: enterprise_proxy_get_enterprise_proxy_gateways description: >- Gets all gateways associated with the specified enterprise proxy. Privileges required: `READ` `GATEWAY` operationId: enterprise_proxy_get_enterprise_proxy_gateways parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/enterprise_proxy_get_enterprise_proxy_gateways' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/network_get_network_gateways_result_item' description: '' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /enterpriseProxy/insertEnterpriseProxyEnterprise: post: tags: - enterpriseProxy - all summary: enterprise_proxy_insert_enterprise_proxy_enterprise description: >- Creates a new enterprise owned by an MSP. Whereas the `insertEnterprise` method creates an enterprise in the global or network context with no MSP association, this method creates one owned by an MSP, as determined by the credentials of the caller. Privileges required: `CREATE` `ENTERPRISE` operationId: enterprise_proxy_insert_enterprise_proxy_enterprise parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/enterprise_proxy_insert_enterprise_proxy_enterprise' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/insertion_confirmation' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /enterpriseProxy/insertOrUpdateEnterpriseProxyProperty: post: tags: - enterpriseProxy - all summary: enterprise_proxy_insert_or_update_enterprise_proxy_property description: >- Insert a enterprise proxy property. If property with the given name already exists, the property will be updated. Privileges required: `UPDATE` `PROXY` operationId: enterprise_proxy_insert_or_update_enterprise_proxy_property parameters: [] requestBody: description: '' content: application/json: schema: allOf: - $ref: '#/components/schemas/enterprise_proxy_insert_or_update_enterprise_proxy_property' - example: enterpriseProxyId: 1532 name: vco.enterprise.proxy.authentication.twoFactor.enable dataType: BOOLEAN value: 'true' example: enterpriseProxyId: 1532 name: vco.enterprise.proxy.authentication.twoFactor.enable dataType: BOOLEAN value: 'true' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/insertion_confirmation' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /event/getEnterpriseEvents: post: tags: - event - all summary: event_get_enterprise_events description: >- Gets Edge events in an enterprise or Edge context. Returns an array of Edge events sorted by `eventTime`.. Privileges required: `READ` `ENTERPRISE_EVENT` operationId: event_get_enterprise_events parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/event_get_enterprise_events' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/event_get_enterprise_events_result' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /event/getOperatorEvents: post: tags: - event - all summary: event_get_operator_events description: >- Gets operator events by network ID (optional). If not specified, will be taken for the caller's security context. Optionally, use a filter object to limit the number of events returned. Additionally, specify a time interval with an interval object. If no end date is specified, then the default is the current date. Specify a `gatewayId` to filter events for the specified gateway. Privileges required: `READ` `OPERATOR_EVENT` operationId: event_get_operator_events parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/event_get_operator_events' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/event_get_operator_events_result' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /event/getProxyEvents: post: tags: - event - all summary: event_get_proxy_events description: >- Fetch Partner Events by enterprise ID. Optionally, a filter object to specify search criteria and limit on number of records. A time interval could be specified with an interval object. If no end date is given, it will default to the current date. Enterprise ID can be supplied to filter events to those of a specific enterprises. Privileges required: `READ` `PROXY_EVENT` operationId: event_get_proxy_events parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/event_get_proxy_events' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/event_get_proxy_events_result' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /firewall/getEnterpriseFirewallLogs: post: tags: - firewall - all summary: firewall_get_enterprise_firewall_logs description: >- Gets firewall logs for the specified enterprise. Privileges required: `READ` `EDGE` `VIEW_FIREWALL_LOGS` `undefined` operationId: firewall_get_enterprise_firewall_logs parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/firewall_get_enterprise_firewall_logs' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/firewall_get_enterprise_firewall_logs_result' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /gateway/deleteGateway: post: tags: - gateway - all summary: gateway_delete_gateway description: >- Delete a gateway by id. Privileges required: `DELETE` `GATEWAY` operationId: gateway_delete_gateway parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/gateway_delete_gateway' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/deletion_confirmation' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /gateway/gatewayProvision: post: tags: - gateway - all summary: gateway_gateway_provision description: >- Provisions a gateway into the specified operator network. Privileges required: `CREATE` `GATEWAY` operationId: gateway_gateway_provision parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/gateway_gateway_provision' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/gateway_gateway_provision_result' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /gateway/getGatewayEdgeAssignments: post: tags: - gateway - all summary: gateway_get_gateway_edge_assignments description: >- Get edge assignments for a gateway Privileges required: `READ` `GATEWAY` operationId: gateway_get_gateway_edge_assignments parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/gateway_get_gateway_edge_assignments' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/gateway_get_gateway_edge_assignments_result_item' description: '' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /gateway/updateGatewayAttributes: post: tags: - gateway - all summary: gateway_update_gateway_attributes description: >- Updates gateway attributes (`name`, `ipAddress`, on-premise parametrization, and `description`) and associated site attributes for the specified gateway (by `id`). Privileges required: `UPDATE` `GATEWAY` operationId: gateway_update_gateway_attributes parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/gateway_update_gateway_attributes' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/rows_modified_confirmation' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /linkQualityEvent/getLinkQualityEvents: post: tags: - linkQualityEvent - all summary: link_quality_event_get_link_quality_events description: >- Fetch per-link and overall Quality of Experience scores for the specified Edge over the specified time interval. For each link, this method reports an aggregate `totalScore`, a `score` breakdown by traffic type, a `timeseries` composed of samples for which pre- and post-enhancement link states are recorded by traffic type, and quality state `distribution`s by traffic type. It also summarizes effective overall link quality scores across all links in the same format on the `overallLinkQuality` property. QoE scores are computed based on a sample of events stored on the Orchestrator. Clients may optionally parameterize the number of events sampled (see the `maxSamples` parameter) or the duration of samples (see `minutesPerSample`), but the default parameter values should be sufficient for most, if not all, use cases. The response schema for this method is unique in that several of the constituent objects use integer keys that inform how values should be interpreted. Where breakdowns are presented by traffic type, as they are in the `distribution` and `score` summary objects, they should be interpreted as follows: - `0`: Voice - `1`: Video - `2`: Transactional Where breakdowns are presented by state, as they are in the traffic-type-specific `distribution` summaries, they should be interpreted as follows: - `0`: Offline - `1`: Unknown - `2`: Red - `3`: Yellow - `4`: Green Where actions are referenced in `timeseries` samples, they should be interpreted as follows: - `0`: None - `1`: Avoid - `2`: Jitter Buffer - `3`: Error Correction - `4`: Forward Error Correction Where metrics are referenced in `timeseries` samples, they should be interpreted as follows: - `0`: Latency Rx - `1`: Latency Tx - `2`: Jitter Rx - `3`: Jitter Tx - `4`: Loss Rx - `5`: Loss Tx Privileges required: `READ` `EDGE` operationId: link_quality_event_get_link_quality_events parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/link_quality_event_get_link_quality_events' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/link_quality_event_get_link_quality_events_result' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /network/deleteNetworkGatewayPool: post: tags: - network - all summary: network_delete_network_gateway_pool description: >- Deletes the specified gateway pool (by `id`). Privileges required: `DELETE` `GATEWAY` operationId: network_delete_network_gateway_pool parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/network_delete_network_gateway_pool' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/deletion_confirmation' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /network/getNetworkGateways: post: tags: - network - all summary: network_get_network_gateways description: >- Gets all gateways associated with the specified network. Privileges required: `READ` `GATEWAY` operationId: network_get_network_gateways parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/network_get_network_gateways' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/network_get_network_gateways_result_item' description: '' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /network/insertNetworkGatewayPool: post: tags: - network - all summary: network_insert_network_gateway_pool description: >- Creates a gateway pool for the specified network. Privileges required: `CREATE` `GATEWAY` operationId: network_insert_network_gateway_pool parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/network_insert_network_gateway_pool' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/insertion_confirmation' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /network/updateNetworkGatwayPoolAttributes: post: tags: - network - all summary: network_update_network_gateway_pool_attributes description: >- Updates the configurable attributes (`name`, `description`, and `handOffType`) of the specified gateway pool (by `id` or `gatewayPoolId`). Privileges required: `UPDATE` `GATEWAY` operationId: network_update_network_gateway_pool_attributes parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/network_update_network_gateway_pool_attributes' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/rows_modified_confirmation' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /role/setEnterpriseDelegatedToEnterpriseProxy: post: tags: - role - all summary: role_set_enterprise_delegated_to_enterprise_proxy description: >- Grants enterprise access to the specified enterprise proxy (partner). When an enterprise is delegated to a proxy, proxy users are granted access to view, configure, and troubleshoot Edges owned by the enterprise. As a security consideration, proxy Support users cannot view personally identifiable information. Privileges required: `UPDATE` `ENTERPRISE_DELEGATION` operationId: role_set_enterprise_delegated_to_enterprise_proxy parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/body3' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/set_delegated_result' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /role/setEnterpriseDelegatedToOperator: post: tags: - role - all summary: role_set_enterprise_delegated_to_operator description: >- Grants enterprise access to the network operator. When an enterprise is delegated to the operator, operator users are permitted to view, configure, and troubleshoot Edges owned by the enterprise. As a security consideration, operator users cannot view personally identifiable information. Privileges required: `UPDATE` `ENTERPRISE_DELEGATION` operationId: role_set_enterprise_delegated_to_operator parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/set_delegated_result' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/set_delegated_result' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /role/setEnterpriseProxyDelegatedToOperator: post: tags: - role - all summary: role_set_enterprise_proxy_delegated_to_operator description: >- Grants enterprise proxy access to the network operator. When an enterprise proxy is delegated to the operator, operator users are granted access to view, configure and troubleshoot objects owned by the proxy. Privileges required: `UPDATE` `ENTERPRISE_PROXY_DELEGATION` operationId: role_set_enterprise_proxy_delegated_to_operator parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/body5' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/set_delegated_result' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /role/setEnterpriseUserManagementDelegatedToOperator: post: tags: - role - all summary: role_set_enterprise_user_management_delegated_to_operator description: >- Grants enterprise user access to the specified network operator. When enterprise user management is delegated to the operator, operator users are granted enterprise-level user management capabilities (user creation, password resets, etc.). Privileges required: `UPDATE` `ENTERPRISE_DELEGATION` operationId: role_set_enterprise_user_management_delegated_to_operator parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/set_delegated_result' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/set_delegated_result' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /systemProperty/getSystemProperties: post: tags: - systemProperty - all summary: system_property_get_system_properties description: >- Gets all configured system properties. Privileges required: `READ` `SYSTEM_PROPERTY` operationId: system_property_get_system_properties parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/system_property_get_system_properties' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/system_property_get_system_properties_result_item' description: '' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /systemProperty/getSystemProperty: post: tags: - systemProperty - all summary: system_property_get_system_property description: >- Gets the specified system property. Specify by object `id` or `name`. Privileges required: `READ` `SYSTEM_PROPERTY` operationId: system_property_get_system_property parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/system_property_get_system_property' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/system_property_get_system_property_result' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /systemProperty/insertOrUpdateSystemProperty: post: tags: - systemProperty - all summary: system_property_insert_or_update_system_property description: >- Creates the specified system property. If the system property with the specified `name` already exists, then the API call updates it. Privileges required: `CREATE` `SYSTEM_PROPERTY` operationId: system_property_insert_or_update_system_property parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/system_property_insert_or_update_system_property' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/insertion_confirmation' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /systemProperty/insertSystemProperty: post: tags: - systemProperty - all summary: system_property_insert_system_property description: >- Creates a new system property with the specified `name`, `value`, and optionally other attributes. Privileges required: `CREATE` `SYSTEM_PROPERTY` operationId: system_property_insert_system_property parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/system_property_insert_system_property' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/insertion_confirmation' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false /systemProperty/updateSystemProperty: post: tags: - systemProperty - all summary: system_property_update_system_property description: >- Updates the specified system property (by object `id` or `name`). Expects an `_update` object containing the field(s) to be updated and their corresponding value(s). Privileges required: `UPDATE` `SYSTEM_PROPERTY` operationId: system_property_update_system_property parameters: [] requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/system_property_update_system_property' required: true responses: '200': description: Request was successfully processed headers: {} content: application/json: schema: $ref: '#/components/schemas/rows_modified_confirmation' '400': description: 'Invalid Request: Please check your request schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/error' '500': description: Error parsing or processing request headers: {} content: application/json: schema: $ref: '#/components/schemas/error' deprecated: false components: schemas: error: title: error required: - error type: object properties: error: $ref: '#/components/schemas/Error1' tinyint: title: tinyint enum: - 0 - 1 type: integer logicalid_reference: title: logicalid_reference type: object properties: logicalId: type: string subnet: title: subnet type: object properties: cidrIp: type: string cidrPrefix: type: integer format: int32 enterprise: title: enterprise type: object properties: id: type: integer format: int32 created: type: string format: date-time networkId: type: integer format: int32 gatewayPoolId: type: integer format: int32 alertsEnabled: $ref: '#/components/schemas/tinyint' operatorAlertsEnabled: $ref: '#/components/schemas/tinyint' endpointPkiMode: $ref: '#/components/schemas/EndpointPkiMode' name: type: string domain: type: string prefix: type: string logicalId: type: string accountNumber: type: string description: type: string contactName: type: string contactPhone: type: string contactMobile: type: string contactEmail: type: string streetAddress: type: string streetAddress2: type: string city: type: string state: type: string postalCode: type: string country: type: string lat: type: number lon: type: number timezone: type: string locale: type: string modified: type: string format: date-time configuration_enterprise: title: configuration_enterprise type: object properties: id: type: integer format: int32 created: type: string format: date-time networkId: type: integer format: int32 gatewayPoolId: type: integer format: int32 alertsEnabled: $ref: '#/components/schemas/tinyint' operatorAlertsEnabled: $ref: '#/components/schemas/tinyint' endpointPkiMode: $ref: '#/components/schemas/EndpointPkiMode' name: type: string domain: type: string prefix: type: string logicalId: type: string accountNumber: type: string description: type: string contactName: type: string contactPhone: type: string contactMobile: type: string contactEmail: type: string streetAddress: type: string streetAddress2: type: string city: type: string state: type: string postalCode: type: string country: type: string lat: type: number lon: type: number timezone: type: string locale: type: string modified: type: string format: date-time configurationAssociationId: type: integer format: int32 enterprise_with_proxy_attributes: title: enterprise_with_proxy_attributes required: - id - created - networkId - gatewayPoolId - alertsEnabled - operatorAlertsEnabled - endpointPkiMode - name - domain - prefix - logicalId - accountNumber - description - contactName - contactPhone - contactMobile - contactEmail - streetAddress - streetAddress2 - city - state - postalCode - country - lat - lon - timezone - locale - modified type: object properties: id: type: integer format: int32 created: type: string format: date-time networkId: type: integer format: int32 gatewayPoolId: type: integer format: int32 alertsEnabled: $ref: '#/components/schemas/tinyint' operatorAlertsEnabled: $ref: '#/components/schemas/tinyint' endpointPkiMode: $ref: '#/components/schemas/EndpointPkiMode' name: type: string domain: type: string prefix: type: string logicalId: type: string accountNumber: type: string description: type: string contactName: type: string contactPhone: type: string contactMobile: type: string contactEmail: type: string streetAddress: type: string streetAddress2: type: string city: type: string state: type: string postalCode: type: string country: type: string lat: type: number lon: type: number timezone: type: string locale: type: string modified: type: string format: date-time enterpriseProxyId: type: integer format: int32 enterpriseProxyName: type: string enterprise_proxy: title: enterprise_proxy type: object properties: id: type: integer format: int32 created: type: string format: date-time networkId: type: integer format: int32 proxyType: $ref: '#/components/schemas/ProxyType' operateGateways: type: boolean logicalId: type: string name: type: string domain: type: string prefix: type: string description: type: string contactName: type: string contactPhone: type: string contactMobile: type: string contactEmail: type: string streetAddress: type: string streetAddress2: type: string city: type: string state: type: string postalCode: type: string country: type: string lat: type: number lon: type: number modified: type: string format: date-time enterprise_alert_configuration: title: enterprise_alert_configuration type: object properties: id: type: integer format: int32 created: type: string format: date-time alertDefinitionId: type: integer format: int32 enterpriseId: type: integer format: int32 enabled: type: boolean name: $ref: '#/components/schemas/Name' description: type: string type: $ref: '#/components/schemas/Type' definition: $ref: '#/components/schemas/enterprise_alert_definition' firstNotificationSeconds: type: integer format: int32 maxNotifications: type: integer format: int32 notificationIntervalSeconds: type: integer format: int32 resetIntervalSeconds: type: integer format: int32 modified: type: string format: date-time enterprise_alert_definition: title: enterprise_alert_definition type: object properties: isSystemOnly: type: boolean isOperatorOnly: type: boolean enterprise_alert_trigger: title: enterprise_alert_trigger type: object properties: id: type: integer format: int32 created: type: string format: date-time triggerTime: type: string format: date-time enterpriseAlertConfigurationId: type: integer format: int32 enterpriseId: type: integer format: int32 edgeId: type: integer format: int32 edgeName: type: string linkId: type: integer format: int32 linkName: type: string enterpriseObjectId: type: integer format: int32 enterpriseObjectName: type: string name: $ref: '#/components/schemas/Name' type: $ref: '#/components/schemas/Type' state: $ref: '#/components/schemas/State' stateSetTime: type: string format: date-time lastContact: type: string format: date-time firstNotificationSeconds: type: integer format: int32 maxNotifications: type: integer format: int32 notificationIntervalSeconds: type: integer format: int32 resetIntervalSeconds: type: integer format: int32 comment: type: string nextNotificationTime: type: string format: date-time remainingNotifications: type: integer format: int32 timezone: type: string locale: type: string modified: type: string format: date-time enterprise_object_base: title: enterprise_object_base required: - id - created - operatorId - networkId - enterpriseId - edgeId - gatewayId - parentGroupId - description - object - name - type - logicalId - alertsEnabled - operatorAlertsEnabled - status - statusModified - previousData - previousCreated - draftData - draftCreated - draftComment - data - lastContact - version - modified type: object properties: id: type: integer format: int32 created: type: string format: date-time operatorId: type: integer format: int32 networkId: type: integer format: int32 enterpriseId: type: integer format: int32 edgeId: type: integer format: int32 gatewayId: type: integer format: int32 parentGroupId: type: integer format: int32 description: type: string object: type: string name: type: string type: type: string logicalId: type: string alertsEnabled: $ref: '#/components/schemas/tinyint' operatorAlertsEnabled: $ref: '#/components/schemas/tinyint' status: type: string statusModified: type: string format: date-time previousData: type: object previousCreated: type: string format: date-time draftData: type: string draftCreated: type: string format: date-time draftComment: type: string data: type: object lastContact: type: string format: date-time version: type: string modified: type: string format: date-time event_base: title: event_base type: object properties: id: type: integer format: int32 eventTime: type: string format: date-time event: type: string category: $ref: '#/components/schemas/Category' severity: $ref: '#/components/schemas/Severity' message: type: string enterprise_event: title: enterprise_event required: - id - eventTime - event - category - severity - message - detail - enterpriseUsername - edgeName type: object properties: id: type: integer format: int32 eventTime: type: string format: date-time event: type: string category: $ref: '#/components/schemas/Category' severity: $ref: '#/components/schemas/Severity' message: type: string detail: type: string enterpriseUsername: type: string edgeName: type: string operator_event: title: operator_event required: - id - eventTime - event - category - severity - message - detail - operatorUsername - networkName - gatewayName type: object properties: id: type: integer format: int32 eventTime: type: string format: date-time event: type: string category: $ref: '#/components/schemas/Category' severity: $ref: '#/components/schemas/Severity' message: type: string detail: type: string operatorUsername: type: string networkName: type: string gatewayName: type: string proxy_event: title: proxy_event required: - id - eventTime - event - category - severity - message - detail - proxyUsername - networkName - enterpriseName type: object properties: id: type: integer format: int32 eventTime: type: string format: date-time event: type: string category: $ref: '#/components/schemas/Category' severity: $ref: '#/components/schemas/Severity' message: type: string detail: type: string proxyUsername: type: string networkName: type: string enterpriseName: type: string aggregate_enterprise_event: title: aggregate_enterprise_event required: - id - eventTime - event - category - severity - message - enterpriseId - enterpriseName - enterpriseUsername - edgeName - detail type: object properties: id: type: integer format: int32 eventTime: type: string format: date-time event: type: string category: $ref: '#/components/schemas/Category' severity: $ref: '#/components/schemas/Severity' message: type: string enterpriseId: type: integer format: int32 enterpriseName: type: string enterpriseUsername: type: string edgeName: type: string detail: type: string vnf_image_download_event: title: vnf_image_download_event required: - id - eventTime - event - category - severity - detail type: object properties: id: type: integer format: int32 eventTime: type: string format: date-time event: type: string category: $ref: '#/components/schemas/Category' severity: $ref: '#/components/schemas/Severity' message: type: string detail: $ref: '#/components/schemas/vnf_image_download_event_detail' vnf_image_download_event_detail: title: vnf_image_download_event_detail type: object properties: logicalId: type: string vnfType: pattern: vnfImage type: string vendor: $ref: '#/components/schemas/Vendor' downloadType: $ref: '#/components/schemas/DownloadType' edgeSerialNumber: type: string isEdgeActive: type: boolean status: $ref: '#/components/schemas/Status' description: type: string service: $ref: '#/components/schemas/Service' gateway_pool_gateway: title: gateway_pool_gateway type: object properties: gatewayPoolAssocId: type: integer format: int32 poolName: type: string id: type: integer format: int32 created: type: string format: date-time networkId: type: integer format: int32 enterpriseProxyId: type: integer format: int32 siteId: type: integer format: int32 activationKey: type: string activationState: type: string activationTime: type: string format: date-time softwareVersion: type: string buildNumber: type: string utilization: type: number utilizationDetail: $ref: '#/components/schemas/UtilizationDetail' connectedEdges: type: integer format: int32 connectedEdgeList: type: array items: $ref: '#/components/schemas/ConnectedEdgeList' description: '' deviceId: type: string logicalId: type: string name: type: string gatewayState: type: string description: type: string dnsName: type: string isLoadBalanced: type: integer format: int32 privateIpAddress: type: string ipAddress: type: string lastContact: type: string format: date-time systemUpSince: type: string format: date-time serviceUpSince: type: string format: date-time serviceState: type: string endpointPkiMode: type: string handOffDetail: $ref: '#/components/schemas/gateway_handoff_detail' ipsecGatewayDetail: $ref: '#/components/schemas/IpsecGatewayDetail' modified: type: string format: date-time gateway_handoff_detail: title: gateway_handoff_detail type: object properties: type: type: string subnets: type: array items: $ref: '#/components/schemas/Subnet1' description: '' icmpProbe: $ref: '#/components/schemas/IcmpProbe' icmpResponder: $ref: '#/components/schemas/IcmpResponder' gateway_handoff_ipsec_gateway_detail: title: gateway_handoff_ipsec_gateway_detail required: - ipsecGatewayAddress type: object properties: ipsecGatewayAddress: type: string strictHostCheck: type: boolean strictHostCheckDN: type: string gateway_pool: title: gateway_pool type: object properties: id: type: integer format: int32 networkId: type: integer format: int32 enterpriseProxyId: type: integer format: int32 created: type: string format: date-time name: type: string description: type: string isDefault: type: boolean handOffType: $ref: '#/components/schemas/HandOffType1' modified: type: string format: date-time link: title: link required: - id - created - edgeId - logicalId - internalId - interface - macAddress - ipAddress - netmask - networkSide - networkType - displayName - isp - org - lat - lon - lastActive - state - backupState - vpnState - lastEvent - lastEventState - alertsEnabled - operatorAlertsEnabled - serviceState - modified type: object properties: id: type: integer format: int32 created: type: string format: date-time edgeId: type: integer format: int32 logicalId: type: string internalId: type: string interface: type: string macAddress: type: string ipAddress: type: string netmask: type: string networkSide: $ref: '#/components/schemas/NetworkSide' networkType: $ref: '#/components/schemas/NetworkType' displayName: type: string isp: type: string org: type: string lat: type: number lon: type: number lastActive: type: string format: date-time state: $ref: '#/components/schemas/State1' backupState: $ref: '#/components/schemas/BackupState' vpnState: $ref: '#/components/schemas/VpnState' lastEvent: type: string format: date-time lastEventState: $ref: '#/components/schemas/LastEventState' alertsEnabled: $ref: '#/components/schemas/tinyint' operatorAlertsEnabled: $ref: '#/components/schemas/tinyint' serviceState: $ref: '#/components/schemas/ServiceState' modified: type: string format: date-time serviceGroups: type: array items: $ref: '#/components/schemas/link_service_group' description: '' client_device: title: client_device required: - id - created - enterpriseId - macAddress - hostName - ipAddress - os - osName - osVersion - deviceType - deviceModel - lastContact - modified type: object properties: id: type: integer format: int32 created: type: string format: date-time enterpriseId: type: integer format: int32 macAddress: type: string hostName: type: string ipAddress: type: string os: type: integer format: int32 osName: type: string osVersion: type: string deviceType: type: string deviceModel: type: string lastContact: type: string format: date-time modified: type: string format: date-time link_quality_object: title: link_quality_object required: - distribution - sampleCount - sampleLength - score - timeseries - totalScore type: object properties: distribution: type: object additionalProperties: type: number description: Summarizes state distributions over the request interval by traffic type. sampleCount: type: integer description: The number of events sampled to compute QoE values over the request interval. The samples themselves appear in the `timeseries` list. format: int32 sampleLength: type: integer description: The total number of link quality events reported by the Edge over the request interval. format: int32 score: type: object additionalProperties: type: number description: Presents a summary QoE scores by traffic type, where the 0 key represents voice traffic, the 1 key represents video traffic, and the 2 key represent transactional traffic. timeseries: type: array items: $ref: '#/components/schemas/link_quality_object_timeseries_data' description: '' totalScore: type: number link_quality_object_timeseries_data: title: link_quality_object_timeseries_data required: - after - metadata - timestamp type: object properties: before: type: object additionalProperties: type: integer format: int32 after: type: object additionalProperties: type: integer format: int32 metadata: $ref: '#/components/schemas/Metadata6' timestamp: type: integer format: int64 distribution: type: object additionalProperties: type: number description: Summarizes state distributions over the request interval by traffic type. score: type: object additionalProperties: type: number enterprise_route: title: enterprise_route type: object properties: type: type: string exitType: type: string edgeId: type: integer format: int32 edgeName: type: string profileId: type: integer format: int32 cidrIp: type: string cost: type: integer format: int32 advertise: type: boolean vlan: title: vlan type: object properties: name: type: string vlanId: type: integer format: int32 staticReserved: type: integer format: int32 enterprise_network_space: title: enterprise_network_space type: object properties: name: type: string mode: $ref: '#/components/schemas/Mode' cidrIp: type: string cidrPrefix: type: integer format: int32 maxVlans: type: integer format: int32 vlans: type: array items: $ref: '#/components/schemas/vlan' description: '' enterprise_service: title: enterprise_service required: - type type: object properties: id: type: integer format: int32 enterpriseObjectId: type: integer format: int32 configurationId: type: integer format: int32 moduleId: type: integer format: int32 ref: type: string data: type: object version: type: string object: type: string name: type: string type: type: string logicalId: type: string discriminator: propertyName: type mapping: dns: dns enterprise_service_network: enterprise_service_network dns: title: dns allOf: - $ref: '#/components/schemas/enterprise_service' - type: object properties: data: $ref: '#/components/schemas/dns_data' dns_data: title: dns_data type: object properties: primary: type: string secondary: type: string isPrivate: type: boolean domains: type: array items: $ref: '#/components/schemas/Domain' description: '' enterprise_service_network: title: enterprise_service_network allOf: - $ref: '#/components/schemas/enterprise_service' - type: object properties: data: $ref: '#/components/schemas/enterprise_service_network_data' enterprise_service_network_data: title: enterprise_service_network_data type: object properties: zone: type: string spaces: type: array items: $ref: '#/components/schemas/Space' description: '' configuration_module: title: configuration_module required: - name type: object properties: created: type: string format: date-time effective: type: string format: date-time id: type: integer format: int32 isSmallData: $ref: '#/components/schemas/tinyint' modified: type: string format: date-time name: type: string type: $ref: '#/components/schemas/Type2' description: type: string configurationId: type: integer format: int32 data: type: object refs: type: object schemaVersion: type: string discriminator: propertyName: name mapping: imageUpdate: imageUpdate controlPlane: controlPlane managementPlane: managementPlane firewall: firewall QOS: QOS edgeDeviceSettings: edgeDeviceSettings deviceSettings: deviceSettings segmentBasedDeviceSettings: segmentBasedDeviceSettings WAN: WAN metaData: metaData imageUpdate: title: imageUpdate allOf: - $ref: '#/components/schemas/configuration_module' - required: - data type: object properties: data: $ref: '#/components/schemas/image_update_data' image_update_data: title: image_update_data required: - buildNumber - profileDeviceFamily - profileVersion - softwarePackageId - softwarePackageName - version - windowDurationMins - windowed type: object properties: buildNumber: type: string profileDeviceFamily: type: string profileVersion: type: string scheduledStartTime: $ref: '#/components/schemas/image_update_scheduled_time' softwarePackageId: type: integer format: int32 softwarePackageName: type: string version: type: string windowDurationMins: type: integer format: int32 windowed: type: boolean image_update_scheduled_time: title: image_update_scheduled_time required: - dayOfWeek - specified - timeOfDayMins - useEdgeTimeZone type: object properties: dayOfWeek: type: integer format: int32 specified: type: boolean timeOfDayMins: type: integer format: int32 useEdgeTimeZone: type: boolean controlPlane: title: controlPlane allOf: - $ref: '#/components/schemas/configuration_module' - required: - data type: object properties: data: $ref: '#/components/schemas/control_plane_data' control_plane_data: title: control_plane_data required: - gatewaySelection type: object properties: gatewaySelection: $ref: '#/components/schemas/GatewaySelection' vpn: $ref: '#/components/schemas/Vpn' ipsecGatewayDetail: type: object additionalProperties: $ref: '#/components/schemas/IpsecGatewayDetail' managementPlane: title: managementPlane allOf: - $ref: '#/components/schemas/configuration_module' - required: - data type: object properties: data: $ref: '#/components/schemas/management_plane_data' management_plane_data: title: management_plane_data required: - heartBeatSeconds - managementPlaneProxy - statsUploadSeconds - timeSliceSeconds type: object properties: heartBeatSeconds: type: integer format: int32 managementPlaneProxy: $ref: '#/components/schemas/ManagementPlaneProxy' statsUploadSeconds: type: integer format: int32 timeSliceSeconds: type: integer format: int32 firewall: title: firewall allOf: - $ref: '#/components/schemas/configuration_module' - required: - data type: object properties: data: $ref: '#/components/schemas/firewall_data' firewall_data: title: firewall_data required: - firewall_enabled - inbound - segments type: object properties: firewall_enabled: type: boolean inboundLoggingEnabled: type: boolean default: false stateful_firewall_enabled: type: boolean firewall_logging_enabled: type: boolean inbound: type: array items: $ref: '#/components/schemas/firewall_inbound_rule' description: '' segments: type: array items: $ref: '#/components/schemas/firewall_segment' description: '' services: $ref: '#/components/schemas/Services' firewall_segment: title: firewall_segment required: - firewall_logging_enabled - outbound - segment type: object properties: firewall_logging_enabled: type: boolean stateful_firewall_enabled: type: boolean outbound: type: array items: $ref: '#/components/schemas/firewall_outbound_rule' description: '' segment: $ref: '#/components/schemas/configuration_module_segment_metadata' firewall_inbound_rule: title: firewall_inbound_rule required: - match - action type: object properties: name: type: string match: $ref: '#/components/schemas/firewall_rule_match' action: $ref: '#/components/schemas/Action1' ruleLogicalId: type: string firewall_outbound_rule: title: firewall_outbound_rule required: - match - action type: object properties: name: type: string match: $ref: '#/components/schemas/firewall_rule_match' action: $ref: '#/components/schemas/Action2' ruleLogicalId: type: string netflow_filter: title: netflow_filter required: - id - created - operatorId - networkId - enterpriseId - edgeId - gatewayId - parentGroupId - description - object - name - type - logicalId - alertsEnabled - operatorAlertsEnabled - status - statusModified - previousData - previousCreated - draftData - draftCreated - draftComment - data - lastContact - version - modified type: object properties: id: type: integer format: int32 created: type: string format: date-time operatorId: type: integer format: int32 networkId: type: integer format: int32 enterpriseId: type: integer format: int32 edgeId: type: integer format: int32 gatewayId: type: integer format: int32 parentGroupId: type: integer format: int32 description: type: string object: type: string name: type: string type: type: string logicalId: type: string alertsEnabled: $ref: '#/components/schemas/tinyint' operatorAlertsEnabled: $ref: '#/components/schemas/tinyint' status: type: string statusModified: type: string format: date-time previousData: type: object previousCreated: type: string format: date-time draftData: type: string draftCreated: type: string format: date-time draftComment: type: string data: $ref: '#/components/schemas/netflow_filter_data' lastContact: type: string format: date-time version: type: string modified: type: string format: date-time netflow_filter_data: title: netflow_filter_data required: - name - match - action type: object properties: name: type: string match: $ref: '#/components/schemas/netflow_filter_rule' action: $ref: '#/components/schemas/Action3' netflow_filter_rule: title: netflow_filter_rule type: object properties: appid: type: integer description: Integer ID corresponding to an application in the network-level application map format: int32 classid: type: integer description: Integer ID corresponding to an application class in the network-level application map format: int32 dscp: type: integer description: 'Integer ID indicating DSCP classification, where mappings are as follows: [EF:46,VA:44,AF11:10,AF12:12,AF13:14,AF21:18,AF22:20,AF23:22,AF31:26,AF32:28,AF33:30,AF41:34,AF42:36,AF43:38,CS0:0,CS1:8,CS2:16,CS3:24,CS4:32,CS5:40,CS6:48,CS7:56]' format: int32 sip: type: string description: Source IP address sport_high: type: integer description: Upper bound of a source port range format: int32 sport_low: type: integer description: Lower bound of a source port range format: int32 sAddressGroup: type: string description: Source address group reference sPortGroup: type: string description: Source port group reference ssm: type: string description: Source subnet mask, e.g. 255.255.255.0 smac: type: string description: Source MAC address svlan: type: integer description: Integer ID for the source VLAN format: int32 os_version: type: integer description: 'Index corresponding to the OS in the array: [OTHER,WINDOWS,LINUX,MACOS,IOS,ANDROID,EDGE]' format: int32 hostname: type: string dip: type: string description: Destination IP address dport_low: type: integer description: Lower bound of a destination port range format: int32 dport_high: type: integer description: Upper bound of a destination port range format: int32 dAddressGroup: type: string description: Destination address group reference dPortGroup: type: string description: Destination port group reference dsm: type: string description: Destination subnet mask e.g. 255.255.255.0 dmac: type: string description: Destination MAC address dvlan: type: integer description: Integer ID for the destination VLAN format: int32 proto: type: integer description: Integer ID corresponding to a protocol format: int32 s_rule_type: $ref: '#/components/schemas/SRuleType' d_rule_type: $ref: '#/components/schemas/DRuleType' firewall_rule_match: title: firewall_rule_match type: object properties: appid: type: integer description: Integer ID corresponding to an application in the network-level application map format: int32 classid: type: integer description: Integer ID corresponding to an application class in the network-level application map format: int32 dscp: type: integer description: 'Integer ID indicating DSCP classification, where mappings are as follows: [EF:46,VA:44,AF11:10,AF12:12,AF13:14,AF21:18,AF22:20,AF23:22,AF31:26,AF32:28,AF33:30,AF41:34,AF42:36,AF43:38,CS0:0,CS1:8,CS2:16,CS3:24,CS4:32,CS5:40,CS6:48,CS7:56]' format: int32 sip: type: string description: Source IP address sport_high: type: integer description: Upper bound of a source port range format: int32 sport_low: type: integer description: Lower bound of a source port range format: int32 ssm: type: string description: Source subnet mask, e.g. 255.255.255.0 smac: type: string description: Source MAC address svlan: type: integer description: Integer ID for the source VLAN format: int32 os_version: type: integer description: 'Index corresponding to the OS in the array: [OTHER,WINDOWS,LINUX,MACOS,IOS,ANDROID,EDGE]' format: int32 hostname: type: string dip: type: string description: Destination IP address dport_low: type: integer description: Lower bound of a destination port range format: int32 dport_high: type: integer description: Upper bound of a destination port range format: int32 dsm: type: string description: Destination subnet mask e.g. 255.255.255.0 dmac: type: string description: Destination MAC address dvlan: type: integer description: Integer ID for the destination VLAN format: int32 proto: type: integer description: Integer ID corresponding to a protocol format: int32 s_rule_type: $ref: '#/components/schemas/SRuleType' d_rule_type: $ref: '#/components/schemas/DRuleType' QOS: title: QOS allOf: - $ref: '#/components/schemas/configuration_module' - required: - data type: object properties: data: $ref: '#/components/schemas/QOSData' refs: $ref: '#/components/schemas/QOSRefs' QOSData: title: QOSData required: - segments type: object properties: serviceRateLimit: $ref: '#/components/schemas/ServiceRateLimit' segments: type: array items: $ref: '#/components/schemas/QOSSegments' description: '' QOSSegments: title: QOSSegments required: - rules - webProxy - segment type: object properties: rules: type: array items: $ref: '#/components/schemas/QOS_business_rules' description: '' defaults: type: array items: $ref: '#/components/schemas/QOS_business_rules' description: '' webProxy: $ref: '#/components/schemas/WebProxy' cosMapping: $ref: '#/components/schemas/CosMapping2' segment: $ref: '#/components/schemas/configuration_module_segment_metadata' QOS_business_rules: title: QOS_business_rules type: object properties: name: type: string match: $ref: '#/components/schemas/Match' action: $ref: '#/components/schemas/Action4' ruleLogicalId: type: string description: Globally unique identifier for the policy rule route_action_object: title: route_action_object type: object properties: interface: type: string linkInternalLogicalId: type: string linkPolicy: type: string routeCfg: type: object routePolicy: type: string serviceGroup: type: string vlanId: type: integer format: int32 wanlink: type: string linkCosLogicalId: type: string linkOuterDscpTag: type: string linkInnerDscpTag: type: string cos_mapping: title: cos_mapping type: object properties: high: $ref: '#/components/schemas/cos_mapping_value' normal: $ref: '#/components/schemas/cos_mapping_value' low: $ref: '#/components/schemas/cos_mapping_value' cos_mapping_value: title: cos_mapping_value type: object properties: value: type: integer format: int32 ratelimit: type: boolean QOSRefs: title: QOSRefs type: object properties: deviceSettings:backHaulEdge: type: object deviceSettings:dataCenter: type: object edgeDeviceSettings: title: edgeDeviceSettings allOf: - $ref: '#/components/schemas/configuration_module' - required: - data type: object properties: data: $ref: '#/components/schemas/edgeDeviceSettingsData' refs: $ref: '#/components/schemas/deviceSettingsRefs' edgeDeviceSettingsData: title: edgeDeviceSettingsData type: object properties: bgp: $ref: '#/components/schemas/Bgp' lan: $ref: '#/components/schemas/Lan' routedInterfaces: type: array items: $ref: '#/components/schemas/RoutedInterface' description: '' routes: $ref: '#/components/schemas/Routes' ha: $ref: '#/components/schemas/device_settings_ha' dns: $ref: '#/components/schemas/Dns1' netflow: $ref: '#/components/schemas/Netflow' vqm: $ref: '#/components/schemas/Vqm' vrrp: $ref: '#/components/schemas/device_settings_vrrp' snmp: $ref: '#/components/schemas/Snmp1' multiSourceQos: $ref: '#/components/schemas/MultiSourceQos' tacacs: $ref: '#/components/schemas/Tacacs' edgeDeviceSettingsDataDhcpServer: title: edgeDeviceSettingsDataDhcpServer type: object properties: baseDhcpAddr: type: integer format: int32 enabled: type: boolean leaseTimeSeconds: type: integer format: int32 dhcpRelay: $ref: '#/components/schemas/DhcpRelay' numDhcpAddr: type: integer format: int32 staticReserved: type: integer format: int32 options: type: array items: $ref: '#/components/schemas/device_settings_dhcp_option' description: '' deviceSettings: title: deviceSettings allOf: - $ref: '#/components/schemas/configuration_module' - required: - data type: object properties: data: $ref: '#/components/schemas/deviceSettingsData' refs: $ref: '#/components/schemas/deviceSettingsRefs' segmentBasedDeviceSettings: title: segmentBasedDeviceSettings allOf: - $ref: '#/components/schemas/configuration_module' - required: - data type: object properties: data: $ref: '#/components/schemas/segmentBasedDeviceSettingsData' refs: $ref: '#/components/schemas/deviceSettingsRefs' deviceSettingsRefs: title: deviceSettingsRefs type: object properties: deviceSettings:authentication: type: object deviceSettings:css:provider: type: object deviceSettings:css:site: type: object deviceSettings:dns:backupProvider: type: object deviceSettings:dns:primaryProvider: type: object deviceSettings:dns:privateProviders: type: object deviceSettings:handOffGateways:gateways: type: object deviceSettings:lan:allocation: type: object deviceSettings:securityVnf:license: type: object deviceSettings:securityVnf:service: type: object deviceSettings:segment: type: object deviceSettings:segment:netflowCollectors: type: object deviceSettings:segment:netflowFilters: type: object deviceSettings:tacacs: type: object deviceSettings:vnfs:edge: type: object deviceSettings:vnfs:vnfImage: type: object deviceSettings:vpn:dataCenter: type: object deviceSettings:vpn:edgeHub: type: object deviceSettings:vpn:edgeHubCluster: type: object deviceSettings:webProxy:provider: type: object ref: title: ref required: - configurationId - moduleId - logicalId - enterpriseObjectId - segmentLogicalId - segmentObjectId type: object properties: id: type: integer format: int32 configurationId: type: integer format: int32 moduleId: type: integer format: int32 logicalId: type: string enterpriseObjectId: type: integer format: int32 segmentLogicalId: type: string segmentObjectId: type: integer format: int32 ref: type: string deviceSettingsData: title: deviceSettingsData type: object properties: lan: $ref: '#/components/schemas/Lan1' ospf: $ref: '#/components/schemas/Ospf2' bgp: $ref: '#/components/schemas/Bgp1' dns: $ref: '#/components/schemas/Dns1' authentication: $ref: '#/components/schemas/Authentication' softwareUpdate: $ref: '#/components/schemas/device_settings_software_update' radioSettings: $ref: '#/components/schemas/device_settings_radio_settings' netflow: $ref: '#/components/schemas/Netflow1' vqm: $ref: '#/components/schemas/Vqm1' snmp: $ref: '#/components/schemas/Snmp2' multiSourceQos: $ref: '#/components/schemas/MultiSourceQos1' models: $ref: '#/components/schemas/Models' vpn: $ref: '#/components/schemas/Vpn1' segmentBasedDeviceSettingsData: title: segmentBasedDeviceSettingsData type: object properties: ha: $ref: '#/components/schemas/device_settings_ha' lan: $ref: '#/components/schemas/device_settings_lan' models: type: object additionalProperties: $ref: '#/components/schemas/device_settings_model' multiSourceQos: $ref: '#/components/schemas/device_settings_multi_source_qos' ntp: $ref: '#/components/schemas/device_settings_ntp' radioSettings: $ref: '#/components/schemas/device_settings_radio_settings' routedInterfaces: type: array items: $ref: '#/components/schemas/device_settings_routed_interface' description: '' segments: type: array items: $ref: '#/components/schemas/device_settings_segment' description: '' snmp: $ref: '#/components/schemas/device_settings_snmp' softwareUpdate: $ref: '#/components/schemas/device_settings_software_update' tacacs: $ref: '#/components/schemas/device_settings_tacacs' vnfs: $ref: '#/components/schemas/device_settings_vnfs' device_settings_authentication: title: device_settings_authentication type: object properties: override: type: boolean ref: $ref: '#/components/schemas/Ref9' device_settings_bgp: title: device_settings_bgp type: object properties: enabled: type: boolean override: type: boolean ASN: type: string connectedRoutes: type: boolean defaultRoute: $ref: '#/components/schemas/DefaultRoute' disableASPathCarryOver: type: boolean filters: type: array items: $ref: '#/components/schemas/device_settings_bgp_filter' description: '' holdtime: type: string isEdge: type: boolean keepalive: type: string neighbors: type: array items: $ref: '#/components/schemas/device_settings_bgp_neighbor' description: '' networks: type: array items: $ref: '#/components/schemas/device_settings_bgp_network' description: '' ospf: $ref: '#/components/schemas/device_settings_bgp_ospf_redistribution' overlayPrefix: type: boolean propagateUplink: type: boolean routerId: type: string uplinkCommunity: type: string device_settings_bgp_filter: title: device_settings_bgp_filter type: object properties: ids: type: array items: type: string description: '' name: type: string rules: type: array items: $ref: '#/components/schemas/device_settings_bgp_filter_rule' description: '' device_settings_bgp_filter_rule: title: device_settings_bgp_filter_rule type: object properties: action: $ref: '#/components/schemas/Action7' match: $ref: '#/components/schemas/Match2' device_settings_bgp_neighbor: title: device_settings_bgp_neighbor type: object properties: neighborAS: type: string neighborIp: type: string neighborTag: $ref: '#/components/schemas/NeighborTag' inboundFilter: $ref: '#/components/schemas/device_settings_bgp_filter_set' outboundFilter: $ref: '#/components/schemas/device_settings_bgp_filter_set' allowAS: type: boolean connect: type: string defaultRoute: type: boolean holdtime: type: string keepalive: type: string enableMd5: type: boolean md5Password: type: string device_settings_bgp_filter_set: title: device_settings_bgp_filter_set type: object properties: ids: type: array items: type: string description: '' device_settings_bgp_network: title: device_settings_bgp_network type: object properties: cidrIp: type: string cidrPrefix: type: integer format: int32 segmentId: type: string device_settings_bgp_ospf_redistribution: title: device_settings_bgp_ospf_redistribution type: object properties: enabled: type: boolean metric: type: integer format: int32 device_settings_cloud_security: title: device_settings_cloud_security type: object properties: enabled: type: boolean override: type: boolean config: $ref: '#/components/schemas/Config' provider: $ref: '#/components/schemas/Provider' sites: type: array items: $ref: '#/components/schemas/device_settings_cloud_security_site' description: '' device_settings_cloud_security_site: title: device_settings_cloud_security_site type: object properties: data: type: object logicalId: type: string device_settings_dns: title: device_settings_dns type: object properties: override: type: boolean primaryProvider: $ref: '#/components/schemas/PrimaryProvider2' backupProvider: $ref: '#/components/schemas/BackupProvider2' privateProviders: $ref: '#/components/schemas/PrivateProviders2' device_settings_ha: title: device_settings_ha type: object properties: enabled: type: boolean interface: type: string device_settings_handoff_gateways: title: device_settings_handoff_gateways type: object properties: override: type: boolean autoSelect: type: boolean gatewayList: type: array items: $ref: '#/components/schemas/device_settings_handoff_gateway' description: '' gateways: type: array items: $ref: '#/components/schemas/logicalid_reference' description: '' device_settings_handoff_gateway: title: device_settings_handoff_gateway type: object properties: logicalId: type: string ipsecDetail: $ref: '#/components/schemas/device_settings_handoff_gateway_ipsec_detail' device_settings_handoff_gateway_ipsec_detail: title: device_settings_handoff_gateway_ipsec_detail type: object properties: ipsecGatewayAddress: type: string strictHostCheck: type: boolean device_settings_model: title: device_settings_model type: object properties: lan: $ref: '#/components/schemas/device_settings_lan' routedInterfaces: type: array items: $ref: '#/components/schemas/device_settings_routed_interface' description: '' device_settings_multicast: title: device_settings_multicast type: object properties: enabled: type: boolean override: type: boolean igmpHostQueryIntervalSeconds: type: integer format: int32 igmpMaxQueryResponse: type: integer format: int32 pimKeepAliveTimerSeconds: type: integer format: int32 pimOnWanOverlay: $ref: '#/components/schemas/device_settings_multicast_pim_on_wan_overlay' pimPruneIntervalSeconds: type: integer format: int32 rp: $ref: '#/components/schemas/device_settings_multicast_rp' device_settings_multicast_pim_on_wan_overlay: title: device_settings_multicast_pim_on_wan_overlay type: object properties: enabled: type: boolean type: $ref: '#/components/schemas/Type16' sourceCidrIp: type: string sourceInterface: type: string device_settings_multicast_rp: title: device_settings_multicast_rp type: object properties: type: $ref: '#/components/schemas/Type17' staticGroups: type: array items: $ref: '#/components/schemas/device_settings_multicast_rp_static_group' description: '' device_settings_multicast_rp_static_group: title: device_settings_multicast_rp_static_group type: object properties: multicastGroups: type: array items: type: string description: '' rpAddress: type: string device_settings_netflow_collector: title: device_settings_netflow_collector type: object properties: type: type: string sourceInterface: type: string name: type: string allowAllSegment: type: boolean logicalId: type: string filterList: type: array items: $ref: '#/components/schemas/device_settings_netflow_filter_list' description: '' device_settings_netflow_filter_list: title: device_settings_netflow_filter_list type: object properties: type: type: string name: type: string logicalId: type: string device_settings_nat: title: device_settings_nat type: object properties: override: type: boolean rules: maxItems: 256 type: array items: $ref: '#/components/schemas/device_settings_nat_rule' description: '' device_settings_nat_rule: title: device_settings_nat_rule required: - type - insideCidrIp - insideCidrPrefix - insideNetmask - outsideCidrIp - outsideCidrPrefix - outsideNetmask type: object properties: type: $ref: '#/components/schemas/Type18' description: type: string insideCidrIp: type: string insideCidrPrefix: type: integer format: int32 insideNetmask: type: string insidePort: type: integer format: int32 outsideCidrIp: type: string outsideCidrPrefix: type: integer format: int32 outsideNetmask: type: string outsidePort: type: integer format: int32 device_settings_netflow: title: device_settings_netflow type: object properties: enabled: type: boolean override: type: boolean collectors: type: array items: $ref: '#/components/schemas/device_settings_netflow_collector' description: '' version: type: integer format: int32 intervals: $ref: '#/components/schemas/Intervals' netflow_collector: title: netflow_collector required: - id - created - operatorId - networkId - enterpriseId - edgeId - gatewayId - parentGroupId - description - object - name - type - logicalId - alertsEnabled - operatorAlertsEnabled - status - statusModified - previousData - previousCreated - draftData - draftCreated - draftComment - data - lastContact - version - modified type: object properties: id: type: integer format: int32 created: type: string format: date-time operatorId: type: integer format: int32 networkId: type: integer format: int32 enterpriseId: type: integer format: int32 edgeId: type: integer format: int32 gatewayId: type: integer format: int32 parentGroupId: type: integer format: int32 description: type: string object: type: string name: type: string type: type: string logicalId: type: string alertsEnabled: $ref: '#/components/schemas/tinyint' operatorAlertsEnabled: $ref: '#/components/schemas/tinyint' status: type: string statusModified: type: string format: date-time previousData: type: object previousCreated: type: string format: date-time draftData: type: string draftCreated: type: string format: date-time draftComment: type: string data: $ref: '#/components/schemas/netflow_collector_data' lastContact: type: string format: date-time version: type: string modified: type: string format: date-time netflow_collector_data: title: netflow_collector_data required: - name - address - port type: object properties: name: type: string address: type: string port: type: integer format: int32 device_settings_vqm_collector: title: device_settings_vqm_collector type: object properties: address: type: string port: type: integer format: int32 device_settings_ospf: title: device_settings_ospf type: object properties: enabled: type: boolean areas: type: array items: $ref: '#/components/schemas/device_settings_ospf_area' description: '' bgp: $ref: '#/components/schemas/device_settings_ospf_bgp_redistribution' defaultPrefixes: type: boolean defaultRouteAdvertise: $ref: '#/components/schemas/DefaultRouteAdvertise' defaultRoutes: $ref: '#/components/schemas/DefaultRoutes' device_settings_ospf_area: title: device_settings_ospf_area type: object properties: id: type: integer format: int32 name: type: string type: type: string device_settings_ospf_bgp_redistribution: title: device_settings_ospf_bgp_redistribution type: object properties: enabled: type: boolean metric: type: integer format: int32 metricType: $ref: '#/components/schemas/MetricType' device_settings_syslog: title: device_settings_syslog required: - enabled - collectors type: object properties: enabled: type: boolean facilityCode: $ref: '#/components/schemas/FacilityCode' override: type: boolean collectors: type: array items: $ref: '#/components/schemas/device_settings_syslog_collector' description: '' device_settings_syslog_collector: title: device_settings_syslog_collector required: - host - port - protocol - roles - severity - sourceInterface type: object properties: host: type: string port: type: integer format: int32 protocol: $ref: '#/components/schemas/Protocol' roles: type: array items: $ref: '#/components/schemas/Role3' description: '' severity: $ref: '#/components/schemas/Severity1' sourceInterface: type: string device_settings_static_route: title: device_settings_static_route type: object properties: destination: type: string netmask: type: string sourceIp: type: string gateway: type: string cost: type: integer format: int32 preferred: type: boolean description: type: string cidrPrefix: type: string wanInterface: type: string icmpProbeLogicalId: type: string vlanId: type: integer format: int32 advertise: type: boolean subinterfaceId: type: integer format: int32 configuration_module_segment_metadata: title: configuration_module_segment_metadata type: object properties: name: type: string segmentId: type: integer format: int32 type: $ref: '#/components/schemas/Type4' device_settings_vpn: title: device_settings_vpn type: object properties: enabled: type: boolean edgeToDataCenter: type: boolean ref: $ref: '#/components/schemas/Ref5' isolationGroupId: type: string edgeToEdgeHub: $ref: '#/components/schemas/EdgeToEdgeHub1' edgeToEdge: type: boolean edgeToEdgeDetail: $ref: '#/components/schemas/EdgeToEdgeDetail2' device_settings_vpn_profile_isolation_deprecated: title: device_settings_vpn_profile_isolation_deprecated type: object properties: enabled: type: boolean profileLogicalId: type: string isolateDynamic: type: boolean device_settings_vpn_profile_isolation: title: device_settings_vpn_profile_isolation type: object properties: enabled: type: boolean device_settings_vpn_profile_isolation_group: title: device_settings_vpn_profile_isolation_group type: object properties: logicalId: type: string device_settings_vpn_hub: title: device_settings_vpn_hub type: object properties: logicalId: type: string name: type: string type: $ref: '#/components/schemas/Type19' device_settings_vqm: title: device_settings_vqm type: object properties: enabled: type: boolean override: type: boolean protocol: $ref: '#/components/schemas/Protocol1' collectors: type: array items: $ref: '#/components/schemas/device_settings_vqm_collector' description: '' device_settings_vrrp: title: device_settings_vrrp type: object properties: enabled: type: boolean data: type: array items: $ref: '#/components/schemas/device_settings_vrrp_virtual_router' description: '' device_settings_vrrp_virtual_router: title: device_settings_vrrp_virtual_router type: object properties: cidrIp: type: string interface: type: string interval: type: integer format: int32 preempt: type: boolean preemptDelay: type: integer format: int32 priority: type: integer format: int32 subinterfaceId: type: integer format: int32 vlanId: type: integer format: int32 vrid: type: integer format: int32 device_settings_lan: title: device_settings_lan type: object properties: interfaces: type: array items: $ref: '#/components/schemas/device_settings_lan_interface' description: '' management: $ref: '#/components/schemas/subnet' networks: type: array items: $ref: '#/components/schemas/device_settings_lan_network' description: '' visibility: $ref: '#/components/schemas/Visibility' device_settings_lan_interface: title: device_settings_lan_interface type: object properties: override: type: boolean name: type: string cwp: type: boolean disabled: type: boolean l2: $ref: '#/components/schemas/device_settings_routed_interface_l2' portMode: $ref: '#/components/schemas/PortMode' space: type: string type: $ref: '#/components/schemas/Type7' untaggedVlan: type: integer format: int32 vlanIds: type: array items: type: integer format: int32 description: '' authenticationType: $ref: '#/components/schemas/AuthenticationType' broadcastSsid: type: boolean passphrase: type: string ssid: type: string securityMode: $ref: '#/components/schemas/SecurityMode' device_settings_lan_network: title: device_settings_lan_network type: object properties: override: type: boolean advertise: type: boolean pingResponse: type: boolean default: true bindEdgeAddress: type: boolean baseDhcpAddr: type: integer format: int32 cidrIp: type: string cidrPrefix: type: integer format: int32 cost: type: integer format: int32 dhcp: $ref: '#/components/schemas/device_settings_dhcp' disabled: type: boolean interfaces: type: array items: type: string description: '' multicast: $ref: '#/components/schemas/Multicast' name: type: string netmask: type: string numDhcpAddr: type: integer format: int32 ospf: $ref: '#/components/schemas/Ospf4' segmentId: type: integer format: int32 staticReserved: type: integer format: int32 vlanId: type: integer format: int32 device_settings_dhcp: title: device_settings_dhcp type: object properties: enabled: type: boolean dhcpRelay: $ref: '#/components/schemas/device_settings_dhcp_relay' leaseTimeSeconds: type: integer format: int32 baseDhcpAddr: type: integer format: int32 numDhcpAddr: type: integer format: int32 options: type: array items: $ref: '#/components/schemas/device_settings_dhcp_option' description: '' override: type: boolean device_settings_dhcp_relay: title: device_settings_dhcp_relay type: object properties: enabled: type: boolean servers: type: array items: type: string description: '' device_settings_dhcp_option: title: device_settings_dhcp_option type: object properties: option: type: integer format: int32 value: type: string type: type: string metaData: $ref: '#/components/schemas/MetaData1' device_settings_multi_source_qos: title: device_settings_multi_source_qos type: object properties: enabled: type: boolean override: type: boolean highRatio: type: integer format: int32 normalRatio: type: integer format: int32 lowRatio: type: integer format: int32 maxCapThreshold: type: integer format: int32 minCapThreshold: type: integer format: int32 device_settings_ntp: title: device_settings_ntp type: object properties: enabled: type: boolean override: type: boolean servers: type: array items: $ref: '#/components/schemas/device_settings_ntp_server' description: '' device_settings_ntp_server: title: device_settings_ntp_server type: object properties: server: type: string device_settings_radio_settings: title: device_settings_radio_settings type: object properties: country: type: string radios: type: array items: $ref: '#/components/schemas/device_settings_radio' description: '' device_settings_radio: title: device_settings_radio type: object properties: band: type: string channel: type: string isEnabled: type: boolean mode: type: string name: type: string radioId: type: integer format: int32 width: type: string device_settings_routed_interface: title: device_settings_routed_interface type: object properties: override: type: boolean addressing: $ref: '#/components/schemas/device_settings_routed_interface_addressing' advertise: type: boolean pingResponse: type: boolean default: true disabled: type: boolean dhcpServer: $ref: '#/components/schemas/device_settings_dhcp' encryptOverlay: type: boolean l2: $ref: '#/components/schemas/device_settings_routed_interface_l2' multicast: $ref: '#/components/schemas/Multicast' name: type: string natDirect: type: boolean ospf: $ref: '#/components/schemas/device_settings_routed_interface_ospf' radiusAuthentication: $ref: '#/components/schemas/RadiusAuthentication' segmentId: type: integer format: int32 subinterfaces: type: array items: $ref: '#/components/schemas/device_settings_subinterface' description: '' rpf: $ref: '#/components/schemas/Rpf' trusted: type: boolean underlayAccounting: type: boolean default: true vlanId: type: integer format: int32 wanOverlay: $ref: '#/components/schemas/WanOverlay' device_settings_routed_interface_addressing: title: device_settings_routed_interface_addressing type: object properties: type: $ref: '#/components/schemas/Type5' cidrPrefix: type: integer format: int32 cidrIp: type: string netmask: type: string gateway: type: string username: type: string password: type: string device_settings_routed_interface_ospf: title: device_settings_routed_interface_ospf type: object properties: area: type: integer format: int32 authentication: type: boolean authId: type: integer format: int32 authPassphrase: type: string cost: type: integer format: int32 deadTimer: type: integer format: int32 mode: type: string enabled: type: boolean exclusionRoutes: type: array items: type: object description: '' helloTimer: type: integer format: int32 inboundRouteLearning: $ref: '#/components/schemas/device_settings_routed_interface_ospf_filter' md5Authentication: type: boolean MTU: type: integer format: int32 outboundRouteAdvertisement: $ref: '#/components/schemas/device_settings_routed_interface_ospf_filter' passive: type: boolean vlanId: type: integer format: int32 device_settings_routed_interface_ospf_filter: title: device_settings_routed_interface_ospf_filter type: object properties: defaultAction: $ref: '#/components/schemas/DefaultAction' filters: type: array items: $ref: '#/components/schemas/Filter1' description: '' device_settings_routed_interface_l2: title: device_settings_routed_interface_l2 type: object properties: autonegotiation: type: boolean speed: type: string duplex: $ref: '#/components/schemas/Duplex' MTU: type: integer format: int32 device_settings_subinterface: title: device_settings_subinterface type: object properties: override: type: boolean addressing: $ref: '#/components/schemas/device_settings_routed_interface_addressing' advertise: type: boolean pingResponse: type: boolean default: true disabled: type: boolean dhcpServer: $ref: '#/components/schemas/device_settings_dhcp' encryptOverlay: type: boolean l2: $ref: '#/components/schemas/device_settings_routed_interface_l2' multicast: $ref: '#/components/schemas/Multicast' name: type: string natDirect: type: boolean ospf: $ref: '#/components/schemas/device_settings_routed_interface_ospf' radiusAuthentication: $ref: '#/components/schemas/RadiusAuthentication' segmentId: type: integer format: int32 subinterfaces: type: array items: $ref: '#/components/schemas/device_settings_subinterface' description: '' rpf: $ref: '#/components/schemas/Rpf' trusted: type: boolean underlayAccounting: type: boolean default: true vlanId: type: integer format: int32 wanOverlay: $ref: '#/components/schemas/WanOverlay' subinterfaceId: type: integer format: int32 subinterfaceType: $ref: '#/components/schemas/SubinterfaceType' device_settings_segment: title: device_settings_segment type: object properties: authentication: $ref: '#/components/schemas/device_settings_authentication' bgp: $ref: '#/components/schemas/device_settings_bgp' css: $ref: '#/components/schemas/device_settings_cloud_security' dns: $ref: '#/components/schemas/device_settings_dns' handOffControllers: $ref: '#/components/schemas/device_settings_handoff_gateways' handOffGateways: $ref: '#/components/schemas/device_settings_handoff_gateways' multiSourceQos: $ref: '#/components/schemas/device_settings_multi_source_qos' multicast: $ref: '#/components/schemas/device_settings_multicast' nat: $ref: '#/components/schemas/device_settings_nat' netflow: $ref: '#/components/schemas/device_settings_netflow' ntp: $ref: '#/components/schemas/device_settings_ntp' ospf: $ref: '#/components/schemas/device_settings_ospf' routes: $ref: '#/components/schemas/Routes' segment: $ref: '#/components/schemas/configuration_module_segment_metadata' snmp: $ref: '#/components/schemas/device_settings_snmp' syslog: $ref: '#/components/schemas/device_settings_syslog' vpn: $ref: '#/components/schemas/device_settings_vpn' vqm: $ref: '#/components/schemas/device_settings_vqm' vrrp: $ref: '#/components/schemas/device_settings_vrrp' device_settings_snmp: title: device_settings_snmp type: object properties: override: type: boolean port: type: integer format: int32 snmpv2c: $ref: '#/components/schemas/device_settings_snmpv2c' snmpv3: $ref: '#/components/schemas/device_settings_snmpv3' device_settings_snmpv2c: title: device_settings_snmpv2c type: object properties: enabled: type: boolean community: type: string allowedIp: type: array items: type: string description: '' device_settings_snmpv3: title: device_settings_snmpv3 type: object properties: enabled: type: boolean users: type: array items: $ref: '#/components/schemas/device_settings_snmpv3_user' description: '' device_settings_snmpv3_user: title: device_settings_snmpv3_user type: object properties: name: type: string passphrase: type: string authAlg: type: string privacy: type: boolean encrAlg: type: string device_settings_software_update: title: device_settings_software_update type: object properties: windowed: type: boolean window: $ref: '#/components/schemas/device_settings_software_update_window' device_settings_software_update_window: title: device_settings_software_update_window type: object properties: day: type: integer format: int32 beginHour: type: integer format: int32 endHour: type: integer format: int32 device_settings_tacacs: title: device_settings_tacacs type: object properties: ref: $ref: '#/components/schemas/Ref7' sourceInterface: type: string device_settings_vnfs: title: device_settings_vnfs type: object properties: edge: $ref: '#/components/schemas/Edge' hasVnfs: type: boolean securityVnf: $ref: '#/components/schemas/SecurityVnf' device_settings_security_vnf_vm: title: device_settings_security_vnf_vm type: object properties: type: pattern: securityVnf type: string vendor: $ref: '#/components/schemas/Vendor' edge: $ref: '#/components/schemas/Edge' license: $ref: '#/components/schemas/License2' service: $ref: '#/components/schemas/Service' uuid: type: string uuidTimestamp: type: string format: date-time WAN: title: WAN allOf: - $ref: '#/components/schemas/configuration_module' - required: - data type: object properties: data: $ref: '#/components/schemas/WAN_data' refs: type: object additionalProperties: $ref: '#/components/schemas/enterprise_service' WAN_data: title: WAN_data type: object properties: links: type: array items: $ref: '#/components/schemas/Link1' description: '' networks: type: array items: $ref: '#/components/schemas/Network2' description: '' metaData: title: metaData allOf: - $ref: '#/components/schemas/configuration_module' - required: - data type: object properties: data: $ref: '#/components/schemas/metadata_data' metadata_data: title: metadata_data type: object properties: applications: $ref: '#/components/schemas/Applications' application: title: application required: - class - description - displayName - id - knownIpPortMapping - protocolPortMapping type: object properties: class: type: integer format: int32 description: type: string displayName: type: string name: type: string id: type: integer format: int32 knownIpPortMapping: $ref: '#/components/schemas/ip_port_mapping' protocolPortMapping: $ref: '#/components/schemas/protocol_port_mapping' application_metadata: title: application_metadata required: - blobId - created - description - fileName - id - logicalId - manifest - modified - name - networkId - type - uploadDetails - version type: object properties: blobId: type: integer format: int32 created: type: string format: date-time description: type: string fileName: type: string id: type: integer format: int32 logicalId: type: string manifest: $ref: '#/components/schemas/application_metadata_manifest' modified: type: string format: date-time name: type: string networkId: type: integer format: int32 type: type: string uploadDetails: $ref: '#/components/schemas/application_metadata_upload_details' version: type: string application_metadata_manifest: title: application_metadata_manifest required: - description - name - version type: object properties: description: type: string name: type: string version: type: string application_metadata_upload_details: title: application_metadata_upload_details required: - size type: object properties: size: type: integer format: int32 auth_object: title: auth_object required: - password - username type: object properties: email: type: string password: type: string password2: type: string format: password username: type: string basic_metric: title: basic_metric enum: - packetsRx - packetsTx - totalPackets - bytesRx - bytesTx - totalBytes type: string edge_link_metric: title: edge_link_metric enum: - bytesRx - bytesTx - totalBytes - totalPackets - p1BytesRx - p1BytesTx - p1PacketsRx - p1PacketsTx - p2BytesRx - p2BytesTx - p2PacketsRx - p2PacketsTx - p3BytesRx - p3BytesTx - p3PacketsRx - p3PacketsTx - packetsRx - packetsTx - controlBytesRx - controlBytesTx - controlPacketsRx - controlPacketsTx - bestBwKbpsRx - bestBwKbpsTx - bestJitterMsRx - bestJitterMsTx - bestLatencyMsRx - bestLatencyMsTx - bestLossPctRx - bestLossPctTx - bpsOfBestPathRx - bpsOfBestPathTx - signalStrength - scoreTx - scoreRx type: string model_configuration: title: model_configuration type: object properties: configurationType: $ref: '#/components/schemas/ConfigurationType' created: type: string format: date-time description: type: string edgeCount: type: integer format: int32 effective: type: string format: date-time id: type: integer format: int32 logicalId: type: string modified: type: string format: date-time modules: type: array items: $ref: '#/components/schemas/configuration_module' description: '' name: type: string schemaVersion: type: string version: type: string bgp_peer_status: title: bgp_peer_status type: object properties: neighborIp: type: string neighborAS: type: integer format: int32 records: type: array items: $ref: '#/components/schemas/bgp_peer_status_record' description: '' bgp_peer_status_record: title: bgp_peer_status_record type: object properties: timestamp: type: string format: date-time state: $ref: '#/components/schemas/State2' msgRcvd: type: integer format: int32 pfxRcvd: type: integer format: int32 msgSent: type: integer format: int32 upDownTime: type: integer format: int32 config_edge_bgp_filter_set: title: config_edge_bgp_filter_set type: object properties: ids: type: array items: type: string description: '' config_edge_bgp_neighbor: title: config_edge_bgp_neighbor type: object properties: neighborAS: type: string neighborIp: type: string neighborTag: $ref: '#/components/schemas/NeighborTag' inboundFilter: $ref: '#/components/schemas/config_edge_bgp_filter_set' outboundFilter: $ref: '#/components/schemas/config_edge_bgp_filter_set' allowAS: type: boolean connect: type: string defaultRoute: type: boolean holdtime: type: string keepalive: type: string enableMd5: type: boolean md5Password: type: string configuration_clone_configuration_result: title: configuration_clone_configuration_result required: - id type: object properties: id: type: integer description: The ID of the newly cloned configuration format: int32 configuration_clone_and_convert_configuration_result: title: configuration_clone_and_convert_configuration_result required: - id type: object properties: id: type: integer description: The ID of the newly cloned configuration format: int32 configuration_clone_enterprise_template_result: title: configuration_clone_enterprise_template_result required: - id type: object properties: id: type: integer description: The ID of the newly cloned configuration format: int32 deletion_confirmation: title: deletion_confirmation required: - rows type: object properties: id: type: integer description: The id of the deleted object. format: int32 error: type: string description: An error message explaining why the method failed rows: type: integer description: The number of rows modified format: int32 example: id: 123 rows: 1 configuration_get_configuration_result: title: configuration_get_configuration_result required: - created - description - effective - id - modified - name - version type: object properties: configurationType: $ref: '#/components/schemas/ConfigurationType' created: type: string format: date-time description: type: string edgeCount: type: integer format: int32 effective: type: string format: date-time id: type: integer format: int32 logicalId: type: string modified: type: string format: date-time modules: type: array items: $ref: '#/components/schemas/configuration_module' description: '' name: type: string schemaVersion: type: string version: type: string configuration_get_routable_applications_result: title: configuration_get_routable_applications_result required: - applicationClassToApplication - applicationToApplicationClass - applicationClasses - applications - metaData type: object properties: applicationClassToApplication: type: object additionalProperties: type: integer format: int32 description: Maps application class IDs (strings) to application IDs (integers) applicationToApplicationClass: type: object additionalProperties: type: integer format: int32 description: Maps application IDs (strings) to class IDs (integers) applicationClasses: type: object additionalProperties: type: integer format: int32 description: Map of application class IDs to class names applications: type: array items: $ref: '#/components/schemas/application' description: '' metaData: $ref: '#/components/schemas/application_metadata' configuration_get_identifiable_applications_result: title: configuration_get_identifiable_applications_result required: - applicationClassToApplication - applicationToApplicationClass - applicationClasses - applications type: object properties: applicationClassToApplication: type: object additionalProperties: type: integer format: int32 description: Maps application class IDs (strings) to application IDs (integers) applicationToApplicationClass: type: object additionalProperties: type: integer format: int32 description: Maps application IDs (strings) to class IDs (integers) applicationClasses: type: object additionalProperties: type: integer format: int32 description: Map of application class IDs to class names applications: type: array items: $ref: '#/components/schemas/application' description: '' configuration_insert_configuration_module_result: title: configuration_insert_configuration_module_result required: - id type: object properties: id: type: integer description: The ID of the newly created configuration module format: int32 rows_modified_confirmation: title: rows_modified_confirmation required: - rows type: object properties: error: type: string description: An error message explaining why the method failed rows: type: integer description: The number of rows modified format: int32 example: rows: 1 base_enterprise_user: title: base_enterprise_user type: object properties: id: type: integer format: int32 created: type: string format: date-time userType: type: string username: type: string domain: type: string password: type: string format: password firstName: type: string lastName: type: string officePhone: type: string mobilePhone: type: string isNative: type: boolean isActive: type: boolean isLocked: type: boolean disableSecondFactor: type: boolean email: type: string lastLogin: type: string format: date-time modified: type: string format: date-time destinations: title: destinations type: object properties: ip_addr: type: string name: type: string disaster_recovery_client_contact: title: disaster_recovery_client_contact required: - activeAddress - activeLastResponseTime - clientLogicalId - clientType - id - modified - standbyAddress - standbyLastResponseTime type: object properties: activeAddress: type: string activeLastResponseTime: type: string format: date-time clientLogicalId: type: string clientType: $ref: '#/components/schemas/ClientType' id: type: integer format: int32 modified: type: string format: date-time standbyAddress: type: string standbyLastResponseTime: type: string format: date-time disaster_recovery_get_replication_blob_result: title: disaster_recovery_get_replication_blob_result required: - activeAccessFromStandby type: object properties: activeAccessFromStandby: type: string disaster_recovery_get_replication_status_result: title: disaster_recovery_get_replication_status_result required: - activeAddress - drState - drVCOUser - failureDescription - role - roleTimestamp - standbyList - vcoIp - vcoUuid type: object properties: activeAddress: type: string activeReplicationAddress: type: string clientContact: type: array items: $ref: '#/components/schemas/disaster_recovery_client_contact' description: '' clientCount: $ref: '#/components/schemas/ClientCount' drState: $ref: '#/components/schemas/DrState' drVCOUser: type: string failureDescription: type: string lastDrProtectedTime: type: string format: date-time role: $ref: '#/components/schemas/Role1' roleTimestamp: type: string format: date-time standbyList: type: array items: $ref: '#/components/schemas/StandbyList' description: '' stateHistory: type: array items: $ref: '#/components/schemas/StateHistory' description: '' stateTimestamp: type: string format: date-time vcoIp: type: string vcoReplicationIp: type: string vcoUuid: type: string edge_edge_provision_result: title: edge_edge_provision_result required: - id - activationKey type: object properties: id: type: integer format: int32 activationKey: type: string generatedCertificate: $ref: '#/components/schemas/GeneratedCertificate' edge_edge_request_reactivation_result: title: edge_edge_request_reactivation_result required: - activationKey - activationKeyExpires type: object properties: activationKey: type: string activationKeyExpires: type: string format: date-time edge_get_edge_configuration_stack_result_item: title: edge_get_edge_configuration_stack_result_item required: - created - description - id - modified - modules - name - version type: object properties: configurationType: $ref: '#/components/schemas/ConfigurationType' created: type: string format: date-time description: type: string edgeCount: type: integer format: int32 effective: type: string format: date-time id: type: integer format: int32 logicalId: type: string modified: type: string format: date-time modules: type: array items: $ref: '#/components/schemas/configuration_module' description: '' name: type: string schemaVersion: type: string version: type: string edge_get_edge_result: title: edge_get_edge_result required: - activationKey - activationKeyExpires - activationState - activationTime - alertsEnabled - buildNumber - created - description - deviceFamily - deviceId - dnsName - edgeState - edgeStateTime - endpointPkiMode - enterpriseId - haLastContact - haPreviousState - haSerialNumber - haState - id - isLive - lastContact - logicalId - modelNumber - modified - name - operatorAlertsEnabled - selfMacAddress - serialNumber - serviceState - serviceUpSince - siteId - softwareUpdated - softwareVersion - systemUpSince type: object properties: activationKey: type: string activationKeyExpires: type: string activationState: $ref: '#/components/schemas/ActivationState' activationTime: type: string alertsEnabled: $ref: '#/components/schemas/tinyint' buildNumber: type: string created: type: string description: type: string deviceFamily: type: string deviceId: type: string dnsName: type: string edgeState: $ref: '#/components/schemas/EdgeState' edgeStateTime: type: string endpointPkiMode: $ref: '#/components/schemas/EndpointPkiMode' enterpriseId: type: integer format: int32 haLastContact: type: string haPreviousState: $ref: '#/components/schemas/HaPreviousState' haSerialNumber: type: string haState: $ref: '#/components/schemas/HaState' id: type: integer format: int32 isLive: type: integer format: int32 lastContact: type: string logicalId: type: string modelNumber: type: string modified: type: string name: type: string operatorAlertsEnabled: $ref: '#/components/schemas/tinyint' selfMacAddress: type: string serialNumber: type: string serviceState: $ref: '#/components/schemas/ServiceState1' serviceUpSince: type: string siteId: type: integer format: int32 softwareUpdated: type: string softwareVersion: type: string systemUpSince: type: string configuration: $ref: '#/components/schemas/model_configuration' enterprise: $ref: '#/components/schemas/enterprise' links: type: array items: $ref: '#/components/schemas/link' description: '' recentLinks: type: array items: $ref: '#/components/schemas/link' description: '' site: $ref: '#/components/schemas/site' edge_object: title: edge_object type: object properties: activationKey: type: string activationKeyExpires: type: string activationState: $ref: '#/components/schemas/ActivationState' activationTime: type: string alertsEnabled: $ref: '#/components/schemas/tinyint' buildNumber: type: string created: type: string description: type: string deviceFamily: type: string deviceId: type: string dnsName: type: string edgeState: $ref: '#/components/schemas/EdgeState' edgeStateTime: type: string endpointPkiMode: $ref: '#/components/schemas/EndpointPkiMode' enterpriseId: type: integer format: int32 haLastContact: type: string haPreviousState: $ref: '#/components/schemas/HaPreviousState' haSerialNumber: type: string haState: $ref: '#/components/schemas/HaState' id: type: integer format: int32 isLive: type: integer format: int32 lastContact: type: string logicalId: type: string modelNumber: type: string modified: type: string name: type: string operatorAlertsEnabled: $ref: '#/components/schemas/tinyint' selfMacAddress: type: string serialNumber: type: string serviceState: $ref: '#/components/schemas/ServiceState1' serviceUpSince: type: string siteId: type: integer format: int32 softwareUpdated: type: string softwareVersion: type: string systemUpSince: type: string edge_update_edge_admin_password_result: title: edge_update_edge_admin_password_result required: - id type: object properties: id: type: string description: The ID of the action queued edge_update_edge_credentials_by_configuration_result: title: edge_update_edge_credentials_by_configuration_result required: - actionIds type: object properties: actionIds: type: array items: type: integer format: int32 description: '' insertion_confirmation: title: insertion_confirmation required: - rows type: object properties: id: type: integer description: The id of the newly-created object. format: int32 rows: type: integer description: The number of rows modified format: int32 error: type: string description: An error message explaining why the method failed example: id: 123 rows: 1 enterprise_alert_notification_user_data: title: enterprise_alert_notification_user_data required: - email - emailEnabled - enabled - enterpriseUserId - mobileEnabled - mobilePhone - smsEnabled - username type: object properties: email: type: string emailEnabled: type: integer format: int32 enabled: type: integer format: int32 enterpriseUserId: type: integer format: int32 mobileEnabled: type: integer format: int32 mobilePhone: type: string smsEnabled: type: integer format: int32 username: type: string enterprise_delete_enterprise_delete_enterprise_gateway_records_record: title: enterprise_delete_enterprise_delete_enterprise_gateway_records_record type: object properties: gatewayId: type: integer format: int32 neighborIp: type: string enterprise_enterprise_proxy: title: enterprise_enterprise_proxy required: - id - created - networkId - proxyType - operateGateways - logicalId - name - domain - prefix - description - contactName - contactPhone - contactMobile - contactEmail - streetAddress - streetAddress2 - city - state - postalCode - country - lat - lon - modified type: object properties: id: type: integer format: int32 created: type: string format: date-time networkId: type: integer format: int32 proxyType: $ref: '#/components/schemas/ProxyType' operateGateways: type: boolean logicalId: type: string name: type: string domain: type: string prefix: type: string description: type: string contactName: type: string contactPhone: type: string contactMobile: type: string contactEmail: type: string streetAddress: type: string streetAddress2: type: string city: type: string state: type: string postalCode: type: string country: type: string lat: type: number lon: type: number modified: type: string format: date-time enterprise_get_enterprise_addresses_result_item: title: enterprise_get_enterprise_addresses_result_item type: object properties: address: type: string entity: $ref: '#/components/schemas/Entity' enterprise_get_enterprise_alert_configurations_result_item: title: enterprise_get_enterprise_alert_configurations_result_item required: - id - created - alertDefinitionId - enterpriseId - enabled - name - description - type - definition - firstNotificationSeconds - maxNotifications - notificationIntervalSeconds - resetIntervalSeconds - modified type: object properties: id: type: integer format: int32 created: type: string format: date-time alertDefinitionId: type: integer format: int32 enterpriseId: type: integer format: int32 enabled: type: boolean name: $ref: '#/components/schemas/Name' description: type: string type: $ref: '#/components/schemas/Type' definition: $ref: '#/components/schemas/enterprise_alert_definition' firstNotificationSeconds: type: integer format: int32 maxNotifications: type: integer format: int32 notificationIntervalSeconds: type: integer format: int32 resetIntervalSeconds: type: integer format: int32 modified: type: string format: date-time enterprise_get_enterprise_alerts_result_item: title: enterprise_get_enterprise_alerts_result_item required: - id - created - triggerTime - enterpriseAlertConfigurationId - enterpriseId - edgeId - edgeName - linkId - linkName - enterpriseObjectId - enterpriseObjectName - name - type - state - stateSetTime - lastContact - firstNotificationSeconds - maxNotifications - notificationIntervalSeconds - resetIntervalSeconds - comment - nextNotificationTime - remainingNotifications - timezone - locale - modified type: object properties: id: type: integer format: int32 created: type: string format: date-time triggerTime: type: string format: date-time enterpriseAlertConfigurationId: type: integer format: int32 enterpriseId: type: integer format: int32 edgeId: type: integer format: int32 edgeName: type: string linkId: type: integer format: int32 linkName: type: string enterpriseObjectId: type: integer format: int32 enterpriseObjectName: type: string name: $ref: '#/components/schemas/Name' type: $ref: '#/components/schemas/Type' state: $ref: '#/components/schemas/State' stateSetTime: type: string format: date-time lastContact: type: string format: date-time firstNotificationSeconds: type: integer format: int32 maxNotifications: type: integer format: int32 notificationIntervalSeconds: type: integer format: int32 resetIntervalSeconds: type: integer format: int32 comment: type: string nextNotificationTime: type: string format: date-time remainingNotifications: type: integer format: int32 timezone: type: string locale: type: string modified: type: string format: date-time enterprise_get_enterprise_all_alert_recipients_result: title: enterprise_get_enterprise_all_alert_recipients_result required: - emailEnabled - emailList - enterpriseUsers - mobileEnabled - mobileList - smsEnabled - smsList type: object properties: emailEnabled: type: boolean emailList: type: array items: type: string description: '' enterpriseUsers: type: array items: $ref: '#/components/schemas/enterprise_alert_notification_user_data' description: '' mobileEnabled: type: boolean mobileList: type: array items: type: string description: '' smsEnabled: type: boolean smsList: type: array items: type: string description: '' snmpEnabled: type: boolean snmpList: type: array items: type: string description: '' enterprise_get_enterprise_capabilities_result: title: enterprise_get_enterprise_capabilities_result type: object properties: edgeVnfs.enable: type: boolean edgeVnfs.securityVnf.paloAlto: type: boolean edgeVnfs.securityVnf.checkpoint: type: boolean edgeVnfs.securityVnf.fortinet: type: boolean enableBGP: type: boolean enableCosMapping: type: boolean enableEnterpriseAuth: type: boolean enableFwLogs: type: boolean enableStatefulFirewall: type: boolean enableNetworks: type: boolean enableOSPF: type: boolean enablePKI: type: boolean enablePremium: type: boolean enableSegmentation: type: boolean enableServiceRateLimiting: type: boolean enableVQM: type: boolean example: edgeVnfs.enable: true edgeVnfs.securityVnf.paloAlto: true edgeVnfs.securityVnf.checkpoint: true edgeVnfs.securityVnf.fortinet: true enableBGP: false enableCosMapping: true enableEnterpriseAuth: true enableFwLogs: false enableStatefulFirewall: false enableNetworks: true enableOSPF: true enablePKI: true enablePremium: true enableSegmentation: true enableServiceRateLimiting: false enableVQM: true enterprise_get_enterprise_configurations_with_policies: title: enterprise_get_enterprise_configurations_with_policies type: object properties: enterpriseId: type: integer format: int32 enterprise_get_enterprise_configurations_result_item: title: enterprise_get_enterprise_configurations_result_item required: - created - description - effective - id - modified - name - version type: object properties: configurationType: $ref: '#/components/schemas/ConfigurationType' created: type: string format: date-time description: type: string edgeCount: type: integer format: int32 effective: type: string format: date-time id: type: integer format: int32 logicalId: type: string modified: type: string format: date-time modules: type: array items: $ref: '#/components/schemas/configuration_module' description: '' name: type: string schemaVersion: type: string version: type: string enterprise_get_enterprise_operator_configuration_type: title: enterprise_get_enterprise_operator_configuration_type type: object properties: enterpriseId: type: integer format: int32 enterprise_get_enterprise_operator_configuration_type_result: title: enterprise_get_enterprise_operator_configuration_type_result required: - configurationType type: object properties: configurationType: $ref: '#/components/schemas/ConfigurationType' enterprise_get_enterprise_edges_result_item: title: enterprise_get_enterprise_edges_result_item required: - activationKey - activationKeyExpires - activationState - activationTime - alertsEnabled - buildNumber - created - description - deviceFamily - deviceId - dnsName - edgeState - edgeStateTime - endpointPkiMode - enterpriseId - haLastContact - haPreviousState - haSerialNumber - haState - id - isLive - lastContact - logicalId - modelNumber - modified - name - operatorAlertsEnabled - selfMacAddress - serialNumber - serviceState - serviceUpSince - siteId - softwareUpdated - softwareVersion - systemUpSince type: object properties: activationKey: type: string activationKeyExpires: type: string activationState: $ref: '#/components/schemas/ActivationState' activationTime: type: string alertsEnabled: $ref: '#/components/schemas/tinyint' buildNumber: type: string created: type: string description: type: string deviceFamily: type: string deviceId: type: string dnsName: type: string edgeState: $ref: '#/components/schemas/EdgeState' edgeStateTime: type: string endpointPkiMode: $ref: '#/components/schemas/EndpointPkiMode' enterpriseId: type: integer format: int32 haLastContact: type: string haPreviousState: $ref: '#/components/schemas/HaPreviousState' haSerialNumber: type: string haState: $ref: '#/components/schemas/HaState' id: type: integer format: int32 isLive: type: integer format: int32 lastContact: type: string logicalId: type: string modelNumber: type: string modified: type: string name: type: string operatorAlertsEnabled: $ref: '#/components/schemas/tinyint' selfMacAddress: type: string serialNumber: type: string serviceState: $ref: '#/components/schemas/ServiceState1' serviceUpSince: type: string siteId: type: integer format: int32 softwareUpdated: type: string softwareVersion: type: string systemUpSince: type: string certificates: type: array items: $ref: '#/components/schemas/edge_certificate' description: '' configuration: $ref: '#/components/schemas/Configuration' ha: $ref: '#/components/schemas/Ha1' licenses: type: array items: $ref: '#/components/schemas/edge_license' description: '' links: type: array items: $ref: '#/components/schemas/link' description: '' recentLinks: type: array items: $ref: '#/components/schemas/link' description: '' site: $ref: '#/components/schemas/site' isHub: type: boolean isSoftwareVersionSupportedByVco: type: boolean edge_list_ha_details_active_standby: title: edge_list_ha_details_active_standby required: - haLastContact - haPreviousState - haSerialNumber - haState type: object properties: haLastContact: type: string format: date-time haPreviousState: $ref: '#/components/schemas/HaPreviousState' haSerialNumber: type: string haState: $ref: '#/components/schemas/HaState' edge_list_ha_details_active_active: title: edge_list_ha_details_active_active required: - clusterId - clusterName type: object properties: clusterId: type: integer format: int32 clusterName: type: string enterprise_get_enterprise_result: title: enterprise_get_enterprise_result required: - id - created - networkId - gatewayPoolId - alertsEnabled - operatorAlertsEnabled - endpointPkiMode - name - domain - prefix - logicalId - accountNumber - description - contactName - contactPhone - contactMobile - contactEmail - streetAddress - streetAddress2 - city - state - postalCode - country - lat - lon - timezone - locale - modified type: object properties: id: type: integer format: int32 created: type: string format: date-time networkId: type: integer format: int32 gatewayPoolId: type: integer format: int32 alertsEnabled: $ref: '#/components/schemas/tinyint' operatorAlertsEnabled: $ref: '#/components/schemas/tinyint' endpointPkiMode: $ref: '#/components/schemas/EndpointPkiMode' name: type: string domain: type: string prefix: type: string logicalId: type: string accountNumber: type: string description: type: string contactName: type: string contactPhone: type: string contactMobile: type: string contactEmail: type: string streetAddress: type: string streetAddress2: type: string city: type: string state: type: string postalCode: type: string country: type: string lat: type: number lon: type: number timezone: type: string locale: type: string modified: type: string format: date-time enterpriseProxy: $ref: '#/components/schemas/enterprise_enterprise_proxy' exit_entity_type: title: exit_entity_type required: - id - name - logicalId type: object properties: id: type: integer format: int32 name: type: string logicalId: type: string type: type: string enterprise_get_enterprise_route_table_result: title: enterprise_get_enterprise_route_table_result type: object properties: profiles: type: array items: $ref: '#/components/schemas/Profile' description: '' subnets: type: array items: $ref: '#/components/schemas/enterprise_route_collection' description: '' exits: $ref: '#/components/schemas/Exits' enterprise_get_enterprise_services_result_item: title: enterprise_get_enterprise_services_result_item required: - id - created - operatorId - networkId - enterpriseId - edgeId - gatewayId - parentGroupId - description - object - name - type - logicalId - alertsEnabled - operatorAlertsEnabled - status - statusModified - previousData - previousCreated - draftData - draftCreated - draftComment - data - lastContact - version - modified type: object properties: id: type: integer format: int32 created: type: string format: date-time operatorId: type: integer format: int32 networkId: type: integer format: int32 enterpriseId: type: integer format: int32 edgeId: type: integer format: int32 gatewayId: type: integer format: int32 parentGroupId: type: integer format: int32 description: type: string object: type: string name: type: string type: type: string logicalId: type: string alertsEnabled: $ref: '#/components/schemas/tinyint' operatorAlertsEnabled: $ref: '#/components/schemas/tinyint' status: type: string statusModified: type: string format: date-time previousData: type: object previousCreated: type: string format: date-time draftData: type: string draftCreated: type: string format: date-time draftComment: type: string data: type: object lastContact: type: string format: date-time version: type: string modified: type: string format: date-time profileCount: type: integer format: int32 edgeCount: type: integer format: int32 groupCount: type: integer format: int32 enterprise_object: title: enterprise_object type: object properties: id: type: integer format: int32 created: type: string format: date-time name: type: string contactName: type: string contactPhone: type: string contactMobile: type: string contactEmail: type: string streetAddress: type: string streetAddress2: type: string city: type: string state: type: string postalCode: type: string country: type: string lat: type: number lon: type: number timezone: type: string locale: type: string shippingSameAsLocation: $ref: '#/components/schemas/tinyint' shippingContactName: type: string shippingAddress: type: string shippingAddress2: type: string shippingCity: type: string shippingState: type: string shippingCountry: type: string shippingPostalCode: type: string modified: type: string format: date-time gatewayPoolId: type: integer format: int32 networkId: type: integer format: int32 returnData: type: boolean user: $ref: '#/components/schemas/auth_object' enterprise_insert_enterprise: title: enterprise_insert_enterprise required: - name - configurationId type: object properties: id: type: integer format: int32 created: type: string format: date-time name: type: string contactName: type: string contactPhone: type: string contactMobile: type: string contactEmail: type: string streetAddress: type: string streetAddress2: type: string city: type: string state: type: string postalCode: type: string country: type: string lat: type: number lon: type: number timezone: type: string locale: type: string shippingSameAsLocation: $ref: '#/components/schemas/tinyint' shippingContactName: type: string shippingAddress: type: string shippingAddress2: type: string shippingCity: type: string shippingState: type: string shippingCountry: type: string shippingPostalCode: type: string modified: type: string format: date-time gatewayPoolId: type: integer format: int32 networkId: type: integer format: int32 returnData: type: boolean user: $ref: '#/components/schemas/auth_object' configurationId: type: integer format: int32 enableEnterpriseDelegationToOperator: type: boolean enableEnterpriseDelegationToProxy: type: boolean enableEnterpriseUserManagementDelegationToOperator: type: boolean licenses: $ref: '#/components/schemas/Licenses' enterprise_update_enterprise: title: enterprise_update_enterprise type: object properties: id: type: integer format: int32 created: type: string format: date-time name: type: string contactName: type: string contactPhone: type: string contactMobile: type: string contactEmail: type: string streetAddress: type: string streetAddress2: type: string city: type: string state: type: string postalCode: type: string country: type: string lat: type: number lon: type: number timezone: type: string locale: type: string shippingSameAsLocation: $ref: '#/components/schemas/tinyint' shippingContactName: type: string shippingAddress: type: string shippingAddress2: type: string shippingCity: type: string shippingState: type: string shippingCountry: type: string shippingPostalCode: type: string modified: type: string format: date-time gatewayPoolId: type: integer format: int32 networkId: type: integer format: int32 returnData: type: boolean user: $ref: '#/components/schemas/User2' enterprise_update_enterprise_result: title: enterprise_update_enterprise_result required: - rows type: object properties: error: type: string description: An error message explaining why the method failed rows: type: integer description: The number of rows modified format: int32 example: rows: 1 enterprise_proxy_insert_enterprise_proxy_enterprise: title: enterprise_proxy_insert_enterprise_proxy_enterprise required: - name - configurationId type: object properties: id: type: integer format: int32 created: type: string format: date-time name: type: string contactName: type: string contactPhone: type: string contactMobile: type: string contactEmail: type: string streetAddress: type: string streetAddress2: type: string city: type: string state: type: string postalCode: type: string country: type: string lat: type: number lon: type: number timezone: type: string locale: type: string shippingSameAsLocation: $ref: '#/components/schemas/tinyint' shippingContactName: type: string shippingAddress: type: string shippingAddress2: type: string shippingCity: type: string shippingState: type: string shippingCountry: type: string shippingPostalCode: type: string modified: type: string format: date-time gatewayPoolId: type: integer format: int32 networkId: type: integer format: int32 returnData: type: boolean user: $ref: '#/components/schemas/auth_object' configurationId: type: integer format: int32 enableEnterpriseDelegationToOperator: type: boolean enableEnterpriseDelegationToProxy: type: boolean enableEnterpriseUserManagementDelegationToOperator: type: boolean licenses: $ref: '#/components/schemas/Licenses' enterpriseProxyId: type: integer format: int32 enterprise_proxy_get_enterprise_proxy_enterprises_result_item: title: enterprise_proxy_get_enterprise_proxy_enterprises_result_item type: object properties: id: type: integer format: int32 created: type: string format: date-time networkId: type: integer format: int32 gatewayPoolId: type: integer format: int32 alertsEnabled: $ref: '#/components/schemas/tinyint' operatorAlertsEnabled: $ref: '#/components/schemas/tinyint' endpointPkiMode: $ref: '#/components/schemas/EndpointPkiMode' name: type: string domain: type: string prefix: type: string logicalId: type: string accountNumber: type: string description: type: string contactName: type: string contactPhone: type: string contactMobile: type: string contactEmail: type: string streetAddress: type: string streetAddress2: type: string city: type: string state: type: string postalCode: type: string country: type: string lat: type: number lon: type: number timezone: type: string locale: type: string modified: type: string format: date-time edgeCount: type: integer format: int32 edges: type: array items: $ref: '#/components/schemas/enterprise_object' description: '' proxy_edge_inventory_object: title: proxy_edge_inventory_object required: - enterpriseName - enterpriseId - edgeName - edgeId - created - edgeState - serialNumber - haSerialNumber - activationState - activationTime - modelNumber - softwareVersion - softwareUpdated - lastContact type: object properties: enterpriseName: type: string enterpriseId: type: integer format: int32 edgeName: type: string edgeId: type: integer format: int32 created: type: string format: date-time edgeState: $ref: '#/components/schemas/EdgeState' serialNumber: type: string haSerialNumber: type: string activationState: $ref: '#/components/schemas/ActivationState' activationTime: type: string format: date-time modelNumber: type: string softwareVersion: type: string softwareUpdated: type: string format: date-time lastContact: type: string format: date-time enterprise_proxy_get_enterprise_proxy_operator_profiles_result_item: title: enterprise_proxy_get_enterprise_proxy_operator_profiles_result_item required: - created - description - effective - id - modified - name - version type: object properties: configurationType: $ref: '#/components/schemas/ConfigurationType' created: type: string format: date-time description: type: string edgeCount: type: integer format: int32 effective: type: string format: date-time id: type: integer format: int32 logicalId: type: string modified: type: string format: date-time modules: type: array items: $ref: '#/components/schemas/configuration_module' description: '' name: type: string schemaVersion: type: string version: type: string edges: type: array items: $ref: '#/components/schemas/edge_object' description: '' enterprises: type: array items: $ref: '#/components/schemas/configuration_enterprise' description: '' enterprise_insert_or_update_enterprise_alert_configurations_result: title: enterprise_insert_or_update_enterprise_alert_configurations_result type: object properties: enterpriseAlertConfigurations: type: array items: $ref: '#/components/schemas/enterprise_alert_configuration' description: '' enterprise_property: title: enterprise_property type: object properties: id: type: integer format: int32 enterpriseId: type: integer format: int32 created: type: string format: date-time name: type: string value: type: string isPassword: type: boolean dataType: $ref: '#/components/schemas/DataType' description: type: string modified: type: string format: date-time enterprise_get_enterprise_property_result: title: enterprise_get_enterprise_property_result required: - id - enterpriseId - created - name - value - isPassword - dataType - description - modified type: object properties: id: type: integer format: int32 enterpriseId: type: integer format: int32 created: type: string format: date-time name: type: string value: type: string isPassword: type: boolean dataType: $ref: '#/components/schemas/DataType' description: type: string modified: type: string format: date-time enterprise_get_enterprise_gateway_handoff_result: title: enterprise_get_enterprise_gateway_handoff_result required: - enterpriseId - value type: object properties: enterpriseId: type: integer format: int32 value: $ref: '#/components/schemas/gateway_handoff_value' id: type: integer format: int32 created: type: string format: date-time name: type: string isPassword: type: boolean dataType: type: string description: type: string modified: type: string format: date-time gateway_handoff: title: gateway_handoff type: object properties: enterpriseId: type: integer format: int32 value: $ref: '#/components/schemas/gateway_handoff_value' enterprise_proxy_get_enterprise_proxy_gateway_pools_result_item: title: enterprise_proxy_get_enterprise_proxy_gateway_pools_result_item type: object properties: id: type: integer format: int32 networkId: type: integer format: int32 enterpriseProxyId: type: integer format: int32 created: type: string format: date-time name: type: string description: type: string isDefault: type: boolean handOffType: $ref: '#/components/schemas/HandOffType1' modified: type: string format: date-time enterprises: type: array items: $ref: '#/components/schemas/enterprise' description: '' gateways: type: array items: $ref: '#/components/schemas/gateway_pool_gateway' description: '' enterprise_route_collection: title: enterprise_route_collection type: object properties: eligableExits: type: array items: $ref: '#/components/schemas/enterprise_route' description: '' preferredExits: type: array items: $ref: '#/components/schemas/enterprise_route' description: '' subnet: type: string enterprise_update_enterprise_route_result: title: enterprise_update_enterprise_route_result required: - eligableExits - preferredExits - subnet type: object properties: eligableExits: type: array items: $ref: '#/components/schemas/enterprise_route' description: '' preferredExits: type: array items: $ref: '#/components/schemas/enterprise_route' description: '' subnet: type: string event_get_enterprise_events_result: title: event_get_enterprise_events_result required: - data - metaData type: object properties: data: type: array items: $ref: '#/components/schemas/enterprise_event' description: '' metaData: $ref: '#/components/schemas/list_metadata' event_get_operator_events_result: title: event_get_operator_events_result required: - data - metaData type: object properties: data: type: array items: $ref: '#/components/schemas/operator_event' description: '' metaData: $ref: '#/components/schemas/list_metadata' event_get_proxy_events_result: title: event_get_proxy_events_result required: - data - metaData type: object properties: data: type: array items: $ref: '#/components/schemas/proxy_event' description: '' metaData: $ref: '#/components/schemas/list_metadata' flow_metric_summary: title: flow_metric_summary type: object properties: bytesRx: type: integer format: int64 bytesTx: type: integer format: int64 flowCount: type: integer format: int32 packetsRx: type: integer format: int64 packetsTx: type: integer format: int64 totalBytes: type: integer format: int64 totalPackets: type: integer format: int64 time_series: title: time_series required: - data - max - metric - min - startTime - tickInterval - total type: object properties: data: type: array items: type: integer format: int64 description: '' max: type: integer format: int64 metric: $ref: '#/components/schemas/basic_metric' min: type: integer format: int64 startTime: type: string format: date-time tickInterval: type: integer format: int32 total: type: integer format: int64 time_series_metadata: title: time_series_metadata required: - series type: object properties: series: type: array items: $ref: '#/components/schemas/time_series' description: '' enterprise_user_with_role_info: title: enterprise_user_with_role_info type: object properties: id: type: integer format: int32 created: type: string format: date-time userType: type: string username: type: string domain: type: string password: type: string format: password firstName: type: string lastName: type: string officePhone: type: string mobilePhone: type: string isNative: type: boolean isActive: type: boolean isLocked: type: boolean disableSecondFactor: type: boolean email: type: string lastLogin: type: string format: date-time modified: type: string format: date-time roleId: type: integer format: int32 roleName: type: string enterprise_user_with_role_and_assocs: title: enterprise_user_with_role_and_assocs type: object properties: id: type: integer format: int32 created: type: string format: date-time userType: type: string username: type: string domain: type: string password: type: string format: password firstName: type: string lastName: type: string officePhone: type: string mobilePhone: type: string isNative: type: boolean isActive: type: boolean isLocked: type: boolean disableSecondFactor: type: boolean email: type: string lastLogin: type: string format: date-time modified: type: string format: date-time roleId: type: integer format: int32 roleName: type: string enterpriseId: type: integer format: int32 enterpriseProxyId: type: integer format: int32 networkId: type: integer format: int32 base_operator_user: title: base_operator_user type: object properties: id: type: integer format: int32 created: type: string format: date-time operatorId: type: integer format: int32 userType: type: string username: type: string domain: type: string password: type: string format: password firstName: type: string lastName: type: string officePhone: type: string mobilePhone: type: string isNative: type: boolean isActive: type: boolean isLocked: type: boolean disableSecondFactor: type: boolean email: type: string lastLogin: type: string format: date-time modified: type: string format: date-time operator_user_with_role_info: title: operator_user_with_role_info type: object properties: id: type: integer format: int32 created: type: string format: date-time operatorId: type: integer format: int32 userType: type: string username: type: string domain: type: string password: type: string format: password firstName: type: string lastName: type: string officePhone: type: string mobilePhone: type: string isNative: type: boolean isActive: type: boolean isLocked: type: boolean disableSecondFactor: type: boolean email: type: string lastLogin: type: string format: date-time modified: type: string format: date-time roleId: type: integer format: int32 roleName: type: string gateway_gateway_provision_result: title: gateway_gateway_provision_result required: - activationKey - id - logicalId type: object properties: activationKey: type: string id: type: integer format: int32 logicalId: type: string gateway_get_gateway_edge_assignments_result_item: title: gateway_get_gateway_edge_assignments_result_item type: object properties: activationKey: type: string activationKeyExpires: type: string activationState: $ref: '#/components/schemas/ActivationState' activationTime: type: string alertsEnabled: $ref: '#/components/schemas/tinyint' buildNumber: type: string created: type: string description: type: string deviceFamily: type: string deviceId: type: string dnsName: type: string edgeState: $ref: '#/components/schemas/EdgeState' edgeStateTime: type: string endpointPkiMode: $ref: '#/components/schemas/EndpointPkiMode' enterpriseId: type: integer format: int32 haLastContact: type: string haPreviousState: $ref: '#/components/schemas/HaPreviousState' haSerialNumber: type: string haState: $ref: '#/components/schemas/HaState' id: type: integer format: int32 isLive: type: integer format: int32 lastContact: type: string logicalId: type: string modelNumber: type: string modified: type: string name: type: string operatorAlertsEnabled: $ref: '#/components/schemas/tinyint' selfMacAddress: type: string serialNumber: type: string serviceState: $ref: '#/components/schemas/ServiceState1' serviceUpSince: type: string siteId: type: integer format: int32 softwareUpdated: type: string softwareVersion: type: string systemUpSince: type: string enterpriseName: type: string enterpriseProxyId: type: integer format: int32 enterpriseProxyName: type: string lat: type: number lon: type: number city: type: string state: type: string country: type: string postalCode: type: string interval: title: interval required: - start type: object properties: end: type: string format: date-time start: type: string format: date-time ip_port_mapping: title: ip_port_mapping type: object properties: subnets: type: array items: type: string description: '' tcpPorts: type: array items: type: integer format: int32 description: '' udpPorts: type: array items: type: integer format: int32 description: '' link_quality_event_get_link_quality_events_result: title: link_quality_event_get_link_quality_events_result type: object properties: overallLinkQuality: $ref: '#/components/schemas/link_quality_object' list_metadata: title: list_metadata required: - limit - more type: object properties: limit: type: integer format: int32 more: type: boolean live_mode_data: title: live_mode_data required: - linkStats type: object properties: linkStats: $ref: '#/components/schemas/live_mode_data_link_stats' live_mode_data_link_stats: title: live_mode_data_link_stats required: - data - timestamp - type type: object properties: data: type: array items: $ref: '#/components/schemas/live_mode_data_link_stats_data' description: '' timestamp: type: string format: date-time type: type: string live_mode_data_link_stats_data: title: live_mode_data_link_stats_data required: - data - timestamp - type type: object properties: data: type: array items: $ref: '#/components/schemas/live_mode_data_link_stats_data_data' description: '' timestamp: type: string format: date-time type: type: string live_mode_data_link_stats_data_data: title: live_mode_data_link_stats_data_data type: object properties: backupOnly: type: integer format: int32 bestJitterMsRx: type: integer format: int32 bestJitterMsTx: type: integer format: int32 bestLatencyMsRx: type: integer format: int32 bestLatencyMsTx: type: integer format: int32 bestLossPctRx: type: number bestLossPctTx: type: number bpsOfBestPathRx: type: integer format: int32 bpsOfBestPathTx: type: integer format: int32 bytesRx: type: integer format: int64 bytesTx: type: integer format: int64 controlBytesRx: type: integer format: int64 controlBytesTx: type: integer format: int64 controlPacketsRx: type: integer format: int64 controlPacketsTx: type: integer format: int64 destinations: type: array items: $ref: '#/components/schemas/destinations' description: '' icmpBytesRx: type: integer format: int64 icmpBytesTx: type: integer format: int64 icmpPacketsRx: type: integer format: int64 icmpPacketsTx: type: integer format: int64 interface: type: string internalId: type: string localIpAddress: type: string logicalId: type: string mode: $ref: '#/components/schemas/Mode2' mtu: type: integer format: int32 name: type: string otherBytesRx: type: integer format: int64 otherBytesTx: type: integer format: int64 otherPacketsRx: type: integer format: int64 otherPacketsTx: type: integer format: int64 p1BytesRx: type: integer format: int64 p1BytesTx: type: integer format: int64 p1PacketsRx: type: integer format: int64 p1PacketsTx: type: integer format: int64 p2BytesRx: type: integer format: int64 p2BytesTx: type: integer format: int64 p2PacketsRx: type: integer format: int64 p2PacketsTx: type: integer format: int64 p3BytesRx: type: integer format: int64 p3BytesTx: type: integer format: int64 p3PacketsRx: type: integer format: int64 p3PacketsTx: type: integer format: int64 publicIpAddress: type: string scoreRx: type: number scoreTx: type: number signalStrength: type: number state: $ref: '#/components/schemas/State1' tcpBytesRx: type: integer format: int64 tcpBytesTx: type: integer format: int64 tcpPacketsRx: type: integer format: int64 tcpPacketsTx: type: integer format: int64 type: $ref: '#/components/schemas/Type20' udpBytesRx: type: integer format: int64 udpBytesTx: type: integer format: int64 udpHolePunching: type: integer format: int32 udpPacketsRx: type: integer format: int64 udpPacketsTx: type: integer format: int64 vlanId: type: integer format: int32 vpnState: $ref: '#/components/schemas/VpnState' live_mode_enter_live_mode_result: title: live_mode_enter_live_mode_result type: object properties: actionId: type: integer description: The ID of the action queued format: int32 alreadyLive: type: boolean lastContact: type: integer format: int32 refreshIntervalMs: type: integer format: int32 token: type: string url: type: string live_mode_exit_live_mode_result: title: live_mode_exit_live_mode_result required: - id type: object properties: id: type: string description: The ID of the action queued live_mode_read_live_data_result: title: live_mode_read_live_data_result required: - data - status - timestamp type: object properties: data: $ref: '#/components/schemas/live_mode_data' status: $ref: '#/components/schemas/live_mode_status' timestamp: type: integer format: int32 live_mode_status: title: live_mode_status required: - isActive - lastContact type: object properties: isActive: type: boolean lastContact: type: integer format: int32 metrics_get_edge_app_link_metrics_result_item: title: metrics_get_edge_app_link_metrics_result_item required: - linkId - name - serviceGroups type: object properties: bytesRx: type: integer format: int64 bytesTx: type: integer format: int64 flowCount: type: integer format: int32 packetsRx: type: integer format: int64 packetsTx: type: integer format: int64 totalBytes: type: integer format: int64 totalPackets: type: integer format: int64 linkId: type: integer format: int32 name: type: integer format: int32 serviceGroups: type: array items: $ref: '#/components/schemas/link_service_group' description: '' metrics_get_edge_app_link_series_result_item: title: metrics_get_edge_app_link_series_result_item required: - series - name - serviceGroups type: object properties: series: type: array items: $ref: '#/components/schemas/time_series' description: '' name: type: integer format: int32 serviceGroups: type: array items: $ref: '#/components/schemas/link_service_group' description: '' metrics_get_edge_app_metrics_result_item: title: metrics_get_edge_app_metrics_result_item required: - application - name type: object properties: bytesRx: type: integer format: int64 bytesTx: type: integer format: int64 flowCount: type: integer format: int32 packetsRx: type: integer format: int64 packetsTx: type: integer format: int64 totalBytes: type: integer format: int64 totalPackets: type: integer format: int64 application: type: integer format: int32 category: type: integer format: int32 name: type: integer format: int32 linkId: type: integer format: int32 metrics_get_edge_app_series_result_item: title: metrics_get_edge_app_series_result_item required: - series - name type: object properties: series: type: array items: $ref: '#/components/schemas/time_series' description: '' name: type: integer format: int32 metrics_get_edge_category_metrics_result_item: title: metrics_get_edge_category_metrics_result_item required: - category - name type: object properties: bytesRx: type: integer format: int64 bytesTx: type: integer format: int64 flowCount: type: integer format: int32 packetsRx: type: integer format: int64 packetsTx: type: integer format: int64 totalBytes: type: integer format: int64 totalPackets: type: integer format: int64 category: type: integer format: int32 name: type: integer format: int32 metrics_get_edge_category_series_result_item: title: metrics_get_edge_category_series_result_item required: - series - name type: object properties: series: type: array items: $ref: '#/components/schemas/time_series' description: '' name: type: integer format: int32 metrics_get_edge_segment_metrics_result_item: title: metrics_get_edge_segment_metrics_result_item required: - segment - name type: object properties: bytesRx: type: integer format: int64 bytesTx: type: integer format: int64 flowCount: type: integer format: int32 packetsRx: type: integer format: int64 packetsTx: type: integer format: int64 totalBytes: type: integer format: int64 totalPackets: type: integer format: int64 segment: type: integer format: int32 name: type: integer format: int32 metrics_get_edge_segment_series_result_item: title: metrics_get_edge_segment_series_result_item required: - series - name type: object properties: series: type: array items: $ref: '#/components/schemas/time_series' description: '' name: type: integer format: int32 metrics_get_edge_dest_metrics_result_item: title: metrics_get_edge_dest_metrics_result_item required: - destDomain - name type: object properties: bytesRx: type: integer format: int64 bytesTx: type: integer format: int64 flowCount: type: integer format: int32 packetsRx: type: integer format: int64 packetsTx: type: integer format: int64 totalBytes: type: integer format: int64 totalPackets: type: integer format: int64 destDomain: type: string name: type: string metrics_get_edge_dest_series_result_item: title: metrics_get_edge_dest_series_result_item required: - series - name type: object properties: series: type: array items: $ref: '#/components/schemas/time_series' description: '' name: type: string metrics_get_edge_device_metrics_device_edge_info: title: metrics_get_edge_device_metrics_device_edge_info type: object properties: edgeId: type: integer format: int32 enterpriseId: type: integer format: int32 hostName: type: string id: type: integer format: int32 ipAddress: type: string lastContact: type: string format: date-time macAddress: type: string metrics_get_edge_device_metrics_result_item: title: metrics_get_edge_device_metrics_result_item required: - edgeInfo - info - name - sourceMac type: object properties: bytesRx: type: integer format: int64 bytesTx: type: integer format: int64 flowCount: type: integer format: int32 packetsRx: type: integer format: int64 packetsTx: type: integer format: int64 totalBytes: type: integer format: int64 totalPackets: type: integer format: int64 edgeInfo: $ref: '#/components/schemas/metrics_get_edge_device_metrics_device_edge_info' info: $ref: '#/components/schemas/client_device' name: type: string sourceMac: type: string metrics_get_edge_device_series_result_item: title: metrics_get_edge_device_series_result_item required: - series - name type: object properties: series: type: array items: $ref: '#/components/schemas/time_series' description: '' name: type: string metrics_get_edge_link_metrics_result_item: title: metrics_get_edge_link_metrics_result_item required: - link - linkId - name type: object properties: bestJitterMsRx: type: integer format: int32 bestJitterMsTx: type: integer format: int32 bestLatencyMsRx: type: integer format: int32 bestLatencyMsTx: type: integer format: int32 bestLossPctRx: type: number bestLossPctTx: type: number bpsOfBestPathRx: type: integer format: int32 bpsOfBestPathTx: type: integer format: int32 bytesRx: type: integer format: int64 bytesTx: type: integer format: int64 controlBytesRx: type: integer format: int64 controlBytesTx: type: integer format: int64 controlPacketsRx: type: integer format: int64 controlPacketsTx: type: integer format: int64 link: $ref: '#/components/schemas/link' linkId: type: integer format: int32 name: type: string p1BytesRx: type: integer format: int64 p1BytesTx: type: integer format: int64 p1PacketsRx: type: integer format: int64 p1PacketsTx: type: integer format: int64 p2BytesRx: type: integer format: int64 p2BytesTx: type: integer format: int64 p2PacketsRx: type: integer format: int64 p2PacketsTx: type: integer format: int64 p3BytesRx: type: integer format: int64 p3BytesTx: type: integer format: int64 p3PacketsRx: type: integer format: int64 p3PacketsTx: type: integer format: int64 scoreRx: type: number scoreTx: type: number signalStrength: type: number state: type: integer format: int32 metrics_get_edge_link_series_result_item: title: metrics_get_edge_link_series_result_item required: - series - edgeId - link - linkId type: object properties: series: type: array items: $ref: '#/components/schemas/time_series' description: '' edgeId: type: integer format: int32 link: $ref: '#/components/schemas/link' linkId: type: integer format: int32 metrics_get_edge_os_metrics_result_item: title: metrics_get_edge_os_metrics_result_item required: - name - os type: object properties: bytesRx: type: integer format: int64 bytesTx: type: integer format: int64 flowCount: type: integer format: int32 packetsRx: type: integer format: int64 packetsTx: type: integer format: int64 totalBytes: type: integer format: int64 totalPackets: type: integer format: int64 name: type: integer format: int32 os: type: integer format: int32 metrics_get_edge_os_series_result_item: title: metrics_get_edge_os_series_result_item required: - series - name type: object properties: series: type: array items: $ref: '#/components/schemas/time_series' description: '' name: type: integer format: int32 monitoring_get_aggregate_edge_link_metrics_result_item: title: monitoring_get_aggregate_edge_link_metrics_result_item required: - link - linkId - name type: object properties: bestJitterMsRx: type: integer format: int32 bestJitterMsTx: type: integer format: int32 bestLatencyMsRx: type: integer format: int32 bestLatencyMsTx: type: integer format: int32 bestLossPctRx: type: number bestLossPctTx: type: number bpsOfBestPathRx: type: integer format: int32 bpsOfBestPathTx: type: integer format: int32 bytesRx: type: integer format: int64 bytesTx: type: integer format: int64 controlBytesRx: type: integer format: int64 controlBytesTx: type: integer format: int64 controlPacketsRx: type: integer format: int64 controlPacketsTx: type: integer format: int64 link: $ref: '#/components/schemas/monitored_link' linkId: type: integer format: int32 name: type: string p1BytesRx: type: integer format: int64 p1BytesTx: type: integer format: int64 p1PacketsRx: type: integer format: int64 p1PacketsTx: type: integer format: int64 p2BytesRx: type: integer format: int64 p2BytesTx: type: integer format: int64 p2PacketsRx: type: integer format: int64 p2PacketsTx: type: integer format: int64 p3BytesRx: type: integer format: int64 p3BytesTx: type: integer format: int64 p3PacketsRx: type: integer format: int64 p3PacketsTx: type: integer format: int64 scoreRx: type: number scoreTx: type: number signalStrength: type: number state: type: integer format: int32 monitoring_get_aggregate_enterprise_events_result: title: monitoring_get_aggregate_enterprise_events_result required: - data - metaData type: object properties: data: type: array items: $ref: '#/components/schemas/aggregate_enterprise_event' description: '' metaData: $ref: '#/components/schemas/list_metadata' monitoring_get_aggregates_result: title: monitoring_get_aggregates_result type: object properties: edgeCount: type: integer format: int32 edges: type: object additionalProperties: type: integer format: int32 enterprises: type: array items: $ref: '#/components/schemas/enterprise_with_proxy_attributes' description: '' monitoring_get_enterprise_bgp_peer_status_result_item: title: monitoring_get_enterprise_bgp_peer_status_result_item type: object properties: gatewayName: type: string gatewayLogicalId: type: string neighbors: type: array items: $ref: '#/components/schemas/bgp_peer_status' description: '' monitoring_get_enterprise_edge_bgp_peer_status_result_item: title: monitoring_get_enterprise_edge_bgp_peer_status_result_item type: object properties: edgeName: type: string edgeId: type: integer format: int32 edgeLogicalId: type: string neighbors: type: array items: $ref: '#/components/schemas/bgp_peer_status' description: '' monitored_link: title: monitored_link required: - displayName - edgeHASerialNumber - edgeId - edgeLastContact - edgeLatitude - edgeLongitude - edgeModelNumber - edgeName - edgeSerialNumber - edgeServiceUpSince - edgeState - edgeSystemUpSince - enterpriseId - enterpriseName - enterpriseProxyId - enterpriseProxyName - interface - internalId - isp - linkId - linkIpAddress - linkLastActive - linkState - linkVpnState type: object properties: displayName: type: string edgeHASerialNumber: type: string edgeId: type: integer format: int32 edgeLastContact: type: string format: date-time edgeLatitude: type: number edgeLongitude: type: number edgeModelNumber: type: string edgeName: type: string edgeSerialNumber: type: string edgeServiceUpSince: type: string format: date-time edgeState: $ref: '#/components/schemas/EdgeState' edgeSystemUpSince: type: string format: date-time enterpriseId: type: integer format: int32 enterpriseName: type: string enterpriseProxyId: type: integer format: int32 enterpriseProxyName: type: string interface: type: string internalId: type: string isp: type: string linkId: type: integer format: int32 linkIpAddress: type: string linkLastActive: type: string format: date-time linkState: $ref: '#/components/schemas/LinkState' linkVpnState: $ref: '#/components/schemas/LinkVpnState' monitoring_get_enterprise_edge_vnf_status_result_item: title: monitoring_get_enterprise_edge_vnf_status_result_item required: - id - created - operatorId - networkId - enterpriseId - edgeId - gatewayId - parentGroupId - description - object - name - type - logicalId - alertsEnabled - operatorAlertsEnabled - status - statusModified - previousData - previousCreated - draftData - draftCreated - draftComment - data - lastContact - version - modified type: object properties: id: type: integer format: int32 created: type: string format: date-time operatorId: type: integer format: int32 networkId: type: integer format: int32 enterpriseId: type: integer format: int32 edgeId: type: integer format: int32 gatewayId: type: integer format: int32 parentGroupId: type: integer format: int32 description: type: string object: type: string name: type: string type: type: string logicalId: type: string alertsEnabled: $ref: '#/components/schemas/tinyint' operatorAlertsEnabled: $ref: '#/components/schemas/tinyint' status: type: string statusModified: type: string format: date-time previousData: type: object previousCreated: type: string format: date-time draftData: type: string draftCreated: type: string format: date-time draftComment: type: string data: $ref: '#/components/schemas/Data' lastContact: type: string format: date-time version: type: string modified: type: string format: date-time edgeCount: type: integer format: int32 edgeUsage: type: array items: $ref: '#/components/schemas/EdgeUsage' description: '' network_get_network_configurations_result_item: title: network_get_network_configurations_result_item required: - created - description - effective - id - modified - name - version type: object properties: configurationType: $ref: '#/components/schemas/ConfigurationType' created: type: string format: date-time description: type: string edgeCount: type: integer format: int32 effective: type: string format: date-time id: type: integer format: int32 logicalId: type: string modified: type: string format: date-time modules: type: array items: $ref: '#/components/schemas/configuration_module' description: '' name: type: string schemaVersion: type: string version: type: string network_get_network_enterprises_result_item: title: network_get_network_enterprises_result_item type: object properties: id: type: integer format: int32 created: type: string format: date-time networkId: type: integer format: int32 gatewayPoolId: type: integer format: int32 alertsEnabled: $ref: '#/components/schemas/tinyint' operatorAlertsEnabled: $ref: '#/components/schemas/tinyint' endpointPkiMode: $ref: '#/components/schemas/EndpointPkiMode' name: type: string domain: type: string prefix: type: string logicalId: type: string accountNumber: type: string description: type: string contactName: type: string contactPhone: type: string contactMobile: type: string contactEmail: type: string streetAddress: type: string streetAddress2: type: string city: type: string state: type: string postalCode: type: string country: type: string lat: type: number lon: type: number timezone: type: string locale: type: string modified: type: string format: date-time enterpriseProxyId: type: integer format: int32 enterpriseProxyName: type: string edgeCount: type: integer format: int32 edges: type: array items: $ref: '#/components/schemas/edge_object' description: '' edgeConfigUpdate: $ref: '#/components/schemas/EdgeConfigUpdate' network_get_network_gateway_pools_result_item: title: network_get_network_gateway_pools_result_item required: - id - networkId - enterpriseProxyId - created - name - description - isDefault - handOffType - modified type: object properties: id: type: integer format: int32 networkId: type: integer format: int32 enterpriseProxyId: type: integer format: int32 created: type: string format: date-time name: type: string description: type: string isDefault: type: boolean handOffType: $ref: '#/components/schemas/HandOffType1' modified: type: string format: date-time gateways: type: array items: $ref: '#/components/schemas/gateway_pool_gateway' description: '' enterprises: type: array items: $ref: '#/components/schemas/enterprise_with_proxy_attributes' description: '' gateway_handoff_edge: title: gateway_handoff_edge type: object properties: activationKey: type: string activationKeyExpires: type: string activationState: $ref: '#/components/schemas/ActivationState' activationTime: type: string alertsEnabled: $ref: '#/components/schemas/tinyint' buildNumber: type: string created: type: string description: type: string deviceFamily: type: string deviceId: type: string dnsName: type: string edgeState: $ref: '#/components/schemas/EdgeState' edgeStateTime: type: string endpointPkiMode: $ref: '#/components/schemas/EndpointPkiMode' enterpriseId: type: integer format: int32 haLastContact: type: string haPreviousState: $ref: '#/components/schemas/HaPreviousState' haSerialNumber: type: string haState: $ref: '#/components/schemas/HaState' id: type: integer format: int32 isLive: type: integer format: int32 lastContact: type: string logicalId: type: string modelNumber: type: string modified: type: string name: type: string operatorAlertsEnabled: $ref: '#/components/schemas/tinyint' selfMacAddress: type: string serialNumber: type: string serviceState: $ref: '#/components/schemas/ServiceState1' serviceUpSince: type: string siteId: type: integer format: int32 softwareUpdated: type: string softwareVersion: type: string systemUpSince: type: string edgeId: type: integer format: int32 isPrimary: type: integer format: int32 pinned: type: integer format: int32 enterpriseLogicalId: type: string enterpriseName: type: string gateway_enterprise_assoc: title: gateway_enterprise_assoc type: object properties: id: type: integer format: int32 created: type: string format: date-time networkId: type: integer format: int32 gatewayPoolId: type: integer format: int32 alertsEnabled: $ref: '#/components/schemas/tinyint' operatorAlertsEnabled: $ref: '#/components/schemas/tinyint' endpointPkiMode: $ref: '#/components/schemas/EndpointPkiMode' name: type: string domain: type: string prefix: type: string logicalId: type: string accountNumber: type: string description: type: string contactName: type: string contactPhone: type: string contactMobile: type: string contactEmail: type: string streetAddress: type: string streetAddress2: type: string city: type: string state: type: string postalCode: type: string country: type: string lat: type: number lon: type: number timezone: type: string locale: type: string modified: type: string format: date-time enterpriseId: type: integer format: int32 enterpriseObjectId: type: integer format: int32 edgeId: type: integer format: int32 gatewayType: $ref: '#/components/schemas/GatewayType' pinned: type: integer format: int32 enterpriseObjectName: type: string enterpriseObjectType: type: string edgeName: type: string edgeLogicalId: type: string edge_certificate: title: edge_certificate type: object properties: id: type: integer format: int32 created: type: string format: date-time csrId: type: integer format: int32 edgeId: type: integer format: int32 enterpriseId: type: integer format: int32 certificate: type: string serialNumber: type: string subjectKeyId: type: string fingerPrint: type: string validFrom: type: string format: date-time validTo: type: string format: date-time gateway_certificate: title: gateway_certificate type: object properties: id: type: integer format: int32 created: type: string format: date-time csrId: type: integer format: int32 gatewayId: type: integer format: int32 networkId: type: integer format: int32 certificate: type: string serialNumber: type: string subjectKeyId: type: string fingerPrint: type: string validFrom: type: string format: date-time validTo: type: string format: date-time gateway_site: title: gateway_site type: object properties: id: type: integer format: int32 created: type: string format: date-time name: type: string contactName: type: string contactPhone: type: string contactMobile: type: string contactEmail: type: string streetAddress: type: string streetAddress2: type: string city: type: string state: type: string postalCode: type: string country: type: string lat: type: number lon: type: number timezone: type: string locale: type: string shippingSameAsLocation: $ref: '#/components/schemas/tinyint' shippingContactName: type: string shippingAddress: type: string shippingAddress2: type: string shippingCity: type: string shippingState: type: string shippingCountry: type: string shippingPostalCode: type: string modified: type: string format: date-time gateway_gateway_pool: title: gateway_gateway_pool type: object properties: id: type: integer format: int32 networkId: type: integer format: int32 enterpriseProxyId: type: integer format: int32 created: type: string format: date-time name: type: string description: type: string isDefault: type: boolean handOffType: $ref: '#/components/schemas/HandOffType1' modified: type: string format: date-time gatewayPoolAssocId: type: integer format: int32 gatewayId: type: integer format: int32 gateway_role: title: gateway_role type: object properties: created: type: string format: date-time gatewayId: type: integer format: int32 gatewayRole: $ref: '#/components/schemas/GatewayRole2' required: type: integer format: int32 gateway_handoff_segment_metadata: title: gateway_handoff_segment_metadata type: object properties: name: type: string segmentId: type: integer format: int32 segmentLogicalId: type: string type: $ref: '#/components/schemas/Type4' gateway_handoff_value_bgp_priority_setup_auto_as: title: gateway_handoff_value_bgp_priority_setup_auto_as type: object properties: enabled: type: boolean default: false gateway_handoff_value_bgp_priority_setup_auto_med: title: gateway_handoff_value_bgp_priority_setup_auto_med type: object properties: enabled: type: boolean default: false gateway_handoff_value_vlan1: title: gateway_handoff_value_vlan1 type: object properties: type: type: string cTag: type: integer format: int32 sTag: type: integer format: int32 transportLanVLAN: type: string gateway_handoff_value: title: gateway_handoff_value type: object properties: segments: type: array items: $ref: '#/components/schemas/gateway_handoff_value' description: '' segment: $ref: '#/components/schemas/gateway_handoff_segment_metadata' bgpPrioritySetup: $ref: '#/components/schemas/BgpPrioritySetup' type: $ref: '#/components/schemas/Type25' override: type: boolean cTag: type: integer format: int32 sTag: type: integer format: int32 localAddress: $ref: '#/components/schemas/LocalAddress' staticRoutes: $ref: '#/components/schemas/StaticRoutes' bgp: $ref: '#/components/schemas/Bgp2' bgpInboundMap: $ref: '#/components/schemas/gateway_handoff_bgp_rules_map' bgpOutboundMap: $ref: '#/components/schemas/gateway_handoff_bgp_rules_map' VLAN: type: object additionalProperties: $ref: '#/components/schemas/gateway_handoff_value_vlan1' overrides: $ref: '#/components/schemas/Overrides' gateway_handoff_bgp_rules_map: title: gateway_handoff_bgp_rules_map type: object properties: rules: type: array items: $ref: '#/components/schemas/bgp_filter_rule' description: '' override: type: boolean bgp_filter_rule: title: bgp_filter_rule type: object properties: action: $ref: '#/components/schemas/Action5' match: $ref: '#/components/schemas/Match1' network_get_network_gateways_result_item: title: network_get_network_gateways_result_item type: object properties: activationKey: type: string activationState: $ref: '#/components/schemas/ActivationState' activationTime: type: string format: date-time buildNumber: type: string certificates: type: array items: $ref: '#/components/schemas/gateway_certificate' description: '' connectedEdges: type: integer format: int32 connectedEdgeList: type: array items: $ref: '#/components/schemas/ConnectedEdgeList' description: '' created: type: string format: date-time dataCenters: type: array items: type: object description: '' description: type: string deviceId: type: string dnsName: type: string endpointPkiMode: $ref: '#/components/schemas/EndpointPkiMode' enterpriseAssociations: type: array items: $ref: '#/components/schemas/gateway_enterprise_assoc' description: '' enterpriseAssociationCount: type: object additionalProperties: type: integer format: int32 enterprises: type: array items: $ref: '#/components/schemas/enterprise' description: '' enterpriseProxyId: type: integer format: int32 gatewayState: $ref: '#/components/schemas/GatewayState' handOffDetail: $ref: '#/components/schemas/gateway_handoff_detail' handOffEdges: type: array items: $ref: '#/components/schemas/gateway_handoff_edge' description: '' id: type: integer format: int32 ipAddress: type: string ipsecGatewayDetail: $ref: '#/components/schemas/IpsecGatewayDetail' isLoadBalanced: type: boolean lastContact: type: string logicalId: type: string modified: type: string format: date-time name: type: string networkId: type: integer format: int32 pools: type: array items: $ref: '#/components/schemas/gateway_gateway_pool' description: '' privateIpAddress: type: string roles: type: array items: $ref: '#/components/schemas/gateway_role' description: '' serviceState: $ref: '#/components/schemas/ServiceState2' serviceUpSince: type: string site: $ref: '#/components/schemas/gateway_site' siteId: type: integer format: int32 softwareVersion: type: string systemUpSince: type: string utilization: type: number utilizationDetail: $ref: '#/components/schemas/UtilizationDetail' new_enterprise_user: title: new_enterprise_user required: - username - password - roleId type: object properties: id: type: integer format: int32 created: type: string format: date-time userType: type: string username: type: string domain: type: string password: type: string format: password firstName: type: string lastName: type: string officePhone: type: string mobilePhone: type: string isNative: type: boolean isActive: type: boolean isLocked: type: boolean disableSecondFactor: type: boolean email: type: string lastLogin: type: string format: date-time modified: type: string format: date-time enterpriseId: type: integer format: int32 enterpriseProxyId: type: integer format: int32 roleId: type: integer format: int32 enterprise_proxy_property: title: enterprise_proxy_property type: object properties: id: type: integer format: int32 enterpriseProxyId: type: integer format: int32 created: type: string format: date-time name: type: string value: type: string isPassword: type: boolean dataType: $ref: '#/components/schemas/DataType' description: type: string modified: type: string format: date-time enterprise_proxy_get_enterprise_proxy_property_result: title: enterprise_proxy_get_enterprise_proxy_property_result required: - id - enterpriseProxyId - created - name - value - isPassword - dataType - description - modified type: object properties: id: type: integer format: int32 enterpriseProxyId: type: integer format: int32 created: type: string format: date-time name: type: string value: type: string isPassword: type: boolean dataType: $ref: '#/components/schemas/DataType' description: type: string modified: type: string format: date-time operator_user_insert_operator_user: title: operator_user_insert_operator_user required: - username - password - networkId - roleId type: object properties: id: type: integer format: int32 created: type: string format: date-time userType: type: string username: type: string domain: type: string password: type: string format: password firstName: type: string lastName: type: string officePhone: type: string mobilePhone: type: string isNative: type: boolean isActive: type: boolean isLocked: type: boolean disableSecondFactor: type: boolean email: type: string lastLogin: type: string format: date-time modified: type: string format: date-time networkId: type: integer format: int32 roleId: type: integer format: int32 role_get_user_type_roles_result_item: title: role_get_user_type_roles_result_item required: - id - created - operatorId - networkId - enterpriseId - enterpriseProxyId - name - userType - fromUserType - isSuper - description - precedence - modified type: object properties: id: type: integer format: int32 created: type: string format: date-time operatorId: type: integer format: int32 networkId: type: integer format: int32 enterpriseId: type: integer format: int32 enterpriseProxyId: type: integer format: int32 name: type: string userType: $ref: '#/components/schemas/UserType' fromUserType: $ref: '#/components/schemas/FromUserType' isSuper: type: integer format: int32 description: type: string precedence: type: integer format: int32 modified: type: string format: date-time set_delegated_result: title: set_delegated_result required: - isDelegated type: object properties: isDelegated: type: boolean system_property: title: system_property type: object properties: id: type: integer format: int32 created: type: string format: date-time name: type: string value: type: string defaultValue: type: string isReadOnly: type: boolean isPassword: type: boolean dataType: $ref: '#/components/schemas/DataType' description: type: string modified: type: string format: date-time system_property_get_system_property_result: title: system_property_get_system_property_result required: - id - created - name - value - defaultValue - isReadOnly - isPassword - dataType - description type: object properties: id: type: integer format: int32 created: type: string format: date-time name: type: string value: type: string defaultValue: type: string isReadOnly: type: boolean isPassword: type: boolean dataType: $ref: '#/components/schemas/DataType' description: type: string modified: type: string format: date-time system_property_get_system_properties_result_item: title: system_property_get_system_properties_result_item required: - id - created - name - value - defaultValue - isReadOnly - isPassword - dataType - description type: object properties: id: type: integer format: int32 created: type: string format: date-time name: type: string value: type: string defaultValue: type: string isReadOnly: type: boolean isPassword: type: boolean dataType: $ref: '#/components/schemas/DataType' description: type: string modified: type: string format: date-time enterprise_get_enterprise_users_result_item: title: enterprise_get_enterprise_users_result_item required: - id - created - userType - username - domain - password - firstName - lastName - officePhone - mobilePhone - isNative - isActive - isLocked - disableSecondFactor - email - lastLogin - modified - roleId - roleName type: object properties: id: type: integer format: int32 created: type: string format: date-time userType: type: string username: type: string domain: type: string password: type: string format: password firstName: type: string lastName: type: string officePhone: type: string mobilePhone: type: string isNative: type: boolean isActive: type: boolean isLocked: type: boolean disableSecondFactor: type: boolean email: type: string lastLogin: type: string format: date-time modified: type: string format: date-time roleId: type: integer format: int32 roleName: type: string enterprise_user_get_enterprise_user_result: title: enterprise_user_get_enterprise_user_result required: - id - created - userType - username - domain - password - firstName - lastName - officePhone - mobilePhone - isNative - isActive - isLocked - email - lastLogin - modified - roleId - roleName - enterpriseId - enterpriseProxyId - networkId type: object properties: id: type: integer format: int32 created: type: string format: date-time userType: type: string username: type: string domain: type: string password: type: string format: password firstName: type: string lastName: type: string officePhone: type: string mobilePhone: type: string isNative: type: boolean isActive: type: boolean isLocked: type: boolean disableSecondFactor: type: boolean email: type: string lastLogin: type: string format: date-time modified: type: string format: date-time roleId: type: integer format: int32 roleName: type: string enterpriseId: type: integer format: int32 enterpriseProxyId: type: integer format: int32 networkId: type: integer format: int32 enterprise_user_update_enterprise_user: title: enterprise_user_update_enterprise_user type: object properties: domain: type: string password: type: string format: password password2: type: string format: password firstName: type: string lastName: type: string officePhone: type: string mobilePhone: type: string isNative: type: boolean isActive: type: boolean disableSecondFactor: type: boolean email: type: string roleId: type: integer format: int32 enterprise_proxy_get_enterprise_proxy_user_result: title: enterprise_proxy_get_enterprise_proxy_user_result type: object properties: id: type: integer format: int32 created: type: string format: date-time userType: type: string username: type: string domain: type: string password: type: string format: password firstName: type: string lastName: type: string officePhone: type: string mobilePhone: type: string isNative: type: boolean isActive: type: boolean isLocked: type: boolean disableSecondFactor: type: boolean email: type: string lastLogin: type: string format: date-time modified: type: string format: date-time roleId: type: integer format: int32 roleName: type: string enterpriseProxyId: type: integer format: int32 networkId: type: integer format: int32 enterprise_proxy_get_enterprise_proxy_users_result_item: title: enterprise_proxy_get_enterprise_proxy_users_result_item type: object properties: id: type: integer format: int32 created: type: string format: date-time userType: type: string username: type: string domain: type: string password: type: string format: password firstName: type: string lastName: type: string officePhone: type: string mobilePhone: type: string isNative: type: boolean isActive: type: boolean isLocked: type: boolean disableSecondFactor: type: boolean email: type: string lastLogin: type: string format: date-time modified: type: string format: date-time roleId: type: integer format: int32 roleName: type: string enterpriseProxyId: type: integer format: int32 networkId: type: integer format: int32 operator_user_update_operator_user: title: operator_user_update_operator_user type: object properties: firstName: type: string lastName: type: string password: type: string format: password password2: type: string format: password roleId: type: integer format: int32 email: type: string mobilePhone: type: string officePhone: type: string operatorId: type: integer format: int32 userType: type: string username: type: string domain: type: string isNative: type: boolean isLocked: type: boolean isActive: type: boolean role: title: role type: object properties: id: type: integer format: int32 created: type: string format: date-time operatorId: type: integer format: int32 networkId: type: integer format: int32 enterpriseId: type: integer format: int32 enterpriseProxyId: type: integer format: int32 name: type: string userType: $ref: '#/components/schemas/UserType' fromUserType: $ref: '#/components/schemas/FromUserType' isSuper: type: integer format: int32 description: type: string precedence: type: integer format: int32 modified: type: string format: date-time protocol_port_mapping: title: protocol_port_mapping type: object properties: tcpPorts: type: array items: type: integer format: int32 description: '' udpPorts: type: array items: type: integer format: int32 description: '' license: title: license type: object properties: tier: type: string bandwidth: type: string term: type: number cloudGatewayRegions: type: array items: type: string description: '' site: title: site type: object properties: id: type: integer format: int32 created: type: string format: date-time name: type: string contactName: type: string contactPhone: type: string contactMobile: type: string contactEmail: type: string streetAddress: type: string streetAddress2: type: string city: type: string state: type: string postalCode: type: string country: type: string lat: type: number lon: type: number timezone: type: string locale: type: string shippingSameAsLocation: $ref: '#/components/schemas/tinyint' shippingContactName: type: string shippingAddress: type: string shippingAddress2: type: string shippingCity: type: string shippingState: type: string shippingCountry: type: string shippingPostalCode: type: string modified: type: string format: date-time firewall_get_enterprise_firewall_logs_result: title: firewall_get_enterprise_firewall_logs_result type: object properties: metaData: $ref: '#/components/schemas/list_metadata' data: type: array items: $ref: '#/components/schemas/firewall_log_data' description: '' rules: type: object additionalProperties: $ref: '#/components/schemas/firewall_rule' firewall_log_data: title: firewall_log_data type: object properties: id: type: integer format: int32 edgeId: type: integer format: int32 timestamp: type: string format: date-time allow: type: integer format: int32 ruleLogicalId: type: string interface: type: string protocol: $ref: '#/components/schemas/Protocol2' sourceIp: type: string sourcePort: type: integer format: int32 destIp: type: string destPort: type: integer format: int32 icmpType: type: string length: type: integer format: int32 firewall_rule: title: firewall_rule type: object properties: created: type: string format: date-time data: type: string deactivated: type: string edgeLogicalId: type: string enterpriseId: type: integer format: int32 id: type: integer format: int32 logicalId: type: string name: type: string type: $ref: '#/components/schemas/Type27' inventory_item: title: inventory_item type: object properties: id: type: integer format: int32 deviceSerialNumber: type: string deviceUuid: type: string modelNumber: type: string siteId: type: integer format: int32 description: type: string acknowledged: type: integer format: int32 edgeId: type: integer format: int32 edge: $ref: '#/components/schemas/Edge2' inventoryState: type: string inventoryEdgeState: type: string inventoryAction: type: string vcoOwnerId: type: integer format: int32 vcoOwner: $ref: '#/components/schemas/VcoOwner' modified: type: string format: date-time basic_metric_summary: title: basic_metric_summary required: - min - max - average type: object properties: min: type: number max: type: number average: type: number gateway_metric: title: gateway_metric enum: - tunnelCount - memoryPct - flowCount - cpuPct - handoffQueueDrops - connectedEdges type: string metrics_get_gateway_status_metrics_result: title: metrics_get_gateway_status_metrics_result type: object properties: total: type: integer format: int32 tunnelCount: $ref: '#/components/schemas/basic_metric_summary' memoryPct: $ref: '#/components/schemas/basic_metric_summary' flowCount: $ref: '#/components/schemas/basic_metric_summary' cpuPct: $ref: '#/components/schemas/basic_metric_summary' handoffQueueDrops: $ref: '#/components/schemas/basic_metric_summary' connectedEdges: $ref: '#/components/schemas/basic_metric_summary' gateway_status_metrics_time_series_item: title: gateway_status_metrics_time_series_item required: - startTime type: object properties: tunnelCount: type: integer format: int32 memoryPct: type: number flowCount: type: number cpuPct: type: number handoffQueueDrops: type: integer format: int32 connectedEdges: type: integer format: int32 startTime: type: string format: date-time gateway_status_metrics_time_series_result: title: gateway_status_metrics_time_series_result required: - series type: object properties: series: type: array items: $ref: '#/components/schemas/gateway_status_metrics_time_series_item' description: '' monitoring_network_gateway_status_item: title: monitoring_network_gateway_status_item required: - gatewayId type: object properties: gatewayId: type: integer format: int32 tunnelCount: type: integer format: int32 memoryPct: type: number flowCount: type: number cpuPct: type: number handoffQueueDrops: type: integer format: int32 connectedEdges: type: integer format: int32 monitoring_network_gateway_status_result: title: monitoring_network_gateway_status_result required: - metaData - data type: object properties: metaData: $ref: '#/components/schemas/MetaData4' data: type: array items: $ref: '#/components/schemas/monitoring_network_gateway_status_item' description: '' edge_metric: title: edge_metric enum: - tunnelCount - memoryPct - flowCount - cpuPct - handoffQueueDrops type: string edge_status_metrics_summary: title: edge_status_metrics_summary type: object properties: total: type: integer format: int32 tunnelCount: $ref: '#/components/schemas/basic_metric_summary' memoryPct: $ref: '#/components/schemas/basic_metric_summary' flowCount: $ref: '#/components/schemas/basic_metric_summary' cpuPct: $ref: '#/components/schemas/basic_metric_summary' handoffQueueDrops: $ref: '#/components/schemas/basic_metric_summary' edge_status_metrics_time_series_item: title: edge_status_metrics_time_series_item required: - startTime type: object properties: tunnelCount: type: integer format: int32 memoryPct: type: number flowCount: type: number cpuPct: type: number handoffQueueDrops: type: integer format: int32 startTime: type: string format: date-time edge_status_metrics_time_series_result: title: edge_status_metrics_time_series_result required: - series type: object properties: series: type: array items: $ref: '#/components/schemas/edge_status_metrics_time_series_item' description: '' monitoring_enterprise_edge_status_item: title: monitoring_enterprise_edge_status_item required: - edgeId type: object properties: edgeId: type: integer format: int32 name: type: string tunnelCount: type: integer format: int32 memoryPct: type: number flowCount: type: number cpuPct: type: number handoffQueueDrops: type: integer format: int32 monitoring_enterprise_edge_status_result: title: monitoring_enterprise_edge_status_result required: - metaData - data type: object properties: metaData: $ref: '#/components/schemas/MetaData4' data: type: array items: $ref: '#/components/schemas/monitoring_enterprise_edge_status_item' description: '' enterprise_get_enterprise_network_segments_result_item: title: enterprise_get_enterprise_network_segments_result_item required: - id - created - operatorId - networkId - enterpriseId - edgeId - gatewayId - parentGroupId - description - object - name - type - logicalId - alertsEnabled - operatorAlertsEnabled - status - statusModified - previousData - previousCreated - draftData - draftCreated - draftComment - data - lastContact - version - modified type: object properties: id: type: integer format: int32 created: type: string format: date-time operatorId: type: integer format: int32 networkId: type: integer format: int32 enterpriseId: type: integer format: int32 edgeId: type: integer format: int32 gatewayId: type: integer format: int32 parentGroupId: type: integer format: int32 description: type: string object: type: string name: type: string type: type: string logicalId: type: string alertsEnabled: $ref: '#/components/schemas/tinyint' operatorAlertsEnabled: $ref: '#/components/schemas/tinyint' status: type: string statusModified: type: string format: date-time previousData: type: object previousCreated: type: string format: date-time draftData: type: string draftCreated: type: string format: date-time draftComment: type: string data: $ref: '#/components/schemas/network_segment_data' lastContact: type: string format: date-time version: type: string modified: type: string format: date-time profileCount: type: integer format: int32 handoffUsage: type: array items: type: object description: '' isAllMPGCDE: type: boolean isAllCtrlCDE: type: boolean edgeCount: type: integer format: int32 edgeUsage: type: array items: $ref: '#/components/schemas/EdgeUsage1' description: '' configuration: type: array items: $ref: '#/components/schemas/Configuration1' description: '' enterprise_encode_enterprise_key_result: title: enterprise_encode_enterprise_key_result required: - key type: object properties: key: type: string enterprise_decode_enterprise_key_result: title: enterprise_decode_enterprise_key_result required: - key type: object properties: key: type: string network_segment: title: network_segment required: - id - created - operatorId - networkId - enterpriseId - edgeId - gatewayId - parentGroupId - description - object - name - type - logicalId - alertsEnabled - operatorAlertsEnabled - status - statusModified - previousData - previousCreated - draftData - draftCreated - draftComment - data - lastContact - version - modified type: object properties: id: type: integer format: int32 created: type: string format: date-time operatorId: type: integer format: int32 networkId: type: integer format: int32 enterpriseId: type: integer format: int32 edgeId: type: integer format: int32 gatewayId: type: integer format: int32 parentGroupId: type: integer format: int32 description: type: string object: type: string name: type: string type: type: string logicalId: type: string alertsEnabled: $ref: '#/components/schemas/tinyint' operatorAlertsEnabled: $ref: '#/components/schemas/tinyint' status: type: string statusModified: type: string format: date-time previousData: type: object previousCreated: type: string format: date-time draftData: type: string draftCreated: type: string format: date-time draftComment: type: string data: $ref: '#/components/schemas/network_segment_data' lastContact: type: string format: date-time version: type: string modified: type: string format: date-time profileCount: type: integer format: int32 handoffUsage: type: array items: type: object description: '' isAllMPGCDE: type: boolean isAllCtrlCDE: type: boolean network_segment_data: title: network_segment_data type: object properties: segmentId: type: integer format: int32 serviceVlan: type: integer format: int32 delegateToEnterprise: type: boolean delegateToEnterpriseProxy: type: boolean cloud_security_service: title: cloud_security_service required: - id - created - operatorId - networkId - enterpriseId - edgeId - gatewayId - parentGroupId - description - object - name - type - logicalId - alertsEnabled - operatorAlertsEnabled - status - statusModified - previousData - previousCreated - draftData - draftCreated - draftComment - data - lastContact - version - modified type: object properties: id: type: integer format: int32 created: type: string format: date-time operatorId: type: integer format: int32 networkId: type: integer format: int32 enterpriseId: type: integer format: int32 edgeId: type: integer format: int32 gatewayId: type: integer format: int32 parentGroupId: type: integer format: int32 description: type: string object: type: string name: type: string type: type: string logicalId: type: string alertsEnabled: $ref: '#/components/schemas/tinyint' operatorAlertsEnabled: $ref: '#/components/schemas/tinyint' status: type: string statusModified: type: string format: date-time previousData: type: object previousCreated: type: string format: date-time draftData: type: string draftCreated: type: string format: date-time draftComment: type: string data: $ref: '#/components/schemas/cloud_security_service_data' lastContact: type: string format: date-time version: type: string modified: type: string format: date-time cloud_security_service_data: title: cloud_security_service_data type: object properties: type: pattern: cloudSecurityService type: string provider: $ref: '#/components/schemas/Provider1' config: $ref: '#/components/schemas/cloud_security_service_provider_config' cloud_security_service_provider_config: title: cloud_security_service_provider_config type: object properties: primaryServer: type: string secondaryServer: type: string enableTunnels: type: boolean sharedIkeAuth: type: boolean maxTunnelsPerIkeIdentity: type: integer format: int32 automateDeployment: type: boolean credentials: $ref: '#/components/schemas/Credentials' cloud_security_service_site: title: cloud_security_service_site required: - id - created - operatorId - networkId - enterpriseId - edgeId - gatewayId - parentGroupId - description - object - name - type - logicalId - alertsEnabled - operatorAlertsEnabled - status - statusModified - previousData - previousCreated - draftData - draftCreated - draftComment - data - lastContact - version - modified type: object properties: id: type: integer format: int32 created: type: string format: date-time operatorId: type: integer format: int32 networkId: type: integer format: int32 enterpriseId: type: integer format: int32 edgeId: type: integer format: int32 gatewayId: type: integer format: int32 parentGroupId: type: integer format: int32 description: type: string object: type: string name: type: string type: type: string logicalId: type: string alertsEnabled: $ref: '#/components/schemas/tinyint' operatorAlertsEnabled: $ref: '#/components/schemas/tinyint' status: type: string statusModified: type: string format: date-time previousData: type: object previousCreated: type: string format: date-time draftData: type: string draftCreated: type: string format: date-time draftComment: type: string data: type: object lastContact: type: string format: date-time version: type: string modified: type: string format: date-time cloud_security_service_site_data_generic_ipsec: title: cloud_security_service_site_data_generic_ipsec type: object properties: ikeId: type: string ikeIdType: type: string psk: type: string pskType: type: string cloud_security_service_site_data_zscaler_gre: title: cloud_security_service_site_data_zscaler_gre type: object properties: customSourceIp: type: string linkInternalLogicalId: type: string primaryAddressing: $ref: '#/components/schemas/PrimaryAddressing' secondaryAddressing: $ref: '#/components/schemas/SecondaryAddressing' useCustomSourceIp: type: boolean security_vnf_service: title: security_vnf_service required: - id - created - operatorId - networkId - enterpriseId - edgeId - gatewayId - parentGroupId - description - object - name - type - logicalId - alertsEnabled - operatorAlertsEnabled - status - statusModified - previousData - previousCreated - draftData - draftCreated - draftComment - data - lastContact - version - modified type: object properties: id: type: integer format: int32 created: type: string format: date-time operatorId: type: integer format: int32 networkId: type: integer format: int32 enterpriseId: type: integer format: int32 edgeId: type: integer format: int32 gatewayId: type: integer format: int32 parentGroupId: type: integer format: int32 description: type: string object: type: string name: type: string type: type: string logicalId: type: string alertsEnabled: $ref: '#/components/schemas/tinyint' operatorAlertsEnabled: $ref: '#/components/schemas/tinyint' status: type: string statusModified: type: string format: date-time previousData: type: object previousCreated: type: string format: date-time draftData: type: string draftCreated: type: string format: date-time draftComment: type: string data: $ref: '#/components/schemas/security_vnf_service_data' lastContact: type: string format: date-time version: type: string modified: type: string format: date-time security_vnf_service_data: title: security_vnf_service_data type: object properties: type: pattern: securityVnfService type: string vendor: $ref: '#/components/schemas/Vendor' vendorSpecificData: $ref: '#/components/schemas/security_vnf_service_data' security_vnf_service_palo_alto_networks: title: security_vnf_service_palo_alto_networks type: object properties: managementServer: $ref: '#/components/schemas/ManagementServer' security_vnf_service_check_point_software: title: security_vnf_service_check_point_software type: object properties: managementServer: $ref: '#/components/schemas/ManagementServer1' vmConfiguration: $ref: '#/components/schemas/VmConfiguration' image: $ref: '#/components/schemas/security_vnf_service_image_info' security_vnf_service_fortinet: title: security_vnf_service_fortinet type: object properties: managementServer: $ref: '#/components/schemas/ManagementServer2' image: $ref: '#/components/schemas/security_vnf_service_image_info' security_vnf_service_image_info: title: security_vnf_service_image_info type: object properties: downloadType: $ref: '#/components/schemas/DownloadType' fileLocation: type: string fileChecksum: type: string fileChecksumType: type: string https: $ref: '#/components/schemas/Https' s3: $ref: '#/components/schemas/S3' security_vnf_image: title: security_vnf_image required: - id - created - operatorId - networkId - enterpriseId - edgeId - gatewayId - parentGroupId - description - object - name - type - logicalId - alertsEnabled - operatorAlertsEnabled - status - statusModified - previousData - previousCreated - draftData - draftCreated - draftComment - data - lastContact - version - modified type: object properties: id: type: integer format: int32 created: type: string format: date-time operatorId: type: integer format: int32 networkId: type: integer format: int32 enterpriseId: type: integer format: int32 edgeId: type: integer format: int32 gatewayId: type: integer format: int32 parentGroupId: type: integer format: int32 description: type: string object: type: string name: type: string type: type: string logicalId: type: string alertsEnabled: $ref: '#/components/schemas/tinyint' operatorAlertsEnabled: $ref: '#/components/schemas/tinyint' status: type: string statusModified: type: string format: date-time previousData: type: object previousCreated: type: string format: date-time draftData: type: string draftCreated: type: string format: date-time draftComment: type: string data: $ref: '#/components/schemas/security_vnf_image_data' lastContact: type: string format: date-time version: type: string modified: type: string format: date-time security_vnf_image_data: title: security_vnf_image_data type: object properties: service: $ref: '#/components/schemas/Service' IN_PROGRESS: $ref: '#/components/schemas/vnf_image_download_event_detail' COMPLETED: $ref: '#/components/schemas/vnf_image_download_event_detail' FAILED: $ref: '#/components/schemas/vnf_image_download_event_detail' security_vnf_license: title: security_vnf_license required: - id - created - operatorId - networkId - enterpriseId - edgeId - gatewayId - parentGroupId - description - object - name - type - logicalId - alertsEnabled - operatorAlertsEnabled - status - statusModified - previousData - previousCreated - draftData - draftCreated - draftComment - data - lastContact - version - modified type: object properties: id: type: integer format: int32 created: type: string format: date-time operatorId: type: integer format: int32 networkId: type: integer format: int32 enterpriseId: type: integer format: int32 edgeId: type: integer format: int32 gatewayId: type: integer format: int32 parentGroupId: type: integer format: int32 description: type: string object: type: string name: type: string type: type: string logicalId: type: string alertsEnabled: $ref: '#/components/schemas/tinyint' operatorAlertsEnabled: $ref: '#/components/schemas/tinyint' status: type: string statusModified: type: string format: date-time previousData: type: object previousCreated: type: string format: date-time draftData: type: string draftCreated: type: string format: date-time draftComment: type: string data: $ref: '#/components/schemas/security_vnf_license_data' lastContact: type: string format: date-time version: type: string modified: type: string format: date-time security_vnf_license_data: title: security_vnf_license_data type: object properties: type: pattern: securityVnfLicense type: string vendor: $ref: '#/components/schemas/Vendor' vendorSpecificData: $ref: '#/components/schemas/security_vnf_license_data' security_vnf_license_palo_alto_networks: title: security_vnf_license_palo_alto_networks type: object properties: licenseServer: $ref: '#/components/schemas/LicenseServer' authCode: type: string edge_vnf: title: edge_vnf required: - id - created - operatorId - networkId - enterpriseId - edgeId - gatewayId - parentGroupId - description - object - name - type - logicalId - alertsEnabled - operatorAlertsEnabled - status - statusModified - previousData - previousCreated - draftData - draftCreated - draftComment - data - lastContact - version - modified type: object properties: id: type: integer format: int32 created: type: string format: date-time operatorId: type: integer format: int32 networkId: type: integer format: int32 enterpriseId: type: integer format: int32 edgeId: type: integer format: int32 gatewayId: type: integer format: int32 parentGroupId: type: integer format: int32 description: type: string object: type: string name: type: string type: type: string logicalId: type: string alertsEnabled: $ref: '#/components/schemas/tinyint' operatorAlertsEnabled: $ref: '#/components/schemas/tinyint' status: type: string statusModified: type: string format: date-time previousData: type: object previousCreated: type: string format: date-time draftData: type: string draftCreated: type: string format: date-time draftComment: type: string data: $ref: '#/components/schemas/security_vnf_service_data' lastContact: type: string format: date-time version: type: string modified: type: string format: date-time edge_vnf_data: title: edge_vnf_data type: object properties: securityVnf: $ref: '#/components/schemas/SecurityVnf1' edge_vnf_security_vnf_vm: title: edge_vnf_security_vnf_vm type: object properties: cidrIp: type: string edgeEvent: $ref: '#/components/schemas/EdgeEvent' hostname: type: string insertionEnabled: type: boolean ref: pattern: deviceSettings:vnfs:edge type: string type: pattern: securityVnf type: string vendor: $ref: '#/components/schemas/Vendor' vendorSpecificData: type: object vlanId: type: integer format: int32 vmDeploy: type: boolean vmPowerOff: type: boolean vnf_vm_event: title: vnf_vm_event required: - id - eventTime - event - category - severity - detail type: object properties: id: type: integer format: int32 eventTime: type: string format: date-time event: type: string category: $ref: '#/components/schemas/Category' severity: $ref: '#/components/schemas/Severity' message: type: string detail: $ref: '#/components/schemas/vnf_vm_event_detail' vnf_vm_event_detail: title: vnf_vm_event_detail type: object properties: configUuid: type: string data: type: object edgeSerialNumber: type: string isEdgeActive: type: boolean runningConfig: type: object status: $ref: '#/components/schemas/Status1' uuid: type: string vendor: $ref: '#/components/schemas/Vendor' vnfEdgeLogicalId: type: string vnfType: $ref: '#/components/schemas/VnfType' edge_vnf_security_vnf_vm_palo_alto_networks: title: edge_vnf_security_vnf_vm_palo_alto_networks type: object properties: deviceGroupName: type: string deviceTemplateName: type: string edge_vnf_security_vnf_vm_fortinet: title: edge_vnf_security_vnf_vm_fortinet type: object properties: inspectionMode: $ref: '#/components/schemas/InspectionMode' license: type: string enterprise_user_do_all_users_have_phones: title: enterprise_user_do_all_users_have_phones type: object properties: doUsersHavePhones: type: boolean doesPhoneHasAtLeastOneUser: type: boolean vpn_generate_vpn_gateway_configuration_result: title: vpn_generate_vpn_gateway_configuration_result type: object properties: id: type: integer format: int32 object: $ref: '#/components/schemas/Object' type: $ref: '#/components/schemas/Type28' data: $ref: '#/components/schemas/data_center_data' data_center_data: title: data_center_data type: object properties: authentication: $ref: '#/components/schemas/Authentication1' isCDE: type: boolean isServiceEnabled: type: boolean primary: $ref: '#/components/schemas/data_center_vpn_tunnel' secondary: $ref: '#/components/schemas/data_center_vpn_tunnel' subnets: type: array items: $ref: '#/components/schemas/Subnet3' description: '' iaasProvider: $ref: '#/components/schemas/IaasProvider' data_center_iaas_provider_microsoft_azure: title: data_center_iaas_provider_microsoft_azure type: object properties: virtualWanId: type: string virtualHubId: type: string primaryVpnSiteId: type: string redundantVpnSiteId: type: string deploymentState: $ref: '#/components/schemas/DeploymentState' data_center_vpn_tunnel: title: data_center_vpn_tunnel type: object properties: IKESA: $ref: '#/components/schemas/IKESA' IPSECDPD: $ref: '#/components/schemas/IPSECDPD' IPSECSA: $ref: '#/components/schemas/IPSECSA' dataCenterLinkIp: type: string dataCenterPublicIp: type: string disabled: type: boolean fragmentationAvoidance: $ref: '#/components/schemas/FragmentationAvoidance' gatewayLinkIp: type: string gatewayPublicIp: type: string geoData: $ref: '#/components/schemas/GeoData' redundant: $ref: '#/components/schemas/data_center_vpn_tunnel' serviceFQDN: type: string tunnelInterface: $ref: '#/components/schemas/TunnelInterface' type: $ref: '#/components/schemas/Type29' typeAlias: $ref: '#/components/schemas/TypeAlias' export_enterprise_edge_license_data_result: title: export_enterprise_edge_license_data_result type: object properties: csv: type: string fileName: type: string export_network_edge_license_data_result: title: export_network_edge_license_data_result type: object properties: csv: type: string fileName: type: string export_enterprise_proxy_edge_license_data_result: title: export_enterprise_proxy_edge_license_data_result type: object properties: csv: type: string fileName: type: string update_enterprise_edge_licenses_result: title: update_enterprise_edge_licenses_result type: object properties: errors: type: array items: $ref: '#/components/schemas/Error2' description: '' valid: type: boolean update_enterprise_proxy_edge_licenses_result: title: update_enterprise_proxy_edge_licenses_result type: object properties: errors: type: array items: $ref: '#/components/schemas/Error2' description: '' valid: type: boolean edge_license: title: edge_license type: object properties: id: type: integer format: int32 created: type: string format: date-time licenseId: type: integer format: int32 sku: type: string name: type: string alias: type: string detail: type: string quota: type: string termMonths: type: integer format: int32 start: type: string format: date-time end: type: string format: date-time edition: type: string bandwidthTier: type: string active: $ref: '#/components/schemas/tinyint' modified: type: string format: date-time vco_diagnostic_bundle: title: vco_diagnostic_bundle type: object properties: id: type: integer format: int32 requestId: type: integer format: int64 userId: type: string ageOutTime: type: string format: date-time reason: type: string created: type: string format: date-time blobId: type: integer format: int32 fileName: type: string fileStore: type: string timestamp: type: string format: date-time jobId: type: string status: type: string upstream_api_response: title: upstream_api_response type: object properties: statusCode: type: integer format: int32 contentType: type: string responseData: type: string microsoft_azure_client_credentials: title: microsoft_azure_client_credentials type: object properties: tenantId: type: string clientId: type: string clientSecret: type: string enterprise_rolemap: title: enterprise_rolemap type: object properties: Enterprise Read Only: type: string Enterprise Standard Admin: type: string Enterprise Superuser: type: string Enterprise Support: type: string radius_operator_rolemap: title: radius_operator_rolemap type: object properties: Operator Standard Admin: type: string Operator Superuser: type: string Operator Support: type: string radius_enterprise_authentication_configuration: title: radius_enterprise_authentication_configuration type: object properties: domainAttribute: type: string primaryServer: type: string protocol: type: string roleAttribute: type: string secondaryServer: type: string sharedSecret: type: string timeoutMilliSeconds: type: integer format: int32 roleMap: $ref: '#/components/schemas/enterprise_rolemap' radius_operator_authentication_configuration: title: radius_operator_authentication_configuration type: object properties: domainAttribute: type: string operatorDomain: type: string primaryServer: type: string protocol: type: string roleAttribute: type: string secondaryServer: type: string sharedSecret: type: string timeoutMilliSeconds: type: integer format: int32 roleMap: $ref: '#/components/schemas/radius_operator_rolemap' operator_sso_authentication_configuration: title: operator_sso_authentication_configuration type: object properties: enabled: type: boolean protocol: type: string provider: type: string configuration: $ref: '#/components/schemas/Configuration2' enterprise_proxy_sso_authentication_configuration: title: enterprise_proxy_sso_authentication_configuration type: object properties: enabled: type: boolean protocol: type: string provider: type: string configuration: $ref: '#/components/schemas/Configuration3' enterprise_sso_authentication_configuration: title: enterprise_sso_authentication_configuration type: object properties: enabled: type: boolean protocol: type: string provider: type: string configuration: $ref: '#/components/schemas/Configuration4' enterprise_authentication_configuration: title: enterprise_authentication_configuration type: object properties: mode: type: string radius: $ref: '#/components/schemas/radius_enterprise_authentication_configuration' operator_authentication_configuration: title: operator_authentication_configuration type: object properties: mode: type: string radius: $ref: '#/components/schemas/radius_operator_authentication_configuration' sso: $ref: '#/components/schemas/operator_sso_authentication_configuration' system_property_get_authentication_configuration_result: title: system_property_get_authentication_configuration_result type: object properties: operator: $ref: '#/components/schemas/operator_authentication_configuration' enterprise: $ref: '#/components/schemas/enterprise_authentication_configuration' system_property_set_authentication_configuration_result: title: system_property_set_authentication_configuration_result type: object properties: rows: type: integer description: The number of rows modified format: int32 sso_get_sso_properties_result: title: sso_get_sso_properties_result type: object properties: redirectUri: type: string openid_well_known_config: title: openid_well_known_config type: object properties: issuer: type: string authorization_endpoint: type: string token_endpoint: type: string revocation_endpoint: type: string userinfo_endpoint: type: string jwks_uri: type: string scopes_supported: type: array items: type: string description: '' response_types_supported: type: array items: type: string description: '' response_modes_supported: type: array items: type: string description: '' claims_supported: type: array items: type: string description: '' sso_discover_openid_endpoints_result: title: sso_discover_openid_endpoints_result type: object properties: issuer: type: string authorization_endpoint: type: string token_endpoint: type: string revocation_endpoint: type: string userinfo_endpoint: type: string jwks_uri: type: string scopes_supported: type: array items: type: string description: '' response_types_supported: type: array items: type: string description: '' response_modes_supported: type: array items: type: string description: '' claims_supported: type: array items: type: string description: '' operator_user_get_operator_user_authentication_mode_result: title: operator_user_get_operator_user_authentication_mode_result required: - id - created - name - value - defaultValue - isReadOnly - isPassword - dataType - description type: object properties: id: type: integer format: int32 created: type: string format: date-time name: type: string value: type: string defaultValue: type: string isReadOnly: type: boolean isPassword: type: boolean dataType: $ref: '#/components/schemas/DataType' description: type: string modified: type: string format: date-time enterprise_proxy_insert_or_update_enterprise_proxy_authentication_configuration_result: title: enterprise_proxy_insert_or_update_enterprise_proxy_authentication_configuration_result type: object properties: rows: type: integer description: The number of rows modified format: int32 enterprise_proxy_get_enterprise_proxy_authentication_configuration_result: title: enterprise_proxy_get_enterprise_proxy_authentication_configuration_result type: object properties: mode: type: string sso: $ref: '#/components/schemas/enterprise_proxy_sso_authentication_configuration' enterprise_insert_or_update_enterprise_authentication_configuration_result: title: enterprise_insert_or_update_enterprise_authentication_configuration_result type: object properties: rows: type: integer description: The number of rows modified format: int32 enterprise_get_enterprise_authentication_configuration_result: title: enterprise_get_enterprise_authentication_configuration_result type: object properties: mode: type: string sso: $ref: '#/components/schemas/enterprise_sso_authentication_configuration' Action: title: Action enum: - 0 - 1 - 2 - 3 - 4 type: integer Action1: title: Action1 required: - type - nat - interface type: object properties: type: $ref: '#/components/schemas/Type3' nat: $ref: '#/components/schemas/Nat' interface: type: string description: The name of the interface from which traffic should be forwarded subinterfaceId: type: integer format: int32 Action2: title: Action2 type: object properties: allow_or_deny: $ref: '#/components/schemas/AllowOrDeny' Action3: title: Action3 required: - allow_or_deny type: object properties: allow_or_deny: $ref: '#/components/schemas/AllowOrDeny1' Action4: title: Action4 type: object properties: routeType: type: string edge2EdgeRouteAction: $ref: '#/components/schemas/route_action_object' edge2DataCenterRouteAction: $ref: '#/components/schemas/route_action_object' edge2CloudRouteAction: $ref: '#/components/schemas/route_action_object' QoS: type: object sla: type: object Action5: title: Action5 type: object properties: type: type: string values: type: array items: $ref: '#/components/schemas/Value' description: '' Action6: title: Action6 enum: - ADVERTISE - IGNORE - LEARN type: string Action7: title: Action7 type: object properties: type: $ref: '#/components/schemas/Type13' values: type: array items: $ref: '#/components/schemas/Value1' description: '' ActivationState: title: ActivationState enum: - UNASSIGNED - PENDING - ACTIVATED - REACTIVATION_PENDING type: string Addressing2: title: Addressing2 type: object properties: type: type: string cidrPrefix: type: integer format: int32 cidrIp: type: string netmask: type: string gateway: type: string AdvertiseNeighborTags: title: AdvertiseNeighborTags required: - UPLINK type: object properties: UPLINK: type: boolean AfterState: title: AfterState enum: - 0 - 1 - 2 - 3 - 4 type: integer Allocation: title: Allocation type: object properties: ref: type: string assignableVlans: type: array items: type: integer format: int32 description: '' managementVlans: type: array items: type: integer format: int32 description: '' AllowOrDeny: title: AllowOrDeny enum: - allow - deny - drop - reject - skip type: string AllowOrDeny1: title: AllowOrDeny1 enum: - allow - deny type: string Applications: title: Applications type: object properties: logicalId: type: string type: type: string version: type: string Assigned: title: Assigned required: - advertiseStatic - advertiseConnected type: object properties: advertiseStatic: type: boolean advertiseConnected: type: boolean Assigned2: title: Assigned2 required: - advertiseStatic type: object properties: advertiseStatic: type: boolean Attribute: title: Attribute enum: - destDomain - destIp - destFQDN type: string Authentication: title: Authentication type: object properties: ref: type: string Authentication1: title: Authentication1 type: object properties: key: type: string value: type: string AuthenticationType: title: AuthenticationType enum: - none - 802.1x type: string BackupProvider: title: BackupProvider type: object properties: ref: type: string BackupProvider2: title: BackupProvider2 type: object properties: ref: $ref: '#/components/schemas/Ref3' BackupState: title: BackupState enum: - UNCONFIGURED - STANDBY - ACTIVE type: string BeforeState: title: BeforeState enum: - 0 - 1 - 2 - 3 - 4 type: integer Bgp: title: Bgp type: object properties: ASN: type: string connectedRoutes: type: boolean disableASPathCarryOver: type: boolean enabled: type: boolean filters: type: array items: $ref: '#/components/schemas/Filter' description: '' holdtime: type: string keepalive: type: string neighbors: type: array items: $ref: '#/components/schemas/config_edge_bgp_neighbor' description: '' networks: type: array items: $ref: '#/components/schemas/subnet' description: '' overlayPrefix: type: boolean propagateUplink: type: boolean routerId: type: string uplinkCommunity: type: integer format: int32 Bgp1: title: Bgp1 type: object properties: enabled: type: boolean asn: type: string neighbors: type: array items: type: object description: '' Bgp2: title: Bgp2 type: object properties: enabled: type: boolean ASN: type: string neighborIp: type: string neighborASN: type: string encryption: type: boolean Bgp4: title: Bgp4 required: - advertiseInternal - advertiseExternal - advertiseNeighborTags type: object properties: advertiseInternal: type: boolean advertiseExternal: type: boolean advertiseNeighborTags: $ref: '#/components/schemas/AdvertiseNeighborTags' Bgp6: title: Bgp6 required: - advertiseExternal type: object properties: advertiseExternal: type: boolean BgpPrioritySetup: title: BgpPrioritySetup type: object properties: autoAs: $ref: '#/components/schemas/gateway_handoff_value_bgp_priority_setup_auto_as' autoMed: $ref: '#/components/schemas/gateway_handoff_value_bgp_priority_setup_auto_med' communityMapping: $ref: '#/components/schemas/CommunityMapping' body2: title: body2 type: object properties: enterprises: type: array items: type: integer format: int32 description: '' enterpriseProxyId: type: integer format: int32 networkId: type: integer format: int32 links: type: boolean default: true body3: title: body3 required: - isDelegated type: object properties: enterpriseId: type: integer format: int32 enterpriseProxyId: type: integer format: int32 isDelegated: type: boolean body5: title: body5 required: - isDelegated type: object properties: enterpriseProxyId: type: integer format: int32 isDelegated: type: boolean Category: title: Category enum: - SYSTEM - NETWORK - APPLICATION - USER - SECURITY - EDGE - GATEWAY - CONFIGURATION - ENTERPRISE type: string ClassesOfService: title: ClassesOfService type: object properties: classId: type: integer format: int32 classesOfService: type: array items: $ref: '#/components/schemas/ClassesOfService1' description: '' ClassesOfService1: title: ClassesOfService1 type: object properties: id: type: string name: type: string dscpTags: type: array items: type: string description: '' staticSLA: $ref: '#/components/schemas/StaticSLA1' bandwidthPct: type: integer format: int32 bandwidthGuaranteed: type: boolean defaultClassOfService: type: boolean ClientCount: title: ClientCount type: object properties: edgeCount: type: integer format: int32 gatewayCount: type: integer format: int32 currentActiveEdgeCount: type: integer format: int32 currentStandbyEdgeCount: type: integer format: int32 currentActiveGatewayCount: type: integer format: int32 currentStandbyGatewayCount: type: integer format: int32 ClientType: title: ClientType enum: - EDGE - GATEWAY type: string CommunityMapping: title: CommunityMapping type: object properties: enabled: type: boolean default: false priorityMode: $ref: '#/components/schemas/PriorityMode' priorities: type: array items: $ref: '#/components/schemas/Priority' description: '' communityAdditive: type: boolean Config: title: Config type: object properties: tunnelingProtocol: $ref: '#/components/schemas/TunnelingProtocol' authenticationAlgorithm: type: string encryptionAlgorithm: type: string redirect: type: string IKEPROP: $ref: '#/components/schemas/IKEPROP' GREPROP: $ref: '#/components/schemas/GREPROP' Configuration: title: Configuration type: object properties: operator: $ref: '#/components/schemas/Operator' enterprise: $ref: '#/components/schemas/Enterprise1' configuration_clone_and_convert_configuration: title: configuration_clone_and_convert_configuration required: - configurationId type: object properties: configurationId: type: integer format: int32 enterpriseId: type: integer format: int32 name: type: string description: type: string guestVLANSegmentObjectId: type: integer format: int32 configuration_clone_configuration: title: configuration_clone_configuration required: - configurationId type: object properties: configurationId: type: integer format: int32 networkId: type: integer format: int32 enterpriseId: type: integer format: int32 name: type: string version: type: string description: type: string configuration_clone_enterprise_template: title: configuration_clone_enterprise_template type: object properties: enterpriseId: type: integer description: Required if called from the operator or MSP context, identifies the target enterprise of the API call. format: int32 configurationType: $ref: '#/components/schemas/ConfigurationType4' name: type: string description: type: string configuration_delete_configuration: title: configuration_delete_configuration required: - id type: object properties: enterpriseId: type: integer format: int32 id: type: integer format: int32 configuration_get_configuration: title: configuration_get_configuration required: - id type: object properties: id: type: integer format: int32 enterpriseId: type: integer format: int32 with: type: array items: $ref: '#/components/schemas/With' description: '' configuration_get_configuration_modules: title: configuration_get_configuration_modules required: - configurationId type: object properties: configurationId: type: integer format: int32 enterpriseId: type: integer format: int32 noData: type: boolean modules: type: array items: $ref: '#/components/schemas/Module2' description: '' configuration_get_routable_applications: title: configuration_get_routable_applications type: object properties: enterpriseId: type: integer format: int32 edgeId: type: integer format: int32 configuration_insert_configuration_module: title: configuration_insert_configuration_module required: - name - data - configurationId type: object properties: enterpriseId: type: integer format: int32 name: $ref: '#/components/schemas/Name2' type: $ref: '#/components/schemas/Type2' description: type: string data: type: object configurationId: type: integer format: int32 version: type: string configuration_options_list: title: configuration_options_list enum: - modules - edgeCount - enterprises - enterpriseCount - counts type: string configuration_update_configuration: title: configuration_update_configuration required: - id - _update type: object properties: id: type: integer format: int32 enterpriseId: type: integer format: int32 _update: $ref: '#/components/schemas/Update' configuration_update_configuration_module: title: configuration_update_configuration_module type: object properties: id: type: integer description: Alias for `configurationModuleId` format: int32 configurationModuleId: type: integer description: The `id` of the target configuration module. This parameter, or its alias `id`, is required. format: int32 enterpriseId: type: integer format: int32 basic: type: boolean default: false _update: $ref: '#/components/schemas/configuration_module' example: enterpriseId: 4 configurationModuleId: 5161 _update: data: inbound: [] segments: - segment: segmentId: 0 name: Global Segment type: REGULAR segmentLogicalId: 0f966250-942d-48cc-be87-d656734f6449 firewall_logging_enabled: false outbound: - name: Block Google DNS match: appid: -1 classid: -1 dscp: -1 sip: any smac: any sport_high: -1 sport_low: -1 ssm: 255.255.255.255 svlan: -1 os_version: -1 hostname: '' dip: 8.8.8.8 dport_low: 53 dport_high: 53 dsm: 255.255.255.255 dvlan: -1 proto: 6 s_rule_type: prefix d_rule_type: exact action: allow_or_deny: deny loggingEnabled: false firewall_enabled: true firewall_logging_enabled: true Configuration1: title: Configuration1 type: object properties: id: type: integer format: int32 created: type: string format: date-time name: type: string logicalId: type: string version: type: string description: type: string configurationType: $ref: '#/components/schemas/ConfigurationType' schemaVersion: type: string effective: type: string modified: type: string format: date-time moduleId: type: integer format: int32 segmentObjectId: type: integer format: int32 Configuration2: title: Configuration2 type: object properties: authorizationEndpoint: type: string clientId: type: string clientSecret: type: string issuer: type: string provider: type: string redirectEndpoint: type: string tokenEndpoint: type: string userInfoEndpoint: type: string wellKnownConfigurationUrl: type: string scopes: type: array items: type: string description: '' roleConfig: $ref: '#/components/schemas/RoleConfig' Configuration3: title: Configuration3 type: object properties: authorizationEndpoint: type: string clientId: type: string clientSecret: type: string issuer: type: string provider: type: string redirectEndpoint: type: string tokenEndpoint: type: string userInfoEndpoint: type: string wellKnownConfigurationUrl: type: string scopes: type: array items: type: string description: '' roleConfig: $ref: '#/components/schemas/RoleConfig1' Configuration4: title: Configuration4 type: object properties: authorizationEndpoint: type: string clientId: type: string clientSecret: type: string issuer: type: string provider: type: string redirectEndpoint: type: string tokenEndpoint: type: string userInfoEndpoint: type: string wellKnownConfigurationUrl: type: string scopes: type: array items: type: string description: '' roleConfig: $ref: '#/components/schemas/RoleConfig2' ConfigurationType: title: ConfigurationType enum: - NETWORK_BASED - SEGMENT_BASED type: string ConfigurationType4: title: ConfigurationType4 enum: - SEGMENT_BASED - NETWORK_BASED type: string description: If both network and segment based functionality is granted to the enterprise, chose which template type to clone. If not specified the type of the operator profile assigned to the enterprise will be used. ConnectedEdgeList: title: ConnectedEdgeList type: object properties: vceid: type: string ControlPlane1: title: ControlPlane1 required: - version - schemaVersion - type - data type: object properties: version: type: string schemaVersion: type: string type: $ref: '#/components/schemas/Type2' data: $ref: '#/components/schemas/control_plane_data' CosMapping2: title: CosMapping2 type: object properties: lsInputType: type: string bulk: $ref: '#/components/schemas/cos_mapping' realtime: $ref: '#/components/schemas/cos_mapping' transactional: $ref: '#/components/schemas/cos_mapping' Credentials: title: Credentials type: object properties: username: type: string password: type: string validated: type: boolean Credentials1: title: Credentials1 type: object properties: username: type: string password: type: string Data: title: Data type: object properties: type: type: string vendor: type: string vendorSpecificData: type: object Data1: title: Data1 type: object properties: spaces: type: array items: $ref: '#/components/schemas/enterprise_network_space' description: '' Data3: title: Data3 required: - edge - hub - partnerGateway - routingPreference type: object properties: edge: $ref: '#/components/schemas/Edge3' hub: $ref: '#/components/schemas/Hub' partnerGateway: $ref: '#/components/schemas/PartnerGateway' routingPreference: type: array items: $ref: '#/components/schemas/RoutingPreference' description: '' DataCenterEdge: title: DataCenterEdge type: object properties: logicalId: type: string name: type: string DataType: title: DataType enum: - STRING - NUMBER - BOOLEAN - JSON - DATE - DATETIME type: string DefaultAction: title: DefaultAction enum: - ADVERTISE - IGNORE - LEARN type: string DefaultRoute: title: DefaultRoute type: object properties: enabled: type: boolean advertise: type: string DefaultRouteAdvertise: title: DefaultRouteAdvertise enum: - ALWAYS - CONDITIONAL - NONE type: string DefaultRoutes: title: DefaultRoutes enum: - OE1 - OE2 - NONE type: string DeploymentState: title: DeploymentState enum: - VPN_SITE_CREATION_PENDING - VPN_SITE_CREATION_IN_PROGRESS - VPN_SITE_CREATION_FAILED - VPN_DEPLOYMENT_PENDING - VPN_DEPLOYMENT_IN_PROGRESS - VPN_DEPLOYMENT_FAILED - SUCCEEDED type: string Detail: title: Detail type: object properties: latencyMsRx: type: integer format: int32 latencyMsTx: type: integer format: int32 lossPctRx: type: integer format: int32 lossPctTx: type: integer format: int32 jitterMsRx: type: integer format: int32 jitterMsTx: type: integer format: int32 Detail1: title: Detail1 type: object properties: regions: type: array items: type: string description: '' addOns: type: array items: type: string description: '' DeviceSettings1: title: DeviceSettings1 required: - version - schemaVersion - type - data type: object properties: version: type: string schemaVersion: type: string type: $ref: '#/components/schemas/Type2' data: $ref: '#/components/schemas/edgeDeviceSettingsData' Dhcp: title: Dhcp type: object properties: enabled: type: boolean leaseTimeSeconds: type: integer format: int32 Dhcp1: title: Dhcp1 type: object properties: enabled: type: boolean leaseTimeSeconds: type: integer format: int32 override: type: boolean dhcpRelay: $ref: '#/components/schemas/DhcpRelay' DhcpRelay: title: DhcpRelay type: object properties: servers: type: array items: type: string description: '' DiffieHellmanGroup: title: DiffieHellmanGroup enum: - GROUP_2 - GROUP_5 - GROUP_14 type: string disaster_recovery_configure_active_for_replication: title: disaster_recovery_configure_active_for_replication required: - standbyList - drVCOUser - drVCOPassword type: object properties: standbyList: type: array items: $ref: '#/components/schemas/standby_vco_designee' description: '' autoConfigStandby: type: boolean default: true drVCOUser: type: string drVCOPassword: type: string disaster_recovery_demote_active: title: disaster_recovery_demote_active type: object properties: force: type: boolean default: false disaster_recovery_get_replication_status: title: disaster_recovery_get_replication_status type: object properties: with: type: array items: $ref: '#/components/schemas/With1' description: '' disaster_recovery_promote_standby_to_active: title: disaster_recovery_promote_standby_to_active type: object properties: force: type: boolean default: false disaster_recovery_transition_to_standby: title: disaster_recovery_transition_to_standby type: object properties: activeAccessFromStandby: type: string Discovery: title: Discovery enum: - DISABLED - AUTO_DISCOVERED - USER_DEFINED type: string Dns1: title: Dns1 type: object properties: primaryProvider: $ref: '#/components/schemas/PrimaryProvider' backupProvider: $ref: '#/components/schemas/BackupProvider' privateProviders: $ref: '#/components/schemas/PrivateProviders' Domain: title: Domain type: object properties: rule: type: string description: type: string DownloadType: title: DownloadType enum: - s3 - http - https type: string DrState: title: DrState enum: - UNCONFIGURED - ACTIVE_CONFIGURING - ACTIVE_CONFIGURED - LAUNCHING_STANDBY - LAUNCHED_STANDBY - ACTIVE_WAIT_STANDBY - PENDING_STANDBY_CANDIDATE - STANDBY_CANDIDATE - STANDBY_CONFIG_RQST - STANDBY_CONFIGURING - STANDBY_CONFIGURED - PENDING_STANDBY_UNCONFIG - STANDBY_UNCONFIG - PENDING_STANDBY_PROMOTION - STANDBY_PROMOTED - PENDING_ACTIVE_DEMOTION - COPYING_DB - COPY_DB_DONE - COPYING_FILES - COPY_FILES_DONE - SYNC_CONFIGURING - STANDBY_SYNC - STANDBY_BACKGROUND_IMPORT - STANDBY_RUNNING - UPGRADING - FAILURE_ACTIVE_CONFIGURING - FAILURE_LAUNCHING_STANDBY - FAILURE_STANDBY_CONFIGURING - FAILURE_GET_STANDBY_CONFIG - FAILURE_COPYING_DB - FAILURE_COPYING_FILES - FAILURE_SYNC_CONFIGURING - FAILURE_BACKGROUND_IMPORT - FAILURE_SYNCING_FILES - FAILURE_GET_STANDBY_STATUS - FAILURE_GET_ACTIVE_STATUS - FAILURE_MYSQL_ACTIVE_STATUS - FAILURE_MYSQL_STANDBY_STATUS - FAILURE_STANDBY_CANDIDATE - FAILURE_STANDBY_UNCONFIG - FAILURE_STANDBY_PROMOTION - FAILURE_ACTIVE_DEMOTION type: string DRuleType: title: DRuleType enum: - exact - prefix - wildcard - netmask type: string description: Destination rule type DRuleType2: title: DRuleType2 enum: - exact - prefix - wildcard - netmask type: string Duplex: title: Duplex enum: - FULL - HALF type: string Dynamic: title: Dynamic type: object properties: enabled: type: boolean timeout: type: integer format: int32 type: type: string Dynamic2: title: Dynamic2 type: object properties: enabled: type: boolean isolation: $ref: '#/components/schemas/device_settings_vpn_profile_isolation' type: type: string timeout: type: integer format: int32 Edge: title: Edge type: object properties: logicalId: type: string ref: pattern: deviceSettings:vnfs:edge type: string edge_delete_edge: title: edge_delete_edge type: object properties: enterpriseId: type: integer format: int32 id: type: integer format: int32 ids: type: array items: type: integer format: int32 description: '' edge_delete_edge_bgp_neighbor_records: title: edge_delete_edge_bgp_neighbor_records type: object properties: records: type: array items: $ref: '#/components/schemas/Record' description: '' edge_edge_cancel_reactivation: title: edge_edge_cancel_reactivation required: - enterpriseId - edgeId type: object properties: enterpriseId: type: integer format: int32 edgeId: type: integer format: int32 edge_edge_provision: title: edge_edge_provision required: - configurationId - modelNumber type: object properties: enterpriseId: type: integer format: int32 configurationId: type: integer format: int32 name: type: string serialNumber: type: string modelNumber: $ref: '#/components/schemas/ModelNumber' description: type: string site: $ref: '#/components/schemas/site' haEnabled: type: boolean generateCertificate: type: boolean subjectCN: type: string subjectO: type: string subjectOU: type: string challengePassword: type: string privateKeyPassword: type: string edge_edge_request_reactivation: title: edge_edge_request_reactivation required: - enterpriseId - edgeId type: object properties: enterpriseId: type: integer format: int32 edgeId: type: integer format: int32 edge_get_client_visibility_mode: title: edge_get_client_visibility_mode required: - edgeId type: object properties: edgeId: type: integer format: int32 enterpriseId: type: integer format: int32 edge_get_client_visibility_mode_result: title: edge_get_client_visibility_mode_result type: object properties: edgeClientVisibilityMode: $ref: '#/components/schemas/EdgeClientVisibilityMode' edge_get_edge: title: edge_get_edge type: object properties: id: type: integer format: int32 enterpriseId: type: integer format: int32 logicalId: type: string activationKey: type: string name: type: string with: type: array items: $ref: '#/components/schemas/With2' description: '' edge_get_edge_configuration_modules: title: edge_get_edge_configuration_modules required: - edgeId type: object properties: edgeId: type: integer format: int32 enterpriseId: type: integer format: int32 modules: type: array items: $ref: '#/components/schemas/Module2' description: '' edge_get_edge_configuration_modules_result: title: edge_get_edge_configuration_modules_result type: object properties: deviceSettings: $ref: '#/components/schemas/DeviceSettings1' firewall: $ref: '#/components/schemas/Firewall2' QOS: $ref: '#/components/schemas/QOS1' WAN: $ref: '#/components/schemas/WAN1' controlPlane: $ref: '#/components/schemas/ControlPlane1' managementPlane: $ref: '#/components/schemas/ManagementPlane1' imageUpdate: $ref: '#/components/schemas/ImageUpdate1' edge_get_edge_configuration_stack: title: edge_get_edge_configuration_stack required: - edgeId type: object properties: edgeId: type: integer format: int32 enterpriseId: type: integer format: int32 edge_set_edge_enterprise_configuration: title: edge_set_edge_enterprise_configuration required: - configurationId type: object properties: id: type: integer description: alias for edgeId format: int32 edgeId: type: integer format: int32 enterpriseId: type: integer format: int32 configurationId: type: integer format: int32 skipEdgeRoutingUpdates: type: boolean edge_set_edge_hand_off_gateways: title: edge_set_edge_hand_off_gateways type: object properties: edgeId: type: integer format: int32 enterpriseId: type: integer format: int32 gateways: $ref: '#/components/schemas/Gateways' edge_set_edge_operator_configuration: title: edge_set_edge_operator_configuration required: - edgeId - configurationId type: object properties: edgeId: type: integer format: int32 enterpriseId: type: integer format: int32 configurationId: type: integer format: int32 edge_update_edge_admin_password: title: edge_update_edge_admin_password required: - id - password type: object properties: id: type: integer format: int32 username: type: string password: type: string edge_update_edge_attributes: title: edge_update_edge_attributes required: - _update type: object properties: id: type: integer format: int32 enterpriseId: type: integer format: int32 _update: $ref: '#/components/schemas/Update1' edge_update_edge_credentials_by_configuration: title: edge_update_edge_credentials_by_configuration required: - credentials type: object properties: configurationId: type: integer format: int32 credentials: $ref: '#/components/schemas/Credentials1' Edge2: title: Edge2 type: object properties: id: type: integer format: int32 edge: type: string site: $ref: '#/components/schemas/Site1' Edge3: title: Edge3 required: - ospf - bgp - assigned type: object properties: ospf: $ref: '#/components/schemas/Ospf5' bgp: $ref: '#/components/schemas/Bgp4' assigned: $ref: '#/components/schemas/Assigned' EdgeClientVisibilityMode: title: EdgeClientVisibilityMode enum: - MAC - IP type: string EdgeConfigUpdate: title: EdgeConfigUpdate type: object properties: enabled: type: boolean enabledOnUpgrade: type: boolean EdgeEvent: title: EdgeEvent type: object properties: DEPLOYED: $ref: '#/components/schemas/vnf_vm_event_detail' status: $ref: '#/components/schemas/Status1' EdgeState: title: EdgeState enum: - NEVER_ACTIVATED - DEGRADED - OFFLINE - DISABLED - EXPIRED - CONNECTED type: string EdgeToEdgeDetail: title: EdgeToEdgeDetail type: object properties: dynamic: $ref: '#/components/schemas/Dynamic' encryptionProtocol: type: string profileIsolation: $ref: '#/components/schemas/ProfileIsolation' useCloudGateway: type: boolean vpnHubs: type: array items: type: object description: '' autoSelectVpnHubs: type: boolean EdgeToEdgeDetail1: title: EdgeToEdgeDetail1 type: object properties: useCloudGateway: type: boolean encryptionProtocol: type: string dynamic: $ref: '#/components/schemas/Dynamic' vpnHubs: type: array items: type: object description: '' autoSelectVpnHubs: type: boolean EdgeToEdgeDetail2: title: EdgeToEdgeDetail2 type: object properties: autoSelectVpnHubs: type: boolean dynamic: $ref: '#/components/schemas/Dynamic2' encryptionProtocol: type: string profileIsolation: $ref: '#/components/schemas/device_settings_vpn_profile_isolation_deprecated' isolation: $ref: '#/components/schemas/device_settings_vpn_profile_isolation' isolationGroupId: type: string isolationGroups: type: array items: $ref: '#/components/schemas/logicalid_reference' description: '' useCloudGateway: type: boolean vpnHubs: type: array items: $ref: '#/components/schemas/device_settings_vpn_hub' description: '' EdgeToEdgeHub: title: EdgeToEdgeHub type: object properties: enabled: type: boolean ref: type: string EdgeToEdgeHub1: title: EdgeToEdgeHub1 type: object properties: enabled: type: boolean ref: $ref: '#/components/schemas/Ref6' EdgeToEdgeList: title: EdgeToEdgeList type: object properties: isolateDynamic: type: integer format: int32 logicalId: type: string name: type: string profileLogicalId: type: string EdgeUsage: title: EdgeUsage type: object properties: configurationId: type: integer format: int32 edgeSpecificId: type: integer format: int32 name: type: string logicalId: type: string profileId: type: integer format: int32 vnfStatus: $ref: '#/components/schemas/VnfStatus' EdgeUsage1: title: EdgeUsage1 type: object properties: configurationId: type: integer format: int32 edgeSpecificId: type: integer format: int32 name: type: string logicalId: type: string profileId: type: integer format: int32 Encryption: title: Encryption enum: - AES_128_CBC - AES_256_CBC type: string EndpointPkiMode: title: EndpointPkiMode enum: - CERTIFICATE_DISABLED - CERTIFICATE_OPTIONAL - CERTIFICATE_REQUIRED type: string enterprise_delete_enterprise_gateway_records: title: enterprise_delete_enterprise_gateway_records type: object properties: records: type: array items: $ref: '#/components/schemas/enterprise_delete_enterprise_delete_enterprise_gateway_records_record' description: '' enterprise_delete_enterprise_network_allocation: title: enterprise_delete_enterprise_network_allocation required: - id type: object properties: id: type: integer format: int32 enterpriseId: type: integer format: int32 enterprise_delete_enterprise_network_segment: title: enterprise_delete_enterprise_network_segment required: - id type: object properties: id: type: integer format: int32 enterpriseId: type: integer format: int32 enterprise_delete_enterprise_service: title: enterprise_delete_enterprise_service type: object properties: id: type: integer format: int32 logicalId: type: string enterpriseId: type: integer format: int32 enterprise_get_enterprise: title: enterprise_get_enterprise type: object properties: id: type: integer format: int32 enterpriseId: type: integer format: int32 with: type: array items: $ref: '#/components/schemas/With3' description: '' enterprise_get_enterprise_addresses: title: enterprise_get_enterprise_addresses required: - enterpriseId type: object properties: enterpriseId: type: integer format: int32 enterprise_get_enterprise_alerts: title: enterprise_get_enterprise_alerts required: - enterpriseId - interval type: object properties: enterpriseId: type: integer format: int32 interval: $ref: '#/components/schemas/interval' filter: $ref: '#/components/schemas/Filter2' with: type: array items: $ref: '#/components/schemas/With4' description: '' enterprise_get_enterprise_alerts_result: title: enterprise_get_enterprise_alerts_result required: - metaData - data type: object properties: metaData: $ref: '#/components/schemas/list_metadata' data: type: array items: $ref: '#/components/schemas/enterprise_get_enterprise_alerts_result_item' description: '' enterprise_get_enterprise_configurations: title: enterprise_get_enterprise_configurations required: - enterpriseId type: object properties: enterpriseId: type: integer format: int32 configurationType: $ref: '#/components/schemas/ConfigurationType' with: type: array items: $ref: '#/components/schemas/With5' description: '' enterprise_get_enterprise_configurations_with_policies_result: title: enterprise_get_enterprise_configurations_with_policies_result type: object properties: configurationType: $ref: '#/components/schemas/ConfigurationType' created: type: string description: type: string edgeCount: type: integer format: int32 effective: type: string id: type: integer format: int32 isStaging: type: integer format: int32 logicalId: type: string modified: type: string name: type: string policies: $ref: '#/components/schemas/Policies' schemaVersion: type: string version: type: string enterprise_get_enterprise_edges: title: enterprise_get_enterprise_edges type: object properties: id: type: integer format: int32 enterpriseId: type: integer format: int32 with: type: array items: $ref: '#/components/schemas/With6' description: '' enterprise_get_enterprise_gateway_handoff: title: enterprise_get_enterprise_gateway_handoff required: - enterpriseId type: object properties: enterpriseId: type: integer format: int32 enterprise_get_enterprise_network_allocation: title: enterprise_get_enterprise_network_allocation required: - id type: object properties: id: type: integer format: int32 enterpriseId: type: integer format: int32 with: type: array items: $ref: '#/components/schemas/With7' description: '' enterprise_get_enterprise_network_allocations: title: enterprise_get_enterprise_network_allocations type: object properties: enterpriseId: type: integer format: int32 name: type: string with: type: array items: $ref: '#/components/schemas/With7' description: '' enterprise_get_enterprise_network_segments: title: enterprise_get_enterprise_network_segments type: object properties: enterpriseId: type: integer format: int32 name: type: string type: type: string with: type: array items: $ref: '#/components/schemas/With9' description: '' enterprise_get_enterprise_property: title: enterprise_get_enterprise_property type: object properties: enterpriseId: type: integer format: int32 name: type: string id: type: integer format: int32 enterprise_get_enterprise_route_table: title: enterprise_get_enterprise_route_table type: object properties: enterpriseId: type: integer format: int32 profiles: type: array items: $ref: '#/components/schemas/Profile1' description: '' subnets: type: array items: $ref: '#/components/schemas/enterprise_route_collection' description: '' enterprise_get_enterprise_services: title: enterprise_get_enterprise_services type: object properties: enterpriseId: type: integer format: int32 type: type: string with: type: array items: $ref: '#/components/schemas/With10' description: '' name: type: string includePartnerGateways: type: boolean enterprise_get_enterprise_users: title: enterprise_get_enterprise_users type: object properties: id: type: integer format: int32 enterpriseId: type: integer format: int32 enterprise_insert_enterprise_network_allocation: title: enterprise_insert_enterprise_network_allocation required: - name type: object properties: enterpriseId: type: integer format: int32 name: type: string data: $ref: '#/components/schemas/Data1' enterprise_insert_enterprise_network_segment: title: enterprise_insert_enterprise_network_segment required: - name - type - data type: object properties: enterpriseId: type: integer format: int32 name: type: string description: type: string type: $ref: '#/components/schemas/Type4' data: $ref: '#/components/schemas/network_segment_data' enterprise_insert_enterprise_service: title: enterprise_insert_enterprise_service required: - type - name - data type: object properties: enterpriseId: type: integer format: int32 type: type: string name: type: string data: type: object edgeId: type: integer format: int32 parentGroupId: type: integer format: int32 enterprise_insert_or_update_enterprise_alert_configurations: title: enterprise_insert_or_update_enterprise_alert_configurations required: - enterpriseAlertConfigurations type: object properties: enterpriseId: type: integer format: int32 enterpriseAlertConfigurations: type: array items: $ref: '#/components/schemas/enterprise_alert_configuration' description: '' enterprise_insert_or_update_enterprise_capability: title: enterprise_insert_or_update_enterprise_capability required: - name - value type: object properties: enterpriseId: type: integer format: int32 name: $ref: '#/components/schemas/Name4' value: type: boolean enterprise_insert_or_update_enterprise_property: title: enterprise_insert_or_update_enterprise_property required: - enterpriseId - name - value type: object properties: enterpriseId: type: integer format: int32 name: type: string value: type: string dataType: $ref: '#/components/schemas/DataType' isPassword: type: boolean description: type: string example: enterpriseId: 1532 name: vco.enterprise.authentication.twoFactor.enable dataType: BOOLEAN value: 'true' enterprise_proxy_delete_enterprise_proxy_user: title: enterprise_proxy_delete_enterprise_proxy_user type: object properties: enterpriseProxyId: type: integer format: int32 id: type: integer format: int32 username: type: string enterprise_proxy_get_enterprise_proxy_edge_inventory: title: enterprise_proxy_get_enterprise_proxy_edge_inventory type: object properties: enterpriseProxyId: type: integer format: int32 enterprise_proxy_get_enterprise_proxy_enterprises: title: enterprise_proxy_get_enterprise_proxy_enterprises type: object properties: enterpriseProxyId: type: integer format: int32 with: type: array items: $ref: '#/components/schemas/With11' description: '' enterprise_proxy_get_enterprise_proxy_gateway_pools: title: enterprise_proxy_get_enterprise_proxy_gateway_pools type: object properties: id: type: integer format: int32 enterpriseProxyId: type: integer format: int32 with: type: array items: $ref: '#/components/schemas/With12' description: '' enterprise_proxy_get_enterprise_proxy_gateways: title: enterprise_proxy_get_enterprise_proxy_gateways type: object properties: enterpriseProxyId: type: integer format: int32 with: type: array items: $ref: '#/components/schemas/With13' description: '' enterprise_proxy_get_enterprise_proxy_operator_profiles: title: enterprise_proxy_get_enterprise_proxy_operator_profiles type: object properties: enterpriseProxyId: type: integer format: int32 with: type: array items: $ref: '#/components/schemas/With14' description: '' enterprise_proxy_get_enterprise_proxy_property: title: enterprise_proxy_get_enterprise_proxy_property type: object properties: enterpriseId: type: integer format: int32 name: type: string id: type: integer format: int32 enterprise_proxy_get_enterprise_proxy_user: title: enterprise_proxy_get_enterprise_proxy_user type: object properties: id: type: integer format: int32 username: type: string enterprise_proxy_get_enterprise_proxy_users: title: enterprise_proxy_get_enterprise_proxy_users type: object properties: enterpriseProxyId: type: integer format: int32 id: type: integer format: int32 enterprise_proxy_insert_or_update_enterprise_proxy_property: title: enterprise_proxy_insert_or_update_enterprise_proxy_property required: - enterpriseProxyId - name - value type: object properties: enterpriseProxyId: type: integer format: int32 name: type: string value: type: string dataType: $ref: '#/components/schemas/DataType' isPassword: type: boolean description: type: string example: enterpriseProxyId: 1532 name: vco.enterprise.proxy.authentication.twoFactor.enable dataType: BOOLEAN value: 'true' enterprise_proxy_update_enterprise_proxy_user: title: enterprise_proxy_update_enterprise_proxy_user required: - _update type: object properties: _update: $ref: '#/components/schemas/enterprise_user_with_role_info' id: type: integer format: int32 enterpriseProxyId: type: integer format: int32 username: type: string enterprise_set_enterprise_all_alert_recipients: title: enterprise_set_enterprise_all_alert_recipients type: object properties: enterpriseId: type: integer format: int32 enterpriseUsers: type: array items: $ref: '#/components/schemas/EnterpriseUser' description: '' smsEnabled: type: boolean smsList: type: array items: $ref: '#/components/schemas/SmsList' description: '' emailEnabled: type: boolean emailList: type: array items: type: string description: '' mobileEnabled: type: boolean mobileList: type: array items: type: string description: '' enterprise_set_enterprise_maximum_segments: title: enterprise_set_enterprise_maximum_segments type: object properties: enterpriseId: type: integer format: int32 value: type: integer format: int32 enterprise_set_enterprise_operator_configuration: title: enterprise_set_enterprise_operator_configuration required: - enterpriseId - configurationId type: object properties: enterpriseId: type: integer format: int32 configurationId: type: integer format: int32 networkId: type: integer format: int32 enterprise_update_enterprise_network_allocation: title: enterprise_update_enterprise_network_allocation type: object properties: id: type: integer format: int32 enterpriseId: type: integer format: int32 _update: $ref: '#/components/schemas/Update2' enterprise_update_enterprise_network_segment: title: enterprise_update_enterprise_network_segment required: - id type: object properties: enterpriseId: type: integer format: int32 id: type: integer format: int32 _update: $ref: '#/components/schemas/Update3' enterprise_update_enterprise_route: title: enterprise_update_enterprise_route type: object properties: enterpriseId: type: integer format: int32 original: $ref: '#/components/schemas/enterprise_route_collection' updated: $ref: '#/components/schemas/enterprise_route_collection' enterprise_update_enterprise_route_configuration: title: enterprise_update_enterprise_route_configuration required: - data type: object properties: enterpriseId: type: integer format: int32 id: type: integer format: int32 data: $ref: '#/components/schemas/Data3' enterprise_update_enterprise_security_policy: title: enterprise_update_enterprise_security_policy type: object properties: enterpriseId: type: integer format: int32 ipsec: $ref: '#/components/schemas/Ipsec' enterprise_update_enterprise_service: title: enterprise_update_enterprise_service required: - id - _update type: object properties: enterpriseId: type: integer format: int32 id: type: integer format: int32 _update: $ref: '#/components/schemas/Update4' enterprise_update_enterprise1: title: enterprise_update_enterprise1 type: object properties: enterpriseId: type: integer format: int32 name: type: string _update: $ref: '#/components/schemas/enterprise_update_enterprise' enterprise_user_delete_enterprise_user: title: enterprise_user_delete_enterprise_user type: object properties: id: type: integer format: int32 enterpriseId: type: integer format: int32 username: type: string enterprise_user_get_enterprise_user: title: enterprise_user_get_enterprise_user type: object properties: id: type: integer format: int32 username: type: string enterprise_user_update_enterprise_user1: title: enterprise_user_update_enterprise_user1 required: - _update type: object properties: _update: $ref: '#/components/schemas/enterprise_user_update_enterprise_user' id: type: integer format: int32 enterpriseId: type: integer format: int32 username: type: string Enterprise1: title: Enterprise1 type: object properties: id: type: integer format: int32 modules: type: array items: $ref: '#/components/schemas/Module1' description: '' name: type: string EnterpriseUser: title: EnterpriseUser type: object properties: enterpriseUserId: type: integer format: int32 enabled: type: boolean smsEnabled: type: boolean emailEnabled: type: boolean mobileEnabled: type: boolean Entity: title: Entity enum: - ACTIVE_VCO - STANDBY_VCO - GATEWAY - DATACENTER type: string Entity1: title: Entity1 enum: - EDGE - HUB - ROUTER - PARTNER type: string Error1: title: Error1 required: - code - message type: object properties: code: type: integer description: A JSON-RPC error code (see http://www.jsonrpc.org/specification#error_object for details) format: int32 example: -32600 message: type: string example: An error occurred while processing your request Error2: title: Error2 type: object properties: message: type: string ErrorDetail: title: ErrorDetail type: object properties: message: type: string response: $ref: '#/components/schemas/upstream_api_response' event_get_enterprise_events: title: event_get_enterprise_events type: object properties: enterpriseId: type: integer format: int32 interval: $ref: '#/components/schemas/interval' filter: $ref: '#/components/schemas/filter3' edgeId: type: array items: type: integer format: int32 description: '' event_get_operator_events: title: event_get_operator_events type: object properties: networkId: type: integer format: int32 interval: $ref: '#/components/schemas/interval' filter: $ref: '#/components/schemas/filter4' gatewayId: type: array items: type: integer format: int32 description: '' event_get_proxy_events: title: event_get_proxy_events type: object properties: interval: $ref: '#/components/schemas/interval' filter: $ref: '#/components/schemas/filter4' enterpriseId: type: array items: type: integer format: int32 description: '' Exits: title: Exits required: - edges - hubs - gateways - nvs type: object properties: edges: type: array items: $ref: '#/components/schemas/exit_entity_type' description: '' hubs: type: array items: $ref: '#/components/schemas/exit_entity_type' description: '' gateways: type: array items: $ref: '#/components/schemas/exit_entity_type' description: '' nvs: type: array items: $ref: '#/components/schemas/exit_entity_type' description: '' FacilityCode: title: FacilityCode enum: - local0 - local1 - local2 - local3 - local4 - local5 - local6 - local7 type: string Field: title: Field enum: - event - edgeName - user - severity - message - detail - segmentName type: string Field1: title: Field1 enum: - event - gatewayName - user - severity - message type: string Filter: title: Filter type: object properties: id: type: string name: type: string rules: type: array items: $ref: '#/components/schemas/bgp_filter_rule' description: '' Filter1: title: Filter1 type: object properties: cidrIp: type: string cidrPrefix: type: string action: $ref: '#/components/schemas/Action6' Filter2: title: Filter2 type: object properties: limit: type: integer format: int32 filter3: title: filter3 type: object properties: limit: type: integer format: int32 default: 2048 rules: type: array items: $ref: '#/components/schemas/Rule' description: '' filter4: title: filter4 type: object properties: limit: type: integer format: int32 default: 2048 rules: type: array items: $ref: '#/components/schemas/Rule1' description: '' Filter7: title: Filter7 required: - limit type: object properties: limit: type: integer format: int32 firewall_get_enterprise_firewall_logs: title: firewall_get_enterprise_firewall_logs type: object properties: enterpriseId: type: integer format: int32 interval: $ref: '#/components/schemas/interval' filter: $ref: '#/components/schemas/Filter2' rules: type: array items: type: string description: '' sourceIps: type: array items: type: string description: '' destIps: type: array items: type: string description: '' edges: type: array items: type: integer format: int32 description: '' with: type: array items: $ref: '#/components/schemas/With15' description: '' Firewall1: title: Firewall1 enum: - none - enabled - disabled type: string Firewall2: title: Firewall2 required: - version - schemaVersion - type - data type: object properties: version: type: string schemaVersion: type: string type: $ref: '#/components/schemas/Type2' data: $ref: '#/components/schemas/firewall_data' FragmentationAvoidance: title: FragmentationAvoidance type: object properties: tcpMssAdjustmentBytes: type: integer format: int32 clearDontFragmentBit: type: string fragmentationStyle: type: string From: title: From enum: - UNCONFIGURED - ACTIVE_CONFIGURING - ACTIVE_CONFIGURED - LAUNCHING_STANDBY - LAUNCHED_STANDBY - ACTIVE_WAIT_STANDBY - PENDING_STANDBY_CANDIDATE - STANDBY_CANDIDATE - STANDBY_CONFIG_RQST - STANDBY_CONFIGURING - STANDBY_CONFIGURED - PENDING_STANDBY_UNCONFIG - STANDBY_UNCONFIG - PENDING_STANDBY_PROMOTION - STANDBY_PROMOTED - PENDING_ACTIVE_DEMOTION - COPYING_DB - COPY_DB_DONE - COPYING_FILES - COPY_FILES_DONE - SYNC_CONFIGURING - STANDBY_SYNC - STANDBY_BACKGROUND_IMPORT - STANDBY_RUNNING - UPGRADING - FAILURE_ACTIVE_CONFIGURING - FAILURE_LAUNCHING_STANDBY - FAILURE_STANDBY_CONFIGURING - FAILURE_GET_STANDBY_CONFIG - FAILURE_COPYING_DB - FAILURE_COPYING_FILES - FAILURE_SYNC_CONFIGURING - FAILURE_BACKGROUND_IMPORT - FAILURE_SYNCING_FILES - FAILURE_GET_STANDBY_STATUS - FAILURE_GET_ACTIVE_STATUS - FAILURE_MYSQL_ACTIVE_STATUS - FAILURE_MYSQL_STANDBY_STATUS - FAILURE_STANDBY_CANDIDATE - FAILURE_STANDBY_UNCONFIG - FAILURE_STANDBY_PROMOTION - FAILURE_ACTIVE_DEMOTION type: string FromUserType: title: FromUserType enum: - OPERATOR - MSP - PARTNER - ENTERPRISE - END_USER - CUSTOM type: string gateway_delete_gateway: title: gateway_delete_gateway required: - id type: object properties: id: type: integer format: int32 gateway_gateway_provision: title: gateway_gateway_provision required: - networkId - ipAddress type: object properties: networkId: type: integer format: int32 ipAddress: type: string gatewayPoolId: type: integer format: int32 dnsName: type: string name: type: string description: type: string isLoadBalanced: type: boolean privateIpAddress: type: string roles: type: array items: $ref: '#/components/schemas/gateway_roles_object' description: '' site: $ref: '#/components/schemas/site' gateway_get_gateway_edge_assignments: title: gateway_get_gateway_edge_assignments required: - gatewayId type: object properties: gatewayId: type: integer format: int32 gateway_roles_object: title: gateway_roles_object required: - gatewayRole type: object properties: gatewayRole: $ref: '#/components/schemas/GatewayRole2' required: type: boolean gateway_update_gateway_attributes: title: gateway_update_gateway_attributes required: - id type: object properties: id: type: integer format: int32 name: type: string description: type: string site: $ref: '#/components/schemas/site' ipsecGatewayDetail: $ref: '#/components/schemas/gateway_handoff_detail' handOffDetail: $ref: '#/components/schemas/gateway_handoff_detail' roles: type: array items: $ref: '#/components/schemas/gateway_roles_object' description: '' GatewayRole2: title: GatewayRole2 enum: - DATA_PLANE - CONTROL_PLANE - VPN_TUNNEL - ON_PREMISE - CDE type: string Gateways: title: Gateways required: - primary type: object properties: primary: type: integer format: int32 primaryIpsecDetail: $ref: '#/components/schemas/gateway_handoff_ipsec_gateway_detail' secondary: type: integer format: int32 secondaryIpsecDetail: $ref: '#/components/schemas/gateway_handoff_ipsec_gateway_detail' GatewaySelection: title: GatewaySelection type: object properties: mode: type: string primary: type: string primaryDetail: $ref: '#/components/schemas/PrimaryDetail' secondary: type: string secondaryDetail: $ref: '#/components/schemas/SecondaryDetail' super: type: string superDetail: $ref: '#/components/schemas/SuperDetail' GatewayState: title: GatewayState enum: - NEVER_ACTIVATED - DEGRADED - QUIESCED - DISABLED - OUT_OF_SERVICE - CONNECTED - OFFLINE type: string GatewayType: title: GatewayType enum: - OTHER - SUPER - DATACENTER - HANDOFF - SUPER_ALT type: string GeneratedCertificate: title: GeneratedCertificate type: object properties: certificate: type: string ca-certificate: type: string privateKey: type: string privateKeyPassword: type: string csr: type: string GeoData: title: GeoData type: object properties: latitude: type: number longitude: type: number get_edge_license_details_by_enterprise_proxy_result: title: get_edge_license_details_by_enterprise_proxy_result type: object properties: activatedEdgeCount: type: integer format: int32 edgeCount: type: integer format: int32 enterpriseCount: type: integer format: int32 enterpriseProxyId: type: integer format: int32 enterpriseProxyName: type: string get_edge_license_details_by_enterprise_result: title: get_edge_license_details_by_enterprise_result type: object properties: activatedEdgeCount: type: integer format: int32 edgeCount: type: integer format: int32 enterpriseCount: type: integer format: int32 enterpriseProxyId: type: integer format: int32 enterpriseProxyName: type: string enterpriseName: type: string get_enterprise_edge_licenses_result: title: get_enterprise_edge_licenses_result type: object properties: activatedEdgeCount: type: integer format: int32 active: type: integer format: int32 alias: type: string bandwidthTier: type: string created: type: string format: date-time detail: $ref: '#/components/schemas/Detail1' edgeCount: type: integer format: int32 edition: type: string end: type: string format: date-time id: type: integer format: int32 licenseId: type: integer format: int32 modified: type: string format: date-time name: type: string quota: type: string sku: type: string start: type: string format: date-time termMonths: type: integer format: int32 get_enterprise_proxy_edge_licenses_result: title: get_enterprise_proxy_edge_licenses_result type: object properties: activatedEdgeCount: type: integer format: int32 active: type: integer format: int32 alias: type: string bandwidthTier: type: string created: type: string format: date-time detail: $ref: '#/components/schemas/Detail1' edgeCount: type: integer format: int32 edition: type: string end: type: string format: date-time enterpriseCount: type: integer format: int32 id: type: integer format: int32 licenseId: type: integer format: int32 modified: type: string format: date-time name: type: string quota: type: string sku: type: string start: type: string format: date-time termMonths: type: integer format: int32 get_network_edge_licenses_result: title: get_network_edge_licenses_result type: object properties: activatedEdgeCount: type: integer format: int32 active: type: integer format: int32 alias: type: string bandwidthTier: type: string created: type: string format: date-time detail: $ref: '#/components/schemas/Detail1' edgeCount: type: integer format: int32 edition: type: string end: type: string format: date-time enterpriseCount: type: integer format: int32 enterpriseProxyCount: type: integer format: int32 id: type: integer format: int32 licenseId: type: integer format: int32 modified: type: string format: date-time name: type: string quota: type: string sku: type: string start: type: string format: date-time termMonths: type: integer format: int32 GREPROP: title: GREPROP type: object properties: keepaliveIntervalSecs: maximum: 30 minimum: 0 type: integer format: int32 keepaliveRetries: maximum: 10 minimum: 0 type: integer format: int32 Ha1: title: Ha1 type: object properties: type: $ref: '#/components/schemas/Type23' data: type: object HandOffType: title: HandOffType enum: - NAT - VLAN type: string HandOffType1: title: HandOffType1 enum: - NONE - ALLOW - ONLY type: string HaPreviousState: title: HaPreviousState enum: - UNCONFIGURED - PENDING_INIT - PENDING_CONFIRMATION - PENDING_CONFIRMED - PENDING_DISSOCIATION - READY - FAILED type: string Hash: title: Hash enum: - MD5 - SHA_1 - SHA_256 type: string HaState: title: HaState enum: - UNCONFIGURED - PENDING_INIT - PENDING_CONFIRMATION - PENDING_CONFIRMED - PENDING_DISSOCIATION - READY - FAILED type: string Https: title: Https type: object properties: username: type: string password: type: string Hub: title: Hub required: - ospf - bgp - assigned type: object properties: ospf: $ref: '#/components/schemas/Ospf5' bgp: $ref: '#/components/schemas/Bgp4' assigned: $ref: '#/components/schemas/Assigned' IaasProvider: title: IaasProvider type: object properties: subscriptionObjectId: type: integer format: int32 vendor: type: string vendorSpecificData: type: object tunnelsEnabledOnSync: type: boolean syncStatus: $ref: '#/components/schemas/SyncStatus' Icmp: title: Icmp required: - enabled type: object properties: enabled: type: boolean allowSelectedIp: type: array items: type: string description: List of IP addresses allowed ICMP access ruleLogicalId: type: string IcmpProbe: title: IcmpProbe type: object properties: enabled: type: boolean probeType: type: string cTag: type: integer format: int32 sTag: type: integer format: int32 destinationIp: type: string frequencySeconds: type: integer format: int32 threshold: type: integer format: int32 IcmpResponder: title: IcmpResponder type: object properties: enabled: type: boolean ipAddress: type: string mode: type: string Igmp: title: Igmp type: object properties: enabled: type: boolean type: $ref: '#/components/schemas/Type8' IKEPROP: title: IKEPROP type: object properties: protocolVersion: type: integer format: int32 IKESA: title: IKESA type: object properties: DHGroup: type: integer format: int32 authenticationAlgorithm: type: string authenticationMethod: type: string ikeVersion: type: integer format: int32 lifeTimeSeconds: type: integer format: int32 phaseOneNegotiationMode: $ref: '#/components/schemas/PhaseOneNegotiationMode' sharedKey: type: string sharedKeyType: type: string ImageUpdate1: title: ImageUpdate1 required: - version - schemaVersion - type - data type: object properties: version: type: string schemaVersion: type: string type: $ref: '#/components/schemas/Type2' data: $ref: '#/components/schemas/image_update_data' InboundRouteLearning: title: InboundRouteLearning type: object properties: defaultAction: type: string filters: type: array items: type: object description: '' InspectionMode: title: InspectionMode enum: - proxy - flow type: string Interface: title: Interface type: object properties: space: type: string name: type: string type: type: string cwp: type: boolean portMode: type: string untaggedVlan: type: string disabled: type: boolean l2: $ref: '#/components/schemas/L2' vlanIds: type: array items: type: integer format: int32 description: '' Intervals: title: Intervals type: object properties: flowStats: type: integer format: int32 flowLinkStats: type: integer format: int32 vrfTable: type: integer format: int32 applicationTable: type: integer format: int32 interfaceTable: type: integer format: int32 linkTable: type: integer format: int32 Ipsec: title: Ipsec type: object properties: hash: $ref: '#/components/schemas/Hash' encryption: $ref: '#/components/schemas/Encryption' diffieHellmanGroup: $ref: '#/components/schemas/DiffieHellmanGroup' perfectForwardSecrecy: $ref: '#/components/schemas/PerfectForwardSecrecy' IPSECDPD: title: IPSECDPD type: object properties: intervalSeconds: type: integer format: int32 retries: type: integer format: int32 type: type: string IpsecGatewayDetail: title: IpsecGatewayDetail type: object properties: enabled: type: boolean strictHostCheck: type: boolean strictHostCheckDN: type: string IPSECSA: title: IPSECSA type: object properties: authenticationAlgorithm: type: string encryptionAlgorithm: type: string lifeTimeSeconds: type: integer format: int32 mode: type: string perfectForwardSecurity: type: string protocol: type: string L2: title: L2 type: object properties: autonegotiation: type: boolean speed: type: string duplex: type: string MTU: type: integer format: int32 Lan: title: Lan type: object properties: networks: type: array items: $ref: '#/components/schemas/Network1' description: '' Lan1: title: Lan1 type: object properties: allocation: $ref: '#/components/schemas/Allocation' Lan2: title: Lan2 type: object properties: interfaces: type: array items: $ref: '#/components/schemas/Interface' description: '' LastEventState: title: LastEventState enum: - UNKNOWN - STABLE - UNSTABLE - DISCONNECTED - QUIET - INITIAL - STANDBY type: string License2: title: License2 type: object properties: logicalId: type: string ref: pattern: deviceSettings:securityVnf:license type: string Licenses: title: Licenses type: object properties: ids: type: array items: type: integer format: int32 description: '' LicenseServer: title: LicenseServer type: object properties: url: type: string apiKey: type: string link_quality_event_get_link_quality_events: title: link_quality_event_get_link_quality_events required: - edgeId - interval type: object properties: enterpriseId: type: integer format: int32 edgeId: type: integer format: int32 interval: $ref: '#/components/schemas/interval' maxSamples: type: integer description: Maximum number of link quality events sampled to produce the time series used in computing scores. This may not be specified in conjunction with `minutesPerSample`. format: int32 default: 50 minutesPerSample: type: integer description: Duration in minutes of the interval partitions from which link quality events are samples to produce the time series used in computing scores. This may not be specified in conjunction with `maxSamples`. format: int32 individualScores: type: boolean description: When `true`, each sample in the resulting time series is populated with its own aggregate `score` values (grouped by traffic type) and link quality state `distribution`. default: false link_service_group: title: link_service_group enum: - ALL - PRIVATE_WIRED - PUBLIC_WIRED - PUBLIC_WIRELESS type: string Link1: title: Link1 type: object properties: logicalId: type: string internalId: type: string discovery: $ref: '#/components/schemas/Discovery' mode: $ref: '#/components/schemas/Mode2' type: $ref: '#/components/schemas/Type20' name: type: string isp: type: string publicIpAddress: type: string sourceIpAddress: type: string nextHopIpAddress: type: string customVlanId: type: boolean vlanId: type: integer format: int32 enable8021P: type: boolean priority8021P: type: integer format: int32 virtualIpAddress: type: string dynamicBwAdjustmentEnabled: type: boolean bwMeasurement: type: string upstreamMbps: type: string downstreamMbps: type: string backupOnly: type: boolean overheadBytes: type: integer format: int32 udpHolePunching: type: boolean MTU: type: integer format: int32 mplsNetwork: type: string dscpTag: type: string staticSlaEnabled: type: boolean classesofServiceEnabled: type: boolean encryptOverlay: type: boolean staticSLA: $ref: '#/components/schemas/StaticSLA' classesOfService: $ref: '#/components/schemas/ClassesOfService' interfaces: type: array items: type: string description: '' lastActive: type: string LinkState: title: LinkState enum: - UNKNOWN - STABLE - UNSTABLE - DISCONNECTED - QUIET - INITIAL - STANDBY type: string LinkVpnState: title: LinkVpnState enum: - UNKNOWN - STABLE - UNSTABLE - DEAD - STANDBY type: string LocalAddress: title: LocalAddress type: object properties: cidrIp: type: string cidrPrefix: type: integer format: int32 useForPrivate: type: boolean advertiseViaBgp: type: boolean override: type: boolean LocalAddress1: title: LocalAddress1 type: object properties: cidrIp: type: string cidrPrefix: type: integer format: int32 useForPrivate: type: boolean advertiseViaBgp: type: boolean LocalUi: title: LocalUi required: - enabled - portNumber type: object properties: enabled: type: boolean allowSelectedIp: type: array items: type: string description: List of IP addresses allowed UI access portNumber: type: integer format: int32 ruleLogicalId: type: string MacBypass: title: MacBypass type: object properties: address: type: string description: type: string ManagementPlane1: title: ManagementPlane1 required: - version - schemaVersion - type - data type: object properties: version: type: string schemaVersion: type: string type: $ref: '#/components/schemas/Type2' data: $ref: '#/components/schemas/management_plane_data' ManagementPlaneProxy: title: ManagementPlaneProxy required: - primary - secondary type: object properties: primary: type: string secondary: type: string ManagementServer: title: ManagementServer type: object properties: primary: type: string secondary: type: string authKey: type: string ManagementServer1: title: ManagementServer1 type: object properties: primary: type: string sicKey: type: string ManagementServer2: title: ManagementServer2 type: object properties: primary: type: string serialNumber: type: string registrationPassword: type: string Match: title: Match type: object properties: appid: type: integer format: int32 classid: type: integer format: int32 dscp: type: integer description: 'Integer ID indicating DSCP classification, where mappings are as follows: [EF:46,VA:44,AF11:10,AF12:12,AF13:14,AF21:18,AF22:20,AF23:22,AF31:26,AF32:28,AF33:30,AF41:34,AF42:36,AF43:38,CS0:0,CS1:8,CS2:16,CS3:24,CS4:32,CS5:40,CS6:48,CS7:56]' format: int32 sip: type: string sport_high: type: integer format: int32 sport_low: type: integer format: int32 ssm: type: string svlan: type: integer format: int32 os_version: type: integer description: 'Index corresponding to the OS in the array: [OTHER,WINDOWS,LINUX,MACOS,IOS,ANDROID,EDGE]' format: int32 hostname: type: string dip: type: string dport_low: type: integer format: int32 dport_high: type: integer format: int32 dsm: type: string dvlan: type: integer format: int32 proto: type: integer format: int32 s_rule_type: $ref: '#/components/schemas/SRuleType2' d_rule_type: $ref: '#/components/schemas/DRuleType2' Match1: title: Match1 type: object properties: exactMatch: type: boolean type: type: string value: type: string Match2: title: Match2 type: object properties: exactMatch: type: boolean type: $ref: '#/components/schemas/Type15' value: type: string MetaData1: title: MetaData1 type: object properties: dataType: type: string description: type: string display: type: boolean list: type: boolean name: type: string option: type: integer format: int32 MetaData4: title: MetaData4 type: object properties: limit: type: integer format: int32 more: type: boolean Metadata6: title: Metadata6 type: object properties: detail: $ref: '#/components/schemas/Detail' metrics: type: array items: $ref: '#/components/schemas/Metric' description: '' stateMap: type: object additionalProperties: $ref: '#/components/schemas/StateMap' metaResponse: title: metaResponse type: object properties: privileges: type: object swagger: type: object Metric: title: Metric type: object properties: trafficType: $ref: '#/components/schemas/TrafficType' action: $ref: '#/components/schemas/Action' metric: $ref: '#/components/schemas/Metric1' beforeState: $ref: '#/components/schemas/BeforeState' afterState: $ref: '#/components/schemas/AfterState' Metric1: title: Metric1 enum: - 0 - 1 - 2 - 3 - 4 - 5 type: integer metrics_get_edge_app_link_metrics: title: metrics_get_edge_app_link_metrics required: - id - interval type: object properties: id: type: integer format: int32 enterpriseId: type: integer format: int32 interval: $ref: '#/components/schemas/interval' metrics: type: array items: $ref: '#/components/schemas/basic_metric' description: A list of metrics to report. When omitted, this method returns all available metrics. metrics_get_edge_app_link_series: title: metrics_get_edge_app_link_series required: - id - interval type: object properties: id: type: integer format: int32 enterpriseId: type: integer format: int32 interval: $ref: '#/components/schemas/interval' metrics: type: array items: $ref: '#/components/schemas/basic_metric' description: A list of metrics to report. When omitted, this method returns all available metrics. links: type: array items: type: integer format: int32 description: '' metrics_get_edge_app_metrics: title: metrics_get_edge_app_metrics required: - interval type: object properties: id: type: integer description: Alias for `edgeId` format: int32 edgeId: type: integer format: int32 enterpriseId: type: integer format: int32 interval: $ref: '#/components/schemas/interval' metrics: type: array items: $ref: '#/components/schemas/basic_metric' description: A list of metrics to report. When omitted, this method returns all available metrics. sort: $ref: '#/components/schemas/basic_metric' limit: type: integer format: int32 applications: type: array items: type: string description: '' with: type: array items: $ref: '#/components/schemas/With16' description: '' metrics_get_edge_app_series: title: metrics_get_edge_app_series required: - interval type: object properties: id: type: integer description: Alias for `edgeId` format: int32 edgeId: type: integer format: int32 enterpriseId: type: integer format: int32 interval: $ref: '#/components/schemas/interval' metrics: type: array items: $ref: '#/components/schemas/basic_metric' description: A list of metrics to report. When omitted, this method returns all available metrics. sort: $ref: '#/components/schemas/basic_metric' limit: type: integer format: int32 default: 10 maxSamples: type: integer format: int32 applications: type: array items: type: string description: '' metrics_get_edge_category_metrics: title: metrics_get_edge_category_metrics required: - interval type: object properties: id: type: integer format: int32 edgeId: type: integer format: int32 enterpriseId: type: integer format: int32 interval: $ref: '#/components/schemas/interval' metrics: type: array items: $ref: '#/components/schemas/basic_metric' description: A list of metrics to report. When omitted, this method returns all available metrics. sort: $ref: '#/components/schemas/basic_metric' limit: type: integer format: int32 categories: type: array items: type: integer format: int32 description: '' metrics_get_edge_category_series: title: metrics_get_edge_category_series required: - interval type: object properties: id: type: integer format: int32 edgeId: type: integer format: int32 enterpriseId: type: integer format: int32 interval: $ref: '#/components/schemas/interval' metrics: type: array items: $ref: '#/components/schemas/basic_metric' description: A list of metrics to report. When omitted, this method returns all available metrics. sort: $ref: '#/components/schemas/basic_metric' limit: type: integer format: int32 maxSamples: type: integer format: int32 categories: type: array items: type: string description: '' metrics_get_edge_dest_metrics: title: metrics_get_edge_dest_metrics required: - interval type: object properties: id: type: integer format: int32 edgeId: type: integer format: int32 enterpriseId: type: integer format: int32 interval: $ref: '#/components/schemas/interval' metrics: type: array items: $ref: '#/components/schemas/basic_metric' description: A list of metrics to report. When omitted, this method returns all available metrics. sort: $ref: '#/components/schemas/basic_metric' limit: type: integer format: int32 attribute: $ref: '#/components/schemas/Attribute' destinations: type: array items: type: string description: '' metrics_get_edge_dest_series: title: metrics_get_edge_dest_series required: - interval type: object properties: id: type: integer format: int32 edgeId: type: integer format: int32 enterpriseId: type: integer format: int32 interval: $ref: '#/components/schemas/interval' sort: $ref: '#/components/schemas/basic_metric' limit: type: integer format: int32 attribute: $ref: '#/components/schemas/Attribute' destinations: type: array items: type: string description: '' metrics_get_edge_device_metrics: title: metrics_get_edge_device_metrics required: - interval type: object properties: id: type: integer format: int32 edgeId: type: integer format: int32 enterpriseId: type: integer format: int32 interval: $ref: '#/components/schemas/interval' metrics: type: array items: $ref: '#/components/schemas/basic_metric' description: A list of metrics to report. When omitted, this method returns all available metrics. sort: $ref: '#/components/schemas/basic_metric' limit: type: integer format: int32 devices: type: array items: type: integer format: int32 description: '' metrics_get_edge_device_series: title: metrics_get_edge_device_series required: - interval type: object properties: id: type: integer format: int32 edgeId: type: integer format: int32 enterpriseId: type: integer format: int32 interval: $ref: '#/components/schemas/interval' metrics: type: array items: $ref: '#/components/schemas/basic_metric' description: A list of metrics to report. When omitted, this method returns all available metrics. sort: $ref: '#/components/schemas/basic_metric' limit: type: integer format: int32 maxSamples: type: integer format: int32 devices: type: array items: type: string description: '' metrics_get_edge_link_metrics: title: metrics_get_edge_link_metrics required: - interval type: object properties: id: type: integer description: Alias for `edgeId` format: int32 edgeId: type: integer format: int32 enterpriseId: type: integer format: int32 interval: $ref: '#/components/schemas/interval' metrics: type: array items: $ref: '#/components/schemas/edge_link_metric' description: A list of metrics to report. When omitted, this method returns all available link metrics. sort: $ref: '#/components/schemas/edge_link_metric' limit: type: integer format: int32 links: type: array items: type: integer format: int32 description: '' metrics_get_edge_link_series: title: metrics_get_edge_link_series required: - interval type: object properties: id: type: integer description: Alias for `edgeId` format: int32 edgeId: type: integer format: int32 enterpriseId: type: integer format: int32 interval: $ref: '#/components/schemas/interval' metrics: type: array items: $ref: '#/components/schemas/edge_link_metric' description: A list of metrics to report. When omitted, this method returns all available link metrics. sort: $ref: '#/components/schemas/edge_link_metric' limit: type: integer format: int32 links: type: array items: type: integer format: int32 description: '' metrics_get_edge_os_metrics: title: metrics_get_edge_os_metrics required: - interval type: object properties: id: type: integer format: int32 edgeId: type: integer format: int32 enterpriseId: type: integer format: int32 interval: $ref: '#/components/schemas/interval' metrics: type: array items: $ref: '#/components/schemas/basic_metric' description: A list of metrics to report. When omitted, this method returns all available metrics. sort: $ref: '#/components/schemas/basic_metric' limit: type: integer format: int32 os: type: array items: type: integer format: int32 description: '' metrics_get_edge_os_series: title: metrics_get_edge_os_series required: - interval type: object properties: id: type: integer format: int32 edgeId: type: integer format: int32 enterpriseId: type: integer format: int32 interval: $ref: '#/components/schemas/interval' metrics: type: array items: $ref: '#/components/schemas/basic_metric' description: A list of metrics to report. When omitted, this method returns all available metrics. maxSamples: type: integer format: int32 sort: $ref: '#/components/schemas/basic_metric' limit: type: integer format: int32 os: type: array items: type: integer format: int32 description: '' metrics_get_edge_segment_metrics: title: metrics_get_edge_segment_metrics required: - interval type: object properties: id: type: integer format: int32 edgeId: type: integer format: int32 enterpriseId: type: integer format: int32 interval: $ref: '#/components/schemas/interval' metrics: type: array items: $ref: '#/components/schemas/basic_metric' description: A list of metrics to report. When omitted, this method returns all available metrics. sort: $ref: '#/components/schemas/basic_metric' limit: type: integer format: int32 segments: type: array items: type: integer format: int32 description: '' metrics_get_edge_segment_series: title: metrics_get_edge_segment_series required: - interval type: object properties: id: type: integer format: int32 edgeId: type: integer format: int32 enterpriseId: type: integer format: int32 interval: $ref: '#/components/schemas/interval' metrics: type: array items: $ref: '#/components/schemas/basic_metric' description: A list of metrics to report. When omitted, this method returns all available metrics. sort: $ref: '#/components/schemas/basic_metric' limit: type: integer format: int32 maxSamples: type: integer format: int32 segments: type: array items: type: string description: '' metrics_get_edge_status_metrics: title: metrics_get_edge_status_metrics required: - edgeId type: object properties: enterpriseId: type: integer format: int32 edgeId: type: integer format: int32 interval: $ref: '#/components/schemas/interval' metrics: type: array items: $ref: '#/components/schemas/edge_metric' description: '' metrics_get_edge_status_series: title: metrics_get_edge_status_series required: - edgeId type: object properties: enterpriseId: type: integer format: int32 edgeId: type: integer format: int32 interval: $ref: '#/components/schemas/interval' metrics: type: array items: $ref: '#/components/schemas/edge_metric' description: '' metrics_get_gateway_status_metrics: title: metrics_get_gateway_status_metrics required: - gatewayId type: object properties: gatewayId: type: integer format: int32 interval: $ref: '#/components/schemas/interval' metrics: type: array items: $ref: '#/components/schemas/gateway_metric' description: '' metrics_get_gateway_status_series: title: metrics_get_gateway_status_series required: - gatewayId type: object properties: gatewayId: type: integer format: int32 interval: $ref: '#/components/schemas/interval' metrics: type: array items: $ref: '#/components/schemas/gateway_metric' description: '' MetricType: title: MetricType enum: - E1 - E2 type: string Mode: title: Mode enum: - static - dynamic type: string Mode1: title: Mode1 enum: - MAC - IP type: string Mode2: title: Mode2 enum: - PUBLIC - PRIVATE type: string ModelNumber: title: ModelNumber enum: - edge500 - edge5X0 - edge510 - edge6X0 - edge840 - edge1000 - edge1000qat - edge3X00 - virtual type: string Models: title: Models type: object properties: virtual: $ref: '#/components/schemas/Virtual' Module: title: Module type: object properties: isEdgeSpecific: $ref: '#/components/schemas/tinyint' name: type: string type: $ref: '#/components/schemas/Type2' version: type: string Module1: title: Module1 type: object properties: edgeSpecificData: type: object isEdgeSpecific: $ref: '#/components/schemas/tinyint' name: type: string type: $ref: '#/components/schemas/Type2' version: type: string Module2: title: Module2 enum: - imageUpdate - controlPlane - managementPlane - firewall - QOS - deviceSettings - WAN - metaData - properties type: string monitoring_get_aggregate_edge_link_metrics: title: monitoring_get_aggregate_edge_link_metrics type: object properties: enterprises: type: array items: type: integer format: int32 description: An array of `enterpriseId` values identifying the target customers. When omitted, the method returns metrics for all Enterprises to which the user has access. Enterprise administrators need not use this parameter. metrics: type: array items: $ref: '#/components/schemas/edge_link_metric' description: A list of metrics to report. When omitted, this method returns all available link metrics. interval: $ref: '#/components/schemas/interval' monitoring_get_aggregate_enterprise_events: title: monitoring_get_aggregate_enterprise_events type: object properties: detail: type: boolean interval: $ref: '#/components/schemas/interval' filter: $ref: '#/components/schemas/Filter7' monitoring_get_aggregates: title: monitoring_get_aggregates type: object properties: enterpriseId: type: integer format: int32 id: type: integer format: int32 monitoring_get_enterprise_edge_cluster_status: title: monitoring_get_enterprise_edge_cluster_status required: - enterpriseId type: object properties: enterpriseId: type: integer format: int32 metrics: type: array items: $ref: '#/components/schemas/edge_metric' description: '' monitoring_get_enterprise_edge_cluster_statusResponse: title: monitoring_get_enterprise_edge_cluster_statusResponse type: object properties: edgeId: type: integer format: int32 edgeName: type: string tunnelCount: type: integer format: int32 memoryPct: type: number flowCount: type: number cpuPct: type: number handoffQueueDrops: type: integer format: int32 Multicast: title: Multicast type: object properties: igmp: $ref: '#/components/schemas/Igmp' igmpHostQueryIntervalSeconds: type: integer format: int32 igmpMaxQueryResponse: type: integer format: int32 pim: $ref: '#/components/schemas/Pim' pimHelloTimerSeconds: type: integer format: int32 pimKeepAliveTimerSeconds: type: integer format: int32 pimPruneIntervalSeconds: type: integer format: int32 MultiSourceQos: title: MultiSourceQos type: object properties: enable: type: boolean enabled: type: boolean highRatio: type: integer format: int32 normalRatio: type: integer format: int32 lowRatio: type: integer format: int32 maxCapThreshold: type: integer format: int32 minCapThreshold: type: integer format: int32 MultiSourceQos1: title: MultiSourceQos1 type: object properties: enabled: type: boolean highRatio: type: integer format: int32 normalRatio: type: integer format: int32 lowRatio: type: integer format: int32 maxCapThreshold: type: integer format: int32 minCapThreshold: type: integer format: int32 Name: title: Name enum: - EDGE_DOWN - EDGE_UP - LINK_DOWN - LINK_UP - VPN_TUNNEL_DOWN - EDGE_HA_FAILOVER - EDGE_SERVICE_DOWN - GATEWAY_SERVICE_DOWN - VNF_VM_EVENT - VNF_VM_DEPLOYED_AND_POWERED_OFF - VNF_VM_POWERED_ON - VNF_VM_POWERED_OFF - VNF_VM_DELETED - VNF_VM_ERROR - VNF_INSERTION_EVENT - VNF_INSERTION_ENABLED - VNF_INSERTION_DISABLED - TEST_ALERT - VNF_IMAGE_DOWNLOAD_EVENT - VNF_IMAGE_DOWNLOAD_IN_PROGRESS - VNF_IMAGE_DOWNLOAD_COMPLETED - VNF_IMAGE_DOWNLOAD_FAILED - EDGE_CSS_TUNNEL_DOWN - EDGE_CSS_TUNNEL_UP type: string Name2: title: Name2 enum: - imageUpdate - controlPlane - managementPlane - firewall - QOS - deviceSettings - WAN - metaData - properties type: string Name4: title: Name4 enum: - enableOSPF - enableBGP - enableNAT - enablePKI - enableFwLogs - enableStatefulFirewall - enableVQM - enableServiceRateLimiting - enableCosMapping - enableSegmentation - enableNetworks - enableEnterpriseAuth - enablePremium - edgeVnfs.enable - edgeVnfs.securityVnf.paloAlto - edgeVnfs.securityVnf.checkPoint - edgeVnfs.securityVnf.fortinet - edgeVnfs.securityVnf.centOS type: string Nat: title: Nat required: - lan_ip type: object properties: lan_ip: type: string lan_port: type: integer format: int32 outbound: type: boolean NeighborTag: title: NeighborTag enum: - UPLINK type: string Netflow: title: Netflow type: object properties: enable: type: boolean enabled: type: boolean version: type: integer format: int32 collectors: type: array items: $ref: '#/components/schemas/device_settings_vqm_collector' description: '' Netflow1: title: Netflow1 type: object properties: enabled: type: boolean version: type: integer format: int32 collectors: type: array items: $ref: '#/components/schemas/device_settings_vqm_collector' description: '' network_delete_network_gateway_pool: title: network_delete_network_gateway_pool required: - id type: object properties: networkId: type: integer format: int32 enterpriseProxyId: type: integer format: int32 id: type: integer description: alias for `gatewayPoolId` format: int32 gatewayPoolId: type: integer format: int32 network_get_network_configurations: title: network_get_network_configurations type: object properties: id: type: integer format: int32 networkId: type: integer format: int32 with: type: array items: $ref: '#/components/schemas/With17' description: '' network_get_network_enterprises: title: network_get_network_enterprises type: object properties: networkId: type: integer format: int32 id: type: integer format: int32 with: type: array items: $ref: '#/components/schemas/With18' description: '' network_get_network_gateway_pools: title: network_get_network_gateway_pools type: object properties: id: type: integer format: int32 networkId: type: integer format: int32 with: type: array items: $ref: '#/components/schemas/With12' description: '' network_get_network_gateways: title: network_get_network_gateways type: object properties: networkId: type: integer format: int32 gatewayIds: type: array items: type: string description: '' with: type: array items: $ref: '#/components/schemas/With13' description: '' network_get_network_operator_users: title: network_get_network_operator_users type: object properties: networkId: type: integer format: int32 network_insert_network_gateway_pool: title: network_insert_network_gateway_pool required: - networkId - name type: object properties: networkId: type: integer format: int32 enterpriseProxyId: type: integer format: int32 name: type: string description: type: string handOffType: $ref: '#/components/schemas/HandOffType1' network_update_network_gateway_pool_attributes: title: network_update_network_gateway_pool_attributes required: - id type: object properties: networkId: type: integer format: int32 enterpriseProxyId: type: integer format: int32 id: type: integer description: alias for `gatewayPoolId` format: int32 gatewayPoolId: type: integer format: int32 name: type: string description: type: string handOffType: $ref: '#/components/schemas/HandOffType1' Network1: title: Network1 type: object properties: space: type: string guest: type: boolean secure: type: boolean advertise: type: boolean pingResponse: type: boolean default: true cost: type: integer format: int32 dhcp: $ref: '#/components/schemas/Dhcp1' staticReserved: type: integer format: int32 netmask: type: string cidrPrefix: type: integer format: int32 cidrIp: type: string baseDhcpAddr: type: integer description: An offset from the cidrIp including staticReserved (if any) format: int32 numDhcpAddr: type: integer format: int32 name: type: string interfaces: type: array items: type: string description: '' vlanId: type: integer format: int32 managementIp: type: string disabled: type: boolean Network2: title: Network2 type: object properties: mode: type: string type: type: string name: type: string logicalId: type: string interface: type: string internalId: type: string ipAddress: type: string isp: type: string lastActive: type: integer format: int32 NetworkSide: title: NetworkSide enum: - UNKOWN - WAN - LAN type: string NetworkType: title: NetworkType enum: - UNKNOWN - WIRELESS - ETHERNET - WIFI type: string Object: title: Object enum: - NETWORK_ALLOCATION - NETWORK_SERVICE - CUSTOM_APPLICATION - ROUTING_CONFIGURATION - NETWORK_SEGMENT - HA_SERVICE - PRIVATE_NETWORK - CDE_GATEWAY - EDGE_LICENSE type: string Op: title: Op enum: - is - is not - startsWith - notStartsWith - endsWith - notEndsWith - contains - notContains type: string Operator: title: Operator type: object properties: id: type: integer format: int32 modules: type: array items: $ref: '#/components/schemas/Module' description: '' name: type: string operator_user_delete_operator_user: title: operator_user_delete_operator_user type: object properties: id: type: integer format: int32 username: type: string operator_user_get_operator_user: title: operator_user_get_operator_user type: object properties: id: type: integer format: int32 username: type: string operator_user_update_operator_user1: title: operator_user_update_operator_user1 required: - _update type: object properties: _update: $ref: '#/components/schemas/operator_user_update_operator_user' networkId: type: integer format: int32 id: type: integer format: int32 username: type: string Ospf: title: Ospf type: object properties: area: type: integer format: int32 authentication: type: boolean authId: type: integer format: int32 authPassphrase: type: string cost: type: integer format: int32 deadTimer: type: integer format: int32 mode: type: string enabled: type: boolean helloTimer: type: integer format: int32 inboundRouteLearning: $ref: '#/components/schemas/InboundRouteLearning' md5Authentication: type: boolean MTU: type: integer format: int32 outboundRouteAdvertisement: $ref: '#/components/schemas/OutboundRouteAdvertisement' passive: type: boolean vlanId: type: integer format: int32 Ospf1: title: Ospf1 type: object properties: area: type: integer format: int32 authentication: type: boolean authId: type: integer format: int32 authPassphrase: type: string cost: type: integer format: int32 deadTimer: type: integer format: int32 mode: type: string enabled: type: boolean helloTimer: type: integer format: int32 inboundRouteLearning: $ref: '#/components/schemas/InboundRouteLearning' md5Authentication: type: boolean MTU: type: integer format: int32 outboundRouteAdvertisement: $ref: '#/components/schemas/OutboundRouteAdvertisement' passive: type: boolean Ospf2: title: Ospf2 type: object properties: enabled: type: boolean areas: type: array items: $ref: '#/components/schemas/device_settings_ospf_area' description: '' Ospf4: title: Ospf4 type: object properties: enabled: type: boolean override: type: boolean area: type: integer format: int32 passiveInterface: type: boolean Ospf5: title: Ospf5 required: - advertiseExternal - advertiseInterArea - advertiseIntraArea type: object properties: advertiseExternal: type: boolean advertiseInterArea: type: boolean advertiseIntraArea: type: boolean OutboundRouteAdvertisement: title: OutboundRouteAdvertisement type: object properties: defaultAction: type: string filters: type: array items: type: object description: '' Overrides: title: Overrides type: object properties: VLAN: type: object additionalProperties: $ref: '#/components/schemas/gateway_handoff_value_vlan1' bgp: type: object additionalProperties: $ref: '#/components/schemas/Bgp2' bgpInboundMap: type: object additionalProperties: $ref: '#/components/schemas/gateway_handoff_bgp_rules_map' bgpOutboundMap: type: object additionalProperties: $ref: '#/components/schemas/gateway_handoff_bgp_rules_map' localAddress: type: object additionalProperties: $ref: '#/components/schemas/LocalAddress1' subnets: type: object additionalProperties: type: object PartnerGateway: title: PartnerGateway required: - bgp - assigned type: object properties: bgp: $ref: '#/components/schemas/Bgp6' assigned: $ref: '#/components/schemas/Assigned2' PerfectForwardSecrecy: title: PerfectForwardSecrecy enum: - DISABLED - GROUP_2 - GROUP_5 type: string PhaseOneNegotiationMode: title: PhaseOneNegotiationMode enum: - main - aggressive type: string Pim: title: Pim type: object properties: enabled: type: boolean type: $ref: '#/components/schemas/Type9' Policies: title: Policies required: - bizPolicyEnabled - deviceSettingsEnabled - firewall type: object properties: bizPolicyEnabled: type: boolean deviceSettingsEnabled: type: boolean firewall: $ref: '#/components/schemas/Firewall1' PortMode: title: PortMode enum: - access - trunk type: string PrimaryAddressing: title: PrimaryAddressing type: object properties: internalRouterIp: type: string internalRouterMask: type: string internalZenIp: type: string internalZenMask: type: string PrimaryDetail: title: PrimaryDetail required: - ipAddress - logicalId - name type: object properties: ipAddress: type: string logicalId: type: string name: type: string PrimaryProvider: title: PrimaryProvider type: object properties: ref: type: string PrimaryProvider2: title: PrimaryProvider2 type: object properties: ref: $ref: '#/components/schemas/Ref2' Priority: title: Priority type: object properties: community: type: string community2: type: string priority: type: integer format: int32 PriorityMode: title: PriorityMode enum: - ALL_SEGMENTS - PER_SEGMENT type: string PrivateProviders: title: PrivateProviders type: object properties: ref: type: string PrivateProviders2: title: PrivateProviders2 type: object properties: ref: $ref: '#/components/schemas/Ref4' Profile: title: Profile required: - description - id - name type: object properties: configurationType: $ref: '#/components/schemas/ConfigurationType' created: type: string format: date-time description: type: string edgeCount: type: integer format: int32 effective: type: string format: date-time id: type: integer format: int32 logicalId: type: string modified: type: string format: date-time modules: type: array items: $ref: '#/components/schemas/configuration_module' description: '' name: type: string schemaVersion: type: string version: type: string Profile1: title: Profile1 type: object properties: id: type: integer format: int32 name: type: string description: type: string ProfileIsolation: title: ProfileIsolation type: object properties: enabled: type: boolean isolateDynamic: type: boolean Protocol: title: Protocol enum: - TCP - UDP type: string Protocol1: title: Protocol1 enum: - RFC6035 type: string Protocol2: title: Protocol2 enum: - ICMP - TCP - UDP - GRE type: string Provider: title: Provider type: object properties: ref: $ref: '#/components/schemas/Ref1' Provider1: title: Provider1 enum: - symantecCloudSecurityService - zscalerWebSecurityService - genericCloudSecurityService type: string ProxyType: title: ProxyType enum: - PARTNER - MSP type: string QOS1: title: QOS1 required: - version - schemaVersion - type - data type: object properties: version: type: string schemaVersion: type: string type: $ref: '#/components/schemas/Type2' data: $ref: '#/components/schemas/QOSData' RadiusAuthentication: title: RadiusAuthentication type: object properties: enabled: type: boolean macBypass: type: array items: $ref: '#/components/schemas/MacBypass' description: '' Record: title: Record type: object properties: edgeId: type: integer format: int32 neighborIp: type: string Ref1: title: Ref1 enum: - deviceSettings:css:provider type: string Ref2: title: Ref2 enum: - deviceSettings:dns:primaryProvider type: string Ref3: title: Ref3 enum: - deviceSettings:dns:backupProvider type: string Ref4: title: Ref4 enum: - deviceSettings:dns:privateProviders type: string Ref5: title: Ref5 enum: - deviceSettings:vpn:dataCenter type: string Ref6: title: Ref6 enum: - deviceSettings:vpn:edgeHub type: string Ref7: title: Ref7 enum: - deviceSettings:tacacs type: string Ref9: title: Ref9 enum: - deviceSettings:authentication type: string Result: title: Result type: object properties: velocloud: type: array items: $ref: '#/components/schemas/Velocloud' description: '' velocloud_ca: type: array items: $ref: '#/components/schemas/VelocloudCa' description: '' velocloud_dr: type: array items: $ref: '#/components/schemas/VelocloudDr' description: '' velocloud_stats: type: array items: $ref: '#/components/schemas/VelocloudStat' description: '' role_create_role_customization: title: role_create_role_customization required: - forRoleId - privilegeIds type: object properties: forRoleId: type: integer format: int32 name: type: string description: type: string userId: type: integer format: int32 enterpriseId: type: integer format: int32 operatorId: type: integer format: int32 networkId: type: integer format: int32 privilegeIds: type: array items: type: integer format: int32 description: '' role_delete_role_customization: title: role_delete_role_customization required: - forRoleId type: object properties: forRoleId: type: integer format: int32 name: type: string userId: type: integer format: int32 enterpriseId: type: integer format: int32 operatorId: type: integer format: int32 networkId: type: integer format: int32 role_get_user_type_roles: title: role_get_user_type_roles required: - userType type: object properties: userType: $ref: '#/components/schemas/UserType' networkId: type: integer format: int32 Role1: title: Role1 enum: - STANDALONE - ACTIVE - STANDBY - ZOMBIE type: string Role3: title: Role3 enum: - EDGE EVENT type: string RoleConfig: title: RoleConfig type: object properties: defaultRole: type: string oidcRolesEnabled: type: boolean roleAttribute: type: string vcoToIdpRoleMap: $ref: '#/components/schemas/VcoToIdpRoleMap' RoleConfig1: title: RoleConfig1 type: object properties: defaultRole: type: string oidcRolesEnabled: type: boolean roleAttribute: type: string vcoToIdpRoleMap: $ref: '#/components/schemas/VcoToIdpRoleMap1' RoleConfig2: title: RoleConfig2 type: object properties: defaultRole: type: string oidcRolesEnabled: type: boolean roleAttribute: type: string vcoToIdpRoleMap: $ref: '#/components/schemas/VcoToIdpRoleMap2' RoutedInterface: title: RoutedInterface type: object properties: addressing: $ref: '#/components/schemas/device_settings_routed_interface_addressing' advertise: type: boolean pingResponse: type: boolean default: true disabled: type: boolean dhcpServer: $ref: '#/components/schemas/edgeDeviceSettingsDataDhcpServer' encryptOverlay: type: boolean l2: $ref: '#/components/schemas/L2' name: type: string natDirect: type: boolean ospf: $ref: '#/components/schemas/Ospf' override: type: boolean subinterfaces: type: array items: $ref: '#/components/schemas/Subinterface' description: '' vlanId: type: integer description: static only format: int32 wanOverlay: $ref: '#/components/schemas/WanOverlay' trusted: type: boolean rpf: $ref: '#/components/schemas/Rpf' underlayAccounting: type: boolean default: true RoutedInterface1: title: RoutedInterface1 type: object properties: name: type: string disabled: type: boolean addressing: $ref: '#/components/schemas/Addressing2' wanOverlay: type: string natDirect: type: boolean ospf: $ref: '#/components/schemas/Ospf1' vlanId: type: integer format: int32 l2: $ref: '#/components/schemas/L2' underlayAccounting: type: boolean default: true trusted: type: boolean rpf: $ref: '#/components/schemas/Rpf' Routes: title: Routes type: object properties: icmpProbes: type: array items: type: object description: '' icmpResponders: type: array items: type: object description: '' static: type: array items: $ref: '#/components/schemas/device_settings_static_route' description: '' RoutingPreference: title: RoutingPreference required: - entity - allow type: object properties: entity: $ref: '#/components/schemas/Entity1' allow: type: boolean Rpf: title: Rpf enum: - SPECIFIC - LOOSE - DISABLED type: string Rule: title: Rule type: object properties: field: $ref: '#/components/schemas/Field' op: $ref: '#/components/schemas/Op' values: type: array items: type: string description: '' Rule1: title: Rule1 type: object properties: field: $ref: '#/components/schemas/Field1' op: $ref: '#/components/schemas/Op' values: type: array items: type: string description: '' S3: title: S3 type: object properties: accessKeyId: type: string secretAccessKey: type: string SecondaryAddressing: title: SecondaryAddressing type: object properties: internalRouterIp: type: string internalRouterMask: type: string internalZenIp: type: string internalZenMask: type: string SecondaryDetail: title: SecondaryDetail required: - ipAddress - logicalId - name type: object properties: ipAddress: type: string logicalId: type: string name: type: string SecurityMode: title: SecurityMode enum: - Open - WPA2Enterprise - WPA2Personal type: string SecurityVnf: title: SecurityVnf type: object properties: vms: type: array items: $ref: '#/components/schemas/device_settings_security_vnf_vm' description: '' SecurityVnf1: title: SecurityVnf1 type: object properties: vms: type: array items: $ref: '#/components/schemas/edge_vnf_security_vnf_vm' description: '' Service: title: Service type: object properties: logicalId: type: string ref: pattern: deviceSettings:securityVnf:service type: string ServiceRateLimit: title: ServiceRateLimit required: - enabled type: object properties: enabled: type: boolean inputType: type: string value: type: integer format: int32 Services: title: Services required: - loggingEnabled type: object properties: loggingEnabled: type: boolean ssh: $ref: '#/components/schemas/Ssh' localUi: $ref: '#/components/schemas/LocalUi' snmp: $ref: '#/components/schemas/Snmp' icmp: $ref: '#/components/schemas/Icmp' ServiceState: title: ServiceState enum: - IN_SERVICE - OUT_OF_SERVICE - HISTORICAL type: string ServiceState1: title: ServiceState1 enum: - IN_SERVICE - OUT_OF_SERVICE - PENDING_SERVICE type: string ServiceState2: title: ServiceState2 enum: - IN_SERVICE - OUT_OF_SERVICE - PENDING_SERVICE - QUIESCED type: string set_client_device_host_name: title: set_client_device_host_name required: - enterpriseId - hostName type: object properties: enterpriseId: type: integer format: int32 clientDeviceId: type: integer format: int32 hostName: type: string macAddress: type: string ipAddress: type: string set_edge_edge_licenses_result: title: set_edge_edge_licenses_result type: object properties: edgeId: type: integer format: int32 edgeLicenseId: type: string success: type: boolean set_enterprise_edge_license_edition_result: title: set_enterprise_edge_license_edition_result type: object properties: original: type: string replacement: type: string Severity: title: Severity enum: - EMERGENCY - ALERT - CRITICAL - ERROR - WARNING - NOTICE - INFO - DEBUG type: string Severity1: title: Severity1 enum: - EMERG - ALERT - CRIT - ERR - WARNING - NOTICE - INFO - DEBUG type: string Site1: title: Site1 type: object properties: name: type: string SmsList: title: SmsList type: object properties: username: type: string mobilePhone: type: string email: type: string Snmp: title: Snmp required: - enabled type: object properties: enabled: type: boolean allowSelectedIp: type: array items: type: string description: List of IP addresses allowed SNMP access ruleLogicalId: type: string Snmp1: title: Snmp1 type: object properties: port: type: integer format: int32 snmpv2c: $ref: '#/components/schemas/Snmpv2c' snmpv3: $ref: '#/components/schemas/Snmpv3' Snmp2: title: Snmp2 type: object properties: port: type: integer format: int32 snmpv2c: $ref: '#/components/schemas/device_settings_snmpv2c' snmpv3: $ref: '#/components/schemas/device_settings_snmpv3' Snmpv2c: title: Snmpv2c type: object properties: enable: type: boolean enabled: type: boolean community: type: string allowedIp: type: array items: type: string description: '' Snmpv3: title: Snmpv3 type: object properties: enabled: type: boolean enable: type: boolean users: type: array items: $ref: '#/components/schemas/device_settings_snmpv3_user' description: '' Space: title: Space type: object properties: cidrIp: type: string cidrPrefix: type: integer format: int32 maxVlans: type: integer format: int32 mode: type: string name: type: string branchCidrPrefix: type: integer format: int32 guest: type: boolean vlans: type: array items: $ref: '#/components/schemas/Vlan1' description: '' SRuleType: title: SRuleType enum: - exact - prefix - wildcard - netmask type: string description: Source rule type SRuleType2: title: SRuleType2 enum: - exact - prefix - wildcard - netmask type: string Ssh: title: Ssh required: - enabled type: object properties: enabled: type: boolean allowSelectedIp: type: array items: type: string description: '' ruleLogicalId: type: string standby_vco_designee: title: standby_vco_designee required: - standbyAddress - standbyUuid type: object properties: standbyAddress: type: string standbyReplicationAddress: type: string standbyUuid: type: string StandbyList: title: StandbyList type: object properties: standbyAddress: type: string standbyReplicationAddress: type: string standbyUuid: type: string State: title: State enum: - PENDING - ACTIVE - CLOSED type: string State1: title: State1 enum: - UNKNOWN - STABLE - UNSTABLE - DISCONNECTED - QUIET - INITIAL - STANDBY type: string State2: title: State2 enum: - IDLE - CONNECT - ACTIVE - OPENSENT - OPENCONFIRM - ESTABLISHED - CLEARING - IDLEADMIN - IDLEPRFXCT type: string StateHistory: title: StateHistory type: object properties: from: $ref: '#/components/schemas/From' to: $ref: '#/components/schemas/To' timestamp: type: string format: date-time StateMap: title: StateMap type: object properties: before: type: integer format: int32 after: type: integer format: int32 action: type: integer format: int32 StaticRoutes: title: StaticRoutes type: object properties: override: type: boolean subnets: type: array items: $ref: '#/components/schemas/Subnet1' description: '' StaticSLA: title: StaticSLA type: object properties: latencyMs: type: integer format: int32 jitterMs: type: integer format: int32 lossPct: type: integer format: int32 StaticSLA1: title: StaticSLA1 type: object properties: latencyMs: type: integer format: int32 jitterMs: type: integer format: int32 lossPct: type: string Status: title: Status enum: - IN_PROGRESS - ERROR - FAILED - COMPLETED - UNKNOWN type: string Status1: title: Status1 enum: - DEPLOYED - POWERED_ON - POWERED_OFF - DELETED - ERROR - UNKNOWN type: string Subinterface: title: Subinterface type: object properties: addressing: $ref: '#/components/schemas/device_settings_routed_interface_addressing' advertise: type: boolean pingResponse: type: boolean default: true dhcpServer: $ref: '#/components/schemas/edgeDeviceSettingsDataDhcpServer' disabled: type: boolean natDirect: type: boolean ospf: $ref: '#/components/schemas/Ospf1' override: type: boolean subinterfaceId: type: integer format: int32 subinterfaceType: type: string vlanId: type: integer description: static only format: int32 trusted: type: boolean rpf: $ref: '#/components/schemas/Rpf' SubinterfaceType: title: SubinterfaceType enum: - SECONDARY_IP - SUB_INTERFACE type: string Subnet1: title: Subnet1 type: object properties: name: type: string routeCost: maximum: 255 minimum: 0 type: integer format: int32 cidrIp: type: string cidrPrefix: type: integer format: int32 encrypt: type: boolean handOffType: $ref: '#/components/schemas/HandOffType' Subnet3: title: Subnet3 type: object properties: advertise: type: boolean cidrIp: type: string cidrIpStart: type: string cidrIpEnd: type: string cidrPrefix: type: string name: type: string netMask: type: string SuperDetail: title: SuperDetail type: object properties: ipAddress: type: string logicalId: type: string name: type: string SyncStatus: title: SyncStatus type: object properties: state: type: string stateTimestamp: type: integer format: int32 lastSyncTimestamp: type: integer format: int32 errorDetail: $ref: '#/components/schemas/ErrorDetail' system_property_get_system_properties: title: system_property_get_system_properties type: object properties: group: type: string description: Filter for properties matching a given group prefix normalize: type: boolean description: If true, transforms query result from rowset to single object with attribute names matching property names fetched system_property_get_system_property: title: system_property_get_system_property type: object properties: name: type: string id: type: integer format: int32 system_property_insert_or_update_system_property: title: system_property_insert_or_update_system_property required: - name - value type: object properties: name: type: string value: type: string defaultValue: type: string isPassword: type: boolean isReadOnly: type: boolean dataType: type: string description: type: string system_property_insert_system_property: title: system_property_insert_system_property required: - name - value type: object properties: name: type: string value: type: string defaultValue: type: string dataType: type: string description: type: string isPassword: type: boolean isReadOnly: type: boolean system_property_update_system_property: title: system_property_update_system_property required: - _update type: object properties: name: type: string id: type: integer format: int32 _update: $ref: '#/components/schemas/Update5' Tacacs: title: Tacacs type: object properties: ref: type: string sourceInterface: type: string To: title: To enum: - UNCONFIGURED - ACTIVE_CONFIGURING - ACTIVE_CONFIGURED - LAUNCHING_STANDBY - LAUNCHED_STANDBY - ACTIVE_WAIT_STANDBY - PENDING_STANDBY_CANDIDATE - STANDBY_CANDIDATE - STANDBY_CONFIG_RQST - STANDBY_CONFIGURING - STANDBY_CONFIGURED - PENDING_STANDBY_UNCONFIG - STANDBY_UNCONFIG - PENDING_STANDBY_PROMOTION - STANDBY_PROMOTED - PENDING_ACTIVE_DEMOTION - COPYING_DB - COPY_DB_DONE - COPYING_FILES - COPY_FILES_DONE - SYNC_CONFIGURING - STANDBY_SYNC - STANDBY_BACKGROUND_IMPORT - STANDBY_RUNNING - UPGRADING - FAILURE_ACTIVE_CONFIGURING - FAILURE_LAUNCHING_STANDBY - FAILURE_STANDBY_CONFIGURING - FAILURE_GET_STANDBY_CONFIG - FAILURE_COPYING_DB - FAILURE_COPYING_FILES - FAILURE_SYNC_CONFIGURING - FAILURE_BACKGROUND_IMPORT - FAILURE_SYNCING_FILES - FAILURE_GET_STANDBY_STATUS - FAILURE_GET_ACTIVE_STATUS - FAILURE_MYSQL_ACTIVE_STATUS - FAILURE_MYSQL_STANDBY_STATUS - FAILURE_STANDBY_CANDIDATE - FAILURE_STANDBY_UNCONFIG - FAILURE_STANDBY_PROMOTION - FAILURE_ACTIVE_DEMOTION type: string TrafficType: title: TrafficType enum: - 0 - 1 - 2 type: integer TunnelingProtocol: title: TunnelingProtocol enum: - GRE - IPSEC type: string TunnelInterface: title: TunnelInterface type: object properties: MTU: type: integer format: int32 Type: title: Type enum: - EDGE_DOWN - EDGE_UP - LINK_DOWN - LINK_UP - VPN_TUNNEL_DOWN - EDGE_HA_FAILOVER - EDGE_SERVICE_DOWN - GATEWAY_SERVICE_DOWN - VNF_VM_EVENT - VNF_VM_DEPLOYED_AND_POWERED_OFF - VNF_VM_POWERED_ON - VNF_VM_POWERED_OFF - VNF_VM_DELETED - VNF_VM_ERROR - VNF_INSERTION_EVENT - VNF_INSERTION_ENABLED - VNF_INSERTION_DISABLED - TEST_ALERT - VNF_IMAGE_DOWNLOAD_EVENT - VNF_IMAGE_DOWNLOAD_IN_PROGRESS - VNF_IMAGE_DOWNLOAD_COMPLETED - VNF_IMAGE_DOWNLOAD_FAILED - EDGE_CSS_TUNNEL_DOWN - EDGE_CSS_TUNNEL_UP type: string Type2: title: Type2 enum: - ENTERPRISE - OPERATOR - GATEWAY type: string Type3: title: Type3 enum: - port_forwarding - one_to_one_nat type: string Type4: title: Type4 enum: - REGULAR - CDE type: string Type5: title: Type5 enum: - DHCP - STATIC - PPPOE type: string Type7: title: Type7 enum: - wired - wireless type: string Type8: title: Type8 enum: - IGMP_V2 type: string Type9: title: Type9 enum: - PIM_SM type: string Type13: title: Type13 enum: - PERMIT - DENY type: string Type14: title: Type14 enum: - AS_PATH_PREPEND - METRIC - LOCAL_PREFERENCE - COMMUNITY type: string Type15: title: Type15 enum: - COMMUNITY - PREFIX type: string Type16: title: Type16 enum: - SOURCE_IP type: string Type17: title: Type17 enum: - STATIC type: string Type18: title: Type18 enum: - source - destination type: string Type19: title: Type19 enum: - edgeHub - edgeHubCluster type: string Type20: title: Type20 enum: - WIRED - WIRELESS type: string Type23: title: Type23 enum: - ACTIVE_ACTIVE - ACTIVE_STANDBY - VRRP type: string Type25: title: Type25 enum: - NONE - 802.1Q - 802.1ad - QinQ (0x9100) - QinQ (0x8100) type: string Type27: title: Type27 enum: - INBOUND - OUTBOUND - SERVICE type: string Type28: title: Type28 enum: - dns - authentication - dataCenter - dataCenterEdge - edgeHub - partnerGateway - edgeHubCluster - edgeBranchCluster - localUiCredentials - edgeBranchClusterMember - edgeHubClusterMember - securityVnf - edgeVrrpPairSet - cloudSecurityService - cloudSecurityServiceSite - securityVnfLicense - securityVnfService - primary - secondary - controllerGateway - tacacs - netflowCollector - iaasSubscription - netflowFilter - vnfImage - custom type: string Type29: title: Type29 enum: - Cisco ISR - Cisco ASA - SonicWall - Palo Alto - Other - Generic Policy - Zscaler - GenericIKEv2Router - CheckPoint - Microsoft Azure Virtual Hub type: string TypeAlias: title: TypeAlias enum: - Cisco ISR - Cisco ASA - SonicWall - Palo Alto - Other - Generic Policy - Zscaler - GenericIKEv2Router - CheckPoint - Microsoft Azure Virtual Hub type: string Update: title: Update type: object properties: name: type: string description: type: string version: type: string effective: type: string Update1: title: Update1 type: object properties: site: $ref: '#/components/schemas/site' name: type: string description: type: string serialNumber: type: string Update2: title: Update2 type: object properties: enterpriseId: type: integer format: int32 name: type: string data: $ref: '#/components/schemas/Data1' Update3: title: Update3 type: object properties: name: type: string description: type: string type: $ref: '#/components/schemas/Type4' data: $ref: '#/components/schemas/network_segment_data' Update4: title: Update4 type: object properties: operatorAlertsEnabled: type: integer format: int32 alertsEnabled: type: integer format: int32 data: type: object name: type: string type: type: string Update5: title: Update5 type: object properties: name: type: string value: type: string defaultValue: type: string isPassword: type: boolean isReadOnly: type: boolean dataType: type: string description: type: string User2: title: User2 type: object properties: email: type: string username: type: string password: type: string UserType: title: UserType enum: - OPERATOR - MSP - PARTNER - ENTERPRISE - END_USER - CUSTOM type: string UtilizationDetail: title: UtilizationDetail type: object properties: load: type: number overall: type: number cpu: type: number memory: type: number Value: title: Value type: object properties: type: type: string value: type: string Value1: title: Value1 type: object properties: type: $ref: '#/components/schemas/Type14' value: type: string vco_diagnostics_get_vco_db_diagnosticsResponse: title: vco_diagnostics_get_vco_db_diagnosticsResponse type: object properties: name: type: string description: type: string method: type: string result: $ref: '#/components/schemas/Result' vco_inventory_associate_edge: title: vco_inventory_associate_edge type: object properties: edgeInventoryId: type: integer format: int32 enterpriseId: type: integer format: int32 edgeId: type: integer format: int32 deviceSerialNumber: type: string vco_inventory_associate_edgeResponse: title: vco_inventory_associate_edgeResponse type: object properties: id: type: integer format: int32 deviceSerialNumber: type: string vco_inventory_get_inventory_items: title: vco_inventory_get_inventory_items type: object properties: enterpriseId: type: integer format: int32 modifiedSince: type: integer format: int32 with: type: array items: $ref: '#/components/schemas/With21' description: '' VcoOwner: title: VcoOwner type: object properties: accountNumber: type: string name: type: string VcoToIdpRoleMap: title: VcoToIdpRoleMap type: object properties: Operator Business: type: array items: type: string description: '' Operator Standard Admin: type: array items: type: string description: '' Operator Superuser: type: array items: type: string description: '' Operator Support: type: array items: type: string description: '' VcoToIdpRoleMap1: title: VcoToIdpRoleMap1 type: object properties: MSP Business: type: array items: type: string description: '' MSP Standard Admin: type: array items: type: string description: '' MSP Superuser: type: array items: type: string description: '' MSP Support: type: array items: type: string description: '' VcoToIdpRoleMap2: title: VcoToIdpRoleMap2 type: object properties: Enterprise Read Only: type: array items: type: string description: '' Enterprise Standard Admin: type: array items: type: string description: '' Enterprise Superuser: type: array items: type: string description: '' Enterprise Support: type: array items: type: string description: '' Velocloud: title: Velocloud type: object properties: table_schema: type: string table_name: type: string table_rows: type: integer format: int32 avg_row_length: type: integer format: int32 data_length: type: integer format: int32 index_length: type: integer format: int32 data_free: type: integer format: int32 VelocloudCa: title: VelocloudCa type: object properties: table_schema: type: string table_name: type: string table_rows: type: integer format: int32 avg_row_length: type: integer format: int32 data_length: type: integer format: int32 index_length: type: integer format: int32 data_free: type: integer format: int32 VelocloudDr: title: VelocloudDr type: object properties: table_schema: type: string table_name: type: string table_rows: type: integer format: int32 avg_row_length: type: integer format: int32 data_length: type: integer format: int32 index_length: type: integer format: int32 data_free: type: integer format: int32 VelocloudStat: title: VelocloudStat type: object properties: table_schema: type: string table_name: type: string table_rows: type: integer format: int32 avg_row_length: type: integer format: int32 data_length: type: integer format: int32 index_length: type: integer format: int32 data_free: type: integer format: int32 Vendor: title: Vendor enum: - PaloAlto - CheckPoint - Fortinet - CentOS type: string Virtual: title: Virtual type: object properties: routedInterfaces: type: array items: $ref: '#/components/schemas/RoutedInterface1' description: '' lan: $ref: '#/components/schemas/Lan2' Visibility: title: Visibility type: object properties: override: type: boolean mode: $ref: '#/components/schemas/Mode1' Vlan1: title: Vlan1 type: object properties: name: type: string vlanId: type: integer format: int32 advertise: type: boolean cost: type: integer format: int32 staticReserved: type: integer format: int32 dhcp: $ref: '#/components/schemas/Dhcp' VmConfiguration: title: VmConfiguration type: object properties: adminPassword: type: string VnfStatus: title: VnfStatus type: object properties: description: type: string status: type: string vmStatus: type: string vnfInsertionEnabled: type: string VnfType: title: VnfType enum: - securityVnf type: string Vpn: title: Vpn type: object properties: dataCenterEdges: type: array items: $ref: '#/components/schemas/DataCenterEdge' description: '' edgeToDataCenter: type: boolean edgeToEdge: type: boolean edgeToEdgeDetail: $ref: '#/components/schemas/EdgeToEdgeDetail' edgeToEdgeList: type: array items: $ref: '#/components/schemas/EdgeToEdgeList' description: '' vpn_generate_vpn_gateway_configuration: title: vpn_generate_vpn_gateway_configuration required: - name - data type: object properties: enterpriseId: type: integer format: int32 name: type: string data: $ref: '#/components/schemas/data_center_data' Vpn1: title: Vpn1 type: object properties: enabled: type: boolean edgeToDataCenter: type: boolean ref: type: string edgeToEdgeHub: $ref: '#/components/schemas/EdgeToEdgeHub' edgeToEdge: type: boolean edgeToEdgeDetail: $ref: '#/components/schemas/EdgeToEdgeDetail1' VpnState: title: VpnState enum: - UNKNOWN - STABLE - UNSTABLE - DEAD - STANDBY type: string Vqm: title: Vqm type: object properties: enable: type: boolean enabled: type: boolean protocol: type: string collectors: type: array items: $ref: '#/components/schemas/device_settings_vqm_collector' description: '' Vqm1: title: Vqm1 type: object properties: enabled: type: boolean protocol: type: string collectors: type: array items: $ref: '#/components/schemas/device_settings_vqm_collector' description: '' WAN1: title: WAN1 required: - version - schemaVersion - type - data type: object properties: version: type: string schemaVersion: type: string type: $ref: '#/components/schemas/Type2' data: $ref: '#/components/schemas/WAN_data' WanOverlay: title: WanOverlay enum: - DISABLED - AUTO_DISCOVERED - USER_DEFINED type: string WebProxy: title: WebProxy type: object properties: providers: type: array items: type: object description: '' With: title: With enum: - modules - edgeCount - enterprises - enterpriseCount - counts type: string With1: title: With1 enum: - clientContact - stateHistory - clientCount - storageInfo type: string With2: title: With2 enum: - recentLinks - links - serviceGroups - site - enterprise - configuration - configurationWithModules type: string With3: title: With3 enum: - enterpriseProxy type: string With4: title: With4 enum: - notifications type: string With5: title: With5 enum: - edges - modules - edgeCount - refs - deviceSettings type: string With6: title: With6 enum: - site - links - recentLinks - configuration - cloudServices - cloudServiceSiteStatus - vnfs - certificates - licenses type: string With7: title: With7 enum: - edges - edgeCount - profileCount type: string With9: title: With9 enum: - profileCount - edgeUsage - configuration - handoffUsage - mpgUsage type: string With10: title: With10 enum: - profileCount - edgeUsage - configuration - groupCount type: string With11: title: With11 enum: - edges - edgeCount type: string With12: title: With12 enum: - gateways - enterprises type: string With13: title: With13 enum: - site - roles - pools - dataCenters - certificates - enterprises - handOffEdges - enterpriseAssociations - enterpriseAssociationCounts type: string With14: title: With14 enum: - edges - edgeCount - modules - enterprises type: string With15: title: With15 enum: - rules type: string With16: title: With16 enum: - category - linkId type: string With17: title: With17 enum: - modules - counts type: string With18: title: With18 enum: - edges - edgeCount - edgeConfigUpdate type: string With21: title: With21 enum: - edge - vcoOwner type: string tags: - name: all description: '' - name: clientDevice description: '' - name: configuration description: '' - name: edge description: '' - name: enterprise description: '' - name: userMaintenance description: '' - name: enterpriseProxy description: '' - name: event description: '' - name: firewall description: '' - name: gateway description: '' - name: linkQualityEvent description: '' - name: network description: '' - name: role description: '' - name: systemProperty description: ''