github.com/rzurga/go-swagger@v0.28.1-0.20211109195225-5d1f453ffa3a/fixtures/bugs/2161/fixture-2161-panic.json (about) 1 { 2 "swagger": "2.0", 3 "info": { 4 "title": "VeloCloud Orchestrator API", 5 "version": "3.3.2", 6 "contact": { 7 "name": "VMware SD-WAN by VeloCloud", 8 "email": "support@velocloud.net", 9 "url": "https://www.vmware.com/products/sd-wan-by-velocloud.html" 10 } 11 }, 12 "basePath": "/portal/rest", 13 "schemes": [ 14 "https" 15 ], 16 "produces": [ 17 "application/json" 18 ], 19 "paths": { 20 "/login/operatorLogin": { 21 "post": { 22 "operationId": "login_operator_login", 23 "summary": "Authenticate operator user", 24 "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).", 25 "tags": [ 26 "all", 27 "login" 28 ], 29 "parameters": [ 30 { 31 "$ref": "#/parameters/auth_param" 32 } 33 ], 34 "responses": { 35 "200": { 36 "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." 37 }, 38 "302": { 39 "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." 40 } 41 } 42 } 43 }, 44 "/login/enterpriseLogin": { 45 "post": { 46 "operationId": "login_enterprise_login", 47 "summary": "Authenticate enterprise or partner (MSP) user", 48 "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.\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).", 49 "tags": [ 50 "all", 51 "login" 52 ], 53 "parameters": [ 54 { 55 "$ref": "#/parameters/auth_param" 56 } 57 ], 58 "responses": { 59 "200": { 60 "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." 61 }, 62 "302": { 63 "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." 64 } 65 } 66 } 67 }, 68 "/logout": { 69 "post": { 70 "operationId": "logout", 71 "summary": "Logout and invalidate authorization session cookie", 72 "description": "Logs out the VCO API user and invalidates the session cookie.", 73 "tags": [ 74 "all", 75 "login" 76 ], 77 "parameters": [], 78 "responses": { 79 "200": { 80 "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." 81 }, 82 "302": { 83 "description": "An HTTP 302 (redirect) response is returned on both successful and failed logout attempts." 84 } 85 } 86 } 87 }, 88 "/meta/{apiPath}": { 89 "post": { 90 "deprecated": true, 91 "operationId": "meta", 92 "summary": "Get Swagger specification for any VCO API call", 93 "description": "Gets the Swagger specification for any VCO API call.", 94 "tags": [ 95 "all", 96 "meta" 97 ], 98 "parameters": [ 99 { 100 "name": "apiPath", 101 "in": "path", 102 "description": "the path to another api method, starting after /rest/", 103 "required": true, 104 "type": "string" 105 } 106 ], 107 "responses": { 108 "200": { 109 "description": "Request successful", 110 "schema": { 111 "type": "object", 112 "properties": { 113 "privileges": { 114 "type": "object" 115 }, 116 "swagger": { 117 "type": "object" 118 } 119 } 120 } 121 }, 122 "400": { 123 "$ref": "#/responses/generic_400" 124 } 125 } 126 } 127 }, 128 "/clientDevice/setClientDeviceHostName": { 129 "post": { 130 "summary": "Set hostname for client device", 131 "description": "Sets the `hostName` for client device\n\nPrivileges required:\n\n`UPDATE` `CLIENT_DEVICE`", 132 "tags": [ 133 "clientDevice", 134 "all" 135 ], 136 "operationId": "set_client_device_host_name", 137 "x-privileges": { 138 "forceEnterpriseContext": true, 139 "excludeAuthTypes": [], 140 "allowAuthTypes": [ 141 "ANY" 142 ], 143 "allowPrincipleTypes": [], 144 "excludePrincipleTypes": [ 145 "EDGE", 146 "GATEWAY" 147 ], 148 "requirePrivileges": [ 149 { 150 "action": "UPDATE", 151 "object": "CLIENT_DEVICE" 152 } 153 ] 154 }, 155 "parameters": [ 156 { 157 "name": "body", 158 "in": "body", 159 "required": true, 160 "schema": { 161 "title": "set_client_device_host_name", 162 "type": "object", 163 "properties": { 164 "enterpriseId": { 165 "type": "integer" 166 }, 167 "clientDeviceId": { 168 "type": "integer" 169 }, 170 "hostName": { 171 "type": "string" 172 }, 173 "macAddress": { 174 "type": "string" 175 }, 176 "ipAddress": { 177 "type": "string" 178 } 179 }, 180 "required": [ 181 "enterpriseId", 182 "hostName" 183 ] 184 } 185 } 186 ], 187 "responses": { 188 "200": { 189 "description": "Request was successfully processed", 190 "schema": { 191 "$ref": "#/definitions/set_client_device_host_name_result" 192 } 193 }, 194 "400": { 195 "$ref": "#/responses/generic_400" 196 }, 197 "500": { 198 "$ref": "#/responses/generic_500" 199 } 200 } 201 } 202 }, 203 "/configuration/cloneAndConvertConfiguration": { 204 "post": { 205 "summary": "Create new segment-based profile from existing network-based profile", 206 "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.\n\nPrivileges required:\n\n`CREATE` `ENTERPRISE_PROFILE`, or\n\n`CREATE` `OPERATOR_PROFILE`", 207 "tags": [ 208 "configuration", 209 "all" 210 ], 211 "operationId": "configuration_clone_and_convert_configuration", 212 "x-privileges": { 213 "excludeAuthTypes": [], 214 "allowAuthTypes": [ 215 "ANY" 216 ], 217 "allowPrincipleTypes": [], 218 "excludePrincipleTypes": [ 219 "EDGE", 220 "GATEWAY" 221 ], 222 "requirePrivileges": [ 223 { 224 "action": "CREATE", 225 "object": "ENTERPRISE_PROFILE", 226 "sufficient": true 227 }, 228 { 229 "action": "CREATE", 230 "object": "OPERATOR_PROFILE", 231 "sufficient": true 232 } 233 ] 234 }, 235 "parameters": [ 236 { 237 "name": "body", 238 "in": "body", 239 "required": true, 240 "schema": { 241 "type": "object", 242 "title": "configuration_clone_and_convert_configuration", 243 "properties": { 244 "configurationId": { 245 "type": "integer" 246 }, 247 "enterpriseId": { 248 "type": "integer" 249 }, 250 "name": { 251 "type": "string" 252 }, 253 "description": { 254 "type": "string" 255 }, 256 "guestVLANSegmentObjectId": { 257 "type": "integer" 258 } 259 }, 260 "required": [ 261 "configurationId" 262 ] 263 } 264 } 265 ], 266 "responses": { 267 "200": { 268 "description": "Request was successfully processed", 269 "schema": { 270 "$ref": "#/definitions/configuration_clone_and_convert_configuration_result" 271 } 272 }, 273 "400": { 274 "$ref": "#/responses/generic_400" 275 }, 276 "500": { 277 "$ref": "#/responses/generic_500" 278 } 279 } 280 } 281 }, 282 "/configuration/cloneConfiguration": { 283 "post": { 284 "summary": "Clone configuration profile", 285 "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.\n\nPrivileges required:\n\n`CREATE` `ENTERPRISE_PROFILE`, or\n\n`CREATE` `OPERATOR_PROFILE`", 286 "tags": [ 287 "configuration", 288 "all" 289 ], 290 "operationId": "configuration_clone_configuration", 291 "x-privileges": { 292 "excludeAuthTypes": [], 293 "allowAuthTypes": [ 294 "ANY" 295 ], 296 "allowPrincipleTypes": [], 297 "excludePrincipleTypes": [ 298 "EDGE", 299 "GATEWAY" 300 ], 301 "requirePrivileges": [ 302 { 303 "action": "CREATE", 304 "object": "ENTERPRISE_PROFILE", 305 "sufficient": true 306 }, 307 { 308 "action": "CREATE", 309 "object": "OPERATOR_PROFILE", 310 "sufficient": true 311 } 312 ] 313 }, 314 "parameters": [ 315 { 316 "name": "body", 317 "in": "body", 318 "required": true, 319 "schema": { 320 "type": "object", 321 "title": "configuration_clone_configuration", 322 "properties": { 323 "configurationId": { 324 "type": "integer" 325 }, 326 "networkId": { 327 "type": "integer" 328 }, 329 "enterpriseId": { 330 "type": "integer" 331 }, 332 "name": { 333 "type": "string" 334 }, 335 "version": { 336 "type": "string" 337 }, 338 "description": { 339 "type": "string" 340 } 341 }, 342 "required": [ 343 "configurationId" 344 ] 345 } 346 } 347 ], 348 "responses": { 349 "200": { 350 "description": "Request was successfully processed", 351 "schema": { 352 "$ref": "#/definitions/configuration_clone_configuration_result" 353 } 354 }, 355 "400": { 356 "$ref": "#/responses/generic_400" 357 }, 358 "500": { 359 "$ref": "#/responses/generic_500" 360 } 361 } 362 } 363 }, 364 "/configuration/cloneEnterpriseTemplate": { 365 "post": { 366 "summary": "Clone default enterprise configuration profile", 367 "description": "Creates a new enterprise configuration from the enterprise default configuration. On success, returns the `id` of the newly created configuration object.\n\nPrivileges required:\n\n`CREATE` `ENTERPRISE_PROFILE`, or\n\n`CREATE` `OPERATOR_PROFILE`", 368 "tags": [ 369 "all", 370 "configuration" 371 ], 372 "operationId": "configuration_clone_enterprise_template", 373 "x-privileges": { 374 "excludeAuthTypes": [], 375 "allowAuthTypes": [ 376 "ANY" 377 ], 378 "allowPrincipleTypes": [], 379 "excludePrincipleTypes": [ 380 "EDGE", 381 "GATEWAY" 382 ], 383 "requirePrivileges": [ 384 { 385 "action": "CREATE", 386 "object": "ENTERPRISE_PROFILE", 387 "sufficient": true 388 }, 389 { 390 "action": "CREATE", 391 "object": "OPERATOR_PROFILE", 392 "sufficient": true 393 } 394 ] 395 }, 396 "parameters": [ 397 { 398 "name": "body", 399 "in": "body", 400 "required": true, 401 "schema": { 402 "type": "object", 403 "title": "configuration_clone_enterprise_template", 404 "properties": { 405 "enterpriseId": { 406 "type": "integer", 407 "description": "Required if called from the operator or MSP context, identifies the target enterprise of the API call." 408 }, 409 "configurationType": { 410 "type": "string", 411 "enum": [ 412 "SEGMENT_BASED", 413 "NETWORK_BASED" 414 ], 415 "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." 416 }, 417 "name": { 418 "type": "string" 419 }, 420 "description": { 421 "type": "string" 422 } 423 } 424 } 425 } 426 ], 427 "responses": { 428 "200": { 429 "description": "Request was successfully processed", 430 "schema": { 431 "$ref": "#/definitions/configuration_clone_enterprise_template_result" 432 } 433 }, 434 "400": { 435 "$ref": "#/responses/generic_400" 436 }, 437 "500": { 438 "$ref": "#/responses/generic_500" 439 } 440 } 441 } 442 }, 443 "/configuration/deleteConfiguration": { 444 "post": { 445 "summary": "Delete configuration profile", 446 "description": "Deletes the specified configuration profile (by `id`). On success, returns an object indicating the number of objects (rows) deleted (1 or 0).\n\nPrivileges required:\n\n`DELETE` `ENTERPRISE_PROFILE`, or\n\n`DELETE` `OPERATOR_PROFILE`", 447 "tags": [ 448 "all", 449 "configuration" 450 ], 451 "operationId": "configuration_delete_configuration", 452 "x-privileges": { 453 "excludeAuthTypes": [], 454 "allowAuthTypes": [ 455 "ANY" 456 ], 457 "allowPrincipleTypes": [], 458 "excludePrincipleTypes": [ 459 "EDGE", 460 "GATEWAY" 461 ], 462 "requirePrivileges": [ 463 { 464 "action": "DELETE", 465 "object": "ENTERPRISE_PROFILE", 466 "sufficient": true 467 }, 468 { 469 "action": "DELETE", 470 "object": "OPERATOR_PROFILE", 471 "sufficient": true 472 } 473 ] 474 }, 475 "parameters": [ 476 { 477 "name": "body", 478 "in": "body", 479 "required": true, 480 "schema": { 481 "type": "object", 482 "title": "configuration_delete_configuration", 483 "properties": { 484 "enterpriseId": { 485 "type": "integer" 486 }, 487 "id": { 488 "type": "integer" 489 } 490 }, 491 "required": [ 492 "id" 493 ] 494 } 495 } 496 ], 497 "responses": { 498 "200": { 499 "description": "Request was successfully processed", 500 "schema": { 501 "$ref": "#/definitions/configuration_delete_configuration_result" 502 } 503 }, 504 "400": { 505 "$ref": "#/responses/generic_400" 506 }, 507 "500": { 508 "$ref": "#/responses/generic_500" 509 } 510 } 511 } 512 }, 513 "/configuration/getConfiguration": { 514 "post": { 515 "summary": "Get configuration profile", 516 "description": "Gets the specified configuration profile, optionally with module details.\n\nPrivileges required:\n\n`READ` `ENTERPRISE_PROFILE`, or\n\n`READ` `OPERATOR_PROFILE`", 517 "tags": [ 518 "all", 519 "configuration" 520 ], 521 "operationId": "configuration_get_configuration", 522 "x-privileges": { 523 "excludeAuthTypes": [], 524 "allowAuthTypes": [ 525 "ANY" 526 ], 527 "allowPrincipleTypes": [], 528 "excludePrincipleTypes": [ 529 "EDGE", 530 "GATEWAY" 531 ], 532 "requirePrivileges": [ 533 { 534 "action": "READ", 535 "object": "ENTERPRISE_PROFILE", 536 "sufficient": true 537 }, 538 { 539 "action": "READ", 540 "object": "OPERATOR_PROFILE", 541 "sufficient": true 542 } 543 ] 544 }, 545 "parameters": [ 546 { 547 "name": "body", 548 "in": "body", 549 "required": true, 550 "schema": { 551 "type": "object", 552 "title": "configuration_get_configuration", 553 "properties": { 554 "id": { 555 "type": "integer" 556 }, 557 "enterpriseId": { 558 "type": "integer" 559 }, 560 "with": { 561 "type": "array", 562 "items": { 563 "type": "string", 564 "enum": [ 565 "modules", 566 "edgeCount", 567 "enterprises", 568 "enterpriseCount", 569 "counts" 570 ] 571 } 572 } 573 }, 574 "required": [ 575 "id" 576 ] 577 } 578 } 579 ], 580 "responses": { 581 "200": { 582 "description": "Request was successfully processed", 583 "schema": { 584 "$ref": "#/definitions/configuration_get_configuration_result" 585 } 586 }, 587 "400": { 588 "$ref": "#/responses/generic_400" 589 }, 590 "500": { 591 "$ref": "#/responses/generic_500" 592 } 593 } 594 } 595 }, 596 "/configuration/getConfigurationModules": { 597 "post": { 598 "summary": "Get configuration profile modules", 599 "description": "Gets all configuration modules for the specified configuration profile.\n\nPrivileges required:\n\n`READ` `ENTERPRISE_PROFILE`, or\n\n`READ` `OPERATOR_PROFILE`", 600 "tags": [ 601 "configuration", 602 "all" 603 ], 604 "operationId": "configuration_get_configuration_modules", 605 "x-privileges": { 606 "excludeAuthTypes": [], 607 "allowAuthTypes": [ 608 "ANY" 609 ], 610 "allowPrincipleTypes": [], 611 "excludePrincipleTypes": [ 612 "EDGE", 613 "GATEWAY" 614 ], 615 "requirePrivileges": [ 616 { 617 "action": "READ", 618 "object": "ENTERPRISE_PROFILE", 619 "sufficient": true 620 }, 621 { 622 "action": "READ", 623 "object": "OPERATOR_PROFILE", 624 "sufficient": true 625 } 626 ] 627 }, 628 "parameters": [ 629 { 630 "name": "body", 631 "in": "body", 632 "required": true, 633 "schema": { 634 "type": "object", 635 "title": "configuration_get_configuration_modules", 636 "properties": { 637 "configurationId": { 638 "type": "integer" 639 }, 640 "enterpriseId": { 641 "type": "integer" 642 }, 643 "noData": { 644 "type": "boolean" 645 }, 646 "modules": { 647 "type": "array", 648 "items": { 649 "type": "string", 650 "enum": [ 651 "imageUpdate", 652 "controlPlane", 653 "managementPlane", 654 "firewall", 655 "QOS", 656 "deviceSettings", 657 "WAN", 658 "metaData", 659 "properties" 660 ] 661 } 662 } 663 }, 664 "required": [ 665 "configurationId" 666 ] 667 } 668 } 669 ], 670 "responses": { 671 "200": { 672 "description": "Request was successfully processed", 673 "schema": { 674 "title": "configuration_get_configuration_modules_result", 675 "type": "array", 676 "items": { 677 "$ref": "#/definitions/configuration_get_configuration_modules_result_item" 678 } 679 } 680 }, 681 "400": { 682 "$ref": "#/responses/generic_400" 683 }, 684 "500": { 685 "$ref": "#/responses/generic_500" 686 } 687 } 688 } 689 }, 690 "/configuration/getIdentifiableApplications": { 691 "post": { 692 "summary": "Get the applications that are identifiable through DPI.", 693 "description": "Gets all applications that are identifiable through DPI. If called from an operator or MSP context, then `enterpriseId` is required.\n\nPrivileges required:\n\n`READ` `ENTERPRISE_PROFILE`", 694 "tags": [ 695 "all", 696 "configuration" 697 ], 698 "operationId": "configuration_get_identifiable_applications", 699 "x-privileges": { 700 "forceEnterpriseContext": true, 701 "excludeAuthTypes": [], 702 "allowAuthTypes": [ 703 "ANY" 704 ], 705 "allowPrincipleTypes": [], 706 "excludePrincipleTypes": [ 707 "EDGE", 708 "GATEWAY" 709 ], 710 "requirePrivileges": [ 711 { 712 "action": "READ", 713 "object": "ENTERPRISE_PROFILE", 714 "sufficient": true 715 } 716 ] 717 }, 718 "parameters": [ 719 { 720 "name": "body", 721 "in": "body", 722 "required": true, 723 "schema": { 724 "type": "object", 725 "title": "configuration_get_identifiable_applications", 726 "properties": { 727 "enterpriseId": { 728 "type": "integer" 729 } 730 } 731 } 732 } 733 ], 734 "responses": { 735 "200": { 736 "description": "Request was successfully processed", 737 "schema": { 738 "$ref": "#/definitions/configuration_get_identifiable_applications_result" 739 } 740 }, 741 "400": { 742 "$ref": "#/responses/generic_400" 743 }, 744 "500": { 745 "$ref": "#/responses/generic_500" 746 } 747 } 748 } 749 }, 750 "/configuration/getRoutableApplications": { 751 "post": { 752 "summary": "Get first packet routable applications", 753 "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.\n\nPrivileges required:\n\n`VIEW_FLOW_STATS` `undefined`", 754 "tags": [ 755 "all", 756 "configuration" 757 ], 758 "operationId": "configuration_get_routable_applications", 759 "x-privileges": { 760 "forceEnterpriseContext": true, 761 "excludeAuthTypes": [], 762 "allowAuthTypes": [ 763 "ANY" 764 ], 765 "allowPrincipleTypes": [], 766 "excludePrincipleTypes": [ 767 "EDGE", 768 "GATEWAY" 769 ], 770 "requirePrivileges": [ 771 { 772 "action": "VIEW_FLOW_STATS", 773 "sufficient": true 774 } 775 ] 776 }, 777 "parameters": [ 778 { 779 "name": "body", 780 "in": "body", 781 "required": true, 782 "schema": { 783 "type": "object", 784 "title": "configuration_get_routable_applications", 785 "properties": { 786 "enterpriseId": { 787 "type": "integer" 788 }, 789 "edgeId": { 790 "type": "integer" 791 } 792 } 793 } 794 } 795 ], 796 "responses": { 797 "200": { 798 "description": "Request was successfully processed", 799 "schema": { 800 "$ref": "#/definitions/configuration_get_routable_applications_result" 801 } 802 }, 803 "400": { 804 "$ref": "#/responses/generic_400" 805 }, 806 "500": { 807 "$ref": "#/responses/generic_500" 808 } 809 } 810 } 811 }, 812 "/configuration/insertConfigurationModule": { 813 "post": { 814 "summary": "Create configuration module", 815 "description": "Creates a new configuration module for the specified configuration profile.\n\nPrivileges required:\n\n`UPDATE` `ENTERPRISE_PROFILE`, or\n\n`UPDATE` `OPERATOR_PROFILE`", 816 "tags": [ 817 "configuration", 818 "all" 819 ], 820 "operationId": "configuration_insert_configuration_module", 821 "x-privileges": { 822 "excludeAuthTypes": [], 823 "allowAuthTypes": [ 824 "ANY" 825 ], 826 "allowPrincipleTypes": [], 827 "excludePrincipleTypes": [ 828 "EDGE", 829 "GATEWAY" 830 ], 831 "requirePrivileges": [ 832 { 833 "action": "UPDATE", 834 "object": "ENTERPRISE_PROFILE", 835 "sufficient": true 836 }, 837 { 838 "action": "UPDATE", 839 "object": "OPERATOR_PROFILE", 840 "sufficient": true 841 } 842 ] 843 }, 844 "parameters": [ 845 { 846 "name": "body", 847 "in": "body", 848 "required": true, 849 "schema": { 850 "type": "object", 851 "title": "configuration_insert_configuration_module", 852 "properties": { 853 "enterpriseId": { 854 "type": "integer" 855 }, 856 "name": { 857 "type": "string", 858 "enum": [ 859 "imageUpdate", 860 "controlPlane", 861 "managementPlane", 862 "firewall", 863 "QOS", 864 "deviceSettings", 865 "WAN", 866 "metaData", 867 "properties" 868 ] 869 }, 870 "type": { 871 "type": "string", 872 "enum": [ 873 "ENTERPRISE", 874 "OPERATOR", 875 "GATEWAY" 876 ] 877 }, 878 "description": { 879 "type": "string" 880 }, 881 "data": { 882 "type": "object" 883 }, 884 "configurationId": { 885 "type": "integer" 886 }, 887 "version": { 888 "type": "string" 889 } 890 }, 891 "required": [ 892 "name", 893 "data", 894 "configurationId" 895 ] 896 } 897 } 898 ], 899 "responses": { 900 "200": { 901 "description": "Request was successfully processed", 902 "schema": { 903 "$ref": "#/definitions/configuration_insert_configuration_module_result" 904 } 905 }, 906 "400": { 907 "$ref": "#/responses/generic_400" 908 }, 909 "500": { 910 "$ref": "#/responses/generic_500" 911 } 912 } 913 } 914 }, 915 "/configuration/updateConfiguration": { 916 "post": { 917 "summary": "Update configuration profile", 918 "description": "Updates the specified configuration profile record according to the attribute:value mappings specified in the `_update` object.\n\nPrivileges required:\n\n`UPDATE` `ENTERPRISE_PROFILE`, or\n\n`UPDATE` `OPERATOR_PROFILE`", 919 "tags": [ 920 "configuration", 921 "all" 922 ], 923 "operationId": "configuration_update_configuration", 924 "x-privileges": { 925 "excludeAuthTypes": [], 926 "allowAuthTypes": [ 927 "ANY" 928 ], 929 "allowPrincipleTypes": [], 930 "excludePrincipleTypes": [ 931 "EDGE", 932 "GATEWAY" 933 ], 934 "requirePrivileges": [ 935 { 936 "action": "UPDATE", 937 "object": "ENTERPRISE_PROFILE", 938 "sufficient": true 939 }, 940 { 941 "action": "UPDATE", 942 "object": "OPERATOR_PROFILE", 943 "sufficient": true 944 } 945 ] 946 }, 947 "parameters": [ 948 { 949 "name": "body", 950 "in": "body", 951 "required": true, 952 "schema": { 953 "type": "object", 954 "title": "configuration_update_configuration", 955 "properties": { 956 "id": { 957 "type": "integer" 958 }, 959 "enterpriseId": { 960 "type": "integer" 961 }, 962 "_update": { 963 "type": "object", 964 "properties": { 965 "name": { 966 "type": "string" 967 }, 968 "description": { 969 "type": "string" 970 }, 971 "version": { 972 "type": "string" 973 }, 974 "effective": { 975 "type": "string" 976 } 977 } 978 } 979 }, 980 "required": [ 981 "id", 982 "_update" 983 ] 984 } 985 } 986 ], 987 "responses": { 988 "200": { 989 "description": "Request was successfully processed", 990 "schema": { 991 "$ref": "#/definitions/rows_modified_confirmation" 992 } 993 }, 994 "400": { 995 "$ref": "#/responses/generic_400" 996 }, 997 "500": { 998 "$ref": "#/responses/generic_500" 999 } 1000 } 1001 } 1002 }, 1003 "/configuration/updateConfigurationModule": { 1004 "post": { 1005 "summary": "Update configuration module", 1006 "description": "Updates the specified configuration module. Expects an `_update` object containing the field(s) to be updated and their corresponding value(s).\n\nPrivileges required:\n\n`UPDATE` `ENTERPRISE_PROFILE`, or\n\n`UPDATE` `OPERATOR_PROFILE`", 1007 "tags": [ 1008 "configuration", 1009 "all" 1010 ], 1011 "operationId": "configuration_update_configuration_module", 1012 "x-privileges": { 1013 "excludeAuthTypes": [], 1014 "allowAuthTypes": [ 1015 "ANY" 1016 ], 1017 "allowPrincipleTypes": [], 1018 "excludePrincipleTypes": [ 1019 "EDGE", 1020 "GATEWAY" 1021 ], 1022 "requirePrivileges": [ 1023 { 1024 "action": "UPDATE", 1025 "object": "ENTERPRISE_PROFILE", 1026 "sufficient": true 1027 }, 1028 { 1029 "action": "UPDATE", 1030 "object": "OPERATOR_PROFILE", 1031 "sufficient": true 1032 } 1033 ] 1034 }, 1035 "parameters": [ 1036 { 1037 "name": "body", 1038 "in": "body", 1039 "required": true, 1040 "schema": { 1041 "type": "object", 1042 "title": "configuration_update_configuration_module", 1043 "properties": { 1044 "id": { 1045 "type": "integer" 1046 }, 1047 "enterpriseId": { 1048 "type": "integer" 1049 }, 1050 "basic": { 1051 "type": "boolean", 1052 "default": false 1053 }, 1054 "_update": { 1055 "$ref": "#/definitions/configuration_module_base_type" 1056 } 1057 } 1058 } 1059 } 1060 ], 1061 "responses": { 1062 "200": { 1063 "description": "Request was successfully processed", 1064 "schema": { 1065 "$ref": "#/definitions/configuration_update_configuration_module_result" 1066 } 1067 }, 1068 "400": { 1069 "$ref": "#/responses/generic_400" 1070 }, 1071 "500": { 1072 "$ref": "#/responses/generic_500" 1073 } 1074 } 1075 } 1076 }, 1077 "/disasterRecovery/configureActiveForReplication": { 1078 "post": { 1079 "summary": "Configure current VCO for disaster recovery", 1080 "tags": [ 1081 "all", 1082 "disasterRecovery" 1083 ], 1084 "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.)\n\nPrivileges required:\n\n`CREATE` `REPLICATION`", 1085 "operationId": "disaster_recovery_configure_active_for_replication", 1086 "x-privileges": { 1087 "excludeAuthTypes": [], 1088 "allowAuthTypes": [ 1089 "OPERATOR_USER" 1090 ], 1091 "allowPrincipleTypes": [], 1092 "excludePrincipleTypes": [ 1093 "EDGE", 1094 "GATEWAY" 1095 ], 1096 "requirePrivileges": [ 1097 { 1098 "action": "CREATE", 1099 "object": "REPLICATION" 1100 } 1101 ] 1102 }, 1103 "parameters": [ 1104 { 1105 "name": "body", 1106 "in": "body", 1107 "required": true, 1108 "schema": { 1109 "type": "object", 1110 "title": "disaster_recovery_configure_active_for_replication", 1111 "properties": { 1112 "standbyList": { 1113 "type": "array", 1114 "items": { 1115 "title": "standby_vco_designee", 1116 "type": "object", 1117 "properties": { 1118 "standbyAddress": { 1119 "type": "string" 1120 }, 1121 "standbyReplicationAddress": { 1122 "type": "string" 1123 }, 1124 "standbyUuid": { 1125 "type": "string" 1126 } 1127 }, 1128 "required": [ 1129 "standbyAddress", 1130 "standbyUuid" 1131 ] 1132 } 1133 }, 1134 "autoConfigStandby": { 1135 "type": "boolean", 1136 "default": true 1137 }, 1138 "drVCOUser": { 1139 "type": "string" 1140 }, 1141 "drVCOPassword": { 1142 "type": "string" 1143 } 1144 }, 1145 "required": [ 1146 "standbyList", 1147 "drVCOUser", 1148 "drVCOPassword" 1149 ] 1150 } 1151 } 1152 ], 1153 "responses": { 1154 "200": { 1155 "description": "Request was successfully processed", 1156 "schema": { 1157 "$ref": "#/definitions/disaster_recovery_configure_active_for_replication_result" 1158 } 1159 }, 1160 "400": { 1161 "$ref": "#/responses/generic_400" 1162 }, 1163 "500": { 1164 "$ref": "#/responses/generic_500" 1165 } 1166 } 1167 } 1168 }, 1169 "/disasterRecovery/demoteActive": { 1170 "post": { 1171 "summary": "Demote current VCO from active to zombie", 1172 "tags": [ 1173 "all", 1174 "disasterRecovery" 1175 ], 1176 "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.\n\nPrivileges required:\n\n`CREATE` `REPLICATION`", 1177 "operationId": "disaster_recovery_demote_active", 1178 "x-privileges": { 1179 "excludeAuthTypes": [], 1180 "allowAuthTypes": [ 1181 "OPERATOR_USER" 1182 ], 1183 "allowPrincipleTypes": [], 1184 "excludePrincipleTypes": [ 1185 "EDGE", 1186 "GATEWAY" 1187 ], 1188 "requirePrivileges": [ 1189 { 1190 "action": "CREATE", 1191 "object": "REPLICATION" 1192 } 1193 ] 1194 }, 1195 "parameters": [ 1196 { 1197 "name": "body", 1198 "in": "body", 1199 "required": true, 1200 "schema": { 1201 "type": "object", 1202 "title": "disaster_recovery_demote_active", 1203 "properties": { 1204 "force": { 1205 "type": "boolean", 1206 "default": false 1207 } 1208 } 1209 } 1210 } 1211 ], 1212 "responses": { 1213 "200": { 1214 "description": "Request was successfully processed", 1215 "schema": { 1216 "$ref": "#/definitions/disaster_recovery_demote_active_result" 1217 } 1218 }, 1219 "400": { 1220 "$ref": "#/responses/generic_400" 1221 }, 1222 "500": { 1223 "$ref": "#/responses/generic_500" 1224 } 1225 } 1226 } 1227 }, 1228 "/disasterRecovery/getReplicationBlob": { 1229 "post": { 1230 "summary": "Get blob needed to configure VCO replication on standby", 1231 "tags": [ 1232 "all", 1233 "disasterRecovery" 1234 ], 1235 "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].\n\nPrivileges required:\n\n`CREATE` `REPLICATION`", 1236 "operationId": "disaster_recovery_get_replication_blob", 1237 "x-privileges": { 1238 "excludeAuthTypes": [], 1239 "allowAuthTypes": [ 1240 "OPERATOR_USER" 1241 ], 1242 "allowPrincipleTypes": [], 1243 "excludePrincipleTypes": [ 1244 "EDGE", 1245 "GATEWAY" 1246 ], 1247 "requirePrivileges": [ 1248 { 1249 "action": "CREATE", 1250 "object": "REPLICATION" 1251 } 1252 ] 1253 }, 1254 "parameters": [ 1255 { 1256 "name": "body", 1257 "in": "body", 1258 "required": true, 1259 "schema": { 1260 "$ref": "#/definitions/disaster_recovery_get_replication_blob" 1261 } 1262 } 1263 ], 1264 "responses": { 1265 "200": { 1266 "description": "Request was successfully processed", 1267 "schema": { 1268 "$ref": "#/definitions/disaster_recovery_get_replication_blob_result" 1269 } 1270 }, 1271 "400": { 1272 "$ref": "#/responses/generic_400" 1273 }, 1274 "500": { 1275 "$ref": "#/responses/generic_500" 1276 } 1277 } 1278 } 1279 }, 1280 "/disasterRecovery/getReplicationStatus": { 1281 "post": { 1282 "summary": "Get disaster recovery status", 1283 "tags": [ 1284 "all", 1285 "disasterRecovery" 1286 ], 1287 "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`.\n\nPrivileges required:\n\n`READ` `REPLICATION`", 1288 "operationId": "disaster_recovery_get_replication_status", 1289 "x-privileges": { 1290 "excludeAuthTypes": [], 1291 "allowAuthTypes": [ 1292 "OPERATOR_USER" 1293 ], 1294 "allowPrincipleTypes": [], 1295 "excludePrincipleTypes": [ 1296 "EDGE", 1297 "GATEWAY" 1298 ], 1299 "requirePrivileges": [ 1300 { 1301 "action": "READ", 1302 "object": "REPLICATION" 1303 } 1304 ] 1305 }, 1306 "parameters": [ 1307 { 1308 "name": "body", 1309 "in": "body", 1310 "required": true, 1311 "schema": { 1312 "type": "object", 1313 "title": "disaster_recovery_get_replication_status", 1314 "properties": { 1315 "with": { 1316 "type": "array", 1317 "items": { 1318 "type": "string", 1319 "enum": [ 1320 "clientContact", 1321 "stateHistory", 1322 "clientCount", 1323 "storageInfo" 1324 ] 1325 } 1326 } 1327 } 1328 } 1329 } 1330 ], 1331 "responses": { 1332 "200": { 1333 "description": "Request was successfully processed", 1334 "schema": { 1335 "$ref": "#/definitions/disaster_recovery_get_replication_status_result" 1336 } 1337 }, 1338 "400": { 1339 "$ref": "#/responses/generic_400" 1340 }, 1341 "500": { 1342 "$ref": "#/responses/generic_500" 1343 } 1344 } 1345 } 1346 }, 1347 "/disasterRecovery/prepareForStandby": { 1348 "post": { 1349 "summary": "Designate current VCO as DR standby candidate", 1350 "tags": [ 1351 "all", 1352 "disasterRecovery" 1353 ], 1354 "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.\n\nPrivileges required:\n\n`CREATE` `REPLICATION`", 1355 "operationId": "disaster_recovery_prepare_for_standby", 1356 "x-privileges": { 1357 "excludeAuthTypes": [], 1358 "allowAuthTypes": [ 1359 "OPERATOR_USER" 1360 ], 1361 "allowPrincipleTypes": [], 1362 "excludePrincipleTypes": [ 1363 "EDGE", 1364 "GATEWAY" 1365 ], 1366 "requirePrivileges": [ 1367 { 1368 "action": "CREATE", 1369 "object": "REPLICATION" 1370 } 1371 ] 1372 }, 1373 "parameters": [ 1374 { 1375 "name": "body", 1376 "in": "body", 1377 "required": true, 1378 "schema": { 1379 "$ref": "#/definitions/disaster_recovery_prepare_for_standby" 1380 } 1381 } 1382 ], 1383 "responses": { 1384 "200": { 1385 "description": "Request was successfully processed", 1386 "schema": { 1387 "$ref": "#/definitions/disaster_recovery_prepare_for_standby_result" 1388 } 1389 }, 1390 "400": { 1391 "$ref": "#/responses/generic_400" 1392 }, 1393 "500": { 1394 "$ref": "#/responses/generic_500" 1395 } 1396 } 1397 } 1398 }, 1399 "/disasterRecovery/promoteStandbyToActive": { 1400 "post": { 1401 "summary": "Promote standby VCO to active", 1402 "tags": [ 1403 "all", 1404 "disasterRecovery" 1405 ], 1406 "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`", 1407 "operationId": "disaster_recovery_promote_standby_to_active", 1408 "x-privileges": { 1409 "excludeAuthTypes": [], 1410 "allowAuthTypes": [ 1411 "OPERATOR_USER" 1412 ], 1413 "allowPrincipleTypes": [], 1414 "excludePrincipleTypes": [ 1415 "EDGE", 1416 "GATEWAY" 1417 ], 1418 "requirePrivileges": [ 1419 { 1420 "action": "CREATE", 1421 "object": "REPLICATION" 1422 } 1423 ] 1424 }, 1425 "parameters": [ 1426 { 1427 "name": "body", 1428 "in": "body", 1429 "required": true, 1430 "schema": { 1431 "type": "object", 1432 "title": "disaster_recovery_promote_standby_to_active", 1433 "properties": { 1434 "force": { 1435 "type": "boolean", 1436 "default": false 1437 } 1438 } 1439 } 1440 } 1441 ], 1442 "responses": { 1443 "200": { 1444 "description": "Request was successfully processed", 1445 "schema": { 1446 "$ref": "#/definitions/disaster_recovery_promote_standby_to_active_result" 1447 } 1448 }, 1449 "400": { 1450 "$ref": "#/responses/generic_400" 1451 }, 1452 "500": { 1453 "$ref": "#/responses/generic_500" 1454 } 1455 } 1456 } 1457 }, 1458 "/disasterRecovery/removeStandby": { 1459 "post": { 1460 "summary": "Remove VCO disaster recovery on current server", 1461 "tags": [ 1462 "all", 1463 "disasterRecovery" 1464 ], 1465 "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.\n\nPrivileges required:\n\n`CREATE` `REPLICATION`", 1466 "operationId": "disaster_recovery_remove_standby", 1467 "x-privileges": { 1468 "excludeAuthTypes": [], 1469 "allowAuthTypes": [ 1470 "OPERATOR_USER" 1471 ], 1472 "allowPrincipleTypes": [], 1473 "excludePrincipleTypes": [ 1474 "EDGE", 1475 "GATEWAY" 1476 ], 1477 "requirePrivileges": [ 1478 { 1479 "action": "CREATE", 1480 "object": "REPLICATION" 1481 } 1482 ] 1483 }, 1484 "parameters": [ 1485 { 1486 "name": "body", 1487 "in": "body", 1488 "required": true, 1489 "schema": { 1490 "$ref": "#/definitions/disaster_recovery_remove_standby" 1491 } 1492 } 1493 ], 1494 "responses": { 1495 "200": { 1496 "description": "Request was successfully processed", 1497 "schema": { 1498 "$ref": "#/definitions/disaster_recovery_remove_standby_result" 1499 } 1500 }, 1501 "400": { 1502 "$ref": "#/responses/generic_400" 1503 }, 1504 "500": { 1505 "$ref": "#/responses/generic_500" 1506 } 1507 } 1508 } 1509 }, 1510 "/disasterRecovery/transitionToStandby": { 1511 "post": { 1512 "summary": "Transition VCO to standby", 1513 "tags": [ 1514 "all", 1515 "disasterRecovery" 1516 ], 1517 "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`.\n\nPrivileges required:\n\n`CREATE` `REPLICATION`", 1518 "operationId": "disaster_recovery_transition_to_standby", 1519 "x-privileges": { 1520 "excludeAuthTypes": [], 1521 "allowAuthTypes": [ 1522 "OPERATOR_USER" 1523 ], 1524 "allowPrincipleTypes": [], 1525 "excludePrincipleTypes": [ 1526 "EDGE", 1527 "GATEWAY" 1528 ], 1529 "requirePrivileges": [ 1530 { 1531 "action": "CREATE", 1532 "object": "REPLICATION" 1533 } 1534 ] 1535 }, 1536 "parameters": [ 1537 { 1538 "name": "body", 1539 "in": "body", 1540 "required": true, 1541 "schema": { 1542 "type": "object", 1543 "title": "disaster_recovery_transition_to_standby", 1544 "properties": { 1545 "activeAccessFromStandby": { 1546 "type": "string" 1547 } 1548 } 1549 } 1550 } 1551 ], 1552 "responses": { 1553 "200": { 1554 "description": "Request was successfully processed", 1555 "schema": { 1556 "$ref": "#/definitions/disaster_recovery_transition_to_standby_result" 1557 } 1558 }, 1559 "400": { 1560 "$ref": "#/responses/generic_400" 1561 }, 1562 "500": { 1563 "$ref": "#/responses/generic_500" 1564 } 1565 } 1566 } 1567 }, 1568 "/edge/deleteEdge": { 1569 "post": { 1570 "summary": "Delete Edge", 1571 "description": "Deletes the specified Edge(s) (by `id` or an array of `ids`).\n\nPrivileges required:\n\n`DELETE` `EDGE`", 1572 "tags": [ 1573 "all", 1574 "edge" 1575 ], 1576 "x-privileges": { 1577 "excludeAuthTypes": [], 1578 "allowAuthTypes": [ 1579 "ANY" 1580 ], 1581 "allowPrincipleTypes": [], 1582 "excludePrincipleTypes": [ 1583 "EDGE", 1584 "GATEWAY" 1585 ], 1586 "requirePrivileges": [ 1587 { 1588 "action": "DELETE", 1589 "object": "EDGE" 1590 } 1591 ] 1592 }, 1593 "operationId": "edge_delete_edge", 1594 "parameters": [ 1595 { 1596 "name": "body", 1597 "in": "body", 1598 "required": true, 1599 "schema": { 1600 "type": "object", 1601 "title": "edge_delete_edge", 1602 "properties": { 1603 "enterpriseId": { 1604 "type": "integer" 1605 }, 1606 "id": { 1607 "type": "integer" 1608 }, 1609 "ids": { 1610 "type": "array", 1611 "items": { 1612 "type": "integer" 1613 } 1614 } 1615 } 1616 } 1617 } 1618 ], 1619 "responses": { 1620 "200": { 1621 "description": "Request was successfully processed", 1622 "schema": { 1623 "type": "array", 1624 "items": { 1625 "$ref": "#/definitions/edge_delete_edge_result_item" 1626 } 1627 } 1628 }, 1629 "400": { 1630 "$ref": "#/responses/generic_400" 1631 }, 1632 "500": { 1633 "$ref": "#/responses/generic_500" 1634 } 1635 } 1636 } 1637 }, 1638 "/edge/deleteEdgeBgpNeighborRecords": { 1639 "post": { 1640 "summary": "Delete Edge BGP neighbor records", 1641 "description": "Deletes BGP record(s) matching the specified record keys (`neighborIp`) on the Edges with the specified `edgeId`s, if they exist.\n\nPrivileges required:\n\n`DELETE` `NETWORK_SERVICE`", 1642 "tags": [ 1643 "all", 1644 "edge" 1645 ], 1646 "x-privileges": { 1647 "excludeAuthTypes": [], 1648 "allowAuthTypes": [ 1649 "ANY" 1650 ], 1651 "allowPrincipleTypes": [], 1652 "excludePrincipleTypes": [ 1653 "EDGE", 1654 "GATEWAY" 1655 ], 1656 "requirePrivileges": [ 1657 { 1658 "action": "DELETE", 1659 "object": "NETWORK_SERVICE" 1660 } 1661 ] 1662 }, 1663 "operationId": "edge_delete_edge_bgp_neighbor_records", 1664 "parameters": [ 1665 { 1666 "name": "body", 1667 "in": "body", 1668 "required": true, 1669 "schema": { 1670 "type": "object", 1671 "title": "edge_delete_edge_bgp_neighbor_records", 1672 "properties": { 1673 "records": { 1674 "type": "array", 1675 "items": { 1676 "type": "object", 1677 "properties": { 1678 "edgeId": { 1679 "type": "integer" 1680 }, 1681 "neighborIp": { 1682 "type": "string" 1683 } 1684 } 1685 } 1686 } 1687 } 1688 } 1689 } 1690 ], 1691 "responses": { 1692 "200": { 1693 "description": "Request was successfully processed", 1694 "schema": { 1695 "$ref": "#/definitions/edge_delete_edge_bgp_neighbor_records_result" 1696 } 1697 }, 1698 "400": { 1699 "$ref": "#/responses/generic_400" 1700 }, 1701 "500": { 1702 "$ref": "#/responses/generic_500" 1703 } 1704 } 1705 } 1706 }, 1707 "/edge/edgeCancelReactivation": { 1708 "post": { 1709 "summary": "Cancel pending Edge reactivation request", 1710 "tags": [ 1711 "edge", 1712 "all" 1713 ], 1714 "description": "Cancels a pending Edge reactivation request for the specified Edge (by `edgeId`).\n\nPrivileges required:\n\n`CREATE` `EDGE`", 1715 "operationId": "edge_edge_cancel_reactivation", 1716 "x-privileges": { 1717 "excludeAuthTypes": [], 1718 "allowAuthTypes": [ 1719 "ANY" 1720 ], 1721 "allowPrincipleTypes": [], 1722 "excludePrincipleTypes": [ 1723 "EDGE", 1724 "GATEWAY" 1725 ], 1726 "requirePrivileges": [ 1727 { 1728 "action": "CREATE", 1729 "object": "EDGE" 1730 } 1731 ] 1732 }, 1733 "parameters": [ 1734 { 1735 "name": "body", 1736 "in": "body", 1737 "required": true, 1738 "schema": { 1739 "type": "object", 1740 "title": "edge_edge_cancel_reactivation", 1741 "properties": { 1742 "enterpriseId": { 1743 "type": "integer" 1744 }, 1745 "edgeId": { 1746 "type": "integer" 1747 } 1748 }, 1749 "required": [ 1750 "enterpriseId", 1751 "edgeId" 1752 ] 1753 } 1754 } 1755 ], 1756 "responses": { 1757 "200": { 1758 "description": "Request was successfully processed", 1759 "schema": { 1760 "$ref": "#/definitions/edge_edge_cancel_reactivation_result" 1761 } 1762 }, 1763 "400": { 1764 "$ref": "#/responses/generic_400" 1765 }, 1766 "500": { 1767 "$ref": "#/responses/generic_500" 1768 } 1769 } 1770 } 1771 }, 1772 "/edge/edgeProvision": { 1773 "post": { 1774 "summary": "Provision Edge", 1775 "description": "Provisions an Edge before activation.\n\nPrivileges required:\n\n`CREATE` `EDGE`", 1776 "operationId": "edge_edge_provision", 1777 "x-privileges": { 1778 "excludeAuthTypes": [], 1779 "allowAuthTypes": [ 1780 "ANY" 1781 ], 1782 "allowPrincipleTypes": [], 1783 "excludePrincipleTypes": [ 1784 "EDGE", 1785 "GATEWAY" 1786 ], 1787 "requirePrivileges": [ 1788 { 1789 "action": "CREATE", 1790 "object": "EDGE" 1791 } 1792 ] 1793 }, 1794 "tags": [ 1795 "edge", 1796 "all" 1797 ], 1798 "parameters": [ 1799 { 1800 "name": "body", 1801 "in": "body", 1802 "required": true, 1803 "schema": { 1804 "type": "object", 1805 "title": "edge_edge_provision", 1806 "properties": { 1807 "enterpriseId": { 1808 "type": "integer" 1809 }, 1810 "configurationId": { 1811 "type": "integer" 1812 }, 1813 "name": { 1814 "type": "string" 1815 }, 1816 "serialNumber": { 1817 "type": "string" 1818 }, 1819 "modelNumber": { 1820 "type": "string", 1821 "enum": [ 1822 "edge500", 1823 "edge5X0", 1824 "edge510", 1825 "edge6X0", 1826 "edge840", 1827 "edge1000", 1828 "edge1000qat", 1829 "edge3X00", 1830 "virtual" 1831 ] 1832 }, 1833 "description": { 1834 "type": "string" 1835 }, 1836 "site": { 1837 "$ref": "#/definitions/site" 1838 }, 1839 "haEnabled": { 1840 "type": "boolean" 1841 }, 1842 "generateCertificate": { 1843 "type": "boolean" 1844 }, 1845 "subjectCN": { 1846 "type": "string" 1847 }, 1848 "subjectO": { 1849 "type": "string" 1850 }, 1851 "subjectOU": { 1852 "type": "string" 1853 }, 1854 "challengePassword": { 1855 "type": "string" 1856 }, 1857 "privateKeyPassword": { 1858 "type": "string" 1859 } 1860 }, 1861 "required": [ 1862 "configurationId", 1863 "modelNumber" 1864 ] 1865 } 1866 } 1867 ], 1868 "responses": { 1869 "200": { 1870 "description": "Request was successfully processed", 1871 "schema": { 1872 "$ref": "#/definitions/edge_edge_provision_result" 1873 } 1874 }, 1875 "400": { 1876 "$ref": "#/responses/generic_400" 1877 }, 1878 "500": { 1879 "$ref": "#/responses/generic_500" 1880 } 1881 } 1882 } 1883 }, 1884 "/edge/edgeRequestReactivation": { 1885 "post": { 1886 "summary": "Prepare Edge for reactivation", 1887 "description": "Updates the activation state of the specified Edge to `REACTIVATION_PENDING`.\n\nPrivileges required:\n\n`CREATE` `EDGE`", 1888 "tags": [ 1889 "edge", 1890 "all" 1891 ], 1892 "operationId": "edge_edge_request_reactivation", 1893 "x-privileges": { 1894 "forceEnterpriseContext": true, 1895 "excludeAuthTypes": [], 1896 "allowAuthTypes": [ 1897 "ANY" 1898 ], 1899 "allowPrincipleTypes": [], 1900 "excludePrincipleTypes": [ 1901 "EDGE", 1902 "GATEWAY" 1903 ], 1904 "requirePrivileges": [ 1905 { 1906 "action": "CREATE", 1907 "object": "EDGE" 1908 } 1909 ] 1910 }, 1911 "parameters": [ 1912 { 1913 "name": "body", 1914 "in": "body", 1915 "required": true, 1916 "schema": { 1917 "type": "object", 1918 "title": "edge_edge_request_reactivation", 1919 "properties": { 1920 "enterpriseId": { 1921 "type": "integer" 1922 }, 1923 "edgeId": { 1924 "type": "integer" 1925 } 1926 }, 1927 "required": [ 1928 "enterpriseId", 1929 "edgeId" 1930 ] 1931 } 1932 } 1933 ], 1934 "responses": { 1935 "200": { 1936 "description": "Request was successfully processed", 1937 "schema": { 1938 "$ref": "#/definitions/edge_edge_request_reactivation_result" 1939 } 1940 }, 1941 "400": { 1942 "$ref": "#/responses/generic_400" 1943 }, 1944 "500": { 1945 "$ref": "#/responses/generic_500" 1946 } 1947 } 1948 } 1949 }, 1950 "/edge/getClientVisibilityMode": { 1951 "post": { 1952 "summary": "Get an edge's client visibility mode", 1953 "description": "Retrieve an edge's client visibility mode.\n\nPrivileges required:\n\n`READ` `EDGE`\n\n`VIEW_FLOW_STATS` `undefined`", 1954 "operationId": "edge_get_client_visibility_mode", 1955 "x-privileges": { 1956 "excludeAuthTypes": [], 1957 "allowAuthTypes": [ 1958 "ANY" 1959 ], 1960 "allowPrincipleTypes": [], 1961 "excludePrincipleTypes": [ 1962 "EDGE", 1963 "GATEWAY" 1964 ], 1965 "forceEnterpriseContext": true, 1966 "requirePrivileges": [ 1967 { 1968 "action": "READ", 1969 "object": "EDGE" 1970 }, 1971 { 1972 "action": "VIEW_FLOW_STATS" 1973 } 1974 ] 1975 }, 1976 "tags": [ 1977 "edge", 1978 "all" 1979 ], 1980 "parameters": [ 1981 { 1982 "name": "body", 1983 "in": "body", 1984 "required": true, 1985 "schema": { 1986 "type": "object", 1987 "title": "edge_get_client_visibility_mode", 1988 "properties": { 1989 "edgeId": { 1990 "type": "integer" 1991 }, 1992 "enterpriseId": { 1993 "type": "integer" 1994 } 1995 }, 1996 "required": [ 1997 "edgeId" 1998 ] 1999 } 2000 } 2001 ], 2002 "responses": { 2003 "200": { 2004 "schema": { 2005 "title": "edge_get_client_visibility_mode_result", 2006 "type": "object", 2007 "properties": { 2008 "edgeClientVisibilityMode": { 2009 "type": "string", 2010 "enum": [ 2011 "MAC", 2012 "IP" 2013 ] 2014 } 2015 } 2016 }, 2017 "description": "Request was successfully processed" 2018 }, 2019 "400": { 2020 "$ref": "#/responses/generic_400" 2021 }, 2022 "500": { 2023 "$ref": "#/responses/generic_500" 2024 } 2025 } 2026 } 2027 }, 2028 "/edge/getEdge": { 2029 "post": { 2030 "summary": "Get Edge", 2031 "tags": [ 2032 "edge", 2033 "all" 2034 ], 2035 "description": "Gets the specified Edge with optional link, site, configuration, certificate, orenterprise details. Supports queries by Edge `id`, `deviceId`, `activationKey`, and `logicalId`.\n\nPrivileges required:\n\n`READ` `EDGE`", 2036 "operationId": "edge_get_edge", 2037 "x-privileges": { 2038 "excludeAuthTypes": [], 2039 "allowAuthTypes": [ 2040 "ANY" 2041 ], 2042 "allowPrincipleTypes": [], 2043 "excludePrincipleTypes": [ 2044 "EDGE", 2045 "GATEWAY" 2046 ], 2047 "requirePrivileges": [ 2048 { 2049 "action": "READ", 2050 "object": "EDGE" 2051 } 2052 ] 2053 }, 2054 "parameters": [ 2055 { 2056 "name": "body", 2057 "in": "body", 2058 "required": true, 2059 "schema": { 2060 "type": "object", 2061 "title": "edge_get_edge", 2062 "properties": { 2063 "id": { 2064 "type": "integer" 2065 }, 2066 "enterpriseId": { 2067 "type": "integer" 2068 }, 2069 "logicalId": { 2070 "type": "string" 2071 }, 2072 "activationKey": { 2073 "type": "string" 2074 }, 2075 "name": { 2076 "type": "string" 2077 }, 2078 "with": { 2079 "type": "array", 2080 "items": { 2081 "type": "string", 2082 "enum": [ 2083 "recentLinks", 2084 "links", 2085 "serviceGroups", 2086 "site", 2087 "enterprise", 2088 "configuration", 2089 "configurationWithModules" 2090 ] 2091 } 2092 } 2093 } 2094 } 2095 } 2096 ], 2097 "responses": { 2098 "200": { 2099 "description": "Request was successfully processed", 2100 "schema": { 2101 "$ref": "#/definitions/edge_get_edge_result" 2102 } 2103 }, 2104 "400": { 2105 "$ref": "#/responses/generic_400" 2106 }, 2107 "500": { 2108 "$ref": "#/responses/generic_500" 2109 } 2110 } 2111 } 2112 }, 2113 "/edge/getEdgeConfigurationModules": { 2114 "post": { 2115 "summary": "Get edge configuration modules", 2116 "description": "Gets edge composite configuration modules for the specified Edge (by `edgeId`).\n\nPrivileges required:\n\n`READ` `EDGE`\n\n`READ` `ENTERPRISE_PROFILE`", 2117 "operationId": "edge_get_edge_configuration_modules", 2118 "x-privileges": { 2119 "excludeAuthTypes": [], 2120 "allowAuthTypes": [ 2121 "ANY" 2122 ], 2123 "allowPrincipleTypes": [], 2124 "excludePrincipleTypes": [ 2125 "EDGE", 2126 "GATEWAY" 2127 ], 2128 "requirePrivileges": [ 2129 { 2130 "action": "READ", 2131 "object": "EDGE" 2132 }, 2133 { 2134 "action": "READ", 2135 "object": "ENTERPRISE_PROFILE" 2136 } 2137 ] 2138 }, 2139 "tags": [ 2140 "edge", 2141 "all" 2142 ], 2143 "parameters": [ 2144 { 2145 "name": "body", 2146 "in": "body", 2147 "required": true, 2148 "schema": { 2149 "type": "object", 2150 "title": "edge_get_edge_configuration_modules", 2151 "properties": { 2152 "edgeId": { 2153 "type": "integer" 2154 }, 2155 "enterpriseId": { 2156 "type": "integer" 2157 }, 2158 "modules": { 2159 "type": "array", 2160 "items": { 2161 "type": "string", 2162 "enum": [ 2163 "imageUpdate", 2164 "controlPlane", 2165 "managementPlane", 2166 "firewall", 2167 "QOS", 2168 "deviceSettings", 2169 "WAN", 2170 "metaData", 2171 "properties" 2172 ] 2173 } 2174 } 2175 }, 2176 "required": [ 2177 "edgeId" 2178 ] 2179 } 2180 } 2181 ], 2182 "responses": { 2183 "200": { 2184 "schema": { 2185 "title": "edge_get_edge_configuration_modules_result", 2186 "type": "object", 2187 "properties": { 2188 "deviceSettings": { 2189 "type": "object", 2190 "properties": { 2191 "version": { 2192 "type": "string" 2193 }, 2194 "schemaVersion": { 2195 "type": "string" 2196 }, 2197 "type": { 2198 "type": "string", 2199 "enum": [ 2200 "ENTERPRISE", 2201 "OPERATOR", 2202 "GATEWAY" 2203 ] 2204 }, 2205 "data": { 2206 "$ref": "#/definitions/edgeDeviceSettingsData" 2207 } 2208 }, 2209 "required": [ 2210 "version", 2211 "schemaVersion", 2212 "type", 2213 "data" 2214 ] 2215 }, 2216 "firewall": { 2217 "type": "object", 2218 "properties": { 2219 "version": { 2220 "type": "string" 2221 }, 2222 "schemaVersion": { 2223 "type": "string" 2224 }, 2225 "type": { 2226 "type": "string", 2227 "enum": [ 2228 "ENTERPRISE", 2229 "OPERATOR", 2230 "GATEWAY" 2231 ] 2232 }, 2233 "data": { 2234 "$ref": "#/definitions/firewall_data" 2235 } 2236 }, 2237 "required": [ 2238 "version", 2239 "schemaVersion", 2240 "type", 2241 "data" 2242 ] 2243 }, 2244 "QOS": { 2245 "type": "object", 2246 "properties": { 2247 "version": { 2248 "type": "string" 2249 }, 2250 "schemaVersion": { 2251 "type": "string" 2252 }, 2253 "type": { 2254 "type": "string", 2255 "enum": [ 2256 "ENTERPRISE", 2257 "OPERATOR", 2258 "GATEWAY" 2259 ] 2260 }, 2261 "data": { 2262 "$ref": "#/definitions/QOSData" 2263 } 2264 }, 2265 "required": [ 2266 "version", 2267 "schemaVersion", 2268 "type", 2269 "data" 2270 ] 2271 }, 2272 "WAN": { 2273 "type": "object", 2274 "properties": { 2275 "version": { 2276 "type": "string" 2277 }, 2278 "schemaVersion": { 2279 "type": "string" 2280 }, 2281 "type": { 2282 "type": "string", 2283 "enum": [ 2284 "ENTERPRISE", 2285 "OPERATOR", 2286 "GATEWAY" 2287 ] 2288 }, 2289 "data": { 2290 "$ref": "#/definitions/WAN_data" 2291 } 2292 }, 2293 "required": [ 2294 "version", 2295 "schemaVersion", 2296 "type", 2297 "data" 2298 ] 2299 }, 2300 "controlPlane": { 2301 "type": "object", 2302 "properties": { 2303 "version": { 2304 "type": "string" 2305 }, 2306 "schemaVersion": { 2307 "type": "string" 2308 }, 2309 "type": { 2310 "type": "string", 2311 "enum": [ 2312 "ENTERPRISE", 2313 "OPERATOR", 2314 "GATEWAY" 2315 ] 2316 }, 2317 "data": { 2318 "$ref": "#/definitions/control_plane_data" 2319 } 2320 }, 2321 "required": [ 2322 "version", 2323 "schemaVersion", 2324 "type", 2325 "data" 2326 ] 2327 }, 2328 "managementPlane": { 2329 "type": "object", 2330 "properties": { 2331 "version": { 2332 "type": "string" 2333 }, 2334 "schemaVersion": { 2335 "type": "string" 2336 }, 2337 "type": { 2338 "type": "string", 2339 "enum": [ 2340 "ENTERPRISE", 2341 "OPERATOR", 2342 "GATEWAY" 2343 ] 2344 }, 2345 "data": { 2346 "$ref": "#/definitions/management_plane_data" 2347 } 2348 }, 2349 "required": [ 2350 "version", 2351 "schemaVersion", 2352 "type", 2353 "data" 2354 ] 2355 }, 2356 "imageUpdate": { 2357 "type": "object", 2358 "properties": { 2359 "version": { 2360 "type": "string" 2361 }, 2362 "schemaVersion": { 2363 "type": "string" 2364 }, 2365 "type": { 2366 "type": "string", 2367 "enum": [ 2368 "ENTERPRISE", 2369 "OPERATOR", 2370 "GATEWAY" 2371 ] 2372 }, 2373 "data": { 2374 "$ref": "#/definitions/image_update_data" 2375 } 2376 }, 2377 "required": [ 2378 "version", 2379 "schemaVersion", 2380 "type", 2381 "data" 2382 ] 2383 } 2384 } 2385 }, 2386 "description": "Request was successfully processed" 2387 }, 2388 "400": { 2389 "$ref": "#/responses/generic_400" 2390 }, 2391 "500": { 2392 "$ref": "#/responses/generic_500" 2393 } 2394 } 2395 } 2396 }, 2397 "/edge/getEdgeConfigurationStack": { 2398 "post": { 2399 "summary": "Get Edge configuration stack", 2400 "description": "Gets the complete configuration profile (including all modules) of the specified Edge (by `edgeId`).\n\nPrivileges required:\n\n`READ` `EDGE`\n\n`READ` `ENTERPRISE_PROFILE`", 2401 "operationId": "edge_get_edge_configuration_stack", 2402 "x-privileges": { 2403 "excludeAuthTypes": [], 2404 "allowAuthTypes": [ 2405 "ANY" 2406 ], 2407 "allowPrincipleTypes": [], 2408 "excludePrincipleTypes": [ 2409 "EDGE", 2410 "GATEWAY" 2411 ], 2412 "requirePrivileges": [ 2413 { 2414 "action": "READ", 2415 "object": "EDGE" 2416 }, 2417 { 2418 "action": "READ", 2419 "object": "ENTERPRISE_PROFILE" 2420 } 2421 ] 2422 }, 2423 "tags": [ 2424 "edge", 2425 "all" 2426 ], 2427 "parameters": [ 2428 { 2429 "name": "body", 2430 "in": "body", 2431 "required": true, 2432 "schema": { 2433 "type": "object", 2434 "title": "edge_get_edge_configuration_stack", 2435 "properties": { 2436 "edgeId": { 2437 "type": "integer" 2438 }, 2439 "enterpriseId": { 2440 "type": "integer" 2441 } 2442 }, 2443 "required": [ 2444 "edgeId" 2445 ] 2446 } 2447 } 2448 ], 2449 "responses": { 2450 "200": { 2451 "schema": { 2452 "title": "edge_get_edge_configuration_stack_result", 2453 "type": "array", 2454 "items": { 2455 "$ref": "#/definitions/edge_get_edge_configuration_stack_result_item" 2456 } 2457 }, 2458 "description": "Request was successfully processed" 2459 }, 2460 "400": { 2461 "$ref": "#/responses/generic_400" 2462 }, 2463 "500": { 2464 "$ref": "#/responses/generic_500" 2465 } 2466 } 2467 } 2468 }, 2469 "/edge/setEdgeEnterpriseConfiguration": { 2470 "post": { 2471 "summary": "Apply configuration profile to Edge", 2472 "tags": [ 2473 "all", 2474 "edge" 2475 ], 2476 "description": "Sets the enterprise configuration for the specified Edge (by `edgeId`).\n\nPrivileges required:\n\n`UPDATE` `EDGE`\n\n`UPDATE` `ENTERPRISE_PROFILE`", 2477 "operationId": "edge_set_edge_enterprise_configuration", 2478 "x-privileges": { 2479 "excludeAuthTypes": [], 2480 "allowAuthTypes": [ 2481 "ANY" 2482 ], 2483 "allowPrincipleTypes": [], 2484 "excludePrincipleTypes": [ 2485 "EDGE", 2486 "GATEWAY" 2487 ], 2488 "requirePrivileges": [ 2489 { 2490 "action": "UPDATE", 2491 "object": "EDGE" 2492 }, 2493 { 2494 "action": "UPDATE", 2495 "object": "ENTERPRISE_PROFILE" 2496 } 2497 ] 2498 }, 2499 "parameters": [ 2500 { 2501 "name": "body", 2502 "in": "body", 2503 "required": true, 2504 "schema": { 2505 "type": "object", 2506 "title": "edge_set_edge_enterprise_configuration", 2507 "properties": { 2508 "id": { 2509 "type": "integer", 2510 "description": "alias for edgeId" 2511 }, 2512 "edgeId": { 2513 "type": "integer" 2514 }, 2515 "enterpriseId": { 2516 "type": "integer" 2517 }, 2518 "configurationId": { 2519 "type": "integer" 2520 }, 2521 "skipEdgeRoutingUpdates": { 2522 "type": "boolean" 2523 } 2524 }, 2525 "required": [ 2526 "configurationId" 2527 ] 2528 } 2529 } 2530 ], 2531 "responses": { 2532 "200": { 2533 "description": "Request was successfully processed", 2534 "schema": { 2535 "$ref": "#/definitions/edge_set_edge_enterprise_configuration_result" 2536 } 2537 }, 2538 "400": { 2539 "$ref": "#/responses/generic_400" 2540 }, 2541 "500": { 2542 "$ref": "#/responses/generic_500" 2543 } 2544 } 2545 } 2546 }, 2547 "/edge/setEdgeHandOffGateways": { 2548 "post": { 2549 "summary": "Set Edge on premise hand-off gateway(s)", 2550 "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.\n\nPrivileges required:\n\n`UPDATE` `EDGE`", 2551 "tags": [ 2552 "all", 2553 "edge" 2554 ], 2555 "x-privileges": { 2556 "excludeAuthTypes": [], 2557 "allowAuthTypes": [ 2558 "OPERATOR_USER", 2559 "MSP_USER" 2560 ], 2561 "allowPrincipleTypes": [], 2562 "excludePrincipleTypes": [ 2563 "EDGE", 2564 "GATEWAY" 2565 ], 2566 "requirePrivileges": [ 2567 { 2568 "action": "UPDATE", 2569 "object": "EDGE" 2570 } 2571 ] 2572 }, 2573 "operationId": "edge_set_edge_hand_off_gateways", 2574 "parameters": [ 2575 { 2576 "name": "body", 2577 "in": "body", 2578 "required": true, 2579 "schema": { 2580 "type": "object", 2581 "title": "edge_set_edge_hand_off_gateways", 2582 "properties": { 2583 "edgeId": { 2584 "type": "integer" 2585 }, 2586 "enterpriseId": { 2587 "type": "integer" 2588 }, 2589 "gateways": { 2590 "type": "object", 2591 "properties": { 2592 "primary": { 2593 "type": "integer" 2594 }, 2595 "primaryIpsecDetail": { 2596 "$ref": "#/definitions/gateway_handoff_ipsec_gateway_detail" 2597 }, 2598 "secondary": { 2599 "type": "integer" 2600 }, 2601 "secondaryIpsecDetail": { 2602 "$ref": "#/definitions/gateway_handoff_ipsec_gateway_detail" 2603 } 2604 }, 2605 "required": [ 2606 "primary" 2607 ] 2608 } 2609 } 2610 } 2611 } 2612 ], 2613 "responses": { 2614 "200": { 2615 "schema": { 2616 "$ref": "#/definitions/edge_set_edge_hand_off_gateways_result" 2617 }, 2618 "description": "Request was successfully processed" 2619 }, 2620 "400": { 2621 "$ref": "#/responses/generic_400" 2622 }, 2623 "500": { 2624 "$ref": "#/responses/generic_500" 2625 } 2626 } 2627 } 2628 }, 2629 "/edge/setEdgeOperatorConfiguration": { 2630 "post": { 2631 "summary": "Apply operator profile to Edge", 2632 "tags": [ 2633 "all", 2634 "edge" 2635 ], 2636 "description": "Sets the operator configuration for the specified Edge (by `edgeId`). This overrides any enterprise-assigned operator configuration and the network default operator configuration.\n\nPrivileges required:\n\n`UPDATE` `EDGE`\n\n`READ` `OPERATOR_PROFILE`", 2637 "operationId": "edge_set_edge_operator_configuration", 2638 "x-privileges": { 2639 "excludeAuthTypes": [], 2640 "allowAuthTypes": [ 2641 "OPERATOR_USER", 2642 "MSP_USER" 2643 ], 2644 "allowPrincipleTypes": [], 2645 "excludePrincipleTypes": [ 2646 "EDGE", 2647 "GATEWAY" 2648 ], 2649 "requirePrivileges": [ 2650 { 2651 "action": "UPDATE", 2652 "object": "EDGE" 2653 }, 2654 { 2655 "action": "READ", 2656 "object": "OPERATOR_PROFILE" 2657 } 2658 ] 2659 }, 2660 "parameters": [ 2661 { 2662 "name": "body", 2663 "in": "body", 2664 "required": true, 2665 "schema": { 2666 "type": "object", 2667 "title": "edge_set_edge_operator_configuration", 2668 "properties": { 2669 "edgeId": { 2670 "type": "integer" 2671 }, 2672 "enterpriseId": { 2673 "type": "integer" 2674 }, 2675 "configurationId": { 2676 "type": "integer" 2677 } 2678 }, 2679 "required": [ 2680 "edgeId", 2681 "configurationId" 2682 ] 2683 } 2684 } 2685 ], 2686 "responses": { 2687 "200": { 2688 "description": "Request was successfully processed", 2689 "schema": { 2690 "$ref": "#/definitions/edge_set_edge_operator_configuration_result" 2691 } 2692 }, 2693 "400": { 2694 "$ref": "#/responses/generic_400" 2695 }, 2696 "500": { 2697 "$ref": "#/responses/generic_500" 2698 } 2699 } 2700 } 2701 }, 2702 "/edge/updateEdgeAdminPassword": { 2703 "post": { 2704 "summary": "Update Edge local UI authentication credentials", 2705 "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.\n\nPrivileges required:\n\n`UPDATE` `EDGE`\n\n`UPDATE` `ENTERPRISE_KEYS`", 2706 "tags": [ 2707 "edge", 2708 "all" 2709 ], 2710 "operationId": "edge_update_edge_admin_password", 2711 "x-privileges": { 2712 "excludeAuthTypes": [], 2713 "allowAuthTypes": [ 2714 "ANY" 2715 ], 2716 "allowPrincipleTypes": [], 2717 "excludePrincipleTypes": [ 2718 "EDGE", 2719 "GATEWAY" 2720 ], 2721 "requirePrivileges": [ 2722 { 2723 "action": "UPDATE", 2724 "object": "EDGE" 2725 }, 2726 { 2727 "action": "UPDATE", 2728 "object": "ENTERPRISE_KEYS" 2729 } 2730 ] 2731 }, 2732 "parameters": [ 2733 { 2734 "name": "body", 2735 "in": "body", 2736 "required": true, 2737 "schema": { 2738 "type": "object", 2739 "title": "edge_update_edge_admin_password", 2740 "properties": { 2741 "id": { 2742 "type": "integer" 2743 }, 2744 "username": { 2745 "type": "string" 2746 }, 2747 "password": { 2748 "type": "string" 2749 } 2750 }, 2751 "required": [ 2752 "id", 2753 "password" 2754 ] 2755 } 2756 } 2757 ], 2758 "responses": { 2759 "200": { 2760 "schema": { 2761 "$ref": "#/definitions/edge_update_edge_admin_password_result" 2762 }, 2763 "description": "Request was successfully processed" 2764 }, 2765 "400": { 2766 "$ref": "#/responses/generic_400" 2767 }, 2768 "500": { 2769 "$ref": "#/responses/generic_500" 2770 } 2771 } 2772 } 2773 }, 2774 "/edge/updateEdgeAttributes": { 2775 "post": { 2776 "summary": "Update Edge attributes", 2777 "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).\n\nPrivileges required:\n\n`UPDATE` `EDGE`", 2778 "tags": [ 2779 "edge", 2780 "all" 2781 ], 2782 "operationId": "edge_update_edge_attributes", 2783 "x-privileges": { 2784 "forceEnterpriseContext": true, 2785 "excludeAuthTypes": [], 2786 "allowAuthTypes": [ 2787 "ANY" 2788 ], 2789 "allowPrincipleTypes": [], 2790 "excludePrincipleTypes": [ 2791 "EDGE", 2792 "GATEWAY" 2793 ], 2794 "requirePrivileges": [ 2795 { 2796 "action": "UPDATE", 2797 "object": "EDGE" 2798 } 2799 ] 2800 }, 2801 "parameters": [ 2802 { 2803 "name": "body", 2804 "in": "body", 2805 "required": true, 2806 "schema": { 2807 "type": "object", 2808 "title": "edge_update_edge_attributes", 2809 "properties": { 2810 "id": { 2811 "type": "integer" 2812 }, 2813 "enterpriseId": { 2814 "type": "integer" 2815 }, 2816 "_update": { 2817 "type": "object", 2818 "properties": { 2819 "site": { 2820 "$ref": "#/definitions/site" 2821 }, 2822 "name": { 2823 "type": "string" 2824 }, 2825 "description": { 2826 "type": "string" 2827 }, 2828 "serialNumber": { 2829 "type": "string" 2830 } 2831 } 2832 } 2833 }, 2834 "required": [ 2835 "_update" 2836 ] 2837 } 2838 } 2839 ], 2840 "responses": { 2841 "200": { 2842 "schema": { 2843 "$ref": "#/definitions/edge_update_edge_attributes_result" 2844 }, 2845 "description": "Request was successfully processed" 2846 }, 2847 "400": { 2848 "$ref": "#/responses/generic_400" 2849 }, 2850 "500": { 2851 "$ref": "#/responses/generic_500" 2852 } 2853 } 2854 } 2855 }, 2856 "/edge/updateEdgeCredentialsByConfiguration": { 2857 "post": { 2858 "summary": "Update Edge local UI credentials by configuration profile", 2859 "tags": [ 2860 "edge", 2861 "all" 2862 ], 2863 "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.\n\nPrivileges required:\n\n`UPDATE` `EDGE`\n\n`UPDATE` `ENTERPRISE_KEYS`", 2864 "operationId": "edge_update_edge_credentials_by_configuration", 2865 "x-privileges": { 2866 "excludeAuthTypes": [], 2867 "allowAuthTypes": [ 2868 "ANY" 2869 ], 2870 "allowPrincipleTypes": [], 2871 "excludePrincipleTypes": [ 2872 "EDGE", 2873 "GATEWAY" 2874 ], 2875 "requirePrivileges": [ 2876 { 2877 "action": "UPDATE", 2878 "object": "EDGE" 2879 }, 2880 { 2881 "action": "UPDATE", 2882 "object": "ENTERPRISE_KEYS" 2883 } 2884 ] 2885 }, 2886 "parameters": [ 2887 { 2888 "name": "body", 2889 "in": "body", 2890 "required": true, 2891 "schema": { 2892 "type": "object", 2893 "title": "edge_update_edge_credentials_by_configuration", 2894 "properties": { 2895 "configurationId": { 2896 "type": "integer" 2897 }, 2898 "credentials": { 2899 "type": "object", 2900 "properties": { 2901 "username": { 2902 "type": "string" 2903 }, 2904 "password": { 2905 "type": "string" 2906 } 2907 } 2908 } 2909 }, 2910 "required": [ 2911 "id", 2912 "credentials" 2913 ] 2914 } 2915 } 2916 ], 2917 "responses": { 2918 "200": { 2919 "schema": { 2920 "$ref": "#/definitions/edge_update_edge_credentials_by_configuration_result" 2921 }, 2922 "description": "Request was successfully processed" 2923 }, 2924 "400": { 2925 "$ref": "#/responses/generic_400" 2926 }, 2927 "500": { 2928 "$ref": "#/responses/generic_500" 2929 } 2930 } 2931 } 2932 }, 2933 "/enterprise/decodeEnterpriseKey": { 2934 "post": { 2935 "summary": "Decrypt an enterprise key", 2936 "tags": [ 2937 "enterprise", 2938 "all" 2939 ], 2940 "description": "Decrypt an enterprise key\n\nPrivileges required:\n\n`READ` `ENTERPRISE_KEYS`", 2941 "operationId": "enterprise_decode_enterprise_key", 2942 "x-privileges": { 2943 "excludeAuthTypes": [], 2944 "allowAuthTypes": [ 2945 "ANY" 2946 ], 2947 "allowPrincipleTypes": [], 2948 "excludePrincipleTypes": [ 2949 "EDGE", 2950 "GATEWAY" 2951 ], 2952 "requirePrivileges": [ 2953 { 2954 "action": "READ", 2955 "object": "ENTERPRISE_KEYS" 2956 } 2957 ] 2958 }, 2959 "parameters": [ 2960 { 2961 "name": "body", 2962 "in": "body", 2963 "required": true, 2964 "schema": { 2965 "type": "object", 2966 "title": "enterprise_decode_enterprise_key", 2967 "properties": { 2968 "key": { 2969 "type": "string" 2970 } 2971 }, 2972 "required": [ 2973 "key" 2974 ] 2975 } 2976 } 2977 ], 2978 "responses": { 2979 "200": { 2980 "description": "Request was successfully processed", 2981 "schema": { 2982 "$ref": "#/definitions/enterprise_decode_enterprise_key_result" 2983 } 2984 }, 2985 "400": { 2986 "$ref": "#/responses/generic_400" 2987 }, 2988 "500": { 2989 "$ref": "#/responses/generic_500" 2990 } 2991 } 2992 } 2993 }, 2994 "/enterprise/deleteEnterprise": { 2995 "post": { 2996 "summary": "Delete enterprise", 2997 "description": "Deletes the specified enterprise (by `id` or `enterpriseId`).\n\nPrivileges required:\n\n`DELETE` `ENTERPRISE`", 2998 "tags": [ 2999 "all", 3000 "enterprise" 3001 ], 3002 "x-privileges": { 3003 "excludeAuthTypes": [], 3004 "allowAuthTypes": [ 3005 "OPERATOR_USER", 3006 "MSP_USER" 3007 ], 3008 "allowPrincipleTypes": [], 3009 "excludePrincipleTypes": [ 3010 "EDGE", 3011 "GATEWAY" 3012 ], 3013 "requirePrivileges": [ 3014 { 3015 "action": "DELETE", 3016 "object": "ENTERPRISE" 3017 } 3018 ] 3019 }, 3020 "operationId": "enterprise_delete_enterprise", 3021 "parameters": [ 3022 { 3023 "name": "body", 3024 "in": "body", 3025 "required": true, 3026 "schema": { 3027 "type": "object", 3028 "title": "enterprise_delete_enterprise", 3029 "properties": { 3030 "enterpriseId": { 3031 "type": "integer" 3032 } 3033 } 3034 } 3035 } 3036 ], 3037 "responses": { 3038 "200": { 3039 "description": "Request was successfully processed", 3040 "schema": { 3041 "$ref": "#/definitions/enterprise_delete_enterprise_result" 3042 } 3043 }, 3044 "400": { 3045 "$ref": "#/responses/generic_400" 3046 }, 3047 "500": { 3048 "$ref": "#/responses/generic_500" 3049 } 3050 } 3051 } 3052 }, 3053 "/enterprise/deleteEnterpriseGatewayRecords": { 3054 "post": { 3055 "summary": "Delete gateway BGP neighbor record(s) for enterprise", 3056 "description": "Deletes the enterprise gateway BGP neighbor record(s) matching the specified gateway id(s) (`gatewayId`) and neighbor IP addresses (`neighborIp`).\n\nPrivileges required:\n\n`DELETE` `NETWORK_SERVICE`", 3057 "tags": [ 3058 "all", 3059 "enterprise" 3060 ], 3061 "x-privileges": { 3062 "excludeAuthTypes": [], 3063 "allowAuthTypes": [ 3064 "OPERATOR_USER", 3065 "MSP_USER" 3066 ], 3067 "allowPrincipleTypes": [], 3068 "excludePrincipleTypes": [ 3069 "EDGE", 3070 "GATEWAY" 3071 ], 3072 "requirePrivileges": [ 3073 { 3074 "action": "DELETE", 3075 "object": "NETWORK_SERVICE" 3076 } 3077 ] 3078 }, 3079 "operationId": "enterprise_delete_enterprise_gateway_records", 3080 "parameters": [ 3081 { 3082 "name": "body", 3083 "in": "body", 3084 "required": true, 3085 "schema": { 3086 "type": "object", 3087 "title": "enterprise_delete_enterprise_gateway_records", 3088 "properties": { 3089 "records": { 3090 "type": "array", 3091 "items": { 3092 "$ref": "#/definitions/enterprise_delete_enterprise_delete_enterprise_gateway_records_record" 3093 } 3094 } 3095 } 3096 } 3097 } 3098 ], 3099 "responses": { 3100 "200": { 3101 "description": "Request was successfully processed", 3102 "schema": { 3103 "$ref": "#/definitions/enterprise_delete_enterprise_gateway_records_result" 3104 } 3105 }, 3106 "400": { 3107 "$ref": "#/responses/generic_400" 3108 }, 3109 "500": { 3110 "$ref": "#/responses/generic_500" 3111 } 3112 } 3113 } 3114 }, 3115 "/enterprise/deleteEnterpriseNetworkAllocation": { 3116 "post": { 3117 "summary": "Delete enterprise network allocation", 3118 "description": "Deletes the specified enterprise network allocation (by `id`).\n\nPrivileges required:\n\n`DELETE` `NETWORK_ALLOCATION`", 3119 "operationId": "enterprise_delete_enterprise_network_allocation", 3120 "x-privileges": { 3121 "forceEnterpriseContext": true, 3122 "excludeAuthTypes": [], 3123 "allowAuthTypes": [ 3124 "ANY" 3125 ], 3126 "allowPrincipleTypes": [], 3127 "excludePrincipleTypes": [ 3128 "EDGE", 3129 "GATEWAY" 3130 ], 3131 "requirePrivileges": [ 3132 { 3133 "action": "DELETE", 3134 "object": "NETWORK_ALLOCATION" 3135 } 3136 ] 3137 }, 3138 "tags": [ 3139 "all", 3140 "enterprise" 3141 ], 3142 "parameters": [ 3143 { 3144 "name": "body", 3145 "in": "body", 3146 "required": true, 3147 "schema": { 3148 "type": "object", 3149 "title": "enterprise_delete_enterprise_network_allocation", 3150 "properties": { 3151 "id": { 3152 "type": "integer" 3153 }, 3154 "enterpriseId": { 3155 "type": "integer" 3156 } 3157 }, 3158 "required": [ 3159 "id" 3160 ] 3161 } 3162 } 3163 ], 3164 "responses": { 3165 "200": { 3166 "description": "Request was successfully processed", 3167 "schema": { 3168 "$ref": "#/definitions/enterprise_delete_enterprise_network_allocation_result" 3169 } 3170 }, 3171 "400": { 3172 "$ref": "#/responses/generic_400" 3173 }, 3174 "500": { 3175 "$ref": "#/responses/generic_500" 3176 } 3177 } 3178 } 3179 }, 3180 "/enterprise/deleteEnterpriseNetworkSegment": { 3181 "post": { 3182 "summary": "Delete an enterprise network segment", 3183 "description": "Delete an enterprise network segment, by id.\n\nPrivileges required:\n\n`DELETE` `NETWORK_ALLOCATION`", 3184 "operationId": "enterprise_delete_enterprise_network_segment", 3185 "x-privileges": { 3186 "forceEnterpriseContext": true, 3187 "excludeAuthTypes": [], 3188 "allowAuthTypes": [ 3189 "ANY" 3190 ], 3191 "allowPrincipleTypes": [], 3192 "excludePrincipleTypes": [ 3193 "EDGE", 3194 "GATEWAY" 3195 ], 3196 "requirePrivileges": [ 3197 { 3198 "action": "DELETE", 3199 "object": "NETWORK_ALLOCATION" 3200 } 3201 ] 3202 }, 3203 "tags": [ 3204 "all", 3205 "enterprise" 3206 ], 3207 "parameters": [ 3208 { 3209 "name": "body", 3210 "in": "body", 3211 "required": true, 3212 "schema": { 3213 "type": "object", 3214 "title": "enterprise_delete_enterprise_network_segment", 3215 "properties": { 3216 "id": { 3217 "type": "integer" 3218 }, 3219 "enterpriseId": { 3220 "type": "integer" 3221 } 3222 }, 3223 "required": [ 3224 "id" 3225 ] 3226 } 3227 } 3228 ], 3229 "responses": { 3230 "200": { 3231 "description": "Request was successfully processed", 3232 "schema": { 3233 "$ref": "#/definitions/deletion_confirmation" 3234 } 3235 }, 3236 "400": { 3237 "$ref": "#/responses/generic_400" 3238 }, 3239 "500": { 3240 "$ref": "#/responses/generic_500" 3241 } 3242 } 3243 } 3244 }, 3245 "/enterprise/deleteEnterpriseService": { 3246 "post": { 3247 "summary": "Delete enterprise network service", 3248 "description": "Deletes the specified enterprise network service (by `id`).\n\nPrivileges required:\n\n`DELETE` `NETWORK_SERVICE`", 3249 "operationId": "enterprise_delete_enterprise_service", 3250 "x-privileges": { 3251 "forceEnterpriseContext": true, 3252 "excludeAuthTypes": [], 3253 "allowAuthTypes": [ 3254 "ANY" 3255 ], 3256 "allowPrincipleTypes": [], 3257 "excludePrincipleTypes": [ 3258 "EDGE", 3259 "GATEWAY" 3260 ], 3261 "requirePrivileges": [ 3262 { 3263 "action": "DELETE", 3264 "object": "NETWORK_SERVICE" 3265 } 3266 ] 3267 }, 3268 "tags": [ 3269 "all", 3270 "enterprise" 3271 ], 3272 "parameters": [ 3273 { 3274 "name": "body", 3275 "in": "body", 3276 "required": true, 3277 "schema": { 3278 "type": "object", 3279 "title": "enterprise_delete_enterprise_service", 3280 "properties": { 3281 "id": { 3282 "type": "integer" 3283 }, 3284 "logicalId": { 3285 "type": "string" 3286 }, 3287 "enterpriseId": { 3288 "type": "integer" 3289 } 3290 } 3291 } 3292 } 3293 ], 3294 "responses": { 3295 "200": { 3296 "description": "Request was successfully processed", 3297 "schema": { 3298 "$ref": "#/definitions/enterprise_delete_enterprise_service_result" 3299 } 3300 }, 3301 "400": { 3302 "$ref": "#/responses/generic_400" 3303 }, 3304 "500": { 3305 "$ref": "#/responses/generic_500" 3306 } 3307 } 3308 } 3309 }, 3310 "/enterprise/encodeEnterpriseKey": { 3311 "post": { 3312 "summary": "Encrypt an enterprise key", 3313 "tags": [ 3314 "enterprise", 3315 "all" 3316 ], 3317 "description": "Encrypt an enterprise key\n\nPrivileges required:\n\n`CREATE` `ENTERPRISE_KEYS`", 3318 "operationId": "enterprise_encode_enterprise_key", 3319 "x-privileges": { 3320 "excludeAuthTypes": [], 3321 "allowAuthTypes": [ 3322 "ANY" 3323 ], 3324 "allowPrincipleTypes": [], 3325 "excludePrincipleTypes": [ 3326 "EDGE", 3327 "GATEWAY" 3328 ], 3329 "requirePrivileges": [ 3330 { 3331 "action": "CREATE", 3332 "object": "ENTERPRISE_KEYS" 3333 } 3334 ] 3335 }, 3336 "parameters": [ 3337 { 3338 "name": "body", 3339 "in": "body", 3340 "required": true, 3341 "schema": { 3342 "type": "object", 3343 "title": "enterprise_encode_enterprise_key", 3344 "properties": { 3345 "key": { 3346 "type": "string" 3347 } 3348 }, 3349 "required": [ 3350 "key" 3351 ] 3352 } 3353 } 3354 ], 3355 "responses": { 3356 "200": { 3357 "description": "Request was successfully processed", 3358 "schema": { 3359 "$ref": "#/definitions/enterprise_encode_enterprise_key_result" 3360 } 3361 }, 3362 "400": { 3363 "$ref": "#/responses/generic_400" 3364 }, 3365 "500": { 3366 "$ref": "#/responses/generic_500" 3367 } 3368 } 3369 } 3370 }, 3371 "/enterprise/getEnterprise": { 3372 "post": { 3373 "summary": "Get enterprise", 3374 "description": "Gets data for the specified enterprise with optional proxy (partner) detail.\n\nPrivileges required:\n\n`READ` `ENTERPRISE`", 3375 "tags": [ 3376 "enterprise", 3377 "all" 3378 ], 3379 "operationId": "enterprise_get_enterprise", 3380 "x-privileges": { 3381 "excludeAuthTypes": [], 3382 "allowAuthTypes": [ 3383 "ANY" 3384 ], 3385 "allowPrincipleTypes": [], 3386 "excludePrincipleTypes": [ 3387 "EDGE", 3388 "GATEWAY" 3389 ], 3390 "requirePrivileges": [ 3391 { 3392 "action": "READ", 3393 "object": "ENTERPRISE" 3394 } 3395 ] 3396 }, 3397 "parameters": [ 3398 { 3399 "name": "body", 3400 "in": "body", 3401 "required": true, 3402 "schema": { 3403 "title": "enterprise_get_enterprise", 3404 "type": "object", 3405 "properties": { 3406 "id": { 3407 "type": "integer" 3408 }, 3409 "enterpriseId": { 3410 "type": "integer" 3411 }, 3412 "with": { 3413 "type": "array", 3414 "items": { 3415 "type": "string", 3416 "enum": [ 3417 "enterpriseProxy" 3418 ] 3419 } 3420 } 3421 } 3422 } 3423 } 3424 ], 3425 "responses": { 3426 "200": { 3427 "description": "Request was successfully processed", 3428 "schema": { 3429 "$ref": "#/definitions/enterprise_get_enterprise_result" 3430 } 3431 }, 3432 "400": { 3433 "$ref": "#/responses/generic_400" 3434 }, 3435 "500": { 3436 "$ref": "#/responses/generic_500" 3437 } 3438 } 3439 } 3440 }, 3441 "/enterprise/getEnterpriseAddresses": { 3442 "post": { 3443 "summary": "Get enterprise IP address(es)", 3444 "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).\n\nPrivileges required:\n\n`READ` `ENTERPRISE`", 3445 "tags": [ 3446 "all", 3447 "enterprise" 3448 ], 3449 "operationId": "enterprise_get_enterprise_addresses", 3450 "x-privileges": { 3451 "excludeAuthTypes": [], 3452 "allowAuthTypes": [ 3453 "ANY" 3454 ], 3455 "allowPrincipleTypes": [], 3456 "excludePrincipleTypes": [ 3457 "EDGE", 3458 "GATEWAY" 3459 ], 3460 "requirePrivileges": [ 3461 { 3462 "action": "READ", 3463 "object": "ENTERPRISE" 3464 } 3465 ] 3466 }, 3467 "parameters": [ 3468 { 3469 "name": "body", 3470 "in": "body", 3471 "required": true, 3472 "schema": { 3473 "type": "object", 3474 "title": "enterprise_get_enterprise_addresses", 3475 "properties": { 3476 "enterpriseId": { 3477 "type": "integer" 3478 } 3479 }, 3480 "required": [ 3481 "enterpriseId" 3482 ] 3483 } 3484 } 3485 ], 3486 "responses": { 3487 "200": { 3488 "description": "Request was successfully processed", 3489 "schema": { 3490 "title": "enterprise_get_enterprise_addresses_result", 3491 "type": "array", 3492 "items": { 3493 "$ref": "#/definitions/enterprise_get_enterprise_addresses_result_item" 3494 } 3495 } 3496 }, 3497 "400": { 3498 "$ref": "#/responses/generic_400" 3499 }, 3500 "500": { 3501 "$ref": "#/responses/generic_500" 3502 } 3503 } 3504 } 3505 }, 3506 "/enterprise/getEnterpriseAlertConfigurations": { 3507 "post": { 3508 "summary": "Get enterprise alert configuration(s)", 3509 "description": "Gets all alert configuration(s) for the specified enterprise.\n\nPrivileges required:\n\n`READ` `ENTERPRISE_ALERT`", 3510 "tags": [ 3511 "all", 3512 "enterprise" 3513 ], 3514 "x-privileges": { 3515 "forceEnterpriseContext": true, 3516 "excludeAuthTypes": [], 3517 "allowAuthTypes": [ 3518 "ANY" 3519 ], 3520 "allowPrincipleTypes": [], 3521 "excludePrincipleTypes": [ 3522 "EDGE", 3523 "GATEWAY" 3524 ], 3525 "requirePrivileges": [ 3526 { 3527 "action": "READ", 3528 "object": "ENTERPRISE_ALERT" 3529 } 3530 ] 3531 }, 3532 "operationId": "enterprise_get_enterprise_alert_configurations", 3533 "parameters": [ 3534 { 3535 "name": "body", 3536 "in": "body", 3537 "required": true, 3538 "schema": { 3539 "type": "object", 3540 "title": "enterprise_get_enterprise_alert_configurations", 3541 "properties": { 3542 "enterpriseId": { 3543 "type": "integer" 3544 } 3545 } 3546 } 3547 } 3548 ], 3549 "responses": { 3550 "200": { 3551 "description": "Request was successfully processed", 3552 "schema": { 3553 "title": "enterprise_get_enterprise_alert_configurations_result", 3554 "type": "array", 3555 "items": { 3556 "$ref": "#/definitions/enterprise_get_enterprise_alert_configurations_result_item" 3557 } 3558 } 3559 }, 3560 "400": { 3561 "$ref": "#/responses/generic_400" 3562 }, 3563 "500": { 3564 "$ref": "#/responses/generic_500" 3565 } 3566 } 3567 } 3568 }, 3569 "/enterprise/getEnterpriseAlerts": { 3570 "post": { 3571 "summary": "Get triggered enterprise alerts", 3572 "description": "Gets past triggered alerts for the specified enterprise.\n\nPrivileges required:\n\n`READ` `ENTERPRISE_ALERT`", 3573 "operationId": "enterprise_get_enterprise_alerts", 3574 "x-privileges": { 3575 "forceEnterpriseContext": true, 3576 "excludeAuthTypes": [], 3577 "allowAuthTypes": [ 3578 "ANY" 3579 ], 3580 "allowPrincipleTypes": [], 3581 "excludePrincipleTypes": [ 3582 "EDGE", 3583 "GATEWAY" 3584 ], 3585 "requirePrivileges": [ 3586 { 3587 "action": "READ", 3588 "object": "ENTERPRISE_ALERT" 3589 } 3590 ] 3591 }, 3592 "tags": [ 3593 "all", 3594 "enterprise" 3595 ], 3596 "parameters": [ 3597 { 3598 "name": "body", 3599 "in": "body", 3600 "required": true, 3601 "schema": { 3602 "type": "object", 3603 "title": "enterprise_get_enterprise_alerts", 3604 "properties": { 3605 "enterpriseId": { 3606 "type": "integer" 3607 }, 3608 "interval": { 3609 "$ref": "#/definitions/interval" 3610 }, 3611 "filter": { 3612 "type": "object", 3613 "properties": { 3614 "limit": { 3615 "type": "integer" 3616 } 3617 } 3618 }, 3619 "with": { 3620 "type": "array", 3621 "items": { 3622 "type": "string", 3623 "enum": [ 3624 "notifications" 3625 ] 3626 } 3627 } 3628 }, 3629 "required": [ 3630 "enterpriseId", 3631 "interval" 3632 ] 3633 } 3634 } 3635 ], 3636 "responses": { 3637 "200": { 3638 "description": "Request was successfully processed", 3639 "schema": { 3640 "title": "enterprise_get_enterprise_alerts_result", 3641 "type": "object", 3642 "properties": { 3643 "metaData": { 3644 "$ref": "#/definitions/list_metadata" 3645 }, 3646 "data": { 3647 "type": "array", 3648 "items": { 3649 "$ref": "#/definitions/enterprise_get_enterprise_alerts_result_item" 3650 } 3651 } 3652 }, 3653 "required": [ 3654 "metaData", 3655 "data" 3656 ] 3657 } 3658 }, 3659 "400": { 3660 "$ref": "#/responses/generic_400" 3661 }, 3662 "500": { 3663 "$ref": "#/responses/generic_500" 3664 } 3665 } 3666 } 3667 }, 3668 "/enterprise/getEnterpriseAllAlertsRecipients": { 3669 "post": { 3670 "summary": "Get recipients receiving all enterprise alerts", 3671 "description": "Gets all recipients configured to receive all alerts for the specified enterprise.\n\nPrivileges required:\n\n`READ` `ENTERPRISE_ALERT`", 3672 "tags": [ 3673 "all", 3674 "enterprise" 3675 ], 3676 "x-privileges": { 3677 "forceEnterpriseContext": true, 3678 "excludeAuthTypes": [], 3679 "allowAuthTypes": [ 3680 "ANY" 3681 ], 3682 "allowPrincipleTypes": [], 3683 "excludePrincipleTypes": [ 3684 "EDGE", 3685 "GATEWAY" 3686 ], 3687 "requirePrivileges": [ 3688 { 3689 "action": "READ", 3690 "object": "ENTERPRISE_ALERT" 3691 } 3692 ] 3693 }, 3694 "operationId": "enterprise_get_enterprise_all_alert_recipients", 3695 "parameters": [ 3696 { 3697 "name": "body", 3698 "in": "body", 3699 "required": true, 3700 "schema": { 3701 "type": "object", 3702 "title": "enterprise_get_enterprise_all_alert_recipients", 3703 "properties": { 3704 "enterpriseId": { 3705 "type": "integer" 3706 } 3707 } 3708 } 3709 } 3710 ], 3711 "responses": { 3712 "200": { 3713 "description": "Request was successfully processed", 3714 "schema": { 3715 "$ref": "#/definitions/enterprise_get_enterprise_all_alert_recipients_result" 3716 } 3717 }, 3718 "400": { 3719 "$ref": "#/responses/generic_400" 3720 }, 3721 "500": { 3722 "$ref": "#/responses/generic_500" 3723 } 3724 } 3725 } 3726 }, 3727 "/enterprise/getEnterpriseCapabilities": { 3728 "post": { 3729 "summary": "Get enterprise capabilities", 3730 "description": "Gets all enterprise capabilities (e.g. BGP, COS mapping, PKI, etc.) currently enabled/disabled for the specified enterprise.\n\nPrivileges required:\n\n`READ` `ENTERPRISE`", 3731 "tags": [ 3732 "enterprise", 3733 "all" 3734 ], 3735 "x-privileges": { 3736 "forceEnterpriseContext": true, 3737 "excludeAuthTypes": [], 3738 "allowAuthTypes": [ 3739 "ANY" 3740 ], 3741 "allowPrincipleTypes": [], 3742 "excludePrincipleTypes": [ 3743 "EDGE", 3744 "GATEWAY" 3745 ], 3746 "requirePrivileges": [ 3747 { 3748 "action": "READ", 3749 "object": "ENTERPRISE" 3750 } 3751 ] 3752 }, 3753 "operationId": "enterprise_get_enterprise_capabilities", 3754 "parameters": [ 3755 { 3756 "name": "body", 3757 "in": "body", 3758 "required": true, 3759 "schema": { 3760 "type": "object", 3761 "title": "enterprise_get_enterprise_capabilities", 3762 "properties": { 3763 "enterpriseId": { 3764 "type": "integer" 3765 } 3766 } 3767 } 3768 } 3769 ], 3770 "responses": { 3771 "200": { 3772 "description": "Request was successfully processed", 3773 "schema": { 3774 "$ref": "#/definitions/enterprise_get_enterprise_capabilities_result" 3775 } 3776 }, 3777 "400": { 3778 "$ref": "#/responses/generic_400" 3779 }, 3780 "500": { 3781 "$ref": "#/responses/generic_500" 3782 } 3783 } 3784 } 3785 }, 3786 "/enterprise/getEnterpriseConfigurations": { 3787 "post": { 3788 "summary": "Get enterprise configuration profiles", 3789 "description": "Gets all configuration profiles, with optional Edge and/or module details, for the specified enterprise.\n\nPrivileges required:\n\n`READ` `ENTERPRISE_PROFILE`", 3790 "tags": [ 3791 "all", 3792 "enterprise" 3793 ], 3794 "operationId": "enterprise_get_enterprise_configurations", 3795 "x-privileges": { 3796 "forceEnterpriseContext": true, 3797 "excludeAuthTypes": [], 3798 "allowAuthTypes": [ 3799 "ANY" 3800 ], 3801 "allowPrincipleTypes": [], 3802 "excludePrincipleTypes": [ 3803 "EDGE", 3804 "GATEWAY" 3805 ], 3806 "requirePrivileges": [ 3807 { 3808 "action": "READ", 3809 "object": "ENTERPRISE_PROFILE" 3810 } 3811 ] 3812 }, 3813 "parameters": [ 3814 { 3815 "name": "body", 3816 "in": "body", 3817 "required": true, 3818 "schema": { 3819 "type": "object", 3820 "title": "enterprise_get_enterprise_configurations", 3821 "properties": { 3822 "enterpriseId": { 3823 "type": "integer" 3824 }, 3825 "configurationType": { 3826 "type": "string", 3827 "enum": [ 3828 "NETWORK_BASED", 3829 "SEGMENT_BASED" 3830 ] 3831 }, 3832 "with": { 3833 "type": "array", 3834 "items": { 3835 "type": "string", 3836 "enum": [ 3837 "edges", 3838 "modules", 3839 "edgeCount", 3840 "refs", 3841 "deviceSettings" 3842 ] 3843 } 3844 } 3845 }, 3846 "required": [ 3847 "enterpriseId" 3848 ] 3849 } 3850 } 3851 ], 3852 "responses": { 3853 "200": { 3854 "description": "Request was successfully processed", 3855 "schema": { 3856 "title": "enterprise_get_enterprise_configurations_result", 3857 "type": "array", 3858 "items": { 3859 "$ref": "#/definitions/enterprise_get_enterprise_configurations_result_item" 3860 } 3861 } 3862 }, 3863 "400": { 3864 "$ref": "#/responses/generic_400" 3865 }, 3866 "500": { 3867 "$ref": "#/responses/generic_500" 3868 } 3869 } 3870 } 3871 }, 3872 "/enterprise/getEnterpriseEdges": { 3873 "post": { 3874 "summary": "Get enterprise Edges", 3875 "tags": [ 3876 "enterprise", 3877 "all" 3878 ], 3879 "description": "Gets all Edges associated with the specified enterprise, including optional site, link, and configuration details.\n\nPrivileges required:\n\n`READ` `EDGE`", 3880 "operationId": "enterprise_get_enterprise_edges", 3881 "x-privileges": { 3882 "forceEnterpriseContext": true, 3883 "excludeAuthTypes": [], 3884 "allowAuthTypes": [ 3885 "ANY" 3886 ], 3887 "allowPrincipleTypes": [], 3888 "excludePrincipleTypes": [ 3889 "EDGE", 3890 "GATEWAY" 3891 ], 3892 "requirePrivileges": [ 3893 { 3894 "action": "READ", 3895 "object": "EDGE" 3896 } 3897 ] 3898 }, 3899 "parameters": [ 3900 { 3901 "name": "body", 3902 "in": "body", 3903 "required": true, 3904 "schema": { 3905 "type": "object", 3906 "title": "enterprise_get_enterprise_edges", 3907 "properties": { 3908 "id": { 3909 "type": "integer" 3910 }, 3911 "enterpriseId": { 3912 "type": "integer" 3913 }, 3914 "with": { 3915 "type": "array", 3916 "items": { 3917 "type": "string", 3918 "enum": [ 3919 "site", 3920 "links", 3921 "recentLinks", 3922 "configuration", 3923 "cloudServices", 3924 "cloudServiceSiteStatus", 3925 "vnfs", 3926 "certificates", 3927 "licenses" 3928 ] 3929 } 3930 } 3931 } 3932 } 3933 } 3934 ], 3935 "responses": { 3936 "200": { 3937 "description": "Request was successfully processed", 3938 "schema": { 3939 "title": "enterprise_get_enterprise_edges_result", 3940 "type": "array", 3941 "items": { 3942 "$ref": "#/definitions/enterprise_get_enterprise_edges_result_item" 3943 } 3944 } 3945 }, 3946 "400": { 3947 "$ref": "#/responses/generic_400" 3948 }, 3949 "500": { 3950 "$ref": "#/responses/generic_500" 3951 } 3952 } 3953 } 3954 }, 3955 "/enterprise/getEnterpriseGatewayHandoff": { 3956 "post": { 3957 "summary": "Get enterprise gateway handoff configuration", 3958 "description": "Gets the gateway handoff configuration for the specified enterprise.\n\nPrivileges required:\n\n`READ` `ENTERPRISE`", 3959 "tags": [ 3960 "enterprise", 3961 "all" 3962 ], 3963 "x-privileges": { 3964 "forceEnterpriseContext": true, 3965 "excludeAuthTypes": [], 3966 "allowAuthTypes": [ 3967 "OPERATOR_USER", 3968 "MSP_USER", 3969 "ENTERPRISE_USER" 3970 ], 3971 "allowPrincipleTypes": [], 3972 "excludePrincipleTypes": [ 3973 "EDGE", 3974 "GATEWAY" 3975 ], 3976 "requirePrivileges": [ 3977 { 3978 "action": "READ", 3979 "object": "ENTERPRISE" 3980 } 3981 ] 3982 }, 3983 "operationId": "enterprise_get_enterprise_gateway_handoff", 3984 "parameters": [ 3985 { 3986 "name": "body", 3987 "in": "body", 3988 "required": true, 3989 "schema": { 3990 "title": "enterprise_get_enterprise_gateway_handoff", 3991 "type": "object", 3992 "properties": { 3993 "enterpriseId": { 3994 "type": "integer" 3995 } 3996 }, 3997 "required": [ 3998 "enterpriseId" 3999 ] 4000 } 4001 } 4002 ], 4003 "responses": { 4004 "200": { 4005 "description": "Request was successfully processed", 4006 "schema": { 4007 "$ref": "#/definitions/enterprise_get_enterprise_gateway_handoff_result" 4008 } 4009 }, 4010 "400": { 4011 "$ref": "#/responses/generic_400" 4012 }, 4013 "500": { 4014 "$ref": "#/responses/generic_500" 4015 } 4016 } 4017 } 4018 }, 4019 "/enterprise/getEnterpriseMaximumSegments": { 4020 "post": { 4021 "summary": "Get enterprise maximum segment", 4022 "description": "Gets maximum segments for the specified enterprise.\n\nPrivileges required:\n\n`READ` `ENTERPRISE`", 4023 "tags": [ 4024 "enterprise", 4025 "all" 4026 ], 4027 "x-privileges": { 4028 "forceEnterpriseContext": true, 4029 "excludeAuthTypes": [], 4030 "allowAuthTypes": [ 4031 "ANY" 4032 ], 4033 "allowPrincipleTypes": [], 4034 "excludePrincipleTypes": [ 4035 "EDGE", 4036 "GATEWAY" 4037 ], 4038 "requirePrivileges": [ 4039 { 4040 "action": "READ", 4041 "object": "ENTERPRISE" 4042 } 4043 ] 4044 }, 4045 "operationId": "enterprise_get_enterprise_maximum_segments", 4046 "parameters": [ 4047 { 4048 "name": "body", 4049 "in": "body", 4050 "required": true, 4051 "schema": { 4052 "type": "object", 4053 "title": "enterprise_get_enterprise_maximum_segments", 4054 "properties": { 4055 "enterpriseId": { 4056 "type": "integer" 4057 } 4058 } 4059 } 4060 } 4061 ], 4062 "responses": { 4063 "200": { 4064 "description": "Request was successfully processed", 4065 "schema": { 4066 "$ref": "#/definitions/enterprise_get_enterprise_property_result" 4067 } 4068 }, 4069 "400": { 4070 "$ref": "#/responses/generic_400" 4071 }, 4072 "500": { 4073 "$ref": "#/responses/generic_500" 4074 } 4075 } 4076 } 4077 }, 4078 "/enterprise/getEnterpriseNetworkAllocation": { 4079 "post": { 4080 "summary": "Get enterprise network allocation", 4081 "description": "Gets the specified network allocation object (by `id`) for the specified enterprise.\n\nPrivileges required:\n\n`READ` `NETWORK_ALLOCATION`", 4082 "tags": [ 4083 "enterprise", 4084 "all" 4085 ], 4086 "x-privileges": { 4087 "excludeAuthTypes": [], 4088 "allowAuthTypes": [ 4089 "ANY" 4090 ], 4091 "allowPrincipleTypes": [], 4092 "excludePrincipleTypes": [ 4093 "EDGE", 4094 "GATEWAY" 4095 ], 4096 "requirePrivileges": [ 4097 { 4098 "action": "READ", 4099 "object": "NETWORK_ALLOCATION" 4100 } 4101 ] 4102 }, 4103 "operationId": "enterprise_get_enterprise_network_allocation", 4104 "parameters": [ 4105 { 4106 "name": "body", 4107 "in": "body", 4108 "required": true, 4109 "schema": { 4110 "type": "object", 4111 "title": "enterprise_get_enterprise_network_allocation", 4112 "properties": { 4113 "id": { 4114 "type": "integer" 4115 }, 4116 "enterpriseId": { 4117 "type": "integer" 4118 }, 4119 "with": { 4120 "type": "array", 4121 "items": { 4122 "type": "string", 4123 "enum": [ 4124 "edges", 4125 "edgeCount", 4126 "profileCount" 4127 ] 4128 } 4129 } 4130 }, 4131 "required": [ 4132 "id" 4133 ] 4134 } 4135 } 4136 ], 4137 "responses": { 4138 "200": { 4139 "description": "Request was successfully processed", 4140 "schema": { 4141 "$ref": "#/definitions/enterprise_get_enterprise_network_allocation_result" 4142 } 4143 }, 4144 "400": { 4145 "$ref": "#/responses/generic_400" 4146 }, 4147 "500": { 4148 "$ref": "#/responses/generic_500" 4149 } 4150 } 4151 } 4152 }, 4153 "/enterprise/getEnterpriseNetworkAllocations": { 4154 "post": { 4155 "summary": "Get enterprise network allocations", 4156 "description": "Gets all network allocations for the specified enterprise.\n\nPrivileges required:\n\n`READ` `NETWORK_ALLOCATION`", 4157 "operationId": "enterprise_get_enterprise_network_allocations", 4158 "x-privileges": { 4159 "excludeAuthTypes": [], 4160 "allowAuthTypes": [ 4161 "ANY" 4162 ], 4163 "allowPrincipleTypes": [], 4164 "excludePrincipleTypes": [ 4165 "EDGE", 4166 "GATEWAY" 4167 ], 4168 "requirePrivileges": [ 4169 { 4170 "action": "READ", 4171 "object": "NETWORK_ALLOCATION" 4172 } 4173 ] 4174 }, 4175 "tags": [ 4176 "all", 4177 "enterprise" 4178 ], 4179 "parameters": [ 4180 { 4181 "name": "body", 4182 "in": "body", 4183 "required": true, 4184 "schema": { 4185 "type": "object", 4186 "title": "enterprise_get_enterprise_network_allocations", 4187 "properties": { 4188 "enterpriseId": { 4189 "type": "integer" 4190 }, 4191 "name": { 4192 "type": "string" 4193 }, 4194 "with": { 4195 "type": "array", 4196 "items": { 4197 "type": "string", 4198 "enum": [ 4199 "edges", 4200 "edgeCount", 4201 "profileCount" 4202 ] 4203 } 4204 } 4205 } 4206 } 4207 } 4208 ], 4209 "responses": { 4210 "200": { 4211 "description": "Request was successfully processed", 4212 "schema": { 4213 "title": "enterprise_get_enterprise_network_allocations_result", 4214 "type": "array", 4215 "items": { 4216 "$ref": "#/definitions/enterprise_get_enterprise_network_allocations_result_item" 4217 } 4218 } 4219 }, 4220 "400": { 4221 "$ref": "#/responses/generic_400" 4222 }, 4223 "500": { 4224 "$ref": "#/responses/generic_500" 4225 } 4226 } 4227 } 4228 }, 4229 "/enterprise/getEnterpriseNetworkSegments": { 4230 "post": { 4231 "summary": "Get all network segment objects defined on an enterprise", 4232 "description": "Retrieve a list of all of the network segments defined forthe given enterprise.\n\nPrivileges required:\n\n`READ` `NETWORK_ALLOCATION`", 4233 "operationId": "enterprise_get_enterprise_network_segments", 4234 "x-privileges": { 4235 "excludeAuthTypes": [], 4236 "allowAuthTypes": [ 4237 "ANY" 4238 ], 4239 "allowPrincipleTypes": [], 4240 "excludePrincipleTypes": [ 4241 "EDGE", 4242 "GATEWAY" 4243 ], 4244 "requirePrivileges": [ 4245 { 4246 "action": "READ", 4247 "object": "NETWORK_ALLOCATION" 4248 } 4249 ] 4250 }, 4251 "tags": [ 4252 "all", 4253 "enterprise" 4254 ], 4255 "parameters": [ 4256 { 4257 "name": "body", 4258 "in": "body", 4259 "required": true, 4260 "schema": { 4261 "type": "object", 4262 "title": "enterprise_get_enterprise_network_segments", 4263 "properties": { 4264 "enterpriseId": { 4265 "type": "integer" 4266 }, 4267 "name": { 4268 "type": "string" 4269 }, 4270 "type": { 4271 "type": "string" 4272 }, 4273 "with": { 4274 "type": "array", 4275 "items": { 4276 "type": "string", 4277 "enum": [ 4278 "profileCount", 4279 "edgeUsage", 4280 "configuration", 4281 "handoffUsage", 4282 "mpgUsage" 4283 ] 4284 } 4285 } 4286 } 4287 } 4288 } 4289 ], 4290 "responses": { 4291 "200": { 4292 "description": "Request was successfully processed", 4293 "schema": { 4294 "title": "enterprise_get_enterprise_network_segments_result", 4295 "type": "array", 4296 "items": { 4297 "$ref": "#/definitions/enterprise_get_enterprise_network_segments_result_item" 4298 } 4299 } 4300 }, 4301 "400": { 4302 "$ref": "#/responses/generic_400" 4303 }, 4304 "500": { 4305 "$ref": "#/responses/generic_500" 4306 } 4307 } 4308 } 4309 }, 4310 "/enterprise/getEnterpriseProperty": { 4311 "post": { 4312 "summary": "Get enterprise property", 4313 "description": "Get a enterprise property by object id or other attribute.\n\nPrivileges required:\n\n`READ` `ENTERPRISE`", 4314 "operationId": "enterprise_get_enterprise_property", 4315 "x-privileges": { 4316 "forceEnterpriseContext": true, 4317 "excludeAuthTypes": [], 4318 "allowAuthTypes": [ 4319 "ANY" 4320 ], 4321 "allowPrincipleTypes": [], 4322 "excludePrincipleTypes": [ 4323 "EDGE", 4324 "GATEWAY" 4325 ], 4326 "requirePrivileges": [ 4327 { 4328 "action": "READ", 4329 "object": "ENTERPRISE" 4330 } 4331 ] 4332 }, 4333 "tags": [ 4334 "enterprise", 4335 "all" 4336 ], 4337 "parameters": [ 4338 { 4339 "name": "body", 4340 "in": "body", 4341 "required": true, 4342 "schema": { 4343 "type": "object", 4344 "title": "enterprise_get_enterprise_property", 4345 "properties": { 4346 "enterpriseId": { 4347 "type": "integer" 4348 }, 4349 "name": { 4350 "type": "string" 4351 }, 4352 "id": { 4353 "type": "integer" 4354 } 4355 } 4356 } 4357 } 4358 ], 4359 "responses": { 4360 "200": { 4361 "schema": { 4362 "$ref": "#/definitions/enterprise_get_enterprise_property_result" 4363 }, 4364 "description": "Request was successfully processed" 4365 }, 4366 "400": { 4367 "$ref": "#/responses/generic_400" 4368 }, 4369 "500": { 4370 "$ref": "#/responses/generic_500" 4371 } 4372 } 4373 } 4374 }, 4375 "/enterprise/getEnterpriseRouteConfiguration": { 4376 "post": { 4377 "summary": "Get enterprise global routing preferences", 4378 "description": "Gets all global routing preferences for the specified enterprise, incuding enterprise route advertisement, routing preferences, OSPF, and BGP advertisement policy.\n\nPrivileges required:\n\n`READ` `ENTERPRISE_PROFILE`", 4379 "tags": [ 4380 "all", 4381 "enterprise" 4382 ], 4383 "x-privileges": { 4384 "forceEnterpriseContext": true, 4385 "excludeAuthTypes": [], 4386 "allowAuthTypes": [ 4387 "ANY" 4388 ], 4389 "allowPrincipleTypes": [], 4390 "excludePrincipleTypes": [ 4391 "EDGE", 4392 "GATEWAY" 4393 ], 4394 "requirePrivileges": [ 4395 { 4396 "action": "READ", 4397 "object": "ENTERPRISE_PROFILE" 4398 } 4399 ] 4400 }, 4401 "operationId": "enterprise_get_enterprise_route_configuration", 4402 "parameters": [ 4403 { 4404 "name": "body", 4405 "in": "body", 4406 "required": true, 4407 "schema": { 4408 "title": "enterprise_get_enterprise_route_configuration", 4409 "type": "object", 4410 "properties": { 4411 "enterpriseId": { 4412 "type": "integer" 4413 } 4414 } 4415 } 4416 } 4417 ], 4418 "responses": { 4419 "200": { 4420 "description": "Request was successfully processed", 4421 "schema": { 4422 "$ref": "#/definitions/enterprise_get_enterprise_route_configuration_result" 4423 } 4424 }, 4425 "400": { 4426 "$ref": "#/responses/generic_400" 4427 }, 4428 "500": { 4429 "$ref": "#/responses/generic_500" 4430 } 4431 } 4432 } 4433 }, 4434 "/enterprise/getEnterpriseRouteTable": { 4435 "post": { 4436 "summary": "Get enterprise route table", 4437 "description": "Gets the composite enterprise route table, optionally scoped by profile(s). The returned routes include static routes, directly connected routes, and learned routes.\n\nPrivileges required:\n\n`READ` `ENTERPRISE_PROFILE`", 4438 "tags": [ 4439 "all", 4440 "enterprise" 4441 ], 4442 "x-privileges": { 4443 "forceEnterpriseContext": true, 4444 "excludeAuthTypes": [], 4445 "allowAuthTypes": [ 4446 "ANY" 4447 ], 4448 "allowPrincipleTypes": [], 4449 "excludePrincipleTypes": [ 4450 "EDGE", 4451 "GATEWAY" 4452 ], 4453 "requirePrivileges": [ 4454 { 4455 "action": "READ", 4456 "object": "ENTERPRISE_PROFILE" 4457 } 4458 ] 4459 }, 4460 "operationId": "enterprise_get_enterprise_route_table", 4461 "parameters": [ 4462 { 4463 "name": "body", 4464 "in": "body", 4465 "required": true, 4466 "schema": { 4467 "type": "object", 4468 "title": "enterprise_get_enterprise_route_table", 4469 "properties": { 4470 "enterpriseId": { 4471 "type": "integer" 4472 }, 4473 "profiles": { 4474 "type": "array", 4475 "items": { 4476 "type": "object", 4477 "properties": { 4478 "id": { 4479 "type": "integer" 4480 }, 4481 "name": { 4482 "type": "string" 4483 }, 4484 "description": { 4485 "type": "string" 4486 } 4487 } 4488 } 4489 }, 4490 "subnets": { 4491 "type": "array", 4492 "items": { 4493 "type": "object", 4494 "properties": { 4495 "subnet": { 4496 "type": "string" 4497 }, 4498 "preferredExits": { 4499 "type": "array", 4500 "items": { 4501 "$ref": "#/definitions/enterprise_route" 4502 } 4503 }, 4504 "eligableExits": { 4505 "type": "array", 4506 "items": { 4507 "$ref": "#/definitions/enterprise_route" 4508 } 4509 } 4510 } 4511 } 4512 } 4513 } 4514 } 4515 } 4516 ], 4517 "responses": { 4518 "200": { 4519 "description": "Request was successfully processed", 4520 "schema": { 4521 "$ref": "#/definitions/enterprise_get_enterprise_route_table_result" 4522 } 4523 }, 4524 "400": { 4525 "$ref": "#/responses/generic_400" 4526 }, 4527 "500": { 4528 "$ref": "#/responses/generic_500" 4529 } 4530 } 4531 } 4532 }, 4533 "/enterprise/getEnterpriseServices": { 4534 "post": { 4535 "summary": "Get enterprise network services", 4536 "description": "Gets all network service JSON objects defined for the specified enterprise.\n\nPrivileges required:\n\n`READ` `NETWORK_SERVICE`", 4537 "tags": [ 4538 "all", 4539 "enterprise" 4540 ], 4541 "x-privileges": { 4542 "excludeAuthTypes": [], 4543 "allowAuthTypes": [ 4544 "ANY" 4545 ], 4546 "allowPrincipleTypes": [], 4547 "excludePrincipleTypes": [ 4548 "EDGE", 4549 "GATEWAY" 4550 ], 4551 "requirePrivileges": [ 4552 { 4553 "action": "READ", 4554 "object": "NETWORK_SERVICE" 4555 } 4556 ] 4557 }, 4558 "operationId": "enterprise_get_enterprise_services", 4559 "parameters": [ 4560 { 4561 "name": "body", 4562 "in": "body", 4563 "required": true, 4564 "schema": { 4565 "type": "object", 4566 "title": "enterprise_get_enterprise_services", 4567 "properties": { 4568 "enterpriseId": { 4569 "type": "integer" 4570 }, 4571 "type": { 4572 "type": "string" 4573 }, 4574 "with": { 4575 "type": "array", 4576 "items": { 4577 "type": "string", 4578 "enum": [ 4579 "profileCount", 4580 "edgeUsage", 4581 "configuration", 4582 "groupCount" 4583 ] 4584 } 4585 }, 4586 "name": { 4587 "type": "string" 4588 }, 4589 "includePartnerGateways": { 4590 "type": "boolean" 4591 } 4592 } 4593 } 4594 } 4595 ], 4596 "responses": { 4597 "200": { 4598 "description": "Request was successfully processed", 4599 "schema": { 4600 "title": "enterprise_get_enterprise_services_result", 4601 "type": "array", 4602 "items": { 4603 "$ref": "#/definitions/enterprise_get_enterprise_services_result_item" 4604 } 4605 } 4606 }, 4607 "400": { 4608 "$ref": "#/responses/generic_400" 4609 }, 4610 "500": { 4611 "$ref": "#/responses/generic_500" 4612 } 4613 } 4614 } 4615 }, 4616 "/enterprise/getEnterpriseUsers": { 4617 "post": { 4618 "tags": [ 4619 "userMaintenance", 4620 "all" 4621 ], 4622 "summary": "Get enterprise users", 4623 "description": "Gets all enterprise users for the specified enterprise (by `enterpriseId`).\n\nPrivileges required:\n\n`READ` `ENTERPRISE`\n\n`READ` `ENTERPRISE_USER`", 4624 "operationId": "enterprise_get_enterprise_users", 4625 "x-privileges": { 4626 "forceEnterpriseContext": true, 4627 "excludeAuthTypes": [], 4628 "allowAuthTypes": [ 4629 "ANY" 4630 ], 4631 "allowPrincipleTypes": [], 4632 "excludePrincipleTypes": [ 4633 "EDGE", 4634 "GATEWAY" 4635 ], 4636 "requirePrivileges": [ 4637 { 4638 "action": "READ", 4639 "object": "ENTERPRISE" 4640 }, 4641 { 4642 "action": "READ", 4643 "object": "ENTERPRISE_USER" 4644 } 4645 ] 4646 }, 4647 "parameters": [ 4648 { 4649 "name": "body", 4650 "in": "body", 4651 "required": true, 4652 "schema": { 4653 "type": "object", 4654 "title": "enterprise_get_enterprise_users", 4655 "properties": { 4656 "id": { 4657 "type": "integer" 4658 }, 4659 "enterpriseId": { 4660 "type": "integer" 4661 } 4662 } 4663 } 4664 } 4665 ], 4666 "responses": { 4667 "200": { 4668 "schema": { 4669 "type": "array", 4670 "items": { 4671 "$ref": "#/definitions/enterprise_get_enterprise_users_result_item" 4672 } 4673 }, 4674 "description": "Request was successfully processed" 4675 }, 4676 "400": { 4677 "$ref": "#/responses/generic_400" 4678 }, 4679 "500": { 4680 "$ref": "#/responses/generic_500" 4681 } 4682 } 4683 } 4684 }, 4685 "/enterprise/insertEnterprise": { 4686 "post": { 4687 "summary": "Create enterprise", 4688 "description": "Creates a new enterprise, which is owned by the operator.\n\nPrivileges required:\n\n`CREATE` `ENTERPRISE`", 4689 "tags": [ 4690 "enterprise", 4691 "all" 4692 ], 4693 "operationId": "enterprise_insert_enterprise", 4694 "x-privileges": { 4695 "excludeAuthTypes": [], 4696 "allowAuthTypes": [ 4697 "OPERATOR_USER", 4698 "MSP_USER" 4699 ], 4700 "allowPrincipleTypes": [], 4701 "excludePrincipleTypes": [ 4702 "EDGE", 4703 "GATEWAY" 4704 ], 4705 "requirePrivileges": [ 4706 { 4707 "action": "CREATE", 4708 "object": "ENTERPRISE" 4709 } 4710 ] 4711 }, 4712 "parameters": [ 4713 { 4714 "name": "body", 4715 "in": "body", 4716 "required": true, 4717 "schema": { 4718 "$ref": "#/definitions/enterprise_insert_enterprise" 4719 } 4720 } 4721 ], 4722 "responses": { 4723 "200": { 4724 "description": "Request was successfully processed", 4725 "schema": { 4726 "$ref": "#/definitions/enterprise_insert_enterprise_result" 4727 } 4728 }, 4729 "400": { 4730 "$ref": "#/responses/generic_400" 4731 }, 4732 "500": { 4733 "$ref": "#/responses/generic_500" 4734 } 4735 } 4736 } 4737 }, 4738 "/enterprise/insertEnterpriseNetworkAllocation": { 4739 "post": { 4740 "summary": "Create enterprise network allocation", 4741 "description": "Creates a new network allocation for the specified enterprise.\n\nPrivileges required:\n\n`CREATE` `NETWORK_ALLOCATION`", 4742 "tags": [ 4743 "enterprise", 4744 "all" 4745 ], 4746 "operationId": "enterprise_insert_enterprise_network_allocation", 4747 "x-privileges": { 4748 "excludeAuthTypes": [], 4749 "allowAuthTypes": [ 4750 "ANY" 4751 ], 4752 "allowPrincipleTypes": [], 4753 "excludePrincipleTypes": [ 4754 "EDGE", 4755 "GATEWAY" 4756 ], 4757 "requirePrivileges": [ 4758 { 4759 "action": "CREATE", 4760 "object": "NETWORK_ALLOCATION" 4761 } 4762 ] 4763 }, 4764 "parameters": [ 4765 { 4766 "name": "body", 4767 "in": "body", 4768 "required": true, 4769 "schema": { 4770 "type": "object", 4771 "title": "enterprise_insert_enterprise_network_allocation", 4772 "properties": { 4773 "enterpriseId": { 4774 "type": "integer" 4775 }, 4776 "name": { 4777 "type": "string" 4778 }, 4779 "data": { 4780 "type": "object", 4781 "properties": { 4782 "spaces": { 4783 "type": "array", 4784 "items": { 4785 "$ref": "#/definitions/enterprise_network_space" 4786 } 4787 } 4788 } 4789 } 4790 }, 4791 "required": [ 4792 "name" 4793 ] 4794 } 4795 } 4796 ], 4797 "responses": { 4798 "200": { 4799 "description": "Request was successfully processed", 4800 "schema": { 4801 "$ref": "#/definitions/enterprise_insert_enterprise_network_allocation_result" 4802 } 4803 }, 4804 "400": { 4805 "$ref": "#/responses/generic_400" 4806 }, 4807 "500": { 4808 "$ref": "#/responses/generic_500" 4809 } 4810 } 4811 } 4812 }, 4813 "/enterprise/insertEnterpriseNetworkSegment": { 4814 "post": { 4815 "summary": "Create enterprise network segment", 4816 "description": "Creates a new network segment for the specified enterprise.\n\nPrivileges required:\n\n`CREATE` `NETWORK_ALLOCATION`", 4817 "tags": [ 4818 "enterprise", 4819 "all" 4820 ], 4821 "operationId": "enterprise_insert_enterprise_network_segment", 4822 "x-privileges": { 4823 "excludeAuthTypes": [], 4824 "allowAuthTypes": [ 4825 "ANY" 4826 ], 4827 "allowPrincipleTypes": [], 4828 "excludePrincipleTypes": [ 4829 "EDGE", 4830 "GATEWAY" 4831 ], 4832 "requirePrivileges": [ 4833 { 4834 "action": "CREATE", 4835 "object": "NETWORK_ALLOCATION" 4836 } 4837 ] 4838 }, 4839 "parameters": [ 4840 { 4841 "name": "body", 4842 "in": "body", 4843 "required": true, 4844 "schema": { 4845 "type": "object", 4846 "title": "enterprise_insert_enterprise_network_segment", 4847 "properties": { 4848 "enterpriseId": { 4849 "type": "integer" 4850 }, 4851 "name": { 4852 "type": "string" 4853 }, 4854 "description": { 4855 "type": "string" 4856 }, 4857 "type": { 4858 "type": "string", 4859 "enum": [ 4860 "REGULAR", 4861 "CDE" 4862 ] 4863 }, 4864 "data": { 4865 "$ref": "#/definitions/network_segment_data" 4866 } 4867 }, 4868 "required": [ 4869 "name", 4870 "type", 4871 "data" 4872 ] 4873 } 4874 } 4875 ], 4876 "responses": { 4877 "200": { 4878 "description": "Request was successfully processed", 4879 "schema": { 4880 "$ref": "#/definitions/enterprise_insert_enterprise_network_segment_result" 4881 } 4882 }, 4883 "400": { 4884 "$ref": "#/responses/generic_400" 4885 }, 4886 "500": { 4887 "$ref": "#/responses/generic_500" 4888 } 4889 } 4890 } 4891 }, 4892 "/enterprise/insertEnterpriseService": { 4893 "post": { 4894 "summary": "Create enterprise service", 4895 "description": "Creates a new enterprise service for the specified enterprise.\n\nPrivileges required:\n\n`CREATE` `NETWORK_SERVICE`", 4896 "tags": [ 4897 "all", 4898 "enterprise" 4899 ], 4900 "x-privileges": { 4901 "excludeAuthTypes": [], 4902 "allowAuthTypes": [ 4903 "ANY" 4904 ], 4905 "allowPrincipleTypes": [], 4906 "excludePrincipleTypes": [ 4907 "EDGE", 4908 "GATEWAY" 4909 ], 4910 "requirePrivileges": [ 4911 { 4912 "action": "CREATE", 4913 "object": "NETWORK_SERVICE" 4914 } 4915 ] 4916 }, 4917 "operationId": "enterprise_insert_enterprise_service", 4918 "parameters": [ 4919 { 4920 "name": "body", 4921 "in": "body", 4922 "required": true, 4923 "schema": { 4924 "type": "object", 4925 "title": "enterprise_insert_enterprise_service", 4926 "properties": { 4927 "enterpriseId": { 4928 "type": "integer" 4929 }, 4930 "type": { 4931 "type": "string" 4932 }, 4933 "name": { 4934 "type": "string" 4935 }, 4936 "data": { 4937 "type": "object" 4938 }, 4939 "edgeId": { 4940 "type": "integer" 4941 }, 4942 "parentGroupId": { 4943 "type": "integer" 4944 } 4945 }, 4946 "required": [ 4947 "type", 4948 "name", 4949 "data" 4950 ] 4951 } 4952 } 4953 ], 4954 "responses": { 4955 "200": { 4956 "description": "Request was successfully processed", 4957 "schema": { 4958 "$ref": "#/definitions/enterprise_insert_enterprise_service_result" 4959 } 4960 }, 4961 "400": { 4962 "$ref": "#/responses/generic_400" 4963 }, 4964 "500": { 4965 "$ref": "#/responses/generic_500" 4966 } 4967 } 4968 } 4969 }, 4970 "/enterprise/insertEnterpriseUser": { 4971 "post": { 4972 "summary": "Create enterprise user", 4973 "description": "Creates a new enterprise user.\n\nPrivileges required:\n\n`CREATE` `ENTERPRISE_USER`", 4974 "x-privileges": { 4975 "excludeAuthTypes": [], 4976 "allowAuthTypes": [ 4977 "ANY" 4978 ], 4979 "allowPrincipleTypes": [], 4980 "excludePrincipleTypes": [ 4981 "EDGE", 4982 "GATEWAY" 4983 ], 4984 "requirePrivileges": [ 4985 { 4986 "action": "CREATE", 4987 "object": "ENTERPRISE_USER" 4988 } 4989 ] 4990 }, 4991 "tags": [ 4992 "userMaintenance", 4993 "all" 4994 ], 4995 "operationId": "enterprise_insert_enterprise_user", 4996 "parameters": [ 4997 { 4998 "name": "body", 4999 "in": "body", 5000 "required": true, 5001 "schema": { 5002 "$ref": "#/definitions/new_enterprise_user" 5003 } 5004 } 5005 ], 5006 "responses": { 5007 "200": { 5008 "schema": { 5009 "$ref": "#/definitions/enterprise_insert_enterprise_user_result" 5010 }, 5011 "description": "Request was successfully processed" 5012 }, 5013 "400": { 5014 "$ref": "#/responses/generic_400" 5015 }, 5016 "500": { 5017 "$ref": "#/responses/generic_500" 5018 } 5019 } 5020 } 5021 }, 5022 "/enterprise/insertOrUpdateEnterpriseAlertConfigurations": { 5023 "post": { 5024 "summary": "Create, update, or delete enterprise alert configurations", 5025 "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.\n\nPrivileges required:\n\n`CREATE` `ENTERPRISE_ALERT`", 5026 "tags": [ 5027 "all", 5028 "enterprise" 5029 ], 5030 "x-privileges": { 5031 "forceEnterpriseContext": true, 5032 "excludeAuthTypes": [], 5033 "allowAuthTypes": [ 5034 "ANY" 5035 ], 5036 "allowPrincipleTypes": [], 5037 "excludePrincipleTypes": [ 5038 "EDGE", 5039 "GATEWAY" 5040 ], 5041 "requirePrivileges": [ 5042 { 5043 "action": "CREATE", 5044 "object": "ENTERPRISE_ALERT" 5045 } 5046 ] 5047 }, 5048 "operationId": "enterprise_insert_or_update_enterprise_alert_configurations", 5049 "parameters": [ 5050 { 5051 "name": "body", 5052 "in": "body", 5053 "required": true, 5054 "schema": { 5055 "type": "object", 5056 "title": "enterprise_insert_or_update_enterprise_alert_configurations", 5057 "properties": { 5058 "enterpriseId": { 5059 "type": "integer" 5060 }, 5061 "enterpriseAlertConfigurations": { 5062 "type": "array", 5063 "items": { 5064 "$ref": "#/definitions/enterprise_alert_configuration" 5065 } 5066 } 5067 }, 5068 "required": [ 5069 "enterpriseAlertConfigurations" 5070 ] 5071 } 5072 } 5073 ], 5074 "responses": { 5075 "200": { 5076 "description": "Request was successfully processed", 5077 "schema": { 5078 "$ref": "#/definitions/enterprise_insert_or_update_enterprise_alert_configurations_result" 5079 } 5080 }, 5081 "400": { 5082 "$ref": "#/responses/generic_400" 5083 }, 5084 "500": { 5085 "$ref": "#/responses/generic_500" 5086 } 5087 } 5088 } 5089 }, 5090 "/enterprise/insertOrUpdateEnterpriseCapability": { 5091 "post": { 5092 "summary": "Create or update enterprise capability", 5093 "description": "Creates or updates the specified capability (`name`, `value`) for the specified enterprise (by `enterpriseId`).\n\nPrivileges required:\n\n`UPDATE` `ENTERPRISE`", 5094 "tags": [ 5095 "enterprise", 5096 "all" 5097 ], 5098 "x-privileges": { 5099 "forceEnterpriseContext": true, 5100 "excludeAuthTypes": [], 5101 "allowAuthTypes": [ 5102 "OPERATOR_USER" 5103 ], 5104 "allowPrincipleTypes": [], 5105 "excludePrincipleTypes": [ 5106 "EDGE", 5107 "GATEWAY" 5108 ], 5109 "requirePrivileges": [ 5110 { 5111 "action": "UPDATE", 5112 "object": "ENTERPRISE" 5113 } 5114 ] 5115 }, 5116 "operationId": "enterprise_insert_or_update_enterprise_capability", 5117 "parameters": [ 5118 { 5119 "name": "body", 5120 "in": "body", 5121 "required": true, 5122 "schema": { 5123 "type": "object", 5124 "title": "enterprise_insert_or_update_enterprise_capability", 5125 "properties": { 5126 "enterpriseId": { 5127 "type": "integer" 5128 }, 5129 "name": { 5130 "type": "string", 5131 "enum": [ 5132 "enableOSPF", 5133 "enableBGP", 5134 "enableNAT", 5135 "enablePKI", 5136 "enableFwLogs", 5137 "enableStatefulFirewall", 5138 "enableVQM", 5139 "enableServiceRateLimiting", 5140 "enableCosMapping", 5141 "enableSegmentation", 5142 "enableNetworks", 5143 "enableEnterpriseAuth", 5144 "enablePremium", 5145 "edgeVnfs.enable", 5146 "edgeVnfs.securityVnf.paloAlto", 5147 "edgeVnfs.securityVnf.checkPoint", 5148 "edgeVnfs.securityVnf.fortinet", 5149 "edgeVnfs.securityVnf.centOS" 5150 ] 5151 }, 5152 "value": { 5153 "type": "boolean" 5154 } 5155 }, 5156 "required": [ 5157 "name", 5158 "value" 5159 ] 5160 } 5161 } 5162 ], 5163 "responses": { 5164 "200": { 5165 "description": "Request was successfully processed", 5166 "schema": { 5167 "$ref": "#/definitions/enterprise_insert_or_update_enterprise_capability_result" 5168 } 5169 }, 5170 "400": { 5171 "$ref": "#/responses/generic_400" 5172 }, 5173 "500": { 5174 "$ref": "#/responses/generic_500" 5175 } 5176 } 5177 } 5178 }, 5179 "/enterprise/insertOrUpdateEnterpriseGatewayHandoff": { 5180 "post": { 5181 "summary": "Create or update enterprise gateway handoff configuration", 5182 "description": "Creates or updates a gateway handoff configuration for the specified enterprise (by `enterpriseId`).\n\nPrivileges required:\n\n`UPDATE` `ENTERPRISE`\n\n`UPDATE` `GATEWAY`", 5183 "tags": [ 5184 "enterprise", 5185 "all" 5186 ], 5187 "x-privileges": { 5188 "forceEnterpriseContext": true, 5189 "excludeAuthTypes": [], 5190 "allowAuthTypes": [ 5191 "OPERATOR_USER", 5192 "MSP_USER" 5193 ], 5194 "allowPrincipleTypes": [], 5195 "excludePrincipleTypes": [ 5196 "EDGE", 5197 "GATEWAY" 5198 ], 5199 "requirePrivileges": [ 5200 { 5201 "action": "UPDATE", 5202 "object": "ENTERPRISE" 5203 }, 5204 { 5205 "action": "UPDATE", 5206 "object": "GATEWAY" 5207 } 5208 ] 5209 }, 5210 "operationId": "enterprise_insert_or_update_enterprise_gateway_handoff", 5211 "parameters": [ 5212 { 5213 "name": "body", 5214 "in": "body", 5215 "required": true, 5216 "schema": { 5217 "$ref": "#/definitions/enterprise_insert_or_update_enterprise_gateway_handoff" 5218 } 5219 } 5220 ], 5221 "responses": { 5222 "200": { 5223 "description": "Request was successfully processed", 5224 "schema": { 5225 "$ref": "#/definitions/enterprise_insert_or_update_enterprise_gateway_handoff_result" 5226 } 5227 }, 5228 "400": { 5229 "$ref": "#/responses/generic_400" 5230 }, 5231 "500": { 5232 "$ref": "#/responses/generic_500" 5233 } 5234 } 5235 } 5236 }, 5237 "/enterprise/insertOrUpdateEnterpriseProperty": { 5238 "post": { 5239 "summary": "Insert or update an enterprise property", 5240 "description": "Insert a enterprise property. If property with the given name already exists, the property will be updated.\n\nPrivileges required:\n\n`UPDATE` `ENTERPRISE`", 5241 "operationId": "enterprise_insert_or_update_enterprise_property", 5242 "x-privileges": { 5243 "forceEnterpriseContext": true, 5244 "excludeAuthTypes": [], 5245 "allowAuthTypes": [ 5246 "ANY" 5247 ], 5248 "allowPrincipleTypes": [], 5249 "excludePrincipleTypes": [ 5250 "EDGE", 5251 "GATEWAY" 5252 ], 5253 "requirePrivileges": [ 5254 { 5255 "action": "UPDATE", 5256 "object": "ENTERPRISE" 5257 } 5258 ] 5259 }, 5260 "tags": [ 5261 "enterprise", 5262 "all" 5263 ], 5264 "parameters": [ 5265 { 5266 "name": "body", 5267 "in": "body", 5268 "required": true, 5269 "schema": { 5270 "type": "object", 5271 "title": "enterprise_insert_or_update_enterprise_property", 5272 "properties": { 5273 "enterpriseId": { 5274 "type": "integer" 5275 }, 5276 "name": { 5277 "type": "string" 5278 }, 5279 "value": { 5280 "type": "string" 5281 }, 5282 "dataType": { 5283 "type": "string", 5284 "enum": [ 5285 "STRING", 5286 "NUMBER", 5287 "BOOLEAN", 5288 "JSON", 5289 "DATE", 5290 "DATETIME" 5291 ] 5292 }, 5293 "isPassword": { 5294 "type": "boolean" 5295 }, 5296 "description": { 5297 "type": "string" 5298 } 5299 }, 5300 "required": [ 5301 "enterpriseId", 5302 "name", 5303 "value" 5304 ], 5305 "example": { 5306 "enterpriseId": 1532, 5307 "name": "vco.enterprise.authentication.twoFactor.enable", 5308 "dataType": "BOOLEAN", 5309 "value": "true" 5310 } 5311 } 5312 } 5313 ], 5314 "responses": { 5315 "200": { 5316 "schema": { 5317 "$ref": "#/definitions/enterprise_insert_or_update_enterprise_property_result" 5318 }, 5319 "description": "Request was successfully processed" 5320 }, 5321 "400": { 5322 "$ref": "#/responses/generic_400" 5323 }, 5324 "500": { 5325 "$ref": "#/responses/generic_500" 5326 } 5327 } 5328 } 5329 }, 5330 "/enterprise/setEnterpriseAllAlertsRecipients": { 5331 "post": { 5332 "summary": "Specify recipients for all enterprise alerts", 5333 "description": "Specifies the recipients who should receive all alerts for the specified enterprise.\n\nPrivileges required:\n\n`UPDATE` `ENTERPRISE_ALERT`", 5334 "tags": [ 5335 "all", 5336 "enterprise" 5337 ], 5338 "x-privileges": { 5339 "excludeAuthTypes": [], 5340 "allowAuthTypes": [ 5341 "ANY" 5342 ], 5343 "allowPrincipleTypes": [], 5344 "excludePrincipleTypes": [ 5345 "EDGE", 5346 "GATEWAY" 5347 ], 5348 "requirePrivileges": [ 5349 { 5350 "action": "UPDATE", 5351 "object": "ENTERPRISE_ALERT" 5352 } 5353 ] 5354 }, 5355 "operationId": "enterprise_set_enterprise_all_alert_recipients", 5356 "parameters": [ 5357 { 5358 "name": "body", 5359 "in": "body", 5360 "required": true, 5361 "schema": { 5362 "type": "object", 5363 "title": "enterprise_set_enterprise_all_alert_recipients", 5364 "properties": { 5365 "enterpriseId": { 5366 "type": "integer" 5367 }, 5368 "enterpriseUsers": { 5369 "type": "array", 5370 "items": { 5371 "type": "object", 5372 "properties": { 5373 "enterpriseUserId": { 5374 "type": "integer" 5375 }, 5376 "enabled": { 5377 "type": "boolean" 5378 }, 5379 "smsEnabled": { 5380 "type": "boolean" 5381 }, 5382 "emailEnabled": { 5383 "type": "boolean" 5384 }, 5385 "mobileEnabled": { 5386 "type": "boolean" 5387 } 5388 } 5389 } 5390 }, 5391 "smsEnabled": { 5392 "type": "boolean" 5393 }, 5394 "smsList": { 5395 "type": "array", 5396 "items": { 5397 "type": "object", 5398 "properties": { 5399 "username": { 5400 "type": "string" 5401 }, 5402 "mobilePhone": { 5403 "type": "string" 5404 }, 5405 "email": { 5406 "type": "string" 5407 } 5408 } 5409 } 5410 }, 5411 "emailEnabled": { 5412 "type": "boolean" 5413 }, 5414 "emailList": { 5415 "type": "array", 5416 "items": { 5417 "type": "string" 5418 } 5419 }, 5420 "mobileEnabled": { 5421 "type": "boolean" 5422 }, 5423 "mobileList": { 5424 "type": "array", 5425 "items": { 5426 "type": "string" 5427 } 5428 } 5429 } 5430 } 5431 } 5432 ], 5433 "responses": { 5434 "200": { 5435 "description": "Request was successfully processed", 5436 "schema": { 5437 "$ref": "#/definitions/enterprise_set_enterprise_all_alert_recipients_result" 5438 } 5439 }, 5440 "400": { 5441 "$ref": "#/responses/generic_400" 5442 }, 5443 "500": { 5444 "$ref": "#/responses/generic_500" 5445 } 5446 } 5447 } 5448 }, 5449 "/enterprise/setEnterpriseMaximumSegments": { 5450 "post": { 5451 "summary": "Set enterprise maximum segments", 5452 "description": "Set maximum segments for the specified enterprise (by `enterpriseId`).\n\nPrivileges required:\n\n`UPDATE` `ENTERPRISE`", 5453 "tags": [ 5454 "enterprise", 5455 "all" 5456 ], 5457 "x-privileges": { 5458 "forceEnterpriseContext": true, 5459 "excludeAuthTypes": [], 5460 "allowAuthTypes": [ 5461 "OPERATOR_USER", 5462 "MSP_USER" 5463 ], 5464 "allowPrincipleTypes": [], 5465 "excludePrincipleTypes": [ 5466 "EDGE", 5467 "GATEWAY" 5468 ], 5469 "requirePrivileges": [ 5470 { 5471 "action": "UPDATE", 5472 "object": "ENTERPRISE" 5473 } 5474 ] 5475 }, 5476 "operationId": "enterprise_set_enterprise_maximum_segments", 5477 "parameters": [ 5478 { 5479 "name": "body", 5480 "in": "body", 5481 "required": true, 5482 "schema": { 5483 "title": "enterprise_set_enterprise_maximum_segments", 5484 "type": "object", 5485 "properties": { 5486 "enterpriseId": { 5487 "type": "integer" 5488 }, 5489 "value": { 5490 "type": "integer" 5491 } 5492 } 5493 } 5494 } 5495 ], 5496 "responses": { 5497 "200": { 5498 "description": "Request was successfully processed", 5499 "schema": { 5500 "$ref": "#/definitions/enterprise_set_enterprise_maximum_segments_result" 5501 } 5502 }, 5503 "400": { 5504 "$ref": "#/responses/generic_400" 5505 }, 5506 "500": { 5507 "$ref": "#/responses/generic_500" 5508 } 5509 } 5510 } 5511 }, 5512 "/enterprise/setEnterpriseOperatorConfiguration": { 5513 "post": { 5514 "summary": "Apply operator profile to given enterprise", 5515 "tags": [ 5516 "all", 5517 "enterprise" 5518 ], 5519 "description": "Sets the operator configuration for the specified enterprise (by `enterpriseId`). This overrides any network-assigned operator configuration and the network default operator configuration.\n\nPrivileges required:\n\n`UPDATE` `ENTERPRISE`", 5520 "operationId": "enterprise_set_enterprise_operator_configuration", 5521 "x-privileges": { 5522 "excludeAuthTypes": [], 5523 "allowAuthTypes": [ 5524 "OPERATOR_USER", 5525 "MSP_USER" 5526 ], 5527 "allowPrincipleTypes": [], 5528 "excludePrincipleTypes": [ 5529 "EDGE", 5530 "GATEWAY" 5531 ], 5532 "requirePrivileges": [ 5533 { 5534 "action": "UPDATE", 5535 "object": "ENTERPRISE" 5536 } 5537 ] 5538 }, 5539 "parameters": [ 5540 { 5541 "name": "body", 5542 "in": "body", 5543 "required": true, 5544 "schema": { 5545 "type": "object", 5546 "title": "enterprise_set_enterprise_operator_configuration", 5547 "properties": { 5548 "enterpriseId": { 5549 "type": "integer" 5550 }, 5551 "configurationId": { 5552 "type": "integer" 5553 }, 5554 "networkId": { 5555 "type": "integer" 5556 } 5557 }, 5558 "required": [ 5559 "enterpriseId", 5560 "configurationId" 5561 ] 5562 } 5563 } 5564 ], 5565 "responses": { 5566 "200": { 5567 "description": "Request was successfully processed", 5568 "schema": { 5569 "$ref": "#/definitions/enterprise_set_enterprise_operator_configuration_result" 5570 } 5571 }, 5572 "400": { 5573 "$ref": "#/responses/generic_400" 5574 }, 5575 "500": { 5576 "$ref": "#/responses/generic_500" 5577 } 5578 } 5579 } 5580 }, 5581 "/enterprise/updateEnterprise": { 5582 "post": { 5583 "summary": "Update enterprise", 5584 "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).\n\nPrivileges required:\n\n`UPDATE` `ENTERPRISE`", 5585 "tags": [ 5586 "enterprise", 5587 "all" 5588 ], 5589 "operationId": "enterprise_update_enterprise", 5590 "x-privileges": { 5591 "forceEnterpriseContext": true, 5592 "excludeAuthTypes": [], 5593 "allowAuthTypes": [ 5594 "ANY" 5595 ], 5596 "allowPrincipleTypes": [], 5597 "excludePrincipleTypes": [ 5598 "EDGE", 5599 "GATEWAY" 5600 ], 5601 "requirePrivileges": [ 5602 { 5603 "action": "UPDATE", 5604 "object": "ENTERPRISE" 5605 } 5606 ] 5607 }, 5608 "parameters": [ 5609 { 5610 "name": "body", 5611 "in": "body", 5612 "required": true, 5613 "schema": { 5614 "title": "enterprise_update_enterprise", 5615 "type": "object", 5616 "properties": { 5617 "enterpriseId": { 5618 "type": "integer" 5619 }, 5620 "name": { 5621 "type": "string" 5622 }, 5623 "_update": { 5624 "$ref": "#/definitions/enterprise_update_enterprise" 5625 } 5626 } 5627 } 5628 } 5629 ], 5630 "responses": { 5631 "200": { 5632 "description": "Request was successfully processed", 5633 "schema": { 5634 "$ref": "#/definitions/enterprise_update_enterprise_result" 5635 } 5636 }, 5637 "400": { 5638 "$ref": "#/responses/generic_400" 5639 }, 5640 "500": { 5641 "$ref": "#/responses/generic_500" 5642 } 5643 } 5644 } 5645 }, 5646 "/enterprise/updateEnterpriseNetworkAllocation": { 5647 "post": { 5648 "summary": "Update enterprise network allocation", 5649 "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).\n\nPrivileges required:\n\n`UPDATE` `NETWORK_ALLOCATION`", 5650 "tags": [ 5651 "enterprise", 5652 "all" 5653 ], 5654 "x-privileges": { 5655 "excludeAuthTypes": [], 5656 "allowAuthTypes": [ 5657 "ANY" 5658 ], 5659 "allowPrincipleTypes": [], 5660 "excludePrincipleTypes": [ 5661 "EDGE", 5662 "GATEWAY" 5663 ], 5664 "requirePrivileges": [ 5665 { 5666 "action": "UPDATE", 5667 "object": "NETWORK_ALLOCATION" 5668 } 5669 ] 5670 }, 5671 "operationId": "enterprise_update_enterprise_network_allocation", 5672 "parameters": [ 5673 { 5674 "name": "body", 5675 "in": "body", 5676 "required": true, 5677 "schema": { 5678 "type": "object", 5679 "title": "enterprise_update_enterprise_network_allocation", 5680 "properties": { 5681 "id": { 5682 "type": "integer" 5683 }, 5684 "enterpriseId": { 5685 "type": "integer" 5686 }, 5687 "_update": { 5688 "type": "object", 5689 "properties": { 5690 "enterpriseId": { 5691 "type": "integer" 5692 }, 5693 "name": { 5694 "type": "string" 5695 }, 5696 "data": { 5697 "type": "object", 5698 "properties": { 5699 "spaces": { 5700 "type": "array", 5701 "items": { 5702 "$ref": "#/definitions/enterprise_network_space" 5703 } 5704 } 5705 } 5706 } 5707 } 5708 } 5709 } 5710 } 5711 } 5712 ], 5713 "responses": { 5714 "200": { 5715 "description": "Request was successfully processed", 5716 "schema": { 5717 "$ref": "#/definitions/enterprise_update_enterprise_network_allocation_result" 5718 } 5719 }, 5720 "400": { 5721 "$ref": "#/responses/generic_400" 5722 }, 5723 "500": { 5724 "$ref": "#/responses/generic_500" 5725 } 5726 } 5727 } 5728 }, 5729 "/enterprise/updateEnterpriseNetworkSegment": { 5730 "post": { 5731 "summary": "Update an enterprise network segment", 5732 "description": "Update an enterprise network segment.\n\nPrivileges required:\n\n`UPDATE` `NETWORK_ALLOCATION`", 5733 "tags": [ 5734 "enterprise", 5735 "all" 5736 ], 5737 "operationId": "enterprise_update_enterprise_network_segment", 5738 "x-privileges": { 5739 "excludeAuthTypes": [], 5740 "allowAuthTypes": [ 5741 "ANY" 5742 ], 5743 "allowPrincipleTypes": [], 5744 "excludePrincipleTypes": [ 5745 "EDGE", 5746 "GATEWAY" 5747 ], 5748 "requirePrivileges": [ 5749 { 5750 "action": "UPDATE", 5751 "object": "NETWORK_ALLOCATION" 5752 } 5753 ] 5754 }, 5755 "parameters": [ 5756 { 5757 "name": "body", 5758 "in": "body", 5759 "required": true, 5760 "schema": { 5761 "type": "object", 5762 "title": "enterprise_update_enterprise_network_segment", 5763 "properties": { 5764 "enterpriseId": { 5765 "type": "integer" 5766 }, 5767 "id": { 5768 "type": "integer" 5769 }, 5770 "_update": { 5771 "type": "object", 5772 "properties": { 5773 "name": { 5774 "type": "string" 5775 }, 5776 "description": { 5777 "type": "string" 5778 }, 5779 "type": { 5780 "type": "string", 5781 "enum": [ 5782 "REGULAR", 5783 "CDE" 5784 ] 5785 }, 5786 "data": { 5787 "$ref": "#/definitions/network_segment_data" 5788 } 5789 } 5790 } 5791 }, 5792 "required": [ 5793 "id" 5794 ] 5795 } 5796 } 5797 ], 5798 "responses": { 5799 "200": { 5800 "description": "Request was successfully processed", 5801 "schema": { 5802 "$ref": "#/definitions/enterprise_update_enterprise_network_segment_result" 5803 } 5804 }, 5805 "400": { 5806 "$ref": "#/responses/generic_400" 5807 }, 5808 "500": { 5809 "$ref": "#/responses/generic_500" 5810 } 5811 } 5812 } 5813 }, 5814 "/enterprise/updateEnterpriseRoute": { 5815 "post": { 5816 "summary": "Update preferred VPN exits for a route", 5817 "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.\n\nPrivileges required:\n\n`UPDATE` `ENTERPRISE_PROFILE`", 5818 "tags": [ 5819 "all", 5820 "enterprise" 5821 ], 5822 "x-privileges": { 5823 "forceEnterpriseContext": true, 5824 "excludeAuthTypes": [], 5825 "allowAuthTypes": [ 5826 "ANY" 5827 ], 5828 "allowPrincipleTypes": [], 5829 "excludePrincipleTypes": [ 5830 "EDGE", 5831 "GATEWAY" 5832 ], 5833 "requirePrivileges": [ 5834 { 5835 "action": "UPDATE", 5836 "object": "ENTERPRISE_PROFILE" 5837 } 5838 ] 5839 }, 5840 "operationId": "enterprise_update_enterprise_route", 5841 "parameters": [ 5842 { 5843 "name": "body", 5844 "in": "body", 5845 "required": true, 5846 "schema": { 5847 "type": "object", 5848 "title": "enterprise_update_enterprise_route", 5849 "properties": { 5850 "enterpriseId": { 5851 "type": "integer" 5852 }, 5853 "original": { 5854 "$ref": "#/definitions/enterprise_route_collection" 5855 }, 5856 "updated": { 5857 "$ref": "#/definitions/enterprise_route_collection" 5858 } 5859 } 5860 } 5861 } 5862 ], 5863 "responses": { 5864 "200": { 5865 "description": "Request was successfully processed", 5866 "schema": { 5867 "$ref": "#/definitions/enterprise_update_enterprise_route_result" 5868 } 5869 }, 5870 "400": { 5871 "$ref": "#/responses/generic_400" 5872 }, 5873 "500": { 5874 "$ref": "#/responses/generic_500" 5875 } 5876 } 5877 } 5878 }, 5879 "/enterprise/updateEnterpriseRouteConfiguration": { 5880 "post": { 5881 "summary": "Update enterprise global routing preferences", 5882 "description": "Updates the specified enterprise global routing preferences as specified by configuration `id` or logicalId.\n\nPrivileges required:\n\n`UPDATE` `ENTERPRISE_PROFILE`", 5883 "tags": [ 5884 "all", 5885 "enterprise" 5886 ], 5887 "x-privileges": { 5888 "forceEnterpriseContext": true, 5889 "excludeAuthTypes": [], 5890 "allowAuthTypes": [ 5891 "ANY" 5892 ], 5893 "allowPrincipleTypes": [], 5894 "excludePrincipleTypes": [ 5895 "EDGE", 5896 "GATEWAY" 5897 ], 5898 "requirePrivileges": [ 5899 { 5900 "action": "UPDATE", 5901 "object": "ENTERPRISE_PROFILE" 5902 } 5903 ] 5904 }, 5905 "operationId": "enterprise_update_enterprise_route_configuration", 5906 "parameters": [ 5907 { 5908 "name": "body", 5909 "in": "body", 5910 "required": true, 5911 "schema": { 5912 "type": "object", 5913 "title": "enterprise_update_enterprise_route_configuration", 5914 "required": [ 5915 "data" 5916 ], 5917 "properties": { 5918 "enterpriseId": { 5919 "type": "integer" 5920 }, 5921 "id": { 5922 "type": "integer" 5923 }, 5924 "data": { 5925 "type": "object", 5926 "required": [ 5927 "edge", 5928 "hub", 5929 "partnerGateway", 5930 "routingPreference" 5931 ], 5932 "properties": { 5933 "edge": { 5934 "type": "object", 5935 "required": [ 5936 "ospf", 5937 "bgp", 5938 "assigned" 5939 ], 5940 "properties": { 5941 "ospf": { 5942 "type": "object", 5943 "required": [ 5944 "advertiseExternal", 5945 "advertiseInterArea", 5946 "advertiseIntraArea" 5947 ], 5948 "properties": { 5949 "advertiseExternal": { 5950 "type": "boolean", 5951 "default": false 5952 }, 5953 "advertiseInterArea": { 5954 "type": "boolean", 5955 "default": true 5956 }, 5957 "advertiseIntraArea": { 5958 "type": "boolean", 5959 "default": true 5960 } 5961 } 5962 }, 5963 "bgp": { 5964 "type": "object", 5965 "required": [ 5966 "advertiseInternal", 5967 "advertiseExternal", 5968 "advertiseNeighborTags" 5969 ], 5970 "properties": { 5971 "advertiseInternal": { 5972 "type": "boolean", 5973 "default": true 5974 }, 5975 "advertiseExternal": { 5976 "type": "boolean", 5977 "default": false 5978 }, 5979 "advertiseNeighborTags": { 5980 "type": "object", 5981 "required": [ 5982 "UPLINK" 5983 ], 5984 "properties": { 5985 "UPLINK": { 5986 "type": "boolean" 5987 } 5988 } 5989 } 5990 } 5991 }, 5992 "assigned": { 5993 "type": "object", 5994 "required": [ 5995 "advertiseStatic", 5996 "advertiseConnected" 5997 ], 5998 "properties": { 5999 "advertiseStatic": { 6000 "type": "boolean", 6001 "default": true 6002 }, 6003 "advertiseConnected": { 6004 "type": "boolean", 6005 "default": true 6006 } 6007 } 6008 } 6009 } 6010 }, 6011 "hub": { 6012 "type": "object", 6013 "required": [ 6014 "ospf", 6015 "bgp", 6016 "assigned" 6017 ], 6018 "properties": { 6019 "ospf": { 6020 "type": "object", 6021 "required": [ 6022 "advertiseExternal", 6023 "advertiseInterArea", 6024 "advertiseIntraArea" 6025 ], 6026 "properties": { 6027 "advertiseExternal": { 6028 "type": "boolean", 6029 "default": false 6030 }, 6031 "advertiseInterArea": { 6032 "type": "boolean", 6033 "default": true 6034 }, 6035 "advertiseIntraArea": { 6036 "type": "boolean", 6037 "default": true 6038 } 6039 } 6040 }, 6041 "bgp": { 6042 "type": "object", 6043 "required": [ 6044 "advertiseInternal", 6045 "advertiseExternal", 6046 "advertiseNeighborTags" 6047 ], 6048 "properties": { 6049 "advertiseInternal": { 6050 "type": "boolean", 6051 "default": true 6052 }, 6053 "advertiseExternal": { 6054 "type": "boolean", 6055 "default": false 6056 }, 6057 "advertiseNeighborTags": { 6058 "type": "object", 6059 "required": [ 6060 "UPLINK" 6061 ], 6062 "properties": { 6063 "UPLINK": { 6064 "type": "boolean" 6065 } 6066 } 6067 } 6068 } 6069 }, 6070 "assigned": { 6071 "type": "object", 6072 "required": [ 6073 "advertiseStatic", 6074 "advertiseConnected" 6075 ], 6076 "properties": { 6077 "advertiseStatic": { 6078 "type": "boolean", 6079 "default": true 6080 }, 6081 "advertiseConnected": { 6082 "type": "boolean", 6083 "default": true 6084 } 6085 } 6086 } 6087 } 6088 }, 6089 "partnerGateway": { 6090 "type": "object", 6091 "required": [ 6092 "bgp", 6093 "assigned" 6094 ], 6095 "properties": { 6096 "bgp": { 6097 "type": "object", 6098 "required": [ 6099 "advertiseExternal" 6100 ], 6101 "properties": { 6102 "advertiseExternal": { 6103 "type": "boolean", 6104 "default": true 6105 } 6106 } 6107 }, 6108 "assigned": { 6109 "type": "object", 6110 "required": [ 6111 "advertiseStatic" 6112 ], 6113 "properties": { 6114 "advertiseStatic": { 6115 "type": "boolean", 6116 "default": true 6117 } 6118 } 6119 } 6120 } 6121 }, 6122 "routingPreference": { 6123 "type": "array", 6124 "items": { 6125 "type": "object", 6126 "required": [ 6127 "entity", 6128 "allow" 6129 ], 6130 "properties": { 6131 "entity": { 6132 "type": "string", 6133 "enum": [ 6134 "EDGE", 6135 "HUB", 6136 "ROUTER", 6137 "PARTNER" 6138 ] 6139 }, 6140 "allow": { 6141 "type": "boolean" 6142 } 6143 } 6144 } 6145 } 6146 } 6147 } 6148 } 6149 } 6150 } 6151 ], 6152 "responses": { 6153 "200": { 6154 "description": "Request was successfully processed", 6155 "schema": { 6156 "$ref": "#/definitions/enterprise_update_enterprise_route_configuration_result" 6157 } 6158 }, 6159 "400": { 6160 "$ref": "#/responses/generic_400" 6161 }, 6162 "500": { 6163 "$ref": "#/responses/generic_500" 6164 } 6165 } 6166 } 6167 }, 6168 "/enterprise/updateEnterpriseSecurityPolicy": { 6169 "post": { 6170 "summary": "Update enterprise security policy", 6171 "description": "Updates the security policy for the specified enterprise (by `enterpriseId`) using the passed in `ipsec` settings.\n\nPrivileges required:\n\n`UPDATE` `ENTERPRISE_PROFILE`", 6172 "tags": [ 6173 "enterprise", 6174 "all" 6175 ], 6176 "x-privileges": { 6177 "forceEnterpriseContext": true, 6178 "excludeAuthTypes": [], 6179 "allowAuthTypes": [ 6180 "ANY" 6181 ], 6182 "allowPrincipleTypes": [], 6183 "excludePrincipleTypes": [ 6184 "EDGE", 6185 "GATEWAY" 6186 ], 6187 "requirePrivileges": [ 6188 { 6189 "action": "UPDATE", 6190 "object": "ENTERPRISE_PROFILE" 6191 } 6192 ] 6193 }, 6194 "operationId": "enterprise_update_enterprise_security_policy", 6195 "parameters": [ 6196 { 6197 "name": "body", 6198 "in": "body", 6199 "required": true, 6200 "schema": { 6201 "type": "object", 6202 "title": "enterprise_update_enterprise_security_policy", 6203 "properties": { 6204 "enterpriseId": { 6205 "type": "integer" 6206 }, 6207 "ipsec": { 6208 "type": "object", 6209 "properties": { 6210 "hash": { 6211 "type": "string", 6212 "enum": [ 6213 "MD5", 6214 "SHA_1", 6215 "SHA_256" 6216 ] 6217 }, 6218 "encryption": { 6219 "type": "string", 6220 "enum": [ 6221 "AES_128_CBC", 6222 "AES_256_CBC" 6223 ] 6224 }, 6225 "diffieHellmanGroup": { 6226 "type": "string", 6227 "enum": [ 6228 "GROUP_2", 6229 "GROUP_5", 6230 "GROUP_14" 6231 ] 6232 }, 6233 "perfectForwardSecrecy": { 6234 "type": "string", 6235 "enum": [ 6236 "DISABLED", 6237 "GROUP_2", 6238 "GROUP_5" 6239 ] 6240 } 6241 } 6242 } 6243 } 6244 } 6245 } 6246 ], 6247 "responses": { 6248 "200": { 6249 "description": "Request was successfully processed", 6250 "schema": { 6251 "$ref": "#/definitions/enterprise_update_enterprise_security_policy_result" 6252 } 6253 }, 6254 "400": { 6255 "$ref": "#/responses/generic_400" 6256 }, 6257 "500": { 6258 "$ref": "#/responses/generic_500" 6259 } 6260 } 6261 } 6262 }, 6263 "/enterprise/updateEnterpriseService": { 6264 "post": { 6265 "summary": "Update enterprise network service", 6266 "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).\n\nPrivileges required:\n\n`UPDATE` `NETWORK_SERVICE`", 6267 "tags": [ 6268 "all", 6269 "enterprise" 6270 ], 6271 "x-privileges": { 6272 "excludeAuthTypes": [], 6273 "allowAuthTypes": [ 6274 "ANY" 6275 ], 6276 "allowPrincipleTypes": [], 6277 "excludePrincipleTypes": [ 6278 "EDGE", 6279 "GATEWAY" 6280 ], 6281 "requirePrivileges": [ 6282 { 6283 "action": "UPDATE", 6284 "object": "NETWORK_SERVICE" 6285 } 6286 ] 6287 }, 6288 "operationId": "enterprise_update_enterprise_service", 6289 "parameters": [ 6290 { 6291 "name": "body", 6292 "in": "body", 6293 "required": true, 6294 "schema": { 6295 "type": "object", 6296 "title": "enterprise_update_enterprise_service", 6297 "properties": { 6298 "enterpriseId": { 6299 "type": "integer" 6300 }, 6301 "id": { 6302 "type": "integer" 6303 }, 6304 "_update": { 6305 "type": "object", 6306 "properties": { 6307 "operatorAlertsEnabled": { 6308 "type": "integer" 6309 }, 6310 "alertsEnabled": { 6311 "type": "integer" 6312 }, 6313 "data": { 6314 "type": "object" 6315 }, 6316 "name": { 6317 "type": "string" 6318 }, 6319 "type": { 6320 "type": "string" 6321 } 6322 } 6323 } 6324 }, 6325 "required": [ 6326 "id", 6327 "_update" 6328 ] 6329 } 6330 } 6331 ], 6332 "responses": { 6333 "200": { 6334 "description": "Request was successfully processed", 6335 "schema": { 6336 "$ref": "#/definitions/enterprise_update_enterprise_service_result" 6337 } 6338 }, 6339 "400": { 6340 "$ref": "#/responses/generic_400" 6341 }, 6342 "500": { 6343 "$ref": "#/responses/generic_500" 6344 } 6345 } 6346 } 6347 }, 6348 "/enterpriseProxy/deleteEnterpriseProxyUser": { 6349 "post": { 6350 "tags": [ 6351 "all", 6352 "userMaintenance" 6353 ], 6354 "summary": "Delete partner admin user", 6355 "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.\n\nPrivileges required:\n\n`DELETE` `PROXY_USER`", 6356 "operationId": "enterprise_proxy_delete_enterprise_proxy_user", 6357 "x-privileges": { 6358 "excludeAuthTypes": [], 6359 "allowAuthTypes": [ 6360 "OPERATOR_USER", 6361 "MSP_USER" 6362 ], 6363 "allowPrincipleTypes": [], 6364 "excludePrincipleTypes": [ 6365 "EDGE", 6366 "GATEWAY" 6367 ], 6368 "requirePrivileges": [ 6369 { 6370 "action": "DELETE", 6371 "object": "PROXY_USER" 6372 } 6373 ] 6374 }, 6375 "parameters": [ 6376 { 6377 "name": "body", 6378 "in": "body", 6379 "required": true, 6380 "schema": { 6381 "type": "object", 6382 "title": "enterprise_proxy_delete_enterprise_proxy_user", 6383 "properties": { 6384 "enterpriseProxyId": { 6385 "type": "integer" 6386 }, 6387 "id": { 6388 "type": "integer" 6389 }, 6390 "username": { 6391 "type": "string" 6392 } 6393 } 6394 } 6395 } 6396 ], 6397 "responses": { 6398 "200": { 6399 "schema": { 6400 "$ref": "#/definitions/enterprise_proxy_delete_enterprise_proxy_user_result" 6401 }, 6402 "description": "Request was successfully processed" 6403 }, 6404 "400": { 6405 "$ref": "#/responses/generic_400" 6406 }, 6407 "500": { 6408 "$ref": "#/responses/generic_500" 6409 } 6410 } 6411 } 6412 }, 6413 "/enterpriseProxy/getEnterpriseProxyEdgeInventory": { 6414 "post": { 6415 "summary": "Get partner enterprises and associated Edge inventory", 6416 "description": "Gets all partner enterprises and their associated Edge inventory.\n\nPrivileges required:\n\n`READ` `ENTERPRISE`", 6417 "tags": [ 6418 "all", 6419 "enterpriseProxy" 6420 ], 6421 "x-privileges": { 6422 "excludeAuthTypes": [], 6423 "allowAuthTypes": [ 6424 "OPERATOR_USER", 6425 "MSP_USER" 6426 ], 6427 "allowPrincipleTypes": [], 6428 "excludePrincipleTypes": [ 6429 "EDGE", 6430 "GATEWAY" 6431 ], 6432 "requirePrivileges": [ 6433 { 6434 "action": "READ", 6435 "object": "ENTERPRISE" 6436 } 6437 ] 6438 }, 6439 "operationId": "enterprise_proxy_get_enterprise_proxy_edge_inventory", 6440 "parameters": [ 6441 { 6442 "name": "body", 6443 "in": "body", 6444 "required": true, 6445 "schema": { 6446 "type": "object", 6447 "title": "enterprise_proxy_get_enterprise_proxy_edge_inventory", 6448 "properties": { 6449 "enterpriseProxyId": { 6450 "type": "integer" 6451 } 6452 } 6453 } 6454 } 6455 ], 6456 "responses": { 6457 "200": { 6458 "schema": { 6459 "title": "enterprise_proxy_get_enterprise_proxy_edge_inventory_result", 6460 "type": "array", 6461 "items": { 6462 "$ref": "#/definitions/enterprise_proxy_get_enterprise_proxy_edge_inventory_result_item" 6463 } 6464 }, 6465 "description": "Request was successfully processed" 6466 }, 6467 "400": { 6468 "$ref": "#/responses/generic_400" 6469 }, 6470 "500": { 6471 "$ref": "#/responses/generic_500" 6472 } 6473 } 6474 } 6475 }, 6476 "/enterpriseProxy/getEnterpriseProxyEnterprises": { 6477 "post": { 6478 "summary": "Get partner enterprises", 6479 "description": "Gets all partner enterprises. Optionally includes all Edges or Edge counts.\n\nPrivileges required:\n\n`READ` `ENTERPRISE`", 6480 "tags": [ 6481 "all", 6482 "enterpriseProxy" 6483 ], 6484 "x-privileges": { 6485 "excludeAuthTypes": [], 6486 "allowAuthTypes": [ 6487 "OPERATOR_USER", 6488 "MSP_USER" 6489 ], 6490 "allowPrincipleTypes": [], 6491 "excludePrincipleTypes": [ 6492 "EDGE", 6493 "GATEWAY" 6494 ], 6495 "requirePrivileges": [ 6496 { 6497 "action": "READ", 6498 "object": "ENTERPRISE" 6499 } 6500 ] 6501 }, 6502 "operationId": "enterprise_proxy_get_enterprise_proxy_enterprises", 6503 "parameters": [ 6504 { 6505 "name": "body", 6506 "in": "body", 6507 "required": true, 6508 "schema": { 6509 "type": "object", 6510 "title": "enterprise_proxy_get_enterprise_proxy_enterprises", 6511 "properties": { 6512 "enterpriseProxyId": { 6513 "type": "integer" 6514 }, 6515 "with": { 6516 "type": "array", 6517 "items": { 6518 "type": "string", 6519 "enum": [ 6520 "edges", 6521 "edgeCount" 6522 ] 6523 } 6524 } 6525 } 6526 } 6527 } 6528 ], 6529 "responses": { 6530 "200": { 6531 "schema": { 6532 "title": "enterprise_proxy_get_enterprise_proxy_enterprises_result", 6533 "type": "array", 6534 "items": { 6535 "$ref": "#/definitions/enterprise_proxy_get_enterprise_proxy_enterprises_result_item" 6536 } 6537 }, 6538 "description": "Request was successfully processed" 6539 }, 6540 "400": { 6541 "$ref": "#/responses/generic_400" 6542 }, 6543 "500": { 6544 "$ref": "#/responses/generic_500" 6545 } 6546 } 6547 } 6548 }, 6549 "/enterpriseProxy/getEnterpriseProxyGatewayPools": { 6550 "post": { 6551 "summary": "Get gateway pools", 6552 "tags": [ 6553 "all", 6554 "enterpriseProxy" 6555 ], 6556 "description": "Gets all gateway pools associated with the specified enterprise proxy. Optionally includes all gateways or enterprises belonging to each pool.\n\nPrivileges required:\n\n`READ` `GATEWAY`", 6557 "operationId": "enterprise_proxy_get_enterprise_proxy_gateway_pools", 6558 "x-privileges": { 6559 "excludeAuthTypes": [], 6560 "allowAuthTypes": [ 6561 "OPERATOR_USER", 6562 "MSP_USER" 6563 ], 6564 "allowPrincipleTypes": [], 6565 "excludePrincipleTypes": [ 6566 "EDGE", 6567 "GATEWAY" 6568 ], 6569 "requirePrivileges": [ 6570 { 6571 "action": "READ", 6572 "object": "GATEWAY" 6573 } 6574 ] 6575 }, 6576 "parameters": [ 6577 { 6578 "name": "body", 6579 "in": "body", 6580 "required": true, 6581 "schema": { 6582 "type": "object", 6583 "title": "enterprise_proxy_get_enterprise_proxy_gateway_pools", 6584 "properties": { 6585 "id": { 6586 "type": "integer" 6587 }, 6588 "enterpriseProxyId": { 6589 "type": "integer" 6590 }, 6591 "with": { 6592 "type": "array", 6593 "items": { 6594 "type": "string", 6595 "enum": [ 6596 "gateways", 6597 "enterprises" 6598 ] 6599 } 6600 } 6601 } 6602 } 6603 } 6604 ], 6605 "responses": { 6606 "200": { 6607 "description": "Request was successfully processed", 6608 "schema": { 6609 "title": "enterprise_proxy_get_enterprise_proxy_gateway_pools_result", 6610 "type": "array", 6611 "items": { 6612 "$ref": "#/definitions/enterprise_proxy_get_enterprise_proxy_gateway_pools_result_item" 6613 } 6614 } 6615 }, 6616 "400": { 6617 "$ref": "#/responses/generic_400" 6618 }, 6619 "500": { 6620 "$ref": "#/responses/generic_500" 6621 } 6622 } 6623 } 6624 }, 6625 "/enterpriseProxy/getEnterpriseProxyGateways": { 6626 "post": { 6627 "summary": "Get gateways for enterprise proxy", 6628 "description": "Gets all gateways associated with the specified enterprise proxy.\n\nPrivileges required:\n\n`READ` `GATEWAY`", 6629 "tags": [ 6630 "enterpriseProxy", 6631 "all" 6632 ], 6633 "operationId": "enterprise_proxy_get_enterprise_proxy_gateways", 6634 "x-privileges": { 6635 "excludeAuthTypes": [], 6636 "allowAuthTypes": [ 6637 "OPERATOR_USER", 6638 "MSP_USER" 6639 ], 6640 "allowPrincipleTypes": [], 6641 "excludePrincipleTypes": [ 6642 "EDGE", 6643 "GATEWAY" 6644 ], 6645 "requirePrivileges": [ 6646 { 6647 "action": "READ", 6648 "object": "GATEWAY" 6649 } 6650 ] 6651 }, 6652 "parameters": [ 6653 { 6654 "name": "body", 6655 "in": "body", 6656 "required": true, 6657 "schema": { 6658 "type": "object", 6659 "title": "enterprise_proxy_get_enterprise_proxy_gateways", 6660 "properties": { 6661 "enterpriseProxyId": { 6662 "type": "integer" 6663 }, 6664 "with": { 6665 "type": "array", 6666 "items": { 6667 "type": "string", 6668 "enum": [ 6669 "site", 6670 "roles", 6671 "pools", 6672 "dataCenters", 6673 "certificates", 6674 "enterprises", 6675 "handOffEdges", 6676 "enterpriseAssociations", 6677 "enterpriseAssociationCounts" 6678 ] 6679 } 6680 } 6681 } 6682 } 6683 } 6684 ], 6685 "responses": { 6686 "200": { 6687 "schema": { 6688 "title": "enterprise_proxy_get_enterprise_proxy_gateways_result", 6689 "type": "array", 6690 "items": { 6691 "$ref": "#/definitions/enterprise_proxy_get_enterprise_proxy_gateways_result_item" 6692 } 6693 }, 6694 "description": "Request was successfully processed" 6695 }, 6696 "400": { 6697 "$ref": "#/responses/generic_400" 6698 }, 6699 "500": { 6700 "$ref": "#/responses/generic_500" 6701 } 6702 } 6703 } 6704 }, 6705 "/enterpriseProxy/getEnterpriseProxyOperatorProfiles": { 6706 "post": { 6707 "summary": "Get partner operator profiles", 6708 "description": "Gets all operator profiles associated with the specified partner (MSP), as assigned by the operator.\n\nPrivileges required:\n\n`READ` `OPERATOR_PROFILE`", 6709 "tags": [ 6710 "all", 6711 "enterpriseProxy" 6712 ], 6713 "x-privileges": { 6714 "excludeAuthTypes": [], 6715 "allowAuthTypes": [ 6716 "OPERATOR_USER", 6717 "MSP_USER" 6718 ], 6719 "allowPrincipleTypes": [], 6720 "excludePrincipleTypes": [ 6721 "EDGE", 6722 "GATEWAY" 6723 ], 6724 "requirePrivileges": [ 6725 { 6726 "action": "READ", 6727 "object": "OPERATOR_PROFILE" 6728 } 6729 ] 6730 }, 6731 "operationId": "enterprise_proxy_get_enterprise_proxy_operator_profiles", 6732 "parameters": [ 6733 { 6734 "name": "body", 6735 "in": "body", 6736 "required": true, 6737 "schema": { 6738 "type": "object", 6739 "title": "enterprise_proxy_get_enterprise_proxy_operator_profiles", 6740 "properties": { 6741 "enterpriseProxyId": { 6742 "type": "integer" 6743 }, 6744 "with": { 6745 "type": "array", 6746 "items": { 6747 "type": "string", 6748 "enum": [ 6749 "edges", 6750 "edgeCount", 6751 "modules", 6752 "enterprises" 6753 ] 6754 } 6755 } 6756 } 6757 } 6758 } 6759 ], 6760 "responses": { 6761 "200": { 6762 "schema": { 6763 "title": "enterprise_proxy_get_enterprise_proxy_operator_profiles_result", 6764 "type": "array", 6765 "items": { 6766 "$ref": "#/definitions/enterprise_proxy_get_enterprise_proxy_operator_profiles_result_item" 6767 } 6768 }, 6769 "description": "Request was successfully processed" 6770 }, 6771 "400": { 6772 "$ref": "#/responses/generic_400" 6773 }, 6774 "500": { 6775 "$ref": "#/responses/generic_500" 6776 } 6777 } 6778 } 6779 }, 6780 "/enterprise/getEnterpriseProxyProperty": { 6781 "post": { 6782 "summary": "Get enterprise proxy property", 6783 "description": "Get a enterprise proxy property by object id or other attribute.\n\nPrivileges required:\n\n`READ` `PROXY`", 6784 "operationId": "enterprise_proxy_get_enterprise_proxy_property", 6785 "x-privileges": { 6786 "excludeAuthTypes": [], 6787 "allowAuthTypes": [ 6788 "OPERATOR_USER", 6789 "MSP_USER" 6790 ], 6791 "allowPrincipleTypes": [], 6792 "excludePrincipleTypes": [ 6793 "EDGE", 6794 "GATEWAY" 6795 ], 6796 "requirePrivileges": [ 6797 { 6798 "action": "READ", 6799 "object": "PROXY" 6800 } 6801 ] 6802 }, 6803 "tags": [ 6804 "enterprise", 6805 "all" 6806 ], 6807 "parameters": [ 6808 { 6809 "name": "body", 6810 "in": "body", 6811 "required": true, 6812 "schema": { 6813 "type": "object", 6814 "title": "enterprise_proxy_get_enterprise_proxy_property", 6815 "properties": { 6816 "enterpriseId": { 6817 "type": "integer" 6818 }, 6819 "name": { 6820 "type": "string" 6821 }, 6822 "id": { 6823 "type": "integer" 6824 } 6825 } 6826 } 6827 } 6828 ], 6829 "responses": { 6830 "200": { 6831 "schema": { 6832 "$ref": "#/definitions/enterprise_proxy_get_enterprise_proxy_property_result" 6833 }, 6834 "description": "Request was successfully processed" 6835 }, 6836 "400": { 6837 "$ref": "#/responses/generic_400" 6838 }, 6839 "500": { 6840 "$ref": "#/responses/generic_500" 6841 } 6842 } 6843 } 6844 }, 6845 "/enterpriseProxy/getEnterpriseProxyUser": { 6846 "post": { 6847 "tags": [ 6848 "all", 6849 "userMaintenance" 6850 ], 6851 "summary": "Get enterprise proxy user", 6852 "description": "Gets the specified enterprise proxy user (by `id` or `username`).\n\nPrivileges required:\n\n`READ` `PROXY_USER`\n\n`READ` `PROXY`", 6853 "operationId": "enterprise_proxy_get_enterprise_proxy_user", 6854 "x-privileges": { 6855 "excludeAuthTypes": [], 6856 "allowAuthTypes": [ 6857 "ANY" 6858 ], 6859 "allowPrincipleTypes": [], 6860 "excludePrincipleTypes": [ 6861 "EDGE", 6862 "GATEWAY" 6863 ], 6864 "allowPrivilegeToSelf": "MSP_USER", 6865 "requirePrivileges": [ 6866 { 6867 "action": "READ", 6868 "object": "PROXY_USER" 6869 }, 6870 { 6871 "action": "READ", 6872 "object": "PROXY" 6873 } 6874 ] 6875 }, 6876 "parameters": [ 6877 { 6878 "name": "body", 6879 "in": "body", 6880 "required": true, 6881 "schema": { 6882 "type": "object", 6883 "title": "enterprise_proxy_get_enterprise_proxy_user", 6884 "properties": { 6885 "id": { 6886 "type": "integer" 6887 }, 6888 "username": { 6889 "type": "string" 6890 } 6891 } 6892 } 6893 } 6894 ], 6895 "responses": { 6896 "200": { 6897 "schema": { 6898 "$ref": "#/definitions/enterprise_proxy_get_enterprise_proxy_user_result" 6899 }, 6900 "description": "Request was successfully processed" 6901 }, 6902 "400": { 6903 "$ref": "#/responses/generic_400" 6904 }, 6905 "500": { 6906 "$ref": "#/responses/generic_500" 6907 } 6908 } 6909 } 6910 }, 6911 "/enterpriseProxy/getEnterpriseProxyUsers": { 6912 "post": { 6913 "tags": [ 6914 "userMaintenance", 6915 "all" 6916 ], 6917 "summary": "Get enterprise proxy admin users", 6918 "description": "Gets all proxy admin users for the specified enterprise.\n\nPrivileges required:\n\n`READ` `ENTERPRISE`\n\n`READ` `PROXY_USER`", 6919 "operationId": "enterprise_proxy_get_enterprise_proxy_users", 6920 "x-privileges": { 6921 "excludeAuthTypes": [], 6922 "allowAuthTypes": [ 6923 "OPERATOR_USER", 6924 "MSP_USER" 6925 ], 6926 "allowPrincipleTypes": [], 6927 "excludePrincipleTypes": [ 6928 "EDGE", 6929 "GATEWAY" 6930 ], 6931 "requirePrivileges": [ 6932 { 6933 "action": "READ", 6934 "object": "ENTERPRISE" 6935 }, 6936 { 6937 "action": "READ", 6938 "object": "PROXY_USER" 6939 } 6940 ] 6941 }, 6942 "parameters": [ 6943 { 6944 "name": "body", 6945 "in": "body", 6946 "required": true, 6947 "schema": { 6948 "type": "object", 6949 "title": "enterprise_proxy_get_enterprise_proxy_users", 6950 "properties": { 6951 "enterpriseProxyId": { 6952 "type": "integer" 6953 }, 6954 "id": { 6955 "type": "integer" 6956 } 6957 } 6958 } 6959 } 6960 ], 6961 "responses": { 6962 "200": { 6963 "schema": { 6964 "type": "array", 6965 "items": { 6966 "$ref": "#/definitions/enterprise_proxy_get_enterprise_proxy_users_result_item" 6967 } 6968 }, 6969 "description": "Request was successfully processed" 6970 }, 6971 "400": { 6972 "$ref": "#/responses/generic_400" 6973 }, 6974 "500": { 6975 "$ref": "#/responses/generic_500" 6976 } 6977 } 6978 } 6979 }, 6980 "/enterpriseProxy/insertEnterpriseProxyEnterprise": { 6981 "post": { 6982 "summary": "Create enterprise owned by MSP", 6983 "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.\n\nPrivileges required:\n\n`CREATE` `ENTERPRISE`", 6984 "tags": [ 6985 "enterpriseProxy", 6986 "all" 6987 ], 6988 "operationId": "enterprise_proxy_insert_enterprise_proxy_enterprise", 6989 "x-privileges": { 6990 "excludeAuthTypes": [], 6991 "allowAuthTypes": [ 6992 "OPERATOR_USER", 6993 "MSP_USER" 6994 ], 6995 "allowPrincipleTypes": [], 6996 "excludePrincipleTypes": [ 6997 "EDGE", 6998 "GATEWAY" 6999 ], 7000 "requirePrivileges": [ 7001 { 7002 "action": "CREATE", 7003 "object": "ENTERPRISE" 7004 } 7005 ] 7006 }, 7007 "parameters": [ 7008 { 7009 "name": "body", 7010 "in": "body", 7011 "required": true, 7012 "schema": { 7013 "$ref": "#/definitions/enterprise_proxy_insert_enterprise_proxy_enterprise" 7014 } 7015 } 7016 ], 7017 "responses": { 7018 "200": { 7019 "description": "Request was successfully processed", 7020 "schema": { 7021 "$ref": "#/definitions/enterprise_proxy_insert_enterprise_proxy_enterprise_result" 7022 } 7023 }, 7024 "400": { 7025 "$ref": "#/responses/generic_400" 7026 }, 7027 "500": { 7028 "$ref": "#/responses/generic_500" 7029 } 7030 } 7031 } 7032 }, 7033 "/enterpriseProxy/insertEnterpriseProxyUser": { 7034 "post": { 7035 "tags": [ 7036 "all", 7037 "userMaintenance" 7038 ], 7039 "summary": "Create partner admin user", 7040 "description": "Creates a new partner admin user.\n\nPrivileges required:\n\n`CREATE` `PROXY_USER`", 7041 "operationId": "enterprise_proxy_insert_enterprise_proxy_user", 7042 "x-privileges": { 7043 "excludeAuthTypes": [], 7044 "allowAuthTypes": [ 7045 "MSP_USER", 7046 "OPERATOR_USER" 7047 ], 7048 "allowPrincipleTypes": [], 7049 "excludePrincipleTypes": [ 7050 "EDGE", 7051 "GATEWAY" 7052 ], 7053 "requirePrivileges": [ 7054 { 7055 "action": "CREATE", 7056 "object": "PROXY_USER" 7057 } 7058 ] 7059 }, 7060 "parameters": [ 7061 { 7062 "name": "body", 7063 "in": "body", 7064 "required": true, 7065 "schema": { 7066 "$ref": "#/definitions/new_enterprise_proxy_user" 7067 } 7068 } 7069 ], 7070 "responses": { 7071 "200": { 7072 "schema": { 7073 "$ref": "#/definitions/enterprise_proxy_insert_enterprise_proxy_user_result" 7074 }, 7075 "description": "Request was successfully processed" 7076 }, 7077 "400": { 7078 "$ref": "#/responses/generic_400" 7079 }, 7080 "500": { 7081 "$ref": "#/responses/generic_500" 7082 } 7083 } 7084 } 7085 }, 7086 "/enterpriseProxy/insertOrUpdateEnterpriseProxyProperty": { 7087 "post": { 7088 "summary": "Insert or update an enterprise proxy (MSP) property", 7089 "description": "Insert a enterprise proxy property. If property with the given name already exists, the property will be updated.\n\nPrivileges required:\n\n`UPDATE` `PROXY`", 7090 "operationId": "enterprise_proxy_insert_or_update_enterprise_proxy_property", 7091 "x-privileges": { 7092 "excludeAuthTypes": [], 7093 "allowAuthTypes": [ 7094 "OPERATOR_USER", 7095 null 7096 ], 7097 "allowPrincipleTypes": [], 7098 "excludePrincipleTypes": [ 7099 "EDGE", 7100 "GATEWAY" 7101 ], 7102 "requirePrivileges": [ 7103 { 7104 "action": "UPDATE", 7105 "object": "PROXY" 7106 } 7107 ] 7108 }, 7109 "tags": [ 7110 "enterpriseProxy", 7111 "all" 7112 ], 7113 "parameters": [ 7114 { 7115 "name": "body", 7116 "in": "body", 7117 "required": true, 7118 "schema": { 7119 "type": "object", 7120 "title": "enterprise_proxy_insert_or_update_enterprise_proxy_property", 7121 "properties": { 7122 "enterpriseProxyId": { 7123 "type": "integer" 7124 }, 7125 "name": { 7126 "type": "string" 7127 }, 7128 "value": { 7129 "type": "string" 7130 }, 7131 "dataType": { 7132 "type": "string", 7133 "enum": [ 7134 "STRING", 7135 "NUMBER", 7136 "BOOLEAN", 7137 "JSON", 7138 "DATE", 7139 "DATETIME" 7140 ] 7141 }, 7142 "isPassword": { 7143 "type": "boolean" 7144 }, 7145 "description": { 7146 "type": "string" 7147 } 7148 }, 7149 "required": [ 7150 "enterpriseProxyId", 7151 "name", 7152 "value" 7153 ], 7154 "example": { 7155 "enterpriseProxyId": 1532, 7156 "name": "vco.enterprise.proxy.authentication.twoFactor.enable", 7157 "dataType": "BOOLEAN", 7158 "value": "true" 7159 } 7160 } 7161 } 7162 ], 7163 "responses": { 7164 "200": { 7165 "schema": { 7166 "$ref": "#/definitions/enterprise_proxy_insert_or_update_enterprise_proxy_property_result" 7167 }, 7168 "description": "Request was successfully processed" 7169 }, 7170 "400": { 7171 "$ref": "#/responses/generic_400" 7172 }, 7173 "500": { 7174 "$ref": "#/responses/generic_500" 7175 } 7176 } 7177 } 7178 }, 7179 "/enterpriseProxy/updateEnterpriseProxyUser": { 7180 "post": { 7181 "tags": [ 7182 "all", 7183 "userMaintenance" 7184 ], 7185 "summary": "Update enterprise proxy admin user", 7186 "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).\n\nPrivileges required:\n\n`UPDATE` `PROXY_USER`", 7187 "operationId": "enterprise_proxy_update_enterprise_proxy_user", 7188 "x-privileges": { 7189 "excludeAuthTypes": [], 7190 "allowAuthTypes": [ 7191 "OPERATOR_USER", 7192 "MSP_USER" 7193 ], 7194 "allowPrincipleTypes": [], 7195 "excludePrincipleTypes": [ 7196 "EDGE", 7197 "GATEWAY" 7198 ], 7199 "allowPrivilegeToSelf": "MSP_USER", 7200 "requirePrivileges": [ 7201 { 7202 "action": "UPDATE", 7203 "object": "PROXY_USER" 7204 } 7205 ] 7206 }, 7207 "parameters": [ 7208 { 7209 "name": "body", 7210 "in": "body", 7211 "required": true, 7212 "schema": { 7213 "type": "object", 7214 "title": "enterprise_proxy_update_enterprise_proxy_user", 7215 "properties": { 7216 "_update": { 7217 "$ref": "#/definitions/enterprise_user_with_role_info" 7218 }, 7219 "id": { 7220 "type": "integer" 7221 }, 7222 "enterpriseProxyId": { 7223 "type": "integer" 7224 }, 7225 "username": { 7226 "type": "string" 7227 } 7228 }, 7229 "required": [ 7230 "_update" 7231 ] 7232 } 7233 } 7234 ], 7235 "responses": { 7236 "200": { 7237 "schema": { 7238 "$ref": "#/definitions/enterprise_proxy_update_enterprise_proxy_user_result" 7239 }, 7240 "description": "Request was successfully processed" 7241 }, 7242 "400": { 7243 "$ref": "#/responses/generic_400" 7244 }, 7245 "500": { 7246 "$ref": "#/responses/generic_500" 7247 } 7248 } 7249 } 7250 }, 7251 "/enterpriseUser/deleteEnterpriseUser": { 7252 "post": { 7253 "tags": [ 7254 "all", 7255 "userMaintenance" 7256 ], 7257 "summary": "Delete enterprise user", 7258 "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.\n\nPrivileges required:\n\n`DELETE` `ENTERPRISE_USER`", 7259 "operationId": "enterprise_user_delete_enterprise_user", 7260 "x-privileges": { 7261 "excludeAuthTypes": [], 7262 "allowAuthTypes": [ 7263 "ANY" 7264 ], 7265 "allowPrincipleTypes": [], 7266 "excludePrincipleTypes": [ 7267 "EDGE", 7268 "GATEWAY" 7269 ], 7270 "requirePrivileges": [ 7271 { 7272 "action": "DELETE", 7273 "object": "ENTERPRISE_USER" 7274 } 7275 ] 7276 }, 7277 "parameters": [ 7278 { 7279 "name": "body", 7280 "in": "body", 7281 "required": true, 7282 "schema": { 7283 "type": "object", 7284 "title": "enterprise_user_delete_enterprise_user", 7285 "properties": { 7286 "id": { 7287 "type": "integer" 7288 }, 7289 "enterpriseId": { 7290 "type": "integer" 7291 }, 7292 "username": { 7293 "type": "string" 7294 } 7295 } 7296 } 7297 } 7298 ], 7299 "responses": { 7300 "200": { 7301 "schema": { 7302 "$ref": "#/definitions/enterprise_user_delete_enterprise_user_result" 7303 }, 7304 "description": "Request was successfully processed" 7305 }, 7306 "400": { 7307 "$ref": "#/responses/generic_400" 7308 }, 7309 "500": { 7310 "$ref": "#/responses/generic_500" 7311 } 7312 } 7313 } 7314 }, 7315 "/enterpriseUser/getEnterpriseUser": { 7316 "post": { 7317 "tags": [ 7318 "all", 7319 "userMaintenance" 7320 ], 7321 "summary": "Get enterprise user", 7322 "description": "Gets the specified enterprise user (by `id` or `username`).\n\nPrivileges required:\n\n`READ` `ENTERPRISE_USER`", 7323 "operationId": "enterprise_user_get_enterprise_user", 7324 "x-privileges": { 7325 "excludeAuthTypes": [], 7326 "allowAuthTypes": [ 7327 "ANY" 7328 ], 7329 "allowPrincipleTypes": [], 7330 "excludePrincipleTypes": [ 7331 "EDGE", 7332 "GATEWAY" 7333 ], 7334 "allowPrivilegeToSelf": "ENTERPRISE_USER", 7335 "requirePrivileges": [ 7336 { 7337 "action": "READ", 7338 "object": "ENTERPRISE_USER" 7339 } 7340 ] 7341 }, 7342 "parameters": [ 7343 { 7344 "name": "body", 7345 "in": "body", 7346 "required": true, 7347 "schema": { 7348 "type": "object", 7349 "title": "enterprise_user_get_enterprise_user", 7350 "properties": { 7351 "id": { 7352 "type": "integer" 7353 }, 7354 "username": { 7355 "type": "string" 7356 } 7357 } 7358 } 7359 } 7360 ], 7361 "responses": { 7362 "200": { 7363 "schema": { 7364 "$ref": "#/definitions/enterprise_user_get_enterprise_user_result" 7365 }, 7366 "description": "Request was successfully processed" 7367 }, 7368 "400": { 7369 "$ref": "#/responses/generic_400" 7370 }, 7371 "500": { 7372 "$ref": "#/responses/generic_500" 7373 } 7374 } 7375 } 7376 }, 7377 "/enterpriseUser/updateEnterpriseUser": { 7378 "post": { 7379 "tags": [ 7380 "all", 7381 "userMaintenance" 7382 ], 7383 "summary": "Update enterprise user", 7384 "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).\n\nPrivileges required:\n\n`UPDATE` `ENTERPRISE_USER`, or\n\n`UPDATE` `OPERATOR_USER`", 7385 "operationId": "enterprise_user_update_enterprise_user", 7386 "x-privileges": { 7387 "excludeAuthTypes": [], 7388 "allowAuthTypes": [ 7389 "ANY" 7390 ], 7391 "allowPrincipleTypes": [], 7392 "excludePrincipleTypes": [ 7393 "EDGE", 7394 "GATEWAY" 7395 ], 7396 "allowPrivilegeToSelf": "ENTERPRISE_USER", 7397 "requirePrivileges": [ 7398 { 7399 "action": "UPDATE", 7400 "object": "ENTERPRISE_USER", 7401 "sufficient": true 7402 }, 7403 { 7404 "action": "UPDATE", 7405 "object": "OPERATOR_USER", 7406 "sufficient": true 7407 } 7408 ] 7409 }, 7410 "parameters": [ 7411 { 7412 "name": "body", 7413 "in": "body", 7414 "required": true, 7415 "schema": { 7416 "type": "object", 7417 "title": "enterprise_user_update_enterprise_user", 7418 "properties": { 7419 "_update": { 7420 "$ref": "#/definitions/enterprise_user_update_enterprise_user" 7421 }, 7422 "id": { 7423 "type": "integer" 7424 }, 7425 "enterpriseId": { 7426 "type": "integer" 7427 }, 7428 "username": { 7429 "type": "string" 7430 } 7431 }, 7432 "required": [ 7433 "_update" 7434 ] 7435 } 7436 } 7437 ], 7438 "responses": { 7439 "200": { 7440 "schema": { 7441 "$ref": "#/definitions/enterprise_user_update_enterprise_user_result" 7442 }, 7443 "description": "Request was successfully processed" 7444 }, 7445 "400": { 7446 "$ref": "#/responses/generic_400" 7447 }, 7448 "500": { 7449 "$ref": "#/responses/generic_500" 7450 } 7451 } 7452 } 7453 }, 7454 "/event/getEnterpriseEvents": { 7455 "post": { 7456 "summary": "Get Edge events", 7457 "description": "Gets Edge events in an enterprise or Edge context. Returns an array of Edge events sorted by `eventTime`..\n\nPrivileges required:\n\n`READ` `ENTERPRISE_EVENT`", 7458 "tags": [ 7459 "event", 7460 "all" 7461 ], 7462 "x-privileges": { 7463 "excludeAuthTypes": [], 7464 "allowAuthTypes": [ 7465 "ANY" 7466 ], 7467 "allowPrincipleTypes": [], 7468 "excludePrincipleTypes": [ 7469 "EDGE", 7470 "GATEWAY" 7471 ], 7472 "requirePrivileges": [ 7473 { 7474 "action": "READ", 7475 "object": "ENTERPRISE_EVENT" 7476 } 7477 ] 7478 }, 7479 "operationId": "event_get_enterprise_events", 7480 "parameters": [ 7481 { 7482 "name": "body", 7483 "in": "body", 7484 "required": true, 7485 "schema": { 7486 "type": "object", 7487 "title": "event_get_enterprise_events", 7488 "properties": { 7489 "enterpriseId": { 7490 "type": "integer" 7491 }, 7492 "interval": { 7493 "$ref": "#/definitions/interval" 7494 }, 7495 "filter": { 7496 "title": "filter", 7497 "type": "object", 7498 "properties": { 7499 "limit": { 7500 "type": "integer", 7501 "default": 2048 7502 }, 7503 "rules": { 7504 "type": "array", 7505 "items": { 7506 "type": "object", 7507 "properties": { 7508 "field": { 7509 "type": "string", 7510 "enum": [ 7511 "event", 7512 "edgeName", 7513 "user", 7514 "severity", 7515 "message", 7516 "detail", 7517 "segmentName" 7518 ] 7519 }, 7520 "op": { 7521 "type": "string", 7522 "enum": [ 7523 "is", 7524 "is not", 7525 "startsWith", 7526 "notStartsWith", 7527 "endsWith", 7528 "notEndsWith", 7529 "contains", 7530 "notContains" 7531 ] 7532 }, 7533 "values": { 7534 "type": "array", 7535 "items": { 7536 "type": "string" 7537 } 7538 } 7539 } 7540 } 7541 } 7542 } 7543 }, 7544 "edgeId": { 7545 "type": "array", 7546 "items": { 7547 "type": "integer" 7548 } 7549 } 7550 } 7551 } 7552 } 7553 ], 7554 "responses": { 7555 "200": { 7556 "description": "Request was successfully processed", 7557 "schema": { 7558 "$ref": "#/definitions/event_get_enterprise_events_result" 7559 } 7560 }, 7561 "400": { 7562 "$ref": "#/responses/generic_400" 7563 }, 7564 "500": { 7565 "$ref": "#/responses/generic_500" 7566 } 7567 } 7568 } 7569 }, 7570 "/event/getOperatorEvents": { 7571 "post": { 7572 "summary": "Get operator events", 7573 "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.\n\nPrivileges required:\n\n`READ` `OPERATOR_EVENT`", 7574 "tags": [ 7575 "event", 7576 "all" 7577 ], 7578 "x-privileges": { 7579 "excludeAuthTypes": [], 7580 "allowAuthTypes": [ 7581 "OPERATOR_USER" 7582 ], 7583 "allowPrincipleTypes": [], 7584 "excludePrincipleTypes": [ 7585 "EDGE", 7586 "GATEWAY" 7587 ], 7588 "requirePrivileges": [ 7589 { 7590 "action": "READ", 7591 "object": "OPERATOR_EVENT" 7592 } 7593 ] 7594 }, 7595 "operationId": "event_get_operator_events", 7596 "parameters": [ 7597 { 7598 "name": "body", 7599 "in": "body", 7600 "required": true, 7601 "schema": { 7602 "type": "object", 7603 "title": "event_get_operator_events", 7604 "properties": { 7605 "networkId": { 7606 "type": "integer" 7607 }, 7608 "interval": { 7609 "$ref": "#/definitions/interval" 7610 }, 7611 "filter": { 7612 "title": "filter", 7613 "type": "object", 7614 "properties": { 7615 "limit": { 7616 "type": "integer", 7617 "default": 2048 7618 }, 7619 "rules": { 7620 "type": "array", 7621 "items": { 7622 "type": "object", 7623 "properties": { 7624 "field": { 7625 "type": "string", 7626 "enum": [ 7627 "event", 7628 "gatewayName", 7629 "user", 7630 "severity", 7631 "message" 7632 ] 7633 }, 7634 "op": { 7635 "type": "string", 7636 "enum": [ 7637 "is", 7638 "is not", 7639 "startsWith", 7640 "notStartsWith", 7641 "endsWith", 7642 "notEndsWith", 7643 "contains", 7644 "notContains" 7645 ] 7646 }, 7647 "values": { 7648 "type": "array", 7649 "items": { 7650 "type": "string" 7651 } 7652 } 7653 } 7654 } 7655 } 7656 } 7657 }, 7658 "gatewayId": { 7659 "type": "array", 7660 "items": { 7661 "type": "integer" 7662 } 7663 } 7664 } 7665 } 7666 } 7667 ], 7668 "responses": { 7669 "200": { 7670 "schema": { 7671 "$ref": "#/definitions/event_get_operator_events_result" 7672 }, 7673 "description": "Request was successfully processed" 7674 }, 7675 "400": { 7676 "$ref": "#/responses/generic_400" 7677 }, 7678 "500": { 7679 "$ref": "#/responses/generic_500" 7680 } 7681 } 7682 } 7683 }, 7684 "/event/getProxyEvents": { 7685 "post": { 7686 "summary": "Fetch Partner events", 7687 "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.\n\nPrivileges required:\n\n`READ` `PROXY_EVENT`", 7688 "tags": [ 7689 "event", 7690 "all" 7691 ], 7692 "x-privileges": { 7693 "excludeAuthTypes": [], 7694 "allowAuthTypes": [ 7695 "MSP_USER", 7696 "OPERATOR_USER" 7697 ], 7698 "allowPrincipleTypes": [], 7699 "excludePrincipleTypes": [ 7700 "EDGE", 7701 "GATEWAY" 7702 ], 7703 "requirePrivileges": [ 7704 { 7705 "action": "READ", 7706 "object": "PROXY_EVENT" 7707 } 7708 ] 7709 }, 7710 "operationId": "event_get_proxy_events", 7711 "parameters": [ 7712 { 7713 "name": "body", 7714 "in": "body", 7715 "required": true, 7716 "schema": { 7717 "type": "object", 7718 "title": "event_get_proxy_events", 7719 "properties": { 7720 "interval": { 7721 "$ref": "#/definitions/interval" 7722 }, 7723 "filter": { 7724 "title": "filter", 7725 "type": "object", 7726 "properties": { 7727 "limit": { 7728 "type": "integer", 7729 "default": 2048 7730 }, 7731 "rules": { 7732 "type": "array", 7733 "items": { 7734 "type": "object", 7735 "properties": { 7736 "field": { 7737 "type": "string", 7738 "enum": [ 7739 "event", 7740 "gatewayName", 7741 "user", 7742 "severity", 7743 "message" 7744 ] 7745 }, 7746 "op": { 7747 "type": "string", 7748 "enum": [ 7749 "is", 7750 "is not", 7751 "startsWith", 7752 "notStartsWith", 7753 "endsWith", 7754 "notEndsWith", 7755 "contains", 7756 "notContains" 7757 ] 7758 }, 7759 "values": { 7760 "type": "array", 7761 "items": { 7762 "type": "string" 7763 } 7764 } 7765 } 7766 } 7767 } 7768 } 7769 }, 7770 "enterpriseId": { 7771 "type": "array", 7772 "items": { 7773 "type": "integer" 7774 } 7775 } 7776 } 7777 } 7778 } 7779 ], 7780 "responses": { 7781 "200": { 7782 "schema": { 7783 "$ref": "#/definitions/event_get_proxy_events_result" 7784 }, 7785 "description": "Request was successfully processed" 7786 }, 7787 "400": { 7788 "$ref": "#/responses/generic_400" 7789 }, 7790 "500": { 7791 "$ref": "#/responses/generic_500" 7792 } 7793 } 7794 } 7795 }, 7796 "/firewall/getEnterpriseFirewallLogs": { 7797 "post": { 7798 "summary": "Get enterprise firewall logs", 7799 "description": "Gets firewall logs for the specified enterprise.\n\nPrivileges required:\n\n`READ` `EDGE`\n\n`VIEW_FIREWALL_LOGS` `undefined`", 7800 "tags": [ 7801 "firewall", 7802 "all" 7803 ], 7804 "operationId": "firewall_get_enterprise_firewall_logs", 7805 "x-privileges": { 7806 "excludeAuthTypes": [], 7807 "allowAuthTypes": [ 7808 "ANY" 7809 ], 7810 "allowPrincipleTypes": [], 7811 "excludePrincipleTypes": [ 7812 "EDGE", 7813 "GATEWAY" 7814 ], 7815 "requirePrivileges": [ 7816 { 7817 "action": "READ", 7818 "object": "EDGE" 7819 }, 7820 { 7821 "action": "VIEW_FIREWALL_LOGS" 7822 } 7823 ] 7824 }, 7825 "parameters": [ 7826 { 7827 "name": "body", 7828 "in": "body", 7829 "required": true, 7830 "schema": { 7831 "title": "firewall_get_enterprise_firewall_logs", 7832 "type": "object", 7833 "properties": { 7834 "enterpriseId": { 7835 "type": "integer" 7836 }, 7837 "interval": { 7838 "$ref": "#/definitions/interval" 7839 }, 7840 "filter": { 7841 "type": "object", 7842 "properties": { 7843 "limit": { 7844 "type": "integer" 7845 } 7846 } 7847 }, 7848 "rules": { 7849 "type": "array", 7850 "items": { 7851 "type": "string" 7852 } 7853 }, 7854 "sourceIps": { 7855 "type": "array", 7856 "items": { 7857 "type": "string" 7858 } 7859 }, 7860 "destIps": { 7861 "type": "array", 7862 "items": { 7863 "type": "string" 7864 } 7865 }, 7866 "edges": { 7867 "type": "array", 7868 "items": { 7869 "type": "integer" 7870 } 7871 }, 7872 "with": { 7873 "type": "array", 7874 "items": { 7875 "type": "string", 7876 "enum": [ 7877 "rules" 7878 ] 7879 } 7880 } 7881 } 7882 } 7883 } 7884 ], 7885 "responses": { 7886 "200": { 7887 "schema": { 7888 "$ref": "#/definitions/firewall_get_enterprise_firewall_logs_result" 7889 }, 7890 "description": "Request was successfully processed" 7891 }, 7892 "400": { 7893 "$ref": "#/responses/generic_400" 7894 }, 7895 "500": { 7896 "$ref": "#/responses/generic_500" 7897 } 7898 } 7899 } 7900 }, 7901 "/gateway/deleteGateway": { 7902 "post": { 7903 "summary": "Delete a gateway", 7904 "description": "Delete a gateway by id.\n\nPrivileges required:\n\n`DELETE` `GATEWAY`", 7905 "tags": [ 7906 "gateway", 7907 "all" 7908 ], 7909 "operationId": "gateway_delete_gateway", 7910 "x-privileges": { 7911 "excludeAuthTypes": [], 7912 "allowAuthTypes": [ 7913 "OPERATOR_USER", 7914 "MSP_USER" 7915 ], 7916 "allowPrincipleTypes": [], 7917 "excludePrincipleTypes": [ 7918 "EDGE", 7919 "GATEWAY" 7920 ], 7921 "requirePrivileges": [ 7922 { 7923 "action": "DELETE", 7924 "object": "GATEWAY" 7925 } 7926 ] 7927 }, 7928 "parameters": [ 7929 { 7930 "name": "body", 7931 "in": "body", 7932 "required": true, 7933 "schema": { 7934 "type": "object", 7935 "title": "gateway_delete_gateway", 7936 "properties": { 7937 "id": { 7938 "type": "integer" 7939 } 7940 }, 7941 "required": [ 7942 "id" 7943 ] 7944 } 7945 } 7946 ], 7947 "responses": { 7948 "200": { 7949 "schema": { 7950 "$ref": "#/definitions/gateway_delete_gateway_result" 7951 }, 7952 "description": "Request was successfully processed" 7953 }, 7954 "400": { 7955 "$ref": "#/responses/generic_400" 7956 }, 7957 "500": { 7958 "$ref": "#/responses/generic_500" 7959 } 7960 } 7961 } 7962 }, 7963 "/gateway/gatewayProvision": { 7964 "post": { 7965 "summary": "Provision gateway", 7966 "description": "Provisions a gateway into the specified operator network.\n\nPrivileges required:\n\n`CREATE` `GATEWAY`", 7967 "tags": [ 7968 "gateway", 7969 "all" 7970 ], 7971 "operationId": "gateway_gateway_provision", 7972 "x-privileges": { 7973 "excludeAuthTypes": [], 7974 "allowAuthTypes": [ 7975 "OPERATOR_USER", 7976 "MSP_USER" 7977 ], 7978 "allowPrincipleTypes": [], 7979 "excludePrincipleTypes": [ 7980 "EDGE", 7981 "GATEWAY" 7982 ], 7983 "requirePrivileges": [ 7984 { 7985 "action": "CREATE", 7986 "object": "GATEWAY" 7987 } 7988 ] 7989 }, 7990 "parameters": [ 7991 { 7992 "name": "body", 7993 "in": "body", 7994 "required": true, 7995 "schema": { 7996 "type": "object", 7997 "title": "gateway_gateway_provision", 7998 "properties": { 7999 "networkId": { 8000 "type": "integer" 8001 }, 8002 "ipAddress": { 8003 "type": "string" 8004 }, 8005 "gatewayPoolId": { 8006 "type": "integer" 8007 }, 8008 "dnsName": { 8009 "type": "string" 8010 }, 8011 "name": { 8012 "type": "string" 8013 }, 8014 "description": { 8015 "type": "string" 8016 }, 8017 "isLoadBalanced": { 8018 "type": "boolean" 8019 }, 8020 "privateIpAddress": { 8021 "type": "string" 8022 }, 8023 "roles": { 8024 "$ref": "#/definitions/gateway_roles_object" 8025 }, 8026 "site": { 8027 "$ref": "#/definitions/site" 8028 } 8029 }, 8030 "required": [ 8031 "networkId", 8032 "ipAddress" 8033 ] 8034 } 8035 } 8036 ], 8037 "responses": { 8038 "200": { 8039 "schema": { 8040 "$ref": "#/definitions/gateway_gateway_provision_result" 8041 }, 8042 "description": "Request was successfully processed" 8043 }, 8044 "400": { 8045 "$ref": "#/responses/generic_400" 8046 }, 8047 "500": { 8048 "$ref": "#/responses/generic_500" 8049 } 8050 } 8051 } 8052 }, 8053 "/gateway/getGatewayEdgeAssignments": { 8054 "post": { 8055 "summary": "Get edge assignments for a gateway", 8056 "tags": [ 8057 "gateway", 8058 "all" 8059 ], 8060 "description": "Get edge assignments for a gateway\n\nPrivileges required:\n\n`READ` `GATEWAY`", 8061 "operationId": "gateway_get_gateway_edge_assignments", 8062 "x-privileges": { 8063 "excludeAuthTypes": [], 8064 "allowAuthTypes": [ 8065 "OPERATOR_USER", 8066 "MSP_USER" 8067 ], 8068 "allowPrincipleTypes": [], 8069 "excludePrincipleTypes": [ 8070 "EDGE", 8071 "GATEWAY" 8072 ], 8073 "requirePrivileges": [ 8074 { 8075 "action": "READ", 8076 "object": "GATEWAY" 8077 } 8078 ] 8079 }, 8080 "parameters": [ 8081 { 8082 "name": "body", 8083 "in": "body", 8084 "required": true, 8085 "schema": { 8086 "type": "object", 8087 "title": "gateway_get_gateway_edge_assignments", 8088 "properties": { 8089 "gatewayId": { 8090 "type": "integer" 8091 } 8092 }, 8093 "required": [ 8094 "gatewayId" 8095 ] 8096 } 8097 } 8098 ], 8099 "responses": { 8100 "200": { 8101 "description": "Request was successfully processed", 8102 "schema": { 8103 "title": "gateway_get_gateway_edge_assignments_result", 8104 "type": "array", 8105 "items": { 8106 "$ref": "#/definitions/gateway_get_gateway_edge_assignments_result_item" 8107 } 8108 } 8109 }, 8110 "400": { 8111 "$ref": "#/responses/generic_400" 8112 }, 8113 "500": { 8114 "$ref": "#/responses/generic_500" 8115 } 8116 } 8117 } 8118 }, 8119 "/gateway/updateGatewayAttributes": { 8120 "post": { 8121 "summary": "Update gateway attributes", 8122 "description": "Updates gateway attributes (`name`, `ipAddress`, on-premise parametrization, and `description`) and associated site attributes for the specified gateway (by `id`).\n\nPrivileges required:\n\n`UPDATE` `GATEWAY`", 8123 "tags": [ 8124 "gateway", 8125 "all" 8126 ], 8127 "operationId": "gateway_update_gateway_attributes", 8128 "x-privileges": { 8129 "excludeAuthTypes": [], 8130 "allowAuthTypes": [ 8131 "OPERATOR_USER", 8132 "MSP_USER" 8133 ], 8134 "allowPrincipleTypes": [], 8135 "excludePrincipleTypes": [ 8136 "EDGE", 8137 "GATEWAY" 8138 ], 8139 "requirePrivileges": [ 8140 { 8141 "action": "UPDATE", 8142 "object": "GATEWAY" 8143 } 8144 ] 8145 }, 8146 "parameters": [ 8147 { 8148 "name": "body", 8149 "in": "body", 8150 "required": true, 8151 "schema": { 8152 "type": "object", 8153 "title": "gateway_update_gateway_attributes", 8154 "properties": { 8155 "id": { 8156 "type": "integer" 8157 }, 8158 "name": { 8159 "type": "string" 8160 }, 8161 "description": { 8162 "type": "string" 8163 }, 8164 "site": { 8165 "$ref": "#/definitions/site" 8166 }, 8167 "ipsecGatewayDetail": { 8168 "$ref": "#/definitions/gateway_handoff_detail" 8169 }, 8170 "handOffDetail": { 8171 "$ref": "#/definitions/gateway_handoff_detail" 8172 }, 8173 "roles": { 8174 "$ref": "#/definitions/gateway_roles_object" 8175 } 8176 }, 8177 "required": [ 8178 "id" 8179 ] 8180 } 8181 } 8182 ], 8183 "responses": { 8184 "200": { 8185 "schema": { 8186 "$ref": "#/definitions/gateway_update_gateway_attributes_result" 8187 }, 8188 "description": "Request was successfully processed" 8189 }, 8190 "400": { 8191 "$ref": "#/responses/generic_400" 8192 }, 8193 "500": { 8194 "$ref": "#/responses/generic_500" 8195 } 8196 } 8197 } 8198 }, 8199 "/linkQualityEvent/getLinkQualityEvents": { 8200 "post": { 8201 "summary": "Get link quality events", 8202 "description": "Gets all link quality scores per link for the specified Edge within the specified time interval. Rolls up link quality events to provide an aggregate score for the Edge. Returns an empty array if no link quality events are available in the specified timeframe.\n\nPrivileges required:\n\n`READ` `EDGE`", 8203 "tags": [ 8204 "linkQualityEvent", 8205 "all" 8206 ], 8207 "x-privileges": { 8208 "excludeAuthTypes": [], 8209 "allowAuthTypes": [ 8210 "ANY" 8211 ], 8212 "allowPrincipleTypes": [], 8213 "excludePrincipleTypes": [ 8214 "EDGE", 8215 "GATEWAY" 8216 ], 8217 "requirePrivileges": [ 8218 { 8219 "action": "READ", 8220 "object": "EDGE" 8221 } 8222 ] 8223 }, 8224 "operationId": "link_quality_event_get_link_quality_events", 8225 "parameters": [ 8226 { 8227 "name": "body", 8228 "in": "body", 8229 "required": true, 8230 "schema": { 8231 "type": "object", 8232 "title": "link_quality_event_get_link_quality_events", 8233 "properties": { 8234 "edgeId": { 8235 "type": "integer" 8236 }, 8237 "interval": { 8238 "$ref": "#/definitions/interval" 8239 }, 8240 "maxSamples": { 8241 "type": "integer" 8242 }, 8243 "individualScores": { 8244 "type": "boolean" 8245 }, 8246 "minutesPerSample": { 8247 "type": "integer" 8248 }, 8249 "debug": { 8250 "type": "boolean" 8251 } 8252 }, 8253 "required": [ 8254 "edgeId", 8255 "interval" 8256 ] 8257 } 8258 } 8259 ], 8260 "responses": { 8261 "200": { 8262 "schema": { 8263 "$ref": "#/definitions/link_quality_event_get_link_quality_events_result" 8264 }, 8265 "description": "Request was successfully processed" 8266 }, 8267 "400": { 8268 "$ref": "#/responses/generic_400" 8269 }, 8270 "500": { 8271 "$ref": "#/responses/generic_500" 8272 } 8273 } 8274 } 8275 }, 8276 "/metrics/getEdgeAppLinkMetrics": { 8277 "post": { 8278 "summary": "Get flow metric aggregate data", 8279 "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.\n\nPrivileges required:\n\n`READ` `EDGE`\n\n`VIEW_FLOW_STATS` `undefined`", 8280 "tags": [ 8281 "all", 8282 "metrics" 8283 ], 8284 "operationId": "metrics_get_edge_app_link_metrics", 8285 "x-privileges": { 8286 "excludeAuthTypes": [], 8287 "allowAuthTypes": [ 8288 "ANY" 8289 ], 8290 "allowPrincipleTypes": [], 8291 "excludePrincipleTypes": [ 8292 "EDGE", 8293 "GATEWAY" 8294 ], 8295 "requirePrivileges": [ 8296 { 8297 "action": "READ", 8298 "object": "EDGE" 8299 }, 8300 { 8301 "action": "VIEW_FLOW_STATS" 8302 } 8303 ] 8304 }, 8305 "parameters": [ 8306 { 8307 "name": "body", 8308 "in": "body", 8309 "required": true, 8310 "schema": { 8311 "type": "object", 8312 "title": "metrics_get_edge_app_link_metrics", 8313 "properties": { 8314 "id": { 8315 "type": "integer" 8316 }, 8317 "enterpriseId": { 8318 "type": "integer" 8319 }, 8320 "interval": { 8321 "$ref": "#/definitions/interval" 8322 }, 8323 "metrics": { 8324 "$ref": "#/definitions/basic_metrics" 8325 } 8326 }, 8327 "required": [ 8328 "id", 8329 "interval" 8330 ] 8331 } 8332 } 8333 ], 8334 "responses": { 8335 "200": { 8336 "schema": { 8337 "title": "metrics_get_edge_app_link_metrics_result", 8338 "type": "array", 8339 "items": { 8340 "$ref": "#/definitions/metrics_get_edge_app_link_metrics_result_item" 8341 } 8342 }, 8343 "description": "Request was successfully processed" 8344 }, 8345 "400": { 8346 "$ref": "#/responses/generic_400" 8347 }, 8348 "500": { 8349 "$ref": "#/responses/generic_500" 8350 } 8351 } 8352 } 8353 }, 8354 "/metrics/getEdgeAppLinkSeries": { 8355 "post": { 8356 "summary": "Get flow metric time series data", 8357 "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.\n\nPrivileges required:\n\n`READ` `EDGE`\n\n`VIEW_FLOW_STATS` `undefined`", 8358 "tags": [ 8359 "all", 8360 "metrics" 8361 ], 8362 "operationId": "metrics_get_edge_app_link_series", 8363 "x-privileges": { 8364 "excludeAuthTypes": [], 8365 "allowAuthTypes": [ 8366 "ANY" 8367 ], 8368 "allowPrincipleTypes": [], 8369 "excludePrincipleTypes": [ 8370 "EDGE", 8371 "GATEWAY" 8372 ], 8373 "requirePrivileges": [ 8374 { 8375 "action": "READ", 8376 "object": "EDGE" 8377 }, 8378 { 8379 "action": "VIEW_FLOW_STATS" 8380 } 8381 ] 8382 }, 8383 "parameters": [ 8384 { 8385 "name": "body", 8386 "in": "body", 8387 "required": true, 8388 "schema": { 8389 "type": "object", 8390 "title": "metrics_get_edge_app_link_series", 8391 "properties": { 8392 "id": { 8393 "type": "integer" 8394 }, 8395 "enterpriseId": { 8396 "type": "integer" 8397 }, 8398 "interval": { 8399 "$ref": "#/definitions/interval" 8400 }, 8401 "metrics": { 8402 "$ref": "#/definitions/basic_metrics" 8403 }, 8404 "links": { 8405 "type": "array", 8406 "items": { 8407 "type": "integer" 8408 } 8409 } 8410 }, 8411 "required": [ 8412 "id", 8413 "interval" 8414 ] 8415 } 8416 } 8417 ], 8418 "responses": { 8419 "200": { 8420 "schema": { 8421 "title": "metrics_get_edge_app_link_series_result", 8422 "type": "array", 8423 "items": { 8424 "$ref": "#/definitions/metrics_get_edge_app_link_series_result_item" 8425 } 8426 }, 8427 "description": "Request was successfully processed" 8428 }, 8429 "400": { 8430 "$ref": "#/responses/generic_400" 8431 }, 8432 "500": { 8433 "$ref": "#/responses/generic_500" 8434 } 8435 } 8436 } 8437 }, 8438 "/metrics/getEdgeAppMetrics": { 8439 "post": { 8440 "summary": "Get flow metric aggregate data by application", 8441 "description": "Gets flow metric summaries 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. 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.\n\nPrivileges required:\n\n`READ` `EDGE`\n\n`VIEW_FLOW_STATS` `undefined`", 8442 "tags": [ 8443 "all", 8444 "metrics" 8445 ], 8446 "operationId": "metrics_get_edge_app_metrics", 8447 "x-privileges": { 8448 "forceEnterpriseContext": true, 8449 "excludeAuthTypes": [], 8450 "allowAuthTypes": [ 8451 "ANY" 8452 ], 8453 "allowPrincipleTypes": [], 8454 "excludePrincipleTypes": [ 8455 "EDGE", 8456 "GATEWAY" 8457 ], 8458 "requirePrivileges": [ 8459 { 8460 "action": "READ", 8461 "object": "EDGE" 8462 }, 8463 { 8464 "action": "VIEW_FLOW_STATS" 8465 } 8466 ] 8467 }, 8468 "parameters": [ 8469 { 8470 "name": "body", 8471 "in": "body", 8472 "required": true, 8473 "schema": { 8474 "type": "object", 8475 "title": "metrics_get_edge_app_metrics", 8476 "properties": { 8477 "id": { 8478 "type": "integer" 8479 }, 8480 "edgeId": { 8481 "type": "integer" 8482 }, 8483 "enterpriseId": { 8484 "type": "integer" 8485 }, 8486 "interval": { 8487 "$ref": "#/definitions/interval" 8488 }, 8489 "metrics": { 8490 "$ref": "#/definitions/basic_metrics" 8491 }, 8492 "sort": { 8493 "$ref": "#/definitions/basic_metric" 8494 }, 8495 "limit": { 8496 "type": "integer" 8497 }, 8498 "applications": { 8499 "type": "array", 8500 "items": { 8501 "type": "string" 8502 } 8503 }, 8504 "with": { 8505 "type": "array", 8506 "items": { 8507 "type": "string", 8508 "enum": [ 8509 "category", 8510 "linkId" 8511 ] 8512 } 8513 } 8514 }, 8515 "required": [ 8516 "interval" 8517 ] 8518 } 8519 } 8520 ], 8521 "responses": { 8522 "200": { 8523 "schema": { 8524 "title": "metrics_get_edge_app_metrics_result", 8525 "type": "array", 8526 "items": { 8527 "$ref": "#/definitions/metrics_get_edge_app_metrics_result_item" 8528 } 8529 }, 8530 "description": "Request was successfully processed" 8531 }, 8532 "400": { 8533 "$ref": "#/responses/generic_400" 8534 }, 8535 "500": { 8536 "$ref": "#/responses/generic_500" 8537 } 8538 } 8539 } 8540 }, 8541 "/metrics/getEdgeAppSeries": { 8542 "post": { 8543 "summary": "Get flow metric time series data by application", 8544 "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. 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.\n\nPrivileges required:\n\n`READ` `EDGE`\n\n`VIEW_FLOW_STATS` `undefined`", 8545 "tags": [ 8546 "all", 8547 "metrics" 8548 ], 8549 "operationId": "metrics_get_edge_app_series", 8550 "x-privileges": { 8551 "forceEnterpriseContext": true, 8552 "excludeAuthTypes": [], 8553 "allowAuthTypes": [ 8554 "ANY" 8555 ], 8556 "allowPrincipleTypes": [], 8557 "excludePrincipleTypes": [ 8558 "EDGE", 8559 "GATEWAY" 8560 ], 8561 "requirePrivileges": [ 8562 { 8563 "action": "READ", 8564 "object": "EDGE" 8565 }, 8566 { 8567 "action": "VIEW_FLOW_STATS" 8568 } 8569 ] 8570 }, 8571 "parameters": [ 8572 { 8573 "name": "body", 8574 "in": "body", 8575 "required": true, 8576 "schema": { 8577 "type": "object", 8578 "title": "metrics_get_edge_app_series", 8579 "properties": { 8580 "id": { 8581 "type": "integer" 8582 }, 8583 "edgeId": { 8584 "type": "integer" 8585 }, 8586 "enterpriseId": { 8587 "type": "integer" 8588 }, 8589 "interval": { 8590 "$ref": "#/definitions/interval" 8591 }, 8592 "metrics": { 8593 "$ref": "#/definitions/basic_metrics" 8594 }, 8595 "sort": { 8596 "$ref": "#/definitions/basic_metric" 8597 }, 8598 "limit": { 8599 "type": "integer" 8600 }, 8601 "maxSamples": { 8602 "type": "integer" 8603 }, 8604 "applications": { 8605 "type": "array", 8606 "items": { 8607 "type": "string" 8608 } 8609 } 8610 }, 8611 "required": [ 8612 "interval" 8613 ] 8614 } 8615 } 8616 ], 8617 "responses": { 8618 "200": { 8619 "schema": { 8620 "title": "metrics_get_edge_app_series_result", 8621 "type": "array", 8622 "items": { 8623 "$ref": "#/definitions/metrics_get_edge_app_series_result_item" 8624 } 8625 }, 8626 "description": "Request was successfully processed" 8627 }, 8628 "400": { 8629 "$ref": "#/responses/generic_400" 8630 }, 8631 "500": { 8632 "$ref": "#/responses/generic_500" 8633 } 8634 } 8635 } 8636 }, 8637 "/metrics/getEdgeCategoryMetrics": { 8638 "post": { 8639 "summary": "Get flow metric aggregate data by application category", 8640 "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.\n\nPrivileges required:\n\n`READ` `EDGE`\n\n`VIEW_FLOW_STATS` `undefined`", 8641 "tags": [ 8642 "all", 8643 "metrics" 8644 ], 8645 "operationId": "metrics_get_edge_category_metrics", 8646 "x-privileges": { 8647 "forceEnterpriseContext": true, 8648 "excludeAuthTypes": [], 8649 "allowAuthTypes": [ 8650 "ANY" 8651 ], 8652 "allowPrincipleTypes": [], 8653 "excludePrincipleTypes": [ 8654 "EDGE", 8655 "GATEWAY" 8656 ], 8657 "requirePrivileges": [ 8658 { 8659 "action": "READ", 8660 "object": "EDGE" 8661 }, 8662 { 8663 "action": "VIEW_FLOW_STATS" 8664 } 8665 ] 8666 }, 8667 "parameters": [ 8668 { 8669 "name": "body", 8670 "in": "body", 8671 "required": true, 8672 "schema": { 8673 "type": "object", 8674 "title": "metrics_get_edge_category_metrics", 8675 "properties": { 8676 "id": { 8677 "type": "integer" 8678 }, 8679 "edgeId": { 8680 "type": "integer" 8681 }, 8682 "enterpriseId": { 8683 "type": "integer" 8684 }, 8685 "interval": { 8686 "$ref": "#/definitions/interval" 8687 }, 8688 "metrics": { 8689 "$ref": "#/definitions/basic_metrics" 8690 }, 8691 "sort": { 8692 "$ref": "#/definitions/basic_metric" 8693 }, 8694 "limit": { 8695 "type": "integer" 8696 }, 8697 "categories": { 8698 "type": "array", 8699 "items": { 8700 "type": "integer" 8701 } 8702 } 8703 }, 8704 "required": [ 8705 "interval" 8706 ] 8707 } 8708 } 8709 ], 8710 "responses": { 8711 "200": { 8712 "schema": { 8713 "title": "metrics_get_edge_category_metrics_result", 8714 "type": "array", 8715 "items": { 8716 "$ref": "#/definitions/metrics_get_edge_category_metrics_result_item" 8717 } 8718 }, 8719 "description": "Request was successfully processed" 8720 }, 8721 "400": { 8722 "$ref": "#/responses/generic_400" 8723 }, 8724 "500": { 8725 "$ref": "#/responses/generic_500" 8726 } 8727 } 8728 } 8729 }, 8730 "/metrics/getEdgeCategorySeries": { 8731 "post": { 8732 "summary": "Get flow metric time series data by application category", 8733 "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.\n\nPrivileges required:\n\n`READ` `EDGE`\n\n`VIEW_FLOW_STATS` `undefined`", 8734 "tags": [ 8735 "all", 8736 "metrics" 8737 ], 8738 "operationId": "metrics_get_edge_category_series", 8739 "x-privileges": { 8740 "forceEnterpriseContext": true, 8741 "excludeAuthTypes": [], 8742 "allowAuthTypes": [ 8743 "ANY" 8744 ], 8745 "allowPrincipleTypes": [], 8746 "excludePrincipleTypes": [ 8747 "EDGE", 8748 "GATEWAY" 8749 ], 8750 "requirePrivileges": [ 8751 { 8752 "action": "READ", 8753 "object": "EDGE" 8754 }, 8755 { 8756 "action": "VIEW_FLOW_STATS" 8757 } 8758 ] 8759 }, 8760 "parameters": [ 8761 { 8762 "name": "body", 8763 "in": "body", 8764 "required": true, 8765 "schema": { 8766 "type": "object", 8767 "title": "metrics_get_edge_category_series", 8768 "properties": { 8769 "id": { 8770 "type": "integer" 8771 }, 8772 "edgeId": { 8773 "type": "integer" 8774 }, 8775 "enterpriseId": { 8776 "type": "integer" 8777 }, 8778 "interval": { 8779 "$ref": "#/definitions/interval" 8780 }, 8781 "metrics": { 8782 "$ref": "#/definitions/basic_metrics" 8783 }, 8784 "sort": { 8785 "$ref": "#/definitions/basic_metric" 8786 }, 8787 "limit": { 8788 "type": "integer" 8789 }, 8790 "maxSamples": { 8791 "type": "integer" 8792 }, 8793 "categories": { 8794 "type": "array", 8795 "items": { 8796 "type": "string" 8797 } 8798 } 8799 }, 8800 "required": [ 8801 "interval" 8802 ] 8803 } 8804 } 8805 ], 8806 "responses": { 8807 "200": { 8808 "schema": { 8809 "title": "metrics_get_edge_category_series_result", 8810 "type": "array", 8811 "items": { 8812 "$ref": "#/definitions/metrics_get_edge_category_series_result_item" 8813 } 8814 }, 8815 "description": "Request was successfully processed" 8816 }, 8817 "400": { 8818 "$ref": "#/responses/generic_400" 8819 }, 8820 "500": { 8821 "$ref": "#/responses/generic_500" 8822 } 8823 } 8824 } 8825 }, 8826 "/metrics/getEdgeDestMetrics": { 8827 "post": { 8828 "summary": "Get flow metric aggregate data by destination", 8829 "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.\n\nPrivileges required:\n\n`READ` `EDGE`\n\n`VIEW_FLOW_STATS` `undefined`", 8830 "tags": [ 8831 "all", 8832 "metrics" 8833 ], 8834 "operationId": "metrics_get_edge_dest_metrics", 8835 "x-privileges": { 8836 "forceEnterpriseContext": true, 8837 "excludeAuthTypes": [], 8838 "allowAuthTypes": [ 8839 "ANY" 8840 ], 8841 "allowPrincipleTypes": [], 8842 "excludePrincipleTypes": [ 8843 "EDGE", 8844 "GATEWAY" 8845 ], 8846 "requirePrivileges": [ 8847 { 8848 "action": "READ", 8849 "object": "EDGE" 8850 }, 8851 { 8852 "action": "VIEW_FLOW_STATS" 8853 } 8854 ] 8855 }, 8856 "parameters": [ 8857 { 8858 "name": "body", 8859 "in": "body", 8860 "required": true, 8861 "schema": { 8862 "type": "object", 8863 "title": "metrics_get_edge_dest_metrics", 8864 "properties": { 8865 "id": { 8866 "type": "integer" 8867 }, 8868 "edgeId": { 8869 "type": "integer" 8870 }, 8871 "enterpriseId": { 8872 "type": "integer" 8873 }, 8874 "interval": { 8875 "$ref": "#/definitions/interval" 8876 }, 8877 "metrics": { 8878 "$ref": "#/definitions/basic_metrics" 8879 }, 8880 "sort": { 8881 "$ref": "#/definitions/basic_metric" 8882 }, 8883 "limit": { 8884 "type": "integer" 8885 }, 8886 "attribute": { 8887 "type": "string", 8888 "enum": [ 8889 "destDomain", 8890 "destIp", 8891 "destFQDN" 8892 ] 8893 }, 8894 "destinations": { 8895 "type": "array", 8896 "items": { 8897 "type": "string" 8898 } 8899 } 8900 }, 8901 "required": [ 8902 "interval" 8903 ] 8904 } 8905 } 8906 ], 8907 "responses": { 8908 "200": { 8909 "schema": { 8910 "title": "metrics_get_edge_dest_metrics_result", 8911 "type": "array", 8912 "items": { 8913 "$ref": "#/definitions/metrics_get_edge_dest_metrics_result_item" 8914 } 8915 }, 8916 "description": "Request was successfully processed" 8917 }, 8918 "400": { 8919 "$ref": "#/responses/generic_400" 8920 }, 8921 "500": { 8922 "$ref": "#/responses/generic_500" 8923 } 8924 } 8925 } 8926 }, 8927 "/metrics/getEdgeDestSeries": { 8928 "post": { 8929 "summary": "Get flow metric time series data by destination", 8930 "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.\n\nPrivileges required:\n\n`READ` `EDGE`\n\n`VIEW_FLOW_STATS` `undefined`", 8931 "tags": [ 8932 "all", 8933 "metrics" 8934 ], 8935 "operationId": "metrics_get_edge_dest_series", 8936 "x-privileges": { 8937 "forceEnterpriseContext": true, 8938 "excludeAuthTypes": [], 8939 "allowAuthTypes": [ 8940 "ANY" 8941 ], 8942 "allowPrincipleTypes": [], 8943 "excludePrincipleTypes": [ 8944 "EDGE", 8945 "GATEWAY" 8946 ], 8947 "requirePrivileges": [ 8948 { 8949 "action": "READ", 8950 "object": "EDGE" 8951 }, 8952 { 8953 "action": "VIEW_FLOW_STATS" 8954 } 8955 ] 8956 }, 8957 "parameters": [ 8958 { 8959 "name": "body", 8960 "in": "body", 8961 "required": true, 8962 "schema": { 8963 "type": "object", 8964 "title": "metrics_get_edge_dest_series", 8965 "properties": { 8966 "id": { 8967 "type": "integer" 8968 }, 8969 "edgeId": { 8970 "type": "integer" 8971 }, 8972 "enterpriseId": { 8973 "type": "integer" 8974 }, 8975 "interval": { 8976 "$ref": "#/definitions/interval" 8977 }, 8978 "sort": { 8979 "$ref": "#/definitions/basic_metric" 8980 }, 8981 "limit": { 8982 "type": "integer" 8983 }, 8984 "attribute": { 8985 "type": "string", 8986 "enum": [ 8987 "destDomain", 8988 "destIp", 8989 "destFQDN" 8990 ] 8991 }, 8992 "destinations": { 8993 "type": "array", 8994 "items": { 8995 "type": "string" 8996 } 8997 } 8998 }, 8999 "required": [ 9000 "interval" 9001 ] 9002 } 9003 } 9004 ], 9005 "responses": { 9006 "200": { 9007 "schema": { 9008 "title": "metrics_get_edge_dest_series_result", 9009 "type": "array", 9010 "items": { 9011 "$ref": "#/definitions/metrics_get_edge_dest_series_result_item" 9012 } 9013 }, 9014 "description": "Request was successfully processed" 9015 }, 9016 "400": { 9017 "$ref": "#/responses/generic_400" 9018 }, 9019 "500": { 9020 "$ref": "#/responses/generic_500" 9021 } 9022 } 9023 } 9024 }, 9025 "/metrics/getEdgeDeviceMetrics": { 9026 "post": { 9027 "summary": "Get flow metric aggregate data by client device", 9028 "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.\n\nPrivileges required:\n\n`READ` `EDGE`\n\n`VIEW_USER_IDENTIFIABLE_FLOW_STATS` `undefined`", 9029 "tags": [ 9030 "all", 9031 "metrics" 9032 ], 9033 "operationId": "metrics_get_edge_device_metrics", 9034 "x-privileges": { 9035 "forceEnterpriseContext": true, 9036 "excludeAuthTypes": [], 9037 "allowAuthTypes": [ 9038 "ANY" 9039 ], 9040 "allowPrincipleTypes": [], 9041 "excludePrincipleTypes": [ 9042 "EDGE", 9043 "GATEWAY" 9044 ], 9045 "requirePrivileges": [ 9046 { 9047 "action": "READ", 9048 "object": "EDGE" 9049 }, 9050 { 9051 "action": "VIEW_USER_IDENTIFIABLE_FLOW_STATS" 9052 } 9053 ] 9054 }, 9055 "parameters": [ 9056 { 9057 "name": "body", 9058 "in": "body", 9059 "required": true, 9060 "schema": { 9061 "type": "object", 9062 "title": "metrics_get_edge_device_metrics", 9063 "properties": { 9064 "id": { 9065 "type": "integer" 9066 }, 9067 "edgeId": { 9068 "type": "integer" 9069 }, 9070 "enterpriseId": { 9071 "type": "integer" 9072 }, 9073 "interval": { 9074 "$ref": "#/definitions/interval" 9075 }, 9076 "metrics": { 9077 "$ref": "#/definitions/basic_metrics" 9078 }, 9079 "sort": { 9080 "$ref": "#/definitions/basic_metric" 9081 }, 9082 "limit": { 9083 "type": "integer" 9084 }, 9085 "devices": { 9086 "type": "array", 9087 "items": { 9088 "type": "integer" 9089 } 9090 } 9091 }, 9092 "required": [ 9093 "interval" 9094 ] 9095 } 9096 } 9097 ], 9098 "responses": { 9099 "200": { 9100 "schema": { 9101 "title": "metrics_get_edge_device_metrics_result", 9102 "type": "array", 9103 "items": { 9104 "$ref": "#/definitions/metrics_get_edge_device_metrics_result_item" 9105 } 9106 }, 9107 "description": "Request was successfully processed" 9108 }, 9109 "400": { 9110 "$ref": "#/responses/generic_400" 9111 }, 9112 "500": { 9113 "$ref": "#/responses/generic_500" 9114 } 9115 } 9116 } 9117 }, 9118 "/metrics/getEdgeDeviceSeries": { 9119 "post": { 9120 "summary": "Get flow metric time series data by client device", 9121 "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.\n\nPrivileges required:\n\n`READ` `EDGE`\n\n`VIEW_USER_IDENTIFIABLE_FLOW_STATS` `undefined`", 9122 "tags": [ 9123 "all", 9124 "metrics" 9125 ], 9126 "operationId": "metrics_get_edge_device_series", 9127 "x-privileges": { 9128 "forceEnterpriseContext": true, 9129 "excludeAuthTypes": [], 9130 "allowAuthTypes": [ 9131 "ANY" 9132 ], 9133 "allowPrincipleTypes": [], 9134 "excludePrincipleTypes": [ 9135 "EDGE", 9136 "GATEWAY" 9137 ], 9138 "requirePrivileges": [ 9139 { 9140 "action": "READ", 9141 "object": "EDGE" 9142 }, 9143 { 9144 "action": "VIEW_USER_IDENTIFIABLE_FLOW_STATS" 9145 } 9146 ] 9147 }, 9148 "parameters": [ 9149 { 9150 "name": "body", 9151 "in": "body", 9152 "required": true, 9153 "schema": { 9154 "type": "object", 9155 "title": "metrics_get_edge_device_series", 9156 "properties": { 9157 "id": { 9158 "type": "integer" 9159 }, 9160 "edgeId": { 9161 "type": "integer" 9162 }, 9163 "enterpriseId": { 9164 "type": "integer" 9165 }, 9166 "interval": { 9167 "$ref": "#/definitions/interval" 9168 }, 9169 "metrics": { 9170 "$ref": "#/definitions/basic_metrics" 9171 }, 9172 "sort": { 9173 "$ref": "#/definitions/basic_metric" 9174 }, 9175 "limit": { 9176 "type": "integer" 9177 }, 9178 "maxSamples": { 9179 "type": "integer" 9180 }, 9181 "devices": { 9182 "type": "array", 9183 "items": { 9184 "type": "string" 9185 } 9186 } 9187 }, 9188 "required": [ 9189 "interval" 9190 ] 9191 } 9192 } 9193 ], 9194 "responses": { 9195 "200": { 9196 "schema": { 9197 "title": "metrics_get_edge_device_series_result", 9198 "type": "array", 9199 "items": { 9200 "$ref": "#/definitions/metrics_get_edge_device_series_result_item" 9201 } 9202 }, 9203 "description": "Request was successfully processed" 9204 }, 9205 "400": { 9206 "$ref": "#/responses/generic_400" 9207 }, 9208 "500": { 9209 "$ref": "#/responses/generic_500" 9210 } 9211 } 9212 } 9213 }, 9214 "/metrics/getEdgeLinkMetrics": { 9215 "post": { 9216 "summary": "Get advanced flow metric aggregate data by link", 9217 "description": "Gets advanced 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.\n\nPrivileges required:\n\n`READ` `EDGE`", 9218 "tags": [ 9219 "all", 9220 "metrics" 9221 ], 9222 "operationId": "metrics_get_edge_link_metrics", 9223 "x-privileges": { 9224 "forceEnterpriseContext": true, 9225 "excludeAuthTypes": [], 9226 "allowAuthTypes": [ 9227 "ANY" 9228 ], 9229 "allowPrincipleTypes": [], 9230 "excludePrincipleTypes": [ 9231 "EDGE", 9232 "GATEWAY" 9233 ], 9234 "requirePrivileges": [ 9235 { 9236 "action": "READ", 9237 "object": "EDGE" 9238 } 9239 ] 9240 }, 9241 "parameters": [ 9242 { 9243 "name": "body", 9244 "in": "body", 9245 "required": true, 9246 "schema": { 9247 "type": "object", 9248 "title": "metrics_get_edge_link_metrics", 9249 "properties": { 9250 "id": { 9251 "type": "integer" 9252 }, 9253 "edgeId": { 9254 "type": "integer" 9255 }, 9256 "enterpriseId": { 9257 "type": "integer" 9258 }, 9259 "interval": { 9260 "$ref": "#/definitions/interval" 9261 }, 9262 "metrics": { 9263 "type": "array", 9264 "items": { 9265 "$ref": "#/definitions/edge_link_metric" 9266 } 9267 }, 9268 "sort": { 9269 "$ref": "#/definitions/edge_link_metric" 9270 }, 9271 "limit": { 9272 "type": "integer" 9273 }, 9274 "links": { 9275 "type": "array", 9276 "items": { 9277 "type": "integer" 9278 } 9279 } 9280 }, 9281 "required": [ 9282 "interval" 9283 ] 9284 } 9285 } 9286 ], 9287 "responses": { 9288 "200": { 9289 "schema": { 9290 "title": "metrics_get_edge_link_metrics_result", 9291 "type": "array", 9292 "items": { 9293 "$ref": "#/definitions/metrics_get_edge_link_metrics_result_item" 9294 } 9295 }, 9296 "description": "Request was successfully processed" 9297 }, 9298 "400": { 9299 "$ref": "#/responses/generic_400" 9300 }, 9301 "500": { 9302 "$ref": "#/responses/generic_500" 9303 } 9304 } 9305 } 9306 }, 9307 "/metrics/getEdgeLinkSeries": { 9308 "post": { 9309 "summary": "Get advanced flow metric time series data by link", 9310 "description": "Gets advanced 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.\n\nPrivileges required:\n\n`READ` `EDGE`", 9311 "tags": [ 9312 "all", 9313 "metrics" 9314 ], 9315 "operationId": "metrics_get_edge_link_series", 9316 "x-privileges": { 9317 "forceEnterpriseContext": true, 9318 "excludeAuthTypes": [], 9319 "allowAuthTypes": [ 9320 "ANY" 9321 ], 9322 "allowPrincipleTypes": [], 9323 "excludePrincipleTypes": [ 9324 "EDGE", 9325 "GATEWAY" 9326 ], 9327 "requirePrivileges": [ 9328 { 9329 "action": "READ", 9330 "object": "EDGE" 9331 } 9332 ] 9333 }, 9334 "parameters": [ 9335 { 9336 "name": "body", 9337 "in": "body", 9338 "required": true, 9339 "schema": { 9340 "type": "object", 9341 "title": "metrics_get_edge_link_series", 9342 "properties": { 9343 "id": { 9344 "type": "integer" 9345 }, 9346 "edgeId": { 9347 "type": "integer" 9348 }, 9349 "enterpriseId": { 9350 "type": "integer" 9351 }, 9352 "interval": { 9353 "$ref": "#/definitions/interval" 9354 }, 9355 "metrics": { 9356 "type": "array", 9357 "items": { 9358 "$ref": "#/definitions/edge_link_metric" 9359 } 9360 }, 9361 "sort": { 9362 "$ref": "#/definitions/edge_link_metric" 9363 }, 9364 "limit": { 9365 "type": "integer" 9366 }, 9367 "links": { 9368 "type": "array", 9369 "items": { 9370 "type": "integer" 9371 } 9372 } 9373 }, 9374 "required": [ 9375 "interval" 9376 ] 9377 } 9378 } 9379 ], 9380 "responses": { 9381 "200": { 9382 "schema": { 9383 "title": "metrics_get_edge_link_series_result", 9384 "type": "array", 9385 "items": { 9386 "$ref": "#/definitions/metrics_get_edge_link_series_result_item" 9387 } 9388 }, 9389 "description": "Request was successfully processed" 9390 }, 9391 "400": { 9392 "$ref": "#/responses/generic_400" 9393 }, 9394 "500": { 9395 "$ref": "#/responses/generic_500" 9396 } 9397 } 9398 } 9399 }, 9400 "/metrics/getEdgeOsMetrics": { 9401 "post": { 9402 "summary": "Get flow metric aggregate data by client OS", 9403 "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.\n\nPrivileges required:\n\n`READ` `EDGE`\n\n`VIEW_FLOW_STATS` `undefined`", 9404 "tags": [ 9405 "all", 9406 "metrics" 9407 ], 9408 "operationId": "metrics_get_edge_os_metrics", 9409 "x-privileges": { 9410 "forceEnterpriseContext": true, 9411 "excludeAuthTypes": [], 9412 "allowAuthTypes": [ 9413 "ANY" 9414 ], 9415 "allowPrincipleTypes": [], 9416 "excludePrincipleTypes": [ 9417 "EDGE", 9418 "GATEWAY" 9419 ], 9420 "requirePrivileges": [ 9421 { 9422 "action": "READ", 9423 "object": "EDGE" 9424 }, 9425 { 9426 "action": "VIEW_FLOW_STATS" 9427 } 9428 ] 9429 }, 9430 "parameters": [ 9431 { 9432 "name": "body", 9433 "in": "body", 9434 "required": true, 9435 "schema": { 9436 "type": "object", 9437 "title": "metrics_get_edge_os_metrics", 9438 "properties": { 9439 "id": { 9440 "type": "integer" 9441 }, 9442 "edgeId": { 9443 "type": "integer" 9444 }, 9445 "enterpriseId": { 9446 "type": "integer" 9447 }, 9448 "interval": { 9449 "$ref": "#/definitions/interval" 9450 }, 9451 "metrics": { 9452 "$ref": "#/definitions/basic_metrics" 9453 }, 9454 "sort": { 9455 "$ref": "#/definitions/basic_metric" 9456 }, 9457 "limit": { 9458 "type": "integer" 9459 }, 9460 "os": { 9461 "type": "array", 9462 "items": { 9463 "type": "integer" 9464 } 9465 } 9466 }, 9467 "required": [ 9468 "interval" 9469 ] 9470 } 9471 } 9472 ], 9473 "responses": { 9474 "200": { 9475 "schema": { 9476 "title": "metrics_get_edge_os_metrics_result", 9477 "type": "array", 9478 "items": { 9479 "$ref": "#/definitions/metrics_get_edge_os_metrics_result_item" 9480 } 9481 }, 9482 "description": "Request was successfully processed" 9483 }, 9484 "400": { 9485 "$ref": "#/responses/generic_400" 9486 }, 9487 "500": { 9488 "$ref": "#/responses/generic_500" 9489 } 9490 } 9491 } 9492 }, 9493 "/metrics/getEdgeOsSeries": { 9494 "post": { 9495 "summary": "Get flow metric time series data by client OS", 9496 "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.\n\nPrivileges required:\n\n`READ` `EDGE`\n\n`VIEW_FLOW_STATS` `undefined`", 9497 "tags": [ 9498 "all", 9499 "metrics" 9500 ], 9501 "operationId": "metrics_get_edge_os_series", 9502 "x-privileges": { 9503 "forceEnterpriseContext": true, 9504 "excludeAuthTypes": [], 9505 "allowAuthTypes": [ 9506 "ANY" 9507 ], 9508 "allowPrincipleTypes": [], 9509 "excludePrincipleTypes": [ 9510 "EDGE", 9511 "GATEWAY" 9512 ], 9513 "requirePrivileges": [ 9514 { 9515 "action": "READ", 9516 "object": "EDGE" 9517 }, 9518 { 9519 "action": "VIEW_FLOW_STATS" 9520 } 9521 ] 9522 }, 9523 "parameters": [ 9524 { 9525 "name": "body", 9526 "in": "body", 9527 "required": true, 9528 "schema": { 9529 "type": "object", 9530 "title": "metrics_get_edge_os_series", 9531 "properties": { 9532 "id": { 9533 "type": "integer" 9534 }, 9535 "edgeId": { 9536 "type": "integer" 9537 }, 9538 "enterpriseId": { 9539 "type": "integer" 9540 }, 9541 "interval": { 9542 "$ref": "#/definitions/interval" 9543 }, 9544 "metrics": { 9545 "$ref": "#/definitions/basic_metrics" 9546 }, 9547 "maxSamples": { 9548 "type": "integer" 9549 }, 9550 "sort": { 9551 "$ref": "#/definitions/basic_metric" 9552 }, 9553 "limit": { 9554 "type": "integer" 9555 }, 9556 "os": { 9557 "type": "array", 9558 "items": { 9559 "type": "integer" 9560 } 9561 } 9562 }, 9563 "required": [ 9564 "interval" 9565 ] 9566 } 9567 } 9568 ], 9569 "responses": { 9570 "200": { 9571 "schema": { 9572 "title": "metrics_get_edge_os_series_result", 9573 "type": "array", 9574 "items": { 9575 "$ref": "#/definitions/metrics_get_edge_os_series_result_item" 9576 } 9577 }, 9578 "description": "Request was successfully processed" 9579 }, 9580 "400": { 9581 "$ref": "#/responses/generic_400" 9582 }, 9583 "500": { 9584 "$ref": "#/responses/generic_500" 9585 } 9586 } 9587 } 9588 }, 9589 "/metrics/getEdgeSegmentMetrics": { 9590 "post": { 9591 "summary": "Get flow metric aggregate data by segment Id", 9592 "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.\n\nPrivileges required:\n\n`READ` `EDGE`\n\n`VIEW_FLOW_STATS` `undefined`", 9593 "tags": [ 9594 "all", 9595 "metrics" 9596 ], 9597 "operationId": "metrics_get_edge_segment_metrics", 9598 "x-privileges": { 9599 "forceEnterpriseContext": true, 9600 "excludeAuthTypes": [], 9601 "allowAuthTypes": [ 9602 "ANY" 9603 ], 9604 "allowPrincipleTypes": [], 9605 "excludePrincipleTypes": [ 9606 "EDGE", 9607 "GATEWAY" 9608 ], 9609 "requirePrivileges": [ 9610 { 9611 "action": "READ", 9612 "object": "EDGE" 9613 }, 9614 { 9615 "action": "VIEW_FLOW_STATS" 9616 } 9617 ] 9618 }, 9619 "parameters": [ 9620 { 9621 "name": "body", 9622 "in": "body", 9623 "required": true, 9624 "schema": { 9625 "type": "object", 9626 "title": "metrics_get_edge_segment_metrics", 9627 "properties": { 9628 "id": { 9629 "type": "integer" 9630 }, 9631 "edgeId": { 9632 "type": "integer" 9633 }, 9634 "enterpriseId": { 9635 "type": "integer" 9636 }, 9637 "interval": { 9638 "$ref": "#/definitions/interval" 9639 }, 9640 "metrics": { 9641 "$ref": "#/definitions/basic_metrics" 9642 }, 9643 "sort": { 9644 "$ref": "#/definitions/basic_metric" 9645 }, 9646 "limit": { 9647 "type": "integer" 9648 }, 9649 "segments": { 9650 "type": "array", 9651 "items": { 9652 "type": "integer" 9653 } 9654 } 9655 }, 9656 "required": [ 9657 "interval" 9658 ] 9659 } 9660 } 9661 ], 9662 "responses": { 9663 "200": { 9664 "schema": { 9665 "title": "metrics_get_edge_segment_metrics_result", 9666 "type": "array", 9667 "items": { 9668 "$ref": "#/definitions/metrics_get_edge_segment_metrics_result_item" 9669 } 9670 }, 9671 "description": "Request was successfully processed" 9672 }, 9673 "400": { 9674 "$ref": "#/responses/generic_400" 9675 }, 9676 "500": { 9677 "$ref": "#/responses/generic_500" 9678 } 9679 } 9680 } 9681 }, 9682 "/metrics/getEdgeSegmentSeries": { 9683 "post": { 9684 "summary": "Get flow metric time series data by segment id", 9685 "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.\n\nPrivileges required:\n\n`READ` `EDGE`\n\n`VIEW_FLOW_STATS` `undefined`", 9686 "tags": [ 9687 "all", 9688 "metrics" 9689 ], 9690 "operationId": "metrics_get_edge_segment_series", 9691 "x-privileges": { 9692 "forceEnterpriseContext": true, 9693 "excludeAuthTypes": [], 9694 "allowAuthTypes": [ 9695 "ANY" 9696 ], 9697 "allowPrincipleTypes": [], 9698 "excludePrincipleTypes": [ 9699 "EDGE", 9700 "GATEWAY" 9701 ], 9702 "requirePrivileges": [ 9703 { 9704 "action": "READ", 9705 "object": "EDGE" 9706 }, 9707 { 9708 "action": "VIEW_FLOW_STATS" 9709 } 9710 ] 9711 }, 9712 "parameters": [ 9713 { 9714 "name": "body", 9715 "in": "body", 9716 "required": true, 9717 "schema": { 9718 "type": "object", 9719 "title": "metrics_get_edge_segment_series", 9720 "properties": { 9721 "id": { 9722 "type": "integer" 9723 }, 9724 "edgeId": { 9725 "type": "integer" 9726 }, 9727 "enterpriseId": { 9728 "type": "integer" 9729 }, 9730 "interval": { 9731 "$ref": "#/definitions/interval" 9732 }, 9733 "metrics": { 9734 "$ref": "#/definitions/basic_metrics" 9735 }, 9736 "sort": { 9737 "$ref": "#/definitions/basic_metric" 9738 }, 9739 "limit": { 9740 "type": "integer" 9741 }, 9742 "maxSamples": { 9743 "type": "integer" 9744 }, 9745 "segments": { 9746 "type": "array", 9747 "items": { 9748 "type": "string" 9749 } 9750 } 9751 }, 9752 "required": [ 9753 "interval" 9754 ] 9755 } 9756 } 9757 ], 9758 "responses": { 9759 "200": { 9760 "schema": { 9761 "title": "metrics_get_edge_segment_series_result", 9762 "type": "array", 9763 "items": { 9764 "$ref": "#/definitions/metrics_get_edge_segment_series_result_item" 9765 } 9766 }, 9767 "description": "Request was successfully processed" 9768 }, 9769 "400": { 9770 "$ref": "#/responses/generic_400" 9771 }, 9772 "500": { 9773 "$ref": "#/responses/generic_500" 9774 } 9775 } 9776 } 9777 }, 9778 "/metrics/getEdgeStatusMetrics": { 9779 "post": { 9780 "summary": "Get Edge healthStats metrics for an interval", 9781 "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\n\nPrivileges required:\n\n`READ` `EDGE`", 9782 "tags": [ 9783 "all", 9784 "metrics" 9785 ], 9786 "operationId": "metrics_get_edge_status_metrics", 9787 "x-privileges": { 9788 "forceEnterpriseContext": true, 9789 "excludeAuthTypes": [], 9790 "allowAuthTypes": [ 9791 "ANY" 9792 ], 9793 "allowPrincipleTypes": [], 9794 "excludePrincipleTypes": [ 9795 "EDGE", 9796 "GATEWAY" 9797 ], 9798 "requirePrivileges": [ 9799 { 9800 "action": "READ", 9801 "object": "EDGE" 9802 } 9803 ] 9804 }, 9805 "parameters": [ 9806 { 9807 "name": "body", 9808 "in": "body", 9809 "required": true, 9810 "schema": { 9811 "type": "object", 9812 "title": "metrics_get_edge_status_metrics", 9813 "properties": { 9814 "edgeId": { 9815 "type": "integer" 9816 }, 9817 "interval": { 9818 "$ref": "#/definitions/interval" 9819 }, 9820 "metrics": { 9821 "$ref": "#/definitions/edge_metrics" 9822 } 9823 }, 9824 "required": [ 9825 "edgeId" 9826 ] 9827 } 9828 } 9829 ], 9830 "responses": { 9831 "200": { 9832 "schema": { 9833 "$ref": "#/definitions/edge_status_metrics_summary" 9834 }, 9835 "description": "Request was successfully processed" 9836 }, 9837 "400": { 9838 "$ref": "#/responses/generic_400" 9839 }, 9840 "500": { 9841 "$ref": "#/responses/generic_500" 9842 } 9843 } 9844 } 9845 }, 9846 "/metrics/getEdgeStatusSeries": { 9847 "post": { 9848 "summary": "Get Edge healthStats time series for an interval ", 9849 "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\n\nPrivileges required:\n\n`READ` `EDGE`", 9850 "tags": [ 9851 "all", 9852 "metrics" 9853 ], 9854 "operationId": "metrics_get_edge_status_series", 9855 "x-privileges": { 9856 "forceEnterpriseContext": true, 9857 "excludeAuthTypes": [], 9858 "allowAuthTypes": [ 9859 "ANY" 9860 ], 9861 "allowPrincipleTypes": [], 9862 "excludePrincipleTypes": [ 9863 "EDGE", 9864 "GATEWAY" 9865 ], 9866 "requirePrivileges": [ 9867 { 9868 "action": "READ", 9869 "object": "EDGE" 9870 } 9871 ] 9872 }, 9873 "parameters": [ 9874 { 9875 "name": "body", 9876 "in": "body", 9877 "required": true, 9878 "schema": { 9879 "type": "object", 9880 "title": "metrics_get_edge_status_series", 9881 "properties": { 9882 "edgeId": { 9883 "type": "integer" 9884 }, 9885 "interval": { 9886 "$ref": "#/definitions/interval" 9887 }, 9888 "metrics": { 9889 "$ref": "#/definitions/edge_metrics" 9890 } 9891 }, 9892 "required": [ 9893 "edgeId" 9894 ] 9895 } 9896 } 9897 ], 9898 "responses": { 9899 "200": { 9900 "schema": { 9901 "$ref": "#/definitions/get_edge_status_metrics_time_series_result" 9902 }, 9903 "description": "Request was successfully processed" 9904 }, 9905 "400": { 9906 "$ref": "#/responses/generic_400" 9907 }, 9908 "500": { 9909 "$ref": "#/responses/generic_500" 9910 } 9911 } 9912 } 9913 }, 9914 "/metrics/getGatewayStatusMetrics": { 9915 "post": { 9916 "summary": "Get Gateway health metric summaries for an interval", 9917 "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\n\nPrivileges required:\n\n`READ` `GATEWAY`", 9918 "tags": [ 9919 "all", 9920 "metrics" 9921 ], 9922 "operationId": "metrics_get_gateway_status_metrics", 9923 "x-privileges": { 9924 "excludeAuthTypes": [], 9925 "allowAuthTypes": [ 9926 "OPERATOR_USER", 9927 "MSP_USER" 9928 ], 9929 "allowPrincipleTypes": [], 9930 "excludePrincipleTypes": [ 9931 "EDGE", 9932 "GATEWAY" 9933 ], 9934 "requirePrivileges": [ 9935 { 9936 "action": "READ", 9937 "object": "GATEWAY" 9938 } 9939 ] 9940 }, 9941 "parameters": [ 9942 { 9943 "name": "body", 9944 "in": "body", 9945 "required": true, 9946 "schema": { 9947 "type": "object", 9948 "title": "metrics_get_gateway_status_metrics", 9949 "properties": { 9950 "gatewayId": { 9951 "type": "integer" 9952 }, 9953 "interval": { 9954 "$ref": "#/definitions/interval" 9955 }, 9956 "metrics": { 9957 "$ref": "#/definitions/gateway_metrics" 9958 } 9959 }, 9960 "required": [ 9961 "gatewayId" 9962 ] 9963 } 9964 } 9965 ], 9966 "responses": { 9967 "200": { 9968 "schema": { 9969 "$ref": "#/definitions/gateway_status_metrics_summary" 9970 }, 9971 "description": "Request was successfully processed" 9972 }, 9973 "400": { 9974 "$ref": "#/responses/generic_400" 9975 }, 9976 "500": { 9977 "$ref": "#/responses/generic_500" 9978 } 9979 } 9980 } 9981 }, 9982 "/metrics/getGatewayStatusSeries": { 9983 "post": { 9984 "summary": "Get Gateway health metric time series for an interval", 9985 "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.\n\nPrivileges required:\n\n`READ` `GATEWAY`", 9986 "tags": [ 9987 "all", 9988 "metrics" 9989 ], 9990 "operationId": "metrics_get_gateway_status_series", 9991 "x-privileges": { 9992 "excludeAuthTypes": [], 9993 "allowAuthTypes": [ 9994 "OPERATOR_USER", 9995 "MSP_USER" 9996 ], 9997 "allowPrincipleTypes": [], 9998 "excludePrincipleTypes": [ 9999 "EDGE", 10000 "GATEWAY" 10001 ], 10002 "requirePrivileges": [ 10003 { 10004 "action": "READ", 10005 "object": "GATEWAY" 10006 } 10007 ] 10008 }, 10009 "parameters": [ 10010 { 10011 "name": "body", 10012 "in": "body", 10013 "required": true, 10014 "schema": { 10015 "type": "object", 10016 "title": "metrics_get_gateway_status_series", 10017 "properties": { 10018 "gatewayId": { 10019 "type": "integer" 10020 }, 10021 "interval": { 10022 "$ref": "#/definitions/interval" 10023 }, 10024 "metrics": { 10025 "$ref": "#/definitions/gateway_metrics" 10026 } 10027 }, 10028 "required": [ 10029 "gatewayId" 10030 ] 10031 } 10032 } 10033 ], 10034 "responses": { 10035 "200": { 10036 "schema": { 10037 "$ref": "#/definitions/get_gateway_status_metrics_time_series_result" 10038 }, 10039 "description": "Request was successfully processed" 10040 }, 10041 "400": { 10042 "$ref": "#/responses/generic_400" 10043 }, 10044 "500": { 10045 "$ref": "#/responses/generic_500" 10046 } 10047 } 10048 } 10049 }, 10050 "/monitoring/getAggregateEdgeLinkMetrics": { 10051 "post": { 10052 "summary": "Get aggregate Edge link metrics across enterprises", 10053 "tags": [ 10054 "all", 10055 "monitoring" 10056 ], 10057 "description": "Gets aggregate link metrics for the request interval for all active links across all enterprises, where a link is considered to be active if an Edge has reported any activity for it in the last 24 hours. On success, returns an array of network utilization metrics, one per link.\n\nPrivileges required:\n\n`READ` `ENTERPRISE`\n\n`READ` `EDGE`", 10058 "operationId": "monitoring_get_aggregate_edge_link_metrics", 10059 "x-privileges": { 10060 "excludeAuthTypes": [], 10061 "allowAuthTypes": [ 10062 "OPERATOR_USER", 10063 "MSP_USER", 10064 "ENTERPRISE_USER" 10065 ], 10066 "allowPrincipleTypes": [], 10067 "excludePrincipleTypes": [ 10068 "EDGE", 10069 "GATEWAY" 10070 ], 10071 "requirePrivileges": [ 10072 { 10073 "action": "READ", 10074 "object": "ENTERPRISE" 10075 }, 10076 { 10077 "action": "READ", 10078 "object": "EDGE" 10079 } 10080 ] 10081 }, 10082 "parameters": [ 10083 { 10084 "name": "body", 10085 "in": "body", 10086 "required": true, 10087 "schema": { 10088 "type": "object", 10089 "title": "monitoring_get_aggregate_edge_link_metrics", 10090 "properties": { 10091 "enterprises": { 10092 "type": "array", 10093 "items": { 10094 "type": "integer" 10095 } 10096 }, 10097 "metrics": { 10098 "type": "array", 10099 "items": { 10100 "$ref": "#/definitions/edge_link_metric" 10101 } 10102 }, 10103 "interval": { 10104 "$ref": "#/definitions/interval" 10105 } 10106 } 10107 } 10108 } 10109 ], 10110 "responses": { 10111 "200": { 10112 "description": "Request was successfully processed", 10113 "schema": { 10114 "title": "monitoring_get_aggregate_edge_link_metrics_result", 10115 "type": "array", 10116 "items": { 10117 "$ref": "#/definitions/monitoring_get_aggregate_edge_link_metrics_result_item" 10118 } 10119 } 10120 }, 10121 "400": { 10122 "$ref": "#/responses/generic_400" 10123 }, 10124 "500": { 10125 "$ref": "#/responses/generic_500" 10126 } 10127 } 10128 } 10129 }, 10130 "/monitoring/getAggregateEnterpriseEvents": { 10131 "post": { 10132 "summary": "Get events across all enterprises", 10133 "tags": [ 10134 "all", 10135 "monitoring" 10136 ], 10137 "description": "Gets events across all enterprises in a paginated list. When called in the MSP/Partner context, queries only enterprises managed by the MSP.\n\nPrivileges required:\n\n`READ` `ENTERPRISE`\n\n`READ` `EDGE`", 10138 "x-privileges": { 10139 "excludeAuthTypes": [], 10140 "allowAuthTypes": [ 10141 "OPERATOR_USER", 10142 "MSP_USER" 10143 ], 10144 "allowPrincipleTypes": [], 10145 "excludePrincipleTypes": [ 10146 "EDGE", 10147 "GATEWAY" 10148 ], 10149 "requirePrivileges": [ 10150 { 10151 "action": "READ", 10152 "object": "ENTERPRISE" 10153 }, 10154 { 10155 "action": "READ", 10156 "object": "EDGE" 10157 } 10158 ] 10159 }, 10160 "operationId": "monitoring_get_aggregate_enterprise_events", 10161 "parameters": [ 10162 { 10163 "name": "body", 10164 "in": "body", 10165 "required": true, 10166 "schema": { 10167 "type": "object", 10168 "title": "monitoring_get_aggregate_enterprise_events", 10169 "properties": { 10170 "detail": { 10171 "type": "boolean" 10172 }, 10173 "interval": { 10174 "$ref": "#/definitions/interval" 10175 }, 10176 "filter": { 10177 "type": "object", 10178 "required": [ 10179 "limit" 10180 ], 10181 "properties": { 10182 "limit": { 10183 "type": "integer", 10184 "default": 2048 10185 } 10186 } 10187 } 10188 } 10189 } 10190 } 10191 ], 10192 "responses": { 10193 "200": { 10194 "schema": { 10195 "$ref": "#/definitions/monitoring_get_aggregate_enterprise_events_result" 10196 }, 10197 "description": "Request was successfully processed" 10198 }, 10199 "400": { 10200 "$ref": "#/responses/generic_400" 10201 }, 10202 "500": { 10203 "$ref": "#/responses/generic_500" 10204 } 10205 } 10206 } 10207 }, 10208 "/monitoring/getAggregates": { 10209 "post": { 10210 "summary": "Get aggregate enterprise and Edge information", 10211 "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.\n\nPrivileges required:\n\n`READ` `ENTERPRISE`\n\n`READ` `EDGE`", 10212 "tags": [ 10213 "all", 10214 "monitoring" 10215 ], 10216 "operationId": "monitoring_get_aggregates", 10217 "x-privileges": { 10218 "excludeAuthTypes": [], 10219 "allowAuthTypes": [ 10220 "OPERATOR_USER", 10221 "MSP_USER" 10222 ], 10223 "allowPrincipleTypes": [], 10224 "excludePrincipleTypes": [ 10225 "EDGE", 10226 "GATEWAY" 10227 ], 10228 "requirePrivileges": [ 10229 { 10230 "action": "READ", 10231 "object": "ENTERPRISE" 10232 }, 10233 { 10234 "action": "READ", 10235 "object": "EDGE" 10236 } 10237 ] 10238 }, 10239 "parameters": [ 10240 { 10241 "name": "body", 10242 "in": "body", 10243 "required": true, 10244 "schema": { 10245 "type": "object", 10246 "title": "monitoring_get_aggregates", 10247 "properties": { 10248 "enterpriseId": { 10249 "type": "integer" 10250 }, 10251 "id": { 10252 "type": "integer" 10253 } 10254 } 10255 } 10256 } 10257 ], 10258 "responses": { 10259 "200": { 10260 "schema": { 10261 "$ref": "#/definitions/monitoring_get_aggregates_result" 10262 }, 10263 "description": "Request was successfully processed" 10264 }, 10265 "400": { 10266 "$ref": "#/responses/generic_400" 10267 }, 10268 "500": { 10269 "$ref": "#/responses/generic_500" 10270 } 10271 } 10272 } 10273 }, 10274 "/monitoring/getEnterpriseBgpPeerStatus": { 10275 "post": { 10276 "summary": "Get gateway BGP peer status for all enterprise gateways", 10277 "tags": [ 10278 "all", 10279 "monitoring" 10280 ], 10281 "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.\n\nPrivileges required:\n\n`READ` `NETWORK_SERVICE`", 10282 "operationId": "monitoring_get_enterprise_bgp_peer_status", 10283 "x-privileges": { 10284 "excludeAuthTypes": [], 10285 "allowAuthTypes": [ 10286 "ANY" 10287 ], 10288 "allowPrincipleTypes": [], 10289 "excludePrincipleTypes": [ 10290 "EDGE", 10291 "GATEWAY" 10292 ], 10293 "requirePrivileges": [ 10294 { 10295 "action": "READ", 10296 "object": "NETWORK_SERVICE" 10297 } 10298 ] 10299 }, 10300 "parameters": [ 10301 { 10302 "name": "body", 10303 "in": "body", 10304 "required": true, 10305 "schema": { 10306 "type": "object", 10307 "properties": { 10308 "enterpriseId": { 10309 "type": "integer" 10310 } 10311 } 10312 } 10313 } 10314 ], 10315 "responses": { 10316 "200": { 10317 "schema": { 10318 "title": "monitoring_get_enterprise_bgp_peer_status_result", 10319 "type": "array", 10320 "items": { 10321 "$ref": "#/definitions/monitoring_get_enterprise_bgp_peer_status_result_item" 10322 } 10323 }, 10324 "description": "Request was successfully processed" 10325 }, 10326 "400": { 10327 "$ref": "#/responses/generic_400" 10328 }, 10329 "500": { 10330 "$ref": "#/responses/generic_500" 10331 } 10332 } 10333 } 10334 }, 10335 "/monitoring/getEnterpriseEdgeBgpPeerStatus": { 10336 "post": { 10337 "summary": "Get Edge BGP peer status for all enterprise Edges", 10338 "tags": [ 10339 "all", 10340 "monitoring" 10341 ], 10342 "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.\n\nPrivileges required:\n\n`READ` `EDGE`", 10343 "operationId": "monitoring_get_enterprise_edge_bgp_peer_status", 10344 "x-privileges": { 10345 "excludeAuthTypes": [], 10346 "allowAuthTypes": [ 10347 "ANY" 10348 ], 10349 "allowPrincipleTypes": [], 10350 "excludePrincipleTypes": [ 10351 "EDGE", 10352 "EDGE" 10353 ], 10354 "requirePrivileges": [ 10355 { 10356 "action": "READ", 10357 "object": "EDGE" 10358 } 10359 ] 10360 }, 10361 "parameters": [ 10362 { 10363 "name": "body", 10364 "in": "body", 10365 "required": true, 10366 "schema": { 10367 "type": "object", 10368 "properties": { 10369 "enterpriseId": { 10370 "type": "integer" 10371 } 10372 } 10373 } 10374 } 10375 ], 10376 "responses": { 10377 "200": { 10378 "schema": { 10379 "title": "monitoring_get_enterprise_edge_bgp_peer_status_result", 10380 "type": "array", 10381 "items": { 10382 "$ref": "#/definitions/monitoring_get_enterprise_edge_bgp_peer_status_result_item" 10383 } 10384 }, 10385 "description": "Request was successfully processed" 10386 }, 10387 "400": { 10388 "$ref": "#/responses/generic_400" 10389 }, 10390 "500": { 10391 "$ref": "#/responses/generic_500" 10392 } 10393 } 10394 } 10395 }, 10396 "/monitoring/getEnterpriseEdgeClusterStatus": { 10397 "post": { 10398 "summary": "Get Edge Cluster status", 10399 "description": "Get edge`s utilization data by clusters\n\nPrivileges required:\n\n`READ` `EDGE`", 10400 "tags": [ 10401 "all", 10402 "monitoring" 10403 ], 10404 "operationId": "monitoring_get_enterprise_edge_cluster_status", 10405 "x-privileges": { 10406 "excludeAuthTypes": [], 10407 "allowAuthTypes": [ 10408 "OPERATOR_USER", 10409 "MSP_USER", 10410 "ENTERPRISE_USER" 10411 ], 10412 "allowPrincipleTypes": [], 10413 "excludePrincipleTypes": [ 10414 "EDGE", 10415 "GATEWAY" 10416 ], 10417 "requirePrivileges": [ 10418 { 10419 "action": "READ", 10420 "object": "EDGE" 10421 } 10422 ] 10423 }, 10424 "parameters": [ 10425 { 10426 "name": "body", 10427 "in": "body", 10428 "required": true, 10429 "schema": { 10430 "type": "object", 10431 "title": "monitoring_get_enterprise_edge_cluster_status", 10432 "properties": { 10433 "enterpriseId": { 10434 "type": "integer" 10435 }, 10436 "metrics": { 10437 "$ref": "#/definitions/edge_metrics" 10438 } 10439 }, 10440 "required": [ 10441 "enterpriseId" 10442 ] 10443 } 10444 } 10445 ], 10446 "responses": { 10447 "200": { 10448 "schema": { 10449 "type": "array", 10450 "items": { 10451 "type": "object", 10452 "properties": { 10453 "edgeId": { 10454 "type": "integer" 10455 }, 10456 "edgeName": { 10457 "type": "string" 10458 }, 10459 "tunnelCount": { 10460 "type": "integer" 10461 }, 10462 "memoryPct": { 10463 "type": "number" 10464 }, 10465 "flowCount": { 10466 "type": "number" 10467 }, 10468 "cpuPct": { 10469 "type": "number" 10470 }, 10471 "handoffQueueDrops": { 10472 "type": "integer" 10473 } 10474 } 10475 } 10476 }, 10477 "description": "Request was successfully processed" 10478 }, 10479 "400": { 10480 "$ref": "#/responses/generic_400" 10481 }, 10482 "500": { 10483 "$ref": "#/responses/generic_500" 10484 } 10485 } 10486 } 10487 }, 10488 "/monitoring/getEnterpriseEdgeLinkStatus": { 10489 "post": { 10490 "summary": "Get Edge and link status data", 10491 "tags": [ 10492 "all", 10493 "monitoring" 10494 ], 10495 "description": "Gets the current Edge and Edge-link status for all enterprises. edges.\n\nPrivileges required:\n\n`READ` `ENTERPRISE`\n\n`READ` `EDGE`", 10496 "operationId": "monitoring_get_enterprise_edge_link_status", 10497 "x-privileges": { 10498 "excludeAuthTypes": [], 10499 "allowAuthTypes": [ 10500 "OPERATOR_USER", 10501 "MSP_USER" 10502 ], 10503 "allowPrincipleTypes": [], 10504 "excludePrincipleTypes": [ 10505 "EDGE", 10506 "GATEWAY" 10507 ], 10508 "requirePrivileges": [ 10509 { 10510 "action": "READ", 10511 "object": "ENTERPRISE" 10512 }, 10513 { 10514 "action": "READ", 10515 "object": "EDGE" 10516 } 10517 ] 10518 }, 10519 "parameters": [ 10520 { 10521 "name": "body", 10522 "in": "body", 10523 "required": true, 10524 "schema": { 10525 "type": "object", 10526 "properties": { 10527 "enterprises": { 10528 "type": "array", 10529 "items": { 10530 "type": "integer" 10531 } 10532 }, 10533 "enterpriseProxyId": { 10534 "type": "integer" 10535 }, 10536 "networkId": { 10537 "type": "integer" 10538 }, 10539 "links": { 10540 "type": "boolean", 10541 "default": true 10542 } 10543 } 10544 } 10545 } 10546 ], 10547 "responses": { 10548 "200": { 10549 "schema": { 10550 "type": "array", 10551 "items": { 10552 "$ref": "#/definitions/monitoring_get_enterprise_edge_link_status_result_item" 10553 } 10554 }, 10555 "description": "Request was successfully processed" 10556 }, 10557 "400": { 10558 "$ref": "#/responses/generic_400" 10559 }, 10560 "500": { 10561 "$ref": "#/responses/generic_500" 10562 } 10563 } 10564 } 10565 }, 10566 "/monitoring/getEnterpriseEdgeStatus": { 10567 "post": { 10568 "summary": "Get Enterprise Edge monitoring status", 10569 "description": "Fetch Enterprise Edge monitoring status time series for the given time interval, all for the enterprise or list of edgess, and list of metrics. On success, this method returns anarray of edge monitoring statuses.\n\nPrivileges required:\n\n`READ` `EDGE`", 10570 "tags": [ 10571 "all", 10572 "monitoring" 10573 ], 10574 "operationId": "monitoring_get_enterprise_edge_status", 10575 "x-privileges": { 10576 "forceEnterpriseContext": true, 10577 "excludeAuthTypes": [], 10578 "allowAuthTypes": [ 10579 "ANY" 10580 ], 10581 "allowPrincipleTypes": [], 10582 "excludePrincipleTypes": [ 10583 "EDGE", 10584 "GATEWAY" 10585 ], 10586 "requirePrivileges": [ 10587 { 10588 "action": "READ", 10589 "object": "EDGE" 10590 } 10591 ] 10592 }, 10593 "parameters": [ 10594 { 10595 "name": "body", 10596 "in": "body", 10597 "required": true, 10598 "schema": { 10599 "type": "object", 10600 "title": "monitoring_get_enterprise_edge_status", 10601 "properties": { 10602 "enterpriseId": { 10603 "type": "integer" 10604 }, 10605 "edgeIds": { 10606 "type": "array", 10607 "items": { 10608 "type": "integer" 10609 } 10610 }, 10611 "time": { 10612 "$ref": "#/definitions/js_date_formats" 10613 }, 10614 "sort": { 10615 "$ref": "#/definitions/edge_metric" 10616 }, 10617 "limit": { 10618 "type": "integer" 10619 }, 10620 "metrics": { 10621 "$ref": "#/definitions/edge_metrics" 10622 } 10623 }, 10624 "required": [ 10625 "enterpriseId", 10626 "sort" 10627 ] 10628 } 10629 } 10630 ], 10631 "responses": { 10632 "200": { 10633 "schema": { 10634 "$ref": "#/definitions/monitoring_get_enterprise_edge_status_result" 10635 }, 10636 "description": "Request was successfully processed" 10637 }, 10638 "400": { 10639 "$ref": "#/responses/generic_400" 10640 }, 10641 "500": { 10642 "$ref": "#/responses/generic_500" 10643 } 10644 } 10645 } 10646 }, 10647 "/monitoring/getNetworkGatewayStatus": { 10648 "post": { 10649 "summary": "Get Network Gateway monitoring status", 10650 "description": "Fetch Network Gateway monitoring status time series for the given time interval, all for the network or list of gateways, and list of metrics. On success, this method returns anarray of gateway monitoring statuses.\n\nPrivileges required:\n\n`READ` `GATEWAY`", 10651 "tags": [ 10652 "all", 10653 "monitoring" 10654 ], 10655 "operationId": "monitoring_get_network_gateway_status", 10656 "x-privileges": { 10657 "excludeAuthTypes": [], 10658 "allowAuthTypes": [ 10659 "OPERATOR_USER", 10660 "MSP_USER" 10661 ], 10662 "allowPrincipleTypes": [], 10663 "excludePrincipleTypes": [ 10664 "EDGE", 10665 "GATEWAY" 10666 ], 10667 "requirePrivileges": [ 10668 { 10669 "action": "READ", 10670 "object": "GATEWAY" 10671 } 10672 ] 10673 }, 10674 "parameters": [ 10675 { 10676 "name": "body", 10677 "in": "body", 10678 "required": true, 10679 "schema": { 10680 "type": "object", 10681 "title": "monitoring_get_network_gateway_status", 10682 "properties": { 10683 "networkId": { 10684 "type": "integer" 10685 }, 10686 "gatewayIds": { 10687 "type": "array", 10688 "items": { 10689 "type": "integer" 10690 } 10691 }, 10692 "time": { 10693 "format": "date-time", 10694 "type": "string" 10695 }, 10696 "sort": { 10697 "$ref": "#/definitions/gateway_metric" 10698 }, 10699 "limit": { 10700 "type": "integer" 10701 }, 10702 "metrics": { 10703 "$ref": "#/definitions/gateway_metrics" 10704 } 10705 }, 10706 "required": [ 10707 "networkId", 10708 "sort" 10709 ] 10710 } 10711 } 10712 ], 10713 "responses": { 10714 "200": { 10715 "schema": { 10716 "$ref": "#/definitions/monitoring_get_network_gateway_status_result" 10717 }, 10718 "description": "Request was successfully processed" 10719 }, 10720 "400": { 10721 "$ref": "#/responses/generic_400" 10722 }, 10723 "500": { 10724 "$ref": "#/responses/generic_500" 10725 } 10726 } 10727 } 10728 }, 10729 "/network/deleteNetworkGatewayPool": { 10730 "post": { 10731 "summary": "Delete gateway pool", 10732 "description": "Deletes the specified gateway pool (by `id`).\n\nPrivileges required:\n\n`DELETE` `GATEWAY`", 10733 "operationId": "network_delete_network_gateway_pool", 10734 "x-privileges": { 10735 "excludeAuthTypes": [], 10736 "allowAuthTypes": [ 10737 "OPERATOR_USER", 10738 "MSP_USER" 10739 ], 10740 "allowPrincipleTypes": [], 10741 "excludePrincipleTypes": [ 10742 "EDGE", 10743 "GATEWAY" 10744 ], 10745 "requirePrivileges": [ 10746 { 10747 "action": "DELETE", 10748 "object": "GATEWAY" 10749 } 10750 ] 10751 }, 10752 "tags": [ 10753 "network", 10754 "all" 10755 ], 10756 "parameters": [ 10757 { 10758 "name": "body", 10759 "in": "body", 10760 "required": true, 10761 "schema": { 10762 "type": "object", 10763 "title": "network_delete_network_gateway_pool", 10764 "properties": { 10765 "networkId": { 10766 "type": "integer" 10767 }, 10768 "enterpriseProxyId": { 10769 "type": "integer" 10770 }, 10771 "id": { 10772 "type": "integer", 10773 "description": "alias for `gatewayPoolId`" 10774 }, 10775 "gatewayPoolId": { 10776 "type": "integer" 10777 } 10778 }, 10779 "required": [ 10780 "id" 10781 ] 10782 } 10783 } 10784 ], 10785 "responses": { 10786 "200": { 10787 "schema": { 10788 "$ref": "#/definitions/network_delete_network_gateway_pool_result" 10789 }, 10790 "description": "Request was successfully processed" 10791 }, 10792 "400": { 10793 "$ref": "#/responses/generic_400" 10794 }, 10795 "500": { 10796 "$ref": "#/responses/generic_500" 10797 } 10798 } 10799 } 10800 }, 10801 "/network/getNetworkConfigurations": { 10802 "post": { 10803 "summary": "Get operator configuration profiles", 10804 "tags": [ 10805 "all", 10806 "network" 10807 ], 10808 "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.\n\nPrivileges required:\n\n`READ` `OPERATOR_PROFILE`", 10809 "operationId": "network_get_network_configurations", 10810 "x-privileges": { 10811 "excludeAuthTypes": [], 10812 "allowAuthTypes": [ 10813 "OPERATOR_USER" 10814 ], 10815 "allowPrincipleTypes": [], 10816 "excludePrincipleTypes": [ 10817 "EDGE", 10818 "GATEWAY" 10819 ], 10820 "requirePrivileges": [ 10821 { 10822 "action": "READ", 10823 "object": "OPERATOR_PROFILE" 10824 } 10825 ] 10826 }, 10827 "parameters": [ 10828 { 10829 "name": "body", 10830 "in": "body", 10831 "required": true, 10832 "schema": { 10833 "type": "object", 10834 "title": "network_get_network_configurations", 10835 "properties": { 10836 "id": { 10837 "type": "integer" 10838 }, 10839 "networkId": { 10840 "type": "integer" 10841 }, 10842 "with": { 10843 "type": "array", 10844 "items": { 10845 "type": "string", 10846 "enum": [ 10847 "modules", 10848 "counts" 10849 ] 10850 } 10851 } 10852 } 10853 } 10854 } 10855 ], 10856 "responses": { 10857 "200": { 10858 "schema": { 10859 "title": "network_get_network_configurations_result", 10860 "type": "array", 10861 "items": { 10862 "$ref": "#/definitions/network_get_network_configurations_result_item" 10863 } 10864 }, 10865 "description": "Request was successfully processed" 10866 }, 10867 "400": { 10868 "$ref": "#/responses/generic_400" 10869 }, 10870 "500": { 10871 "$ref": "#/responses/generic_500" 10872 } 10873 } 10874 } 10875 }, 10876 "/network/getNetworkEnterprises": { 10877 "post": { 10878 "summary": "Get enterprises on network", 10879 "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.\n\nPrivileges required:\n\n`READ` `ENTERPRISE`", 10880 "tags": [ 10881 "all", 10882 "network" 10883 ], 10884 "x-privileges": { 10885 "excludeAuthTypes": [], 10886 "allowAuthTypes": [ 10887 "OPERATOR_USER" 10888 ], 10889 "allowPrincipleTypes": [], 10890 "excludePrincipleTypes": [ 10891 "EDGE", 10892 "GATEWAY" 10893 ], 10894 "requirePrivileges": [ 10895 { 10896 "action": "READ", 10897 "object": "ENTERPRISE" 10898 } 10899 ] 10900 }, 10901 "operationId": "network_get_network_enterprises", 10902 "parameters": [ 10903 { 10904 "name": "body", 10905 "in": "body", 10906 "required": true, 10907 "schema": { 10908 "type": "object", 10909 "title": "network_get_network_enterprises", 10910 "properties": { 10911 "networkId": { 10912 "type": "integer" 10913 }, 10914 "id": { 10915 "type": "integer" 10916 }, 10917 "with": { 10918 "type": "array", 10919 "items": { 10920 "type": "string", 10921 "enum": [ 10922 "edges", 10923 "edgeCount", 10924 "edgeConfigUpdate" 10925 ] 10926 } 10927 } 10928 } 10929 } 10930 } 10931 ], 10932 "responses": { 10933 "200": { 10934 "schema": { 10935 "title": "network_get_network_enterprises_result", 10936 "type": "array", 10937 "items": { 10938 "$ref": "#/definitions/network_get_network_enterprises_result_item" 10939 } 10940 }, 10941 "description": "Request was successfully processed" 10942 }, 10943 "400": { 10944 "$ref": "#/responses/generic_400" 10945 }, 10946 "500": { 10947 "$ref": "#/responses/generic_500" 10948 } 10949 } 10950 } 10951 }, 10952 "/network/getNetworkGatewayPools": { 10953 "post": { 10954 "summary": "Get gateway pools on network", 10955 "tags": [ 10956 "all", 10957 "network" 10958 ], 10959 "description": "Gets all gateway pools associated with the specified network. Optionally includes the gateways or enterprises belonging to each pool.\n\nPrivileges required:\n\n`READ` `GATEWAY`", 10960 "operationId": "network_get_network_gateway_pools", 10961 "x-privileges": { 10962 "excludeAuthTypes": [], 10963 "allowAuthTypes": [ 10964 "OPERATOR_USER", 10965 "MSP_USER" 10966 ], 10967 "allowPrincipleTypes": [], 10968 "excludePrincipleTypes": [ 10969 "EDGE", 10970 "GATEWAY" 10971 ], 10972 "requirePrivileges": [ 10973 { 10974 "action": "READ", 10975 "object": "GATEWAY" 10976 } 10977 ] 10978 }, 10979 "parameters": [ 10980 { 10981 "name": "body", 10982 "in": "body", 10983 "required": true, 10984 "schema": { 10985 "type": "object", 10986 "title": "network_get_network_gateway_pools", 10987 "properties": { 10988 "id": { 10989 "type": "integer" 10990 }, 10991 "networkId": { 10992 "type": "integer" 10993 }, 10994 "with": { 10995 "type": "array", 10996 "items": { 10997 "type": "string", 10998 "enum": [ 10999 "gateways", 11000 "enterprises" 11001 ] 11002 } 11003 } 11004 } 11005 } 11006 } 11007 ], 11008 "responses": { 11009 "200": { 11010 "schema": { 11011 "title": "network_get_network_gateway_pools_result", 11012 "type": "array", 11013 "items": { 11014 "$ref": "#/definitions/network_get_network_gateway_pools_result_item" 11015 } 11016 }, 11017 "description": "Request was successfully processed" 11018 }, 11019 "400": { 11020 "$ref": "#/responses/generic_400" 11021 }, 11022 "500": { 11023 "$ref": "#/responses/generic_500" 11024 } 11025 } 11026 } 11027 }, 11028 "/network/getNetworkGateways": { 11029 "post": { 11030 "summary": "Get gateways on network", 11031 "description": "Gets all gateways associated with the specified network.\n\nPrivileges required:\n\n`READ` `GATEWAY`", 11032 "tags": [ 11033 "network", 11034 "all" 11035 ], 11036 "operationId": "network_get_network_gateways", 11037 "x-privileges": { 11038 "excludeAuthTypes": [], 11039 "allowAuthTypes": [ 11040 "OPERATOR_USER", 11041 "MSP_USER" 11042 ], 11043 "allowPrincipleTypes": [], 11044 "excludePrincipleTypes": [ 11045 "EDGE", 11046 "GATEWAY" 11047 ], 11048 "requirePrivileges": [ 11049 { 11050 "action": "READ", 11051 "object": "GATEWAY" 11052 } 11053 ] 11054 }, 11055 "parameters": [ 11056 { 11057 "name": "body", 11058 "in": "body", 11059 "required": true, 11060 "schema": { 11061 "type": "object", 11062 "title": "network_get_network_gateways", 11063 "properties": { 11064 "networkId": { 11065 "type": "integer" 11066 }, 11067 "gatewayIds": { 11068 "type": "array", 11069 "items": { 11070 "type": "string" 11071 } 11072 }, 11073 "with": { 11074 "type": "array", 11075 "items": { 11076 "type": "string", 11077 "enum": [ 11078 "site", 11079 "pools", 11080 "enterprises", 11081 "enterpriseAssociations", 11082 "enterpriseAssociationCounts", 11083 "dataCenters", 11084 "certificates", 11085 "handOffEdges", 11086 "roles" 11087 ] 11088 } 11089 } 11090 } 11091 } 11092 } 11093 ], 11094 "responses": { 11095 "200": { 11096 "schema": { 11097 "title": "network_get_network_gateways_result", 11098 "type": "array", 11099 "items": { 11100 "$ref": "#/definitions/network_get_network_gateways_result_item" 11101 } 11102 }, 11103 "description": "Request was successfully processed" 11104 }, 11105 "400": { 11106 "$ref": "#/responses/generic_400" 11107 }, 11108 "500": { 11109 "$ref": "#/responses/generic_500" 11110 } 11111 } 11112 } 11113 }, 11114 "/network/getNetworkOperatorUsers": { 11115 "post": { 11116 "summary": "Get operator users for network", 11117 "description": "Gets all operator users associated with the specified network.\n\nPrivileges required:\n\n`READ` `OPERATOR_USER`", 11118 "tags": [ 11119 "all", 11120 "network" 11121 ], 11122 "operationId": "network_get_network_operator_users", 11123 "x-privileges": { 11124 "excludeAuthTypes": [], 11125 "allowAuthTypes": [ 11126 "OPERATOR_USER" 11127 ], 11128 "allowPrincipleTypes": [], 11129 "excludePrincipleTypes": [ 11130 "EDGE", 11131 "GATEWAY" 11132 ], 11133 "requirePrivileges": [ 11134 { 11135 "action": "READ", 11136 "object": "OPERATOR_USER" 11137 } 11138 ] 11139 }, 11140 "parameters": [ 11141 { 11142 "name": "body", 11143 "in": "body", 11144 "required": true, 11145 "schema": { 11146 "type": "object", 11147 "title": "network_get_network_operator_users", 11148 "properties": { 11149 "networkId": { 11150 "type": "integer" 11151 } 11152 } 11153 } 11154 } 11155 ], 11156 "responses": { 11157 "200": { 11158 "schema": { 11159 "title": "network_get_network_operator_users_result", 11160 "type": "array", 11161 "items": { 11162 "$ref": "#/definitions/network_get_network_operator_users_result_item" 11163 } 11164 }, 11165 "description": "Request was successfully processed" 11166 }, 11167 "400": { 11168 "$ref": "#/responses/generic_400" 11169 }, 11170 "500": { 11171 "$ref": "#/responses/generic_500" 11172 } 11173 } 11174 } 11175 }, 11176 "/network/insertNetworkGatewayPool": { 11177 "post": { 11178 "summary": "Create gateway pool", 11179 "description": "Creates a gateway pool for the specified network.\n\nPrivileges required:\n\n`CREATE` `GATEWAY`", 11180 "tags": [ 11181 "network", 11182 "all" 11183 ], 11184 "x-privileges": { 11185 "excludeAuthTypes": [], 11186 "allowAuthTypes": [ 11187 "OPERATOR_USER", 11188 "MSP_USER" 11189 ], 11190 "allowPrincipleTypes": [], 11191 "excludePrincipleTypes": [ 11192 "EDGE", 11193 "GATEWAY" 11194 ], 11195 "requirePrivileges": [ 11196 { 11197 "action": "CREATE", 11198 "object": "GATEWAY" 11199 } 11200 ] 11201 }, 11202 "operationId": "network_insert_network_gateway_pool", 11203 "parameters": [ 11204 { 11205 "name": "body", 11206 "in": "body", 11207 "required": true, 11208 "schema": { 11209 "type": "object", 11210 "title": "network_insert_network_gateway_pool", 11211 "properties": { 11212 "networkId": { 11213 "type": "integer" 11214 }, 11215 "enterpriseProxyId": { 11216 "type": "integer" 11217 }, 11218 "name": { 11219 "type": "string" 11220 }, 11221 "description": { 11222 "type": "string" 11223 }, 11224 "handOffType": { 11225 "type": "string", 11226 "enum": [ 11227 "NONE", 11228 "ALLOW", 11229 "ONLY" 11230 ] 11231 } 11232 }, 11233 "required": [ 11234 "name", 11235 "networkId" 11236 ] 11237 } 11238 } 11239 ], 11240 "responses": { 11241 "200": { 11242 "schema": { 11243 "$ref": "#/definitions/network_insert_network_gateway_pool_result" 11244 }, 11245 "description": "Request was successfully processed" 11246 }, 11247 "400": { 11248 "$ref": "#/responses/generic_400" 11249 }, 11250 "500": { 11251 "$ref": "#/responses/generic_500" 11252 } 11253 } 11254 } 11255 }, 11256 "/network/updateNetworkGatwayPoolAttributes": { 11257 "post": { 11258 "summary": "Update gateway pool attributes", 11259 "description": "Updates the configurable attributes (`name`, `description`, and `handOffType`) of the specified gateway pool (by `id` or `gatewayPoolId`).\n\nPrivileges required:\n\n`UPDATE` `GATEWAY`", 11260 "tags": [ 11261 "network", 11262 "all" 11263 ], 11264 "operationId": "network_update_network_gateway_pool_attributes", 11265 "x-privileges": { 11266 "excludeAuthTypes": [], 11267 "allowAuthTypes": [ 11268 "OPERATOR_USER", 11269 "MSP_USER" 11270 ], 11271 "allowPrincipleTypes": [], 11272 "excludePrincipleTypes": [ 11273 "EDGE", 11274 "GATEWAY" 11275 ], 11276 "requirePrivileges": [ 11277 { 11278 "action": "UPDATE", 11279 "object": "GATEWAY" 11280 } 11281 ] 11282 }, 11283 "parameters": [ 11284 { 11285 "name": "body", 11286 "in": "body", 11287 "required": true, 11288 "schema": { 11289 "type": "object", 11290 "title": "network_update_network_gateway_pool_attributes", 11291 "properties": { 11292 "networkId": { 11293 "type": "integer" 11294 }, 11295 "enterpriseProxyId": { 11296 "type": "integer" 11297 }, 11298 "id": { 11299 "type": "integer", 11300 "description": "alias for `gatewayPoolId`" 11301 }, 11302 "gatewayPoolId": { 11303 "type": "integer" 11304 }, 11305 "name": { 11306 "type": "string" 11307 }, 11308 "description": { 11309 "type": "string" 11310 }, 11311 "handOffType": { 11312 "type": "string", 11313 "enum": [ 11314 "NONE", 11315 "ALLOW", 11316 "ONLY" 11317 ] 11318 } 11319 }, 11320 "required": [ 11321 "id" 11322 ] 11323 } 11324 } 11325 ], 11326 "responses": { 11327 "200": { 11328 "schema": { 11329 "$ref": "#/definitions/network_update_network_gateway_pool_attributes_result" 11330 }, 11331 "description": "Request was successfully processed" 11332 }, 11333 "400": { 11334 "$ref": "#/responses/generic_400" 11335 }, 11336 "500": { 11337 "$ref": "#/responses/generic_500" 11338 } 11339 } 11340 } 11341 }, 11342 "/operatorUser/deleteOperatorUser": { 11343 "post": { 11344 "tags": [ 11345 "all", 11346 "userMaintenance" 11347 ], 11348 "summary": "Delete operator user", 11349 "description": "Deletes the specified operator user (by `id` or `username`).\n\nPrivileges required:\n\n`DELETE` `OPERATOR_USER`", 11350 "operationId": "operator_user_delete_operator_user", 11351 "x-privileges": { 11352 "excludeAuthTypes": [], 11353 "allowAuthTypes": [ 11354 "OPERATOR_USER" 11355 ], 11356 "allowPrincipleTypes": [], 11357 "excludePrincipleTypes": [ 11358 "EDGE", 11359 "GATEWAY" 11360 ], 11361 "requirePrivileges": [ 11362 { 11363 "action": "DELETE", 11364 "object": "OPERATOR_USER" 11365 } 11366 ] 11367 }, 11368 "parameters": [ 11369 { 11370 "name": "body", 11371 "in": "body", 11372 "required": true, 11373 "schema": { 11374 "type": "object", 11375 "title": "operator_user_delete_operator_user", 11376 "properties": { 11377 "id": { 11378 "type": "integer" 11379 }, 11380 "username": { 11381 "type": "string" 11382 } 11383 } 11384 } 11385 } 11386 ], 11387 "responses": { 11388 "200": { 11389 "schema": { 11390 "$ref": "#/definitions/operator_user_delete_operator_user_result" 11391 }, 11392 "description": "Request was successfully processed" 11393 }, 11394 "400": { 11395 "$ref": "#/responses/generic_400" 11396 }, 11397 "500": { 11398 "$ref": "#/responses/generic_500" 11399 } 11400 } 11401 } 11402 }, 11403 "/operatorUser/getOperatorUser": { 11404 "post": { 11405 "tags": [ 11406 "all", 11407 "userMaintenance" 11408 ], 11409 "summary": "Get operator user", 11410 "description": "Gets the specified operator user object (by `id` or `username`).\n\nPrivileges required:\n\n`READ` `OPERATOR_USER`", 11411 "operationId": "operator_user_get_operator_user", 11412 "x-privileges": { 11413 "excludeAuthTypes": [], 11414 "allowAuthTypes": [ 11415 "OPERATOR_USER" 11416 ], 11417 "allowPrincipleTypes": [], 11418 "excludePrincipleTypes": [ 11419 "EDGE", 11420 "GATEWAY" 11421 ], 11422 "allowPrivilegeToSelf": "OPERATOR_USER", 11423 "requirePrivileges": [ 11424 { 11425 "action": "READ", 11426 "object": "OPERATOR_USER" 11427 } 11428 ] 11429 }, 11430 "parameters": [ 11431 { 11432 "name": "body", 11433 "in": "body", 11434 "required": true, 11435 "schema": { 11436 "type": "object", 11437 "title": "operator_user_get_operator_user", 11438 "properties": { 11439 "id": { 11440 "type": "integer" 11441 }, 11442 "username": { 11443 "type": "string" 11444 } 11445 } 11446 } 11447 } 11448 ], 11449 "responses": { 11450 "200": { 11451 "schema": { 11452 "$ref": "#/definitions/operator_user_get_operator_user_result" 11453 }, 11454 "description": "Request was successfully processed" 11455 }, 11456 "400": { 11457 "$ref": "#/responses/generic_400" 11458 }, 11459 "500": { 11460 "$ref": "#/responses/generic_500" 11461 } 11462 } 11463 } 11464 }, 11465 "/operatorUser/insertOperatorUser": { 11466 "post": { 11467 "tags": [ 11468 "all", 11469 "userMaintenance" 11470 ], 11471 "summary": "Create operator user", 11472 "description": "Creates an operator user and associates it with the operator's network.\n\nPrivileges required:\n\n`CREATE` `OPERATOR_USER`", 11473 "operationId": "operator_user_insert_operator_user", 11474 "x-privileges": { 11475 "excludeAuthTypes": [], 11476 "allowAuthTypes": [ 11477 "OPERATOR_USER" 11478 ], 11479 "allowPrincipleTypes": [], 11480 "excludePrincipleTypes": [ 11481 "EDGE", 11482 "GATEWAY" 11483 ], 11484 "requirePrivileges": [ 11485 { 11486 "action": "CREATE", 11487 "object": "OPERATOR_USER" 11488 } 11489 ] 11490 }, 11491 "parameters": [ 11492 { 11493 "name": "body", 11494 "in": "body", 11495 "required": true, 11496 "schema": { 11497 "$ref": "#/definitions/operator_user_insert_operator_user" 11498 } 11499 } 11500 ], 11501 "responses": { 11502 "200": { 11503 "schema": { 11504 "$ref": "#/definitions/operator_user_get_operator_user_result" 11505 }, 11506 "description": "Request was successfully processed" 11507 }, 11508 "400": { 11509 "$ref": "#/responses/generic_400" 11510 }, 11511 "500": { 11512 "$ref": "#/responses/generic_500" 11513 } 11514 } 11515 } 11516 }, 11517 "/operatorUser/updateOperatorUser": { 11518 "post": { 11519 "tags": [ 11520 "all", 11521 "userMaintenance" 11522 ], 11523 "summary": "Update operator user", 11524 "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).\n\nPrivileges required:\n\n`UPDATE` `OPERATOR_USER`", 11525 "operationId": "operator_user_update_operator_user", 11526 "x-privileges": { 11527 "excludeAuthTypes": [], 11528 "allowAuthTypes": [ 11529 "OPERATOR_USER" 11530 ], 11531 "allowPrincipleTypes": [], 11532 "excludePrincipleTypes": [ 11533 "EDGE", 11534 "GATEWAY" 11535 ], 11536 "allowPrivilegeToSelf": "OPERATOR_USER", 11537 "requirePrivileges": [ 11538 { 11539 "action": "UPDATE", 11540 "object": "OPERATOR_USER" 11541 } 11542 ] 11543 }, 11544 "parameters": [ 11545 { 11546 "name": "body", 11547 "in": "body", 11548 "required": true, 11549 "schema": { 11550 "type": "object", 11551 "title": "operator_user_update_operator_user", 11552 "properties": { 11553 "_update": { 11554 "$ref": "#/definitions/operator_user_update_operator_user" 11555 }, 11556 "networkId": { 11557 "type": "integer" 11558 }, 11559 "id": { 11560 "type": "integer" 11561 }, 11562 "username": { 11563 "type": "string" 11564 } 11565 }, 11566 "required": [ 11567 "_update" 11568 ] 11569 } 11570 } 11571 ], 11572 "responses": { 11573 "200": { 11574 "schema": { 11575 "$ref": "#/definitions/operator_user_update_operator_user_result" 11576 }, 11577 "description": "Request was successfully processed" 11578 }, 11579 "400": { 11580 "$ref": "#/responses/generic_400" 11581 }, 11582 "500": { 11583 "$ref": "#/responses/generic_500" 11584 } 11585 } 11586 } 11587 }, 11588 "/role/createRoleCustomization": { 11589 "post": { 11590 "summary": "Create role customization", 11591 "tags": [ 11592 "all", 11593 "role" 11594 ], 11595 "description": "Creates a role customization specified by `roleId` and an array of `privilegeIds`.\n\nPrivileges required:\n\n`UPDATE` `NETWORK`", 11596 "operationId": "role_create_role_customization", 11597 "x-privileges": { 11598 "excludeAuthTypes": [], 11599 "allowAuthTypes": [ 11600 "OPERATOR_USER" 11601 ], 11602 "allowPrincipleTypes": [], 11603 "excludePrincipleTypes": [ 11604 "EDGE", 11605 "GATEWAY" 11606 ], 11607 "requirePrivileges": [ 11608 { 11609 "action": "UPDATE", 11610 "object": "NETWORK" 11611 } 11612 ] 11613 }, 11614 "parameters": [ 11615 { 11616 "name": "body", 11617 "in": "body", 11618 "required": true, 11619 "schema": { 11620 "type": "object", 11621 "title": "role_create_role_customization", 11622 "properties": { 11623 "forRoleId": { 11624 "type": "integer" 11625 }, 11626 "name": { 11627 "type": "string" 11628 }, 11629 "description": { 11630 "type": "string" 11631 }, 11632 "userId": { 11633 "type": "integer" 11634 }, 11635 "enterpriseId": { 11636 "type": "integer" 11637 }, 11638 "operatorId": { 11639 "type": "integer" 11640 }, 11641 "networkId": { 11642 "type": "integer" 11643 }, 11644 "privilegeIds": { 11645 "type": "array", 11646 "items": { 11647 "type": "integer" 11648 } 11649 } 11650 }, 11651 "required": [ 11652 "forRoleId", 11653 "privilegeIds" 11654 ] 11655 } 11656 } 11657 ], 11658 "responses": { 11659 "200": { 11660 "schema": { 11661 "$ref": "#/definitions/role_create_role_customization_result" 11662 }, 11663 "description": "Request was successfully processed" 11664 }, 11665 "400": { 11666 "$ref": "#/responses/generic_400" 11667 }, 11668 "500": { 11669 "$ref": "#/responses/generic_500" 11670 } 11671 } 11672 } 11673 }, 11674 "/role/deleteRoleCustomization": { 11675 "post": { 11676 "summary": "Delete role customization", 11677 "tags": [ 11678 "all", 11679 "role" 11680 ], 11681 "description": "Deletes the specified role customization (by `name` or `forRoleId`).\n\nPrivileges required:\n\n`UPDATE` `NETWORK`", 11682 "operationId": "role_delete_role_customization", 11683 "x-privileges": { 11684 "excludeAuthTypes": [], 11685 "allowAuthTypes": [ 11686 "OPERATOR_USER" 11687 ], 11688 "allowPrincipleTypes": [], 11689 "excludePrincipleTypes": [ 11690 "EDGE", 11691 "GATEWAY" 11692 ], 11693 "requirePrivileges": [ 11694 { 11695 "action": "UPDATE", 11696 "object": "NETWORK" 11697 } 11698 ] 11699 }, 11700 "parameters": [ 11701 { 11702 "name": "body", 11703 "in": "body", 11704 "required": true, 11705 "schema": { 11706 "type": "object", 11707 "title": "role_delete_role_customization", 11708 "properties": { 11709 "forRoleId": { 11710 "type": "integer" 11711 }, 11712 "name": { 11713 "type": "string" 11714 }, 11715 "userId": { 11716 "type": "integer" 11717 }, 11718 "enterpriseId": { 11719 "type": "integer" 11720 }, 11721 "operatorId": { 11722 "type": "integer" 11723 }, 11724 "networkId": { 11725 "type": "integer" 11726 } 11727 }, 11728 "required": [ 11729 "forRoleId" 11730 ] 11731 } 11732 } 11733 ], 11734 "responses": { 11735 "200": { 11736 "schema": { 11737 "$ref": "#/definitions/role_delete_role_customization_result" 11738 }, 11739 "description": "Request was successfully processed" 11740 }, 11741 "400": { 11742 "$ref": "#/responses/generic_400" 11743 }, 11744 "500": { 11745 "$ref": "#/responses/generic_500" 11746 } 11747 } 11748 } 11749 }, 11750 "/role/getUserTypeRoles": { 11751 "post": { 11752 "summary": "Get roles per user type", 11753 "tags": [ 11754 "all", 11755 "role" 11756 ], 11757 "description": "Gets all roles defined for the specified `userType`.\n\nPrivileges required:\n\n`READ` `ENTERPRISE_USER`, or\n\n`READ` `PROXY_USER`, or\n\n`READ` `OPERATOR_USER`", 11758 "operationId": "role_get_user_type_roles", 11759 "x-privileges": { 11760 "excludeAuthTypes": [], 11761 "allowAuthTypes": [ 11762 "ANY" 11763 ], 11764 "allowPrincipleTypes": [], 11765 "excludePrincipleTypes": [ 11766 "EDGE", 11767 "GATEWAY" 11768 ], 11769 "requirePrivileges": [ 11770 { 11771 "action": "READ", 11772 "object": "ENTERPRISE_USER", 11773 "sufficient": true 11774 }, 11775 { 11776 "action": "READ", 11777 "object": "PROXY_USER", 11778 "sufficient": true 11779 }, 11780 { 11781 "action": "READ", 11782 "object": "OPERATOR_USER", 11783 "sufficient": true 11784 } 11785 ] 11786 }, 11787 "parameters": [ 11788 { 11789 "name": "body", 11790 "in": "body", 11791 "required": true, 11792 "schema": { 11793 "type": "object", 11794 "title": "role_get_user_type_roles", 11795 "properties": { 11796 "userType": { 11797 "type": "string", 11798 "enum": [ 11799 "OPERATOR", 11800 "MSP", 11801 "PARTNER", 11802 "ENTERPRISE", 11803 "END_USER", 11804 "CUSTOM" 11805 ] 11806 }, 11807 "networkId": { 11808 "type": "integer" 11809 } 11810 }, 11811 "required": [ 11812 "userType" 11813 ] 11814 } 11815 } 11816 ], 11817 "responses": { 11818 "200": { 11819 "schema": { 11820 "title": "role_get_user_type_roles_result", 11821 "type": "array", 11822 "items": { 11823 "$ref": "#/definitions/role_get_user_type_roles_result_item" 11824 } 11825 }, 11826 "description": "Request was successfully processed" 11827 }, 11828 "400": { 11829 "$ref": "#/responses/generic_400" 11830 }, 11831 "500": { 11832 "$ref": "#/responses/generic_500" 11833 } 11834 } 11835 } 11836 }, 11837 "/role/setEnterpriseDelegatedToEnterpriseProxy": { 11838 "post": { 11839 "summary": "Grant enterprise access to partner", 11840 "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.\n\nPrivileges required:\n\n`UPDATE` `ENTERPRISE_DELEGATION`", 11841 "tags": [ 11842 "role", 11843 "all" 11844 ], 11845 "operationId": "role_set_enterprise_delegated_to_enterprise_proxy", 11846 "x-privileges": { 11847 "forceEnterpriseContext": true, 11848 "excludeAuthTypes": [], 11849 "allowAuthTypes": [ 11850 "ANY" 11851 ], 11852 "allowPrincipleTypes": [], 11853 "excludePrincipleTypes": [ 11854 "EDGE", 11855 "GATEWAY" 11856 ], 11857 "requirePrivileges": [ 11858 { 11859 "action": "UPDATE", 11860 "object": "ENTERPRISE_DELEGATION" 11861 } 11862 ] 11863 }, 11864 "parameters": [ 11865 { 11866 "name": "body", 11867 "in": "body", 11868 "required": true, 11869 "schema": { 11870 "type": "object", 11871 "properties": { 11872 "enterpriseId": { 11873 "type": "integer" 11874 }, 11875 "enterpriseProxyId": { 11876 "type": "integer" 11877 }, 11878 "isDelegated": { 11879 "type": "boolean" 11880 } 11881 }, 11882 "required": [ 11883 "isDelegated" 11884 ] 11885 } 11886 } 11887 ], 11888 "responses": { 11889 "200": { 11890 "description": "Request was successfully processed", 11891 "schema": { 11892 "$ref": "#/definitions/role_set_enterprise_delegated_to_enterprise_proxy_result" 11893 } 11894 }, 11895 "400": { 11896 "$ref": "#/responses/generic_400" 11897 }, 11898 "500": { 11899 "$ref": "#/responses/generic_500" 11900 } 11901 } 11902 } 11903 }, 11904 "/role/setEnterpriseDelegatedToOperator": { 11905 "post": { 11906 "summary": "Grant enterprise access to network operator", 11907 "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.\n\nPrivileges required:\n\n`UPDATE` `ENTERPRISE_DELEGATION`", 11908 "tags": [ 11909 "role", 11910 "all" 11911 ], 11912 "operationId": "role_set_enterprise_delegated_to_operator", 11913 "x-privileges": { 11914 "forceEnterpriseContext": true, 11915 "excludeAuthTypes": [], 11916 "allowAuthTypes": [ 11917 "ANY" 11918 ], 11919 "allowPrincipleTypes": [], 11920 "excludePrincipleTypes": [ 11921 "EDGE", 11922 "GATEWAY" 11923 ], 11924 "requirePrivileges": [ 11925 { 11926 "action": "UPDATE", 11927 "object": "ENTERPRISE_DELEGATION" 11928 } 11929 ] 11930 }, 11931 "parameters": [ 11932 { 11933 "name": "body", 11934 "in": "body", 11935 "required": true, 11936 "schema": { 11937 "type": "object", 11938 "properties": { 11939 "isDelegated": { 11940 "type": "boolean" 11941 } 11942 }, 11943 "required": [ 11944 "isDelegated" 11945 ] 11946 } 11947 } 11948 ], 11949 "responses": { 11950 "200": { 11951 "description": "Request was successfully processed", 11952 "schema": { 11953 "$ref": "#/definitions/role_set_enterprise_delegated_to_operator_result" 11954 } 11955 }, 11956 "400": { 11957 "$ref": "#/responses/generic_400" 11958 }, 11959 "500": { 11960 "$ref": "#/responses/generic_500" 11961 } 11962 } 11963 } 11964 }, 11965 "/role/setEnterpriseProxyDelegatedToOperator": { 11966 "post": { 11967 "summary": "Grant enterprise proxy access to network operator", 11968 "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.\n\nPrivileges required:\n\n`UPDATE` `ENTERPRISE_PROXY_DELEGATION`", 11969 "tags": [ 11970 "role", 11971 "all" 11972 ], 11973 "operationId": "role_set_enterprise_proxy_delegated_to_operator", 11974 "x-privileges": { 11975 "excludeAuthTypes": [], 11976 "allowAuthTypes": [ 11977 "OPERATOR_USER", 11978 "MSP_USER" 11979 ], 11980 "allowPrincipleTypes": [], 11981 "excludePrincipleTypes": [ 11982 "EDGE", 11983 "GATEWAY" 11984 ], 11985 "requirePrivileges": [ 11986 { 11987 "action": "UPDATE", 11988 "object": "ENTERPRISE_PROXY_DELEGATION" 11989 } 11990 ] 11991 }, 11992 "parameters": [ 11993 { 11994 "name": "body", 11995 "in": "body", 11996 "required": true, 11997 "schema": { 11998 "type": "object", 11999 "properties": { 12000 "enterpriseProxyId": { 12001 "type": "integer" 12002 }, 12003 "isDelegated": { 12004 "type": "boolean" 12005 } 12006 }, 12007 "required": [ 12008 "isDelegated" 12009 ] 12010 } 12011 } 12012 ], 12013 "responses": { 12014 "200": { 12015 "description": "Request was successfully processed", 12016 "schema": { 12017 "$ref": "#/definitions/role_set_enterprise_proxy_delegated_to_operator_result" 12018 } 12019 }, 12020 "400": { 12021 "$ref": "#/responses/generic_400" 12022 }, 12023 "500": { 12024 "$ref": "#/responses/generic_500" 12025 } 12026 } 12027 } 12028 }, 12029 "/role/setEnterpriseUserManagementDelegatedToOperator": { 12030 "post": { 12031 "summary": "Grant enterprise user access to network operator", 12032 "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.).\n\nPrivileges required:\n\n`UPDATE` `ENTERPRISE_DELEGATION`", 12033 "tags": [ 12034 "role", 12035 "all" 12036 ], 12037 "operationId": "role_set_enterprise_user_management_delegated_to_operator", 12038 "x-privileges": { 12039 "excludeAuthTypes": [], 12040 "allowAuthTypes": [ 12041 "OPERATOR_USER", 12042 "MSP_USER", 12043 "ENTERPRISE_USER" 12044 ], 12045 "allowPrincipleTypes": [], 12046 "excludePrincipleTypes": [ 12047 "EDGE", 12048 "GATEWAY" 12049 ], 12050 "requirePrivileges": [ 12051 { 12052 "action": "UPDATE", 12053 "object": "ENTERPRISE_DELEGATION" 12054 } 12055 ] 12056 }, 12057 "parameters": [ 12058 { 12059 "name": "body", 12060 "in": "body", 12061 "required": true, 12062 "schema": { 12063 "type": "object", 12064 "properties": { 12065 "isDelegated": { 12066 "type": "boolean" 12067 } 12068 }, 12069 "required": [ 12070 "isDelegated" 12071 ] 12072 } 12073 } 12074 ], 12075 "responses": { 12076 "200": { 12077 "description": "Request was successfully processed", 12078 "schema": { 12079 "$ref": "#/definitions/role_set_enterprise_user_management_delegated_to_operator_result" 12080 } 12081 }, 12082 "400": { 12083 "$ref": "#/responses/generic_400" 12084 }, 12085 "500": { 12086 "$ref": "#/responses/generic_500" 12087 } 12088 } 12089 } 12090 }, 12091 "/systemProperty/getSystemProperties": { 12092 "post": { 12093 "summary": "Get all system properties", 12094 "description": "Gets all configured system properties.\n\nPrivileges required:\n\n`READ` `SYSTEM_PROPERTY`", 12095 "operationId": "system_property_get_system_properties", 12096 "x-privileges": { 12097 "excludeAuthTypes": [], 12098 "allowAuthTypes": [ 12099 "OPERATOR_USER" 12100 ], 12101 "allowPrincipleTypes": [], 12102 "excludePrincipleTypes": [ 12103 "EDGE", 12104 "GATEWAY" 12105 ], 12106 "requirePrivileges": [ 12107 { 12108 "action": "READ", 12109 "object": "SYSTEM_PROPERTY" 12110 } 12111 ] 12112 }, 12113 "tags": [ 12114 "systemProperty", 12115 "all" 12116 ], 12117 "parameters": [ 12118 { 12119 "name": "body", 12120 "in": "body", 12121 "required": true, 12122 "schema": { 12123 "type": "object", 12124 "title": "system_property_get_system_properties", 12125 "properties": { 12126 "group": { 12127 "type": "string", 12128 "description": "Filter for properties matching a given group prefix" 12129 }, 12130 "normalize": { 12131 "type": "boolean", 12132 "description": "If true, transforms query result from rowset to single object with attribute names matching property names fetched" 12133 } 12134 } 12135 } 12136 } 12137 ], 12138 "responses": { 12139 "200": { 12140 "schema": { 12141 "type": "array", 12142 "items": { 12143 "$ref": "#/definitions/system_property_get_system_properties_result_item" 12144 } 12145 }, 12146 "description": "Request was successfully processed" 12147 }, 12148 "400": { 12149 "$ref": "#/responses/generic_400" 12150 }, 12151 "500": { 12152 "$ref": "#/responses/generic_500" 12153 } 12154 } 12155 } 12156 }, 12157 "/systemProperty/getSystemProperty": { 12158 "post": { 12159 "summary": "Get system property", 12160 "description": "Gets the specified system property. Specify by object `id` or `name`.\n\nPrivileges required:\n\n`READ` `SYSTEM_PROPERTY`", 12161 "operationId": "system_property_get_system_property", 12162 "x-privileges": { 12163 "excludeAuthTypes": [], 12164 "allowAuthTypes": [ 12165 "OPERATOR_USER" 12166 ], 12167 "allowPrincipleTypes": [], 12168 "excludePrincipleTypes": [ 12169 "EDGE", 12170 "GATEWAY" 12171 ], 12172 "requirePrivileges": [ 12173 { 12174 "action": "READ", 12175 "object": "SYSTEM_PROPERTY" 12176 } 12177 ] 12178 }, 12179 "tags": [ 12180 "systemProperty", 12181 "all" 12182 ], 12183 "parameters": [ 12184 { 12185 "name": "body", 12186 "in": "body", 12187 "required": true, 12188 "schema": { 12189 "type": "object", 12190 "title": "system_property_get_system_property", 12191 "properties": { 12192 "name": { 12193 "type": "string" 12194 }, 12195 "id": { 12196 "type": "integer" 12197 } 12198 } 12199 } 12200 } 12201 ], 12202 "responses": { 12203 "200": { 12204 "schema": { 12205 "$ref": "#/definitions/system_property_get_system_property_result" 12206 }, 12207 "description": "Request was successfully processed" 12208 }, 12209 "400": { 12210 "$ref": "#/responses/generic_400" 12211 }, 12212 "500": { 12213 "$ref": "#/responses/generic_500" 12214 } 12215 } 12216 } 12217 }, 12218 "/systemProperty/insertOrUpdateSystemProperty": { 12219 "post": { 12220 "summary": "Create or update system property", 12221 "description": "Creates the specified system property. If the system property with the specified `name` already exists, then the API call updates it.\n\nPrivileges required:\n\n`CREATE` `SYSTEM_PROPERTY`", 12222 "operationId": "system_property_insert_or_update_system_property", 12223 "x-privileges": { 12224 "excludeAuthTypes": [], 12225 "allowAuthTypes": [ 12226 "OPERATOR_USER" 12227 ], 12228 "allowPrincipleTypes": [], 12229 "excludePrincipleTypes": [ 12230 "EDGE", 12231 "GATEWAY" 12232 ], 12233 "requirePrivileges": [ 12234 { 12235 "action": "CREATE", 12236 "object": "SYSTEM_PROPERTY" 12237 } 12238 ] 12239 }, 12240 "tags": [ 12241 "systemProperty", 12242 "all" 12243 ], 12244 "parameters": [ 12245 { 12246 "name": "body", 12247 "in": "body", 12248 "required": true, 12249 "schema": { 12250 "type": "object", 12251 "title": "system_property_insert_or_update_system_property", 12252 "properties": { 12253 "name": { 12254 "type": "string" 12255 }, 12256 "value": { 12257 "type": "string" 12258 }, 12259 "defaultValue": { 12260 "type": "string" 12261 }, 12262 "isPassword": { 12263 "type": "boolean" 12264 }, 12265 "isReadOnly": { 12266 "type": "boolean" 12267 }, 12268 "dataType": { 12269 "type": "string" 12270 }, 12271 "description": { 12272 "type": "string" 12273 } 12274 }, 12275 "required": [ 12276 "name", 12277 "value" 12278 ] 12279 } 12280 } 12281 ], 12282 "responses": { 12283 "200": { 12284 "schema": { 12285 "$ref": "#/definitions/system_property_insert_or_update_system_property_result" 12286 }, 12287 "description": "Request was successfully processed" 12288 }, 12289 "400": { 12290 "$ref": "#/responses/generic_400" 12291 }, 12292 "500": { 12293 "$ref": "#/responses/generic_500" 12294 } 12295 } 12296 } 12297 }, 12298 "/systemProperty/insertSystemProperty": { 12299 "post": { 12300 "summary": "Create system property", 12301 "description": "Creates a new system property with the specified `name`, `value`, and optionally other attributes.\n\nPrivileges required:\n\n`CREATE` `SYSTEM_PROPERTY`", 12302 "operationId": "system_property_insert_system_property", 12303 "x-privileges": { 12304 "excludeAuthTypes": [], 12305 "allowAuthTypes": [ 12306 "OPERATOR_USER" 12307 ], 12308 "allowPrincipleTypes": [], 12309 "excludePrincipleTypes": [ 12310 "EDGE", 12311 "GATEWAY" 12312 ], 12313 "requirePrivileges": [ 12314 { 12315 "action": "CREATE", 12316 "object": "SYSTEM_PROPERTY" 12317 } 12318 ] 12319 }, 12320 "tags": [ 12321 "systemProperty", 12322 "all" 12323 ], 12324 "parameters": [ 12325 { 12326 "name": "body", 12327 "in": "body", 12328 "required": true, 12329 "schema": { 12330 "type": "object", 12331 "title": "system_property_insert_system_property", 12332 "properties": { 12333 "name": { 12334 "type": "string" 12335 }, 12336 "value": { 12337 "type": "string" 12338 }, 12339 "defaultValue": { 12340 "type": "string" 12341 }, 12342 "dataType": { 12343 "type": "string" 12344 }, 12345 "description": { 12346 "type": "string" 12347 }, 12348 "isPassword": { 12349 "type": "boolean" 12350 }, 12351 "isReadOnly": { 12352 "type": "boolean" 12353 } 12354 }, 12355 "required": [ 12356 "name", 12357 "value" 12358 ] 12359 } 12360 } 12361 ], 12362 "responses": { 12363 "200": { 12364 "schema": { 12365 "$ref": "#/definitions/system_property_insert_system_property_result" 12366 }, 12367 "description": "Request was successfully processed" 12368 }, 12369 "400": { 12370 "$ref": "#/responses/generic_400" 12371 }, 12372 "500": { 12373 "$ref": "#/responses/generic_500" 12374 } 12375 } 12376 } 12377 }, 12378 "/systemProperty/updateSystemProperty": { 12379 "post": { 12380 "summary": "Update system property", 12381 "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).\n\nPrivileges required:\n\n`UPDATE` `SYSTEM_PROPERTY`", 12382 "operationId": "system_property_update_system_property", 12383 "x-privileges": { 12384 "excludeAuthTypes": [], 12385 "allowAuthTypes": [ 12386 "OPERATOR_USER" 12387 ], 12388 "allowPrincipleTypes": [], 12389 "excludePrincipleTypes": [ 12390 "EDGE", 12391 "GATEWAY" 12392 ], 12393 "requirePrivileges": [ 12394 { 12395 "action": "UPDATE", 12396 "object": "SYSTEM_PROPERTY" 12397 } 12398 ] 12399 }, 12400 "tags": [ 12401 "systemProperty", 12402 "all" 12403 ], 12404 "parameters": [ 12405 { 12406 "name": "body", 12407 "in": "body", 12408 "required": true, 12409 "schema": { 12410 "type": "object", 12411 "title": "system_property_update_system_property", 12412 "properties": { 12413 "name": { 12414 "type": "string" 12415 }, 12416 "id": { 12417 "type": "integer" 12418 }, 12419 "_update": { 12420 "type": "object", 12421 "properties": { 12422 "name": { 12423 "type": "string" 12424 }, 12425 "value": { 12426 "type": "string" 12427 }, 12428 "defaultValue": { 12429 "type": "string" 12430 }, 12431 "isPassword": { 12432 "type": "boolean" 12433 }, 12434 "isReadOnly": { 12435 "type": "boolean" 12436 }, 12437 "dataType": { 12438 "type": "string" 12439 }, 12440 "description": { 12441 "type": "string" 12442 } 12443 } 12444 } 12445 }, 12446 "required": [ 12447 "_update" 12448 ] 12449 } 12450 } 12451 ], 12452 "responses": { 12453 "200": { 12454 "schema": { 12455 "$ref": "#/definitions/system_property_update_system_property_result" 12456 }, 12457 "description": "Request was successfully processed" 12458 }, 12459 "400": { 12460 "$ref": "#/responses/generic_400" 12461 }, 12462 "500": { 12463 "$ref": "#/responses/generic_500" 12464 } 12465 } 12466 } 12467 }, 12468 "/vcoDiagnostics/getVcoDbDiagnostics": { 12469 "post": { 12470 "summary": "Get VCO Database Diagnostics", 12471 "description": "Gets the diagnostic information of the VCO database.\n\nPrivileges required:\n\n`READ` `VCO_DIAGNOSTICS`", 12472 "operationId": "vco_diagnostics_get_vco_db_diagnostics", 12473 "x-privileges": { 12474 "excludeAuthTypes": [], 12475 "allowAuthTypes": [ 12476 "OPERATOR_USER" 12477 ], 12478 "allowPrincipleTypes": [], 12479 "excludePrincipleTypes": [ 12480 "EDGE", 12481 "GATEWAY" 12482 ], 12483 "requirePrivileges": [ 12484 { 12485 "action": "READ", 12486 "object": "VCO_DIAGNOSTICS" 12487 } 12488 ] 12489 }, 12490 "tags": [ 12491 "all", 12492 "vcoDiagnostics" 12493 ], 12494 "parameters": [ 12495 { 12496 "name": "body", 12497 "in": "body", 12498 "required": true, 12499 "schema": { 12500 "type": "object", 12501 "title": "vco_diagnostics_get_vco_db_diagnostics", 12502 "properties": {} 12503 } 12504 } 12505 ], 12506 "responses": { 12507 "200": { 12508 "description": "Request was successfully processed", 12509 "schema": { 12510 "type": "array", 12511 "items": { 12512 "type": "object", 12513 "properties": { 12514 "name": { 12515 "type": "string" 12516 }, 12517 "description": { 12518 "type": "string" 12519 }, 12520 "method": { 12521 "type": "string" 12522 }, 12523 "result": { 12524 "type": "object", 12525 "properties": { 12526 "velocloud": { 12527 "type": "array", 12528 "items": { 12529 "type": "object", 12530 "properties": { 12531 "table_schema": { 12532 "type": "string" 12533 }, 12534 "table_name": { 12535 "type": "string" 12536 }, 12537 "table_rows": { 12538 "type": "integer" 12539 }, 12540 "avg_row_length": { 12541 "type": "integer" 12542 }, 12543 "data_length": { 12544 "type": "integer" 12545 }, 12546 "index_length": { 12547 "type": "integer" 12548 }, 12549 "data_free": { 12550 "type": "integer" 12551 } 12552 } 12553 } 12554 }, 12555 "velocloud_ca": { 12556 "type": "array", 12557 "items": { 12558 "type": "object", 12559 "properties": { 12560 "table_schema": { 12561 "type": "string" 12562 }, 12563 "table_name": { 12564 "type": "string" 12565 }, 12566 "table_rows": { 12567 "type": "integer" 12568 }, 12569 "avg_row_length": { 12570 "type": "integer" 12571 }, 12572 "data_length": { 12573 "type": "integer" 12574 }, 12575 "index_length": { 12576 "type": "integer" 12577 }, 12578 "data_free": { 12579 "type": "integer" 12580 } 12581 } 12582 } 12583 }, 12584 "velocloud_dr": { 12585 "type": "array", 12586 "items": { 12587 "type": "object", 12588 "properties": { 12589 "table_schema": { 12590 "type": "string" 12591 }, 12592 "table_name": { 12593 "type": "string" 12594 }, 12595 "table_rows": { 12596 "type": "integer" 12597 }, 12598 "avg_row_length": { 12599 "type": "integer" 12600 }, 12601 "data_length": { 12602 "type": "integer" 12603 }, 12604 "index_length": { 12605 "type": "integer" 12606 }, 12607 "data_free": { 12608 "type": "integer" 12609 } 12610 } 12611 } 12612 }, 12613 "velocloud_stats": { 12614 "type": "array", 12615 "items": { 12616 "type": "object", 12617 "properties": { 12618 "table_schema": { 12619 "type": "string" 12620 }, 12621 "table_name": { 12622 "type": "string" 12623 }, 12624 "table_rows": { 12625 "type": "integer" 12626 }, 12627 "avg_row_length": { 12628 "type": "integer" 12629 }, 12630 "data_length": { 12631 "type": "integer" 12632 }, 12633 "index_length": { 12634 "type": "integer" 12635 }, 12636 "data_free": { 12637 "type": "integer" 12638 } 12639 } 12640 } 12641 } 12642 } 12643 } 12644 } 12645 } 12646 } 12647 }, 12648 "400": { 12649 "$ref": "#/responses/generic_400" 12650 }, 12651 "500": { 12652 "$ref": "#/responses/generic_500" 12653 } 12654 } 12655 } 12656 }, 12657 "/vcoInventory/associateEdge": { 12658 "post": { 12659 "summary": "Assign Edge to enterprise", 12660 "tags": [ 12661 "all", 12662 "vcoInventory" 12663 ], 12664 "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.\n\nPrivileges required:\n\n`CREATE` `ENTERPRISE`", 12665 "operationId": "vco_inventory_associate_edge", 12666 "x-privileges": { 12667 "excludeAuthTypes": [], 12668 "allowAuthTypes": [ 12669 "OPERATOR_USER" 12670 ], 12671 "allowPrincipleTypes": [], 12672 "excludePrincipleTypes": [ 12673 "EDGE", 12674 "GATEWAY" 12675 ], 12676 "requirePrivileges": [ 12677 { 12678 "action": "CREATE", 12679 "object": "ENTERPRISE" 12680 } 12681 ] 12682 }, 12683 "parameters": [ 12684 { 12685 "name": "body", 12686 "in": "body", 12687 "required": true, 12688 "schema": { 12689 "type": "object", 12690 "title": "vco_inventory_associate_edge", 12691 "properties": { 12692 "edgeInventoryId": { 12693 "type": "integer" 12694 }, 12695 "enterpriseId": { 12696 "type": "integer" 12697 }, 12698 "edgeId": { 12699 "type": "integer" 12700 }, 12701 "deviceSerialNumber": { 12702 "type": "string" 12703 } 12704 } 12705 } 12706 } 12707 ], 12708 "responses": { 12709 "200": { 12710 "description": "Request was successfully processed", 12711 "schema": { 12712 "type": "object", 12713 "properties": { 12714 "id": { 12715 "type": "integer" 12716 }, 12717 "deviceSerialNumber": { 12718 "type": "string" 12719 } 12720 } 12721 } 12722 }, 12723 "400": { 12724 "$ref": "#/responses/generic_400" 12725 }, 12726 "500": { 12727 "$ref": "#/responses/generic_500" 12728 } 12729 } 12730 } 12731 }, 12732 "/vcoInventory/getInventoryItems": { 12733 "post": { 12734 "summary": "Get available VCO inventory items", 12735 "tags": [ 12736 "all", 12737 "vcoInventory" 12738 ], 12739 "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`", 12740 "operationId": "vco_inventory_get_inventory_items", 12741 "x-privileges": { 12742 "excludeAuthTypes": [], 12743 "allowAuthTypes": [ 12744 "OPERATOR_USER", 12745 "ENTERPRISE_USER" 12746 ], 12747 "allowPrincipleTypes": [], 12748 "excludePrincipleTypes": [ 12749 "EDGE", 12750 "GATEWAY" 12751 ], 12752 "requirePrivileges": [ 12753 { 12754 "action": "READ", 12755 "object": "INVENTORY" 12756 } 12757 ] 12758 }, 12759 "parameters": [ 12760 { 12761 "name": "body", 12762 "in": "body", 12763 "required": true, 12764 "schema": { 12765 "type": "object", 12766 "title": "vco_inventory_get_inventory_items", 12767 "properties": { 12768 "enterpriseId": { 12769 "type": "integer" 12770 }, 12771 "modifiedSince": { 12772 "type": "integer" 12773 }, 12774 "with": { 12775 "type": "array", 12776 "items": { 12777 "type": "string", 12778 "enum": [ 12779 "edge", 12780 "vcoOwner" 12781 ] 12782 } 12783 } 12784 } 12785 } 12786 } 12787 ], 12788 "responses": { 12789 "200": { 12790 "description": "Request was successfully processed", 12791 "schema": { 12792 "$ref": "#/definitions/vco_inventory_get_inventory_items_result" 12793 } 12794 }, 12795 "400": { 12796 "$ref": "#/responses/generic_400" 12797 }, 12798 "500": { 12799 "$ref": "#/responses/generic_500" 12800 } 12801 } 12802 } 12803 }, 12804 "/vpn/generateVpnGatewayConfiguration": { 12805 "post": { 12806 "summary": "Provision a non-SD-WAN VPN site", 12807 "description": "Provision a non-SD-WAN site (e.g. a data center or cloud service PoP) and generate VPN configuration.\n\nPrivileges required:\n\n`CREATE` `NETWORK_SERVICE`", 12808 "tags": [ 12809 "all", 12810 "vpn" 12811 ], 12812 "x-privileges": { 12813 "excludeAuthTypes": [], 12814 "allowAuthTypes": [ 12815 "ANY" 12816 ], 12817 "allowPrincipleTypes": [], 12818 "excludePrincipleTypes": [ 12819 "EDGE", 12820 "GATEWAY" 12821 ], 12822 "requirePrivileges": [ 12823 { 12824 "action": "CREATE", 12825 "object": "NETWORK_SERVICE" 12826 } 12827 ] 12828 }, 12829 "operationId": "vpn_generate_vpn_gateway_configuration", 12830 "parameters": [ 12831 { 12832 "name": "body", 12833 "in": "body", 12834 "required": true, 12835 "schema": { 12836 "type": "object", 12837 "title": "vpn_generate_vpn_gateway_configuration", 12838 "properties": { 12839 "enterpriseId": { 12840 "type": "integer" 12841 }, 12842 "name": { 12843 "type": "string" 12844 }, 12845 "data": { 12846 "$ref": "#/definitions/data_center_data" 12847 } 12848 }, 12849 "required": [ 12850 "name", 12851 "data" 12852 ] 12853 } 12854 } 12855 ], 12856 "responses": { 12857 "200": { 12858 "description": "Request was successfully processed", 12859 "schema": { 12860 "$ref": "#/definitions/vpn_generate_vpn_gateway_configuration_result" 12861 } 12862 }, 12863 "400": { 12864 "$ref": "#/responses/generic_400" 12865 }, 12866 "500": { 12867 "$ref": "#/responses/generic_500" 12868 } 12869 } 12870 } 12871 } 12872 }, 12873 "definitions": { 12874 "error": { 12875 "type": "object", 12876 "properties": { 12877 "error": { 12878 "type": "object", 12879 "properties": { 12880 "code": { 12881 "type": "integer", 12882 "description": "A JSON-RPC error code (see http://www.jsonrpc.org/specification#error_object for details)", 12883 "example": -32600 12884 }, 12885 "message": { 12886 "type": "string", 12887 "example": "An error occurred while processing your request" 12888 } 12889 }, 12890 "required": [ 12891 "code", 12892 "message" 12893 ] 12894 } 12895 }, 12896 "required": [ 12897 "error" 12898 ] 12899 }, 12900 "tinyint": { 12901 "type": "integer", 12902 "enum": [ 12903 0, 12904 1 12905 ] 12906 }, 12907 "logicalid_reference": { 12908 "type": "object", 12909 "properties": { 12910 "logicalId": { 12911 "type": "string" 12912 } 12913 } 12914 }, 12915 "subnet": { 12916 "type": "object", 12917 "properties": { 12918 "cidrIp": { 12919 "type": "string" 12920 }, 12921 "cidrPrefix": { 12922 "type": "integer" 12923 } 12924 } 12925 }, 12926 "enterprise": { 12927 "type": "object", 12928 "properties": { 12929 "id": { 12930 "type": "integer" 12931 }, 12932 "created": { 12933 "type": "string", 12934 "format": "date-time" 12935 }, 12936 "networkId": { 12937 "type": "integer" 12938 }, 12939 "gatewayPoolId": { 12940 "type": "integer" 12941 }, 12942 "alertsEnabled": { 12943 "$ref": "#/definitions/tinyint" 12944 }, 12945 "operatorAlertsEnabled": { 12946 "$ref": "#/definitions/tinyint" 12947 }, 12948 "endpointPkiMode": { 12949 "type": "string", 12950 "enum": [ 12951 "CERTIFICATE_DISABLED", 12952 "CERTIFICATE_OPTIONAL", 12953 "CERTIFICATE_REQUIRED" 12954 ] 12955 }, 12956 "name": { 12957 "type": "string" 12958 }, 12959 "domain": { 12960 "type": "string" 12961 }, 12962 "prefix": { 12963 "type": "string" 12964 }, 12965 "logicalId": { 12966 "type": "string" 12967 }, 12968 "accountNumber": { 12969 "type": "string" 12970 }, 12971 "description": { 12972 "type": "string" 12973 }, 12974 "contactName": { 12975 "type": "string" 12976 }, 12977 "contactPhone": { 12978 "type": "string" 12979 }, 12980 "contactMobile": { 12981 "type": "string" 12982 }, 12983 "contactEmail": { 12984 "type": "string" 12985 }, 12986 "streetAddress": { 12987 "type": "string" 12988 }, 12989 "streetAddress2": { 12990 "type": "string" 12991 }, 12992 "city": { 12993 "type": "string" 12994 }, 12995 "state": { 12996 "type": "string" 12997 }, 12998 "postalCode": { 12999 "type": "string" 13000 }, 13001 "country": { 13002 "type": "string" 13003 }, 13004 "lat": { 13005 "type": "number", 13006 "format": "double" 13007 }, 13008 "lon": { 13009 "type": "number", 13010 "format": "double" 13011 }, 13012 "timezone": { 13013 "type": "string" 13014 }, 13015 "locale": { 13016 "type": "string" 13017 }, 13018 "modified": { 13019 "type": "string", 13020 "format": "date-time" 13021 } 13022 } 13023 }, 13024 "configuration_enterprise": { 13025 "allOf": [ 13026 { 13027 "$ref": "#/definitions/enterprise" 13028 }, 13029 { 13030 "type": "object", 13031 "properties": { 13032 "configurationAssociationId": { 13033 "type": "integer" 13034 } 13035 } 13036 } 13037 ] 13038 }, 13039 "enterprise_with_proxy_attributes": { 13040 "allOf": [ 13041 { 13042 "$ref": "#/definitions/enterprise" 13043 }, 13044 { 13045 "properties": { 13046 "enterpriseProxyId": { 13047 "type": "integer" 13048 }, 13049 "enterpriseProxyName": { 13050 "type": "string" 13051 } 13052 }, 13053 "required": [ 13054 "id", 13055 "created", 13056 "networkId", 13057 "gatewayPoolId", 13058 "alertsEnabled", 13059 "operatorAlertsEnabled", 13060 "endpointPkiMode", 13061 "name", 13062 "domain", 13063 "prefix", 13064 "logicalId", 13065 "accountNumber", 13066 "description", 13067 "contactName", 13068 "contactPhone", 13069 "contactMobile", 13070 "contactEmail", 13071 "streetAddress", 13072 "streetAddress2", 13073 "city", 13074 "state", 13075 "postalCode", 13076 "country", 13077 "lat", 13078 "lon", 13079 "timezone", 13080 "locale", 13081 "modified" 13082 ] 13083 } 13084 ] 13085 }, 13086 "enterprise_proxy": { 13087 "type": "object", 13088 "properties": { 13089 "id": { 13090 "type": "integer" 13091 }, 13092 "created": { 13093 "type": "string", 13094 "format": "date-time" 13095 }, 13096 "networkId": { 13097 "type": "integer" 13098 }, 13099 "proxyType": { 13100 "type": "string", 13101 "enum": [ 13102 "PARTNER", 13103 "MSP" 13104 ] 13105 }, 13106 "operateGateways": { 13107 "type": "boolean" 13108 }, 13109 "logicalId": { 13110 "type": "string" 13111 }, 13112 "name": { 13113 "type": "string" 13114 }, 13115 "domain": { 13116 "type": "string" 13117 }, 13118 "prefix": { 13119 "type": "string" 13120 }, 13121 "description": { 13122 "type": "string" 13123 }, 13124 "contactName": { 13125 "type": "string" 13126 }, 13127 "contactPhone": { 13128 "type": "string" 13129 }, 13130 "contactMobile": { 13131 "type": "string" 13132 }, 13133 "contactEmail": { 13134 "type": "string" 13135 }, 13136 "streetAddress": { 13137 "type": "string" 13138 }, 13139 "streetAddress2": { 13140 "type": "string" 13141 }, 13142 "city": { 13143 "type": "string" 13144 }, 13145 "state": { 13146 "type": "string" 13147 }, 13148 "postalCode": { 13149 "type": "string" 13150 }, 13151 "country": { 13152 "type": "string" 13153 }, 13154 "lat": { 13155 "type": "number", 13156 "format": "double" 13157 }, 13158 "lon": { 13159 "type": "number", 13160 "format": "double" 13161 }, 13162 "modified": { 13163 "type": "string", 13164 "format": "date-time" 13165 } 13166 } 13167 }, 13168 "enterprise_alert_configuration": { 13169 "type": "object", 13170 "properties": { 13171 "id": { 13172 "type": "integer" 13173 }, 13174 "created": { 13175 "type": "string", 13176 "format": "date-time" 13177 }, 13178 "alertDefinitionId": { 13179 "type": "integer" 13180 }, 13181 "enterpriseId": { 13182 "type": "integer" 13183 }, 13184 "enabled": { 13185 "type": "boolean" 13186 }, 13187 "name": { 13188 "type": "string", 13189 "enum": [ 13190 "EDGE_DOWN", 13191 "EDGE_UP", 13192 "LINK_DOWN", 13193 "LINK_UP", 13194 "VPN_TUNNEL_DOWN", 13195 "EDGE_HA_FAILOVER", 13196 "EDGE_SERVICE_DOWN", 13197 "GATEWAY_SERVICE_DOWN", 13198 "VNF_VM_EVENT", 13199 "VNF_VM_DEPLOYED_AND_POWERED_OFF", 13200 "VNF_VM_POWERED_ON", 13201 "VNF_VM_POWERED_OFF", 13202 "VNF_VM_DELETED", 13203 "VNF_VM_ERROR", 13204 "VNF_INSERTION_EVENT", 13205 "VNF_INSERTION_ENABLED", 13206 "VNF_INSERTION_DISABLED", 13207 "TEST_ALERT", 13208 "VNF_IMAGE_DOWNLOAD_EVENT", 13209 "VNF_IMAGE_DOWNLOAD_IN_PROGRESS", 13210 "VNF_IMAGE_DOWNLOAD_COMPLETED", 13211 "VNF_IMAGE_DOWNLOAD_FAILED", 13212 "EDGE_CSS_TUNNEL_DOWN", 13213 "EDGE_CSS_TUNNEL_UP" 13214 ] 13215 }, 13216 "description": { 13217 "type": "string" 13218 }, 13219 "type": { 13220 "type": "string", 13221 "enum": [ 13222 "EDGE_DOWN", 13223 "EDGE_UP", 13224 "LINK_DOWN", 13225 "LINK_UP", 13226 "VPN_TUNNEL_DOWN", 13227 "EDGE_HA_FAILOVER", 13228 "EDGE_SERVICE_DOWN", 13229 "GATEWAY_SERVICE_DOWN", 13230 "VNF_VM_EVENT", 13231 "VNF_VM_DEPLOYED_AND_POWERED_OFF", 13232 "VNF_VM_POWERED_ON", 13233 "VNF_VM_POWERED_OFF", 13234 "VNF_VM_DELETED", 13235 "VNF_VM_ERROR", 13236 "VNF_INSERTION_EVENT", 13237 "VNF_INSERTION_ENABLED", 13238 "VNF_INSERTION_DISABLED", 13239 "TEST_ALERT", 13240 "VNF_IMAGE_DOWNLOAD_EVENT", 13241 "VNF_IMAGE_DOWNLOAD_IN_PROGRESS", 13242 "VNF_IMAGE_DOWNLOAD_COMPLETED", 13243 "VNF_IMAGE_DOWNLOAD_FAILED", 13244 "EDGE_CSS_TUNNEL_DOWN", 13245 "EDGE_CSS_TUNNEL_UP" 13246 ] 13247 }, 13248 "definition": { 13249 "$ref": "#/definitions/enterprise_alert_definition" 13250 }, 13251 "firstNotificationSeconds": { 13252 "type": "integer" 13253 }, 13254 "maxNotifications": { 13255 "type": "integer" 13256 }, 13257 "notificationIntervalSeconds": { 13258 "type": "integer" 13259 }, 13260 "resetIntervalSeconds": { 13261 "type": "integer" 13262 }, 13263 "modified": { 13264 "type": "string", 13265 "format": "date-time" 13266 } 13267 } 13268 }, 13269 "enterprise_alert_definition": { 13270 "type": "object", 13271 "properties": { 13272 "isSystemOnly": { 13273 "type": "boolean" 13274 }, 13275 "isOperatorOnly": { 13276 "type": "boolean" 13277 } 13278 } 13279 }, 13280 "enterprise_alert_trigger": { 13281 "type": "object", 13282 "properties": { 13283 "id": { 13284 "type": "integer" 13285 }, 13286 "created": { 13287 "type": "string", 13288 "format": "date-time" 13289 }, 13290 "triggerTime": { 13291 "type": "string", 13292 "format": "date-time" 13293 }, 13294 "enterpriseAlertConfigurationId": { 13295 "type": "integer" 13296 }, 13297 "enterpriseId": { 13298 "type": "integer" 13299 }, 13300 "edgeId": { 13301 "type": "integer" 13302 }, 13303 "edgeName": { 13304 "type": "string" 13305 }, 13306 "linkId": { 13307 "type": "integer" 13308 }, 13309 "linkName": { 13310 "type": "string" 13311 }, 13312 "enterpriseObjectId": { 13313 "type": "integer" 13314 }, 13315 "enterpriseObjectName": { 13316 "type": "string" 13317 }, 13318 "name": { 13319 "type": "string", 13320 "enum": [ 13321 "EDGE_DOWN", 13322 "EDGE_UP", 13323 "LINK_DOWN", 13324 "LINK_UP", 13325 "VPN_TUNNEL_DOWN", 13326 "EDGE_HA_FAILOVER", 13327 "EDGE_SERVICE_DOWN", 13328 "GATEWAY_SERVICE_DOWN", 13329 "VNF_VM_EVENT", 13330 "VNF_VM_DEPLOYED_AND_POWERED_OFF", 13331 "VNF_VM_POWERED_ON", 13332 "VNF_VM_POWERED_OFF", 13333 "VNF_VM_DELETED", 13334 "VNF_VM_ERROR", 13335 "VNF_INSERTION_EVENT", 13336 "VNF_INSERTION_ENABLED", 13337 "VNF_INSERTION_DISABLED", 13338 "TEST_ALERT", 13339 "VNF_IMAGE_DOWNLOAD_EVENT", 13340 "VNF_IMAGE_DOWNLOAD_IN_PROGRESS", 13341 "VNF_IMAGE_DOWNLOAD_COMPLETED", 13342 "VNF_IMAGE_DOWNLOAD_FAILED", 13343 "EDGE_CSS_TUNNEL_DOWN", 13344 "EDGE_CSS_TUNNEL_UP" 13345 ] 13346 }, 13347 "type": { 13348 "type": "string", 13349 "enum": [ 13350 "EDGE_DOWN", 13351 "EDGE_UP", 13352 "LINK_DOWN", 13353 "LINK_UP", 13354 "VPN_TUNNEL_DOWN", 13355 "EDGE_HA_FAILOVER", 13356 "EDGE_SERVICE_DOWN", 13357 "GATEWAY_SERVICE_DOWN", 13358 "VNF_VM_EVENT", 13359 "VNF_VM_DEPLOYED_AND_POWERED_OFF", 13360 "VNF_VM_POWERED_ON", 13361 "VNF_VM_POWERED_OFF", 13362 "VNF_VM_DELETED", 13363 "VNF_VM_ERROR", 13364 "VNF_INSERTION_EVENT", 13365 "VNF_INSERTION_ENABLED", 13366 "VNF_INSERTION_DISABLED", 13367 "TEST_ALERT", 13368 "VNF_IMAGE_DOWNLOAD_EVENT", 13369 "VNF_IMAGE_DOWNLOAD_IN_PROGRESS", 13370 "VNF_IMAGE_DOWNLOAD_COMPLETED", 13371 "VNF_IMAGE_DOWNLOAD_FAILED", 13372 "EDGE_CSS_TUNNEL_DOWN", 13373 "EDGE_CSS_TUNNEL_UP" 13374 ] 13375 }, 13376 "state": { 13377 "type": "string", 13378 "enum": [ 13379 "PENDING", 13380 "ACTIVE", 13381 "CLOSED" 13382 ] 13383 }, 13384 "stateSetTime": { 13385 "type": "string", 13386 "format": "date-time" 13387 }, 13388 "lastContact": { 13389 "type": "string", 13390 "format": "date-time" 13391 }, 13392 "firstNotificationSeconds": { 13393 "type": "integer" 13394 }, 13395 "maxNotifications": { 13396 "type": "integer" 13397 }, 13398 "notificationIntervalSeconds": { 13399 "type": "integer" 13400 }, 13401 "resetIntervalSeconds": { 13402 "type": "integer" 13403 }, 13404 "comment": { 13405 "type": "string" 13406 }, 13407 "nextNotificationTime": { 13408 "type": "string", 13409 "format": "date-time" 13410 }, 13411 "remainingNotifications": { 13412 "type": "integer" 13413 }, 13414 "timezone": { 13415 "type": "string" 13416 }, 13417 "locale": { 13418 "type": "string" 13419 }, 13420 "modified": { 13421 "type": "string", 13422 "format": "date-time" 13423 } 13424 } 13425 }, 13426 "enterprise_object_base": { 13427 "type": "object", 13428 "properties": { 13429 "id": { 13430 "type": "integer" 13431 }, 13432 "created": { 13433 "type": "string", 13434 "format": "date-time" 13435 }, 13436 "operatorId": { 13437 "type": "integer" 13438 }, 13439 "networkId": { 13440 "type": "integer" 13441 }, 13442 "enterpriseId": { 13443 "type": "integer" 13444 }, 13445 "edgeId": { 13446 "type": "integer" 13447 }, 13448 "gatewayId": { 13449 "type": "integer" 13450 }, 13451 "parentGroupId": { 13452 "type": "integer" 13453 }, 13454 "description": { 13455 "type": "string" 13456 }, 13457 "object": { 13458 "type": "string" 13459 }, 13460 "name": { 13461 "type": "string" 13462 }, 13463 "type": { 13464 "type": "string" 13465 }, 13466 "logicalId": { 13467 "type": "string" 13468 }, 13469 "alertsEnabled": { 13470 "$ref": "#/definitions/tinyint" 13471 }, 13472 "operatorAlertsEnabled": { 13473 "$ref": "#/definitions/tinyint" 13474 }, 13475 "status": { 13476 "type": "string" 13477 }, 13478 "statusModified": { 13479 "type": "string", 13480 "format": "date-time" 13481 }, 13482 "previousData": { 13483 "type": "object" 13484 }, 13485 "previousCreated": { 13486 "type": "string", 13487 "format": "date-time" 13488 }, 13489 "draftData": { 13490 "type": "string" 13491 }, 13492 "draftCreated": { 13493 "type": "string", 13494 "format": "date-time" 13495 }, 13496 "draftComment": { 13497 "type": "string" 13498 }, 13499 "lastContact": { 13500 "type": "string", 13501 "format": "date-time" 13502 }, 13503 "version": { 13504 "type": "string" 13505 }, 13506 "modified": { 13507 "type": "string", 13508 "format": "date-time" 13509 } 13510 }, 13511 "required": [ 13512 "id", 13513 "created", 13514 "operatorId", 13515 "networkId", 13516 "enterpriseId", 13517 "edgeId", 13518 "gatewayId", 13519 "parentGroupId", 13520 "description", 13521 "object", 13522 "name", 13523 "type", 13524 "logicalId", 13525 "alertsEnabled", 13526 "operatorAlertsEnabled", 13527 "status", 13528 "statusModified", 13529 "previousData", 13530 "previousCreated", 13531 "draftData", 13532 "draftCreated", 13533 "draftComment", 13534 "lastContact", 13535 "version", 13536 "modified" 13537 ] 13538 }, 13539 "event_base": { 13540 "type": "object", 13541 "properties": { 13542 "id": { 13543 "type": "integer" 13544 }, 13545 "eventTime": { 13546 "type": "string", 13547 "format": "date-time" 13548 }, 13549 "event": { 13550 "type": "string" 13551 }, 13552 "category": { 13553 "type": "string", 13554 "enum": [ 13555 "SYSTEM", 13556 "NETWORK", 13557 "APPLICATION", 13558 "USER", 13559 "SECURITY", 13560 "EDGE", 13561 "GATEWAY", 13562 "CONFIGURATION", 13563 "ENTERPRISE" 13564 ] 13565 }, 13566 "severity": { 13567 "type": "string", 13568 "enum": [ 13569 "EMERGENCY", 13570 "ALERT", 13571 "CRITICAL", 13572 "ERROR", 13573 "WARNING", 13574 "NOTICE", 13575 "INFO", 13576 "DEBUG" 13577 ] 13578 }, 13579 "message": { 13580 "type": "string" 13581 } 13582 } 13583 }, 13584 "enterprise_event": { 13585 "allOf": [ 13586 { 13587 "$ref": "#/definitions/event_base" 13588 }, 13589 { 13590 "properties": { 13591 "detail": { 13592 "type": "string" 13593 }, 13594 "enterpriseUsername": { 13595 "type": "string" 13596 }, 13597 "edgeName": { 13598 "type": "string" 13599 } 13600 }, 13601 "required": [ 13602 "id", 13603 "eventTime", 13604 "event", 13605 "category", 13606 "severity", 13607 "message", 13608 "detail", 13609 "enterpriseUsername", 13610 "edgeName" 13611 ] 13612 } 13613 ] 13614 }, 13615 "operator_event": { 13616 "allOf": [ 13617 { 13618 "$ref": "#/definitions/event_base" 13619 }, 13620 { 13621 "properties": { 13622 "detail": { 13623 "type": "string" 13624 }, 13625 "operatorUsername": { 13626 "type": "string" 13627 }, 13628 "networkName": { 13629 "type": "string" 13630 }, 13631 "gatewayName": { 13632 "type": "string" 13633 } 13634 }, 13635 "required": [ 13636 "id", 13637 "eventTime", 13638 "event", 13639 "category", 13640 "severity", 13641 "message", 13642 "detail", 13643 "operatorUsername", 13644 "networkName", 13645 "gatewayName" 13646 ] 13647 } 13648 ] 13649 }, 13650 "proxy_event": { 13651 "allOf": [ 13652 { 13653 "$ref": "#/definitions/event_base" 13654 }, 13655 { 13656 "properties": { 13657 "detail": { 13658 "type": "string" 13659 }, 13660 "proxyUsername": { 13661 "type": "string" 13662 }, 13663 "networkName": { 13664 "type": "string" 13665 }, 13666 "enterpriseName": { 13667 "type": "string" 13668 } 13669 }, 13670 "required": [ 13671 "id", 13672 "eventTime", 13673 "event", 13674 "category", 13675 "severity", 13676 "message", 13677 "detail", 13678 "proxyUsername", 13679 "networkName", 13680 "enterpriseName" 13681 ] 13682 } 13683 ] 13684 }, 13685 "aggregate_enterprise_event": { 13686 "allOf": [ 13687 { 13688 "$ref": "#/definitions/event_base" 13689 }, 13690 { 13691 "properties": { 13692 "enterpriseId": { 13693 "type": "integer" 13694 }, 13695 "enterpriseName": { 13696 "type": "string" 13697 }, 13698 "enterpriseUsername": { 13699 "type": "string" 13700 }, 13701 "edgeName": { 13702 "type": "string" 13703 }, 13704 "detail": { 13705 "type": "string" 13706 } 13707 }, 13708 "required": [ 13709 "id", 13710 "eventTime", 13711 "event", 13712 "category", 13713 "severity", 13714 "message", 13715 "enterpriseId", 13716 "enterpriseName", 13717 "enterpriseUsername", 13718 "edgeName", 13719 "detail" 13720 ] 13721 } 13722 ] 13723 }, 13724 "vnf_image_download_event": { 13725 "allOf": [ 13726 { 13727 "$ref": "#/definitions/event_base" 13728 }, 13729 { 13730 "properties": { 13731 "detail": { 13732 "$ref": "#/definitions/vnf_image_download_event_detail" 13733 } 13734 }, 13735 "required": [ 13736 "id", 13737 "eventTime", 13738 "event", 13739 "category", 13740 "severity", 13741 "detail" 13742 ] 13743 } 13744 ] 13745 }, 13746 "vnf_image_download_event_detail": { 13747 "type": "object", 13748 "properties": { 13749 "logicalId": { 13750 "type": "string" 13751 }, 13752 "vnfType": { 13753 "type": "string", 13754 "pattern": "vnfImage" 13755 }, 13756 "vendor": { 13757 "type": "string", 13758 "enum": [ 13759 "PaloAlto", 13760 "CheckPoint", 13761 "Fortinet", 13762 "CentOS" 13763 ] 13764 }, 13765 "downloadType": { 13766 "type": "string", 13767 "enum": [ 13768 "s3", 13769 "http", 13770 "https" 13771 ] 13772 }, 13773 "edgeSerialNumber": { 13774 "type": "string" 13775 }, 13776 "isEdgeActive": { 13777 "type": "boolean" 13778 }, 13779 "status": { 13780 "type": "string", 13781 "enum": [ 13782 "IN_PROGRESS", 13783 "ERROR", 13784 "FAILED", 13785 "COMPLETED", 13786 "UNKNOWN" 13787 ] 13788 }, 13789 "description": { 13790 "type": "string" 13791 }, 13792 "service": { 13793 "allOf": [ 13794 { 13795 "$ref": "#/definitions/logicalid_reference" 13796 }, 13797 { 13798 "type": "object", 13799 "properties": { 13800 "ref": { 13801 "type": "string", 13802 "pattern": "deviceSettings:securityVnf:service" 13803 } 13804 } 13805 } 13806 ] 13807 } 13808 } 13809 }, 13810 "gateway_pool_gateway": { 13811 "type": "object", 13812 "properties": { 13813 "gatewayPoolAssocId": { 13814 "type": "integer" 13815 }, 13816 "poolName": { 13817 "type": "string" 13818 }, 13819 "id": { 13820 "type": "integer" 13821 }, 13822 "created": { 13823 "type": "string", 13824 "format": "date-time" 13825 }, 13826 "networkId": { 13827 "type": "integer" 13828 }, 13829 "enterpriseProxyId": { 13830 "type": "integer" 13831 }, 13832 "siteId": { 13833 "type": "integer" 13834 }, 13835 "activationKey": { 13836 "type": "string" 13837 }, 13838 "activationState": { 13839 "type": "string" 13840 }, 13841 "activationTime": { 13842 "type": "string", 13843 "format": "date-time" 13844 }, 13845 "softwareVersion": { 13846 "type": "string" 13847 }, 13848 "buildNumber": { 13849 "type": "string" 13850 }, 13851 "utilization": { 13852 "type": "number" 13853 }, 13854 "utilizationDetail": { 13855 "type": "object", 13856 "properties": { 13857 "load": { 13858 "type": "number" 13859 }, 13860 "overall": { 13861 "type": "number" 13862 }, 13863 "cpu": { 13864 "type": "number" 13865 }, 13866 "memory": { 13867 "type": "number" 13868 } 13869 } 13870 }, 13871 "connectedEdges": { 13872 "type": "integer" 13873 }, 13874 "connectedEdgeList": { 13875 "type": "array", 13876 "items": { 13877 "type": "object", 13878 "properties": { 13879 "vceid": { 13880 "type": "string" 13881 } 13882 } 13883 } 13884 }, 13885 "deviceId": { 13886 "type": "string" 13887 }, 13888 "logicalId": { 13889 "type": "string" 13890 }, 13891 "name": { 13892 "type": "string" 13893 }, 13894 "gatewayState": { 13895 "type": "string" 13896 }, 13897 "description": { 13898 "type": "string" 13899 }, 13900 "dnsName": { 13901 "type": "string" 13902 }, 13903 "isLoadBalanced": { 13904 "type": "integer" 13905 }, 13906 "privateIpAddress": { 13907 "type": "string" 13908 }, 13909 "ipAddress": { 13910 "type": "string" 13911 }, 13912 "lastContact": { 13913 "type": "string", 13914 "format": "date-time" 13915 }, 13916 "systemUpSince": { 13917 "type": "string", 13918 "format": "date-time" 13919 }, 13920 "serviceUpSince": { 13921 "type": "string", 13922 "format": "date-time" 13923 }, 13924 "serviceState": { 13925 "type": "string" 13926 }, 13927 "endpointPkiMode": { 13928 "type": "string" 13929 }, 13930 "handOffDetail": { 13931 "$ref": "#/definitions/gateway_handoff_detail" 13932 }, 13933 "ipsecGatewayDetail": { 13934 "type": "object", 13935 "properties": { 13936 "enabled": { 13937 "type": "boolean" 13938 }, 13939 "strictHostCheck": { 13940 "type": "boolean" 13941 }, 13942 "strictHostCheckDN": { 13943 "type": "string" 13944 } 13945 } 13946 }, 13947 "modified": { 13948 "type": "string", 13949 "format": "date-time" 13950 } 13951 } 13952 }, 13953 "gateway_handoff_detail": { 13954 "type": "object", 13955 "properties": { 13956 "type": { 13957 "type": "string" 13958 }, 13959 "subnets": { 13960 "type": "array", 13961 "items": { 13962 "type": "object", 13963 "properties": { 13964 "name": { 13965 "type": "string" 13966 }, 13967 "routeCost": { 13968 "type": "integer", 13969 "minimum": 0, 13970 "maximum": 255 13971 }, 13972 "cidrIp": { 13973 "type": "string" 13974 }, 13975 "cidrPrefix": { 13976 "type": "integer" 13977 }, 13978 "encrypt": { 13979 "type": "boolean" 13980 }, 13981 "handOffType": { 13982 "type": "string", 13983 "enum": [ 13984 "NAT", 13985 "VLAN" 13986 ] 13987 } 13988 } 13989 } 13990 }, 13991 "icmpProbe": { 13992 "type": "object", 13993 "properties": { 13994 "enabled": { 13995 "type": "boolean" 13996 }, 13997 "probeType": { 13998 "type": "string" 13999 }, 14000 "cTag": { 14001 "type": "integer" 14002 }, 14003 "sTag": { 14004 "type": "integer" 14005 }, 14006 "destinationIp": { 14007 "type": "string" 14008 }, 14009 "frequencySeconds": { 14010 "type": "integer" 14011 }, 14012 "threshold": { 14013 "type": "integer" 14014 } 14015 } 14016 }, 14017 "icmpResponder": { 14018 "type": "object", 14019 "properties": { 14020 "enabled": { 14021 "type": "boolean" 14022 }, 14023 "ipAddress": { 14024 "type": "string" 14025 }, 14026 "mode": { 14027 "type": "string" 14028 } 14029 } 14030 } 14031 } 14032 }, 14033 "gateway_handoff_ipsec_gateway_detail": { 14034 "type": "object", 14035 "properties": { 14036 "ipsecGatewayAddress": { 14037 "type": "string" 14038 }, 14039 "strictHostCheck": { 14040 "type": "boolean" 14041 }, 14042 "strictHostCheckDN": { 14043 "type": "string" 14044 } 14045 }, 14046 "required": [ 14047 "ipsecGatewayAddress" 14048 ] 14049 }, 14050 "gateway_pool": { 14051 "type": "object", 14052 "properties": { 14053 "id": { 14054 "type": "integer" 14055 }, 14056 "networkId": { 14057 "type": "integer" 14058 }, 14059 "enterpriseProxyId": { 14060 "type": "integer" 14061 }, 14062 "created": { 14063 "type": "string", 14064 "format": "date-time" 14065 }, 14066 "name": { 14067 "type": "string" 14068 }, 14069 "description": { 14070 "type": "string" 14071 }, 14072 "isDefault": { 14073 "type": "boolean" 14074 }, 14075 "handOffType": { 14076 "type": "string", 14077 "enum": [ 14078 "NONE", 14079 "ALLOW", 14080 "ONLY" 14081 ] 14082 }, 14083 "modified": { 14084 "type": "string", 14085 "format": "date-time" 14086 } 14087 } 14088 }, 14089 "link": { 14090 "type": "object", 14091 "properties": { 14092 "id": { 14093 "type": "integer" 14094 }, 14095 "created": { 14096 "type": "string", 14097 "format": "date-time" 14098 }, 14099 "edgeId": { 14100 "type": "integer" 14101 }, 14102 "logicalId": { 14103 "type": "string" 14104 }, 14105 "internalId": { 14106 "type": "string" 14107 }, 14108 "interface": { 14109 "type": "string" 14110 }, 14111 "macAddress": { 14112 "type": "string" 14113 }, 14114 "ipAddress": { 14115 "type": "string" 14116 }, 14117 "netmask": { 14118 "type": "string" 14119 }, 14120 "networkSide": { 14121 "type": "string", 14122 "enum": [ 14123 "UNKOWN", 14124 "WAN", 14125 "LAN" 14126 ] 14127 }, 14128 "networkType": { 14129 "type": "string", 14130 "enum": [ 14131 "UNKNOWN", 14132 "WIRELESS", 14133 "ETHERNET", 14134 "WIFI" 14135 ] 14136 }, 14137 "displayName": { 14138 "type": "string" 14139 }, 14140 "isp": { 14141 "type": "string" 14142 }, 14143 "org": { 14144 "type": "string" 14145 }, 14146 "lat": { 14147 "type": "number", 14148 "format": "double" 14149 }, 14150 "lon": { 14151 "type": "number", 14152 "format": "double" 14153 }, 14154 "lastActive": { 14155 "type": "string", 14156 "format": "date-time" 14157 }, 14158 "state": { 14159 "type": "string", 14160 "enum": [ 14161 "UNKNOWN", 14162 "STABLE", 14163 "UNSTABLE", 14164 "DISCONNECTED", 14165 "QUIET", 14166 "INITIAL", 14167 "STANDBY" 14168 ] 14169 }, 14170 "backupState": { 14171 "type": "string", 14172 "enum": [ 14173 "UNCONFIGURED", 14174 "STANDBY", 14175 "ACTIVE" 14176 ] 14177 }, 14178 "vpnState": { 14179 "type": "string", 14180 "enum": [ 14181 "UNKNOWN", 14182 "STABLE", 14183 "UNSTABLE", 14184 "DEAD", 14185 "STANDBY" 14186 ] 14187 }, 14188 "lastEvent": { 14189 "type": "string", 14190 "format": "date-time" 14191 }, 14192 "lastEventState": { 14193 "type": "string", 14194 "enum": [ 14195 "UNKNOWN", 14196 "STABLE", 14197 "UNSTABLE", 14198 "DISCONNECTED", 14199 "QUIET", 14200 "INITIAL", 14201 "STANDBY" 14202 ] 14203 }, 14204 "alertsEnabled": { 14205 "$ref": "#/definitions/tinyint" 14206 }, 14207 "operatorAlertsEnabled": { 14208 "$ref": "#/definitions/tinyint" 14209 }, 14210 "serviceState": { 14211 "type": "string", 14212 "enum": [ 14213 "IN_SERVICE", 14214 "OUT_OF_SERVICE", 14215 "HISTORICAL" 14216 ] 14217 }, 14218 "modified": { 14219 "type": "string", 14220 "format": "date-time" 14221 }, 14222 "serviceGroups": { 14223 "$ref": "#/definitions/link_service_groups" 14224 } 14225 }, 14226 "required": [ 14227 "id", 14228 "created", 14229 "edgeId", 14230 "logicalId", 14231 "internalId", 14232 "interface", 14233 "macAddress", 14234 "ipAddress", 14235 "netmask", 14236 "networkSide", 14237 "networkType", 14238 "displayName", 14239 "isp", 14240 "org", 14241 "lat", 14242 "lon", 14243 "lastActive", 14244 "state", 14245 "backupState", 14246 "vpnState", 14247 "lastEvent", 14248 "lastEventState", 14249 "alertsEnabled", 14250 "operatorAlertsEnabled", 14251 "serviceState", 14252 "modified" 14253 ] 14254 }, 14255 "client_device": { 14256 "type": "object", 14257 "properties": { 14258 "id": { 14259 "type": "integer" 14260 }, 14261 "created": { 14262 "type": "string", 14263 "format": "date-time" 14264 }, 14265 "enterpriseId": { 14266 "type": "integer" 14267 }, 14268 "macAddress": { 14269 "type": "string" 14270 }, 14271 "hostName": { 14272 "type": "string" 14273 }, 14274 "ipAddress": { 14275 "type": "string" 14276 }, 14277 "os": { 14278 "type": "integer" 14279 }, 14280 "osName": { 14281 "type": "string" 14282 }, 14283 "osVersion": { 14284 "type": "string" 14285 }, 14286 "deviceType": { 14287 "type": "string" 14288 }, 14289 "deviceModel": { 14290 "type": "string" 14291 }, 14292 "lastContact": { 14293 "type": "string", 14294 "format": "date-time" 14295 }, 14296 "modified": { 14297 "type": "string", 14298 "format": "date-time" 14299 } 14300 }, 14301 "required": [ 14302 "id", 14303 "created", 14304 "enterpriseId", 14305 "macAddress", 14306 "hostName", 14307 "ipAddress", 14308 "os", 14309 "osName", 14310 "osVersion", 14311 "deviceType", 14312 "deviceModel", 14313 "lastContact", 14314 "modified" 14315 ] 14316 }, 14317 "link_quality_object": { 14318 "type": "object", 14319 "properties": { 14320 "distribution": { 14321 "$ref": "#/definitions/link_quality_object_distribution" 14322 }, 14323 "sampleCount": { 14324 "type": "integer" 14325 }, 14326 "sampleLength": { 14327 "type": "integer" 14328 }, 14329 "score": { 14330 "type": "object", 14331 "additionalProperties": { 14332 "type": "number" 14333 } 14334 }, 14335 "timeseries": { 14336 "type": "array", 14337 "items": { 14338 "$ref": "#/definitions/link_quality_object_timeseries_data" 14339 } 14340 }, 14341 "totalScore": { 14342 "type": "number" 14343 } 14344 }, 14345 "required": [ 14346 "distribution", 14347 "sampleCount", 14348 "sampleLength", 14349 "score", 14350 "timeseries", 14351 "totalScore" 14352 ] 14353 }, 14354 "link_quality_object_distribution": { 14355 "type": "object", 14356 "additionalProperties": { 14357 "type": "object", 14358 "additionalProperties": { 14359 "type": "number" 14360 } 14361 } 14362 }, 14363 "link_quality_object_timeseries_data": { 14364 "type": "object", 14365 "properties": { 14366 "before": { 14367 "type": "object", 14368 "additionalProperties": { 14369 "type": "integer" 14370 } 14371 }, 14372 "after": { 14373 "type": "object", 14374 "additionalProperties": { 14375 "type": "integer" 14376 } 14377 }, 14378 "metadata": { 14379 "type": "object", 14380 "properties": { 14381 "detail": { 14382 "type": "object", 14383 "properties": { 14384 "latencyMsRx": { 14385 "type": "integer" 14386 }, 14387 "latencyMsTx": { 14388 "type": "integer" 14389 }, 14390 "lossPctRx": { 14391 "type": "integer" 14392 }, 14393 "lossPctTx": { 14394 "type": "integer" 14395 }, 14396 "jitterMsRx": { 14397 "type": "integer" 14398 }, 14399 "jitterMsTx": { 14400 "type": "integer" 14401 } 14402 } 14403 }, 14404 "metrics": { 14405 "type": "array", 14406 "items": { 14407 "type": "object", 14408 "properties": { 14409 "trafficType": { 14410 "type": "integer", 14411 "enum": [ 14412 0, 14413 1, 14414 2 14415 ] 14416 }, 14417 "action": { 14418 "type": "integer", 14419 "enum": [ 14420 0, 14421 1, 14422 2, 14423 3, 14424 4 14425 ] 14426 }, 14427 "metric": { 14428 "type": "integer", 14429 "enum": [ 14430 0, 14431 1, 14432 2, 14433 3, 14434 4, 14435 5 14436 ] 14437 }, 14438 "beforeState": { 14439 "type": "integer", 14440 "enum": [ 14441 0, 14442 1, 14443 2, 14444 3, 14445 4 14446 ] 14447 }, 14448 "afterState": { 14449 "type": "integer", 14450 "enum": [ 14451 0, 14452 1, 14453 2, 14454 3, 14455 4 14456 ] 14457 } 14458 } 14459 } 14460 }, 14461 "stateMap": { 14462 "type": "object", 14463 "additionalProperties": { 14464 "type": "object", 14465 "additionalProperties": { 14466 "type": "object", 14467 "properties": { 14468 "before": { 14469 "type": "integer" 14470 }, 14471 "after": { 14472 "type": "integer" 14473 }, 14474 "action": { 14475 "type": "integer" 14476 } 14477 } 14478 } 14479 } 14480 } 14481 } 14482 }, 14483 "timestamp": { 14484 "type": "integer", 14485 "format": "int64" 14486 } 14487 }, 14488 "required": [ 14489 "after", 14490 "metadata", 14491 "timestamp" 14492 ] 14493 }, 14494 "enterprise_route": { 14495 "type": "object", 14496 "properties": { 14497 "type": { 14498 "type": "string" 14499 }, 14500 "exitType": { 14501 "type": "string" 14502 }, 14503 "edgeId": { 14504 "type": "integer" 14505 }, 14506 "edgeName": { 14507 "type": "string" 14508 }, 14509 "profileId": { 14510 "type": "integer" 14511 }, 14512 "cidrIp": { 14513 "type": "string" 14514 }, 14515 "cost": { 14516 "type": "integer" 14517 }, 14518 "advertise": { 14519 "type": "boolean" 14520 } 14521 } 14522 }, 14523 "vlan": { 14524 "type": "object", 14525 "properties": { 14526 "name": { 14527 "type": "string" 14528 }, 14529 "vlanId": { 14530 "type": "integer" 14531 }, 14532 "staticReserved": { 14533 "type": "integer" 14534 } 14535 } 14536 }, 14537 "enterprise_network_space": { 14538 "type": "object", 14539 "properties": { 14540 "name": { 14541 "type": "string" 14542 }, 14543 "mode": { 14544 "type": "string", 14545 "enum": [ 14546 "static", 14547 "dynamic" 14548 ] 14549 }, 14550 "cidrIp": { 14551 "type": "string" 14552 }, 14553 "cidrPrefix": { 14554 "type": "integer" 14555 }, 14556 "maxVlans": { 14557 "type": "integer" 14558 }, 14559 "vlans": { 14560 "type": "array", 14561 "items": { 14562 "$ref": "#/definitions/vlan" 14563 } 14564 } 14565 } 14566 }, 14567 "enterprise_service_base_type": { 14568 "type": "object", 14569 "discriminator": "type", 14570 "properties": { 14571 "id": { 14572 "type": "integer" 14573 }, 14574 "enterpriseObjectId": { 14575 "type": "integer" 14576 }, 14577 "configurationId": { 14578 "type": "integer" 14579 }, 14580 "moduleId": { 14581 "type": "integer" 14582 }, 14583 "ref": { 14584 "type": "string" 14585 }, 14586 "version": { 14587 "type": "string" 14588 }, 14589 "object": { 14590 "type": "string" 14591 }, 14592 "name": { 14593 "type": "string" 14594 }, 14595 "type": { 14596 "type": "string" 14597 }, 14598 "logicalId": { 14599 "type": "string" 14600 } 14601 }, 14602 "required": [ 14603 "type" 14604 ] 14605 }, 14606 "dns": { 14607 "allOf": [ 14608 { 14609 "$ref": "#/definitions/enterprise_service_base_type" 14610 }, 14611 { 14612 "type": "object", 14613 "properties": { 14614 "data": { 14615 "$ref": "#/definitions/dns_data" 14616 } 14617 } 14618 } 14619 ] 14620 }, 14621 "dns_data": { 14622 "type": "object", 14623 "properties": { 14624 "primary": { 14625 "type": "string" 14626 }, 14627 "secondary": { 14628 "type": "string" 14629 }, 14630 "isPrivate": { 14631 "type": "boolean" 14632 }, 14633 "domains": { 14634 "type": "array", 14635 "items": { 14636 "type": "object", 14637 "properties": { 14638 "rule": { 14639 "type": "string" 14640 }, 14641 "description": { 14642 "type": "string" 14643 } 14644 } 14645 } 14646 } 14647 } 14648 }, 14649 "enterprise_service_network": { 14650 "allOf": [ 14651 { 14652 "$ref": "#/definitions/enterprise_service_base_type" 14653 }, 14654 { 14655 "type": "object", 14656 "properties": { 14657 "data": { 14658 "$ref": "#/definitions/enterprise_service_network_data" 14659 } 14660 } 14661 } 14662 ] 14663 }, 14664 "enterprise_service_network_data": { 14665 "type": "object", 14666 "properties": { 14667 "zone": { 14668 "type": "string" 14669 }, 14670 "spaces": { 14671 "type": "array", 14672 "items": { 14673 "type": "object", 14674 "properties": { 14675 "cidrIp": { 14676 "type": "string" 14677 }, 14678 "cidrPrefix": { 14679 "type": "integer" 14680 }, 14681 "maxVlans": { 14682 "type": "integer" 14683 }, 14684 "mode": { 14685 "type": "string" 14686 }, 14687 "name": { 14688 "type": "string" 14689 }, 14690 "branchCidrPrefix": { 14691 "type": "integer" 14692 }, 14693 "guest": { 14694 "type": "boolean" 14695 }, 14696 "vlans": { 14697 "type": "array", 14698 "items": { 14699 "type": "object", 14700 "properties": { 14701 "name": { 14702 "type": "string" 14703 }, 14704 "vlanId": { 14705 "type": "integer" 14706 }, 14707 "advertise": { 14708 "type": "boolean" 14709 }, 14710 "cost": { 14711 "type": "integer" 14712 }, 14713 "staticReserved": { 14714 "type": "integer" 14715 }, 14716 "dhcp": { 14717 "type": "object", 14718 "properties": { 14719 "enabled": { 14720 "type": "boolean" 14721 }, 14722 "leaseTimeSeconds": { 14723 "type": "integer" 14724 } 14725 } 14726 } 14727 } 14728 } 14729 } 14730 } 14731 } 14732 } 14733 } 14734 }, 14735 "configuration_module_base_type": { 14736 "type": "object", 14737 "required": [ 14738 "name" 14739 ], 14740 "properties": { 14741 "id": { 14742 "type": "integer" 14743 }, 14744 "name": { 14745 "type": "string", 14746 "enum": [ 14747 "imageUpdate", 14748 "controlPlane", 14749 "managementPlane", 14750 "firewall", 14751 "QOS", 14752 "deviceSettings", 14753 "WAN", 14754 "metaData", 14755 "properties" 14756 ] 14757 }, 14758 "type": { 14759 "type": "string", 14760 "enum": [ 14761 "ENTERPRISE", 14762 "OPERATOR", 14763 "GATEWAY" 14764 ] 14765 }, 14766 "description": { 14767 "type": "string" 14768 }, 14769 "configurationId": { 14770 "type": "integer" 14771 } 14772 }, 14773 "discriminator": "name" 14774 }, 14775 "genericRefs": { 14776 "type": "object", 14777 "additionalProperties": { 14778 "$ref": "#/definitions/enterprise_service_base_type" 14779 } 14780 }, 14781 "imageUpdate": { 14782 "allOf": [ 14783 { 14784 "$ref": "#/definitions/configuration_module_base_type" 14785 }, 14786 { 14787 "type": "object", 14788 "properties": { 14789 "data": { 14790 "$ref": "#/definitions/image_update_data" 14791 } 14792 }, 14793 "required": [ 14794 "data" 14795 ] 14796 } 14797 ] 14798 }, 14799 "image_update_data": { 14800 "type": "object", 14801 "properties": { 14802 "buildNumber": { 14803 "type": "string" 14804 }, 14805 "profileDeviceFamily": { 14806 "type": "string" 14807 }, 14808 "profileVersion": { 14809 "type": "string" 14810 }, 14811 "scheduledStartTime": { 14812 "$ref": "#/definitions/image_update_scheduled_time" 14813 }, 14814 "softwarePackageId": { 14815 "type": "integer" 14816 }, 14817 "softwarePackageName": { 14818 "type": "string" 14819 }, 14820 "version": { 14821 "type": "string" 14822 }, 14823 "windowDurationMins": { 14824 "type": "integer" 14825 }, 14826 "windowed": { 14827 "type": "boolean" 14828 } 14829 }, 14830 "required": [ 14831 "buildNumber", 14832 "profileDeviceFamily", 14833 "profileVersion", 14834 "softwarePackageId", 14835 "softwarePackageName", 14836 "version", 14837 "windowDurationMins", 14838 "windowed" 14839 ] 14840 }, 14841 "image_update_scheduled_time": { 14842 "type": "object", 14843 "properties": { 14844 "dayOfWeek": { 14845 "type": "integer" 14846 }, 14847 "specified": { 14848 "type": "boolean" 14849 }, 14850 "timeOfDayMins": { 14851 "type": "integer" 14852 }, 14853 "useEdgeTimeZone": { 14854 "type": "boolean" 14855 } 14856 }, 14857 "required": [ 14858 "dayOfWeek", 14859 "specified", 14860 "timeOfDayMins", 14861 "useEdgeTimeZone" 14862 ] 14863 }, 14864 "controlPlane": { 14865 "allOf": [ 14866 { 14867 "$ref": "#/definitions/configuration_module_base_type" 14868 }, 14869 { 14870 "type": "object", 14871 "properties": { 14872 "data": { 14873 "$ref": "#/definitions/control_plane_data" 14874 } 14875 }, 14876 "required": [ 14877 "data" 14878 ] 14879 } 14880 ] 14881 }, 14882 "control_plane_data": { 14883 "type": "object", 14884 "properties": { 14885 "gatewaySelection": { 14886 "type": "object", 14887 "properties": { 14888 "mode": { 14889 "type": "string" 14890 }, 14891 "primary": { 14892 "type": "string" 14893 }, 14894 "primaryDetail": { 14895 "type": "object", 14896 "properties": { 14897 "ipAddress": { 14898 "type": "string" 14899 }, 14900 "logicalId": { 14901 "type": "string" 14902 }, 14903 "name": { 14904 "type": "string" 14905 } 14906 }, 14907 "required": [ 14908 "ipAddress", 14909 "logicalId", 14910 "name" 14911 ] 14912 }, 14913 "secondary": { 14914 "type": "string" 14915 }, 14916 "secondaryDetail": { 14917 "type": "object", 14918 "properties": { 14919 "ipAddress": { 14920 "type": "string" 14921 }, 14922 "logicalId": { 14923 "type": "string" 14924 }, 14925 "name": { 14926 "type": "string" 14927 } 14928 }, 14929 "required": [ 14930 "ipAddress", 14931 "logicalId", 14932 "name" 14933 ] 14934 }, 14935 "super": { 14936 "type": "string" 14937 }, 14938 "superDetail": { 14939 "type": "object", 14940 "properties": { 14941 "ipAddress": { 14942 "type": "string" 14943 }, 14944 "logicalId": { 14945 "type": "string" 14946 }, 14947 "name": { 14948 "type": "string" 14949 } 14950 } 14951 } 14952 } 14953 }, 14954 "vpn": { 14955 "type": "object", 14956 "properties": { 14957 "dataCenterEdges": { 14958 "type": "array", 14959 "items": { 14960 "type": "object", 14961 "properties": { 14962 "logicalId": { 14963 "type": "string" 14964 }, 14965 "name": { 14966 "type": "string" 14967 } 14968 } 14969 } 14970 }, 14971 "edgeToDataCenter": { 14972 "type": "boolean" 14973 }, 14974 "edgeToEdge": { 14975 "type": "boolean" 14976 }, 14977 "edgeToEdgeDetail": { 14978 "type": "object", 14979 "properties": { 14980 "dynamic": { 14981 "type": "object", 14982 "properties": { 14983 "enabled": { 14984 "type": "boolean" 14985 }, 14986 "timeout": { 14987 "type": "integer" 14988 }, 14989 "type": { 14990 "type": "string" 14991 } 14992 } 14993 }, 14994 "encryptionProtocol": { 14995 "type": "string" 14996 }, 14997 "profileIsolation": { 14998 "type": "object", 14999 "properties": { 15000 "enabled": { 15001 "type": "boolean" 15002 }, 15003 "isolateDynamic": { 15004 "type": "boolean" 15005 } 15006 } 15007 }, 15008 "useCloudGateway": { 15009 "type": "boolean" 15010 }, 15011 "vpnHubs": { 15012 "type": "array", 15013 "items": { 15014 "type": "object" 15015 } 15016 }, 15017 "autoSelectVpnHubs": { 15018 "type": "boolean" 15019 } 15020 } 15021 }, 15022 "edgeToEdgeList": { 15023 "type": "array", 15024 "items": { 15025 "type": "object", 15026 "properties": { 15027 "isolateDynamic": { 15028 "type": "integer" 15029 }, 15030 "logicalId": { 15031 "type": "string" 15032 }, 15033 "name": { 15034 "type": "string" 15035 }, 15036 "profileLogicalId": { 15037 "type": "string" 15038 } 15039 } 15040 } 15041 } 15042 } 15043 }, 15044 "ipsecGatewayDetail": { 15045 "type": "object", 15046 "additionalProperties": { 15047 "type": "object", 15048 "properties": { 15049 "enabled": { 15050 "type": "boolean" 15051 }, 15052 "strictHostCheck": { 15053 "type": "boolean" 15054 }, 15055 "strictHostCheckDN": { 15056 "type": "string" 15057 } 15058 } 15059 } 15060 } 15061 }, 15062 "required": [ 15063 "gatewaySelection" 15064 ] 15065 }, 15066 "managementPlane": { 15067 "allOf": [ 15068 { 15069 "$ref": "#/definitions/configuration_module_base_type" 15070 }, 15071 { 15072 "type": "object", 15073 "properties": { 15074 "data": { 15075 "$ref": "#/definitions/management_plane_data" 15076 } 15077 }, 15078 "required": [ 15079 "data" 15080 ] 15081 } 15082 ] 15083 }, 15084 "management_plane_data": { 15085 "type": "object", 15086 "properties": { 15087 "heartBeatSeconds": { 15088 "type": "integer" 15089 }, 15090 "managementPlaneProxy": { 15091 "type": "object", 15092 "properties": { 15093 "primary": { 15094 "type": "string" 15095 }, 15096 "secondary": { 15097 "type": "string" 15098 } 15099 }, 15100 "required": [ 15101 "primary", 15102 "secondary" 15103 ] 15104 }, 15105 "statsUploadSeconds": { 15106 "type": "integer" 15107 }, 15108 "timeSliceSeconds": { 15109 "type": "integer" 15110 } 15111 }, 15112 "required": [ 15113 "heartBeatSeconds", 15114 "managementPlaneProxy", 15115 "statsUploadSeconds", 15116 "timeSliceSeconds" 15117 ] 15118 }, 15119 "firewall": { 15120 "allOf": [ 15121 { 15122 "$ref": "#/definitions/configuration_module_base_type" 15123 }, 15124 { 15125 "type": "object", 15126 "properties": { 15127 "data": { 15128 "$ref": "#/definitions/firewall_data" 15129 } 15130 }, 15131 "required": [ 15132 "data" 15133 ] 15134 } 15135 ] 15136 }, 15137 "firewall_data": { 15138 "type": "object", 15139 "properties": { 15140 "firewall_enabled": { 15141 "type": "boolean" 15142 }, 15143 "stateful_firewall_enabled": { 15144 "type": "boolean" 15145 }, 15146 "firewall_logging_enabled": { 15147 "type": "boolean" 15148 }, 15149 "inbound": { 15150 "type": "array", 15151 "items": { 15152 "$ref": "#/definitions/firewall_inbound_rule" 15153 } 15154 }, 15155 "segments": { 15156 "type": "array", 15157 "items": { 15158 "$ref": "#/definitions/firewall_segment" 15159 } 15160 }, 15161 "services": { 15162 "type": "object", 15163 "properties": { 15164 "loggingEnabled": { 15165 "type": "boolean" 15166 }, 15167 "ssh": { 15168 "type": "object", 15169 "properties": { 15170 "enabled": { 15171 "type": "boolean" 15172 }, 15173 "allowSelectedIp": { 15174 "type": "array", 15175 "items": { 15176 "type": "string" 15177 } 15178 }, 15179 "ruleLogicalId": { 15180 "type": "string" 15181 } 15182 }, 15183 "required": [ 15184 "enabled" 15185 ] 15186 }, 15187 "localUi": { 15188 "type": "object", 15189 "properties": { 15190 "enabled": { 15191 "type": "boolean" 15192 }, 15193 "allowSelectedIp": { 15194 "type": "array", 15195 "items": { 15196 "type": "string" 15197 }, 15198 "description": "List of IP addresses allowed UI access" 15199 }, 15200 "portNumber": { 15201 "type": "integer" 15202 }, 15203 "ruleLogicalId": { 15204 "type": "string" 15205 } 15206 }, 15207 "required": [ 15208 "enabled", 15209 "portNumber" 15210 ] 15211 }, 15212 "snmp": { 15213 "type": "object", 15214 "properties": { 15215 "enabled": { 15216 "type": "boolean" 15217 }, 15218 "allowSelectedIp": { 15219 "type": "array", 15220 "items": { 15221 "type": "string" 15222 }, 15223 "description": "List of IP addresses allowed SNMP access" 15224 }, 15225 "ruleLogicalId": { 15226 "type": "string" 15227 } 15228 }, 15229 "required": [ 15230 "enabled" 15231 ] 15232 }, 15233 "icmp": { 15234 "type": "object", 15235 "properties": { 15236 "enabled": { 15237 "type": "boolean" 15238 }, 15239 "allowSelectedIp": { 15240 "type": "array", 15241 "items": { 15242 "type": "string" 15243 }, 15244 "description": "List of IP addresses allowed ICMP access" 15245 }, 15246 "ruleLogicalId": { 15247 "type": "string" 15248 } 15249 }, 15250 "required": [ 15251 "enabled" 15252 ] 15253 } 15254 }, 15255 "required": [ 15256 "loggingEnabled" 15257 ] 15258 } 15259 }, 15260 "required": [ 15261 "firewall_enabled", 15262 "inbound", 15263 "segments" 15264 ] 15265 }, 15266 "firewall_segment": { 15267 "type": "object", 15268 "properties": { 15269 "firewall_logging_enabled": { 15270 "type": "boolean" 15271 }, 15272 "stateful_firewall_enabled": { 15273 "type": "boolean" 15274 }, 15275 "outbound": { 15276 "type": "array", 15277 "items": { 15278 "$ref": "#/definitions/firewall_outbound_rule" 15279 } 15280 }, 15281 "segment": { 15282 "$ref": "#/definitions/configuration_module_segment_metadata" 15283 } 15284 }, 15285 "required": [ 15286 "firewall_logging_enabled", 15287 "outbound", 15288 "segment" 15289 ] 15290 }, 15291 "firewall_inbound_rule": { 15292 "type": "object", 15293 "properties": { 15294 "name": { 15295 "type": "string" 15296 }, 15297 "match": { 15298 "$ref": "#/definitions/firewall_rule_match" 15299 }, 15300 "action": { 15301 "type": "object", 15302 "properties": { 15303 "type": { 15304 "type": "string", 15305 "enum": [ 15306 "port_forwarding", 15307 "one_to_one_nat" 15308 ] 15309 }, 15310 "nat": { 15311 "type": "object", 15312 "properties": { 15313 "lan_ip": { 15314 "type": "string" 15315 }, 15316 "lan_port": { 15317 "type": "integer" 15318 }, 15319 "outbound": { 15320 "type": "boolean" 15321 } 15322 }, 15323 "required": [ 15324 "lan_ip" 15325 ] 15326 }, 15327 "interface": { 15328 "type": "string", 15329 "description": "The name of the interface from which traffic should be forwarded" 15330 }, 15331 "subinterfaceId": { 15332 "type": "integer" 15333 } 15334 }, 15335 "required": [ 15336 "type", 15337 "nat", 15338 "interface" 15339 ] 15340 }, 15341 "ruleLogicalId": { 15342 "type": "string" 15343 } 15344 }, 15345 "required": [ 15346 "match", 15347 "action" 15348 ] 15349 }, 15350 "firewall_outbound_rule": { 15351 "type": "object", 15352 "properties": { 15353 "name": { 15354 "type": "string" 15355 }, 15356 "match": { 15357 "$ref": "#/definitions/firewall_rule_match" 15358 }, 15359 "action": { 15360 "type": "object", 15361 "properties": { 15362 "allow_or_deny": { 15363 "type": "string", 15364 "enum": [ 15365 "allow", 15366 "deny", 15367 "drop", 15368 "reject", 15369 "skip" 15370 ] 15371 } 15372 } 15373 }, 15374 "ruleLogicalId": { 15375 "type": "string" 15376 } 15377 }, 15378 "required": [ 15379 "match", 15380 "action" 15381 ] 15382 }, 15383 "netflow_filter": { 15384 "allOf": [ 15385 { 15386 "$ref": "#/definitions/enterprise_object_base" 15387 }, 15388 { 15389 "type": "object", 15390 "properties": { 15391 "data": { 15392 "$ref": "#/definitions/netflow_filter_data" 15393 } 15394 } 15395 } 15396 ] 15397 }, 15398 "netflow_filter_data": { 15399 "type": "object", 15400 "properties": { 15401 "name": { 15402 "type": "string" 15403 }, 15404 "match": { 15405 "$ref": "#/definitions/netflow_filter_rule" 15406 }, 15407 "action": { 15408 "type": "object", 15409 "properties": { 15410 "allow_or_deny": { 15411 "type": "string", 15412 "enum": [ 15413 "allow", 15414 "deny" 15415 ] 15416 } 15417 }, 15418 "required": [ 15419 "allow_or_deny" 15420 ] 15421 } 15422 }, 15423 "required": [ 15424 "match", 15425 "action", 15426 "name" 15427 ] 15428 }, 15429 "netflow_filter_rule": { 15430 "type": "object", 15431 "properties": { 15432 "appid": { 15433 "type": "integer", 15434 "description": "Integer ID corresponding to an application in the network-level application map" 15435 }, 15436 "classid": { 15437 "type": "integer", 15438 "description": "Integer ID corresponding to an application class in the network-level application map" 15439 }, 15440 "dscp": { 15441 "type": "integer", 15442 "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]" 15443 }, 15444 "sip": { 15445 "type": "string", 15446 "description": "Source IP address" 15447 }, 15448 "sport_high": { 15449 "type": "integer", 15450 "description": "Upper bound of a source port range" 15451 }, 15452 "sport_low": { 15453 "type": "integer", 15454 "description": "Lower bound of a source port range" 15455 }, 15456 "sAddressGroup": { 15457 "type": "string", 15458 "description": "Source address group reference" 15459 }, 15460 "sPortGroup": { 15461 "type": "string", 15462 "description": "Source port group reference" 15463 }, 15464 "ssm": { 15465 "type": "string", 15466 "description": "Source subnet mask, e.g. 255.255.255.0" 15467 }, 15468 "smac": { 15469 "type": "string", 15470 "description": "Source MAC address" 15471 }, 15472 "svlan": { 15473 "type": "integer", 15474 "description": "Integer ID for the source VLAN" 15475 }, 15476 "os_version": { 15477 "type": "integer", 15478 "description": "Index corresponding to the OS in the array: [OTHER,WINDOWS,LINUX,MACOS,IOS,ANDROID,EDGE]" 15479 }, 15480 "hostname": { 15481 "type": "string" 15482 }, 15483 "dip": { 15484 "type": "string", 15485 "description": "Destination IP address" 15486 }, 15487 "dport_low": { 15488 "type": "integer", 15489 "description": "Lower bound of a destination port range" 15490 }, 15491 "dport_high": { 15492 "type": "integer", 15493 "description": "Upper bound of a destination port range" 15494 }, 15495 "dAddressGroup": { 15496 "type": "string", 15497 "description": "Destination address group reference" 15498 }, 15499 "dPortGroup": { 15500 "type": "string", 15501 "description": "Destination port group reference" 15502 }, 15503 "dsm": { 15504 "type": "string", 15505 "description": "Destination subnet mask e.g. 255.255.255.0" 15506 }, 15507 "dmac": { 15508 "type": "string", 15509 "description": "Destination MAC address" 15510 }, 15511 "dvlan": { 15512 "type": "integer", 15513 "description": "Integer ID for the destination VLAN" 15514 }, 15515 "proto": { 15516 "type": "integer", 15517 "description": "Integer ID corresponding to a protocol" 15518 }, 15519 "s_rule_type": { 15520 "type": "string", 15521 "enum": [ 15522 "exact", 15523 "prefix", 15524 "wildcard", 15525 "netmask" 15526 ], 15527 "description": "Source rule type" 15528 }, 15529 "d_rule_type": { 15530 "type": "string", 15531 "enum": [ 15532 "exact", 15533 "prefix", 15534 "wildcard", 15535 "netmask" 15536 ], 15537 "description": "Destination rule type" 15538 } 15539 } 15540 }, 15541 "firewall_rule_match": { 15542 "type": "object", 15543 "properties": { 15544 "appid": { 15545 "type": "integer", 15546 "description": "Integer ID corresponding to an application in the network-level application map" 15547 }, 15548 "classid": { 15549 "type": "integer", 15550 "description": "Integer ID corresponding to an application class in the network-level application map" 15551 }, 15552 "dscp": { 15553 "type": "integer", 15554 "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]" 15555 }, 15556 "sip": { 15557 "type": "string", 15558 "description": "Source IP address" 15559 }, 15560 "sport_high": { 15561 "type": "integer", 15562 "description": "Upper bound of a source port range" 15563 }, 15564 "sport_low": { 15565 "type": "integer", 15566 "description": "Lower bound of a source port range" 15567 }, 15568 "ssm": { 15569 "type": "string", 15570 "description": "Source subnet mask, e.g. 255.255.255.0" 15571 }, 15572 "smac": { 15573 "type": "string", 15574 "description": "Source MAC address" 15575 }, 15576 "svlan": { 15577 "type": "integer", 15578 "description": "Integer ID for the source VLAN" 15579 }, 15580 "os_version": { 15581 "type": "integer", 15582 "description": "Index corresponding to the OS in the array: [OTHER,WINDOWS,LINUX,MACOS,IOS,ANDROID,EDGE]" 15583 }, 15584 "hostname": { 15585 "type": "string" 15586 }, 15587 "dip": { 15588 "type": "string", 15589 "description": "Destination IP address" 15590 }, 15591 "dport_low": { 15592 "type": "integer", 15593 "description": "Lower bound of a destination port range" 15594 }, 15595 "dport_high": { 15596 "type": "integer", 15597 "description": "Upper bound of a destination port range" 15598 }, 15599 "dsm": { 15600 "type": "string", 15601 "description": "Destination subnet mask e.g. 255.255.255.0" 15602 }, 15603 "dmac": { 15604 "type": "string", 15605 "description": "Destination MAC address" 15606 }, 15607 "dvlan": { 15608 "type": "integer", 15609 "description": "Integer ID for the destination VLAN" 15610 }, 15611 "proto": { 15612 "type": "integer", 15613 "description": "Integer ID corresponding to a protocol" 15614 }, 15615 "s_rule_type": { 15616 "type": "string", 15617 "enum": [ 15618 "exact", 15619 "prefix", 15620 "wildcard", 15621 "netmask" 15622 ], 15623 "description": "Source rule type" 15624 }, 15625 "d_rule_type": { 15626 "type": "string", 15627 "enum": [ 15628 "exact", 15629 "prefix", 15630 "wildcard", 15631 "netmask" 15632 ], 15633 "description": "Destination rule type" 15634 } 15635 } 15636 }, 15637 "QOS": { 15638 "allOf": [ 15639 { 15640 "$ref": "#/definitions/configuration_module_base_type" 15641 }, 15642 { 15643 "type": "object", 15644 "properties": { 15645 "data": { 15646 "$ref": "#/definitions/QOSData" 15647 }, 15648 "refs": { 15649 "$ref": "#/definitions/QOSRefs" 15650 } 15651 }, 15652 "required": [ 15653 "data" 15654 ] 15655 } 15656 ] 15657 }, 15658 "QOSData": { 15659 "type": "object", 15660 "properties": { 15661 "serviceRateLimit": { 15662 "type": "object", 15663 "properties": { 15664 "enabled": { 15665 "type": "boolean" 15666 }, 15667 "inputType": { 15668 "type": "string" 15669 }, 15670 "value": { 15671 "type": "integer" 15672 } 15673 }, 15674 "required": [ 15675 "enabled" 15676 ] 15677 }, 15678 "segments": { 15679 "type": "array", 15680 "items": { 15681 "$ref": "#/definitions/QOSSegments" 15682 } 15683 } 15684 }, 15685 "required": [ 15686 "segments" 15687 ] 15688 }, 15689 "QOSSegments": { 15690 "type": "object", 15691 "properties": { 15692 "rules": { 15693 "type": "array", 15694 "items": { 15695 "$ref": "#/definitions/QOS_business_rules" 15696 } 15697 }, 15698 "defaults": { 15699 "type": "array", 15700 "items": { 15701 "$ref": "#/definitions/QOS_business_rules" 15702 } 15703 }, 15704 "webProxy": { 15705 "type": "object", 15706 "properties": { 15707 "providers": { 15708 "type": "array", 15709 "items": { 15710 "type": "object" 15711 } 15712 } 15713 } 15714 }, 15715 "cosMapping": { 15716 "type": "object", 15717 "properties": { 15718 "lsInputType": { 15719 "type": "string" 15720 }, 15721 "bulk": { 15722 "$ref": "#/definitions/cos_mapping" 15723 }, 15724 "realtime": { 15725 "$ref": "#/definitions/cos_mapping" 15726 }, 15727 "transactional": { 15728 "$ref": "#/definitions/cos_mapping" 15729 } 15730 } 15731 }, 15732 "segment": { 15733 "$ref": "#/definitions/configuration_module_segment_metadata" 15734 } 15735 }, 15736 "required": [ 15737 "rules", 15738 "webProxy", 15739 "segment" 15740 ] 15741 }, 15742 "QOS_business_rules": { 15743 "type": "object", 15744 "properties": { 15745 "name": { 15746 "type": "string" 15747 }, 15748 "match": { 15749 "type": "object", 15750 "properties": { 15751 "appid": { 15752 "type": "integer" 15753 }, 15754 "classid": { 15755 "type": "integer" 15756 }, 15757 "dscp": { 15758 "type": "integer", 15759 "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]" 15760 }, 15761 "sip": { 15762 "type": "string" 15763 }, 15764 "sport_high": { 15765 "type": "integer" 15766 }, 15767 "sport_low": { 15768 "type": "integer" 15769 }, 15770 "ssm": { 15771 "type": "string" 15772 }, 15773 "svlan": { 15774 "type": "integer" 15775 }, 15776 "os_version": { 15777 "type": "integer", 15778 "description": "Index corresponding to the OS in the array: [OTHER,WINDOWS,LINUX,MACOS,IOS,ANDROID,EDGE]" 15779 }, 15780 "hostname": { 15781 "type": "string" 15782 }, 15783 "dip": { 15784 "type": "string" 15785 }, 15786 "dport_low": { 15787 "type": "integer" 15788 }, 15789 "dport_high": { 15790 "type": "integer" 15791 }, 15792 "dsm": { 15793 "type": "string" 15794 }, 15795 "dvlan": { 15796 "type": "integer" 15797 }, 15798 "proto": { 15799 "type": "integer" 15800 }, 15801 "s_rule_type": { 15802 "type": "string", 15803 "enum": [ 15804 "exact", 15805 "prefix", 15806 "wildcard", 15807 "netmask" 15808 ] 15809 }, 15810 "d_rule_type": { 15811 "type": "string", 15812 "enum": [ 15813 "exact", 15814 "prefix", 15815 "wildcard", 15816 "netmask" 15817 ] 15818 } 15819 } 15820 }, 15821 "action": { 15822 "type": "object", 15823 "properties": { 15824 "routeType": { 15825 "type": "string" 15826 }, 15827 "edge2EdgeRouteAction": { 15828 "$ref": "#/definitions/route_action_object" 15829 }, 15830 "edge2DataCenterRouteAction": { 15831 "$ref": "#/definitions/route_action_object" 15832 }, 15833 "edge2CloudRouteAction": { 15834 "$ref": "#/definitions/route_action_object" 15835 }, 15836 "QoS": { 15837 "type": "object" 15838 }, 15839 "sla": { 15840 "type": "object" 15841 } 15842 } 15843 }, 15844 "ruleLogicalId": { 15845 "type": "string", 15846 "description": "Globally unique identifier for the policy rule" 15847 } 15848 } 15849 }, 15850 "route_action_object": { 15851 "type": "object", 15852 "properties": { 15853 "interface": { 15854 "type": "string" 15855 }, 15856 "linkInternalLogicalId": { 15857 "type": "string" 15858 }, 15859 "linkPolicy": { 15860 "type": "string" 15861 }, 15862 "routeCfg": { 15863 "type": "object" 15864 }, 15865 "routePolicy": { 15866 "type": "string" 15867 }, 15868 "serviceGroup": { 15869 "type": "string" 15870 }, 15871 "vlanId": { 15872 "type": "integer" 15873 }, 15874 "wanlink": { 15875 "type": "string" 15876 }, 15877 "linkCosLogicalId": { 15878 "type": "string" 15879 }, 15880 "linkOuterDscpTag": { 15881 "type": "string" 15882 }, 15883 "linkInnerDscpTag": { 15884 "type": "string" 15885 } 15886 } 15887 }, 15888 "cos_mapping": { 15889 "type": "object", 15890 "properties": { 15891 "high": { 15892 "$ref": "#/definitions/cos_mapping_value" 15893 }, 15894 "normal": { 15895 "$ref": "#/definitions/cos_mapping_value" 15896 }, 15897 "low": { 15898 "$ref": "#/definitions/cos_mapping_value" 15899 } 15900 } 15901 }, 15902 "cos_mapping_value": { 15903 "type": "object", 15904 "properties": { 15905 "value": { 15906 "type": "integer" 15907 }, 15908 "ratelimit": { 15909 "type": "boolean" 15910 } 15911 } 15912 }, 15913 "QOSRefs": { 15914 "type": "object", 15915 "properties": { 15916 "deviceSettings:backHaulEdge": { 15917 "type": "object" 15918 }, 15919 "deviceSettings:dataCenter": { 15920 "type": "object" 15921 } 15922 } 15923 }, 15924 "edgeDeviceSettings": { 15925 "allOf": [ 15926 { 15927 "$ref": "#/definitions/configuration_module_base_type" 15928 }, 15929 { 15930 "type": "object", 15931 "properties": { 15932 "data": { 15933 "$ref": "#/definitions/edgeDeviceSettingsData" 15934 }, 15935 "refs": { 15936 "$ref": "#/definitions/deviceSettingsRefs" 15937 } 15938 }, 15939 "required": [ 15940 "data" 15941 ] 15942 } 15943 ] 15944 }, 15945 "edgeDeviceSettingsData": { 15946 "type": "object", 15947 "properties": { 15948 "bgp": { 15949 "type": "object", 15950 "properties": { 15951 "ASN": { 15952 "type": "string" 15953 }, 15954 "connectedRoutes": { 15955 "type": "boolean" 15956 }, 15957 "disableASPathCarryOver": { 15958 "type": "boolean" 15959 }, 15960 "enabled": { 15961 "type": "boolean" 15962 }, 15963 "filters": { 15964 "type": "array", 15965 "items": { 15966 "type": "object", 15967 "properties": { 15968 "id": { 15969 "type": "string" 15970 }, 15971 "name": { 15972 "type": "string" 15973 }, 15974 "rules": { 15975 "type": "array", 15976 "items": { 15977 "$ref": "#/definitions/bgp_filter_rule" 15978 } 15979 } 15980 } 15981 } 15982 }, 15983 "holdtime": { 15984 "type": "string" 15985 }, 15986 "keepalive": { 15987 "type": "string" 15988 }, 15989 "neighbors": { 15990 "type": "array", 15991 "items": { 15992 "$ref": "#/definitions/config_edge_bgp_neighbor" 15993 } 15994 }, 15995 "networks": { 15996 "type": "array", 15997 "items": { 15998 "type": "object", 15999 "properties": { 16000 "cidrIp": { 16001 "type": "string" 16002 }, 16003 "cidrPrefix": { 16004 "type": "integer" 16005 } 16006 } 16007 } 16008 }, 16009 "overlayPrefix": { 16010 "type": "boolean" 16011 }, 16012 "propagateUplink": { 16013 "type": "boolean" 16014 }, 16015 "routerId": { 16016 "type": "string" 16017 }, 16018 "uplinkCommunity": { 16019 "type": "integer" 16020 } 16021 } 16022 }, 16023 "lan": { 16024 "type": "object", 16025 "properties": { 16026 "networks": { 16027 "type": "array", 16028 "items": { 16029 "type": "object", 16030 "properties": { 16031 "space": { 16032 "type": "string" 16033 }, 16034 "guest": { 16035 "type": "boolean" 16036 }, 16037 "secure": { 16038 "type": "boolean" 16039 }, 16040 "advertise": { 16041 "type": "boolean" 16042 }, 16043 "pingResponse": { 16044 "type": "boolean", 16045 "default": true 16046 }, 16047 "cost": { 16048 "type": "integer" 16049 }, 16050 "dhcp": { 16051 "type": "object", 16052 "properties": { 16053 "enabled": { 16054 "type": "boolean" 16055 }, 16056 "leaseTimeSeconds": { 16057 "type": "integer" 16058 }, 16059 "override": { 16060 "type": "boolean" 16061 }, 16062 "dhcpRelay": { 16063 "type": "object", 16064 "properties": { 16065 "servers": { 16066 "type": "array", 16067 "items": { 16068 "type": "string" 16069 } 16070 } 16071 } 16072 } 16073 } 16074 }, 16075 "staticReserved": { 16076 "type": "integer" 16077 }, 16078 "netmask": { 16079 "type": "string" 16080 }, 16081 "cidrPrefix": { 16082 "type": "integer" 16083 }, 16084 "cidrIp": { 16085 "type": "string" 16086 }, 16087 "baseDhcpAddr": { 16088 "type": "integer", 16089 "description": "An offset from the cidrIp including staticReserved (if any)" 16090 }, 16091 "numDhcpAddr": { 16092 "type": "integer" 16093 }, 16094 "name": { 16095 "type": "string" 16096 }, 16097 "interfaces": { 16098 "type": "array", 16099 "items": { 16100 "type": "string" 16101 } 16102 }, 16103 "vlanId": { 16104 "type": "integer" 16105 }, 16106 "managementIp": { 16107 "type": "string" 16108 }, 16109 "disabled": { 16110 "type": "boolean" 16111 } 16112 } 16113 } 16114 } 16115 } 16116 }, 16117 "routedInterfaces": { 16118 "type": "array", 16119 "items": { 16120 "type": "object", 16121 "properties": { 16122 "addressing": { 16123 "type": "object", 16124 "properties": { 16125 "type": { 16126 "type": "string", 16127 "enum": [ 16128 "DHCP", 16129 "STATIC", 16130 "PPPOE" 16131 ] 16132 }, 16133 "cidrPrefix": { 16134 "type": "integer" 16135 }, 16136 "cidrIp": { 16137 "type": "string" 16138 }, 16139 "netmask": { 16140 "type": "string" 16141 }, 16142 "gateway": { 16143 "type": "string" 16144 }, 16145 "username": { 16146 "type": "string" 16147 }, 16148 "password": { 16149 "type": "string" 16150 } 16151 } 16152 }, 16153 "advertise": { 16154 "type": "boolean" 16155 }, 16156 "pingResponse": { 16157 "type": "boolean", 16158 "default": true 16159 }, 16160 "disabled": { 16161 "type": "boolean" 16162 }, 16163 "dhcpServer": { 16164 "$ref": "#/definitions/edgeDeviceSettingsDataDhcpServer" 16165 }, 16166 "encryptOverlay": { 16167 "type": "boolean" 16168 }, 16169 "l2": { 16170 "type": "object", 16171 "properties": { 16172 "autonegotiation": { 16173 "type": "boolean" 16174 }, 16175 "speed": { 16176 "type": "string" 16177 }, 16178 "duplex": { 16179 "type": "string" 16180 }, 16181 "MTU": { 16182 "type": "integer" 16183 } 16184 } 16185 }, 16186 "name": { 16187 "type": "string" 16188 }, 16189 "natDirect": { 16190 "type": "boolean" 16191 }, 16192 "ospf": { 16193 "type": "object", 16194 "properties": { 16195 "area": { 16196 "type": "integer" 16197 }, 16198 "authentication": { 16199 "type": "boolean" 16200 }, 16201 "authId": { 16202 "type": "integer" 16203 }, 16204 "authPassphrase": { 16205 "type": "string" 16206 }, 16207 "cost": { 16208 "type": "integer" 16209 }, 16210 "deadTimer": { 16211 "type": "integer" 16212 }, 16213 "mode": { 16214 "type": "string" 16215 }, 16216 "enabled": { 16217 "type": "boolean" 16218 }, 16219 "helloTimer": { 16220 "type": "integer" 16221 }, 16222 "inboundRouteLearning": { 16223 "type": "object", 16224 "properties": { 16225 "defaultAction": { 16226 "type": "string" 16227 }, 16228 "filters": { 16229 "type": "array", 16230 "items": { 16231 "type": "object" 16232 } 16233 } 16234 } 16235 }, 16236 "md5Authentication": { 16237 "type": "boolean" 16238 }, 16239 "MTU": { 16240 "type": "integer" 16241 }, 16242 "outboundRouteAdvertisement": { 16243 "type": "object", 16244 "properties": { 16245 "defaultAction": { 16246 "type": "string" 16247 }, 16248 "filters": { 16249 "type": "array", 16250 "items": { 16251 "type": "object" 16252 } 16253 } 16254 } 16255 }, 16256 "passive": { 16257 "type": "boolean" 16258 }, 16259 "vlanId": { 16260 "type": "integer" 16261 } 16262 } 16263 }, 16264 "override": { 16265 "type": "boolean" 16266 }, 16267 "subinterfaces": { 16268 "type": "array", 16269 "items": { 16270 "type": "object", 16271 "properties": { 16272 "addressing": { 16273 "type": "object", 16274 "properties": { 16275 "cidrIp": { 16276 "type": "string" 16277 }, 16278 "cidrPrefix": { 16279 "type": "integer" 16280 }, 16281 "gateway": { 16282 "type": "string" 16283 }, 16284 "netmask": { 16285 "type": "string" 16286 }, 16287 "type": { 16288 "type": "string", 16289 "enum": [ 16290 "DHCP", 16291 "STATIC", 16292 "PPPOE" 16293 ] 16294 }, 16295 "username": { 16296 "type": "string" 16297 }, 16298 "password": { 16299 "type": "string" 16300 } 16301 } 16302 }, 16303 "advertise": { 16304 "type": "boolean" 16305 }, 16306 "pingResponse": { 16307 "type": "boolean", 16308 "default": true 16309 }, 16310 "dhcpServer": { 16311 "$ref": "#/definitions/edgeDeviceSettingsDataDhcpServer" 16312 }, 16313 "disabled": { 16314 "type": "boolean" 16315 }, 16316 "natDirect": { 16317 "type": "boolean" 16318 }, 16319 "ospf": { 16320 "type": "object", 16321 "properties": { 16322 "area": { 16323 "type": "integer" 16324 }, 16325 "authentication": { 16326 "type": "boolean" 16327 }, 16328 "authId": { 16329 "type": "integer" 16330 }, 16331 "authPassphrase": { 16332 "type": "string" 16333 }, 16334 "cost": { 16335 "type": "integer" 16336 }, 16337 "deadTimer": { 16338 "type": "integer" 16339 }, 16340 "mode": { 16341 "type": "string" 16342 }, 16343 "enabled": { 16344 "type": "boolean" 16345 }, 16346 "helloTimer": { 16347 "type": "integer" 16348 }, 16349 "inboundRouteLearning": { 16350 "type": "object", 16351 "properties": { 16352 "defaultAction": { 16353 "type": "string" 16354 }, 16355 "filters": { 16356 "type": "array", 16357 "items": { 16358 "type": "object" 16359 } 16360 } 16361 } 16362 }, 16363 "md5Authentication": { 16364 "type": "boolean" 16365 }, 16366 "MTU": { 16367 "type": "integer" 16368 }, 16369 "outboundRouteAdvertisement": { 16370 "type": "object", 16371 "properties": { 16372 "defaultAction": { 16373 "type": "string" 16374 }, 16375 "filters": { 16376 "type": "array", 16377 "items": { 16378 "type": "object" 16379 } 16380 } 16381 } 16382 }, 16383 "passive": { 16384 "type": "boolean" 16385 } 16386 } 16387 }, 16388 "override": { 16389 "type": "boolean" 16390 }, 16391 "subinterfaceId": { 16392 "type": "integer" 16393 }, 16394 "subinterfaceType": { 16395 "type": "string" 16396 }, 16397 "vlanId": { 16398 "type": "integer", 16399 "description": "static only" 16400 }, 16401 "trusted": { 16402 "type": "boolean" 16403 }, 16404 "rpf": { 16405 "type": "string", 16406 "enum": [ 16407 "SPECIFIC", 16408 "LOOSE", 16409 "DISABLED" 16410 ] 16411 } 16412 } 16413 } 16414 }, 16415 "vlanId": { 16416 "type": "integer", 16417 "description": "static only" 16418 }, 16419 "wanOverlay": { 16420 "type": "string", 16421 "enum": [ 16422 "DISABLED", 16423 "AUTO_DISCOVERED", 16424 "USER_DEFINED" 16425 ] 16426 }, 16427 "trusted": { 16428 "type": "boolean" 16429 }, 16430 "rpf": { 16431 "type": "string", 16432 "enum": [ 16433 "SPECIFIC", 16434 "LOOSE", 16435 "DISABLED" 16436 ] 16437 }, 16438 "underlayAccounting": { 16439 "type": "boolean", 16440 "default": true 16441 } 16442 } 16443 } 16444 }, 16445 "routes": { 16446 "type": "object", 16447 "properties": { 16448 "icmpProbes": { 16449 "type": "array", 16450 "items": { 16451 "type": "object" 16452 } 16453 }, 16454 "icmpResponders": { 16455 "type": "array", 16456 "items": { 16457 "type": "object" 16458 } 16459 }, 16460 "static": { 16461 "type": "array", 16462 "items": { 16463 "type": "object", 16464 "properties": { 16465 "destination": { 16466 "type": "string" 16467 }, 16468 "netmask": { 16469 "type": "string" 16470 }, 16471 "sourceIp": { 16472 "type": "string" 16473 }, 16474 "gateway": { 16475 "type": "string" 16476 }, 16477 "cost": { 16478 "type": "integer" 16479 }, 16480 "preferred": { 16481 "type": "boolean" 16482 }, 16483 "description": { 16484 "type": "string" 16485 }, 16486 "cidrPrefix": { 16487 "type": "string" 16488 }, 16489 "wanInterface": { 16490 "type": "string" 16491 }, 16492 "icmpProbeLogicalId": { 16493 "type": "string" 16494 }, 16495 "vlanId": { 16496 "type": "integer" 16497 }, 16498 "advertise": { 16499 "type": "boolean" 16500 }, 16501 "subinterfaceId": { 16502 "type": "integer" 16503 } 16504 } 16505 } 16506 } 16507 } 16508 }, 16509 "ha": { 16510 "type": "object", 16511 "properties": { 16512 "enabled": { 16513 "type": "boolean" 16514 }, 16515 "interface": { 16516 "type": "string" 16517 } 16518 } 16519 }, 16520 "dns": { 16521 "type": "object", 16522 "properties": { 16523 "primaryProvider": { 16524 "type": "object", 16525 "properties": { 16526 "ref": { 16527 "type": "string" 16528 } 16529 } 16530 }, 16531 "backupProvider": { 16532 "type": "object", 16533 "properties": { 16534 "ref": { 16535 "type": "string" 16536 } 16537 } 16538 }, 16539 "privateProviders": { 16540 "type": "object", 16541 "properties": { 16542 "ref": { 16543 "type": "string" 16544 } 16545 } 16546 } 16547 } 16548 }, 16549 "netflow": { 16550 "type": "object", 16551 "properties": { 16552 "enable": { 16553 "type": "boolean" 16554 }, 16555 "enabled": { 16556 "type": "boolean" 16557 }, 16558 "version": { 16559 "type": "integer" 16560 }, 16561 "collectors": { 16562 "type": "array", 16563 "items": { 16564 "type": "object", 16565 "properties": { 16566 "address": { 16567 "type": "string" 16568 }, 16569 "port": { 16570 "type": "integer" 16571 } 16572 } 16573 } 16574 } 16575 } 16576 }, 16577 "vqm": { 16578 "type": "object", 16579 "properties": { 16580 "enable": { 16581 "type": "boolean" 16582 }, 16583 "enabled": { 16584 "type": "boolean" 16585 }, 16586 "protocol": { 16587 "type": "string" 16588 }, 16589 "collectors": { 16590 "type": "array", 16591 "items": { 16592 "type": "object", 16593 "properties": { 16594 "address": { 16595 "type": "string" 16596 }, 16597 "port": { 16598 "type": "integer" 16599 } 16600 } 16601 } 16602 } 16603 } 16604 }, 16605 "vrrp": { 16606 "type": "object", 16607 "properties": { 16608 "enabled": { 16609 "type": "boolean" 16610 }, 16611 "data": { 16612 "type": "array", 16613 "items": { 16614 "type": "object", 16615 "properties": { 16616 "cidrIp": { 16617 "type": "string" 16618 }, 16619 "interface": { 16620 "type": "string" 16621 }, 16622 "interval": { 16623 "type": "integer" 16624 }, 16625 "preempt": { 16626 "type": "boolean" 16627 }, 16628 "preemptDelay": { 16629 "type": "integer" 16630 }, 16631 "priority": { 16632 "type": "integer" 16633 }, 16634 "subinterfaceId": { 16635 "type": "integer" 16636 }, 16637 "vlanId": { 16638 "type": "integer" 16639 }, 16640 "vrid": { 16641 "type": "integer" 16642 } 16643 } 16644 } 16645 } 16646 } 16647 }, 16648 "snmp": { 16649 "type": "object", 16650 "properties": { 16651 "port": { 16652 "type": "integer" 16653 }, 16654 "snmpv2c": { 16655 "type": "object", 16656 "properties": { 16657 "enable": { 16658 "type": "boolean" 16659 }, 16660 "enabled": { 16661 "type": "boolean" 16662 }, 16663 "community": { 16664 "type": "string" 16665 }, 16666 "allowedIp": { 16667 "type": "array", 16668 "items": { 16669 "type": "string" 16670 } 16671 } 16672 } 16673 }, 16674 "snmpv3": { 16675 "type": "object", 16676 "properties": { 16677 "enabled": { 16678 "type": "boolean" 16679 }, 16680 "enable": { 16681 "type": "boolean" 16682 }, 16683 "users": { 16684 "type": "array", 16685 "items": { 16686 "type": "object", 16687 "properties": { 16688 "name": { 16689 "type": "string" 16690 }, 16691 "passphrase": { 16692 "type": "string" 16693 }, 16694 "authAlg": { 16695 "type": "string" 16696 }, 16697 "privacy": { 16698 "type": "boolean" 16699 }, 16700 "encrAlg": { 16701 "type": "string" 16702 } 16703 } 16704 } 16705 } 16706 } 16707 } 16708 } 16709 }, 16710 "multiSourceQos": { 16711 "type": "object", 16712 "properties": { 16713 "enable": { 16714 "type": "boolean" 16715 }, 16716 "enabled": { 16717 "type": "boolean" 16718 }, 16719 "highRatio": { 16720 "type": "integer" 16721 }, 16722 "normalRatio": { 16723 "type": "integer" 16724 }, 16725 "lowRatio": { 16726 "type": "integer" 16727 }, 16728 "maxCapThreshold": { 16729 "type": "integer" 16730 }, 16731 "minCapThreshold": { 16732 "type": "integer" 16733 } 16734 } 16735 }, 16736 "tacacs": { 16737 "type": "object", 16738 "properties": { 16739 "ref": { 16740 "type": "string" 16741 }, 16742 "sourceInterface": { 16743 "type": "string" 16744 } 16745 } 16746 } 16747 } 16748 }, 16749 "edgeDeviceSettingsDataDhcpServer": { 16750 "type": "object", 16751 "properties": { 16752 "baseDhcpAddr": { 16753 "type": "integer" 16754 }, 16755 "enabled": { 16756 "type": "boolean" 16757 }, 16758 "leaseTimeSeconds": { 16759 "type": "integer" 16760 }, 16761 "dhcpRelay": { 16762 "type": "object", 16763 "properties": { 16764 "servers": { 16765 "type": "array", 16766 "items": { 16767 "type": "string" 16768 } 16769 } 16770 } 16771 }, 16772 "numDhcpAddr": { 16773 "type": "integer" 16774 }, 16775 "staticReserved": { 16776 "type": "integer" 16777 }, 16778 "options": { 16779 "type": "array", 16780 "items": { 16781 "type": "object", 16782 "properties": { 16783 "option": { 16784 "type": "integer" 16785 }, 16786 "value": { 16787 "type": "string" 16788 }, 16789 "type": { 16790 "type": "string" 16791 }, 16792 "metaData": { 16793 "type": "object", 16794 "properties": { 16795 "dataType": { 16796 "type": "string" 16797 }, 16798 "description": { 16799 "type": "string" 16800 }, 16801 "display": { 16802 "type": "boolean" 16803 }, 16804 "list": { 16805 "type": "boolean" 16806 }, 16807 "name": { 16808 "type": "string" 16809 }, 16810 "option": { 16811 "type": "integer" 16812 } 16813 } 16814 } 16815 } 16816 } 16817 } 16818 } 16819 }, 16820 "deviceSettings": { 16821 "allOf": [ 16822 { 16823 "$ref": "#/definitions/configuration_module_base_type" 16824 }, 16825 { 16826 "type": "object", 16827 "properties": { 16828 "data": { 16829 "$ref": "#/definitions/deviceSettingsData" 16830 }, 16831 "refs": { 16832 "$ref": "#/definitions/deviceSettingsRefs" 16833 } 16834 }, 16835 "required": [ 16836 "data" 16837 ] 16838 } 16839 ] 16840 }, 16841 "segmentBasedDeviceSettings": { 16842 "allOf": [ 16843 { 16844 "$ref": "#/definitions/configuration_module_base_type" 16845 }, 16846 { 16847 "type": "object", 16848 "properties": { 16849 "data": { 16850 "$ref": "#/definitions/segmentBasedDeviceSettingsData" 16851 }, 16852 "refs": { 16853 "$ref": "#/definitions/deviceSettingsRefs" 16854 } 16855 }, 16856 "required": [ 16857 "data" 16858 ] 16859 } 16860 ] 16861 }, 16862 "deviceSettingsRefs": { 16863 "type": "object", 16864 "properties": { 16865 "deviceSettings:authentication": { 16866 "type": "object" 16867 }, 16868 "deviceSettings:css:provider": { 16869 "type": "object" 16870 }, 16871 "deviceSettings:css:site": { 16872 "type": "object" 16873 }, 16874 "deviceSettings:dns:backupProvider": { 16875 "type": "object" 16876 }, 16877 "deviceSettings:dns:primaryProvider": { 16878 "type": "object" 16879 }, 16880 "deviceSettings:dns:privateProviders": { 16881 "type": "object" 16882 }, 16883 "deviceSettings:handOffGateways:gateways": { 16884 "type": "object" 16885 }, 16886 "deviceSettings:lan:allocation": { 16887 "type": "object" 16888 }, 16889 "deviceSettings:securityVnf:license": { 16890 "type": "object" 16891 }, 16892 "deviceSettings:securityVnf:service": { 16893 "type": "object" 16894 }, 16895 "deviceSettings:segment": { 16896 "type": "object" 16897 }, 16898 "deviceSettings:segment:netflowCollectors": { 16899 "type": "object" 16900 }, 16901 "deviceSettings:segment:netflowFilters": { 16902 "type": "object" 16903 }, 16904 "deviceSettings:tacacs": { 16905 "type": "object" 16906 }, 16907 "deviceSettings:vnfs:edge": { 16908 "type": "object" 16909 }, 16910 "deviceSettings:vnfs:vnfImage": { 16911 "type": "object" 16912 }, 16913 "deviceSettings:vpn:dataCenter": { 16914 "type": "object" 16915 }, 16916 "deviceSettings:vpn:edgeHub": { 16917 "type": "object" 16918 }, 16919 "deviceSettings:vpn:edgeHubCluster": { 16920 "type": "object" 16921 }, 16922 "deviceSettings:webProxy:provider": { 16923 "type": "object" 16924 } 16925 } 16926 }, 16927 "ref": { 16928 "type": "object", 16929 "properties": { 16930 "id": { 16931 "type": "integer" 16932 }, 16933 "configurationId": { 16934 "type": "integer" 16935 }, 16936 "moduleId": { 16937 "type": "integer" 16938 }, 16939 "logicalId": { 16940 "type": "string" 16941 }, 16942 "enterpriseObjectId": { 16943 "type": "integer" 16944 }, 16945 "segmentLogicalId": { 16946 "type": "string" 16947 }, 16948 "segmentObjectId": { 16949 "type": "integer" 16950 }, 16951 "ref": { 16952 "type": "string" 16953 } 16954 }, 16955 "required": [ 16956 "configurationId", 16957 "moduleId", 16958 "logicalId", 16959 "enterpriseObjectId", 16960 "segmentLogicalId", 16961 "segmentObjectId" 16962 ] 16963 }, 16964 "deviceSettingsData": { 16965 "type": "object", 16966 "properties": { 16967 "lan": { 16968 "type": "object", 16969 "properties": { 16970 "allocation": { 16971 "type": "object", 16972 "properties": { 16973 "ref": { 16974 "type": "string" 16975 }, 16976 "assignableVlans": { 16977 "type": "array", 16978 "items": { 16979 "type": "integer" 16980 } 16981 }, 16982 "managementVlans": { 16983 "type": "array", 16984 "items": { 16985 "type": "integer" 16986 } 16987 } 16988 } 16989 } 16990 } 16991 }, 16992 "ospf": { 16993 "type": "object", 16994 "properties": { 16995 "enabled": { 16996 "type": "boolean" 16997 }, 16998 "areas": { 16999 "type": "array", 17000 "items": { 17001 "type": "object", 17002 "properties": { 17003 "id": { 17004 "type": "integer" 17005 }, 17006 "name": { 17007 "type": "string" 17008 }, 17009 "type": { 17010 "type": "string" 17011 } 17012 } 17013 } 17014 } 17015 } 17016 }, 17017 "bgp": { 17018 "type": "object", 17019 "properties": { 17020 "enabled": { 17021 "type": "boolean" 17022 }, 17023 "asn": { 17024 "type": "string" 17025 }, 17026 "neighbors": { 17027 "type": "array", 17028 "items": { 17029 "type": "object" 17030 } 17031 } 17032 } 17033 }, 17034 "dns": { 17035 "type": "object", 17036 "properties": { 17037 "primaryProvider": { 17038 "type": "object", 17039 "properties": { 17040 "ref": { 17041 "type": "string" 17042 } 17043 } 17044 }, 17045 "backupProvider": { 17046 "type": "object", 17047 "properties": { 17048 "ref": { 17049 "type": "string" 17050 } 17051 } 17052 }, 17053 "privateProviders": { 17054 "type": "object", 17055 "properties": { 17056 "ref": { 17057 "type": "string" 17058 } 17059 } 17060 } 17061 } 17062 }, 17063 "authentication": { 17064 "type": "object", 17065 "properties": { 17066 "ref": { 17067 "type": "string" 17068 } 17069 } 17070 }, 17071 "softwareUpdate": { 17072 "type": "object", 17073 "properties": { 17074 "windowed": { 17075 "type": "boolean" 17076 }, 17077 "window": { 17078 "type": "object", 17079 "properties": { 17080 "day": { 17081 "type": "integer" 17082 }, 17083 "beginHour": { 17084 "type": "integer" 17085 }, 17086 "endHour": { 17087 "type": "integer" 17088 } 17089 } 17090 } 17091 } 17092 }, 17093 "radioSettings": { 17094 "type": "object", 17095 "properties": { 17096 "country": { 17097 "type": "string" 17098 }, 17099 "radios": { 17100 "type": "array", 17101 "items": { 17102 "type": "object", 17103 "properties": { 17104 "radioId": { 17105 "type": "integer" 17106 }, 17107 "isEnabled": { 17108 "type": "boolean" 17109 }, 17110 "name": { 17111 "type": "string" 17112 }, 17113 "band": { 17114 "type": "string" 17115 }, 17116 "channel": { 17117 "type": "string" 17118 }, 17119 "width": { 17120 "type": "string" 17121 }, 17122 "mode": { 17123 "type": "string" 17124 } 17125 } 17126 } 17127 } 17128 } 17129 }, 17130 "netflow": { 17131 "type": "object", 17132 "properties": { 17133 "enabled": { 17134 "type": "boolean" 17135 }, 17136 "version": { 17137 "type": "integer" 17138 }, 17139 "collectors": { 17140 "type": "array", 17141 "items": { 17142 "type": "object", 17143 "properties": { 17144 "address": { 17145 "type": "string" 17146 }, 17147 "port": { 17148 "type": "integer" 17149 } 17150 } 17151 } 17152 } 17153 } 17154 }, 17155 "vqm": { 17156 "type": "object", 17157 "properties": { 17158 "enabled": { 17159 "type": "boolean" 17160 }, 17161 "protocol": { 17162 "type": "string" 17163 }, 17164 "collectors": { 17165 "type": "array", 17166 "items": { 17167 "type": "object", 17168 "properties": { 17169 "address": { 17170 "type": "string" 17171 }, 17172 "port": { 17173 "type": "integer" 17174 } 17175 } 17176 } 17177 } 17178 } 17179 }, 17180 "snmp": { 17181 "type": "object", 17182 "properties": { 17183 "port": { 17184 "type": "integer" 17185 }, 17186 "snmpv2c": { 17187 "type": "object", 17188 "properties": { 17189 "enabled": { 17190 "type": "boolean" 17191 }, 17192 "community": { 17193 "type": "string" 17194 }, 17195 "allowedIp": { 17196 "type": "array", 17197 "items": { 17198 "type": "string" 17199 } 17200 } 17201 } 17202 }, 17203 "snmpv3": { 17204 "type": "object", 17205 "properties": { 17206 "enabled": { 17207 "type": "boolean" 17208 }, 17209 "users": { 17210 "type": "array", 17211 "items": { 17212 "type": "object", 17213 "properties": { 17214 "name": { 17215 "type": "string" 17216 }, 17217 "passphrase": { 17218 "type": "string" 17219 }, 17220 "authAlg": { 17221 "type": "string" 17222 }, 17223 "privacy": { 17224 "type": "boolean" 17225 }, 17226 "encrAlg": { 17227 "type": "string" 17228 } 17229 } 17230 } 17231 } 17232 } 17233 } 17234 } 17235 }, 17236 "multiSourceQos": { 17237 "type": "object", 17238 "properties": { 17239 "enabled": { 17240 "type": "boolean" 17241 }, 17242 "highRatio": { 17243 "type": "integer" 17244 }, 17245 "normalRatio": { 17246 "type": "integer" 17247 }, 17248 "lowRatio": { 17249 "type": "integer" 17250 }, 17251 "maxCapThreshold": { 17252 "type": "integer" 17253 }, 17254 "minCapThreshold": { 17255 "type": "integer" 17256 } 17257 } 17258 }, 17259 "models": { 17260 "type": "object", 17261 "properties": { 17262 "virtual": { 17263 "type": "object", 17264 "properties": { 17265 "routedInterfaces": { 17266 "type": "array", 17267 "items": { 17268 "type": "object", 17269 "properties": { 17270 "name": { 17271 "type": "string" 17272 }, 17273 "disabled": { 17274 "type": "boolean" 17275 }, 17276 "addressing": { 17277 "type": "object", 17278 "properties": { 17279 "type": { 17280 "type": "string" 17281 }, 17282 "cidrPrefix": { 17283 "type": "integer" 17284 }, 17285 "cidrIp": { 17286 "type": "string" 17287 }, 17288 "netmask": { 17289 "type": "string" 17290 }, 17291 "gateway": { 17292 "type": "string" 17293 } 17294 } 17295 }, 17296 "wanOverlay": { 17297 "type": "string" 17298 }, 17299 "natDirect": { 17300 "type": "boolean" 17301 }, 17302 "ospf": { 17303 "type": "object", 17304 "properties": { 17305 "enabled": { 17306 "type": "boolean" 17307 }, 17308 "area": { 17309 "type": "integer" 17310 }, 17311 "authentication": { 17312 "type": "boolean" 17313 }, 17314 "authId": { 17315 "type": "integer" 17316 }, 17317 "authPassphrase": { 17318 "type": "string" 17319 }, 17320 "helloTimer": { 17321 "type": "integer" 17322 }, 17323 "deadTimer": { 17324 "type": "integer" 17325 }, 17326 "mode": { 17327 "type": "string" 17328 }, 17329 "md5Authentication": { 17330 "type": "boolean" 17331 }, 17332 "cost": { 17333 "type": "integer" 17334 }, 17335 "MTU": { 17336 "type": "integer" 17337 }, 17338 "passive": { 17339 "type": "boolean" 17340 }, 17341 "inboundRouteLearning": { 17342 "type": "object", 17343 "properties": { 17344 "defaultAction": { 17345 "type": "string" 17346 }, 17347 "filters": { 17348 "type": "array", 17349 "items": { 17350 "type": "object" 17351 } 17352 } 17353 } 17354 }, 17355 "outboundRouteAdvertisement": { 17356 "type": "object", 17357 "properties": { 17358 "defaultAction": { 17359 "type": "string" 17360 }, 17361 "filters": { 17362 "type": "array", 17363 "items": { 17364 "type": "object" 17365 } 17366 } 17367 } 17368 } 17369 } 17370 }, 17371 "vlanId": { 17372 "type": "integer" 17373 }, 17374 "l2": { 17375 "type": "object", 17376 "properties": { 17377 "autonegotiation": { 17378 "type": "boolean" 17379 }, 17380 "speed": { 17381 "type": "string" 17382 }, 17383 "duplex": { 17384 "type": "string" 17385 }, 17386 "MTU": { 17387 "type": "integer" 17388 } 17389 } 17390 }, 17391 "underlayAccounting": { 17392 "type": "boolean", 17393 "default": true 17394 }, 17395 "trusted": { 17396 "type": "boolean" 17397 }, 17398 "rpf": { 17399 "type": "string", 17400 "enum": [ 17401 "SPECIFIC", 17402 "LOOSE", 17403 "DISABLED" 17404 ] 17405 } 17406 } 17407 } 17408 }, 17409 "lan": { 17410 "type": "object", 17411 "properties": { 17412 "interfaces": { 17413 "type": "array", 17414 "items": { 17415 "type": "object", 17416 "properties": { 17417 "space": { 17418 "type": "string" 17419 }, 17420 "name": { 17421 "type": "string" 17422 }, 17423 "type": { 17424 "type": "string" 17425 }, 17426 "cwp": { 17427 "type": "boolean" 17428 }, 17429 "portMode": { 17430 "type": "string" 17431 }, 17432 "untaggedVlan": { 17433 "type": "string" 17434 }, 17435 "disabled": { 17436 "type": "boolean" 17437 }, 17438 "l2": { 17439 "type": "object", 17440 "properties": { 17441 "autonegotiation": { 17442 "type": "boolean" 17443 }, 17444 "speed": { 17445 "type": "string" 17446 }, 17447 "duplex": { 17448 "type": "string" 17449 }, 17450 "MTU": { 17451 "type": "integer" 17452 } 17453 } 17454 }, 17455 "vlanIds": { 17456 "type": "array", 17457 "items": { 17458 "type": "integer" 17459 } 17460 } 17461 } 17462 } 17463 } 17464 } 17465 } 17466 } 17467 } 17468 } 17469 }, 17470 "vpn": { 17471 "type": "object", 17472 "properties": { 17473 "enabled": { 17474 "type": "boolean" 17475 }, 17476 "edgeToDataCenter": { 17477 "type": "boolean" 17478 }, 17479 "ref": { 17480 "type": "string" 17481 }, 17482 "edgeToEdgeHub": { 17483 "type": "object", 17484 "properties": { 17485 "enabled": { 17486 "type": "boolean" 17487 }, 17488 "ref": { 17489 "type": "string" 17490 } 17491 } 17492 }, 17493 "edgeToEdge": { 17494 "type": "boolean" 17495 }, 17496 "edgeToEdgeDetail": { 17497 "type": "object", 17498 "properties": { 17499 "useCloudGateway": { 17500 "type": "boolean" 17501 }, 17502 "encryptionProtocol": { 17503 "type": "string" 17504 }, 17505 "dynamic": { 17506 "type": "object", 17507 "properties": { 17508 "enabled": { 17509 "type": "boolean" 17510 }, 17511 "type": { 17512 "type": "string" 17513 }, 17514 "timeout": { 17515 "type": "integer" 17516 } 17517 } 17518 }, 17519 "vpnHubs": { 17520 "type": "array", 17521 "items": { 17522 "type": "object" 17523 } 17524 }, 17525 "autoSelectVpnHubs": { 17526 "type": "boolean" 17527 } 17528 } 17529 } 17530 } 17531 } 17532 } 17533 }, 17534 "segmentBasedDeviceSettingsData": { 17535 "type": "object", 17536 "properties": { 17537 "ha": { 17538 "$ref": "#/definitions/device_settings_ha" 17539 }, 17540 "lan": { 17541 "$ref": "#/definitions/device_settings_lan" 17542 }, 17543 "models": { 17544 "type": "object", 17545 "additionalProperties": { 17546 "$ref": "#/definitions/device_settings_model" 17547 } 17548 }, 17549 "multiSourceQos": { 17550 "$ref": "#/definitions/device_settings_multi_source_qos" 17551 }, 17552 "ntp": { 17553 "$ref": "#/definitions/device_settings_ntp" 17554 }, 17555 "radioSettings": { 17556 "$ref": "#/definitions/device_settings_radio_settings" 17557 }, 17558 "routedInterfaces": { 17559 "type": "array", 17560 "items": { 17561 "$ref": "#/definitions/device_settings_routed_interface" 17562 } 17563 }, 17564 "segments": { 17565 "type": "array", 17566 "items": { 17567 "$ref": "#/definitions/device_settings_segment" 17568 } 17569 }, 17570 "snmp": { 17571 "$ref": "#/definitions/device_settings_snmp" 17572 }, 17573 "softwareUpdate": { 17574 "$ref": "#/definitions/device_settings_software_update" 17575 }, 17576 "tacacs": { 17577 "$ref": "#/definitions/device_settings_tacacs" 17578 }, 17579 "vnfs": { 17580 "$ref": "#/definitions/device_settings_vnfs" 17581 } 17582 } 17583 }, 17584 "device_settings_authentication": { 17585 "type": "object", 17586 "properties": { 17587 "override": { 17588 "type": "boolean" 17589 }, 17590 "ref": { 17591 "type": "string", 17592 "enum": [ 17593 "deviceSettings:authentication" 17594 ] 17595 } 17596 } 17597 }, 17598 "device_settings_bgp": { 17599 "type": "object", 17600 "properties": { 17601 "enabled": { 17602 "type": "boolean" 17603 }, 17604 "override": { 17605 "type": "boolean" 17606 }, 17607 "ASN": { 17608 "type": "string" 17609 }, 17610 "connectedRoutes": { 17611 "type": "boolean" 17612 }, 17613 "defaultRoute": { 17614 "type": "object", 17615 "properties": { 17616 "enabled": { 17617 "type": "boolean" 17618 }, 17619 "advertise": { 17620 "type": "string" 17621 } 17622 } 17623 }, 17624 "disableASPathCarryOver": { 17625 "type": "boolean" 17626 }, 17627 "filters": { 17628 "type": "array", 17629 "items": { 17630 "$ref": "#/definitions/device_settings_bgp_filter" 17631 } 17632 }, 17633 "holdtime": { 17634 "type": "string" 17635 }, 17636 "isEdge": { 17637 "type": "boolean" 17638 }, 17639 "keepalive": { 17640 "type": "string" 17641 }, 17642 "neighbors": { 17643 "type": "array", 17644 "items": { 17645 "$ref": "#/definitions/device_settings_bgp_neighbor" 17646 } 17647 }, 17648 "networks": { 17649 "type": "array", 17650 "items": { 17651 "$ref": "#/definitions/device_settings_bgp_network" 17652 } 17653 }, 17654 "ospf": { 17655 "$ref": "#/definitions/device_settings_bgp_ospf_redistribution" 17656 }, 17657 "overlayPrefix": { 17658 "type": "boolean" 17659 }, 17660 "propagateUplink": { 17661 "type": "boolean" 17662 }, 17663 "routerId": { 17664 "type": "string" 17665 }, 17666 "uplinkCommunity": { 17667 "type": "string" 17668 } 17669 } 17670 }, 17671 "device_settings_bgp_filter": { 17672 "type": "object", 17673 "properties": { 17674 "ids": { 17675 "type": "array", 17676 "items": { 17677 "type": "string" 17678 } 17679 }, 17680 "name": { 17681 "type": "string" 17682 }, 17683 "rules": { 17684 "type": "array", 17685 "items": { 17686 "$ref": "#/definitions/device_settings_bgp_filter_rule" 17687 } 17688 } 17689 } 17690 }, 17691 "device_settings_bgp_filter_rule": { 17692 "type": "object", 17693 "properties": { 17694 "action": { 17695 "type": "object", 17696 "properties": { 17697 "type": { 17698 "type": "string", 17699 "enum": [ 17700 "PERMIT", 17701 "DENY" 17702 ] 17703 }, 17704 "values": { 17705 "type": "array", 17706 "items": { 17707 "type": "object", 17708 "properties": { 17709 "type": { 17710 "type": "string", 17711 "enum": [ 17712 "AS_PATH_PREPEND", 17713 "METRIC", 17714 "LOCAL_PREFERENCE", 17715 "COMMUNITY" 17716 ] 17717 }, 17718 "value": { 17719 "type": "string" 17720 } 17721 } 17722 } 17723 } 17724 } 17725 }, 17726 "match": { 17727 "type": "object", 17728 "properties": { 17729 "exactMatch": { 17730 "type": "boolean" 17731 }, 17732 "type": { 17733 "type": "string", 17734 "enum": [ 17735 "COMMUNITY", 17736 "PREFIX" 17737 ] 17738 }, 17739 "value": { 17740 "type": "string" 17741 } 17742 } 17743 } 17744 } 17745 }, 17746 "device_settings_bgp_neighbor": { 17747 "type": "object", 17748 "properties": { 17749 "neighborAS": { 17750 "type": "string" 17751 }, 17752 "neighborIp": { 17753 "type": "string" 17754 }, 17755 "neighborTag": { 17756 "type": "string", 17757 "enum": [ 17758 "UPLINK" 17759 ] 17760 }, 17761 "inboundFilter": { 17762 "$ref": "#/definitions/device_settings_bgp_filter_set" 17763 }, 17764 "outboundFilter": { 17765 "$ref": "#/definitions/device_settings_bgp_filter_set" 17766 }, 17767 "allowAS": { 17768 "type": "boolean" 17769 }, 17770 "connect": { 17771 "type": "string" 17772 }, 17773 "defaultRoute": { 17774 "type": "boolean" 17775 }, 17776 "holdtime": { 17777 "type": "string" 17778 }, 17779 "keepalive": { 17780 "type": "string" 17781 }, 17782 "enableMd5": { 17783 "type": "boolean" 17784 }, 17785 "md5Password": { 17786 "type": "string" 17787 } 17788 } 17789 }, 17790 "device_settings_bgp_filter_set": { 17791 "type": "object", 17792 "properties": { 17793 "ids": { 17794 "type": "array", 17795 "items": { 17796 "type": "string" 17797 } 17798 } 17799 } 17800 }, 17801 "device_settings_bgp_network": { 17802 "type": "object", 17803 "properties": { 17804 "cidrIp": { 17805 "type": "string" 17806 }, 17807 "cidrPrefix": { 17808 "type": "integer" 17809 }, 17810 "segmentId": { 17811 "type": "string" 17812 } 17813 } 17814 }, 17815 "device_settings_bgp_ospf_redistribution": { 17816 "type": "object", 17817 "properties": { 17818 "enabled": { 17819 "type": "boolean" 17820 }, 17821 "metric": { 17822 "type": "integer" 17823 } 17824 } 17825 }, 17826 "device_settings_cloud_security": { 17827 "type": "object", 17828 "properties": { 17829 "enabled": { 17830 "type": "boolean" 17831 }, 17832 "override": { 17833 "type": "boolean" 17834 }, 17835 "config": { 17836 "type": "object", 17837 "properties": { 17838 "tunnelingProtocol": { 17839 "type": "string", 17840 "enum": [ 17841 "GRE", 17842 "IPSEC" 17843 ] 17844 }, 17845 "authenticationAlgorithm": { 17846 "type": "string" 17847 }, 17848 "encryptionAlgorithm": { 17849 "type": "string" 17850 }, 17851 "redirect": { 17852 "type": "string" 17853 }, 17854 "IKEPROP": { 17855 "type": "object", 17856 "properties": { 17857 "protocolVersion": { 17858 "type": "integer" 17859 } 17860 } 17861 }, 17862 "GREPROP": { 17863 "type": "object", 17864 "properties": { 17865 "keepaliveIntervalSecs": { 17866 "type": "integer", 17867 "minimum": 0, 17868 "maximum": 30 17869 }, 17870 "keepaliveRetries": { 17871 "type": "integer", 17872 "minimum": 0, 17873 "maximum": 10 17874 } 17875 } 17876 } 17877 } 17878 }, 17879 "provider": { 17880 "type": "object", 17881 "properties": { 17882 "ref": { 17883 "type": "string", 17884 "enum": [ 17885 "deviceSettings:css:provider" 17886 ] 17887 } 17888 } 17889 }, 17890 "sites": { 17891 "type": "array", 17892 "items": { 17893 "$ref": "#/definitions/device_settings_cloud_security_site" 17894 } 17895 } 17896 } 17897 }, 17898 "device_settings_cloud_security_site": { 17899 "type": "object", 17900 "properties": { 17901 "data": { 17902 "$ref": "#/definitions/cloud_security_service_site_data" 17903 }, 17904 "logicalId": { 17905 "type": "string" 17906 } 17907 } 17908 }, 17909 "device_settings_dns": { 17910 "type": "object", 17911 "properties": { 17912 "override": { 17913 "type": "boolean" 17914 }, 17915 "primaryProvider": { 17916 "type": "object", 17917 "properties": { 17918 "ref": { 17919 "type": "string", 17920 "enum": [ 17921 "deviceSettings:dns:primaryProvider" 17922 ] 17923 } 17924 } 17925 }, 17926 "backupProvider": { 17927 "type": "object", 17928 "properties": { 17929 "ref": { 17930 "type": "string", 17931 "enum": [ 17932 "deviceSettings:dns:backupProvider" 17933 ] 17934 } 17935 } 17936 }, 17937 "privateProviders": { 17938 "type": "object", 17939 "properties": { 17940 "ref": { 17941 "type": "string", 17942 "enum": [ 17943 "deviceSettings:dns:privateProviders" 17944 ] 17945 } 17946 } 17947 } 17948 } 17949 }, 17950 "device_settings_ha": { 17951 "type": "object", 17952 "properties": { 17953 "enabled": { 17954 "type": "boolean" 17955 }, 17956 "interface": { 17957 "type": "string" 17958 } 17959 } 17960 }, 17961 "device_settings_handoff_gateways": { 17962 "type": "object", 17963 "properties": { 17964 "override": { 17965 "type": "boolean" 17966 }, 17967 "autoSelect": { 17968 "type": "boolean" 17969 }, 17970 "gatewayList": { 17971 "type": "array", 17972 "items": { 17973 "$ref": "#/definitions/device_settings_handoff_gateway" 17974 } 17975 }, 17976 "gateways": { 17977 "type": "array", 17978 "items": { 17979 "$ref": "#/definitions/logicalid_reference" 17980 } 17981 } 17982 } 17983 }, 17984 "device_settings_handoff_gateway": { 17985 "allOf": [ 17986 { 17987 "$ref": "#/definitions/logicalid_reference" 17988 }, 17989 { 17990 "properties": { 17991 "ipsecDetail": { 17992 "$ref": "#/definitions/device_settings_handoff_gateway_ipsec_detail" 17993 } 17994 } 17995 } 17996 ] 17997 }, 17998 "device_settings_handoff_gateway_ipsec_detail": { 17999 "type": "object", 18000 "properties": { 18001 "ipsecGatewayAddress": { 18002 "type": "string" 18003 }, 18004 "strictHostCheck": { 18005 "type": "boolean" 18006 } 18007 } 18008 }, 18009 "device_settings_model": { 18010 "type": "object", 18011 "properties": { 18012 "lan": { 18013 "$ref": "#/definitions/device_settings_lan" 18014 }, 18015 "routedInterfaces": { 18016 "type": "array", 18017 "items": { 18018 "$ref": "#/definitions/device_settings_routed_interface" 18019 } 18020 } 18021 } 18022 }, 18023 "device_settings_multicast": { 18024 "type": "object", 18025 "properties": { 18026 "enabled": { 18027 "type": "boolean" 18028 }, 18029 "override": { 18030 "type": "boolean" 18031 }, 18032 "igmpHostQueryIntervalSeconds": { 18033 "type": "integer" 18034 }, 18035 "igmpMaxQueryResponse": { 18036 "type": "integer" 18037 }, 18038 "pimKeepAliveTimerSeconds": { 18039 "type": "integer" 18040 }, 18041 "pimOnWanOverlay": { 18042 "$ref": "#/definitions/device_settings_multicast_pim_on_wan_overlay" 18043 }, 18044 "pimPruneIntervalSeconds": { 18045 "type": "integer" 18046 }, 18047 "rp": { 18048 "$ref": "#/definitions/device_settings_multicast_rp" 18049 } 18050 } 18051 }, 18052 "device_settings_multicast_pim_on_wan_overlay": { 18053 "type": "object", 18054 "properties": { 18055 "enabled": { 18056 "type": "boolean" 18057 }, 18058 "type": { 18059 "type": "string", 18060 "enum": [ 18061 "SOURCE_IP" 18062 ] 18063 }, 18064 "sourceCidrIp": { 18065 "type": "string" 18066 }, 18067 "sourceInterface": { 18068 "type": "string" 18069 } 18070 } 18071 }, 18072 "device_settings_multicast_rp": { 18073 "type": "object", 18074 "properties": { 18075 "type": { 18076 "type": "string", 18077 "enum": [ 18078 "STATIC" 18079 ] 18080 }, 18081 "staticGroups": { 18082 "type": "array", 18083 "items": { 18084 "$ref": "#/definitions/device_settings_multicast_rp_static_group" 18085 } 18086 } 18087 } 18088 }, 18089 "device_settings_multicast_rp_static_group": { 18090 "type": "object", 18091 "properties": { 18092 "multicastGroups": { 18093 "type": "array", 18094 "items": { 18095 "type": "string" 18096 } 18097 }, 18098 "rpAddress": { 18099 "type": "string" 18100 } 18101 } 18102 }, 18103 "device_settings_netflow_collector": { 18104 "type": "object", 18105 "properties": { 18106 "type": { 18107 "type": "string" 18108 }, 18109 "sourceInterface": { 18110 "type": "string" 18111 }, 18112 "name": { 18113 "type": "string" 18114 }, 18115 "allowAllSegment": { 18116 "type": "boolean" 18117 }, 18118 "logicalId": { 18119 "type": "string" 18120 }, 18121 "filterList": { 18122 "type": "array", 18123 "items": { 18124 "$ref": "#/definitions/device_settings_netflow_filter_list" 18125 } 18126 } 18127 } 18128 }, 18129 "device_settings_netflow_filter_list": { 18130 "type": "object", 18131 "properties": { 18132 "type": { 18133 "type": "string" 18134 }, 18135 "name": { 18136 "type": "string" 18137 }, 18138 "logicalId": { 18139 "type": "string" 18140 } 18141 } 18142 }, 18143 "device_settings_nat": { 18144 "type": "object", 18145 "properties": { 18146 "override": { 18147 "type": "boolean" 18148 }, 18149 "rules": { 18150 "type": "array", 18151 "items": { 18152 "$ref": "#/definitions/device_settings_nat_rule" 18153 }, 18154 "maxItems": 256 18155 } 18156 } 18157 }, 18158 "device_settings_nat_rule": { 18159 "type": "object", 18160 "properties": { 18161 "type": { 18162 "type": "string", 18163 "enum": [ 18164 "source", 18165 "destination" 18166 ] 18167 }, 18168 "description": { 18169 "type": "string" 18170 }, 18171 "insideCidrIp": { 18172 "type": "string", 18173 "format": "ipv4" 18174 }, 18175 "insideCidrPrefix": { 18176 "type": "integer" 18177 }, 18178 "insideNetmask": { 18179 "type": "string", 18180 "format": "ipv4" 18181 }, 18182 "insidePort": { 18183 "type": "integer" 18184 }, 18185 "outsideCidrIp": { 18186 "type": "string", 18187 "format": "ipv4" 18188 }, 18189 "outsideCidrPrefix": { 18190 "type": "integer" 18191 }, 18192 "outsideNetmask": { 18193 "type": "string", 18194 "format": "ipv4" 18195 }, 18196 "outsidePort": { 18197 "type": "integer" 18198 } 18199 }, 18200 "required": [ 18201 "type", 18202 "insideCidrIp", 18203 "insideCidrPrefix", 18204 "insideNetmask", 18205 "outsideCidrIp", 18206 "outsideCidrPrefix", 18207 "outsideNetmask" 18208 ] 18209 }, 18210 "device_settings_netflow": { 18211 "type": "object", 18212 "properties": { 18213 "enabled": { 18214 "type": "boolean" 18215 }, 18216 "override": { 18217 "type": "boolean" 18218 }, 18219 "collectors": { 18220 "type": "array", 18221 "items": { 18222 "$ref": "#/definitions/device_settings_netflow_collector" 18223 } 18224 }, 18225 "version": { 18226 "type": "integer" 18227 }, 18228 "intervals": { 18229 "type": "object", 18230 "properties": { 18231 "flowStats": { 18232 "type": "integer" 18233 }, 18234 "flowLinkStats": { 18235 "type": "integer" 18236 }, 18237 "vrfTable": { 18238 "type": "integer" 18239 }, 18240 "applicationTable": { 18241 "type": "integer" 18242 }, 18243 "interfaceTable": { 18244 "type": "integer" 18245 }, 18246 "linkTable": { 18247 "type": "integer" 18248 } 18249 } 18250 } 18251 } 18252 }, 18253 "netflow_collector": { 18254 "allOf": [ 18255 { 18256 "$ref": "#/definitions/enterprise_object_base" 18257 }, 18258 { 18259 "type": "object", 18260 "properties": { 18261 "data": { 18262 "$ref": "#/definitions/netflow_collector_data" 18263 } 18264 } 18265 } 18266 ] 18267 }, 18268 "netflow_collector_data": { 18269 "type": "object", 18270 "properties": { 18271 "name": { 18272 "type": "string" 18273 }, 18274 "address": { 18275 "type": "string" 18276 }, 18277 "port": { 18278 "type": "integer" 18279 } 18280 }, 18281 "required": [ 18282 "name", 18283 "address", 18284 "port" 18285 ] 18286 }, 18287 "device_settings_vqm_collector": { 18288 "type": "object", 18289 "properties": { 18290 "address": { 18291 "type": "string" 18292 }, 18293 "port": { 18294 "type": "integer" 18295 } 18296 } 18297 }, 18298 "device_settings_ospf": { 18299 "type": "object", 18300 "properties": { 18301 "enabled": { 18302 "type": "boolean" 18303 }, 18304 "areas": { 18305 "type": "array", 18306 "items": { 18307 "$ref": "#/definitions/device_settings_ospf_area" 18308 } 18309 }, 18310 "bgp": { 18311 "$ref": "#/definitions/device_settings_ospf_bgp_redistribution" 18312 }, 18313 "defaultPrefixes": { 18314 "type": "boolean" 18315 }, 18316 "defaultRouteAdvertise": { 18317 "type": "string", 18318 "enum": [ 18319 "ALWAYS", 18320 "CONDITIONAL" 18321 ] 18322 }, 18323 "defaultRoutes": { 18324 "type": "string", 18325 "enum": [ 18326 "OE1", 18327 "OE2", 18328 "NONE" 18329 ] 18330 } 18331 } 18332 }, 18333 "device_settings_ospf_area": { 18334 "type": "object", 18335 "properties": { 18336 "id": { 18337 "type": "integer" 18338 }, 18339 "name": { 18340 "type": "string" 18341 }, 18342 "type": { 18343 "type": "string" 18344 } 18345 } 18346 }, 18347 "device_settings_ospf_bgp_redistribution": { 18348 "type": "object", 18349 "properties": { 18350 "enabled": { 18351 "type": "boolean" 18352 }, 18353 "metric": { 18354 "type": "integer" 18355 }, 18356 "metricType": { 18357 "type": "string", 18358 "enum": [ 18359 "E1", 18360 "E2" 18361 ] 18362 } 18363 } 18364 }, 18365 "device_settings_syslog": { 18366 "type": "object", 18367 "properties": { 18368 "enabled": { 18369 "type": "boolean" 18370 }, 18371 "facilityCode": { 18372 "type": "string", 18373 "enum": [ 18374 "local0", 18375 "local1", 18376 "local2", 18377 "local3", 18378 "local4", 18379 "local5", 18380 "local6", 18381 "local7" 18382 ] 18383 }, 18384 "override": { 18385 "type": "boolean" 18386 }, 18387 "collectors": { 18388 "type": "array", 18389 "items": { 18390 "$ref": "#/definitions/device_settings_syslog_collector" 18391 } 18392 } 18393 }, 18394 "required": [ 18395 "collectors", 18396 "enabled" 18397 ] 18398 }, 18399 "device_settings_syslog_collector": { 18400 "type": "object", 18401 "properties": { 18402 "host": { 18403 "type": "string" 18404 }, 18405 "port": { 18406 "type": "integer" 18407 }, 18408 "protocol": { 18409 "type": "string", 18410 "enum": [ 18411 "TCP", 18412 "UDP" 18413 ] 18414 }, 18415 "roles": { 18416 "type": "array", 18417 "items": { 18418 "type": "string", 18419 "enum": [ 18420 "EDGE EVENT" 18421 ] 18422 } 18423 }, 18424 "severity": { 18425 "type": "string", 18426 "enum": [ 18427 "EMERG", 18428 "ALERT", 18429 "CRIT", 18430 "ERR", 18431 "WARNING", 18432 "NOTICE", 18433 "INFO", 18434 "DEBUG" 18435 ] 18436 }, 18437 "sourceInterface": { 18438 "type": "string" 18439 } 18440 }, 18441 "required": [ 18442 "host", 18443 "port", 18444 "protocol", 18445 "roles", 18446 "severity", 18447 "sourceInterface" 18448 ] 18449 }, 18450 "device_settings_icmp_probe": { 18451 "type": "object" 18452 }, 18453 "device_settings_icmp_responder": { 18454 "type": "object" 18455 }, 18456 "device_settings_static_route": { 18457 "type": "object", 18458 "properties": { 18459 "destination": { 18460 "type": "string" 18461 }, 18462 "netmask": { 18463 "type": "string" 18464 }, 18465 "sourceIp": { 18466 "type": "string" 18467 }, 18468 "gateway": { 18469 "type": "string" 18470 }, 18471 "cost": { 18472 "type": "integer" 18473 }, 18474 "preferred": { 18475 "type": "boolean" 18476 }, 18477 "description": { 18478 "type": "string" 18479 }, 18480 "cidrPrefix": { 18481 "type": "string" 18482 }, 18483 "wanInterface": { 18484 "type": "string" 18485 }, 18486 "icmpProbeLogicalId": { 18487 "type": "string" 18488 }, 18489 "vlanId": { 18490 "type": "integer" 18491 }, 18492 "advertise": { 18493 "type": "boolean" 18494 }, 18495 "subinterfaceId": { 18496 "type": "integer" 18497 } 18498 } 18499 }, 18500 "configuration_module_segment_metadata": { 18501 "type": "object", 18502 "properties": { 18503 "name": { 18504 "type": "string" 18505 }, 18506 "segmentId": { 18507 "type": "integer" 18508 }, 18509 "type": { 18510 "type": "string", 18511 "enum": [ 18512 "REGULAR", 18513 "CDE" 18514 ] 18515 } 18516 } 18517 }, 18518 "device_settings_vpn": { 18519 "type": "object", 18520 "properties": { 18521 "enabled": { 18522 "type": "boolean" 18523 }, 18524 "edgeToDataCenter": { 18525 "type": "boolean" 18526 }, 18527 "ref": { 18528 "type": "string", 18529 "enum": [ 18530 "deviceSettings:vpn:dataCenter" 18531 ] 18532 }, 18533 "isolationGroupId": { 18534 "type": "string" 18535 }, 18536 "edgeToEdgeHub": { 18537 "type": "object", 18538 "properties": { 18539 "enabled": { 18540 "type": "boolean" 18541 }, 18542 "ref": { 18543 "type": "string", 18544 "enum": [ 18545 "deviceSettings:vpn:edgeHub" 18546 ] 18547 } 18548 } 18549 }, 18550 "edgeToEdge": { 18551 "type": "boolean" 18552 }, 18553 "edgeToEdgeDetail": { 18554 "type": "object", 18555 "properties": { 18556 "autoSelectVpnHubs": { 18557 "type": "boolean" 18558 }, 18559 "dynamic": { 18560 "type": "object", 18561 "properties": { 18562 "enabled": { 18563 "type": "boolean" 18564 }, 18565 "isolation": { 18566 "$ref": "#/definitions/device_settings_vpn_profile_isolation" 18567 }, 18568 "type": { 18569 "type": "string" 18570 }, 18571 "timeout": { 18572 "type": "integer" 18573 } 18574 } 18575 }, 18576 "encryptionProtocol": { 18577 "type": "string" 18578 }, 18579 "profileIsolation": { 18580 "$ref": "#/definitions/device_settings_vpn_profile_isolation_deprecated" 18581 }, 18582 "isolation": { 18583 "$ref": "#/definitions/device_settings_vpn_profile_isolation" 18584 }, 18585 "isolationGroupId": { 18586 "type": "string" 18587 }, 18588 "isolationGroups": { 18589 "type": "array", 18590 "items": { 18591 "type": "object", 18592 "properties": { 18593 "logicalId": { 18594 "type": "string" 18595 } 18596 } 18597 } 18598 }, 18599 "useCloudGateway": { 18600 "type": "boolean" 18601 }, 18602 "vpnHubs": { 18603 "type": "array", 18604 "items": { 18605 "$ref": "#/definitions/device_settings_vpn_hub" 18606 } 18607 } 18608 } 18609 } 18610 } 18611 }, 18612 "device_settings_vpn_profile_isolation_deprecated": { 18613 "type": "object", 18614 "properties": { 18615 "enabled": { 18616 "type": "boolean" 18617 }, 18618 "profileLogicalId": { 18619 "type": "string" 18620 }, 18621 "isolateDynamic": { 18622 "type": "boolean" 18623 } 18624 } 18625 }, 18626 "device_settings_vpn_profile_isolation": { 18627 "type": "object", 18628 "properties": { 18629 "enabled": { 18630 "type": "boolean" 18631 } 18632 } 18633 }, 18634 "device_settings_vpn_profile_isolation_group": { 18635 "type": "object", 18636 "properties": { 18637 "logicalId": { 18638 "type": "string" 18639 } 18640 } 18641 }, 18642 "device_settings_vpn_hub": { 18643 "allOf": [ 18644 { 18645 "$ref": "#/definitions/logicalid_reference" 18646 }, 18647 { 18648 "properties": { 18649 "name": { 18650 "type": "string" 18651 }, 18652 "type": { 18653 "type": "string", 18654 "enum": [ 18655 "edgeHub", 18656 "edgeHubCluster" 18657 ] 18658 } 18659 } 18660 } 18661 ] 18662 }, 18663 "device_settings_vqm": { 18664 "type": "object", 18665 "properties": { 18666 "enabled": { 18667 "type": "boolean" 18668 }, 18669 "override": { 18670 "type": "boolean" 18671 }, 18672 "protocol": { 18673 "type": "string", 18674 "enum": [ 18675 "RFC6035" 18676 ] 18677 }, 18678 "collectors": { 18679 "type": "array", 18680 "items": { 18681 "$ref": "#/definitions/device_settings_vqm_collector" 18682 } 18683 } 18684 } 18685 }, 18686 "device_settings_vrrp": { 18687 "type": "object", 18688 "properties": { 18689 "enabled": { 18690 "type": "boolean" 18691 }, 18692 "data": { 18693 "type": "array", 18694 "items": { 18695 "$ref": "#/definitions/device_settings_vrrp_virtual_router" 18696 } 18697 } 18698 } 18699 }, 18700 "device_settings_vrrp_virtual_router": { 18701 "type": "object", 18702 "properties": { 18703 "cidrIp": { 18704 "type": "string" 18705 }, 18706 "interface": { 18707 "type": "string" 18708 }, 18709 "interval": { 18710 "type": "integer" 18711 }, 18712 "preempt": { 18713 "type": "boolean" 18714 }, 18715 "preemptDelay": { 18716 "type": "integer" 18717 }, 18718 "priority": { 18719 "type": "integer" 18720 }, 18721 "subinterfaceId": { 18722 "type": "integer" 18723 }, 18724 "vlanId": { 18725 "type": "integer" 18726 }, 18727 "vrid": { 18728 "type": "integer" 18729 } 18730 } 18731 }, 18732 "device_settings_lan": { 18733 "type": "object", 18734 "properties": { 18735 "interfaces": { 18736 "type": "array", 18737 "items": { 18738 "$ref": "#/definitions/device_settings_lan_interface" 18739 } 18740 }, 18741 "management": { 18742 "$ref": "#/definitions/subnet" 18743 }, 18744 "networks": { 18745 "type": "array", 18746 "items": { 18747 "$ref": "#/definitions/device_settings_lan_network" 18748 } 18749 }, 18750 "visibility": { 18751 "type": "object", 18752 "properties": { 18753 "override": { 18754 "type": "boolean" 18755 }, 18756 "mode": { 18757 "type": "string", 18758 "enum": [ 18759 "MAC", 18760 "IP" 18761 ] 18762 } 18763 } 18764 } 18765 } 18766 }, 18767 "device_settings_lan_interface": { 18768 "type": "object", 18769 "properties": { 18770 "override": { 18771 "type": "boolean" 18772 }, 18773 "name": { 18774 "type": "string" 18775 }, 18776 "cwp": { 18777 "type": "boolean" 18778 }, 18779 "disabled": { 18780 "type": "boolean" 18781 }, 18782 "l2": { 18783 "type": "object", 18784 "properties": { 18785 "autonegotiation": { 18786 "type": "boolean" 18787 }, 18788 "speed": { 18789 "type": "string" 18790 }, 18791 "duplex": { 18792 "type": "string", 18793 "enum": [ 18794 "FULL", 18795 "HALF" 18796 ] 18797 }, 18798 "MTU": { 18799 "type": "integer" 18800 } 18801 } 18802 }, 18803 "portMode": { 18804 "type": "string", 18805 "enum": [ 18806 "access", 18807 "trunk" 18808 ] 18809 }, 18810 "space": { 18811 "type": "string" 18812 }, 18813 "type": { 18814 "type": "string", 18815 "enum": [ 18816 "wired", 18817 "wireless" 18818 ] 18819 }, 18820 "untaggedVlan": { 18821 "type": "integer" 18822 }, 18823 "vlanIds": { 18824 "type": "array", 18825 "items": { 18826 "type": "integer" 18827 } 18828 }, 18829 "authenticationType": { 18830 "type": "string", 18831 "enum": [ 18832 "none", 18833 "802.1x" 18834 ] 18835 }, 18836 "broadcastSsid": { 18837 "type": "boolean" 18838 }, 18839 "passphrase": { 18840 "type": "string" 18841 }, 18842 "ssid": { 18843 "type": "string" 18844 }, 18845 "securityMode": { 18846 "type": "string", 18847 "enum": [ 18848 "Open", 18849 "WPA2Enterprise", 18850 "WPA2Personal" 18851 ] 18852 } 18853 } 18854 }, 18855 "device_settings_lan_network": { 18856 "type": "object", 18857 "properties": { 18858 "override": { 18859 "type": "boolean" 18860 }, 18861 "advertise": { 18862 "type": "boolean" 18863 }, 18864 "pingResponse": { 18865 "type": "boolean", 18866 "default": true 18867 }, 18868 "bindEdgeAddress": { 18869 "type": "boolean" 18870 }, 18871 "baseDhcpAddr": { 18872 "type": "integer" 18873 }, 18874 "cidrIp": { 18875 "type": "string" 18876 }, 18877 "cidrPrefix": { 18878 "type": "integer" 18879 }, 18880 "cost": { 18881 "type": "integer" 18882 }, 18883 "dhcp": { 18884 "$ref": "#/definitions/device_settings_dhcp" 18885 }, 18886 "disabled": { 18887 "type": "boolean" 18888 }, 18889 "interfaces": { 18890 "type": "array", 18891 "items": { 18892 "type": "string" 18893 } 18894 }, 18895 "multicast": { 18896 "type": "object", 18897 "properties": { 18898 "igmp": { 18899 "type": "object", 18900 "properties": { 18901 "enabled": { 18902 "type": "boolean" 18903 }, 18904 "type": { 18905 "type": "string", 18906 "enum": [ 18907 "IGMP_V2" 18908 ] 18909 } 18910 } 18911 }, 18912 "igmpHostQueryIntervalSeconds": { 18913 "type": "integer" 18914 }, 18915 "igmpMaxQueryResponse": { 18916 "type": "integer" 18917 }, 18918 "pim": { 18919 "type": "object", 18920 "properties": { 18921 "enabled": { 18922 "type": "boolean" 18923 }, 18924 "type": { 18925 "type": "string", 18926 "enum": [ 18927 "PIM_SM" 18928 ] 18929 } 18930 } 18931 }, 18932 "pimHelloTimerSeconds": { 18933 "type": "integer" 18934 }, 18935 "pimKeepAliveTimerSeconds": { 18936 "type": "integer" 18937 }, 18938 "pimPruneIntervalSeconds": { 18939 "type": "integer" 18940 } 18941 } 18942 }, 18943 "name": { 18944 "type": "string" 18945 }, 18946 "netmask": { 18947 "type": "string" 18948 }, 18949 "numDhcpAddr": { 18950 "type": "integer" 18951 }, 18952 "ospf": { 18953 "type": "object", 18954 "properties": { 18955 "enabled": { 18956 "type": "boolean" 18957 }, 18958 "override": { 18959 "type": "boolean" 18960 }, 18961 "area": { 18962 "type": "integer" 18963 }, 18964 "passiveInterface": { 18965 "type": "boolean" 18966 } 18967 } 18968 }, 18969 "segmentId": { 18970 "type": "integer" 18971 }, 18972 "staticReserved": { 18973 "type": "integer" 18974 }, 18975 "vlanId": { 18976 "type": "integer" 18977 } 18978 } 18979 }, 18980 "device_settings_dhcp": { 18981 "type": "object", 18982 "properties": { 18983 "enabled": { 18984 "type": "boolean" 18985 }, 18986 "dhcpRelay": { 18987 "$ref": "#/definitions/device_settings_dhcp_relay" 18988 }, 18989 "leaseTimeSeconds": { 18990 "type": "integer" 18991 }, 18992 "baseDhcpAddr": { 18993 "type": "integer" 18994 }, 18995 "numDhcpAddr": { 18996 "type": "integer" 18997 }, 18998 "options": { 18999 "type": "array", 19000 "items": { 19001 "$ref": "#/definitions/device_settings_dhcp_option" 19002 } 19003 }, 19004 "override": { 19005 "type": "boolean" 19006 } 19007 } 19008 }, 19009 "device_settings_dhcp_relay": { 19010 "type": "object", 19011 "properties": { 19012 "enabled": { 19013 "type": "boolean" 19014 }, 19015 "servers": { 19016 "type": "array", 19017 "items": { 19018 "type": "string" 19019 } 19020 } 19021 } 19022 }, 19023 "device_settings_dhcp_option": { 19024 "type": "object", 19025 "properties": { 19026 "option": { 19027 "type": "integer" 19028 }, 19029 "value": { 19030 "type": "string" 19031 }, 19032 "type": { 19033 "type": "string" 19034 }, 19035 "metaData": { 19036 "type": "object", 19037 "properties": { 19038 "dataType": { 19039 "type": "string" 19040 }, 19041 "description": { 19042 "type": "string" 19043 }, 19044 "display": { 19045 "type": "boolean" 19046 }, 19047 "list": { 19048 "type": "boolean" 19049 }, 19050 "name": { 19051 "type": "string" 19052 }, 19053 "option": { 19054 "type": "integer" 19055 } 19056 } 19057 } 19058 } 19059 }, 19060 "device_settings_multi_source_qos": { 19061 "type": "object", 19062 "properties": { 19063 "enabled": { 19064 "type": "boolean" 19065 }, 19066 "override": { 19067 "type": "boolean" 19068 }, 19069 "highRatio": { 19070 "type": "integer" 19071 }, 19072 "normalRatio": { 19073 "type": "integer" 19074 }, 19075 "lowRatio": { 19076 "type": "integer" 19077 }, 19078 "maxCapThreshold": { 19079 "type": "integer" 19080 }, 19081 "minCapThreshold": { 19082 "type": "integer" 19083 } 19084 } 19085 }, 19086 "device_settings_ntp": { 19087 "type": "object", 19088 "properties": { 19089 "enabled": { 19090 "type": "boolean" 19091 }, 19092 "override": { 19093 "type": "boolean" 19094 }, 19095 "servers": { 19096 "type": "array", 19097 "items": { 19098 "$ref": "#/definitions/device_settings_ntp_server" 19099 } 19100 } 19101 } 19102 }, 19103 "device_settings_ntp_server": { 19104 "type": "object", 19105 "properties": { 19106 "server": { 19107 "type": "string" 19108 } 19109 } 19110 }, 19111 "device_settings_radio_settings": { 19112 "type": "object", 19113 "properties": { 19114 "country": { 19115 "type": "string" 19116 }, 19117 "radios": { 19118 "type": "array", 19119 "items": { 19120 "$ref": "#/definitions/device_settings_radio" 19121 } 19122 } 19123 } 19124 }, 19125 "device_settings_radio": { 19126 "type": "object", 19127 "properties": { 19128 "band": { 19129 "type": "string" 19130 }, 19131 "channel": { 19132 "type": "string" 19133 }, 19134 "isEnabled": { 19135 "type": "boolean" 19136 }, 19137 "mode": { 19138 "type": "string" 19139 }, 19140 "name": { 19141 "type": "string" 19142 }, 19143 "radioId": { 19144 "type": "integer" 19145 }, 19146 "width": { 19147 "type": "string" 19148 } 19149 } 19150 }, 19151 "device_settings_routed_interface": { 19152 "type": "object", 19153 "properties": { 19154 "override": { 19155 "type": "boolean" 19156 }, 19157 "addressing": { 19158 "$ref": "#/definitions/device_settings_routed_interface_addressing" 19159 }, 19160 "advertise": { 19161 "type": "boolean" 19162 }, 19163 "pingResponse": { 19164 "type": "boolean", 19165 "default": true 19166 }, 19167 "disabled": { 19168 "type": "boolean" 19169 }, 19170 "dhcpServer": { 19171 "$ref": "#/definitions/device_settings_dhcp" 19172 }, 19173 "encryptOverlay": { 19174 "type": "boolean" 19175 }, 19176 "l2": { 19177 "$ref": "#/definitions/device_settings_routed_interface_l2" 19178 }, 19179 "multicast": { 19180 "type": "object", 19181 "properties": { 19182 "igmp": { 19183 "type": "object", 19184 "properties": { 19185 "enabled": { 19186 "type": "boolean" 19187 }, 19188 "type": { 19189 "type": "string", 19190 "enum": [ 19191 "IGMP_V2" 19192 ] 19193 } 19194 } 19195 }, 19196 "igmpHostQueryIntervalSeconds": { 19197 "type": "integer" 19198 }, 19199 "igmpMaxQueryResponse": { 19200 "type": "integer" 19201 }, 19202 "pim": { 19203 "type": "object", 19204 "properties": { 19205 "enabled": { 19206 "type": "boolean" 19207 }, 19208 "type": { 19209 "type": "string", 19210 "enum": [ 19211 "PIM_SM" 19212 ] 19213 } 19214 } 19215 }, 19216 "pimKeepAliveTimerSeconds": { 19217 "type": "integer" 19218 }, 19219 "pimPruneIntervalSeconds": { 19220 "type": "integer" 19221 }, 19222 "pimHelloTimerSeconds": { 19223 "type": "integer" 19224 } 19225 } 19226 }, 19227 "name": { 19228 "type": "string" 19229 }, 19230 "natDirect": { 19231 "type": "boolean" 19232 }, 19233 "ospf": { 19234 "$ref": "#/definitions/device_settings_routed_interface_ospf" 19235 }, 19236 "radiusAuthentication": { 19237 "type": "object", 19238 "properties": { 19239 "enabled": { 19240 "type": "boolean" 19241 }, 19242 "macBypass": { 19243 "type": "array", 19244 "items": { 19245 "type": "object", 19246 "properties": { 19247 "address": { 19248 "type": "string" 19249 }, 19250 "description": { 19251 "type": "string" 19252 } 19253 } 19254 } 19255 } 19256 } 19257 }, 19258 "segmentId": { 19259 "type": "integer" 19260 }, 19261 "subinterfaces": { 19262 "type": "array", 19263 "items": { 19264 "$ref": "#/definitions/device_settings_subinterface" 19265 } 19266 }, 19267 "rpf": { 19268 "type": "string", 19269 "enum": [ 19270 "SPECIFIC", 19271 "LOOSE", 19272 "DISABLED" 19273 ] 19274 }, 19275 "trusted": { 19276 "type": "boolean" 19277 }, 19278 "underlayAccounting": { 19279 "type": "boolean", 19280 "default": true 19281 }, 19282 "vlanId": { 19283 "type": "integer" 19284 }, 19285 "wanOverlay": { 19286 "type": "string", 19287 "enum": [ 19288 "DISABLED", 19289 "AUTO_DISCOVERED", 19290 "USER_DEFINED" 19291 ] 19292 } 19293 } 19294 }, 19295 "device_settings_routed_interface_addressing": { 19296 "type": "object", 19297 "properties": { 19298 "type": { 19299 "type": "string", 19300 "enum": [ 19301 "DHCP", 19302 "STATIC", 19303 "PPPOE" 19304 ] 19305 }, 19306 "cidrPrefix": { 19307 "type": "integer" 19308 }, 19309 "cidrIp": { 19310 "type": "string" 19311 }, 19312 "netmask": { 19313 "type": "string" 19314 }, 19315 "gateway": { 19316 "type": "string" 19317 }, 19318 "username": { 19319 "type": "string" 19320 }, 19321 "password": { 19322 "type": "string" 19323 } 19324 } 19325 }, 19326 "device_settings_routed_interface_ospf": { 19327 "type": "object", 19328 "properties": { 19329 "area": { 19330 "type": "integer" 19331 }, 19332 "authentication": { 19333 "type": "boolean" 19334 }, 19335 "authId": { 19336 "type": "integer" 19337 }, 19338 "authPassphrase": { 19339 "type": "string" 19340 }, 19341 "cost": { 19342 "type": "integer" 19343 }, 19344 "deadTimer": { 19345 "type": "integer" 19346 }, 19347 "mode": { 19348 "type": "string" 19349 }, 19350 "enabled": { 19351 "type": "boolean" 19352 }, 19353 "exclusionRoutes": { 19354 "type": "array", 19355 "items": { 19356 "type": "object" 19357 } 19358 }, 19359 "helloTimer": { 19360 "type": "integer" 19361 }, 19362 "inboundRouteLearning": { 19363 "$ref": "#/definitions/device_settings_routed_interface_ospf_filter" 19364 }, 19365 "md5Authentication": { 19366 "type": "boolean" 19367 }, 19368 "MTU": { 19369 "type": "integer" 19370 }, 19371 "outboundRouteAdvertisement": { 19372 "$ref": "#/definitions/device_settings_routed_interface_ospf_filter" 19373 }, 19374 "passive": { 19375 "type": "boolean" 19376 }, 19377 "vlanId": { 19378 "type": "integer" 19379 } 19380 } 19381 }, 19382 "device_settings_routed_interface_ospf_filter": { 19383 "type": "object", 19384 "properties": { 19385 "defaultAction": { 19386 "type": "string", 19387 "enum": [ 19388 "ADVERTISE", 19389 "IGNORE", 19390 "LEARN" 19391 ] 19392 }, 19393 "filters": { 19394 "type": "array", 19395 "items": { 19396 "type": "object", 19397 "properties": { 19398 "cidrIp": { 19399 "type": "string" 19400 }, 19401 "cidrPrefix": { 19402 "type": "string" 19403 }, 19404 "action": { 19405 "type": "string", 19406 "enum": [ 19407 "ADVERTISE", 19408 "IGNORE", 19409 "LEARN" 19410 ] 19411 } 19412 } 19413 } 19414 } 19415 } 19416 }, 19417 "device_settings_routed_interface_l2": { 19418 "type": "object", 19419 "properties": { 19420 "autonegotiation": { 19421 "type": "boolean" 19422 }, 19423 "speed": { 19424 "type": "string" 19425 }, 19426 "duplex": { 19427 "type": "string", 19428 "enum": [ 19429 "FULL", 19430 "HALF" 19431 ] 19432 }, 19433 "MTU": { 19434 "type": "integer" 19435 } 19436 } 19437 }, 19438 "device_settings_subinterface": { 19439 "allOf": [ 19440 { 19441 "$ref": "#/definitions/device_settings_routed_interface" 19442 }, 19443 { 19444 "type": "object", 19445 "properties": { 19446 "subinterfaceId": { 19447 "type": "integer" 19448 }, 19449 "subinterfaceType": { 19450 "type": "string", 19451 "enum": [ 19452 "SECONDARY_IP", 19453 "SUB_INTERFACE" 19454 ] 19455 } 19456 } 19457 } 19458 ] 19459 }, 19460 "device_settings_segment": { 19461 "type": "object", 19462 "properties": { 19463 "authentication": { 19464 "$ref": "#/definitions/device_settings_authentication" 19465 }, 19466 "bgp": { 19467 "$ref": "#/definitions/device_settings_bgp" 19468 }, 19469 "css": { 19470 "$ref": "#/definitions/device_settings_cloud_security" 19471 }, 19472 "dns": { 19473 "$ref": "#/definitions/device_settings_dns" 19474 }, 19475 "handOffControllers": { 19476 "$ref": "#/definitions/device_settings_handoff_gateways" 19477 }, 19478 "handOffGateways": { 19479 "$ref": "#/definitions/device_settings_handoff_gateways" 19480 }, 19481 "multiSourceQos": { 19482 "$ref": "#/definitions/device_settings_multi_source_qos" 19483 }, 19484 "multicast": { 19485 "$ref": "#/definitions/device_settings_multicast" 19486 }, 19487 "nat": { 19488 "$ref": "#/definitions/device_settings_nat" 19489 }, 19490 "netflow": { 19491 "$ref": "#/definitions/device_settings_netflow" 19492 }, 19493 "ntp": { 19494 "$ref": "#/definitions/device_settings_ntp" 19495 }, 19496 "ospf": { 19497 "$ref": "#/definitions/device_settings_ospf" 19498 }, 19499 "routes": { 19500 "type": "object", 19501 "properties": { 19502 "icmpProbes": { 19503 "type": "array", 19504 "items": { 19505 "$ref": "#/definitions/device_settings_icmp_probe" 19506 } 19507 }, 19508 "icmpResponders": { 19509 "type": "array", 19510 "items": { 19511 "$ref": "#/definitions/device_settings_icmp_responder" 19512 } 19513 }, 19514 "static": { 19515 "type": "array", 19516 "items": { 19517 "$ref": "#/definitions/device_settings_static_route" 19518 } 19519 } 19520 } 19521 }, 19522 "segment": { 19523 "$ref": "#/definitions/configuration_module_segment_metadata" 19524 }, 19525 "snmp": { 19526 "$ref": "#/definitions/device_settings_snmp" 19527 }, 19528 "syslog": { 19529 "$ref": "#/definitions/device_settings_syslog" 19530 }, 19531 "vpn": { 19532 "$ref": "#/definitions/device_settings_vpn" 19533 }, 19534 "vqm": { 19535 "$ref": "#/definitions/device_settings_vqm" 19536 }, 19537 "vrrp": { 19538 "$ref": "#/definitions/device_settings_vrrp" 19539 } 19540 } 19541 }, 19542 "device_settings_snmp": { 19543 "type": "object", 19544 "properties": { 19545 "override": { 19546 "type": "boolean" 19547 }, 19548 "port": { 19549 "type": "integer" 19550 }, 19551 "snmpv2c": { 19552 "$ref": "#/definitions/device_settings_snmpv2c" 19553 }, 19554 "snmpv3": { 19555 "$ref": "#/definitions/device_settings_snmpv3" 19556 } 19557 } 19558 }, 19559 "device_settings_snmpv2c": { 19560 "type": "object", 19561 "properties": { 19562 "enabled": { 19563 "type": "boolean" 19564 }, 19565 "community": { 19566 "type": "string" 19567 }, 19568 "allowedIp": { 19569 "type": "array", 19570 "items": { 19571 "type": "string" 19572 } 19573 } 19574 } 19575 }, 19576 "device_settings_snmpv3": { 19577 "type": "object", 19578 "properties": { 19579 "enabled": { 19580 "type": "boolean" 19581 }, 19582 "users": { 19583 "type": "array", 19584 "items": { 19585 "$ref": "#/definitions/device_settings_snmpv3_user" 19586 } 19587 } 19588 } 19589 }, 19590 "device_settings_snmpv3_user": { 19591 "type": "object", 19592 "properties": { 19593 "name": { 19594 "type": "string" 19595 }, 19596 "passphrase": { 19597 "type": "string" 19598 }, 19599 "authAlg": { 19600 "type": "string" 19601 }, 19602 "privacy": { 19603 "type": "boolean" 19604 }, 19605 "encrAlg": { 19606 "type": "string" 19607 } 19608 } 19609 }, 19610 "device_settings_software_update": { 19611 "type": "object", 19612 "properties": { 19613 "windowed": { 19614 "type": "boolean" 19615 }, 19616 "window": { 19617 "$ref": "#/definitions/device_settings_software_update_window" 19618 } 19619 } 19620 }, 19621 "device_settings_software_update_window": { 19622 "type": "object", 19623 "properties": { 19624 "day": { 19625 "type": "integer" 19626 }, 19627 "beginHour": { 19628 "type": "integer" 19629 }, 19630 "endHour": { 19631 "type": "integer" 19632 } 19633 } 19634 }, 19635 "device_settings_tacacs": { 19636 "type": "object", 19637 "properties": { 19638 "ref": { 19639 "type": "string", 19640 "enum": [ 19641 "deviceSettings:tacacs" 19642 ] 19643 }, 19644 "sourceInterface": { 19645 "type": "string" 19646 } 19647 } 19648 }, 19649 "device_settings_vnfs": { 19650 "type": "object", 19651 "properties": { 19652 "edge": { 19653 "allOf": [ 19654 { 19655 "$ref": "#/definitions/logicalid_reference" 19656 }, 19657 { 19658 "type": "object", 19659 "properties": { 19660 "ref": { 19661 "type": "string", 19662 "pattern": "deviceSettings:vnfs:edge" 19663 } 19664 } 19665 } 19666 ] 19667 }, 19668 "hasVnfs": { 19669 "type": "boolean" 19670 }, 19671 "securityVnf": { 19672 "type": "object", 19673 "properties": { 19674 "vms": { 19675 "type": "array", 19676 "items": { 19677 "$ref": "#/definitions/device_settings_security_vnf_vm" 19678 } 19679 } 19680 } 19681 } 19682 } 19683 }, 19684 "device_settings_security_vnf_vm": { 19685 "type": "object", 19686 "properties": { 19687 "type": { 19688 "type": "string", 19689 "pattern": "securityVnf" 19690 }, 19691 "vendor": { 19692 "type": "string", 19693 "enum": [ 19694 "PaloAlto", 19695 "CheckPoint", 19696 "Fortinet", 19697 "CentOS" 19698 ] 19699 }, 19700 "edge": { 19701 "allOf": [ 19702 { 19703 "$ref": "#/definitions/logicalid_reference" 19704 }, 19705 { 19706 "type": "object", 19707 "properties": { 19708 "ref": { 19709 "type": "string", 19710 "pattern": "deviceSettings:vnfs:edge" 19711 } 19712 } 19713 } 19714 ] 19715 }, 19716 "license": { 19717 "allOf": [ 19718 { 19719 "$ref": "#/definitions/logicalid_reference" 19720 }, 19721 { 19722 "type": "object", 19723 "properties": { 19724 "ref": { 19725 "type": "string", 19726 "pattern": "deviceSettings:securityVnf:license" 19727 } 19728 } 19729 } 19730 ] 19731 }, 19732 "service": { 19733 "allOf": [ 19734 { 19735 "$ref": "#/definitions/logicalid_reference" 19736 }, 19737 { 19738 "type": "object", 19739 "properties": { 19740 "ref": { 19741 "type": "string", 19742 "pattern": "deviceSettings:securityVnf:service" 19743 } 19744 } 19745 } 19746 ] 19747 }, 19748 "uuid": { 19749 "type": "string" 19750 }, 19751 "uuidTimestamp": { 19752 "type": "string", 19753 "format": "date-time" 19754 } 19755 } 19756 }, 19757 "WAN": { 19758 "allOf": [ 19759 { 19760 "$ref": "#/definitions/configuration_module_base_type" 19761 }, 19762 { 19763 "type": "object", 19764 "properties": { 19765 "data": { 19766 "$ref": "#/definitions/WAN_data" 19767 }, 19768 "refs": { 19769 "$ref": "#/definitions/genericRefs" 19770 } 19771 }, 19772 "required": [ 19773 "data" 19774 ] 19775 } 19776 ] 19777 }, 19778 "WAN_data": { 19779 "type": "object", 19780 "properties": { 19781 "links": { 19782 "type": "array", 19783 "items": { 19784 "type": "object", 19785 "properties": { 19786 "logicalId": { 19787 "type": "string" 19788 }, 19789 "internalId": { 19790 "type": "string" 19791 }, 19792 "discovery": { 19793 "type": "string", 19794 "enum": [ 19795 "DISABLED", 19796 "AUTO_DISCOVERED", 19797 "USER_DEFINED" 19798 ] 19799 }, 19800 "mode": { 19801 "type": "string", 19802 "enum": [ 19803 "PUBLIC", 19804 "PRIVATE" 19805 ] 19806 }, 19807 "type": { 19808 "type": "string", 19809 "enum": [ 19810 "WIRED", 19811 "WIRELESS" 19812 ] 19813 }, 19814 "name": { 19815 "type": "string" 19816 }, 19817 "isp": { 19818 "type": "string" 19819 }, 19820 "publicIpAddress": { 19821 "type": "string" 19822 }, 19823 "sourceIpAddress": { 19824 "type": "string" 19825 }, 19826 "nextHopIpAddress": { 19827 "type": "string" 19828 }, 19829 "customVlanId": { 19830 "type": "boolean" 19831 }, 19832 "vlanId": { 19833 "type": "integer" 19834 }, 19835 "enable8021P": { 19836 "type": "boolean" 19837 }, 19838 "priority8021P": { 19839 "type": "integer" 19840 }, 19841 "virtualIpAddress": { 19842 "type": "string" 19843 }, 19844 "dynamicBwAdjustmentEnabled": { 19845 "type": "boolean" 19846 }, 19847 "bwMeasurement": { 19848 "type": "string" 19849 }, 19850 "upstreamMbps": { 19851 "type": "string" 19852 }, 19853 "downstreamMbps": { 19854 "type": "string" 19855 }, 19856 "backupOnly": { 19857 "type": "boolean" 19858 }, 19859 "overheadBytes": { 19860 "type": "integer" 19861 }, 19862 "udpHolePunching": { 19863 "type": "boolean" 19864 }, 19865 "MTU": { 19866 "type": "integer" 19867 }, 19868 "mplsNetwork": { 19869 "type": "string" 19870 }, 19871 "dscpTag": { 19872 "type": "string" 19873 }, 19874 "staticSlaEnabled": { 19875 "type": "boolean" 19876 }, 19877 "classesofServiceEnabled": { 19878 "type": "boolean" 19879 }, 19880 "encryptOverlay": { 19881 "type": "boolean" 19882 }, 19883 "staticSLA": { 19884 "type": "object", 19885 "properties": { 19886 "latencyMs": { 19887 "type": "integer" 19888 }, 19889 "jitterMs": { 19890 "type": "integer" 19891 }, 19892 "lossPct": { 19893 "type": "integer" 19894 } 19895 } 19896 }, 19897 "classesOfService": { 19898 "type": "object", 19899 "properties": { 19900 "classId": { 19901 "type": "integer" 19902 }, 19903 "classesOfService": { 19904 "type": "array", 19905 "items": { 19906 "type": "object", 19907 "properties": { 19908 "id": { 19909 "type": "string" 19910 }, 19911 "name": { 19912 "type": "string" 19913 }, 19914 "dscpTags": { 19915 "type": "array", 19916 "items": { 19917 "type": "string" 19918 } 19919 }, 19920 "staticSLA": { 19921 "type": "object", 19922 "properties": { 19923 "latencyMs": { 19924 "type": "integer" 19925 }, 19926 "jitterMs": { 19927 "type": "integer" 19928 }, 19929 "lossPct": { 19930 "type": "string" 19931 } 19932 } 19933 }, 19934 "bandwidthPct": { 19935 "type": "integer" 19936 }, 19937 "bandwidthGuaranteed": { 19938 "type": "boolean" 19939 }, 19940 "defaultClassOfService": { 19941 "type": "boolean" 19942 } 19943 } 19944 } 19945 } 19946 } 19947 }, 19948 "interfaces": { 19949 "type": "array", 19950 "items": { 19951 "type": "string" 19952 } 19953 }, 19954 "lastActive": { 19955 "type": "string" 19956 } 19957 } 19958 } 19959 }, 19960 "networks": { 19961 "type": "array", 19962 "items": { 19963 "type": "object", 19964 "properties": { 19965 "mode": { 19966 "type": "string" 19967 }, 19968 "type": { 19969 "type": "string" 19970 }, 19971 "name": { 19972 "type": "string" 19973 }, 19974 "logicalId": { 19975 "type": "string" 19976 }, 19977 "interface": { 19978 "type": "string" 19979 }, 19980 "internalId": { 19981 "type": "string" 19982 }, 19983 "ipAddress": { 19984 "type": "string" 19985 }, 19986 "isp": { 19987 "type": "string" 19988 }, 19989 "lastActive": { 19990 "type": "integer" 19991 } 19992 } 19993 } 19994 } 19995 } 19996 }, 19997 "metaData": { 19998 "allOf": [ 19999 { 20000 "$ref": "#/definitions/configuration_module_base_type" 20001 }, 20002 { 20003 "type": "object", 20004 "properties": { 20005 "data": { 20006 "$ref": "#/definitions/metadata_data" 20007 } 20008 }, 20009 "required": [ 20010 "data" 20011 ] 20012 } 20013 ] 20014 }, 20015 "metadata_data": { 20016 "type": "object", 20017 "properties": { 20018 "applications": { 20019 "type": "object", 20020 "properties": { 20021 "logicalId": { 20022 "type": "string" 20023 }, 20024 "type": { 20025 "type": "string" 20026 }, 20027 "version": { 20028 "type": "string" 20029 } 20030 } 20031 } 20032 } 20033 }, 20034 "application": { 20035 "properties": { 20036 "class": { 20037 "type": "integer" 20038 }, 20039 "description": { 20040 "type": "string" 20041 }, 20042 "displayName": { 20043 "type": "string" 20044 }, 20045 "name": { 20046 "type": "string" 20047 }, 20048 "id": { 20049 "type": "integer" 20050 }, 20051 "knownIpPortMapping": { 20052 "$ref": "#/definitions/ip_port_mapping" 20053 }, 20054 "protocolPortMapping": { 20055 "$ref": "#/definitions/protocol_port_mapping" 20056 } 20057 }, 20058 "required": [ 20059 "id", 20060 "displayName", 20061 "class", 20062 "description", 20063 "knownIpPortMapping", 20064 "protocolPortMapping" 20065 ], 20066 "type": "object" 20067 }, 20068 "application_metadata": { 20069 "properties": { 20070 "blobId": { 20071 "type": "integer" 20072 }, 20073 "created": { 20074 "format": "date-time", 20075 "type": "string" 20076 }, 20077 "description": { 20078 "type": "string" 20079 }, 20080 "fileName": { 20081 "type": "string" 20082 }, 20083 "id": { 20084 "type": "integer" 20085 }, 20086 "logicalId": { 20087 "type": "string" 20088 }, 20089 "manifest": { 20090 "$ref": "#/definitions/application_metadata_manifest" 20091 }, 20092 "modified": { 20093 "format": "date-time", 20094 "type": "string" 20095 }, 20096 "name": { 20097 "type": "string" 20098 }, 20099 "networkId": { 20100 "type": "integer" 20101 }, 20102 "type": { 20103 "type": "string" 20104 }, 20105 "uploadDetails": { 20106 "$ref": "#/definitions/application_metadata_upload_details" 20107 }, 20108 "version": { 20109 "type": "string" 20110 } 20111 }, 20112 "required": [ 20113 "id", 20114 "networkId", 20115 "created", 20116 "name", 20117 "logicalId", 20118 "type", 20119 "description", 20120 "version", 20121 "manifest", 20122 "blobId", 20123 "modified", 20124 "fileName", 20125 "uploadDetails" 20126 ], 20127 "type": "object" 20128 }, 20129 "application_metadata_manifest": { 20130 "properties": { 20131 "description": { 20132 "type": "string" 20133 }, 20134 "name": { 20135 "type": "string" 20136 }, 20137 "version": { 20138 "type": "string" 20139 } 20140 }, 20141 "required": [ 20142 "name", 20143 "description", 20144 "version" 20145 ], 20146 "type": "object" 20147 }, 20148 "application_metadata_upload_details": { 20149 "additionalProperties": true, 20150 "properties": { 20151 "size": { 20152 "type": "integer" 20153 } 20154 }, 20155 "required": [ 20156 "size" 20157 ], 20158 "type": "object" 20159 }, 20160 "auth_object": { 20161 "properties": { 20162 "email": { 20163 "type": "string" 20164 }, 20165 "password": { 20166 "type": "string" 20167 }, 20168 "password2": { 20169 "format": "password", 20170 "type": "string" 20171 }, 20172 "username": { 20173 "type": "string" 20174 } 20175 }, 20176 "required": [ 20177 "username", 20178 "password" 20179 ], 20180 "type": "object" 20181 }, 20182 "basic_metric": { 20183 "enum": [ 20184 "packetsRx", 20185 "packetsTx", 20186 "totalPackets", 20187 "bytesRx", 20188 "bytesTx", 20189 "totalBytes" 20190 ], 20191 "type": "string" 20192 }, 20193 "basic_metrics": { 20194 "items": { 20195 "$ref": "#/definitions/basic_metric" 20196 }, 20197 "type": "array" 20198 }, 20199 "edge_link_metric": { 20200 "type": "string", 20201 "enum": [ 20202 "bytesRx", 20203 "bytesTx", 20204 "totalBytes", 20205 "totalPackets", 20206 "p1BytesRx", 20207 "p1BytesTx", 20208 "p1PacketsRx", 20209 "p1PacketsTx", 20210 "p2BytesRx", 20211 "p2BytesTx", 20212 "p2PacketsRx", 20213 "p2PacketsTx", 20214 "p3BytesRx", 20215 "p3BytesTx", 20216 "p3PacketsRx", 20217 "p3PacketsTx", 20218 "packetsRx", 20219 "packetsTx", 20220 "controlBytesRx", 20221 "controlBytesTx", 20222 "controlPacketsRx", 20223 "controlPacketsTx", 20224 "bestBwKbpsRx", 20225 "bestBwKbpsTx", 20226 "bestJitterMsRx", 20227 "bestJitterMsTx", 20228 "bestLatencyMsRx", 20229 "bestLatencyMsTx", 20230 "bestLossPctRx", 20231 "bestLossPctTx", 20232 "bpsOfBestPathRx", 20233 "bpsOfBestPathTx", 20234 "signalStrength", 20235 "scoreTx", 20236 "scoreRx" 20237 ] 20238 }, 20239 "model_configuration": { 20240 "type": "object", 20241 "properties": { 20242 "created": { 20243 "type": "string" 20244 }, 20245 "description": { 20246 "type": "string" 20247 }, 20248 "edgeCount": { 20249 "type": "integer" 20250 }, 20251 "effective": { 20252 "type": "string" 20253 }, 20254 "id": { 20255 "type": "integer" 20256 }, 20257 "modified": { 20258 "type": "string" 20259 }, 20260 "modules": { 20261 "type": "array", 20262 "items": { 20263 "$ref": "#/definitions/configuration_module_base_type" 20264 } 20265 }, 20266 "name": { 20267 "type": "string" 20268 }, 20269 "version": { 20270 "type": "string" 20271 } 20272 } 20273 }, 20274 "empty_object": { 20275 "type": "object", 20276 "properties": {} 20277 }, 20278 "bgp_peer_status": { 20279 "type": "object", 20280 "properties": { 20281 "neighborIp": { 20282 "type": "string" 20283 }, 20284 "neighborAS": { 20285 "type": "integer" 20286 }, 20287 "records": { 20288 "type": "array", 20289 "items": { 20290 "$ref": "#/definitions/bgp_peer_status_record" 20291 } 20292 } 20293 } 20294 }, 20295 "bgp_peer_status_record": { 20296 "type": "object", 20297 "properties": { 20298 "timestamp": { 20299 "type": "string", 20300 "format": "date-time" 20301 }, 20302 "state": { 20303 "type": "string", 20304 "enum": [ 20305 "IDLE", 20306 "CONNECT", 20307 "ACTIVE", 20308 "OPENSENT", 20309 "OPENCONFIRM", 20310 "ESTABLISHED", 20311 "CLEARING", 20312 "IDLEADMIN", 20313 "IDLEPRFXCT" 20314 ] 20315 }, 20316 "msgRcvd": { 20317 "type": "integer" 20318 }, 20319 "pfxRcvd": { 20320 "type": "integer" 20321 }, 20322 "msgSent": { 20323 "type": "integer" 20324 }, 20325 "upDownTime": { 20326 "type": "integer" 20327 } 20328 } 20329 }, 20330 "config_edge_bgp_filter_set": { 20331 "type": "object", 20332 "properties": { 20333 "ids": { 20334 "type": "array", 20335 "items": { 20336 "type": "string" 20337 } 20338 } 20339 } 20340 }, 20341 "config_edge_bgp_neighbor": { 20342 "type": "object", 20343 "properties": { 20344 "neighborAS": { 20345 "type": "string" 20346 }, 20347 "neighborIp": { 20348 "type": "string" 20349 }, 20350 "neighborTag": { 20351 "type": "string", 20352 "enum": [ 20353 "UPLINK" 20354 ] 20355 }, 20356 "inboundFilter": { 20357 "$ref": "#/definitions/config_edge_bgp_filter_set" 20358 }, 20359 "outboundFilter": { 20360 "$ref": "#/definitions/config_edge_bgp_filter_set" 20361 }, 20362 "allowAS": { 20363 "type": "boolean" 20364 }, 20365 "connect": { 20366 "type": "string" 20367 }, 20368 "defaultRoute": { 20369 "type": "boolean" 20370 }, 20371 "holdtime": { 20372 "type": "string" 20373 }, 20374 "keepalive": { 20375 "type": "string" 20376 }, 20377 "enableMd5": { 20378 "type": "boolean" 20379 }, 20380 "md5Password": { 20381 "type": "string" 20382 } 20383 } 20384 }, 20385 "configuration_clone_configuration_result": { 20386 "properties": { 20387 "id": { 20388 "description": "The ID of the newly cloned configuration", 20389 "type": "integer" 20390 } 20391 }, 20392 "required": [ 20393 "id" 20394 ], 20395 "type": "object" 20396 }, 20397 "configuration_clone_and_convert_configuration_result": { 20398 "properties": { 20399 "id": { 20400 "description": "The ID of the newly cloned configuration", 20401 "type": "integer" 20402 } 20403 }, 20404 "required": [ 20405 "id" 20406 ], 20407 "type": "object" 20408 }, 20409 "configuration_clone_enterprise_template_result": { 20410 "properties": { 20411 "id": { 20412 "description": "The ID of the newly cloned configuration", 20413 "type": "integer" 20414 } 20415 }, 20416 "required": [ 20417 "id" 20418 ], 20419 "type": "object" 20420 }, 20421 "configuration_delete_configuration_result": { 20422 "allOf": [ 20423 { 20424 "$ref": "#/definitions/deletion_confirmation" 20425 } 20426 ] 20427 }, 20428 "configuration_get_configuration_modules_result_item": { 20429 "allOf": [ 20430 { 20431 "$ref": "#/definitions/configuration_module_base_type" 20432 }, 20433 { 20434 "required": [ 20435 "id", 20436 "name", 20437 "type", 20438 "data", 20439 "refs", 20440 "description", 20441 "configurationId" 20442 ] 20443 } 20444 ] 20445 }, 20446 "configuration_get_configuration_result": { 20447 "allOf": [ 20448 { 20449 "$ref": "#/definitions/model_configuration" 20450 }, 20451 { 20452 "required": [ 20453 "id", 20454 "created", 20455 "name", 20456 "version", 20457 "description", 20458 "effective", 20459 "modified" 20460 ] 20461 } 20462 ] 20463 }, 20464 "configuration_get_routable_applications_result": { 20465 "properties": { 20466 "applicationClassToApplication": { 20467 "allOf": [ 20468 { 20469 "$ref": "#/definitions/id_map_one_to_many" 20470 } 20471 ], 20472 "description": "Maps application class IDs (strings) to application IDs (integers)" 20473 }, 20474 "applicationToApplicationClass": { 20475 "allOf": [ 20476 { 20477 "$ref": "#/definitions/id_map_one_to_many" 20478 } 20479 ], 20480 "description": "Maps application IDs (strings) to class IDs (integers)" 20481 }, 20482 "applicationClasses": { 20483 "allOf": [ 20484 { 20485 "$ref": "#/definitions/id_map_one_to_one" 20486 } 20487 ], 20488 "description": "Map of application class IDs to class names" 20489 }, 20490 "applications": { 20491 "items": { 20492 "$ref": "#/definitions/application" 20493 }, 20494 "type": "array" 20495 }, 20496 "metaData": { 20497 "$ref": "#/definitions/application_metadata" 20498 } 20499 }, 20500 "required": [ 20501 "applications", 20502 "applicationClasses", 20503 "applicationClassToApplication", 20504 "applicationToApplicationClass", 20505 "metaData" 20506 ], 20507 "type": "object" 20508 }, 20509 "configuration_get_identifiable_applications_result": { 20510 "properties": { 20511 "applicationClassToApplication": { 20512 "allOf": [ 20513 { 20514 "$ref": "#/definitions/id_map_one_to_many" 20515 } 20516 ], 20517 "description": "Maps application class IDs (strings) to application IDs (integers)" 20518 }, 20519 "applicationToApplicationClass": { 20520 "allOf": [ 20521 { 20522 "$ref": "#/definitions/id_map_one_to_many" 20523 } 20524 ], 20525 "description": "Maps application IDs (strings) to class IDs (integers)" 20526 }, 20527 "applicationClasses": { 20528 "allOf": [ 20529 { 20530 "$ref": "#/definitions/id_map_one_to_one" 20531 } 20532 ], 20533 "description": "Map of application class IDs to class names" 20534 }, 20535 "applications": { 20536 "items": { 20537 "$ref": "#/definitions/application" 20538 }, 20539 "type": "array" 20540 } 20541 }, 20542 "required": [ 20543 "applications", 20544 "applicationClasses", 20545 "applicationClassToApplication", 20546 "applicationToApplicationClass" 20547 ], 20548 "type": "object" 20549 }, 20550 "configuration_insert_configuration_module_result": { 20551 "properties": { 20552 "id": { 20553 "description": "The ID of the newly created configuration module", 20554 "type": "integer" 20555 } 20556 }, 20557 "required": [ 20558 "id" 20559 ], 20560 "type": "object" 20561 }, 20562 "configuration_options_list": { 20563 "items": { 20564 "enum": [ 20565 "modules", 20566 "edgeCount", 20567 "enterprises", 20568 "enterpriseCount", 20569 "counts" 20570 ], 20571 "type": "string" 20572 }, 20573 "type": "array" 20574 }, 20575 "configuration_update_configuration_module_result": { 20576 "allOf": [ 20577 { 20578 "$ref": "#/definitions/rows_modified_confirmation" 20579 } 20580 ] 20581 }, 20582 "base_enterprise_user": { 20583 "type": "object", 20584 "properties": { 20585 "id": { 20586 "type": "integer" 20587 }, 20588 "created": { 20589 "type": "string", 20590 "format": "date-time" 20591 }, 20592 "userType": { 20593 "type": "string" 20594 }, 20595 "username": { 20596 "type": "string" 20597 }, 20598 "domain": { 20599 "type": "string" 20600 }, 20601 "password": { 20602 "type": "string", 20603 "format": "password" 20604 }, 20605 "firstName": { 20606 "type": "string" 20607 }, 20608 "lastName": { 20609 "type": "string" 20610 }, 20611 "officePhone": { 20612 "type": "string" 20613 }, 20614 "mobilePhone": { 20615 "type": "string" 20616 }, 20617 "isNative": { 20618 "type": "boolean" 20619 }, 20620 "isActive": { 20621 "type": "boolean" 20622 }, 20623 "isLocked": { 20624 "type": "boolean" 20625 }, 20626 "disableSecondFactor": { 20627 "type": "boolean" 20628 }, 20629 "email": { 20630 "type": "string" 20631 }, 20632 "lastLogin": { 20633 "type": "string", 20634 "format": "date-time" 20635 }, 20636 "modified": { 20637 "type": "string", 20638 "format": "date-time" 20639 } 20640 } 20641 }, 20642 "destinations": { 20643 "properties": { 20644 "ip_addr": { 20645 "type": "string" 20646 }, 20647 "name": { 20648 "type": "string" 20649 } 20650 }, 20651 "type": "object" 20652 }, 20653 "disaster_recovery_client_contact": { 20654 "properties": { 20655 "activeAddress": { 20656 "type": "string" 20657 }, 20658 "activeLastResponseTime": { 20659 "format": "date-time", 20660 "type": "string" 20661 }, 20662 "clientLogicalId": { 20663 "type": "string" 20664 }, 20665 "clientType": { 20666 "enum": [ 20667 "EDGE", 20668 "GATEWAY" 20669 ], 20670 "type": "string" 20671 }, 20672 "id": { 20673 "type": "integer" 20674 }, 20675 "modified": { 20676 "format": "date-time", 20677 "type": "string" 20678 }, 20679 "standbyAddress": { 20680 "type": "string" 20681 }, 20682 "standbyLastResponseTime": { 20683 "format": "date-time", 20684 "type": "string" 20685 } 20686 }, 20687 "required": [ 20688 "id", 20689 "clientType", 20690 "clientLogicalId", 20691 "activeAddress", 20692 "activeLastResponseTime", 20693 "standbyAddress", 20694 "standbyLastResponseTime", 20695 "modified" 20696 ], 20697 "type": "object" 20698 }, 20699 "disaster_recovery_configure_active_for_replication_result": { 20700 "allOf": [ 20701 { 20702 "$ref": "#/definitions/rows_modified_confirmation" 20703 } 20704 ] 20705 }, 20706 "disaster_recovery_demote_active_result": { 20707 "allOf": [ 20708 { 20709 "$ref": "#/definitions/rows_modified_confirmation" 20710 } 20711 ] 20712 }, 20713 "disaster_recovery_get_replication_blob": { 20714 "allOf": [ 20715 { 20716 "$ref": "#/definitions/empty_object" 20717 } 20718 ] 20719 }, 20720 "disaster_recovery_get_replication_blob_result": { 20721 "properties": { 20722 "activeAccessFromStandby": { 20723 "type": "string" 20724 } 20725 }, 20726 "required": [ 20727 "activeAccessFromStandby" 20728 ], 20729 "type": "object" 20730 }, 20731 "disaster_recovery_get_replication_status_result": { 20732 "properties": { 20733 "activeAddress": { 20734 "type": "string" 20735 }, 20736 "activeReplicationAddress": { 20737 "type": "string" 20738 }, 20739 "clientContact": { 20740 "type": "array", 20741 "items": { 20742 "$ref": "#/definitions/disaster_recovery_client_contact" 20743 } 20744 }, 20745 "clientCount": { 20746 "type": "object", 20747 "properties": { 20748 "edgeCount": { 20749 "type": "integer" 20750 }, 20751 "gatewayCount": { 20752 "type": "integer" 20753 }, 20754 "currentActiveEdgeCount": { 20755 "type": "integer" 20756 }, 20757 "currentStandbyEdgeCount": { 20758 "type": "integer" 20759 }, 20760 "currentActiveGatewayCount": { 20761 "type": "integer" 20762 }, 20763 "currentStandbyGatewayCount": { 20764 "type": "integer" 20765 } 20766 } 20767 }, 20768 "drState": { 20769 "enum": [ 20770 "UNCONFIGURED", 20771 "ACTIVE_CONFIGURING", 20772 "ACTIVE_CONFIGURED", 20773 "LAUNCHING_STANDBY", 20774 "LAUNCHED_STANDBY", 20775 "ACTIVE_WAIT_STANDBY", 20776 "PENDING_STANDBY_CANDIDATE", 20777 "STANDBY_CANDIDATE", 20778 "STANDBY_CONFIG_RQST", 20779 "STANDBY_CONFIGURING", 20780 "STANDBY_CONFIGURED", 20781 "PENDING_STANDBY_UNCONFIG", 20782 "STANDBY_UNCONFIG", 20783 "PENDING_STANDBY_PROMOTION", 20784 "STANDBY_PROMOTED", 20785 "PENDING_ACTIVE_DEMOTION", 20786 "COPYING_DB", 20787 "COPY_DB_DONE", 20788 "COPYING_FILES", 20789 "COPY_FILES_DONE", 20790 "SYNC_CONFIGURING", 20791 "STANDBY_SYNC", 20792 "STANDBY_BACKGROUND_IMPORT", 20793 "STANDBY_RUNNING", 20794 "UPGRADING", 20795 "FAILURE_ACTIVE_CONFIGURING", 20796 "FAILURE_LAUNCHING_STANDBY", 20797 "FAILURE_STANDBY_CONFIGURING", 20798 "FAILURE_GET_STANDBY_CONFIG", 20799 "FAILURE_COPYING_DB", 20800 "FAILURE_COPYING_FILES", 20801 "FAILURE_SYNC_CONFIGURING", 20802 "FAILURE_BACKGROUND_IMPORT", 20803 "FAILURE_SYNCING_FILES", 20804 "FAILURE_GET_STANDBY_STATUS", 20805 "FAILURE_GET_ACTIVE_STATUS", 20806 "FAILURE_MYSQL_ACTIVE_STATUS", 20807 "FAILURE_MYSQL_STANDBY_STATUS", 20808 "FAILURE_STANDBY_CANDIDATE", 20809 "FAILURE_STANDBY_UNCONFIG", 20810 "FAILURE_STANDBY_PROMOTION", 20811 "FAILURE_ACTIVE_DEMOTION" 20812 ], 20813 "type": "string" 20814 }, 20815 "drVCOUser": { 20816 "type": "string" 20817 }, 20818 "failureDescription": { 20819 "type": "string" 20820 }, 20821 "lastDrProtectedTime": { 20822 "type": "string", 20823 "format": "date-time" 20824 }, 20825 "role": { 20826 "enum": [ 20827 "STANDALONE", 20828 "ACTIVE", 20829 "STANDBY", 20830 "ZOMBIE" 20831 ], 20832 "type": "string" 20833 }, 20834 "roleTimestamp": { 20835 "type": "string", 20836 "format": "date-time" 20837 }, 20838 "standbyList": { 20839 "type": "array", 20840 "items": { 20841 "type": "object", 20842 "properties": { 20843 "standbyAddress": { 20844 "type": "string" 20845 }, 20846 "standbyReplicationAddress": { 20847 "type": "string" 20848 }, 20849 "standbyUuid": { 20850 "type": "string" 20851 } 20852 } 20853 } 20854 }, 20855 "stateHistory": { 20856 "type": "array", 20857 "items": { 20858 "type": "object", 20859 "properties": { 20860 "from": { 20861 "type": "string", 20862 "enum": [ 20863 "UNCONFIGURED", 20864 "ACTIVE_CONFIGURING", 20865 "ACTIVE_CONFIGURED", 20866 "LAUNCHING_STANDBY", 20867 "LAUNCHED_STANDBY", 20868 "ACTIVE_WAIT_STANDBY", 20869 "PENDING_STANDBY_CANDIDATE", 20870 "STANDBY_CANDIDATE", 20871 "STANDBY_CONFIG_RQST", 20872 "STANDBY_CONFIGURING", 20873 "STANDBY_CONFIGURED", 20874 "PENDING_STANDBY_UNCONFIG", 20875 "STANDBY_UNCONFIG", 20876 "PENDING_STANDBY_PROMOTION", 20877 "STANDBY_PROMOTED", 20878 "PENDING_ACTIVE_DEMOTION", 20879 "COPYING_DB", 20880 "COPY_DB_DONE", 20881 "COPYING_FILES", 20882 "COPY_FILES_DONE", 20883 "SYNC_CONFIGURING", 20884 "STANDBY_SYNC", 20885 "STANDBY_BACKGROUND_IMPORT", 20886 "STANDBY_RUNNING", 20887 "UPGRADING", 20888 "FAILURE_ACTIVE_CONFIGURING", 20889 "FAILURE_LAUNCHING_STANDBY", 20890 "FAILURE_STANDBY_CONFIGURING", 20891 "FAILURE_GET_STANDBY_CONFIG", 20892 "FAILURE_COPYING_DB", 20893 "FAILURE_COPYING_FILES", 20894 "FAILURE_SYNC_CONFIGURING", 20895 "FAILURE_BACKGROUND_IMPORT", 20896 "FAILURE_SYNCING_FILES", 20897 "FAILURE_GET_STANDBY_STATUS", 20898 "FAILURE_GET_ACTIVE_STATUS", 20899 "FAILURE_MYSQL_ACTIVE_STATUS", 20900 "FAILURE_MYSQL_STANDBY_STATUS", 20901 "FAILURE_STANDBY_CANDIDATE", 20902 "FAILURE_STANDBY_UNCONFIG", 20903 "FAILURE_STANDBY_PROMOTION", 20904 "FAILURE_ACTIVE_DEMOTION" 20905 ] 20906 }, 20907 "to": { 20908 "type": "string", 20909 "enum": [ 20910 "UNCONFIGURED", 20911 "ACTIVE_CONFIGURING", 20912 "ACTIVE_CONFIGURED", 20913 "LAUNCHING_STANDBY", 20914 "LAUNCHED_STANDBY", 20915 "ACTIVE_WAIT_STANDBY", 20916 "PENDING_STANDBY_CANDIDATE", 20917 "STANDBY_CANDIDATE", 20918 "STANDBY_CONFIG_RQST", 20919 "STANDBY_CONFIGURING", 20920 "STANDBY_CONFIGURED", 20921 "PENDING_STANDBY_UNCONFIG", 20922 "STANDBY_UNCONFIG", 20923 "PENDING_STANDBY_PROMOTION", 20924 "STANDBY_PROMOTED", 20925 "PENDING_ACTIVE_DEMOTION", 20926 "COPYING_DB", 20927 "COPY_DB_DONE", 20928 "COPYING_FILES", 20929 "COPY_FILES_DONE", 20930 "SYNC_CONFIGURING", 20931 "STANDBY_SYNC", 20932 "STANDBY_BACKGROUND_IMPORT", 20933 "STANDBY_RUNNING", 20934 "UPGRADING", 20935 "FAILURE_ACTIVE_CONFIGURING", 20936 "FAILURE_LAUNCHING_STANDBY", 20937 "FAILURE_STANDBY_CONFIGURING", 20938 "FAILURE_GET_STANDBY_CONFIG", 20939 "FAILURE_COPYING_DB", 20940 "FAILURE_COPYING_FILES", 20941 "FAILURE_SYNC_CONFIGURING", 20942 "FAILURE_BACKGROUND_IMPORT", 20943 "FAILURE_SYNCING_FILES", 20944 "FAILURE_GET_STANDBY_STATUS", 20945 "FAILURE_GET_ACTIVE_STATUS", 20946 "FAILURE_MYSQL_ACTIVE_STATUS", 20947 "FAILURE_MYSQL_STANDBY_STATUS", 20948 "FAILURE_STANDBY_CANDIDATE", 20949 "FAILURE_STANDBY_UNCONFIG", 20950 "FAILURE_STANDBY_PROMOTION", 20951 "FAILURE_ACTIVE_DEMOTION" 20952 ] 20953 }, 20954 "timestamp": { 20955 "type": "string", 20956 "format": "date-time" 20957 } 20958 } 20959 } 20960 }, 20961 "stateTimestamp": { 20962 "type": "string", 20963 "format": "date-time" 20964 }, 20965 "vcoIp": { 20966 "type": "string" 20967 }, 20968 "vcoReplicationIp": { 20969 "type": "string" 20970 }, 20971 "vcoUuid": { 20972 "type": "string" 20973 } 20974 }, 20975 "required": [ 20976 "drState", 20977 "failureDescription", 20978 "role", 20979 "roleTimestamp", 20980 "activeAddress", 20981 "standbyList", 20982 "drVCOUser", 20983 "vcoUuid", 20984 "vcoIp" 20985 ], 20986 "type": "object" 20987 }, 20988 "disaster_recovery_prepare_for_standby": { 20989 "allOf": [ 20990 { 20991 "$ref": "#/definitions/empty_object" 20992 } 20993 ] 20994 }, 20995 "disaster_recovery_prepare_for_standby_result": { 20996 "allOf": [ 20997 { 20998 "$ref": "#/definitions/rows_modified_confirmation" 20999 } 21000 ] 21001 }, 21002 "disaster_recovery_promote_standby_to_active_result": { 21003 "allOf": [ 21004 { 21005 "$ref": "#/definitions/rows_modified_confirmation" 21006 } 21007 ] 21008 }, 21009 "disaster_recovery_remove_standby": { 21010 "allOf": [ 21011 { 21012 "$ref": "#/definitions/empty_object" 21013 } 21014 ] 21015 }, 21016 "disaster_recovery_remove_standby_result": { 21017 "allOf": [ 21018 { 21019 "$ref": "#/definitions/rows_modified_confirmation" 21020 } 21021 ] 21022 }, 21023 "disaster_recovery_transition_to_standby_result": { 21024 "allOf": [ 21025 { 21026 "$ref": "#/definitions/rows_modified_confirmation" 21027 } 21028 ] 21029 }, 21030 "edge_delete_edge_bgp_neighbor_records_result": { 21031 "allOf": [ 21032 { 21033 "$ref": "#/definitions/deletion_confirmation" 21034 } 21035 ] 21036 }, 21037 "edge_delete_edge_result_item": { 21038 "allOf": [ 21039 { 21040 "$ref": "#/definitions/deletion_confirmation" 21041 } 21042 ] 21043 }, 21044 "edge_edge_cancel_reactivation_result": { 21045 "allOf": [ 21046 { 21047 "$ref": "#/definitions/rows_modified_confirmation" 21048 } 21049 ] 21050 }, 21051 "edge_edge_provision_result": { 21052 "properties": { 21053 "id": { 21054 "type": "integer" 21055 }, 21056 "activationKey": { 21057 "type": "string" 21058 }, 21059 "generatedCertificate": { 21060 "type": "object", 21061 "properties": { 21062 "certificate": { 21063 "type": "string" 21064 }, 21065 "ca-certificate": { 21066 "type": "string" 21067 }, 21068 "privateKey": { 21069 "type": "string" 21070 }, 21071 "privateKeyPassword": { 21072 "type": "string" 21073 }, 21074 "csr": { 21075 "type": "string" 21076 } 21077 } 21078 } 21079 }, 21080 "required": [ 21081 "id", 21082 "activationKey" 21083 ] 21084 }, 21085 "edge_edge_request_reactivation_result": { 21086 "properties": { 21087 "activationKey": { 21088 "type": "string" 21089 }, 21090 "activationKeyExpires": { 21091 "format": "date-time", 21092 "type": "string" 21093 } 21094 }, 21095 "required": [ 21096 "activationKey", 21097 "activationKeyExpires" 21098 ] 21099 }, 21100 "edge_get_edge_configuration_stack_result_item": { 21101 "allOf": [ 21102 { 21103 "$ref": "#/definitions/model_configuration" 21104 }, 21105 { 21106 "required": [ 21107 "id", 21108 "created", 21109 "name", 21110 "version", 21111 "description", 21112 "modified", 21113 "modules" 21114 ] 21115 } 21116 ] 21117 }, 21118 "edge_get_edge_result": { 21119 "allOf": [ 21120 { 21121 "$ref": "#/definitions/edge_object" 21122 }, 21123 { 21124 "properties": { 21125 "configuration": { 21126 "$ref": "#/definitions/model_configuration" 21127 }, 21128 "enterprise": { 21129 "$ref": "#/definitions/enterprise" 21130 }, 21131 "links": { 21132 "type": "array", 21133 "items": { 21134 "$ref": "#/definitions/link" 21135 } 21136 }, 21137 "recentLinks": { 21138 "type": "array", 21139 "items": { 21140 "$ref": "#/definitions/link" 21141 } 21142 }, 21143 "site": { 21144 "$ref": "#/definitions/site" 21145 } 21146 }, 21147 "required": [ 21148 "id", 21149 "created", 21150 "enterpriseId", 21151 "siteId", 21152 "activationKey", 21153 "activationKeyExpires", 21154 "activationState", 21155 "activationTime", 21156 "softwareVersion", 21157 "buildNumber", 21158 "softwareUpdated", 21159 "selfMacAddress", 21160 "deviceId", 21161 "logicalId", 21162 "serialNumber", 21163 "modelNumber", 21164 "deviceFamily", 21165 "name", 21166 "dnsName", 21167 "description", 21168 "alertsEnabled", 21169 "operatorAlertsEnabled", 21170 "edgeState", 21171 "edgeStateTime", 21172 "isLive", 21173 "systemUpSince", 21174 "serviceUpSince", 21175 "lastContact", 21176 "serviceState", 21177 "endpointPkiMode", 21178 "haState", 21179 "haPreviousState", 21180 "haLastContact", 21181 "haSerialNumber", 21182 "modified" 21183 ], 21184 "type": "object" 21185 } 21186 ] 21187 }, 21188 "edge_object": { 21189 "properties": { 21190 "activationKey": { 21191 "type": "string" 21192 }, 21193 "activationKeyExpires": { 21194 "type": "string" 21195 }, 21196 "activationState": { 21197 "enum": [ 21198 "UNASSIGNED", 21199 "PENDING", 21200 "ACTIVATED", 21201 "REACTIVATION_PENDING" 21202 ], 21203 "type": "string" 21204 }, 21205 "activationTime": { 21206 "type": "string" 21207 }, 21208 "alertsEnabled": { 21209 "$ref": "#/definitions/tinyint" 21210 }, 21211 "buildNumber": { 21212 "type": "string" 21213 }, 21214 "created": { 21215 "type": "string" 21216 }, 21217 "description": { 21218 "type": "string" 21219 }, 21220 "deviceFamily": { 21221 "type": "string" 21222 }, 21223 "deviceId": { 21224 "type": "string" 21225 }, 21226 "dnsName": { 21227 "type": "string" 21228 }, 21229 "edgeState": { 21230 "enum": [ 21231 "NEVER_ACTIVATED", 21232 "DEGRADED", 21233 "OFFLINE", 21234 "DISABLED", 21235 "EXPIRED", 21236 "CONNECTED" 21237 ], 21238 "type": "string" 21239 }, 21240 "edgeStateTime": { 21241 "type": "string" 21242 }, 21243 "endpointPkiMode": { 21244 "enum": [ 21245 "CERTIFICATE_DISABLED", 21246 "CERTIFICATE_OPTIONAL", 21247 "CERTIFICATE_REQUIRED" 21248 ], 21249 "type": "string" 21250 }, 21251 "enterpriseId": { 21252 "type": "integer" 21253 }, 21254 "haLastContact": { 21255 "type": "string" 21256 }, 21257 "haPreviousState": { 21258 "enum": [ 21259 "UNCONFIGURED", 21260 "PENDING_INIT", 21261 "PENDING_CONFIRMATION", 21262 "PENDING_CONFIRMED", 21263 "PENDING_DISSOCIATION", 21264 "READY", 21265 "FAILED" 21266 ], 21267 "type": "string" 21268 }, 21269 "haSerialNumber": { 21270 "type": "string" 21271 }, 21272 "haState": { 21273 "enum": [ 21274 "UNCONFIGURED", 21275 "PENDING_INIT", 21276 "PENDING_CONFIRMATION", 21277 "PENDING_CONFIRMED", 21278 "PENDING_DISSOCIATION", 21279 "READY", 21280 "FAILED" 21281 ], 21282 "type": "string" 21283 }, 21284 "id": { 21285 "type": "integer" 21286 }, 21287 "isLive": { 21288 "type": "integer" 21289 }, 21290 "lastContact": { 21291 "type": "string" 21292 }, 21293 "logicalId": { 21294 "type": "string" 21295 }, 21296 "modelNumber": { 21297 "type": "string" 21298 }, 21299 "modified": { 21300 "type": "string" 21301 }, 21302 "name": { 21303 "type": "string" 21304 }, 21305 "operatorAlertsEnabled": { 21306 "$ref": "#/definitions/tinyint" 21307 }, 21308 "selfMacAddress": { 21309 "type": "string" 21310 }, 21311 "serialNumber": { 21312 "type": "string" 21313 }, 21314 "serviceState": { 21315 "enum": [ 21316 "IN_SERVICE", 21317 "OUT_OF_SERVICE", 21318 "PENDING_SERVICE" 21319 ], 21320 "type": "string" 21321 }, 21322 "serviceUpSince": { 21323 "type": "string" 21324 }, 21325 "siteId": { 21326 "type": "integer" 21327 }, 21328 "softwareUpdated": { 21329 "type": "string" 21330 }, 21331 "softwareVersion": { 21332 "type": "string" 21333 }, 21334 "systemUpSince": { 21335 "type": "string" 21336 } 21337 }, 21338 "type": "object" 21339 }, 21340 "edge_set_edge_hand_off_gateways_result": { 21341 "allOf": [ 21342 { 21343 "$ref": "#/definitions/rows_modified_confirmation" 21344 } 21345 ] 21346 }, 21347 "edge_update_edge_admin_password_result": { 21348 "properties": { 21349 "id": { 21350 "description": "The ID of the action queued", 21351 "type": "string" 21352 } 21353 }, 21354 "required": [ 21355 "id" 21356 ], 21357 "type": "object" 21358 }, 21359 "set_client_device_host_name_result": { 21360 "allOf": [ 21361 { 21362 "$ref": "#/definitions/rows_modified_confirmation" 21363 } 21364 ] 21365 }, 21366 "edge_update_edge_attributes_result": { 21367 "allOf": [ 21368 { 21369 "$ref": "#/definitions/rows_modified_confirmation" 21370 } 21371 ] 21372 }, 21373 "edge_update_edge_credentials_by_configuration_result": { 21374 "properties": { 21375 "actionIds": { 21376 "items": { 21377 "type": "integer" 21378 }, 21379 "type": "array" 21380 } 21381 }, 21382 "required": [ 21383 "actionIds" 21384 ], 21385 "type": "object" 21386 }, 21387 "edge_set_edge_operator_configuration_result": { 21388 "allOf": [ 21389 { 21390 "$ref": "#/definitions/insertion_confirmation" 21391 } 21392 ] 21393 }, 21394 "enterprise_set_enterprise_operator_configuration_result": { 21395 "allOf": [ 21396 { 21397 "$ref": "#/definitions/insertion_confirmation" 21398 } 21399 ] 21400 }, 21401 "edge_set_edge_enterprise_configuration_result": { 21402 "allOf": [ 21403 { 21404 "$ref": "#/definitions/insertion_confirmation" 21405 } 21406 ] 21407 }, 21408 "enterprise_alert_notification_user_data": { 21409 "properties": { 21410 "email": { 21411 "type": "string" 21412 }, 21413 "emailEnabled": { 21414 "type": "integer" 21415 }, 21416 "enabled": { 21417 "type": "integer" 21418 }, 21419 "enterpriseUserId": { 21420 "type": "integer" 21421 }, 21422 "mobileEnabled": { 21423 "type": "integer" 21424 }, 21425 "mobilePhone": { 21426 "type": "string" 21427 }, 21428 "smsEnabled": { 21429 "type": "integer" 21430 }, 21431 "username": { 21432 "type": "string" 21433 } 21434 }, 21435 "required": [ 21436 "email", 21437 "emailEnabled", 21438 "enabled", 21439 "enterpriseUserId", 21440 "mobileEnabled", 21441 "mobilePhone", 21442 "smsEnabled", 21443 "username" 21444 ], 21445 "type": "object" 21446 }, 21447 "enterprise_delete_enterprise_delete_enterprise_gateway_records_record": { 21448 "properties": { 21449 "gatewayId": { 21450 "type": "integer" 21451 }, 21452 "neighborIp": { 21453 "type": "string" 21454 } 21455 }, 21456 "type": "object" 21457 }, 21458 "enterprise_delete_enterprise_gateway_records_result": { 21459 "allOf": [ 21460 { 21461 "$ref": "#/definitions/deletion_confirmation" 21462 } 21463 ] 21464 }, 21465 "enterprise_delete_enterprise_network_allocation_result": { 21466 "allOf": [ 21467 { 21468 "$ref": "#/definitions/deletion_confirmation" 21469 } 21470 ] 21471 }, 21472 "enterprise_delete_enterprise_result": { 21473 "allOf": [ 21474 { 21475 "$ref": "#/definitions/deletion_confirmation" 21476 } 21477 ] 21478 }, 21479 "enterprise_delete_enterprise_service_result": { 21480 "allOf": [ 21481 { 21482 "$ref": "#/definitions/deletion_confirmation" 21483 } 21484 ] 21485 }, 21486 "enterprise_enterprise_proxy": { 21487 "allOf": [ 21488 { 21489 "$ref": "#/definitions/enterprise_proxy" 21490 }, 21491 { 21492 "required": [ 21493 "id", 21494 "created", 21495 "networkId", 21496 "proxyType", 21497 "operateGateways", 21498 "logicalId", 21499 "name", 21500 "domain", 21501 "prefix", 21502 "description", 21503 "contactName", 21504 "contactPhone", 21505 "contactMobile", 21506 "contactEmail", 21507 "streetAddress", 21508 "streetAddress2", 21509 "city", 21510 "state", 21511 "postalCode", 21512 "country", 21513 "lat", 21514 "lon", 21515 "modified" 21516 ] 21517 } 21518 ] 21519 }, 21520 "enterprise_get_enterprise_addresses_result_item": { 21521 "properties": { 21522 "address": { 21523 "type": "string" 21524 }, 21525 "entity": { 21526 "enum": [ 21527 "ACTIVE_VCO", 21528 "STANDBY_VCO", 21529 "GATEWAY", 21530 "DATACENTER" 21531 ], 21532 "type": "string" 21533 } 21534 }, 21535 "type": "object" 21536 }, 21537 "enterprise_get_enterprise_alert_configurations_result_item": { 21538 "allOf": [ 21539 { 21540 "$ref": "#/definitions/enterprise_alert_configuration" 21541 }, 21542 { 21543 "required": [ 21544 "id", 21545 "created", 21546 "alertDefinitionId", 21547 "enterpriseId", 21548 "enabled", 21549 "name", 21550 "description", 21551 "type", 21552 "definition", 21553 "firstNotificationSeconds", 21554 "maxNotifications", 21555 "notificationIntervalSeconds", 21556 "resetIntervalSeconds", 21557 "modified" 21558 ] 21559 } 21560 ] 21561 }, 21562 "enterprise_get_enterprise_alerts_result_item": { 21563 "allOf": [ 21564 { 21565 "$ref": "#/definitions/enterprise_alert_trigger" 21566 }, 21567 { 21568 "required": [ 21569 "id", 21570 "created", 21571 "triggerTime", 21572 "enterpriseAlertConfigurationId", 21573 "enterpriseId", 21574 "edgeId", 21575 "edgeName", 21576 "linkId", 21577 "linkName", 21578 "enterpriseObjectId", 21579 "enterpriseObjectName", 21580 "name", 21581 "type", 21582 "state", 21583 "stateSetTime", 21584 "lastContact", 21585 "firstNotificationSeconds", 21586 "maxNotifications", 21587 "notificationIntervalSeconds", 21588 "resetIntervalSeconds", 21589 "comment", 21590 "nextNotificationTime", 21591 "remainingNotifications", 21592 "timezone", 21593 "locale", 21594 "modified" 21595 ] 21596 } 21597 ] 21598 }, 21599 "enterprise_get_enterprise_all_alert_recipients_result": { 21600 "properties": { 21601 "emailEnabled": { 21602 "type": "boolean" 21603 }, 21604 "emailList": { 21605 "items": { 21606 "type": "string" 21607 }, 21608 "type": "array" 21609 }, 21610 "enterpriseUsers": { 21611 "items": { 21612 "$ref": "#/definitions/enterprise_alert_notification_user_data" 21613 }, 21614 "type": "array" 21615 }, 21616 "mobileEnabled": { 21617 "type": "boolean" 21618 }, 21619 "mobileList": { 21620 "items": { 21621 "type": "string" 21622 }, 21623 "type": "array" 21624 }, 21625 "smsEnabled": { 21626 "type": "boolean" 21627 }, 21628 "smsList": { 21629 "items": { 21630 "type": "string" 21631 }, 21632 "type": "array" 21633 }, 21634 "snmpEnabled": { 21635 "type": "boolean" 21636 }, 21637 "snmpList": { 21638 "items": { 21639 "type": "string" 21640 }, 21641 "type": "array" 21642 } 21643 }, 21644 "required": [ 21645 "emailEnabled", 21646 "emailList", 21647 "enterpriseUsers", 21648 "mobileEnabled", 21649 "mobileList", 21650 "smsEnabled", 21651 "smsList" 21652 ], 21653 "type": "object" 21654 }, 21655 "enterprise_get_enterprise_capabilities_result": { 21656 "type": "object", 21657 "properties": { 21658 "edgeVnfs.enable": { 21659 "type": "boolean" 21660 }, 21661 "edgeVnfs.securityVnf.paloAlto": { 21662 "type": "boolean" 21663 }, 21664 "edgeVnfs.securityVnf.checkpoint": { 21665 "type": "boolean" 21666 }, 21667 "edgeVnfs.securityVnf.fortinet": { 21668 "type": "boolean" 21669 }, 21670 "enableBGP": { 21671 "type": "boolean" 21672 }, 21673 "enableCosMapping": { 21674 "type": "boolean" 21675 }, 21676 "enableEnterpriseAuth": { 21677 "type": "boolean" 21678 }, 21679 "enableFwLogs": { 21680 "type": "boolean" 21681 }, 21682 "enableStatefulFirewall": { 21683 "type": "boolean" 21684 }, 21685 "enableNetworks": { 21686 "type": "boolean" 21687 }, 21688 "enableOSPF": { 21689 "type": "boolean" 21690 }, 21691 "enablePKI": { 21692 "type": "boolean" 21693 }, 21694 "enablePremium": { 21695 "type": "boolean" 21696 }, 21697 "enableSegmentation": { 21698 "type": "boolean" 21699 }, 21700 "enableServiceRateLimiting": { 21701 "type": "boolean" 21702 }, 21703 "enableVQM": { 21704 "type": "boolean" 21705 } 21706 }, 21707 "example": { 21708 "edgeVnfs.enable": true, 21709 "edgeVnfs.securityVnf.paloAlto": true, 21710 "edgeVnfs.securityVnf.checkpoint": true, 21711 "edgeVnfs.securityVnf.fortinet": true, 21712 "enableBGP": false, 21713 "enableCosMapping": true, 21714 "enableEnterpriseAuth": true, 21715 "enableFwLogs": false, 21716 "enableStatefulFirewall": false, 21717 "enableNetworks": true, 21718 "enableOSPF": true, 21719 "enablePKI": true, 21720 "enablePremium": true, 21721 "enableSegmentation": true, 21722 "enableServiceRateLimiting": false, 21723 "enableVQM": true 21724 } 21725 }, 21726 "enterprise_get_enterprise_configurations_with_policies": { 21727 "title": "enterprise_get_enterprise_configurations_with_policies", 21728 "type": "object", 21729 "properties": { 21730 "enterpriseId": { 21731 "type": "integer" 21732 } 21733 } 21734 }, 21735 "enterprise_get_enterprise_configurations_with_policies_result": { 21736 "title": "enterprise_get_enterprise_configurations_with_policies_result", 21737 "type": "array", 21738 "items": { 21739 "type": "object", 21740 "properties": { 21741 "configurationType": { 21742 "type": "string", 21743 "enum": [ 21744 "NETWORK_BASED", 21745 "SEGMENT_BASED" 21746 ] 21747 }, 21748 "created": { 21749 "type": "string" 21750 }, 21751 "description": { 21752 "type": "string" 21753 }, 21754 "edgeCount": { 21755 "type": "integer" 21756 }, 21757 "effective": { 21758 "type": "string" 21759 }, 21760 "id": { 21761 "type": "integer" 21762 }, 21763 "isStaging": { 21764 "type": "integer" 21765 }, 21766 "logicalId": { 21767 "type": "string" 21768 }, 21769 "modified": { 21770 "type": "string" 21771 }, 21772 "name": { 21773 "type": "string" 21774 }, 21775 "policies": { 21776 "type": "object", 21777 "properties": { 21778 "bizPolicyEnabled": { 21779 "type": "boolean" 21780 }, 21781 "deviceSettingsEnabled": { 21782 "type": "boolean" 21783 }, 21784 "firewall": { 21785 "type": "string", 21786 "enum": [ 21787 "none", 21788 "enabled", 21789 "disabled" 21790 ] 21791 } 21792 }, 21793 "required": [ 21794 "bizPolicyEnabled", 21795 "deviceSettingsEnabled", 21796 "firewall" 21797 ] 21798 }, 21799 "schemaVersion": { 21800 "type": "string" 21801 }, 21802 "version": { 21803 "type": "string" 21804 } 21805 } 21806 } 21807 }, 21808 "enterprise_get_enterprise_configurations_result_item": { 21809 "allOf": [ 21810 { 21811 "$ref": "#/definitions/model_configuration" 21812 }, 21813 { 21814 "required": [ 21815 "id", 21816 "created", 21817 "name", 21818 "version", 21819 "description", 21820 "effective", 21821 "modified" 21822 ] 21823 } 21824 ] 21825 }, 21826 "enterprise_get_enterprise_operator_configuration_type": { 21827 "title": "enterprise_get_enterprise_operator_configuration_type", 21828 "type": "object", 21829 "properties": { 21830 "enterpriseId": { 21831 "type": "integer" 21832 } 21833 } 21834 }, 21835 "enterprise_get_enterprise_operator_configuration_type_result": { 21836 "title": "enterprise_get_enterprise_operator_configuration_type_result", 21837 "type": "object", 21838 "properties": { 21839 "configurationType": { 21840 "type": "string", 21841 "enum": [ 21842 "NETWORK_BASED", 21843 "SEGMENT_BASED" 21844 ] 21845 } 21846 }, 21847 "required": [ 21848 "configurationType" 21849 ] 21850 }, 21851 "enterprise_get_enterprise_edges_result_item": { 21852 "allOf": [ 21853 { 21854 "$ref": "#/definitions/edge_object" 21855 }, 21856 { 21857 "properties": { 21858 "certificates": { 21859 "type": "array", 21860 "items": { 21861 "$ref": "#/definitions/edge_certificate" 21862 } 21863 }, 21864 "configuration": { 21865 "type": "object", 21866 "properties": { 21867 "operator": { 21868 "type": "object", 21869 "properties": { 21870 "id": { 21871 "type": "integer" 21872 }, 21873 "modules": { 21874 "type": "array", 21875 "items": { 21876 "type": "object", 21877 "properties": { 21878 "isEdgeSpecific": { 21879 "type": "integer", 21880 "enum": [ 21881 0, 21882 1 21883 ] 21884 }, 21885 "name": { 21886 "type": "string" 21887 }, 21888 "type": { 21889 "type": "string", 21890 "enum": [ 21891 "ENTERPRISE", 21892 "OPERATOR", 21893 "GATEWAY" 21894 ] 21895 }, 21896 "version": { 21897 "type": "string" 21898 } 21899 } 21900 } 21901 }, 21902 "name": { 21903 "type": "string" 21904 } 21905 } 21906 }, 21907 "enterprise": { 21908 "type": "object", 21909 "properties": { 21910 "id": { 21911 "type": "integer" 21912 }, 21913 "modules": { 21914 "type": "array", 21915 "items": { 21916 "type": "object", 21917 "properties": { 21918 "edgeSpecificData": { 21919 "type": "object" 21920 }, 21921 "isEdgeSpecific": { 21922 "type": "integer", 21923 "enum": [ 21924 0, 21925 1 21926 ] 21927 }, 21928 "name": { 21929 "type": "string" 21930 }, 21931 "type": { 21932 "type": "string", 21933 "enum": [ 21934 "ENTERPRISE", 21935 "OPERATOR", 21936 "GATEWAY" 21937 ] 21938 }, 21939 "version": { 21940 "type": "string" 21941 } 21942 } 21943 } 21944 }, 21945 "name": { 21946 "type": "string" 21947 } 21948 } 21949 } 21950 } 21951 }, 21952 "ha": { 21953 "type": "object", 21954 "properties": { 21955 "type": { 21956 "type": "string", 21957 "enum": [ 21958 "ACTIVE_ACTIVE", 21959 "ACTIVE_STANDBY", 21960 "VRRP" 21961 ] 21962 }, 21963 "data": { 21964 "type": "object" 21965 } 21966 } 21967 }, 21968 "licenses": { 21969 "type": "array", 21970 "items": { 21971 "$ref": "#/definitions/edge_license" 21972 } 21973 }, 21974 "links": { 21975 "type": "array", 21976 "items": { 21977 "$ref": "#/definitions/link" 21978 } 21979 }, 21980 "recentLinks": { 21981 "type": "array", 21982 "items": { 21983 "$ref": "#/definitions/link" 21984 } 21985 }, 21986 "site": { 21987 "$ref": "#/definitions/site" 21988 }, 21989 "isHub": { 21990 "type": "boolean" 21991 }, 21992 "isSoftwareVersionSupportedByVco": { 21993 "type": "boolean" 21994 } 21995 }, 21996 "required": [ 21997 "id", 21998 "created", 21999 "enterpriseId", 22000 "siteId", 22001 "activationKey", 22002 "activationKeyExpires", 22003 "activationState", 22004 "activationTime", 22005 "softwareVersion", 22006 "buildNumber", 22007 "softwareUpdated", 22008 "selfMacAddress", 22009 "deviceId", 22010 "logicalId", 22011 "serialNumber", 22012 "modelNumber", 22013 "deviceFamily", 22014 "name", 22015 "dnsName", 22016 "description", 22017 "alertsEnabled", 22018 "operatorAlertsEnabled", 22019 "edgeState", 22020 "edgeStateTime", 22021 "isLive", 22022 "systemUpSince", 22023 "serviceUpSince", 22024 "lastContact", 22025 "serviceState", 22026 "endpointPkiMode", 22027 "haState", 22028 "haPreviousState", 22029 "haLastContact", 22030 "haSerialNumber", 22031 "modified" 22032 ], 22033 "type": "object" 22034 } 22035 ] 22036 }, 22037 "edge_list_ha_details_active_standby": { 22038 "type": "object", 22039 "properties": { 22040 "haLastContact": { 22041 "type": "string", 22042 "format": "date-time" 22043 }, 22044 "haPreviousState": { 22045 "type": "string", 22046 "enum": [ 22047 "UNCONFIGURED", 22048 "PENDING_INIT", 22049 "PENDING_CONFIRMATION", 22050 "PENDING_CONFIRMED", 22051 "PENDING_DISSOCIATION", 22052 "READY", 22053 "FAILED" 22054 ] 22055 }, 22056 "haSerialNumber": { 22057 "type": "string" 22058 }, 22059 "haState": { 22060 "type": "string", 22061 "enum": [ 22062 "UNCONFIGURED", 22063 "PENDING_INIT", 22064 "PENDING_CONFIRMATION", 22065 "PENDING_CONFIRMED", 22066 "PENDING_DISSOCIATION", 22067 "READY", 22068 "FAILED" 22069 ] 22070 } 22071 }, 22072 "required": [ 22073 "haLastContact", 22074 "haPreviousState", 22075 "haSerialNumber", 22076 "haState" 22077 ] 22078 }, 22079 "edge_list_ha_details_active_active": { 22080 "type": "object", 22081 "properties": { 22082 "clusterId": { 22083 "type": "integer" 22084 }, 22085 "clusterName": { 22086 "type": "string" 22087 } 22088 }, 22089 "required": [ 22090 "clusterId", 22091 "clusterName" 22092 ] 22093 }, 22094 "edge_list_ha_details_vrrp": { 22095 "type": "array", 22096 "items": { 22097 "$ref": "#/definitions/device_settings_vrrp_virtual_router" 22098 } 22099 }, 22100 "enterprise_get_enterprise_network_allocation_result": { 22101 "allOf": [ 22102 { 22103 "$ref": "#/definitions/enterprise_object_base" 22104 } 22105 ] 22106 }, 22107 "enterprise_get_enterprise_network_allocations_result_item": { 22108 "allOf": [ 22109 { 22110 "$ref": "#/definitions/enterprise_object_base" 22111 } 22112 ] 22113 }, 22114 "enterprise_get_enterprise_result": { 22115 "allOf": [ 22116 { 22117 "$ref": "#/definitions/enterprise" 22118 }, 22119 { 22120 "properties": { 22121 "enterpriseProxy": { 22122 "$ref": "#/definitions/enterprise_enterprise_proxy" 22123 } 22124 }, 22125 "required": [ 22126 "domain", 22127 "contactPhone", 22128 "locale", 22129 "alertsEnabled", 22130 "endpointPkiMode", 22131 "contactEmail", 22132 "prefix", 22133 "contactName", 22134 "timezone", 22135 "id", 22136 "gatewayPoolId", 22137 "networkId", 22138 "city", 22139 "lon", 22140 "state", 22141 "streetAddress", 22142 "postalCode", 22143 "streetAddress2", 22144 "description", 22145 "accountNumber", 22146 "contactMobile", 22147 "lat", 22148 "logicalId", 22149 "operatorAlertsEnabled", 22150 "name", 22151 "created", 22152 "country", 22153 "modified" 22154 ] 22155 } 22156 ] 22157 }, 22158 "enterprise_get_enterprise_route_configuration_result": { 22159 "allOf": [ 22160 { 22161 "$ref": "#/definitions/enterprise_object_base" 22162 } 22163 ] 22164 }, 22165 "exit_entity_type": { 22166 "title": "exit_entity_type", 22167 "type": "object", 22168 "properties": { 22169 "id": { 22170 "type": "integer" 22171 }, 22172 "name": { 22173 "type": "string" 22174 }, 22175 "logicalId": { 22176 "type": "string" 22177 }, 22178 "type": { 22179 "type": "string" 22180 } 22181 }, 22182 "required": [ 22183 "id", 22184 "logicalId", 22185 "name" 22186 ] 22187 }, 22188 "enterprise_get_enterprise_route_table_result": { 22189 "properties": { 22190 "profiles": { 22191 "items": { 22192 "allOf": [ 22193 { 22194 "$ref": "#/definitions/model_configuration" 22195 }, 22196 { 22197 "required": [ 22198 "id", 22199 "description", 22200 "name" 22201 ] 22202 } 22203 ], 22204 "type": "object" 22205 }, 22206 "type": "array" 22207 }, 22208 "subnets": { 22209 "items": { 22210 "$ref": "#/definitions/enterprise_route_collection" 22211 }, 22212 "type": "array" 22213 }, 22214 "exits": { 22215 "type": "object", 22216 "properties": { 22217 "edges": { 22218 "type": "array", 22219 "items": { 22220 "$ref": "#/definitions/exit_entity_type" 22221 } 22222 }, 22223 "hubs": { 22224 "type": "array", 22225 "items": { 22226 "$ref": "#/definitions/exit_entity_type" 22227 } 22228 }, 22229 "gateways": { 22230 "type": "array", 22231 "items": { 22232 "$ref": "#/definitions/exit_entity_type" 22233 } 22234 }, 22235 "nvs": { 22236 "type": "array", 22237 "items": { 22238 "$ref": "#/definitions/exit_entity_type" 22239 } 22240 } 22241 }, 22242 "required": [ 22243 "edges", 22244 "hubs", 22245 "nvs", 22246 "gateways" 22247 ] 22248 } 22249 }, 22250 "type": "object" 22251 }, 22252 "enterprise_get_enterprise_services_result_item": { 22253 "allOf": [ 22254 { 22255 "$ref": "#/definitions/enterprise_object_base" 22256 }, 22257 { 22258 "type": "object", 22259 "properties": { 22260 "profileCount": { 22261 "type": "integer" 22262 }, 22263 "edgeCount": { 22264 "type": "integer" 22265 }, 22266 "groupCount": { 22267 "type": "integer" 22268 } 22269 } 22270 } 22271 ] 22272 }, 22273 "enterprise_object": { 22274 "allOf": [ 22275 { 22276 "$ref": "#/definitions/site" 22277 }, 22278 { 22279 "type": "object", 22280 "properties": { 22281 "gatewayPoolId": { 22282 "type": "integer" 22283 }, 22284 "networkId": { 22285 "type": "integer" 22286 }, 22287 "returnData": { 22288 "type": "boolean" 22289 }, 22290 "user": { 22291 "$ref": "#/definitions/auth_object" 22292 } 22293 } 22294 } 22295 ] 22296 }, 22297 "enterprise_insert_enterprise_network_allocation_result": { 22298 "allOf": [ 22299 { 22300 "$ref": "#/definitions/insertion_confirmation" 22301 } 22302 ] 22303 }, 22304 "enterprise_insert_enterprise_network_segment_result": { 22305 "allOf": [ 22306 { 22307 "$ref": "#/definitions/insertion_confirmation" 22308 } 22309 ] 22310 }, 22311 "enterprise_insert_enterprise": { 22312 "allOf": [ 22313 { 22314 "$ref": "#/definitions/enterprise_object" 22315 }, 22316 { 22317 "type": "object", 22318 "properties": { 22319 "configurationId": { 22320 "type": "integer" 22321 }, 22322 "enableEnterpriseDelegationToOperator": { 22323 "type": "boolean" 22324 }, 22325 "enableEnterpriseDelegationToProxy": { 22326 "type": "boolean" 22327 }, 22328 "enableEnterpriseUserManagementDelegationToOperator": { 22329 "type": "boolean" 22330 }, 22331 "licenses": { 22332 "type": "object", 22333 "properties": { 22334 "ids": { 22335 "type": "array", 22336 "items": { 22337 "type": "integer" 22338 } 22339 } 22340 } 22341 } 22342 }, 22343 "required": [ 22344 "configurationId", 22345 "name" 22346 ] 22347 } 22348 ] 22349 }, 22350 "enterprise_insert_enterprise_result": { 22351 "allOf": [ 22352 { 22353 "$ref": "#/definitions/insertion_confirmation" 22354 } 22355 ] 22356 }, 22357 "enterprise_update_enterprise": { 22358 "allOf": [ 22359 { 22360 "$ref": "#/definitions/site" 22361 }, 22362 { 22363 "type": "object", 22364 "properties": { 22365 "gatewayPoolId": { 22366 "type": "integer" 22367 }, 22368 "networkId": { 22369 "type": "integer" 22370 }, 22371 "returnData": { 22372 "type": "boolean" 22373 }, 22374 "user": { 22375 "type": "object", 22376 "additionalProperties": false, 22377 "properties": { 22378 "email": { 22379 "type": "string" 22380 }, 22381 "username": { 22382 "type": "string" 22383 }, 22384 "password": { 22385 "type": "string" 22386 } 22387 } 22388 } 22389 } 22390 } 22391 ] 22392 }, 22393 "enterprise_update_enterprise_result": { 22394 "$ref": "#/definitions/rows_modified_confirmation" 22395 }, 22396 "enterprise_proxy_insert_enterprise_proxy_enterprise": { 22397 "allOf": [ 22398 { 22399 "$ref": "#/definitions/enterprise_insert_enterprise" 22400 }, 22401 { 22402 "type": "object", 22403 "properties": { 22404 "enterpriseProxyId": { 22405 "type": "integer" 22406 } 22407 } 22408 } 22409 ] 22410 }, 22411 "enterprise_proxy_insert_enterprise_proxy_enterprise_result": { 22412 "allOf": [ 22413 { 22414 "$ref": "#/definitions/enterprise_insert_enterprise_result" 22415 } 22416 ] 22417 }, 22418 "enterprise_proxy_get_enterprise_proxy_enterprises_result_item": { 22419 "allOf": [ 22420 { 22421 "$ref": "#/definitions/enterprise" 22422 }, 22423 { 22424 "type": "object", 22425 "properties": { 22426 "edgeCount": { 22427 "type": "integer" 22428 }, 22429 "edges": { 22430 "type": "array", 22431 "items": { 22432 "$ref": "#/definitions/enterprise_object" 22433 } 22434 } 22435 } 22436 } 22437 ] 22438 }, 22439 "proxy_edge_inventory_object": { 22440 "type": "object", 22441 "properties": { 22442 "enterpriseName": { 22443 "type": "string" 22444 }, 22445 "enterpriseId": { 22446 "type": "integer" 22447 }, 22448 "edgeName": { 22449 "type": "string" 22450 }, 22451 "edgeId": { 22452 "type": "integer" 22453 }, 22454 "created": { 22455 "type": "string", 22456 "format": "date-time" 22457 }, 22458 "edgeState": { 22459 "type": "string", 22460 "enum": [ 22461 "NEVER_ACTIVATED", 22462 "DEGRADED", 22463 "OFFLINE", 22464 "DISABLED", 22465 "EXPIRED", 22466 "CONNECTED" 22467 ] 22468 }, 22469 "serialNumber": { 22470 "type": "string" 22471 }, 22472 "haSerialNumber": { 22473 "type": "string" 22474 }, 22475 "activationState": { 22476 "type": "string", 22477 "enum": [ 22478 "UNASSIGNED", 22479 "PENDING", 22480 "ACTIVATED", 22481 "REACTIVATION_PENDING" 22482 ] 22483 }, 22484 "activationTime": { 22485 "type": "string", 22486 "format": "date-time" 22487 }, 22488 "modelNumber": { 22489 "type": "string" 22490 }, 22491 "softwareVersion": { 22492 "type": "string" 22493 }, 22494 "softwareUpdated": { 22495 "type": "string", 22496 "format": "date-time" 22497 }, 22498 "lastContact": { 22499 "type": "string", 22500 "format": "date-time" 22501 } 22502 }, 22503 "required": [ 22504 "enterpriseName", 22505 "enterpriseId", 22506 "edgeName", 22507 "edgeId", 22508 "created", 22509 "edgeState", 22510 "serialNumber", 22511 "haSerialNumber", 22512 "activationState", 22513 "activationTime", 22514 "modelNumber", 22515 "softwareVersion", 22516 "softwareUpdated", 22517 "lastContact" 22518 ] 22519 }, 22520 "enterprise_proxy_get_enterprise_proxy_edge_inventory_result_item": { 22521 "allOf": [ 22522 { 22523 "$ref": "#/definitions/proxy_edge_inventory_object" 22524 } 22525 ] 22526 }, 22527 "enterprise_proxy_get_enterprise_proxy_operator_profiles_result_item": { 22528 "allOf": [ 22529 { 22530 "$ref": "#/definitions/model_configuration" 22531 }, 22532 { 22533 "type": "object", 22534 "properties": { 22535 "edges": { 22536 "type": "array", 22537 "items": { 22538 "$ref": "#/definitions/edge_object" 22539 } 22540 }, 22541 "enterprises": { 22542 "type": "array", 22543 "items": { 22544 "$ref": "#/definitions/configuration_enterprise" 22545 } 22546 } 22547 }, 22548 "required": [ 22549 "id", 22550 "created", 22551 "name", 22552 "version", 22553 "description", 22554 "effective", 22555 "modified" 22556 ] 22557 } 22558 ] 22559 }, 22560 "enterprise_insert_enterprise_service_result": { 22561 "allOf": [ 22562 { 22563 "$ref": "#/definitions/insertion_confirmation" 22564 } 22565 ] 22566 }, 22567 "enterprise_insert_or_update_enterprise_alert_configurations_result": { 22568 "type": "object", 22569 "properties": { 22570 "enterpriseAlertConfigurations": { 22571 "type": "array", 22572 "items": { 22573 "$ref": "#/definitions/enterprise_alert_configuration" 22574 } 22575 } 22576 } 22577 }, 22578 "enterprise_insert_or_update_enterprise_capability_result": { 22579 "allOf": [ 22580 { 22581 "$ref": "#/definitions/insertion_confirmation" 22582 } 22583 ] 22584 }, 22585 "enterprise_set_enterprise_maximum_segments_result": { 22586 "allOf": [ 22587 { 22588 "$ref": "#/definitions/insertion_confirmation" 22589 } 22590 ] 22591 }, 22592 "enterprise_insert_or_update_enterprise_property_result": { 22593 "allOf": [ 22594 { 22595 "$ref": "#/definitions/insertion_confirmation" 22596 } 22597 ] 22598 }, 22599 "enterprise_property": { 22600 "type": "object", 22601 "properties": { 22602 "id": { 22603 "type": "integer" 22604 }, 22605 "enterpriseId": { 22606 "type": "integer" 22607 }, 22608 "created": { 22609 "type": "string", 22610 "format": "date-time" 22611 }, 22612 "name": { 22613 "type": "string" 22614 }, 22615 "value": { 22616 "type": "string" 22617 }, 22618 "isPassword": { 22619 "type": "boolean" 22620 }, 22621 "dataType": { 22622 "type": "string", 22623 "enum": [ 22624 "STRING", 22625 "NUMBER", 22626 "BOOLEAN", 22627 "JSON", 22628 "DATE", 22629 "DATETIME" 22630 ] 22631 }, 22632 "description": { 22633 "type": "string" 22634 }, 22635 "modified": { 22636 "type": "string", 22637 "format": "date-time" 22638 } 22639 } 22640 }, 22641 "enterprise_get_enterprise_property_result": { 22642 "allOf": [ 22643 { 22644 "$ref": "#/definitions/enterprise_property" 22645 }, 22646 { 22647 "required": [ 22648 "id", 22649 "created", 22650 "name", 22651 "enterpriseId", 22652 "value", 22653 "isPassword", 22654 "dataType", 22655 "description", 22656 "modified" 22657 ] 22658 } 22659 ] 22660 }, 22661 "enterprise_get_enterprise_gateway_handoff_result": { 22662 "allOf": [ 22663 { 22664 "$ref": "#/definitions/gateway_handoff" 22665 }, 22666 { 22667 "type": "object", 22668 "properties": { 22669 "id": { 22670 "type": "integer" 22671 }, 22672 "created": { 22673 "type": "string", 22674 "format": "date-time" 22675 }, 22676 "name": { 22677 "type": "string" 22678 }, 22679 "isPassword": { 22680 "type": "boolean" 22681 }, 22682 "dataType": { 22683 "type": "string" 22684 }, 22685 "description": { 22686 "type": "string" 22687 }, 22688 "modified": { 22689 "type": "string", 22690 "format": "date-time" 22691 } 22692 }, 22693 "required": [ 22694 "enterpriseId", 22695 "value" 22696 ] 22697 } 22698 ] 22699 }, 22700 "enterprise_insert_or_update_enterprise_gateway_handoff": { 22701 "allOf": [ 22702 { 22703 "$ref": "#/definitions/gateway_handoff" 22704 } 22705 ] 22706 }, 22707 "enterprise_insert_or_update_enterprise_gateway_handoff_result": { 22708 "allOf": [ 22709 { 22710 "$ref": "#/definitions/insertion_confirmation" 22711 } 22712 ] 22713 }, 22714 "enterprise_proxy_get_enterprise_proxy_gateway_pools_result_item": { 22715 "allOf": [ 22716 { 22717 "$ref": "#/definitions/gateway_pool" 22718 }, 22719 { 22720 "properties": { 22721 "enterprises": { 22722 "items": { 22723 "$ref": "#/definitions/enterprise" 22724 }, 22725 "type": "array" 22726 }, 22727 "gateways": { 22728 "items": { 22729 "$ref": "#/definitions/gateway_pool_gateway" 22730 }, 22731 "type": "array" 22732 } 22733 } 22734 } 22735 ] 22736 }, 22737 "enterprise_route_collection": { 22738 "properties": { 22739 "eligableExits": { 22740 "items": { 22741 "$ref": "#/definitions/enterprise_route" 22742 }, 22743 "type": "array" 22744 }, 22745 "preferredExits": { 22746 "items": { 22747 "$ref": "#/definitions/enterprise_route" 22748 }, 22749 "type": "array" 22750 }, 22751 "subnet": { 22752 "type": "string" 22753 } 22754 }, 22755 "type": "object" 22756 }, 22757 "enterprise_set_enterprise_all_alert_recipients_result": { 22758 "allOf": [ 22759 { 22760 "$ref": "#/definitions/enterprise_get_enterprise_all_alert_recipients_result" 22761 } 22762 ] 22763 }, 22764 "enterprise_update_enterprise_network_allocation_result": { 22765 "allOf": [ 22766 { 22767 "$ref": "#/definitions/rows_modified_confirmation" 22768 } 22769 ] 22770 }, 22771 "enterprise_update_enterprise_network_segment_result": { 22772 "allOf": [ 22773 { 22774 "$ref": "#/definitions/rows_modified_confirmation" 22775 } 22776 ] 22777 }, 22778 "enterprise_update_enterprise_route_configuration_result": { 22779 "allOf": [ 22780 { 22781 "$ref": "#/definitions/rows_modified_confirmation" 22782 } 22783 ] 22784 }, 22785 "enterprise_update_enterprise_route_result": { 22786 "allOf": [ 22787 { 22788 "$ref": "#/definitions/enterprise_route_collection" 22789 }, 22790 { 22791 "required": [ 22792 "subnet", 22793 "preferredExits", 22794 "eligableExits" 22795 ] 22796 } 22797 ] 22798 }, 22799 "enterprise_update_enterprise_security_policy_result": { 22800 "allOf": [ 22801 { 22802 "$ref": "#/definitions/rows_modified_confirmation" 22803 } 22804 ] 22805 }, 22806 "enterprise_update_enterprise_service_result": { 22807 "allOf": [ 22808 { 22809 "$ref": "#/definitions/rows_modified_confirmation" 22810 } 22811 ] 22812 }, 22813 "event_get_enterprise_events_result": { 22814 "properties": { 22815 "data": { 22816 "items": { 22817 "$ref": "#/definitions/enterprise_event" 22818 }, 22819 "type": "array" 22820 }, 22821 "metaData": { 22822 "$ref": "#/definitions/list_metadata" 22823 } 22824 }, 22825 "required": [ 22826 "metaData", 22827 "data" 22828 ], 22829 "type": "object" 22830 }, 22831 "event_get_operator_events_result": { 22832 "properties": { 22833 "data": { 22834 "items": { 22835 "$ref": "#/definitions/operator_event" 22836 }, 22837 "type": "array" 22838 }, 22839 "metaData": { 22840 "$ref": "#/definitions/list_metadata" 22841 } 22842 }, 22843 "required": [ 22844 "metaData", 22845 "data" 22846 ], 22847 "type": "object" 22848 }, 22849 "event_get_proxy_events_result": { 22850 "properties": { 22851 "data": { 22852 "items": { 22853 "$ref": "#/definitions/proxy_event" 22854 }, 22855 "type": "array" 22856 }, 22857 "metaData": { 22858 "$ref": "#/definitions/list_metadata" 22859 } 22860 }, 22861 "required": [ 22862 "metaData", 22863 "data" 22864 ], 22865 "type": "object" 22866 }, 22867 "flow_metric_summary": { 22868 "type": "object", 22869 "properties": { 22870 "bytesRx": { 22871 "type": "integer", 22872 "format": "int64" 22873 }, 22874 "bytesTx": { 22875 "type": "integer", 22876 "format": "int64" 22877 }, 22878 "flowCount": { 22879 "type": "integer" 22880 }, 22881 "packetsRx": { 22882 "type": "integer", 22883 "format": "int64" 22884 }, 22885 "packetsTx": { 22886 "type": "integer", 22887 "format": "int64" 22888 }, 22889 "totalBytes": { 22890 "type": "integer", 22891 "format": "int64" 22892 }, 22893 "totalPackets": { 22894 "type": "integer", 22895 "format": "int64" 22896 } 22897 } 22898 }, 22899 "time_series": { 22900 "type": "object", 22901 "properties": { 22902 "data": { 22903 "type": "array", 22904 "items": { 22905 "type": "integer", 22906 "format": "int64" 22907 } 22908 }, 22909 "max": { 22910 "type": "integer", 22911 "format": "int64" 22912 }, 22913 "metric": { 22914 "$ref": "#/definitions/basic_metric" 22915 }, 22916 "min": { 22917 "type": "integer", 22918 "format": "int64" 22919 }, 22920 "startTime": { 22921 "type": "string", 22922 "format": "date-time" 22923 }, 22924 "tickInterval": { 22925 "type": "integer" 22926 }, 22927 "total": { 22928 "type": "integer", 22929 "format": "int64" 22930 } 22931 }, 22932 "required": [ 22933 "data", 22934 "metric", 22935 "max", 22936 "min", 22937 "startTime", 22938 "tickInterval", 22939 "total" 22940 ] 22941 }, 22942 "time_series_metadata": { 22943 "type": "object", 22944 "properties": { 22945 "series": { 22946 "type": "array", 22947 "items": { 22948 "$ref": "#/definitions/time_series" 22949 } 22950 } 22951 }, 22952 "required": [ 22953 "series" 22954 ] 22955 }, 22956 "enterprise_user_with_role_info": { 22957 "allOf": [ 22958 { 22959 "$ref": "#/definitions/base_enterprise_user" 22960 }, 22961 { 22962 "properties": { 22963 "roleId": { 22964 "type": "integer" 22965 }, 22966 "roleName": { 22967 "type": "string" 22968 } 22969 } 22970 } 22971 ] 22972 }, 22973 "enterprise_user_with_role_and_assocs": { 22974 "allOf": [ 22975 { 22976 "$ref": "#/definitions/enterprise_user_with_role_info" 22977 }, 22978 { 22979 "properties": { 22980 "enterpriseId": { 22981 "type": "integer" 22982 }, 22983 "enterpriseProxyId": { 22984 "type": "integer" 22985 }, 22986 "networkId": { 22987 "type": "integer" 22988 } 22989 } 22990 } 22991 ] 22992 }, 22993 "base_operator_user": { 22994 "type": "object", 22995 "properties": { 22996 "id": { 22997 "type": "integer" 22998 }, 22999 "created": { 23000 "type": "string", 23001 "format": "date-time" 23002 }, 23003 "operatorId": { 23004 "type": "integer" 23005 }, 23006 "userType": { 23007 "type": "string" 23008 }, 23009 "username": { 23010 "type": "string" 23011 }, 23012 "domain": { 23013 "type": "string" 23014 }, 23015 "password": { 23016 "type": "string", 23017 "format": "password" 23018 }, 23019 "firstName": { 23020 "type": "string" 23021 }, 23022 "lastName": { 23023 "type": "string" 23024 }, 23025 "officePhone": { 23026 "type": "string" 23027 }, 23028 "mobilePhone": { 23029 "type": "string" 23030 }, 23031 "isNative": { 23032 "type": "boolean" 23033 }, 23034 "isActive": { 23035 "type": "boolean" 23036 }, 23037 "isLocked": { 23038 "type": "boolean" 23039 }, 23040 "disableSecondFactor": { 23041 "type": "boolean" 23042 }, 23043 "email": { 23044 "type": "string" 23045 }, 23046 "lastLogin": { 23047 "type": "string", 23048 "format": "date-time" 23049 }, 23050 "modified": { 23051 "type": "string", 23052 "format": "date-time" 23053 } 23054 } 23055 }, 23056 "operator_user_with_role_info": { 23057 "allOf": [ 23058 { 23059 "$ref": "#/definitions/base_operator_user" 23060 }, 23061 { 23062 "properties": { 23063 "roleId": { 23064 "type": "integer" 23065 }, 23066 "roleName": { 23067 "type": "string" 23068 } 23069 } 23070 } 23071 ] 23072 }, 23073 "gateway_delete_gateway_result": { 23074 "allOf": [ 23075 { 23076 "$ref": "#/definitions/deletion_confirmation" 23077 } 23078 ] 23079 }, 23080 "gateway_gateway_provision_result": { 23081 "properties": { 23082 "activationKey": { 23083 "type": "string" 23084 }, 23085 "id": { 23086 "type": "integer" 23087 }, 23088 "logicalId": { 23089 "type": "string" 23090 } 23091 }, 23092 "required": [ 23093 "id", 23094 "activationKey", 23095 "logicalId" 23096 ], 23097 "type": "object" 23098 }, 23099 "gateway_roles_object": { 23100 "items": { 23101 "properties": { 23102 "gatewayRole": { 23103 "enum": [ 23104 "DATA_PLANE", 23105 "CONTROL_PLANE", 23106 "VPN_TUNNEL", 23107 "ON_PREMISE", 23108 "CDE" 23109 ], 23110 "type": "string" 23111 }, 23112 "required": { 23113 "type": "boolean" 23114 } 23115 }, 23116 "required": [ 23117 "gatewayRole" 23118 ], 23119 "type": "object" 23120 }, 23121 "type": "array" 23122 }, 23123 "gateway_update_gateway_attributes_result": { 23124 "allOf": [ 23125 { 23126 "$ref": "#/definitions/rows_modified_confirmation" 23127 } 23128 ] 23129 }, 23130 "gateway_get_gateway_edge_assignments_result_item": { 23131 "allOf": [ 23132 { 23133 "$ref": "#/definitions/edge_object" 23134 }, 23135 { 23136 "type": "object", 23137 "properties": { 23138 "enterpriseName": { 23139 "type": "string" 23140 }, 23141 "enterpriseProxyId": { 23142 "type": "integer" 23143 }, 23144 "enterpriseProxyName": { 23145 "type": "string" 23146 }, 23147 "lat": { 23148 "type": "number", 23149 "format": "double" 23150 }, 23151 "lon": { 23152 "type": "number", 23153 "format": "double" 23154 }, 23155 "city": { 23156 "type": "string" 23157 }, 23158 "state": { 23159 "type": "string" 23160 }, 23161 "country": { 23162 "type": "string" 23163 }, 23164 "postalCode": { 23165 "type": "string" 23166 } 23167 } 23168 } 23169 ] 23170 }, 23171 "id_map_one_to_many": { 23172 "additionalProperties": { 23173 "type": "integer" 23174 }, 23175 "type": "object" 23176 }, 23177 "id_map_one_to_one": { 23178 "additionalProperties": { 23179 "type": "integer" 23180 }, 23181 "type": "string" 23182 }, 23183 "js_date_formats": { 23184 "type": "string", 23185 "format": "date-time" 23186 }, 23187 "interval": { 23188 "properties": { 23189 "end": { 23190 "$ref": "#/definitions/js_date_formats" 23191 }, 23192 "start": { 23193 "$ref": "#/definitions/js_date_formats" 23194 } 23195 }, 23196 "required": [ 23197 "start" 23198 ], 23199 "type": "object" 23200 }, 23201 "ip_port_mapping": { 23202 "properties": { 23203 "subnets": { 23204 "items": { 23205 "type": "string" 23206 }, 23207 "type": "array" 23208 }, 23209 "tcpPorts": { 23210 "items": { 23211 "type": "integer" 23212 }, 23213 "type": "array" 23214 }, 23215 "udpPorts": { 23216 "items": { 23217 "type": "integer" 23218 }, 23219 "type": "array" 23220 } 23221 }, 23222 "type": "object" 23223 }, 23224 "link_quality_event_get_link_quality_events_result": { 23225 "type": "object", 23226 "properties": { 23227 "overallLinkQuality": { 23228 "$ref": "#/definitions/link_quality_object" 23229 } 23230 }, 23231 "additionalProperties": { 23232 "$ref": "#/definitions/link_quality_object" 23233 } 23234 }, 23235 "link_service_groups": { 23236 "items": { 23237 "enum": [ 23238 "ALL", 23239 "PRIVATE_WIRED", 23240 "PUBLIC_WIRED", 23241 "PUBLIC_WIRELESS" 23242 ], 23243 "type": "string" 23244 }, 23245 "type": "array" 23246 }, 23247 "list_metadata": { 23248 "properties": { 23249 "limit": { 23250 "type": "integer" 23251 }, 23252 "more": { 23253 "type": "boolean" 23254 } 23255 }, 23256 "required": [ 23257 "limit", 23258 "more" 23259 ], 23260 "type": "object" 23261 }, 23262 "live_mode_data": { 23263 "properties": { 23264 "linkStats": { 23265 "$ref": "#/definitions/live_mode_data_link_stats" 23266 } 23267 }, 23268 "required": [ 23269 "linkStats" 23270 ], 23271 "type": "object" 23272 }, 23273 "live_mode_data_link_stats": { 23274 "properties": { 23275 "data": { 23276 "items": { 23277 "$ref": "#/definitions/live_mode_data_link_stats_data" 23278 }, 23279 "type": "array" 23280 }, 23281 "timestamp": { 23282 "format": "date-time", 23283 "type": "string" 23284 }, 23285 "type": { 23286 "type": "string" 23287 } 23288 }, 23289 "required": [ 23290 "type", 23291 "timestamp", 23292 "data" 23293 ], 23294 "type": "object" 23295 }, 23296 "live_mode_data_link_stats_data": { 23297 "properties": { 23298 "data": { 23299 "items": { 23300 "$ref": "#/definitions/live_mode_data_link_stats_data_data" 23301 }, 23302 "type": "array" 23303 }, 23304 "timestamp": { 23305 "format": "date-time", 23306 "type": "string" 23307 }, 23308 "type": { 23309 "type": "string" 23310 } 23311 }, 23312 "required": [ 23313 "type", 23314 "timestamp", 23315 "data" 23316 ], 23317 "type": "object" 23318 }, 23319 "live_mode_data_link_stats_data_data": { 23320 "properties": { 23321 "backupOnly": { 23322 "type": "integer" 23323 }, 23324 "bestJitterMsRx": { 23325 "type": "integer" 23326 }, 23327 "bestJitterMsTx": { 23328 "type": "integer" 23329 }, 23330 "bestLatencyMsRx": { 23331 "type": "integer" 23332 }, 23333 "bestLatencyMsTx": { 23334 "type": "integer" 23335 }, 23336 "bestLossPctRx": { 23337 "type": "number", 23338 "format": "float" 23339 }, 23340 "bestLossPctTx": { 23341 "type": "number", 23342 "format": "float" 23343 }, 23344 "bpsOfBestPathRx": { 23345 "type": "integer" 23346 }, 23347 "bpsOfBestPathTx": { 23348 "type": "integer" 23349 }, 23350 "bytesRx": { 23351 "type": "integer", 23352 "format": "int64" 23353 }, 23354 "bytesTx": { 23355 "type": "integer", 23356 "format": "int64" 23357 }, 23358 "controlBytesRx": { 23359 "type": "integer", 23360 "format": "int64" 23361 }, 23362 "controlBytesTx": { 23363 "type": "integer", 23364 "format": "int64" 23365 }, 23366 "controlPacketsRx": { 23367 "type": "integer", 23368 "format": "int64" 23369 }, 23370 "controlPacketsTx": { 23371 "type": "integer", 23372 "format": "int64" 23373 }, 23374 "destinations": { 23375 "items": { 23376 "$ref": "#/definitions/destinations" 23377 }, 23378 "type": "array" 23379 }, 23380 "icmpBytesRx": { 23381 "type": "integer", 23382 "format": "int64" 23383 }, 23384 "icmpBytesTx": { 23385 "type": "integer", 23386 "format": "int64" 23387 }, 23388 "icmpPacketsRx": { 23389 "type": "integer", 23390 "format": "int64" 23391 }, 23392 "icmpPacketsTx": { 23393 "type": "integer", 23394 "format": "int64" 23395 }, 23396 "interface": { 23397 "type": "string" 23398 }, 23399 "internalId": { 23400 "type": "string" 23401 }, 23402 "localIpAddress": { 23403 "type": "string" 23404 }, 23405 "logicalId": { 23406 "type": "string" 23407 }, 23408 "mode": { 23409 "enum": [ 23410 "PUBLIC", 23411 "PRIVATE" 23412 ], 23413 "type": "string" 23414 }, 23415 "mtu": { 23416 "type": "integer" 23417 }, 23418 "name": { 23419 "type": "string" 23420 }, 23421 "otherBytesRx": { 23422 "type": "integer", 23423 "format": "int64" 23424 }, 23425 "otherBytesTx": { 23426 "type": "integer", 23427 "format": "int64" 23428 }, 23429 "otherPacketsRx": { 23430 "type": "integer", 23431 "format": "int64" 23432 }, 23433 "otherPacketsTx": { 23434 "type": "integer", 23435 "format": "int64" 23436 }, 23437 "p1BytesRx": { 23438 "type": "integer", 23439 "format": "int64" 23440 }, 23441 "p1BytesTx": { 23442 "type": "integer", 23443 "format": "int64" 23444 }, 23445 "p1PacketsRx": { 23446 "type": "integer", 23447 "format": "int64" 23448 }, 23449 "p1PacketsTx": { 23450 "type": "integer", 23451 "format": "int64" 23452 }, 23453 "p2BytesRx": { 23454 "type": "integer", 23455 "format": "int64" 23456 }, 23457 "p2BytesTx": { 23458 "type": "integer", 23459 "format": "int64" 23460 }, 23461 "p2PacketsRx": { 23462 "type": "integer", 23463 "format": "int64" 23464 }, 23465 "p2PacketsTx": { 23466 "type": "integer", 23467 "format": "int64" 23468 }, 23469 "p3BytesRx": { 23470 "type": "integer", 23471 "format": "int64" 23472 }, 23473 "p3BytesTx": { 23474 "type": "integer", 23475 "format": "int64" 23476 }, 23477 "p3PacketsRx": { 23478 "type": "integer", 23479 "format": "int64" 23480 }, 23481 "p3PacketsTx": { 23482 "type": "integer", 23483 "format": "int64" 23484 }, 23485 "publicIpAddress": { 23486 "type": "string" 23487 }, 23488 "scoreRx": { 23489 "type": "number", 23490 "format": "float" 23491 }, 23492 "scoreTx": { 23493 "type": "number", 23494 "format": "float" 23495 }, 23496 "signalStrength": { 23497 "type": "number", 23498 "format": "float" 23499 }, 23500 "state": { 23501 "enum": [ 23502 "UNKNOWN", 23503 "STABLE", 23504 "UNSTABLE", 23505 "DISCONNECTED", 23506 "QUIET", 23507 "INITIAL", 23508 "STANDBY" 23509 ], 23510 "type": "string" 23511 }, 23512 "tcpBytesRx": { 23513 "type": "integer", 23514 "format": "int64" 23515 }, 23516 "tcpBytesTx": { 23517 "type": "integer", 23518 "format": "int64" 23519 }, 23520 "tcpPacketsRx": { 23521 "type": "integer", 23522 "format": "int64" 23523 }, 23524 "tcpPacketsTx": { 23525 "type": "integer", 23526 "format": "int64" 23527 }, 23528 "type": { 23529 "enum": [ 23530 "WIRED", 23531 "WIRELESS" 23532 ], 23533 "type": "string" 23534 }, 23535 "udpBytesRx": { 23536 "type": "integer", 23537 "format": "int64" 23538 }, 23539 "udpBytesTx": { 23540 "type": "integer", 23541 "format": "int64" 23542 }, 23543 "udpHolePunching": { 23544 "type": "integer" 23545 }, 23546 "udpPacketsRx": { 23547 "type": "integer", 23548 "format": "int64" 23549 }, 23550 "udpPacketsTx": { 23551 "type": "integer", 23552 "format": "int64" 23553 }, 23554 "vlanId": { 23555 "type": "integer" 23556 }, 23557 "vpnState": { 23558 "enum": [ 23559 "UNKNOWN", 23560 "STABLE", 23561 "UNSTABLE", 23562 "DEAD", 23563 "STANDBY" 23564 ], 23565 "type": "string" 23566 } 23567 }, 23568 "type": "object" 23569 }, 23570 "live_mode_enter_live_mode_result": { 23571 "properties": { 23572 "actionId": { 23573 "description": "The ID of the action queued", 23574 "type": "integer" 23575 }, 23576 "alreadyLive": { 23577 "type": "boolean" 23578 }, 23579 "lastContact": { 23580 "type": "integer" 23581 }, 23582 "refreshIntervalMs": { 23583 "type": "integer" 23584 }, 23585 "token": { 23586 "type": "string" 23587 }, 23588 "url": { 23589 "type": "string" 23590 } 23591 }, 23592 "type": "object" 23593 }, 23594 "live_mode_exit_live_mode_result": { 23595 "properties": { 23596 "id": { 23597 "description": "The ID of the action queued", 23598 "type": "string" 23599 } 23600 }, 23601 "required": [ 23602 "id" 23603 ], 23604 "type": "object" 23605 }, 23606 "live_mode_read_live_data_result": { 23607 "properties": { 23608 "data": { 23609 "$ref": "#/definitions/live_mode_data" 23610 }, 23611 "status": { 23612 "$ref": "#/definitions/live_mode_status" 23613 }, 23614 "timestamp": { 23615 "type": "integer" 23616 } 23617 }, 23618 "required": [ 23619 "timestamp", 23620 "data", 23621 "status" 23622 ], 23623 "type": "object" 23624 }, 23625 "live_mode_status": { 23626 "properties": { 23627 "isActive": { 23628 "type": "boolean" 23629 }, 23630 "lastContact": { 23631 "type": "integer" 23632 } 23633 }, 23634 "required": [ 23635 "isActive", 23636 "lastContact" 23637 ], 23638 "type": "object" 23639 }, 23640 "metrics_get_edge_app_link_metrics_result_item": { 23641 "allOf": [ 23642 { 23643 "$ref": "#/definitions/flow_metric_summary" 23644 }, 23645 { 23646 "properties": { 23647 "linkId": { 23648 "type": "integer" 23649 }, 23650 "name": { 23651 "type": "integer" 23652 }, 23653 "serviceGroups": { 23654 "$ref": "#/definitions/link_service_groups" 23655 } 23656 }, 23657 "required": [ 23658 "linkId", 23659 "name", 23660 "serviceGroups" 23661 ] 23662 } 23663 ] 23664 }, 23665 "metrics_get_edge_app_link_series_result_item": { 23666 "allOf": [ 23667 { 23668 "$ref": "#/definitions/time_series_metadata" 23669 }, 23670 { 23671 "properties": { 23672 "name": { 23673 "type": "integer" 23674 }, 23675 "serviceGroups": { 23676 "$ref": "#/definitions/link_service_groups" 23677 } 23678 }, 23679 "required": [ 23680 "name", 23681 "serviceGroups" 23682 ] 23683 } 23684 ] 23685 }, 23686 "metrics_get_edge_app_metrics_result_item": { 23687 "allOf": [ 23688 { 23689 "$ref": "#/definitions/flow_metric_summary" 23690 }, 23691 { 23692 "properties": { 23693 "application": { 23694 "type": "integer" 23695 }, 23696 "category": { 23697 "type": "integer" 23698 }, 23699 "name": { 23700 "type": "integer" 23701 }, 23702 "linkId": { 23703 "type": "integer" 23704 } 23705 }, 23706 "required": [ 23707 "name", 23708 "application" 23709 ] 23710 } 23711 ] 23712 }, 23713 "metrics_get_edge_app_series_result_item": { 23714 "allOf": [ 23715 { 23716 "$ref": "#/definitions/time_series_metadata" 23717 }, 23718 { 23719 "properties": { 23720 "name": { 23721 "type": "integer" 23722 } 23723 }, 23724 "required": [ 23725 "name" 23726 ] 23727 } 23728 ] 23729 }, 23730 "metrics_get_edge_category_metrics_result_item": { 23731 "allOf": [ 23732 { 23733 "$ref": "#/definitions/flow_metric_summary" 23734 }, 23735 { 23736 "properties": { 23737 "category": { 23738 "type": "integer" 23739 }, 23740 "name": { 23741 "type": "integer" 23742 } 23743 }, 23744 "required": [ 23745 "name", 23746 "category" 23747 ] 23748 } 23749 ] 23750 }, 23751 "metrics_get_edge_category_series_result_item": { 23752 "allOf": [ 23753 { 23754 "$ref": "#/definitions/time_series_metadata" 23755 }, 23756 { 23757 "properties": { 23758 "name": { 23759 "type": "integer" 23760 } 23761 }, 23762 "required": [ 23763 "name" 23764 ] 23765 } 23766 ] 23767 }, 23768 "metrics_get_edge_segment_metrics_result_item": { 23769 "allOf": [ 23770 { 23771 "$ref": "#/definitions/flow_metric_summary" 23772 }, 23773 { 23774 "properties": { 23775 "segment": { 23776 "type": "integer" 23777 }, 23778 "name": { 23779 "type": "integer" 23780 } 23781 }, 23782 "required": [ 23783 "name", 23784 "segment" 23785 ] 23786 } 23787 ] 23788 }, 23789 "metrics_get_edge_segment_series_result_item": { 23790 "allOf": [ 23791 { 23792 "$ref": "#/definitions/time_series_metadata" 23793 }, 23794 { 23795 "properties": { 23796 "name": { 23797 "type": "integer" 23798 } 23799 }, 23800 "required": [ 23801 "name" 23802 ] 23803 } 23804 ] 23805 }, 23806 "metrics_get_edge_dest_metrics_result_item": { 23807 "allOf": [ 23808 { 23809 "$ref": "#/definitions/flow_metric_summary" 23810 }, 23811 { 23812 "properties": { 23813 "destDomain": { 23814 "type": "string" 23815 }, 23816 "name": { 23817 "type": "string" 23818 } 23819 }, 23820 "required": [ 23821 "destDomain", 23822 "name" 23823 ] 23824 } 23825 ] 23826 }, 23827 "metrics_get_edge_dest_series_result_item": { 23828 "allOf": [ 23829 { 23830 "$ref": "#/definitions/time_series_metadata" 23831 }, 23832 { 23833 "properties": { 23834 "name": { 23835 "type": "string" 23836 } 23837 }, 23838 "required": [ 23839 "name" 23840 ] 23841 } 23842 ] 23843 }, 23844 "metrics_get_edge_device_metrics_device_edge_info": { 23845 "properties": { 23846 "edgeId": { 23847 "type": "integer" 23848 }, 23849 "enterpriseId": { 23850 "type": "integer" 23851 }, 23852 "hostName": { 23853 "type": "string" 23854 }, 23855 "id": { 23856 "type": "integer" 23857 }, 23858 "ipAddress": { 23859 "type": "string" 23860 }, 23861 "lastContact": { 23862 "format": "date-time", 23863 "type": "string" 23864 }, 23865 "macAddress": { 23866 "type": "string" 23867 } 23868 }, 23869 "type": "object" 23870 }, 23871 "metrics_get_edge_device_metrics_result_item": { 23872 "allOf": [ 23873 { 23874 "$ref": "#/definitions/flow_metric_summary" 23875 }, 23876 { 23877 "properties": { 23878 "edgeInfo": { 23879 "$ref": "#/definitions/metrics_get_edge_device_metrics_device_edge_info" 23880 }, 23881 "info": { 23882 "$ref": "#/definitions/client_device" 23883 }, 23884 "name": { 23885 "type": "string" 23886 }, 23887 "sourceMac": { 23888 "type": "string" 23889 } 23890 }, 23891 "required": [ 23892 "edgeInfo", 23893 "info", 23894 "name", 23895 "sourceMac" 23896 ] 23897 } 23898 ] 23899 }, 23900 "metrics_get_edge_device_series_result_item": { 23901 "allOf": [ 23902 { 23903 "$ref": "#/definitions/time_series_metadata" 23904 }, 23905 { 23906 "properties": { 23907 "name": { 23908 "type": "string" 23909 } 23910 }, 23911 "required": [ 23912 "name" 23913 ] 23914 } 23915 ] 23916 }, 23917 "metrics_get_edge_link_metrics_result_item": { 23918 "properties": { 23919 "bestJitterMsRx": { 23920 "type": "integer" 23921 }, 23922 "bestJitterMsTx": { 23923 "type": "integer" 23924 }, 23925 "bestLatencyMsRx": { 23926 "type": "integer" 23927 }, 23928 "bestLatencyMsTx": { 23929 "type": "integer" 23930 }, 23931 "bestLossPctRx": { 23932 "type": "number", 23933 "format": "float" 23934 }, 23935 "bestLossPctTx": { 23936 "type": "number", 23937 "format": "float" 23938 }, 23939 "bpsOfBestPathRx": { 23940 "type": "integer" 23941 }, 23942 "bpsOfBestPathTx": { 23943 "type": "integer" 23944 }, 23945 "bytesRx": { 23946 "type": "integer", 23947 "format": "int64" 23948 }, 23949 "bytesTx": { 23950 "type": "integer", 23951 "format": "int64" 23952 }, 23953 "controlBytesRx": { 23954 "type": "integer", 23955 "format": "int64" 23956 }, 23957 "controlBytesTx": { 23958 "type": "integer", 23959 "format": "int64" 23960 }, 23961 "controlPacketsRx": { 23962 "type": "integer", 23963 "format": "int64" 23964 }, 23965 "controlPacketsTx": { 23966 "type": "integer", 23967 "format": "int64" 23968 }, 23969 "link": { 23970 "$ref": "#/definitions/link" 23971 }, 23972 "linkId": { 23973 "type": "integer" 23974 }, 23975 "name": { 23976 "type": "string" 23977 }, 23978 "p1BytesRx": { 23979 "type": "integer", 23980 "format": "int64" 23981 }, 23982 "p1BytesTx": { 23983 "type": "integer", 23984 "format": "int64" 23985 }, 23986 "p1PacketsRx": { 23987 "type": "integer", 23988 "format": "int64" 23989 }, 23990 "p1PacketsTx": { 23991 "type": "integer", 23992 "format": "int64" 23993 }, 23994 "p2BytesRx": { 23995 "type": "integer", 23996 "format": "int64" 23997 }, 23998 "p2BytesTx": { 23999 "type": "integer", 24000 "format": "int64" 24001 }, 24002 "p2PacketsRx": { 24003 "type": "integer", 24004 "format": "int64" 24005 }, 24006 "p2PacketsTx": { 24007 "type": "integer", 24008 "format": "int64" 24009 }, 24010 "p3BytesRx": { 24011 "type": "integer", 24012 "format": "int64" 24013 }, 24014 "p3BytesTx": { 24015 "type": "integer", 24016 "format": "int64" 24017 }, 24018 "p3PacketsRx": { 24019 "type": "integer", 24020 "format": "int64" 24021 }, 24022 "p3PacketsTx": { 24023 "type": "integer", 24024 "format": "int64" 24025 }, 24026 "scoreRx": { 24027 "type": "number", 24028 "format": "float" 24029 }, 24030 "scoreTx": { 24031 "type": "number", 24032 "format": "float" 24033 }, 24034 "signalStrength": { 24035 "type": "number", 24036 "format": "float" 24037 }, 24038 "state": { 24039 "type": "integer" 24040 } 24041 }, 24042 "required": [ 24043 "link", 24044 "linkId", 24045 "name" 24046 ], 24047 "type": "object" 24048 }, 24049 "metrics_get_edge_link_series_result_item": { 24050 "allOf": [ 24051 { 24052 "$ref": "#/definitions/time_series_metadata" 24053 }, 24054 { 24055 "properties": { 24056 "edgeId": { 24057 "type": "integer" 24058 }, 24059 "link": { 24060 "$ref": "#/definitions/link" 24061 }, 24062 "linkId": { 24063 "type": "integer" 24064 } 24065 }, 24066 "required": [ 24067 "edgeId", 24068 "linkId", 24069 "link" 24070 ] 24071 } 24072 ] 24073 }, 24074 "metrics_get_edge_os_metrics_result_item": { 24075 "allOf": [ 24076 { 24077 "$ref": "#/definitions/flow_metric_summary" 24078 }, 24079 { 24080 "properties": { 24081 "name": { 24082 "type": "integer" 24083 }, 24084 "os": { 24085 "type": "integer" 24086 } 24087 }, 24088 "required": [ 24089 "os", 24090 "name" 24091 ] 24092 } 24093 ] 24094 }, 24095 "metrics_get_edge_os_series_result_item": { 24096 "allOf": [ 24097 { 24098 "$ref": "#/definitions/time_series_metadata" 24099 }, 24100 { 24101 "properties": { 24102 "name": { 24103 "type": "integer" 24104 } 24105 }, 24106 "required": [ 24107 "name" 24108 ] 24109 } 24110 ] 24111 }, 24112 "monitoring_get_aggregate_edge_link_metrics_result_item": { 24113 "type": "object", 24114 "properties": { 24115 "bestJitterMsRx": { 24116 "type": "integer" 24117 }, 24118 "bestJitterMsTx": { 24119 "type": "integer" 24120 }, 24121 "bestLatencyMsRx": { 24122 "type": "integer" 24123 }, 24124 "bestLatencyMsTx": { 24125 "type": "integer" 24126 }, 24127 "bestLossPctRx": { 24128 "type": "number", 24129 "format": "float" 24130 }, 24131 "bestLossPctTx": { 24132 "type": "number", 24133 "format": "float" 24134 }, 24135 "bpsOfBestPathRx": { 24136 "type": "integer" 24137 }, 24138 "bpsOfBestPathTx": { 24139 "type": "integer" 24140 }, 24141 "bytesRx": { 24142 "type": "integer", 24143 "format": "int64" 24144 }, 24145 "bytesTx": { 24146 "type": "integer", 24147 "format": "int64" 24148 }, 24149 "controlBytesRx": { 24150 "type": "integer", 24151 "format": "int64" 24152 }, 24153 "controlBytesTx": { 24154 "type": "integer", 24155 "format": "int64" 24156 }, 24157 "controlPacketsRx": { 24158 "type": "integer", 24159 "format": "int64" 24160 }, 24161 "controlPacketsTx": { 24162 "type": "integer", 24163 "format": "int64" 24164 }, 24165 "link": { 24166 "$ref": "#/definitions/monitored_link" 24167 }, 24168 "linkId": { 24169 "type": "integer" 24170 }, 24171 "name": { 24172 "type": "string" 24173 }, 24174 "p1BytesRx": { 24175 "type": "integer", 24176 "format": "int64" 24177 }, 24178 "p1BytesTx": { 24179 "type": "integer", 24180 "format": "int64" 24181 }, 24182 "p1PacketsRx": { 24183 "type": "integer", 24184 "format": "int64" 24185 }, 24186 "p1PacketsTx": { 24187 "type": "integer", 24188 "format": "int64" 24189 }, 24190 "p2BytesRx": { 24191 "type": "integer", 24192 "format": "int64" 24193 }, 24194 "p2BytesTx": { 24195 "type": "integer", 24196 "format": "int64" 24197 }, 24198 "p2PacketsRx": { 24199 "type": "integer", 24200 "format": "int64" 24201 }, 24202 "p2PacketsTx": { 24203 "type": "integer", 24204 "format": "int64" 24205 }, 24206 "p3BytesRx": { 24207 "type": "integer", 24208 "format": "int64" 24209 }, 24210 "p3BytesTx": { 24211 "type": "integer", 24212 "format": "int64" 24213 }, 24214 "p3PacketsRx": { 24215 "type": "integer", 24216 "format": "int64" 24217 }, 24218 "p3PacketsTx": { 24219 "type": "integer", 24220 "format": "int64" 24221 }, 24222 "scoreRx": { 24223 "type": "number", 24224 "format": "float" 24225 }, 24226 "scoreTx": { 24227 "type": "number", 24228 "format": "float" 24229 }, 24230 "signalStrength": { 24231 "type": "number", 24232 "format": "float" 24233 }, 24234 "state": { 24235 "type": "integer" 24236 } 24237 }, 24238 "required": [ 24239 "link", 24240 "linkId", 24241 "name" 24242 ] 24243 }, 24244 "monitoring_get_aggregate_enterprise_events_result": { 24245 "type": "object", 24246 "properties": { 24247 "data": { 24248 "items": { 24249 "$ref": "#/definitions/aggregate_enterprise_event" 24250 }, 24251 "type": "array" 24252 }, 24253 "metaData": { 24254 "$ref": "#/definitions/list_metadata" 24255 } 24256 }, 24257 "required": [ 24258 "metaData", 24259 "data" 24260 ] 24261 }, 24262 "monitoring_get_aggregates_result": { 24263 "type": "object", 24264 "properties": { 24265 "edgeCount": { 24266 "type": "integer" 24267 }, 24268 "edges": { 24269 "type": "object", 24270 "additionalProperties": { 24271 "type": "integer" 24272 } 24273 }, 24274 "enterprises": { 24275 "type": "array", 24276 "items": { 24277 "$ref": "#/definitions/enterprise_with_proxy_attributes" 24278 } 24279 } 24280 } 24281 }, 24282 "monitoring_get_enterprise_bgp_peer_status_result_item": { 24283 "type": "object", 24284 "properties": { 24285 "gatewayName": { 24286 "type": "string" 24287 }, 24288 "gatewayLogicalId": { 24289 "type": "string" 24290 }, 24291 "neighbors": { 24292 "type": "array", 24293 "items": { 24294 "$ref": "#/definitions/bgp_peer_status" 24295 } 24296 } 24297 } 24298 }, 24299 "monitoring_get_enterprise_edge_bgp_peer_status_result_item": { 24300 "type": "object", 24301 "properties": { 24302 "edgeName": { 24303 "type": "string" 24304 }, 24305 "edgeId": { 24306 "type": "integer" 24307 }, 24308 "edgeLogicalId": { 24309 "type": "string" 24310 }, 24311 "neighbors": { 24312 "type": "array", 24313 "items": { 24314 "$ref": "#/definitions/bgp_peer_status" 24315 } 24316 } 24317 } 24318 }, 24319 "monitored_link": { 24320 "type": "object", 24321 "properties": { 24322 "displayName": { 24323 "type": "string" 24324 }, 24325 "edgeHASerialNumber": { 24326 "type": "string" 24327 }, 24328 "edgeId": { 24329 "type": "integer" 24330 }, 24331 "edgeLastContact": { 24332 "format": "date-time", 24333 "type": "string" 24334 }, 24335 "edgeLatitude": { 24336 "type": "number", 24337 "format": "double" 24338 }, 24339 "edgeLongitude": { 24340 "type": "number", 24341 "format": "double" 24342 }, 24343 "edgeModelNumber": { 24344 "type": "string" 24345 }, 24346 "edgeName": { 24347 "type": "string" 24348 }, 24349 "edgeSerialNumber": { 24350 "type": "string" 24351 }, 24352 "edgeServiceUpSince": { 24353 "format": "date-time", 24354 "type": "string" 24355 }, 24356 "edgeState": { 24357 "enum": [ 24358 "NEVER_ACTIVATED", 24359 "DEGRADED", 24360 "OFFLINE", 24361 "DISABLED", 24362 "EXPIRED", 24363 "CONNECTED" 24364 ], 24365 "type": "string" 24366 }, 24367 "edgeSystemUpSince": { 24368 "format": "date-time", 24369 "type": "string" 24370 }, 24371 "enterpriseId": { 24372 "type": "integer" 24373 }, 24374 "enterpriseName": { 24375 "type": "string" 24376 }, 24377 "enterpriseProxyId": { 24378 "type": "integer" 24379 }, 24380 "enterpriseProxyName": { 24381 "type": "string" 24382 }, 24383 "interface": { 24384 "type": "string" 24385 }, 24386 "internalId": { 24387 "type": "string" 24388 }, 24389 "isp": { 24390 "type": "string" 24391 }, 24392 "linkId": { 24393 "type": "integer" 24394 }, 24395 "linkIpAddress": { 24396 "type": "string" 24397 }, 24398 "linkLastActive": { 24399 "format": "date-time", 24400 "type": "string" 24401 }, 24402 "linkState": { 24403 "enum": [ 24404 "UNKNOWN", 24405 "STABLE", 24406 "UNSTABLE", 24407 "DISCONNECTED", 24408 "QUIET", 24409 "INITIAL", 24410 "STANDBY" 24411 ], 24412 "type": "string" 24413 }, 24414 "linkVpnState": { 24415 "type": "string", 24416 "enum": [ 24417 "UNKNOWN", 24418 "STABLE", 24419 "UNSTABLE", 24420 "DEAD", 24421 "STANDBY" 24422 ] 24423 } 24424 }, 24425 "required": [ 24426 "displayName", 24427 "edgeHASerialNumber", 24428 "edgeId", 24429 "edgeLastContact", 24430 "edgeLatitude", 24431 "edgeLongitude", 24432 "edgeModelNumber", 24433 "edgeName", 24434 "edgeSerialNumber", 24435 "edgeServiceUpSince", 24436 "edgeState", 24437 "edgeSystemUpSince", 24438 "enterpriseId", 24439 "enterpriseName", 24440 "enterpriseProxyId", 24441 "enterpriseProxyName", 24442 "interface", 24443 "internalId", 24444 "isp", 24445 "linkId", 24446 "linkIpAddress", 24447 "linkLastActive", 24448 "linkState", 24449 "linkVpnState" 24450 ] 24451 }, 24452 "monitoring_get_enterprise_edge_link_status_result_item": { 24453 "allOf": [ 24454 { 24455 "$ref": "#/definitions/monitored_link" 24456 } 24457 ] 24458 }, 24459 "monitoring_get_enterprise_edge_vnf_status_result_item": { 24460 "allOf": [ 24461 { 24462 "$ref": "#/definitions/enterprise_object_base" 24463 }, 24464 { 24465 "type": "object", 24466 "properties": { 24467 "data": { 24468 "type": "object", 24469 "properties": { 24470 "type": { 24471 "type": "string" 24472 }, 24473 "vendor": { 24474 "type": "string" 24475 }, 24476 "vendorSpecificData": { 24477 "type": "object" 24478 } 24479 } 24480 }, 24481 "edgeCount": { 24482 "type": "integer" 24483 }, 24484 "edgeUsage": { 24485 "type": "array", 24486 "items": { 24487 "type": "object", 24488 "properties": { 24489 "configurationId": { 24490 "type": "integer" 24491 }, 24492 "edgeSpecificId": { 24493 "type": "integer" 24494 }, 24495 "name": { 24496 "type": "string" 24497 }, 24498 "logicalId": { 24499 "type": "string" 24500 }, 24501 "profileId": { 24502 "type": "integer" 24503 }, 24504 "vnfStatus": { 24505 "type": "object", 24506 "properties": { 24507 "description": { 24508 "type": "string" 24509 }, 24510 "status": { 24511 "type": "string" 24512 }, 24513 "vmStatus": { 24514 "type": "string" 24515 }, 24516 "vnfInsertionEnabled": { 24517 "type": "string" 24518 } 24519 } 24520 } 24521 } 24522 } 24523 } 24524 } 24525 } 24526 ] 24527 }, 24528 "network_delete_network_gateway_pool_result": { 24529 "allOf": [ 24530 { 24531 "$ref": "#/definitions/deletion_confirmation" 24532 } 24533 ] 24534 }, 24535 "network_get_network_configurations_result_item": { 24536 "allOf": [ 24537 { 24538 "$ref": "#/definitions/model_configuration" 24539 }, 24540 { 24541 "required": [ 24542 "id", 24543 "created", 24544 "description", 24545 "effective", 24546 "modified", 24547 "name", 24548 "version" 24549 ] 24550 } 24551 ] 24552 }, 24553 "network_get_network_enterprises_result_item": { 24554 "allOf": [ 24555 { 24556 "$ref": "#/definitions/enterprise" 24557 }, 24558 { 24559 "properties": { 24560 "enterpriseProxyId": { 24561 "type": "integer" 24562 }, 24563 "enterpriseProxyName": { 24564 "type": "string" 24565 }, 24566 "edgeCount": { 24567 "type": "integer" 24568 }, 24569 "edges": { 24570 "type": "array", 24571 "items": { 24572 "$ref": "#/definitions/edge_object" 24573 } 24574 }, 24575 "edgeConfigUpdate": { 24576 "type": "object", 24577 "properties": { 24578 "enabled": { 24579 "type": "boolean" 24580 }, 24581 "enabledOnUpgrade": { 24582 "type": "boolean" 24583 } 24584 } 24585 } 24586 } 24587 } 24588 ] 24589 }, 24590 "network_get_network_gateway_pools_result_item": { 24591 "allOf": [ 24592 { 24593 "$ref": "#/definitions/gateway_pool" 24594 }, 24595 { 24596 "properties": { 24597 "gateways": { 24598 "type": "array", 24599 "items": { 24600 "$ref": "#/definitions/gateway_pool_gateway" 24601 } 24602 }, 24603 "enterprises": { 24604 "type": "array", 24605 "items": { 24606 "$ref": "#/definitions/enterprise_with_proxy_attributes" 24607 } 24608 } 24609 }, 24610 "required": [ 24611 "id", 24612 "networkId", 24613 "enterpriseProxyId", 24614 "created", 24615 "name", 24616 "description", 24617 "isDefault", 24618 "handOffType", 24619 "modified" 24620 ] 24621 } 24622 ] 24623 }, 24624 "gateway_handoff_edge": { 24625 "allOf": [ 24626 { 24627 "$ref": "#/definitions/edge_object" 24628 }, 24629 { 24630 "type": "object", 24631 "properties": { 24632 "edgeId": { 24633 "type": "integer" 24634 }, 24635 "isPrimary": { 24636 "type": "integer" 24637 }, 24638 "pinned": { 24639 "type": "integer" 24640 }, 24641 "enterpriseLogicalId": { 24642 "type": "string" 24643 }, 24644 "enterpriseName": { 24645 "type": "string" 24646 } 24647 } 24648 } 24649 ] 24650 }, 24651 "gateway_enterprise_assoc": { 24652 "allOf": [ 24653 { 24654 "$ref": "#/definitions/enterprise" 24655 }, 24656 { 24657 "type": "object", 24658 "properties": { 24659 "enterpriseId": { 24660 "type": "integer" 24661 }, 24662 "enterpriseObjectId": { 24663 "type": "integer" 24664 }, 24665 "edgeId": { 24666 "type": "integer" 24667 }, 24668 "gatewayType": { 24669 "type": "string", 24670 "enum": [ 24671 "OTHER", 24672 "SUPER", 24673 "DATACENTER", 24674 "HANDOFF", 24675 "SUPER_ALT" 24676 ] 24677 }, 24678 "pinned": { 24679 "type": "integer" 24680 }, 24681 "enterpriseObjectName": { 24682 "type": "string" 24683 }, 24684 "enterpriseObjectType": { 24685 "type": "string" 24686 }, 24687 "edgeName": { 24688 "type": "string" 24689 }, 24690 "edgeLogicalId": { 24691 "type": "string" 24692 } 24693 } 24694 } 24695 ] 24696 }, 24697 "edge_certificate": { 24698 "type": "object", 24699 "properties": { 24700 "id": { 24701 "type": "integer" 24702 }, 24703 "created": { 24704 "type": "string", 24705 "format": "date-time" 24706 }, 24707 "csrId": { 24708 "type": "integer" 24709 }, 24710 "edgeId": { 24711 "type": "integer" 24712 }, 24713 "enterpriseId": { 24714 "type": "integer" 24715 }, 24716 "certificate": { 24717 "type": "string" 24718 }, 24719 "serialNumber": { 24720 "type": "string" 24721 }, 24722 "subjectKeyId": { 24723 "type": "string" 24724 }, 24725 "fingerPrint": { 24726 "type": "string" 24727 }, 24728 "validFrom": { 24729 "type": "string", 24730 "format": "date-time" 24731 }, 24732 "validTo": { 24733 "type": "string", 24734 "format": "date-time" 24735 } 24736 } 24737 }, 24738 "gateway_certificate": { 24739 "type": "object", 24740 "properties": { 24741 "id": { 24742 "type": "integer" 24743 }, 24744 "created": { 24745 "type": "string", 24746 "format": "date-time" 24747 }, 24748 "csrId": { 24749 "type": "integer" 24750 }, 24751 "gatewayId": { 24752 "type": "integer" 24753 }, 24754 "networkId": { 24755 "type": "integer" 24756 }, 24757 "certificate": { 24758 "type": "string" 24759 }, 24760 "serialNumber": { 24761 "type": "string" 24762 }, 24763 "subjectKeyId": { 24764 "type": "string" 24765 }, 24766 "fingerPrint": { 24767 "type": "string" 24768 }, 24769 "validFrom": { 24770 "type": "string", 24771 "format": "date-time" 24772 }, 24773 "validTo": { 24774 "type": "string", 24775 "format": "date-time" 24776 } 24777 } 24778 }, 24779 "gateway_site": { 24780 "allOf": [ 24781 { 24782 "$ref": "#/definitions/site" 24783 }, 24784 { 24785 "type": "object", 24786 "properties": { 24787 } 24788 } 24789 ] 24790 }, 24791 "gateway_gateway_pool": { 24792 "allOf": [ 24793 { 24794 "$ref": "#/definitions/gateway_pool" 24795 }, 24796 { 24797 "type": "object", 24798 "properties": { 24799 "gatewayPoolAssocId": { 24800 "type": "integer" 24801 }, 24802 "gatewayId": { 24803 "type": "integer" 24804 } 24805 } 24806 } 24807 ] 24808 }, 24809 "gateway_role": { 24810 "type": "object", 24811 "properties": { 24812 "created": { 24813 "type": "string", 24814 "format": "date-time" 24815 }, 24816 "gatewayId": { 24817 "type": "integer" 24818 }, 24819 "gatewayRole": { 24820 "type": "string", 24821 "enum": [ 24822 "DATA_PLANE", 24823 "CONTROL_PLANE", 24824 "VPN_TUNNEL", 24825 "ON_PREMISE", 24826 "CDE" 24827 ], 24828 "x-alternate-name": "gatewayRoleProperty" 24829 }, 24830 "required": { 24831 "type": "integer" 24832 } 24833 } 24834 }, 24835 "gateway_handoff_segment_metadata": { 24836 "type": "object", 24837 "properties": { 24838 "name": { 24839 "type": "string" 24840 }, 24841 "segmentId": { 24842 "type": "integer" 24843 }, 24844 "segmentLogicalId": { 24845 "type": "string" 24846 }, 24847 "type": { 24848 "type": "string", 24849 "enum": [ 24850 "REGULAR", 24851 "CDE" 24852 ] 24853 } 24854 } 24855 }, 24856 "gateway_handoff_value_bgp_priority_setup_auto_as": { 24857 "type": "object", 24858 "properties": { 24859 "enabled": { 24860 "type": "boolean", 24861 "default": false 24862 } 24863 } 24864 }, 24865 "gateway_handoff_value_bgp_priority_setup_auto_med": { 24866 "type": "object", 24867 "properties": { 24868 "enabled": { 24869 "type": "boolean", 24870 "default": false 24871 } 24872 } 24873 }, 24874 "gateway_handoff_value_vlan": { 24875 "type": "object", 24876 "additionalProperties": { 24877 "type": "object", 24878 "properties": { 24879 "type": { 24880 "type": "string" 24881 }, 24882 "cTag": { 24883 "type": "integer" 24884 }, 24885 "sTag": { 24886 "type": "integer" 24887 }, 24888 "transportLanVLAN": { 24889 "type": "string" 24890 } 24891 } 24892 } 24893 }, 24894 "gateway_handoff_value_segments": { 24895 "type": "array", 24896 "items": { 24897 "$ref": "#/definitions/gateway_handoff_value" 24898 } 24899 }, 24900 "gateway_handoff_value": { 24901 "type": "object", 24902 "properties": { 24903 "segments": { 24904 "$ref": "#/definitions/gateway_handoff_value_segments" 24905 }, 24906 "segment": { 24907 "$ref": "#/definitions/gateway_handoff_segment_metadata" 24908 }, 24909 "bgpPrioritySetup": { 24910 "type": "object", 24911 "properties": { 24912 "autoAs": { 24913 "$ref": "#/definitions/gateway_handoff_value_bgp_priority_setup_auto_as" 24914 }, 24915 "autoMed": { 24916 "$ref": "#/definitions/gateway_handoff_value_bgp_priority_setup_auto_med" 24917 }, 24918 "communityMapping": { 24919 "type": "object", 24920 "properties": { 24921 "enabled": { 24922 "type": "boolean", 24923 "default": false 24924 }, 24925 "priorityMode": { 24926 "type": "string", 24927 "enum": [ 24928 "ALL_SEGMENTS", 24929 "PER_SEGMENT" 24930 ] 24931 }, 24932 "priorities": { 24933 "type": "array", 24934 "items": { 24935 "type": "object", 24936 "properties": { 24937 "community": { 24938 "type": "string" 24939 }, 24940 "community2": { 24941 "type": "string" 24942 }, 24943 "priority": { 24944 "type": "integer" 24945 } 24946 } 24947 } 24948 }, 24949 "communityAdditive": { 24950 "type": "boolean" 24951 } 24952 } 24953 } 24954 } 24955 }, 24956 "type": { 24957 "type": "string", 24958 "enum": [ 24959 "NONE", 24960 "802.1Q", 24961 "802.1ad", 24962 "QinQ (0x9100)", 24963 "QinQ (0x8100)" 24964 ] 24965 }, 24966 "override": { 24967 "type": "boolean" 24968 }, 24969 "cTag": { 24970 "type": "integer" 24971 }, 24972 "sTag": { 24973 "type": "integer" 24974 }, 24975 "localAddress": { 24976 "type": "object", 24977 "properties": { 24978 "cidrIp": { 24979 "type": "string" 24980 }, 24981 "cidrPrefix": { 24982 "type": "integer" 24983 }, 24984 "useForPrivate": { 24985 "type": "boolean" 24986 }, 24987 "advertiseViaBgp": { 24988 "type": "boolean" 24989 }, 24990 "override": { 24991 "type": "boolean" 24992 } 24993 } 24994 }, 24995 "staticRoutes": { 24996 "type": "object", 24997 "properties": { 24998 "override": { 24999 "type": "boolean" 25000 }, 25001 "subnets": { 25002 "type": "array", 25003 "items": { 25004 "type": "object", 25005 "properties": { 25006 "name": { 25007 "type": "string" 25008 }, 25009 "cidrIp": { 25010 "type": "string" 25011 }, 25012 "cidrPrefix": { 25013 "type": "integer" 25014 }, 25015 "encrypt": { 25016 "type": "boolean" 25017 }, 25018 "handOffType": { 25019 "type": "string", 25020 "enum": [ 25021 "NAT", 25022 "VLAN" 25023 ] 25024 }, 25025 "routeCost": { 25026 "type": "integer", 25027 "minimum": 0, 25028 "maximum": 255 25029 } 25030 } 25031 } 25032 } 25033 } 25034 }, 25035 "bgp": { 25036 "type": "object", 25037 "properties": { 25038 "enabled": { 25039 "type": "boolean" 25040 }, 25041 "ASN": { 25042 "type": "string" 25043 }, 25044 "neighborIp": { 25045 "type": "string" 25046 }, 25047 "neighborASN": { 25048 "type": "string" 25049 }, 25050 "encryption": { 25051 "type": "boolean" 25052 } 25053 } 25054 }, 25055 "bgpInboundMap": { 25056 "$ref": "#/definitions/gateway_handoff_bgp_rules_map" 25057 }, 25058 "bgpOutboundMap": { 25059 "$ref": "#/definitions/gateway_handoff_bgp_rules_map" 25060 }, 25061 "VLAN": { 25062 "$ref": "#/definitions/gateway_handoff_value_vlan" 25063 }, 25064 "overrides": { 25065 "type": "object", 25066 "properties": { 25067 "VLAN": { 25068 "type": "object", 25069 "additionalProperties": { 25070 "type": "object", 25071 "properties": { 25072 "type": { 25073 "type": "string" 25074 }, 25075 "cTag": { 25076 "type": "integer" 25077 }, 25078 "sTag": { 25079 "type": "integer" 25080 }, 25081 "transportLanVLAN": { 25082 "type": "string" 25083 } 25084 } 25085 } 25086 }, 25087 "bgp": { 25088 "type": "object", 25089 "additionalProperties": { 25090 "type": "object", 25091 "properties": { 25092 "enabled": { 25093 "type": "boolean" 25094 }, 25095 "ASN": { 25096 "type": "string" 25097 }, 25098 "neighborIp": { 25099 "type": "string" 25100 }, 25101 "neighborASN": { 25102 "type": "string" 25103 }, 25104 "encryption": { 25105 "type": "boolean" 25106 } 25107 } 25108 } 25109 }, 25110 "bgpInboundMap": { 25111 "type": "object", 25112 "additionalProperties": { 25113 "$ref": "#/definitions/gateway_handoff_bgp_rules_map" 25114 } 25115 }, 25116 "bgpOutboundMap": { 25117 "type": "object", 25118 "additionalProperties": { 25119 "$ref": "#/definitions/gateway_handoff_bgp_rules_map" 25120 } 25121 }, 25122 "localAddress": { 25123 "type": "object", 25124 "additionalProperties": { 25125 "type": "object", 25126 "properties": { 25127 "cidrIp": { 25128 "type": "string" 25129 }, 25130 "cidrPrefix": { 25131 "type": "integer" 25132 }, 25133 "useForPrivate": { 25134 "type": "boolean" 25135 }, 25136 "advertiseViaBgp": { 25137 "type": "boolean" 25138 } 25139 } 25140 } 25141 }, 25142 "subnets": { 25143 "type": "object", 25144 "additionalProperties": { 25145 "type": "array", 25146 "items": { 25147 "type": "object" 25148 } 25149 } 25150 } 25151 } 25152 } 25153 } 25154 }, 25155 "gateway_handoff": { 25156 "type": "object", 25157 "properties": { 25158 "enterpriseId": { 25159 "type": "integer" 25160 }, 25161 "value": { 25162 "$ref": "#/definitions/gateway_handoff_value" 25163 } 25164 } 25165 }, 25166 "gateway_handoff_bgp_rules_map": { 25167 "type": "object", 25168 "properties": { 25169 "rules": { 25170 "type": "array", 25171 "items": { 25172 "$ref": "#/definitions/gateway_handoff_bgp_rule" 25173 } 25174 }, 25175 "override": { 25176 "type": "boolean" 25177 } 25178 } 25179 }, 25180 "gateway_handoff_bgp_rule": { 25181 "allOf": [ 25182 { 25183 "$ref": "#/definitions/bgp_filter_rule" 25184 } 25185 ] 25186 }, 25187 "bgp_filter_rule": { 25188 "type": "object", 25189 "properties": { 25190 "action": { 25191 "type": "object", 25192 "properties": { 25193 "type": { 25194 "type": "string" 25195 }, 25196 "values": { 25197 "type": "array", 25198 "items": { 25199 "type": "object", 25200 "properties": { 25201 "type": { 25202 "type": "string" 25203 }, 25204 "value": { 25205 "type": "string" 25206 } 25207 } 25208 } 25209 } 25210 } 25211 }, 25212 "match": { 25213 "type": "object", 25214 "properties": { 25215 "exactMatch": { 25216 "type": "boolean" 25217 }, 25218 "type": { 25219 "type": "string" 25220 }, 25221 "value": { 25222 "type": "string" 25223 } 25224 } 25225 } 25226 } 25227 }, 25228 "network_get_network_gateways_result_item": { 25229 "type": "object", 25230 "properties": { 25231 "activationKey": { 25232 "type": "string" 25233 }, 25234 "activationState": { 25235 "type": "string", 25236 "enum": [ 25237 "UNASSIGNED", 25238 "PENDING", 25239 "ACTIVATED", 25240 "REACTIVATION_PENDING" 25241 ] 25242 }, 25243 "activationTime": { 25244 "type": "string", 25245 "format": "date-time" 25246 }, 25247 "buildNumber": { 25248 "type": "string" 25249 }, 25250 "certificates": { 25251 "type": "array", 25252 "items": { 25253 "$ref": "#/definitions/gateway_certificate" 25254 } 25255 }, 25256 "connectedEdges": { 25257 "type": "integer" 25258 }, 25259 "connectedEdgeList": { 25260 "type": "array", 25261 "items": { 25262 "type": "object", 25263 "properties": { 25264 "vceid": { 25265 "type": "string" 25266 } 25267 } 25268 } 25269 }, 25270 "created": { 25271 "type": "string", 25272 "format": "date-time" 25273 }, 25274 "dataCenters": { 25275 "type": "array", 25276 "items": { 25277 "type": "object" 25278 } 25279 }, 25280 "description": { 25281 "type": "string" 25282 }, 25283 "deviceId": { 25284 "type": "string" 25285 }, 25286 "dnsName": { 25287 "type": "string" 25288 }, 25289 "endpointPkiMode": { 25290 "type": "string", 25291 "enum": [ 25292 "CERTIFICATE_DISABLED", 25293 "CERTIFICATE_OPTIONAL", 25294 "CERTIFICATE_REQUIRED" 25295 ] 25296 }, 25297 "enterpriseAssociations": { 25298 "type": "array", 25299 "items": { 25300 "$ref": "#/definitions/gateway_enterprise_assoc" 25301 } 25302 }, 25303 "enterpriseAssociationCount": { 25304 "type": "object", 25305 "additionalProperties": { 25306 "type": "integer" 25307 } 25308 }, 25309 "enterprises": { 25310 "type": "array", 25311 "items": { 25312 "$ref": "#/definitions/enterprise" 25313 } 25314 }, 25315 "enterpriseProxyId": { 25316 "type": "integer" 25317 }, 25318 "gatewayState": { 25319 "type": "string", 25320 "enum": [ 25321 "NEVER_ACTIVATED", 25322 "DEGRADED", 25323 "QUIESCED", 25324 "DISABLED", 25325 "OUT_OF_SERVICE", 25326 "CONNECTED", 25327 "OFFLINE" 25328 ] 25329 }, 25330 "handOffDetail": { 25331 "$ref": "#/definitions/gateway_handoff_detail" 25332 }, 25333 "handOffEdges": { 25334 "type": "array", 25335 "items": { 25336 "$ref": "#/definitions/gateway_handoff_edge" 25337 } 25338 }, 25339 "id": { 25340 "type": "integer" 25341 }, 25342 "ipAddress": { 25343 "type": "string" 25344 }, 25345 "ipsecGatewayDetail": { 25346 "type": "object", 25347 "properties": { 25348 "enabled": { 25349 "type": "boolean" 25350 }, 25351 "strictHostCheck": { 25352 "type": "boolean" 25353 }, 25354 "strictHostCheckDN": { 25355 "type": "string" 25356 } 25357 } 25358 }, 25359 "isLoadBalanced": { 25360 "type": "boolean" 25361 }, 25362 "lastContact": { 25363 "type": "string" 25364 }, 25365 "logicalId": { 25366 "type": "string" 25367 }, 25368 "modified": { 25369 "type": "string", 25370 "format": "date-time" 25371 }, 25372 "name": { 25373 "type": "string" 25374 }, 25375 "networkId": { 25376 "type": "integer" 25377 }, 25378 "pools": { 25379 "type": "array", 25380 "items": { 25381 "$ref": "#/definitions/gateway_gateway_pool" 25382 } 25383 }, 25384 "privateIpAddress": { 25385 "type": "string" 25386 }, 25387 "roles": { 25388 "type": "array", 25389 "items": { 25390 "$ref": "#/definitions/gateway_role" 25391 } 25392 }, 25393 "serviceState": { 25394 "type": "string", 25395 "enum": [ 25396 "IN_SERVICE", 25397 "OUT_OF_SERVICE", 25398 "PENDING_SERVICE", 25399 "QUIESCED" 25400 ] 25401 }, 25402 "serviceUpSince": { 25403 "type": "string" 25404 }, 25405 "site": { 25406 "$ref": "#/definitions/gateway_site" 25407 }, 25408 "siteId": { 25409 "type": "integer" 25410 }, 25411 "softwareVersion": { 25412 "type": "string" 25413 }, 25414 "systemUpSince": { 25415 "type": "string" 25416 }, 25417 "utilization": { 25418 "type": "number" 25419 }, 25420 "utilizationDetail": { 25421 "type": "object", 25422 "properties": { 25423 "load": { 25424 "type": "number" 25425 }, 25426 "overall": { 25427 "type": "number" 25428 }, 25429 "cpu": { 25430 "type": "number" 25431 }, 25432 "memory": { 25433 "type": "number" 25434 } 25435 } 25436 } 25437 } 25438 }, 25439 "enterprise_proxy_get_enterprise_proxy_gateways_result_item": { 25440 "allOf": [ 25441 { 25442 "$ref": "#/definitions/network_get_network_gateways_result_item" 25443 } 25444 ] 25445 }, 25446 "network_get_network_operator_users_result_item": { 25447 "allOf": [ 25448 { 25449 "$ref": "#/definitions/operator_user_with_role_info" 25450 } 25451 ] 25452 }, 25453 "network_insert_network_gateway_pool_result": { 25454 "allOf": [ 25455 { 25456 "$ref": "#/definitions/insertion_confirmation" 25457 } 25458 ] 25459 }, 25460 "network_update_network_gateway_pool_attributes_result": { 25461 "allOf": [ 25462 { 25463 "$ref": "#/definitions/rows_modified_confirmation" 25464 } 25465 ] 25466 }, 25467 "new_enterprise_user": { 25468 "allOf": [ 25469 { 25470 "$ref": "#/definitions/base_enterprise_user" 25471 }, 25472 { 25473 "type": "object", 25474 "properties": { 25475 "enterpriseId": { 25476 "type": "integer" 25477 }, 25478 "enterpriseProxyId": { 25479 "type": "integer" 25480 }, 25481 "roleId": { 25482 "type": "integer" 25483 } 25484 }, 25485 "required": [ 25486 "roleId", 25487 "username", 25488 "password" 25489 ] 25490 } 25491 ] 25492 }, 25493 "enterprise_proxy_insert_or_update_enterprise_proxy_property_result": { 25494 "allOf": [ 25495 { 25496 "$ref": "#/definitions/insertion_confirmation" 25497 } 25498 ] 25499 }, 25500 "enterprise_proxy_property": { 25501 "type": "object", 25502 "properties": { 25503 "id": { 25504 "type": "integer" 25505 }, 25506 "enterpriseProxyId": { 25507 "type": "integer" 25508 }, 25509 "created": { 25510 "type": "string", 25511 "format": "date-time" 25512 }, 25513 "name": { 25514 "type": "string" 25515 }, 25516 "value": { 25517 "type": "string" 25518 }, 25519 "isPassword": { 25520 "type": "boolean" 25521 }, 25522 "dataType": { 25523 "type": "string", 25524 "enum": [ 25525 "STRING", 25526 "NUMBER", 25527 "BOOLEAN", 25528 "JSON", 25529 "DATE", 25530 "DATETIME" 25531 ] 25532 }, 25533 "description": { 25534 "type": "string" 25535 }, 25536 "modified": { 25537 "type": "string", 25538 "format": "date-time" 25539 } 25540 } 25541 }, 25542 "enterprise_proxy_get_enterprise_proxy_property_result": { 25543 "allOf": [ 25544 { 25545 "$ref": "#/definitions/enterprise_proxy_property" 25546 }, 25547 { 25548 "required": [ 25549 "id", 25550 "created", 25551 "name", 25552 "enterpriseProxyId", 25553 "value", 25554 "isPassword", 25555 "dataType", 25556 "description", 25557 "modified" 25558 ] 25559 } 25560 ] 25561 }, 25562 "new_enterprise_proxy_user": { 25563 "allOf": [ 25564 { 25565 "$ref": "#/definitions/new_enterprise_user" 25566 } 25567 ] 25568 }, 25569 "operator_user_insert_operator_user": { 25570 "allOf": [ 25571 { 25572 "$ref": "#/definitions/base_enterprise_user" 25573 }, 25574 { 25575 "properties": { 25576 "networkId": { 25577 "type": "integer" 25578 }, 25579 "roleId": { 25580 "type": "integer" 25581 } 25582 }, 25583 "required": [ 25584 "networkId", 25585 "roleId", 25586 "username", 25587 "password" 25588 ], 25589 "type": "object" 25590 } 25591 ] 25592 }, 25593 "role_create_role_customization_result": { 25594 "allOf": [ 25595 { 25596 "$ref": "#/definitions/empty_object" 25597 } 25598 ] 25599 }, 25600 "role_delete_role_customization_result": { 25601 "allOf": [ 25602 { 25603 "$ref": "#/definitions/deletion_confirmation" 25604 } 25605 ] 25606 }, 25607 "role_get_user_type_roles_result_item": { 25608 "allOf": [ 25609 { 25610 "$ref": "#/definitions/role" 25611 }, 25612 { 25613 "required": [ 25614 "id", 25615 "created", 25616 "operatorId", 25617 "networkId", 25618 "enterpriseId", 25619 "enterpriseProxyId", 25620 "name", 25621 "userType", 25622 "fromUserType", 25623 "isSuper", 25624 "description", 25625 "precedence", 25626 "modified" 25627 ] 25628 } 25629 ] 25630 }, 25631 "set_delegated_result": { 25632 "type": "object", 25633 "properties": { 25634 "isDelegated": { 25635 "type": "boolean" 25636 } 25637 }, 25638 "required": [ 25639 "isDelegated" 25640 ] 25641 }, 25642 "role_set_enterprise_delegated_to_enterprise_proxy_result": { 25643 "allOf": [ 25644 { 25645 "$ref": "#/definitions/set_delegated_result" 25646 } 25647 ] 25648 }, 25649 "role_set_enterprise_delegated_to_operator_result": { 25650 "allOf": [ 25651 { 25652 "$ref": "#/definitions/set_delegated_result" 25653 } 25654 ] 25655 }, 25656 "role_set_enterprise_proxy_delegated_to_operator_result": { 25657 "allOf": [ 25658 { 25659 "$ref": "#/definitions/set_delegated_result" 25660 } 25661 ] 25662 }, 25663 "role_set_enterprise_user_management_delegated_to_operator_result": { 25664 "allOf": [ 25665 { 25666 "$ref": "#/definitions/set_delegated_result" 25667 } 25668 ] 25669 }, 25670 "system_property": { 25671 "type": "object", 25672 "properties": { 25673 "id": { 25674 "type": "integer" 25675 }, 25676 "created": { 25677 "type": "string", 25678 "format": "date-time" 25679 }, 25680 "name": { 25681 "type": "string" 25682 }, 25683 "value": { 25684 "type": "string" 25685 }, 25686 "defaultValue": { 25687 "type": "string" 25688 }, 25689 "isReadOnly": { 25690 "type": "boolean" 25691 }, 25692 "isPassword": { 25693 "type": "boolean" 25694 }, 25695 "dataType": { 25696 "type": "string", 25697 "enum": [ 25698 "STRING", 25699 "NUMBER", 25700 "BOOLEAN", 25701 "JSON", 25702 "DATE", 25703 "DATETIME" 25704 ] 25705 }, 25706 "description": { 25707 "type": "string" 25708 }, 25709 "modified": { 25710 "type": "string", 25711 "format": "date-time" 25712 } 25713 } 25714 }, 25715 "system_property_get_system_property_result": { 25716 "allOf": [ 25717 { 25718 "$ref": "#/definitions/system_property" 25719 }, 25720 { 25721 "required": [ 25722 "id", 25723 "created", 25724 "name", 25725 "value", 25726 "defaultValue", 25727 "isReadOnly", 25728 "isPassword", 25729 "dataType", 25730 "description" 25731 ] 25732 } 25733 ] 25734 }, 25735 "system_property_get_system_properties_result_item": { 25736 "allOf": [ 25737 { 25738 "$ref": "#/definitions/system_property" 25739 }, 25740 { 25741 "required": [ 25742 "id", 25743 "created", 25744 "name", 25745 "value", 25746 "defaultValue", 25747 "isReadOnly", 25748 "isPassword", 25749 "dataType", 25750 "description" 25751 ] 25752 } 25753 ] 25754 }, 25755 "system_property_insert_or_update_system_property_result": { 25756 "allOf": [ 25757 { 25758 "$ref": "#/definitions/insertion_confirmation" 25759 } 25760 ] 25761 }, 25762 "system_property_insert_system_property_result": { 25763 "allOf": [ 25764 { 25765 "$ref": "#/definitions/insertion_confirmation" 25766 } 25767 ] 25768 }, 25769 "system_property_update_system_property_result": { 25770 "allOf": [ 25771 { 25772 "$ref": "#/definitions/rows_modified_confirmation" 25773 } 25774 ] 25775 }, 25776 "enterprise_get_enterprise_users_result_item": { 25777 "allOf": [ 25778 { 25779 "$ref": "#/definitions/enterprise_user_with_role_info" 25780 }, 25781 { 25782 "required": [ 25783 "id", 25784 "created", 25785 "userType", 25786 "username", 25787 "domain", 25788 "password", 25789 "firstName", 25790 "lastName", 25791 "officePhone", 25792 "mobilePhone", 25793 "email", 25794 "isNative", 25795 "isActive", 25796 "isLocked", 25797 "disableSecondFactor", 25798 "lastLogin", 25799 "modified", 25800 "roleId", 25801 "roleName" 25802 ] 25803 } 25804 ] 25805 }, 25806 "enterprise_insert_enterprise_user_result": { 25807 "allOf": [ 25808 { 25809 "$ref": "#/definitions/insertion_confirmation" 25810 } 25811 ] 25812 }, 25813 "enterprise_user_delete_enterprise_user_result": { 25814 "allOf": [ 25815 { 25816 "$ref": "#/definitions/deletion_confirmation" 25817 } 25818 ] 25819 }, 25820 "enterprise_user_get_enterprise_user_result": { 25821 "allOf": [ 25822 { 25823 "$ref": "#/definitions/enterprise_user_with_role_and_assocs" 25824 }, 25825 { 25826 "required": [ 25827 "id", 25828 "created", 25829 "userType", 25830 "username", 25831 "domain", 25832 "password", 25833 "firstName", 25834 "lastName", 25835 "officePhone", 25836 "mobilePhone", 25837 "email", 25838 "isNative", 25839 "isActive", 25840 "isLocked", 25841 "lastLogin", 25842 "modified", 25843 "roleId", 25844 "roleName", 25845 "enterpriseId", 25846 "enterpriseProxyId", 25847 "networkId" 25848 ] 25849 } 25850 ] 25851 }, 25852 "enterprise_user_update_enterprise_user": { 25853 "type": "object", 25854 "properties": { 25855 "domain": { 25856 "type": "string" 25857 }, 25858 "password": { 25859 "type": "string", 25860 "format": "password" 25861 }, 25862 "password2": { 25863 "type": "string", 25864 "format": "password" 25865 }, 25866 "firstName": { 25867 "type": "string" 25868 }, 25869 "lastName": { 25870 "type": "string" 25871 }, 25872 "officePhone": { 25873 "type": "string" 25874 }, 25875 "mobilePhone": { 25876 "type": "string" 25877 }, 25878 "isNative": { 25879 "type": "boolean" 25880 }, 25881 "isActive": { 25882 "type": "boolean" 25883 }, 25884 "disableSecondFactor": { 25885 "type": "boolean" 25886 }, 25887 "email": { 25888 "type": "string" 25889 }, 25890 "roleId": { 25891 "type": "integer" 25892 } 25893 } 25894 }, 25895 "enterprise_user_update_enterprise_user_result": { 25896 "allOf": [ 25897 { 25898 "$ref": "#/definitions/rows_modified_confirmation" 25899 } 25900 ] 25901 }, 25902 "enterprise_proxy_delete_enterprise_proxy_user_result": { 25903 "allOf": [ 25904 { 25905 "$ref": "#/definitions/rows_modified_confirmation" 25906 } 25907 ] 25908 }, 25909 "enterprise_proxy_get_enterprise_proxy_user_result": { 25910 "allOf": [ 25911 { 25912 "$ref": "#/definitions/enterprise_user_with_role_info" 25913 }, 25914 { 25915 "properties": { 25916 "enterpriseProxyId": { 25917 "type": "integer" 25918 }, 25919 "networkId": { 25920 "type": "integer" 25921 } 25922 } 25923 } 25924 ] 25925 }, 25926 "enterprise_proxy_insert_enterprise_proxy_user_result": { 25927 "allOf": [ 25928 { 25929 "$ref": "#/definitions/insertion_confirmation" 25930 } 25931 ] 25932 }, 25933 "enterprise_proxy_update_enterprise_proxy_user_result": { 25934 "allOf": [ 25935 { 25936 "$ref": "#/definitions/rows_modified_confirmation" 25937 } 25938 ] 25939 }, 25940 "enterprise_proxy_get_enterprise_proxy_users_result_item": { 25941 "allOf": [ 25942 { 25943 "$ref": "#/definitions/enterprise_user_with_role_info" 25944 }, 25945 { 25946 "properties": { 25947 "enterpriseProxyId": { 25948 "type": "integer" 25949 }, 25950 "networkId": { 25951 "type": "integer" 25952 } 25953 } 25954 } 25955 ] 25956 }, 25957 "operator_user_delete_operator_user_result": { 25958 "allOf": [ 25959 { 25960 "$ref": "#/definitions/deletion_confirmation" 25961 } 25962 ] 25963 }, 25964 "operator_user_get_operator_user_result": { 25965 "allOf": [ 25966 { 25967 "$ref": "#/definitions/operator_user_with_role_info" 25968 } 25969 ] 25970 }, 25971 "operator_user_insert_operator_user_result": { 25972 "allOf": [ 25973 { 25974 "$ref": "#/definitions/insertion_confirmation" 25975 } 25976 ] 25977 }, 25978 "operator_user_update_operator_user": { 25979 "type": "object", 25980 "properties": { 25981 "firstName": { 25982 "type": "string" 25983 }, 25984 "lastName": { 25985 "type": "string" 25986 }, 25987 "password": { 25988 "type": "string", 25989 "format": "password" 25990 }, 25991 "password2": { 25992 "type": "string", 25993 "format": "password" 25994 }, 25995 "roleId": { 25996 "type": "integer" 25997 }, 25998 "email": { 25999 "type": "string" 26000 }, 26001 "mobilePhone": { 26002 "type": "string" 26003 }, 26004 "officePhone": { 26005 "type": "string" 26006 }, 26007 "operatorId": { 26008 "type": "integer" 26009 }, 26010 "userType": { 26011 "type": "string" 26012 }, 26013 "username": { 26014 "type": "string" 26015 }, 26016 "domain": { 26017 "type": "string" 26018 }, 26019 "isNative": { 26020 "type": "boolean" 26021 }, 26022 "isLocked": { 26023 "type": "boolean" 26024 }, 26025 "isActive": { 26026 "type": "boolean" 26027 } 26028 } 26029 }, 26030 "operator_user_update_operator_user_result": { 26031 "allOf": [ 26032 { 26033 "$ref": "#/definitions/rows_modified_confirmation" 26034 } 26035 ] 26036 }, 26037 "role": { 26038 "type": "object", 26039 "properties": { 26040 "id": { 26041 "type": "integer" 26042 }, 26043 "created": { 26044 "type": "string", 26045 "format": "date-time" 26046 }, 26047 "operatorId": { 26048 "type": "integer" 26049 }, 26050 "networkId": { 26051 "type": "integer" 26052 }, 26053 "enterpriseId": { 26054 "type": "integer" 26055 }, 26056 "enterpriseProxyId": { 26057 "type": "integer" 26058 }, 26059 "name": { 26060 "type": "string" 26061 }, 26062 "userType": { 26063 "type": "string", 26064 "enum": [ 26065 "OPERATOR", 26066 "MSP", 26067 "PARTNER", 26068 "ENTERPRISE", 26069 "END_USER", 26070 "CUSTOM" 26071 ] 26072 }, 26073 "fromUserType": { 26074 "type": "string", 26075 "enum": [ 26076 "OPERATOR", 26077 "MSP", 26078 "PARTNER", 26079 "ENTERPRISE", 26080 "END_USER", 26081 "CUSTOM" 26082 ] 26083 }, 26084 "isSuper": { 26085 "type": "integer" 26086 }, 26087 "description": { 26088 "type": "string" 26089 }, 26090 "precedence": { 26091 "type": "integer" 26092 }, 26093 "modified": { 26094 "type": "string", 26095 "format": "date-time" 26096 } 26097 } 26098 }, 26099 "protocol_port_mapping": { 26100 "properties": { 26101 "tcpPorts": { 26102 "items": { 26103 "type": "integer" 26104 }, 26105 "type": "array" 26106 }, 26107 "udpPorts": { 26108 "items": { 26109 "type": "integer" 26110 }, 26111 "type": "array" 26112 } 26113 }, 26114 "type": "object" 26115 }, 26116 "rows_modified_confirmation": { 26117 "type": "object", 26118 "properties": { 26119 "error": { 26120 "description": "An error message explaining why the method failed", 26121 "type": "string" 26122 }, 26123 "rows": { 26124 "description": "The number of rows modified", 26125 "type": "integer" 26126 } 26127 }, 26128 "required": [ 26129 "rows" 26130 ], 26131 "example": { 26132 "rows": 1 26133 } 26134 }, 26135 "insertion_confirmation": { 26136 "type": "object", 26137 "properties": { 26138 "id": { 26139 "type": "integer", 26140 "description": "The id of the newly-created object." 26141 }, 26142 "rows": { 26143 "description": "The number of rows modified", 26144 "type": "integer" 26145 }, 26146 "error": { 26147 "description": "An error message explaining why the method failed", 26148 "type": "string" 26149 } 26150 }, 26151 "required": [ 26152 "rows" 26153 ], 26154 "example": { 26155 "id": 123, 26156 "rows": 1 26157 } 26158 }, 26159 "deletion_confirmation": { 26160 "type": "object", 26161 "properties": { 26162 "id": { 26163 "type": "integer", 26164 "description": "The id of the deleted object." 26165 }, 26166 "error": { 26167 "description": "An error message explaining why the method failed", 26168 "type": "string" 26169 }, 26170 "rows": { 26171 "description": "The number of rows modified", 26172 "type": "integer" 26173 } 26174 }, 26175 "required": [ 26176 "rows" 26177 ], 26178 "example": { 26179 "id": 123, 26180 "rows": 1 26181 } 26182 }, 26183 "license": { 26184 "type": "object", 26185 "properties": { 26186 "tier": { 26187 "type": "string" 26188 }, 26189 "bandwidth": { 26190 "type": "string" 26191 }, 26192 "term": { 26193 "type": "number" 26194 }, 26195 "cloudGatewayRegions": { 26196 "type": "array", 26197 "items": { 26198 "type": "string" 26199 } 26200 } 26201 } 26202 }, 26203 "site": { 26204 "type": "object", 26205 "properties": { 26206 "id": { 26207 "type": "integer" 26208 }, 26209 "created": { 26210 "type": "string", 26211 "format": "date-time" 26212 }, 26213 "name": { 26214 "type": "string" 26215 }, 26216 "contactName": { 26217 "type": "string" 26218 }, 26219 "contactPhone": { 26220 "type": "string" 26221 }, 26222 "contactMobile": { 26223 "type": "string" 26224 }, 26225 "contactEmail": { 26226 "type": "string" 26227 }, 26228 "streetAddress": { 26229 "type": "string" 26230 }, 26231 "streetAddress2": { 26232 "type": "string" 26233 }, 26234 "city": { 26235 "type": "string" 26236 }, 26237 "state": { 26238 "type": "string" 26239 }, 26240 "postalCode": { 26241 "type": "string" 26242 }, 26243 "country": { 26244 "type": "string" 26245 }, 26246 "lat": { 26247 "type": "number", 26248 "format": "double" 26249 }, 26250 "lon": { 26251 "type": "number", 26252 "format": "double" 26253 }, 26254 "timezone": { 26255 "type": "string" 26256 }, 26257 "locale": { 26258 "type": "string" 26259 }, 26260 "shippingSameAsLocation": { 26261 "$ref": "#/definitions/tinyint" 26262 }, 26263 "shippingContactName": { 26264 "type": "string" 26265 }, 26266 "shippingAddress": { 26267 "type": "string" 26268 }, 26269 "shippingAddress2": { 26270 "type": "string" 26271 }, 26272 "shippingCity": { 26273 "type": "string" 26274 }, 26275 "shippingState": { 26276 "type": "string" 26277 }, 26278 "shippingCountry": { 26279 "type": "string" 26280 }, 26281 "shippingPostalCode": { 26282 "type": "string" 26283 }, 26284 "modified": { 26285 "type": "string", 26286 "format": "date-time" 26287 } 26288 } 26289 }, 26290 "firewall_get_enterprise_firewall_logs_result": { 26291 "type": "object", 26292 "properties": { 26293 "metaData": { 26294 "$ref": "#/definitions/list_metadata" 26295 }, 26296 "data": { 26297 "type": "array", 26298 "items": { 26299 "$ref": "#/definitions/firewall_log_data" 26300 } 26301 }, 26302 "rules": { 26303 "type": "object", 26304 "additionalProperties": { 26305 "$ref": "#/definitions/firewall_rule" 26306 } 26307 } 26308 } 26309 }, 26310 "firewall_log_data": { 26311 "type": "object", 26312 "properties": { 26313 "id": { 26314 "type": "integer" 26315 }, 26316 "edgeId": { 26317 "type": "integer" 26318 }, 26319 "timestamp": { 26320 "type": "string", 26321 "format": "date-time" 26322 }, 26323 "allow": { 26324 "type": "integer" 26325 }, 26326 "ruleLogicalId": { 26327 "type": "string" 26328 }, 26329 "interface": { 26330 "type": "string" 26331 }, 26332 "protocol": { 26333 "type": "string", 26334 "enum": [ 26335 "ICMP", 26336 "TCP", 26337 "UDP", 26338 "GRE" 26339 ] 26340 }, 26341 "sourceIp": { 26342 "type": "string" 26343 }, 26344 "sourcePort": { 26345 "type": "integer" 26346 }, 26347 "destIp": { 26348 "type": "string" 26349 }, 26350 "destPort": { 26351 "type": "integer" 26352 }, 26353 "icmpType": { 26354 "type": "string" 26355 }, 26356 "length": { 26357 "type": "integer" 26358 } 26359 } 26360 }, 26361 "firewall_rule": { 26362 "type": "object", 26363 "properties": { 26364 "created": { 26365 "type": "string", 26366 "format": "date-time" 26367 }, 26368 "data": { 26369 "type": "string" 26370 }, 26371 "deactivated": { 26372 "type": "string" 26373 }, 26374 "edgeLogicalId": { 26375 "type": "string" 26376 }, 26377 "enterpriseId": { 26378 "type": "integer" 26379 }, 26380 "id": { 26381 "type": "integer" 26382 }, 26383 "logicalId": { 26384 "type": "string" 26385 }, 26386 "name": { 26387 "type": "string" 26388 }, 26389 "type": { 26390 "type": "string", 26391 "enum": [ 26392 "INBOUND", 26393 "OUTBOUND", 26394 "SERVICE" 26395 ] 26396 } 26397 } 26398 }, 26399 "vco_inventory_get_inventory_items_result": { 26400 "type": "array", 26401 "items": { 26402 "$ref": "#/definitions/inventory_item" 26403 } 26404 }, 26405 "inventory_item": { 26406 "type": "object", 26407 "properties": { 26408 "id": { 26409 "type": "integer" 26410 }, 26411 "deviceSerialNumber": { 26412 "type": "string" 26413 }, 26414 "deviceUuid": { 26415 "type": "string" 26416 }, 26417 "modelNumber": { 26418 "type": "string" 26419 }, 26420 "siteId": { 26421 "type": "integer" 26422 }, 26423 "description": { 26424 "type": "string" 26425 }, 26426 "acknowledged": { 26427 "type": "integer" 26428 }, 26429 "edgeId": { 26430 "type": "integer" 26431 }, 26432 "edge": { 26433 "type": "object", 26434 "properties": { 26435 "id": { 26436 "type": "integer" 26437 }, 26438 "edge": { 26439 "type": "string" 26440 }, 26441 "site": { 26442 "type": "object", 26443 "properties": { 26444 "name": { 26445 "type": "string" 26446 } 26447 } 26448 } 26449 } 26450 }, 26451 "inventoryState": { 26452 "type": "string" 26453 }, 26454 "inventoryEdgeState": { 26455 "type": "string" 26456 }, 26457 "inventoryAction": { 26458 "type": "string" 26459 }, 26460 "vcoOwnerId": { 26461 "type": "integer" 26462 }, 26463 "vcoOwner": { 26464 "type": "object", 26465 "properties": { 26466 "accountNumber": { 26467 "type": "string" 26468 }, 26469 "name": { 26470 "type": "string" 26471 } 26472 } 26473 }, 26474 "modified": { 26475 "type": "string", 26476 "format": "date-time" 26477 } 26478 } 26479 }, 26480 "basic_metric_summary": { 26481 "properties": { 26482 "min": { 26483 "type": "number" 26484 }, 26485 "max": { 26486 "type": "number" 26487 }, 26488 "average": { 26489 "type": "number" 26490 } 26491 }, 26492 "type": "object", 26493 "required": [ 26494 "min", 26495 "max", 26496 "average" 26497 ] 26498 }, 26499 "gateway_metric": { 26500 "enum": [ 26501 "tunnelCount", 26502 "memoryPct", 26503 "flowCount", 26504 "cpuPct", 26505 "handoffQueueDrops", 26506 "connectedEdges" 26507 ], 26508 "type": "string" 26509 }, 26510 "gateway_metrics": { 26511 "items": { 26512 "$ref": "#/definitions/gateway_metric" 26513 }, 26514 "type": "array" 26515 }, 26516 "gateway_status_metrics_summary": { 26517 "type": "object", 26518 "title": "metrics_get_gateway_status_metrics_result", 26519 "properties": { 26520 "total": { 26521 "type": "integer" 26522 }, 26523 "tunnelCount": { 26524 "$ref": "#/definitions/basic_metric_summary" 26525 }, 26526 "memoryPct": { 26527 "$ref": "#/definitions/basic_metric_summary" 26528 }, 26529 "flowCount": { 26530 "$ref": "#/definitions/basic_metric_summary" 26531 }, 26532 "cpuPct": { 26533 "$ref": "#/definitions/basic_metric_summary" 26534 }, 26535 "handoffQueueDrops": { 26536 "$ref": "#/definitions/basic_metric_summary" 26537 }, 26538 "connectedEdges": { 26539 "$ref": "#/definitions/basic_metric_summary" 26540 } 26541 } 26542 }, 26543 "gateway_status_metrics_time_series_item": { 26544 "type": "object", 26545 "title": "gateway_status_metrics_time_series_item", 26546 "properties": { 26547 "tunnelCount": { 26548 "type": "integer" 26549 }, 26550 "memoryPct": { 26551 "type": "number" 26552 }, 26553 "flowCount": { 26554 "type": "number" 26555 }, 26556 "cpuPct": { 26557 "type": "number" 26558 }, 26559 "handoffQueueDrops": { 26560 "type": "integer" 26561 }, 26562 "connectedEdges": { 26563 "type": "integer" 26564 }, 26565 "startTime": { 26566 "type": "string", 26567 "format": "date-time" 26568 } 26569 }, 26570 "required": [ 26571 "startTime" 26572 ] 26573 }, 26574 "get_gateway_status_metrics_time_series_result": { 26575 "type": "object", 26576 "title": "gateway_status_metrics_time_series_result", 26577 "properties": { 26578 "series": { 26579 "type": "array", 26580 "items": { 26581 "$ref": "#/definitions/gateway_status_metrics_time_series_item" 26582 } 26583 } 26584 }, 26585 "required": [ 26586 "series" 26587 ] 26588 }, 26589 "monitoring_network_gateway_status_item": { 26590 "type": "object", 26591 "title": "monitoring_network_gateway_status_item", 26592 "properties": { 26593 "gatewayId": { 26594 "type": "integer" 26595 }, 26596 "tunnelCount": { 26597 "type": "integer" 26598 }, 26599 "memoryPct": { 26600 "type": "number" 26601 }, 26602 "flowCount": { 26603 "type": "number" 26604 }, 26605 "cpuPct": { 26606 "type": "number" 26607 }, 26608 "handoffQueueDrops": { 26609 "type": "integer" 26610 }, 26611 "connectedEdges": { 26612 "type": "integer" 26613 } 26614 }, 26615 "required": [ 26616 "gatewayId" 26617 ] 26618 }, 26619 "monitoring_get_network_gateway_status_result": { 26620 "type": "object", 26621 "title": "monitoring_network_gateway_status_result", 26622 "properties": { 26623 "metaData": { 26624 "type": "object", 26625 "properties": { 26626 "limit": { 26627 "type": "integer" 26628 }, 26629 "more": { 26630 "type": "boolean" 26631 } 26632 } 26633 }, 26634 "data": { 26635 "type": "array", 26636 "items": { 26637 "$ref": "#/definitions/monitoring_network_gateway_status_item" 26638 } 26639 } 26640 }, 26641 "required": [ 26642 "metaData", 26643 "data" 26644 ] 26645 }, 26646 "edge_metric": { 26647 "enum": [ 26648 "tunnelCount", 26649 "memoryPct", 26650 "flowCount", 26651 "cpuPct", 26652 "handoffQueueDrops" 26653 ], 26654 "type": "string" 26655 }, 26656 "edge_metrics": { 26657 "items": { 26658 "$ref": "#/definitions/edge_metric" 26659 }, 26660 "type": "array" 26661 }, 26662 "edge_status_metrics_summary": { 26663 "type": "object", 26664 "properties": { 26665 "total": { 26666 "type": "integer" 26667 }, 26668 "tunnelCount": { 26669 "$ref": "#/definitions/basic_metric_summary" 26670 }, 26671 "memoryPct": { 26672 "$ref": "#/definitions/basic_metric_summary" 26673 }, 26674 "flowCount": { 26675 "$ref": "#/definitions/basic_metric_summary" 26676 }, 26677 "cpuPct": { 26678 "$ref": "#/definitions/basic_metric_summary" 26679 }, 26680 "handoffQueueDrops": { 26681 "$ref": "#/definitions/basic_metric_summary" 26682 } 26683 } 26684 }, 26685 "edge_status_metrics_time_series_item": { 26686 "type": "object", 26687 "title": "edge_status_metrics_time_series_item", 26688 "properties": { 26689 "tunnelCount": { 26690 "type": "integer" 26691 }, 26692 "memoryPct": { 26693 "type": "number" 26694 }, 26695 "flowCount": { 26696 "type": "number" 26697 }, 26698 "cpuPct": { 26699 "type": "number" 26700 }, 26701 "handoffQueueDrops": { 26702 "type": "integer" 26703 }, 26704 "startTime": { 26705 "type": "string", 26706 "format": "date-time" 26707 } 26708 }, 26709 "required": [ 26710 "startTime" 26711 ] 26712 }, 26713 "get_edge_status_metrics_time_series_result": { 26714 "type": "object", 26715 "title": "edge_status_metrics_time_series_result", 26716 "properties": { 26717 "series": { 26718 "type": "array", 26719 "items": { 26720 "$ref": "#/definitions/edge_status_metrics_time_series_item" 26721 } 26722 } 26723 }, 26724 "required": [ 26725 "series" 26726 ] 26727 }, 26728 "monitoring_enterprise_edge_status_item": { 26729 "type": "object", 26730 "title": "monitoring_enterprise_edge_status_item", 26731 "properties": { 26732 "edgeId": { 26733 "type": "integer" 26734 }, 26735 "name": { 26736 "type": "string" 26737 }, 26738 "tunnelCount": { 26739 "type": "integer" 26740 }, 26741 "memoryPct": { 26742 "type": "number" 26743 }, 26744 "flowCount": { 26745 "type": "number" 26746 }, 26747 "cpuPct": { 26748 "type": "number" 26749 }, 26750 "handoffQueueDrops": { 26751 "type": "integer" 26752 } 26753 }, 26754 "required": [ 26755 "edgeId" 26756 ] 26757 }, 26758 "monitoring_get_enterprise_edge_status_result": { 26759 "type": "object", 26760 "title": "monitoring_enterprise_edge_status_result", 26761 "properties": { 26762 "metaData": { 26763 "type": "object", 26764 "properties": { 26765 "limit": { 26766 "type": "integer" 26767 }, 26768 "more": { 26769 "type": "boolean" 26770 } 26771 } 26772 }, 26773 "data": { 26774 "type": "array", 26775 "items": { 26776 "$ref": "#/definitions/monitoring_enterprise_edge_status_item" 26777 } 26778 } 26779 }, 26780 "required": [ 26781 "metaData", 26782 "data" 26783 ] 26784 }, 26785 "edge_get_edge_certificates_result_item": { 26786 "allOf": [ 26787 { 26788 "$ref": "#/definitions/edge_certificate" 26789 } 26790 ] 26791 }, 26792 "enterprise_get_enterprise_network_segments_result_item": { 26793 "allOf": [ 26794 { 26795 "$ref": "#/definitions/network_segment" 26796 }, 26797 { 26798 "type": "object", 26799 "properties": { 26800 "edgeCount": { 26801 "type": "integer" 26802 }, 26803 "edgeUsage": { 26804 "type": "array", 26805 "items": { 26806 "type": "object", 26807 "properties": { 26808 "configurationId": { 26809 "type": "integer" 26810 }, 26811 "edgeSpecificId": { 26812 "type": "integer" 26813 }, 26814 "name": { 26815 "type": "string" 26816 }, 26817 "logicalId": { 26818 "type": "string" 26819 }, 26820 "profileId": { 26821 "type": "integer" 26822 } 26823 } 26824 } 26825 }, 26826 "configuration": { 26827 "type": "array", 26828 "items": { 26829 "type": "object", 26830 "properties": { 26831 "id": { 26832 "type": "integer" 26833 }, 26834 "created": { 26835 "type": "string", 26836 "format": "date-time" 26837 }, 26838 "name": { 26839 "type": "string" 26840 }, 26841 "logicalId": { 26842 "type": "string" 26843 }, 26844 "version": { 26845 "type": "string" 26846 }, 26847 "description": { 26848 "type": "string" 26849 }, 26850 "configurationType": { 26851 "type": "string", 26852 "enum": [ 26853 "NETWORK_BASED", 26854 "SEGMENT_BASED" 26855 ] 26856 }, 26857 "schemaVersion": { 26858 "type": "string" 26859 }, 26860 "effective": { 26861 "type": "string" 26862 }, 26863 "modified": { 26864 "type": "string", 26865 "format": "date-time" 26866 }, 26867 "moduleId": { 26868 "type": "integer" 26869 }, 26870 "segmentObjectId": { 26871 "type": "integer" 26872 } 26873 } 26874 } 26875 } 26876 } 26877 } 26878 ] 26879 }, 26880 "enterprise_encode_enterprise_key_result": { 26881 "type": "object", 26882 "properties": { 26883 "key": { 26884 "type": "string" 26885 } 26886 }, 26887 "required": [ 26888 "key" 26889 ] 26890 }, 26891 "enterprise_decode_enterprise_key_result": { 26892 "type": "object", 26893 "properties": { 26894 "key": { 26895 "type": "string" 26896 } 26897 }, 26898 "required": [ 26899 "key" 26900 ] 26901 }, 26902 "network_segment": { 26903 "allOf": [ 26904 { 26905 "$ref": "#/definitions/enterprise_object_base" 26906 }, 26907 { 26908 "type": "object", 26909 "properties": { 26910 "data": { 26911 "$ref": "#/definitions/network_segment_data" 26912 }, 26913 "profileCount": { 26914 "type": "integer" 26915 }, 26916 "handoffUsage": { 26917 "type": "array", 26918 "items": { 26919 "type": "object" 26920 } 26921 }, 26922 "isAllMPGCDE": { 26923 "type": "boolean" 26924 }, 26925 "isAllCtrlCDE": { 26926 "type": "boolean" 26927 } 26928 } 26929 } 26930 ] 26931 }, 26932 "network_segment_data": { 26933 "type": "object", 26934 "properties": { 26935 "segmentId": { 26936 "type": "integer" 26937 }, 26938 "serviceVlan": { 26939 "type": "integer" 26940 }, 26941 "delegateToEnterprise": { 26942 "type": "boolean" 26943 }, 26944 "delegateToEnterpriseProxy": { 26945 "type": "boolean" 26946 } 26947 } 26948 }, 26949 "cloud_security_service": { 26950 "allOf": [ 26951 { 26952 "$ref": "#/definitions/enterprise_object_base" 26953 }, 26954 { 26955 "type": "object", 26956 "properties": { 26957 "data": { 26958 "$ref": "#/definitions/cloud_security_service_data" 26959 } 26960 } 26961 } 26962 ] 26963 }, 26964 "cloud_security_service_data": { 26965 "type": "object", 26966 "properties": { 26967 "type": { 26968 "type": "string", 26969 "pattern": "cloudSecurityService" 26970 }, 26971 "provider": { 26972 "type": "string", 26973 "enum": [ 26974 "symantecCloudSecurityService", 26975 "zscalerWebSecurityService", 26976 "genericCloudSecurityService" 26977 ] 26978 }, 26979 "config": { 26980 "$ref": "#/definitions/cloud_security_service_provider_config" 26981 } 26982 } 26983 }, 26984 "cloud_security_service_provider_config": { 26985 "type": "object", 26986 "properties": { 26987 "primaryServer": { 26988 "type": "string" 26989 }, 26990 "secondaryServer": { 26991 "type": "string" 26992 }, 26993 "enableTunnels": { 26994 "type": "boolean" 26995 }, 26996 "sharedIkeAuth": { 26997 "type": "boolean" 26998 }, 26999 "maxTunnelsPerIkeIdentity": { 27000 "type": "integer" 27001 }, 27002 "automateDeployment": { 27003 "type": "boolean" 27004 }, 27005 "credentials": { 27006 "type": "object", 27007 "properties": { 27008 "username": { 27009 "type": "string" 27010 }, 27011 "password": { 27012 "type": "string" 27013 }, 27014 "validated": { 27015 "type": "boolean" 27016 } 27017 } 27018 } 27019 } 27020 }, 27021 "cloud_security_service_site": { 27022 "allOf": [ 27023 { 27024 "$ref": "#/definitions/enterprise_object_base" 27025 }, 27026 { 27027 "type": "object", 27028 "properties": { 27029 "data": { 27030 "$ref": "#/definitions/cloud_security_service_site_data" 27031 } 27032 } 27033 } 27034 ] 27035 }, 27036 "cloud_security_service_site_data": { 27037 "type": "object" 27038 }, 27039 "cloud_security_service_site_data_generic_ipsec": { 27040 "type": "object", 27041 "properties": { 27042 "ikeId": { 27043 "type": "string" 27044 }, 27045 "ikeIdType": { 27046 "type": "string" 27047 }, 27048 "psk": { 27049 "type": "string" 27050 }, 27051 "pskType": { 27052 "type": "string" 27053 } 27054 } 27055 }, 27056 "cloud_security_service_site_data_zscaler_gre": { 27057 "type": "object", 27058 "properties": { 27059 "customSourceIp": { 27060 "type": "string" 27061 }, 27062 "linkInternalLogicalId": { 27063 "type": "string" 27064 }, 27065 "primaryAddressing": { 27066 "type": "object", 27067 "properties": { 27068 "internalRouterIp": { 27069 "type": "string" 27070 }, 27071 "internalRouterMask": { 27072 "type": "string" 27073 }, 27074 "internalZenIp": { 27075 "type": "string" 27076 }, 27077 "internalZenMask": { 27078 "type": "string" 27079 } 27080 } 27081 }, 27082 "secondaryAddressing": { 27083 "type": "object", 27084 "properties": { 27085 "internalRouterIp": { 27086 "type": "string" 27087 }, 27088 "internalRouterMask": { 27089 "type": "string" 27090 }, 27091 "internalZenIp": { 27092 "type": "string" 27093 }, 27094 "internalZenMask": { 27095 "type": "string" 27096 } 27097 } 27098 }, 27099 "useCustomSourceIp": { 27100 "type": "boolean" 27101 } 27102 } 27103 }, 27104 "security_vnf_service": { 27105 "allOf": [ 27106 { 27107 "$ref": "#/definitions/enterprise_object_base" 27108 }, 27109 { 27110 "type": "object", 27111 "properties": { 27112 "data": { 27113 "$ref": "#/definitions/security_vnf_service_data" 27114 } 27115 } 27116 } 27117 ] 27118 }, 27119 "security_vnf_service_data": { 27120 "type": "object", 27121 "properties": { 27122 "type": { 27123 "type": "string", 27124 "pattern": "securityVnfService" 27125 }, 27126 "vendor": { 27127 "type": "string", 27128 "enum": [ 27129 "PaloAlto", 27130 "CheckPoint", 27131 "Fortinet", 27132 "CentOS" 27133 ] 27134 }, 27135 "vendorSpecificData": { 27136 "$ref": "#/definitions/security_vnf_service_data" 27137 } 27138 } 27139 }, 27140 "security_vnf_service_vendor_specific_data": { 27141 "type": "object" 27142 }, 27143 "security_vnf_service_palo_alto_networks": { 27144 "type": "object", 27145 "properties": { 27146 "managementServer": { 27147 "type": "object", 27148 "properties": { 27149 "primary": { 27150 "type": "string" 27151 }, 27152 "secondary": { 27153 "type": "string" 27154 }, 27155 "authKey": { 27156 "type": "string" 27157 } 27158 } 27159 } 27160 } 27161 }, 27162 "security_vnf_service_check_point_software": { 27163 "type": "object", 27164 "properties": { 27165 "managementServer": { 27166 "type": "object", 27167 "properties": { 27168 "primary": { 27169 "type": "string" 27170 }, 27171 "sicKey": { 27172 "type": "string" 27173 } 27174 } 27175 }, 27176 "vmConfiguration": { 27177 "type": "object", 27178 "properties": { 27179 "adminPassword": { 27180 "type": "string" 27181 } 27182 } 27183 }, 27184 "image": { 27185 "$ref": "#/definitions/security_vnf_service_image_info" 27186 } 27187 } 27188 }, 27189 "security_vnf_service_fortinet": { 27190 "type": "object", 27191 "properties": { 27192 "managementServer": { 27193 "type": "object", 27194 "properties": { 27195 "primary": { 27196 "type": "string" 27197 }, 27198 "serialNumber": { 27199 "type": "string" 27200 }, 27201 "registrationPassword": { 27202 "type": "string" 27203 } 27204 } 27205 }, 27206 "image": { 27207 "$ref": "#/definitions/security_vnf_service_image_info" 27208 } 27209 } 27210 }, 27211 "security_vnf_service_image_info": { 27212 "type": "object", 27213 "properties": { 27214 "downloadType": { 27215 "type": "string", 27216 "enum": [ 27217 "s3", 27218 "http", 27219 "https" 27220 ] 27221 }, 27222 "fileLocation": { 27223 "type": "string" 27224 }, 27225 "fileChecksum": { 27226 "type": "string" 27227 }, 27228 "fileChecksumType": { 27229 "type": "string" 27230 }, 27231 "https": { 27232 "type": "object", 27233 "properties": { 27234 "username": { 27235 "type": "string" 27236 }, 27237 "password": { 27238 "type": "string" 27239 } 27240 } 27241 }, 27242 "s3": { 27243 "type": "object", 27244 "properties": { 27245 "accessKeyId": { 27246 "type": "string" 27247 }, 27248 "secretAccessKey": { 27249 "type": "string" 27250 } 27251 } 27252 } 27253 } 27254 }, 27255 "security_vnf_image": { 27256 "allOf": [ 27257 { 27258 "$ref": "#/definitions/enterprise_object_base" 27259 }, 27260 { 27261 "type": "object", 27262 "properties": { 27263 "data": { 27264 "$ref": "#/definitions/security_vnf_image_data" 27265 } 27266 } 27267 } 27268 ] 27269 }, 27270 "security_vnf_image_data": { 27271 "type": "object", 27272 "properties": { 27273 "service": { 27274 "allOf": [ 27275 { 27276 "$ref": "#/definitions/logicalid_reference" 27277 }, 27278 { 27279 "type": "object", 27280 "properties": { 27281 "ref": { 27282 "type": "string", 27283 "pattern": "deviceSettings:securityVnf:service" 27284 } 27285 } 27286 } 27287 ] 27288 }, 27289 "IN_PROGRESS": { 27290 "$ref": "#/definitions/vnf_image_download_event_detail" 27291 }, 27292 "COMPLETED": { 27293 "$ref": "#/definitions/vnf_image_download_event_detail" 27294 }, 27295 "FAILED": { 27296 "$ref": "#/definitions/vnf_image_download_event_detail" 27297 } 27298 } 27299 }, 27300 "security_vnf_license": { 27301 "allOf": [ 27302 { 27303 "$ref": "#/definitions/enterprise_object_base" 27304 }, 27305 { 27306 "type": "object", 27307 "properties": { 27308 "data": { 27309 "$ref": "#/definitions/security_vnf_license_data" 27310 } 27311 } 27312 } 27313 ] 27314 }, 27315 "security_vnf_license_data": { 27316 "type": "object", 27317 "properties": { 27318 "type": { 27319 "type": "string", 27320 "pattern": "securityVnfLicense" 27321 }, 27322 "vendor": { 27323 "type": "string", 27324 "enum": [ 27325 "PaloAlto", 27326 "CheckPoint", 27327 "Fortinet", 27328 "CentOS" 27329 ] 27330 }, 27331 "vendorSpecificData": { 27332 "$ref": "#/definitions/security_vnf_license_data" 27333 } 27334 } 27335 }, 27336 "security_vnf_license_vendor_specific_data": { 27337 "type": "object" 27338 }, 27339 "security_vnf_license_palo_alto_networks": { 27340 "type": "object", 27341 "properties": { 27342 "licenseServer": { 27343 "type": "object", 27344 "properties": { 27345 "url": { 27346 "type": "string" 27347 }, 27348 "apiKey": { 27349 "type": "string" 27350 } 27351 } 27352 }, 27353 "authCode": { 27354 "type": "string" 27355 } 27356 } 27357 }, 27358 "edge_vnf": { 27359 "allOf": [ 27360 { 27361 "$ref": "#/definitions/enterprise_object_base" 27362 }, 27363 { 27364 "type": "object", 27365 "properties": { 27366 "data": { 27367 "$ref": "#/definitions/security_vnf_service_data" 27368 } 27369 } 27370 } 27371 ] 27372 }, 27373 "edge_vnf_data": { 27374 "type": "object", 27375 "properties": { 27376 "securityVnf": { 27377 "type": "object", 27378 "properties": { 27379 "vms": { 27380 "type": "array", 27381 "items": { 27382 "$ref": "#/definitions/edge_vnf_security_vnf_vm" 27383 } 27384 } 27385 } 27386 } 27387 } 27388 }, 27389 "edge_vnf_security_vnf_vm": { 27390 "type": "object", 27391 "properties": { 27392 "cidrIp": { 27393 "type": "string", 27394 "format": "ipv4" 27395 }, 27396 "edgeEvent": { 27397 "type": "object", 27398 "properties": { 27399 "DEPLOYED": { 27400 "$ref": "#/definitions/vnf_vm_event_detail" 27401 }, 27402 "status": { 27403 "type": "string", 27404 "enum": [ 27405 "DEPLOYED", 27406 "POWERED_ON", 27407 "POWERED_OFF", 27408 "DELETED", 27409 "ERROR", 27410 "UNKNOWN" 27411 ] 27412 } 27413 } 27414 }, 27415 "hostname": { 27416 "type": "string" 27417 }, 27418 "insertionEnabled": { 27419 "type": "boolean" 27420 }, 27421 "ref": { 27422 "type": "string", 27423 "pattern": "deviceSettings:vnfs:edge" 27424 }, 27425 "type": { 27426 "type": "string", 27427 "pattern": "securityVnf" 27428 }, 27429 "vendor": { 27430 "type": "string", 27431 "enum": [ 27432 "PaloAlto", 27433 "CheckPoint", 27434 "Fortinet", 27435 "CentOS" 27436 ] 27437 }, 27438 "vendorSpecificData": { 27439 "$ref": "#/definitions/edge_vnf_security_vnf_vm_vendor_specific_data" 27440 }, 27441 "vlanId": { 27442 "type": "integer" 27443 }, 27444 "vmDeploy": { 27445 "type": "boolean" 27446 }, 27447 "vmPowerOff": { 27448 "type": "boolean" 27449 } 27450 } 27451 }, 27452 "vnf_vm_event": { 27453 "allOf": [ 27454 { 27455 "$ref": "#/definitions/event_base" 27456 }, 27457 { 27458 "properties": { 27459 "detail": { 27460 "$ref": "#/definitions/vnf_vm_event_detail" 27461 } 27462 }, 27463 "required": [ 27464 "id", 27465 "eventTime", 27466 "event", 27467 "category", 27468 "severity", 27469 "detail" 27470 ] 27471 } 27472 ] 27473 }, 27474 "vnf_vm_event_detail": { 27475 "type": "object", 27476 "properties": { 27477 "configUuid": { 27478 "type": "string" 27479 }, 27480 "data": { 27481 "type": "object" 27482 }, 27483 "edgeSerialNumber": { 27484 "type": "string" 27485 }, 27486 "isEdgeActive": { 27487 "type": "boolean" 27488 }, 27489 "runningConfig": { 27490 "type": "object" 27491 }, 27492 "status": { 27493 "type": "string", 27494 "enum": [ 27495 "DEPLOYED", 27496 "POWERED_ON", 27497 "POWERED_OFF", 27498 "DELETED", 27499 "ERROR", 27500 "UNKNOWN" 27501 ] 27502 }, 27503 "uuid": { 27504 "type": "string" 27505 }, 27506 "vendor": { 27507 "type": "string", 27508 "enum": [ 27509 "PaloAlto", 27510 "CheckPoint", 27511 "Fortinet", 27512 "CentOS" 27513 ] 27514 }, 27515 "vnfEdgeLogicalId": { 27516 "type": "string" 27517 }, 27518 "vnfType": { 27519 "type": "string", 27520 "enum": [ 27521 "securityVnf" 27522 ] 27523 } 27524 } 27525 }, 27526 "edge_vnf_security_vnf_vm_vendor_specific_data": { 27527 "type": "object" 27528 }, 27529 "edge_vnf_security_vnf_vm_palo_alto_networks": { 27530 "type": "object", 27531 "properties": { 27532 "deviceGroupName": { 27533 "type": "string" 27534 }, 27535 "deviceTemplateName": { 27536 "type": "string" 27537 } 27538 } 27539 }, 27540 "edge_vnf_security_vnf_vm_check_point_software": { 27541 "type": "object" 27542 }, 27543 "edge_vnf_security_vnf_vm_fortinet": { 27544 "type": "object", 27545 "properties": { 27546 "inspectionMode": { 27547 "type": "string", 27548 "enum": [ 27549 "proxy", 27550 "flow" 27551 ] 27552 }, 27553 "license": { 27554 "type": "string" 27555 } 27556 } 27557 }, 27558 "enterprise_user_do_all_users_have_phones": { 27559 "type": "object", 27560 "properties": { 27561 "doUsersHavePhones": { 27562 "type": "boolean" 27563 }, 27564 "doesPhoneHasAtLeastOneUser": { 27565 "type": "boolean" 27566 } 27567 } 27568 }, 27569 "vpn_generate_vpn_gateway_configuration_result": { 27570 "type": "object", 27571 "properties": { 27572 "id": { 27573 "type": "integer" 27574 }, 27575 "object": { 27576 "type": "string", 27577 "enum": [ 27578 "NETWORK_ALLOCATION", 27579 "NETWORK_SERVICE", 27580 "CUSTOM_APPLICATION", 27581 "ROUTING_CONFIGURATION", 27582 "NETWORK_SEGMENT", 27583 "HA_SERVICE", 27584 "PRIVATE_NETWORK", 27585 "CDE_GATEWAY", 27586 "EDGE_LICENSE" 27587 ] 27588 }, 27589 "type": { 27590 "type": "string", 27591 "enum": [ 27592 "dns", 27593 "authentication", 27594 "dataCenter", 27595 "dataCenterEdge", 27596 "edgeHub", 27597 "partnerGateway", 27598 "edgeHubCluster", 27599 "edgeBranchCluster", 27600 "localUiCredentials", 27601 "edgeBranchClusterMember", 27602 "edgeHubClusterMember", 27603 "securityVnf", 27604 "edgeVrrpPairSet", 27605 "cloudSecurityService", 27606 "cloudSecurityServiceSite", 27607 "securityVnfLicense", 27608 "securityVnfService", 27609 "primary", 27610 "secondary", 27611 "controllerGateway", 27612 "tacacs", 27613 "netflowCollector", 27614 "iaasSubscription", 27615 "netflowFilter", 27616 "vnfImage", 27617 "custom" 27618 ] 27619 }, 27620 "data": { 27621 "$ref": "#/definitions/data_center_data" 27622 } 27623 } 27624 }, 27625 "data_center_data": { 27626 "type": "object", 27627 "properties": { 27628 "authentication": { 27629 "type": "object", 27630 "properties": { 27631 "key": { 27632 "type": "string" 27633 }, 27634 "value": { 27635 "type": "string" 27636 } 27637 } 27638 }, 27639 "isCDE": { 27640 "type": "boolean" 27641 }, 27642 "isServiceEnabled": { 27643 "type": "boolean" 27644 }, 27645 "primary": { 27646 "$ref": "#/definitions/data_center_vpn_tunnel" 27647 }, 27648 "secondary": { 27649 "$ref": "#/definitions/data_center_vpn_tunnel" 27650 }, 27651 "subnets": { 27652 "type": "array", 27653 "items": { 27654 "type": "object", 27655 "properties": { 27656 "advertise": { 27657 "type": "boolean" 27658 }, 27659 "cidrIp": { 27660 "type": "string", 27661 "format": "ipv4" 27662 }, 27663 "cidrIpStart": { 27664 "type": "string", 27665 "format": "ipv4" 27666 }, 27667 "cidrIpEnd": { 27668 "type": "string", 27669 "format": "ipv4" 27670 }, 27671 "cidrPrefix": { 27672 "type": "string" 27673 }, 27674 "name": { 27675 "type": "string" 27676 }, 27677 "netMask": { 27678 "type": "string", 27679 "format": "ipv4" 27680 } 27681 } 27682 } 27683 }, 27684 "iaasProvider": { 27685 "type": "object", 27686 "properties": { 27687 "subscriptionObjectId": { 27688 "type": "integer" 27689 }, 27690 "vendor": { 27691 "type": "string" 27692 }, 27693 "vendorSpecificData": { 27694 "$ref": "#/definitions/data_center_iaas_provider_vendor_specific_data" 27695 }, 27696 "tunnelsEnabledOnSync": { 27697 "type": "boolean" 27698 }, 27699 "syncStatus": { 27700 "type": "object", 27701 "properties": { 27702 "state": { 27703 "type": "string" 27704 }, 27705 "stateTimestamp": { 27706 "type": "integer" 27707 }, 27708 "lastSyncTimestamp": { 27709 "type": "integer" 27710 }, 27711 "errorDetail": { 27712 "type": "object", 27713 "properties": { 27714 "message": { 27715 "type": "string" 27716 }, 27717 "response": { 27718 "$ref": "#/definitions/upstream_api_response" 27719 } 27720 } 27721 } 27722 } 27723 } 27724 } 27725 } 27726 } 27727 }, 27728 "data_center_iaas_provider_vendor_specific_data": { 27729 "type": "object" 27730 }, 27731 "data_center_iaas_provider_microsoft_azure": { 27732 "type": "object", 27733 "properties": { 27734 "virtualWanId": { 27735 "type": "string" 27736 }, 27737 "virtualHubId": { 27738 "type": "string" 27739 }, 27740 "primaryVpnSiteId": { 27741 "type": "string" 27742 }, 27743 "redundantVpnSiteId": { 27744 "type": "string" 27745 }, 27746 "deploymentState": { 27747 "type": "string", 27748 "enum": [ 27749 "VPN_SITE_CREATION_PENDING", 27750 "VPN_SITE_CREATION_IN_PROGRESS", 27751 "VPN_SITE_CREATION_FAILED", 27752 "VPN_DEPLOYMENT_PENDING", 27753 "VPN_DEPLOYMENT_IN_PROGRESS", 27754 "VPN_DEPLOYMENT_FAILED", 27755 "SUCCEEDED" 27756 ] 27757 } 27758 } 27759 }, 27760 "data_center_vpn_tunnel": { 27761 "type": "object", 27762 "properties": { 27763 "IKESA": { 27764 "type": "object", 27765 "properties": { 27766 "DHGroup": { 27767 "type": "integer" 27768 }, 27769 "authenticationAlgorithm": { 27770 "type": "string" 27771 }, 27772 "authenticationMethod": { 27773 "type": "string" 27774 }, 27775 "ikeVersion": { 27776 "type": "integer" 27777 }, 27778 "lifeTimeSeconds": { 27779 "type": "integer" 27780 }, 27781 "phaseOneNegotiationMode": { 27782 "type": "string", 27783 "enum": [ 27784 "main", 27785 "aggressive" 27786 ] 27787 }, 27788 "sharedKey": { 27789 "type": "string" 27790 }, 27791 "sharedKeyType": { 27792 "type": "string" 27793 } 27794 } 27795 }, 27796 "IPSECDPD": { 27797 "type": "object", 27798 "properties": { 27799 "intervalSeconds": { 27800 "type": "integer" 27801 }, 27802 "retries": { 27803 "type": "integer" 27804 }, 27805 "type": { 27806 "type": "string" 27807 } 27808 } 27809 }, 27810 "IPSECSA": { 27811 "type": "object", 27812 "properties": { 27813 "authenticationAlgorithm": { 27814 "type": "string" 27815 }, 27816 "encryptionAlgorithm": { 27817 "type": "string" 27818 }, 27819 "lifeTimeSeconds": { 27820 "type": "integer" 27821 }, 27822 "mode": { 27823 "type": "string" 27824 }, 27825 "perfectForwardSecurity": { 27826 "type": "string" 27827 }, 27828 "protocol": { 27829 "type": "string" 27830 } 27831 } 27832 }, 27833 "dataCenterLinkIp": { 27834 "type": "string", 27835 "format": "ipv4" 27836 }, 27837 "dataCenterPublicIp": { 27838 "type": "string", 27839 "format": "ipv4" 27840 }, 27841 "disabled": { 27842 "type": "boolean" 27843 }, 27844 "fragmentationAvoidance": { 27845 "type": "object", 27846 "properties": { 27847 "tcpMssAdjustmentBytes": { 27848 "type": "integer" 27849 }, 27850 "clearDontFragmentBit": { 27851 "type": "string" 27852 }, 27853 "fragmentationStyle": { 27854 "type": "string" 27855 } 27856 } 27857 }, 27858 "gatewayLinkIp": { 27859 "type": "string", 27860 "format": "ipv4" 27861 }, 27862 "gatewayPublicIp": { 27863 "type": "string", 27864 "format": "ipv4" 27865 }, 27866 "geoData": { 27867 "type": "object", 27868 "properties": { 27869 "latitude": { 27870 "type": "number" 27871 }, 27872 "longitude": { 27873 "type": "number" 27874 } 27875 } 27876 }, 27877 "redundant": { 27878 "$ref": "#/definitions/data_center_vpn_tunnel" 27879 }, 27880 "serviceFQDN": { 27881 "type": "string" 27882 }, 27883 "tunnelInterface": { 27884 "type": "object", 27885 "properties": { 27886 "MTU": { 27887 "type": "integer" 27888 } 27889 } 27890 }, 27891 "type": { 27892 "type": "string", 27893 "enum": [ 27894 "Cisco ISR", 27895 "Cisco ASA", 27896 "SonicWall", 27897 "Palo Alto", 27898 "Other", 27899 "Generic Policy", 27900 "Zscaler", 27901 "GenericIKEv2Router", 27902 "CheckPoint", 27903 "Microsoft Azure Virtual Hub" 27904 ] 27905 }, 27906 "typeAlias": { 27907 "type": "string", 27908 "enum": [ 27909 "Cisco ISR", 27910 "Cisco ASA", 27911 "SonicWall", 27912 "Palo Alto", 27913 "Other", 27914 "Generic Policy", 27915 "Zscaler", 27916 "GenericIKEv2Router", 27917 "CheckPoint", 27918 "Microsoft Azure Virtual Hub" 27919 ] 27920 } 27921 } 27922 }, 27923 "export_enterprise_edge_license_data_result": { 27924 "type": "object", 27925 "properties": { 27926 "csv": { 27927 "type": "string" 27928 }, 27929 "fileName": { 27930 "type": "string" 27931 } 27932 } 27933 }, 27934 "export_network_edge_license_data_result": { 27935 "type": "object", 27936 "properties": { 27937 "csv": { 27938 "type": "string" 27939 }, 27940 "fileName": { 27941 "type": "string" 27942 } 27943 } 27944 }, 27945 "export_enterprise_proxy_edge_license_data_result": { 27946 "type": "object", 27947 "properties": { 27948 "csv": { 27949 "type": "string" 27950 }, 27951 "fileName": { 27952 "type": "string" 27953 } 27954 } 27955 }, 27956 "get_edge_license_details_by_enterprise_proxy_result": { 27957 "type": "array", 27958 "items": { 27959 "type": "object", 27960 "properties": { 27961 "activatedEdgeCount": { 27962 "type": "integer" 27963 }, 27964 "edgeCount": { 27965 "type": "integer" 27966 }, 27967 "enterpriseCount": { 27968 "type": "integer" 27969 }, 27970 "enterpriseProxyId": { 27971 "type": "integer" 27972 }, 27973 "enterpriseProxyName": { 27974 "type": "string" 27975 } 27976 } 27977 } 27978 }, 27979 "get_edge_license_details_by_enterprise_result": { 27980 "type": "array", 27981 "items": { 27982 "type": "object", 27983 "properties": { 27984 "activatedEdgeCount": { 27985 "type": "integer" 27986 }, 27987 "edgeCount": { 27988 "type": "integer" 27989 }, 27990 "enterpriseCount": { 27991 "type": "integer" 27992 }, 27993 "enterpriseProxyId": { 27994 "type": "integer" 27995 }, 27996 "enterpriseProxyName": { 27997 "type": "string" 27998 }, 27999 "enterpriseName": { 28000 "type": "string" 28001 } 28002 } 28003 } 28004 }, 28005 "set_edge_edge_licenses_result": { 28006 "type": "array", 28007 "items": { 28008 "type": "object", 28009 "properties": { 28010 "edgeId": { 28011 "type": "integer" 28012 }, 28013 "edgeLicenseId": { 28014 "type": "string" 28015 }, 28016 "success": { 28017 "type": "boolean" 28018 } 28019 } 28020 } 28021 }, 28022 "set_enterprise_edge_license_edition_result": { 28023 "type": "array", 28024 "items": { 28025 "type": "object", 28026 "properties": { 28027 "original": { 28028 "type": "string" 28029 }, 28030 "replacement": { 28031 "type": "string" 28032 } 28033 } 28034 } 28035 }, 28036 "update_enterprise_edge_licenses_result": { 28037 "type": "object", 28038 "properties": { 28039 "errors": { 28040 "type": "array", 28041 "items": { 28042 "type": "object", 28043 "properties": { 28044 "message": { 28045 "type": "string" 28046 } 28047 } 28048 } 28049 }, 28050 "valid": { 28051 "type": "boolean" 28052 } 28053 } 28054 }, 28055 "update_enterprise_proxy_edge_licenses_result": { 28056 "type": "object", 28057 "properties": { 28058 "errors": { 28059 "type": "array", 28060 "items": { 28061 "type": "object", 28062 "properties": { 28063 "message": { 28064 "type": "string" 28065 } 28066 } 28067 } 28068 }, 28069 "valid": { 28070 "type": "boolean" 28071 } 28072 } 28073 }, 28074 "edge_license": { 28075 "type": "object", 28076 "properties": { 28077 "id": { 28078 "type": "integer" 28079 }, 28080 "created": { 28081 "type": "string", 28082 "format": "date-time" 28083 }, 28084 "licenseId": { 28085 "type": "integer" 28086 }, 28087 "sku": { 28088 "type": "string" 28089 }, 28090 "name": { 28091 "type": "string" 28092 }, 28093 "alias": { 28094 "type": "string" 28095 }, 28096 "detail": { 28097 "type": "string" 28098 }, 28099 "quota": { 28100 "type": "string" 28101 }, 28102 "termMonths": { 28103 "type": "integer" 28104 }, 28105 "start": { 28106 "type": "string", 28107 "format": "date-time" 28108 }, 28109 "end": { 28110 "type": "string", 28111 "format": "date-time" 28112 }, 28113 "edition": { 28114 "type": "string" 28115 }, 28116 "bandwidthTier": { 28117 "type": "string" 28118 }, 28119 "active": { 28120 "$ref": "#/definitions/tinyint" 28121 }, 28122 "modified": { 28123 "type": "string", 28124 "format": "date-time" 28125 } 28126 } 28127 }, 28128 "get_enterprise_proxy_edge_licenses_result": { 28129 "type": "array", 28130 "items": { 28131 "type": "object", 28132 "properties": { 28133 "activatedEdgeCount": { 28134 "type": "integer" 28135 }, 28136 "active": { 28137 "type": "integer" 28138 }, 28139 "alias": { 28140 "type": "string" 28141 }, 28142 "bandwidthTier": { 28143 "type": "string" 28144 }, 28145 "created": { 28146 "type": "string", 28147 "format": "date-time" 28148 }, 28149 "detail": { 28150 "type": "object", 28151 "properties": { 28152 "regions": { 28153 "type": "array", 28154 "items": { 28155 "type": "string" 28156 } 28157 }, 28158 "addOns": { 28159 "type": "array", 28160 "items": { 28161 "type": "string" 28162 } 28163 } 28164 } 28165 }, 28166 "edgeCount": { 28167 "type": "integer" 28168 }, 28169 "edition": { 28170 "type": "string" 28171 }, 28172 "end": { 28173 "type": "string", 28174 "format": "date-time" 28175 }, 28176 "enterpriseCount": { 28177 "type": "integer" 28178 }, 28179 "id": { 28180 "type": "integer" 28181 }, 28182 "licenseId": { 28183 "type": "integer" 28184 }, 28185 "modified": { 28186 "type": "string", 28187 "format": "date-time" 28188 }, 28189 "name": { 28190 "type": "string" 28191 }, 28192 "quota": { 28193 "type": "string" 28194 }, 28195 "sku": { 28196 "type": "string" 28197 }, 28198 "start": { 28199 "type": "string", 28200 "format": "date-time" 28201 }, 28202 "termMonths": { 28203 "type": "integer" 28204 } 28205 } 28206 } 28207 }, 28208 "get_enterprise_edge_licenses_result": { 28209 "type": "array", 28210 "items": { 28211 "type": "object", 28212 "properties": { 28213 "activatedEdgeCount": { 28214 "type": "integer" 28215 }, 28216 "active": { 28217 "type": "integer" 28218 }, 28219 "alias": { 28220 "type": "string" 28221 }, 28222 "bandwidthTier": { 28223 "type": "string" 28224 }, 28225 "created": { 28226 "type": "string", 28227 "format": "date-time" 28228 }, 28229 "detail": { 28230 "type": "object", 28231 "properties": { 28232 "regions": { 28233 "type": "array", 28234 "items": { 28235 "type": "string" 28236 } 28237 }, 28238 "addOns": { 28239 "type": "array", 28240 "items": { 28241 "type": "string" 28242 } 28243 } 28244 } 28245 }, 28246 "edgeCount": { 28247 "type": "integer" 28248 }, 28249 "edition": { 28250 "type": "string" 28251 }, 28252 "end": { 28253 "type": "string", 28254 "format": "date-time" 28255 }, 28256 "id": { 28257 "type": "integer" 28258 }, 28259 "licenseId": { 28260 "type": "integer" 28261 }, 28262 "modified": { 28263 "type": "string", 28264 "format": "date-time" 28265 }, 28266 "name": { 28267 "type": "string" 28268 }, 28269 "quota": { 28270 "type": "string" 28271 }, 28272 "sku": { 28273 "type": "string" 28274 }, 28275 "start": { 28276 "type": "string", 28277 "format": "date-time" 28278 }, 28279 "termMonths": { 28280 "type": "integer" 28281 } 28282 } 28283 } 28284 }, 28285 "get_network_edge_licenses_result": { 28286 "type": "array", 28287 "items": { 28288 "type": "object", 28289 "properties": { 28290 "activatedEdgeCount": { 28291 "type": "integer" 28292 }, 28293 "active": { 28294 "type": "integer" 28295 }, 28296 "alias": { 28297 "type": "string" 28298 }, 28299 "bandwidthTier": { 28300 "type": "string" 28301 }, 28302 "created": { 28303 "type": "string", 28304 "format": "date-time" 28305 }, 28306 "detail": { 28307 "type": "object", 28308 "properties": { 28309 "regions": { 28310 "type": "array", 28311 "items": { 28312 "type": "string" 28313 } 28314 }, 28315 "addOns": { 28316 "type": "array", 28317 "items": { 28318 "type": "string" 28319 } 28320 } 28321 } 28322 }, 28323 "edgeCount": { 28324 "type": "integer" 28325 }, 28326 "edition": { 28327 "type": "string" 28328 }, 28329 "end": { 28330 "type": "string", 28331 "format": "date-time" 28332 }, 28333 "enterpriseCount": { 28334 "type": "integer" 28335 }, 28336 "enterpriseProxyCount": { 28337 "type": "integer" 28338 }, 28339 "id": { 28340 "type": "integer" 28341 }, 28342 "licenseId": { 28343 "type": "integer" 28344 }, 28345 "modified": { 28346 "type": "string", 28347 "format": "date-time" 28348 }, 28349 "name": { 28350 "type": "string" 28351 }, 28352 "quota": { 28353 "type": "string" 28354 }, 28355 "sku": { 28356 "type": "string" 28357 }, 28358 "start": { 28359 "type": "string", 28360 "format": "date-time" 28361 }, 28362 "termMonths": { 28363 "type": "integer" 28364 } 28365 } 28366 } 28367 }, 28368 "vco_diagnostic_bundle": { 28369 "type": "object", 28370 "properties": { 28371 "id": { 28372 "type": "integer" 28373 }, 28374 "requestId": { 28375 "type": "integer", 28376 "format": "int64" 28377 }, 28378 "userId": { 28379 "type": "string" 28380 }, 28381 "ageOutTime": { 28382 "type": "string", 28383 "format": "date-time" 28384 }, 28385 "reason": { 28386 "type": "string" 28387 }, 28388 "created": { 28389 "type": "string", 28390 "format": "date-time" 28391 }, 28392 "blobId": { 28393 "type": "integer" 28394 }, 28395 "fileName": { 28396 "type": "string" 28397 }, 28398 "fileStore": { 28399 "type": "string" 28400 }, 28401 "timestamp": { 28402 "type": "string", 28403 "format": "date-time" 28404 }, 28405 "jobId": { 28406 "type": "string" 28407 }, 28408 "status": { 28409 "type": "string" 28410 } 28411 } 28412 }, 28413 "upstream_api_response": { 28414 "type": "object", 28415 "properties": { 28416 "statusCode": { 28417 "type": "integer" 28418 }, 28419 "contentType": { 28420 "type": "string" 28421 }, 28422 "responseData": { 28423 "type": "string" 28424 } 28425 } 28426 }, 28427 "iaas_vendor_credentials": { 28428 "type": "object" 28429 }, 28430 "microsoft_azure_client_credentials": { 28431 "type": "object", 28432 "properties": { 28433 "tenantId": { 28434 "type": "string" 28435 }, 28436 "clientId": { 28437 "type": "string" 28438 }, 28439 "clientSecret": { 28440 "type": "string" 28441 } 28442 } 28443 }, 28444 "enterprise_rolemap": { 28445 "type": "object", 28446 "properties": { 28447 "Enterprise Read Only": { 28448 "type": "string" 28449 }, 28450 "Enterprise Standard Admin": { 28451 "type": "string" 28452 }, 28453 "Enterprise Superuser": { 28454 "type": "string" 28455 }, 28456 "Enterprise Support": { 28457 "type": "string" 28458 } 28459 } 28460 }, 28461 "radius_operator_rolemap": { 28462 "type": "object", 28463 "properties": { 28464 "Operator Standard Admin": { 28465 "type": "string" 28466 }, 28467 "Operator Superuser": { 28468 "type": "string" 28469 }, 28470 "Operator Support": { 28471 "type": "string" 28472 } 28473 } 28474 }, 28475 "radius_enterprise_authentication_configuration": { 28476 "type": "object", 28477 "properties": { 28478 "domainAttribute": { 28479 "type": "string" 28480 }, 28481 "primaryServer": { 28482 "type": "string" 28483 }, 28484 "protocol": { 28485 "type": "string" 28486 }, 28487 "roleAttribute": { 28488 "type": "string" 28489 }, 28490 "secondaryServer": { 28491 "type": "string" 28492 }, 28493 "sharedSecret": { 28494 "type": "string" 28495 }, 28496 "timeoutMilliSeconds": { 28497 "type": "integer" 28498 }, 28499 "roleMap": { 28500 "$ref": "#/definitions/enterprise_rolemap" 28501 } 28502 } 28503 }, 28504 "radius_operator_authentication_configuration": { 28505 "type": "object", 28506 "properties": { 28507 "domainAttribute": { 28508 "type": "string" 28509 }, 28510 "operatorDomain": { 28511 "type": "string" 28512 }, 28513 "primaryServer": { 28514 "type": "string" 28515 }, 28516 "protocol": { 28517 "type": "string" 28518 }, 28519 "roleAttribute": { 28520 "type": "string" 28521 }, 28522 "secondaryServer": { 28523 "type": "string" 28524 }, 28525 "sharedSecret": { 28526 "type": "string" 28527 }, 28528 "timeoutMilliSeconds": { 28529 "type": "integer" 28530 }, 28531 "roleMap": { 28532 "$ref": "#/definitions/radius_operator_rolemap" 28533 } 28534 } 28535 }, 28536 "operator_sso_authentication_configuration": { 28537 "type": "object", 28538 "properties": { 28539 "enabled": { 28540 "type": "boolean" 28541 }, 28542 "protocol": { 28543 "type": "string" 28544 }, 28545 "provider": { 28546 "type": "string" 28547 }, 28548 "configuration": { 28549 "type": "object", 28550 "properties": { 28551 "authorizationEndpoint": { 28552 "type": "string" 28553 }, 28554 "clientId": { 28555 "type": "string" 28556 }, 28557 "clientSecret": { 28558 "type": "string" 28559 }, 28560 "issuer": { 28561 "type": "string" 28562 }, 28563 "provider": { 28564 "type": "string" 28565 }, 28566 "redirectEndpoint": { 28567 "type": "string" 28568 }, 28569 "tokenEndpoint": { 28570 "type": "string" 28571 }, 28572 "userInfoEndpoint": { 28573 "type": "string" 28574 }, 28575 "wellKnownConfigurationUrl": { 28576 "type": "string" 28577 }, 28578 "scopes": { 28579 "type": "array", 28580 "items": { 28581 "type": "string" 28582 } 28583 }, 28584 "roleConfig": { 28585 "type": "object", 28586 "properties": { 28587 "defaultRole": { 28588 "type": "string" 28589 }, 28590 "oidcRolesEnabled": { 28591 "type": "boolean" 28592 }, 28593 "roleAttribute": { 28594 "type": "string" 28595 }, 28596 "vcoToIdpRoleMap": { 28597 "type": "object", 28598 "properties": { 28599 "Operator Business": { 28600 "type": "array", 28601 "items": { 28602 "type": "string" 28603 } 28604 }, 28605 "Operator Standard Admin": { 28606 "type": "array", 28607 "items": { 28608 "type": "string" 28609 } 28610 }, 28611 "Operator Superuser": { 28612 "type": "array", 28613 "items": { 28614 "type": "string" 28615 } 28616 }, 28617 "Operator Support": { 28618 "type": "array", 28619 "items": { 28620 "type": "string" 28621 } 28622 } 28623 } 28624 } 28625 } 28626 } 28627 } 28628 } 28629 } 28630 }, 28631 "enterprise_proxy_sso_authentication_configuration": { 28632 "type": "object", 28633 "properties": { 28634 "enabled": { 28635 "type": "boolean" 28636 }, 28637 "protocol": { 28638 "type": "string" 28639 }, 28640 "provider": { 28641 "type": "string" 28642 }, 28643 "configuration": { 28644 "type": "object", 28645 "properties": { 28646 "authorizationEndpoint": { 28647 "type": "string" 28648 }, 28649 "clientId": { 28650 "type": "string" 28651 }, 28652 "clientSecret": { 28653 "type": "string" 28654 }, 28655 "issuer": { 28656 "type": "string" 28657 }, 28658 "provider": { 28659 "type": "string" 28660 }, 28661 "redirectEndpoint": { 28662 "type": "string" 28663 }, 28664 "tokenEndpoint": { 28665 "type": "string" 28666 }, 28667 "userInfoEndpoint": { 28668 "type": "string" 28669 }, 28670 "wellKnownConfigurationUrl": { 28671 "type": "string" 28672 }, 28673 "scopes": { 28674 "type": "array", 28675 "items": { 28676 "type": "string" 28677 } 28678 }, 28679 "roleConfig": { 28680 "type": "object", 28681 "properties": { 28682 "defaultRole": { 28683 "type": "string" 28684 }, 28685 "oidcRolesEnabled": { 28686 "type": "boolean" 28687 }, 28688 "roleAttribute": { 28689 "type": "string" 28690 }, 28691 "vcoToIdpRoleMap": { 28692 "type": "object", 28693 "properties": { 28694 "MSP Business": { 28695 "type": "array", 28696 "items": { 28697 "type": "string" 28698 } 28699 }, 28700 "MSP Standard Admin": { 28701 "type": "array", 28702 "items": { 28703 "type": "string" 28704 } 28705 }, 28706 "MSP Superuser": { 28707 "type": "array", 28708 "items": { 28709 "type": "string" 28710 } 28711 }, 28712 "MSP Support": { 28713 "type": "array", 28714 "items": { 28715 "type": "string" 28716 } 28717 } 28718 } 28719 } 28720 } 28721 } 28722 } 28723 } 28724 } 28725 }, 28726 "enterprise_sso_authentication_configuration": { 28727 "type": "object", 28728 "properties": { 28729 "enabled": { 28730 "type": "boolean" 28731 }, 28732 "protocol": { 28733 "type": "string" 28734 }, 28735 "provider": { 28736 "type": "string" 28737 }, 28738 "configuration": { 28739 "type": "object", 28740 "properties": { 28741 "authorizationEndpoint": { 28742 "type": "string" 28743 }, 28744 "clientId": { 28745 "type": "string" 28746 }, 28747 "clientSecret": { 28748 "type": "string" 28749 }, 28750 "issuer": { 28751 "type": "string" 28752 }, 28753 "provider": { 28754 "type": "string" 28755 }, 28756 "redirectEndpoint": { 28757 "type": "string" 28758 }, 28759 "tokenEndpoint": { 28760 "type": "string" 28761 }, 28762 "userInfoEndpoint": { 28763 "type": "string" 28764 }, 28765 "wellKnownConfigurationUrl": { 28766 "type": "string" 28767 }, 28768 "scopes": { 28769 "type": "array", 28770 "items": { 28771 "type": "string" 28772 } 28773 }, 28774 "roleConfig": { 28775 "type": "object", 28776 "properties": { 28777 "defaultRole": { 28778 "type": "string" 28779 }, 28780 "oidcRolesEnabled": { 28781 "type": "boolean" 28782 }, 28783 "roleAttribute": { 28784 "type": "string" 28785 }, 28786 "vcoToIdpRoleMap": { 28787 "type": "object", 28788 "properties": { 28789 "Enterprise Read Only": { 28790 "type": "array", 28791 "items": { 28792 "type": "string" 28793 } 28794 }, 28795 "Enterprise Standard Admin": { 28796 "type": "array", 28797 "items": { 28798 "type": "string" 28799 } 28800 }, 28801 "Enterprise Superuser": { 28802 "type": "array", 28803 "items": { 28804 "type": "string" 28805 } 28806 }, 28807 "Enterprise Support": { 28808 "type": "array", 28809 "items": { 28810 "type": "string" 28811 } 28812 } 28813 } 28814 } 28815 } 28816 } 28817 } 28818 } 28819 } 28820 }, 28821 "enterprise_authentication_configuration": { 28822 "type": "object", 28823 "properties": { 28824 "mode": { 28825 "type": "string" 28826 }, 28827 "radius": { 28828 "description": "", 28829 "$ref": "#/definitions/radius_enterprise_authentication_configuration" 28830 } 28831 } 28832 }, 28833 "operator_authentication_configuration": { 28834 "type": "object", 28835 "properties": { 28836 "mode": { 28837 "type": "string" 28838 }, 28839 "radius": { 28840 "description": "Returns radius configuration or null (if no configuration available)", 28841 "$ref": "#/definitions/radius_operator_authentication_configuration" 28842 }, 28843 "sso": { 28844 "description": "Returns sso configuration or null (if no configuration available)", 28845 "$ref": "#/definitions/operator_sso_authentication_configuration" 28846 } 28847 } 28848 }, 28849 "system_property_get_authentication_configuration_result": { 28850 "type": "object", 28851 "properties": { 28852 "operator": { 28853 "$ref": "#/definitions/operator_authentication_configuration" 28854 }, 28855 "enterprise": { 28856 "$ref": "#/definitions/enterprise_authentication_configuration" 28857 } 28858 } 28859 }, 28860 "system_property_set_authentication_configuration_result": { 28861 "type": "object", 28862 "properties": { 28863 "rows": { 28864 "description": "The number of rows modified", 28865 "type": "integer" 28866 } 28867 } 28868 }, 28869 "sso_get_sso_properties_result": { 28870 "type": "object", 28871 "properties": { 28872 "redirectUri": { 28873 "type": "string" 28874 } 28875 } 28876 }, 28877 "openid_well_known_config": { 28878 "type": "object", 28879 "properties": { 28880 "issuer": { 28881 "type": "string" 28882 }, 28883 "authorization_endpoint": { 28884 "type": "string" 28885 }, 28886 "token_endpoint": { 28887 "type": "string" 28888 }, 28889 "revocation_endpoint": { 28890 "type": "string" 28891 }, 28892 "userinfo_endpoint": { 28893 "type": "string" 28894 }, 28895 "jwks_uri": { 28896 "type": "string" 28897 }, 28898 "scopes_supported": { 28899 "type": "array", 28900 "items": { 28901 "type": "string" 28902 } 28903 }, 28904 "response_types_supported": { 28905 "type": "array", 28906 "items": { 28907 "type": "string" 28908 } 28909 }, 28910 "response_modes_supported": { 28911 "type": "array", 28912 "items": { 28913 "type": "string" 28914 } 28915 }, 28916 "claims_supported": { 28917 "type": "array", 28918 "items": { 28919 "type": "string" 28920 } 28921 } 28922 } 28923 }, 28924 "sso_discover_openid_endpoints_result": { 28925 "$ref": "#/definitions/openid_well_known_config" 28926 }, 28927 "operator_user_get_operator_user_authentication_mode_result": { 28928 "$ref": "#/definitions/system_property_get_system_property_result" 28929 }, 28930 "enterprise_proxy_insert_or_update_enterprise_proxy_authentication_configuration_result": { 28931 "type": "object", 28932 "properties": { 28933 "rows": { 28934 "description": "The number of rows modified", 28935 "type": "integer" 28936 } 28937 } 28938 }, 28939 "enterprise_proxy_get_enterprise_proxy_authentication_configuration_result": { 28940 "type": "object", 28941 "properties": { 28942 "mode": { 28943 "type": "string" 28944 }, 28945 "sso": { 28946 "$ref": "#/definitions/enterprise_proxy_sso_authentication_configuration", 28947 "description": "Returns sso configuration or null (if no configuration available)" 28948 } 28949 } 28950 }, 28951 "enterprise_insert_or_update_enterprise_authentication_configuration_result": { 28952 "type": "object", 28953 "properties": { 28954 "rows": { 28955 "description": "The number of rows modified", 28956 "type": "integer" 28957 } 28958 } 28959 }, 28960 "enterprise_get_enterprise_authentication_configuration_result": { 28961 "type": "object", 28962 "properties": { 28963 "mode": { 28964 "type": "string" 28965 }, 28966 "sso": { 28967 "description": "Returns sso configuration or null (if no configuration available)", 28968 "$ref": "#/definitions/enterprise_sso_authentication_configuration" 28969 } 28970 } 28971 } 28972 }, 28973 "parameters": { 28974 "auth_param": { 28975 "name": "authorization", 28976 "in": "body", 28977 "required": true, 28978 "schema": { 28979 "$ref": "#/definitions/auth_object" 28980 } 28981 } 28982 }, 28983 "responses": { 28984 "generic_200": { 28985 "description": "Request was successfully processed", 28986 "schema": { 28987 "type": "object" 28988 } 28989 }, 28990 "generic_400": { 28991 "description": "Invalid Request: Please check your request schema", 28992 "schema": { 28993 "$ref": "#/definitions/error" 28994 } 28995 }, 28996 "generic_500": { 28997 "description": "Error parsing or processing request", 28998 "schema": { 28999 "$ref": "#/definitions/error" 29000 } 29001 }, 29002 "no_credentials": { 29003 "description": "Authorization Cookie not Received" 29004 }, 29005 "forbidden": { 29006 "description": "Insufficient Permissions" 29007 } 29008 } 29009 }