{ "openapi": "3.1.0", "info": { "title": "SD-WAN Services", "description": "Includes API operations for managing SD-WAN services such as Cloud OnRamp for SaaS and MultiCloud", "contact": { "email": "vmanage@cisco.com" }, "license": { "name": "Commercial License", "url": "https://www.cisco.com/c/en/us/solutions/enterprise-networks/sd-wan/index.html" }, "version": "26.1.0+2026-01-06", "x-provenance": { "method": "harvested", "authored_by": "Cisco Catalyst SD-WAN", "harvested_by": "API Evangelist", "harvested_on": "2026-08-19", "first_party": true, "provider_published": true, "source_host": "pubhub.devnetcloud.com", "note": "4,138 operations across 2,841 paths, published by Cisco as self-contained per-operation OpenAPI 3.1.0 fragments on the DevNet CDN and consolidated here into 13 documents. Ownership verified from info.contact vmanage@cisco.com and the Cisco license URL rather than from the fetch host." }, "x-evidence": [ { "type": "source", "url": "https://pubhub.devnetcloud.com/media/cisco-catalyst-sd-wan-26-1-api-guide/docs/" }, { "type": "source", "url": "https://developer.cisco.com/docs/sdwan/" } ] }, "servers": [ { "url": "/dataservice" } ], "tags": [ { "name": "Configuration - Multi Cloud" }, { "name": "Data Collection Agent" }, { "name": "Multicloud Interconnect - Accounts" }, { "name": "Multicloud Interconnect - Cloud Resource Management" }, { "name": "Multicloud Interconnect - Connectivity" }, { "name": "Multicloud Interconnect - Entitlement" }, { "name": "Multicloud Interconnect - Gateways" }, { "name": "Multicloud Interconnect - General" }, { "name": "Multicloud Interconnect - Global Settings" }, { "name": "Multicloud Interconnect - Monitoring" }, { "name": "Multicloud Interconnect - Resource Audit" }, { "name": "Multicloud Interconnect - Service Sw package types" }, { "name": "Multicloud Interconnect - Services" }, { "name": "Service Chain Mapping" }, { "name": "System - Cloud Service" } ], "paths": { "/cloudservices/accesstoken": { "get": { "tags": [ "System - Cloud Service" ], "operationId": "getAccessTokenforDevice", "responses": { "default": { "description": "default response", "content": { "application/json": {} } } } } }, "/cloudservices/authtoken": { "post": { "tags": [ "System - Cloud Service" ], "description": "Get Azure token", "operationId": "getAzureToken", "requestBody": { "content": { "*/*": { "schema": { "type": "string" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/octet-stream": { "schema": { "type": "object" }, "examples": { "Telemetry state": { "description": "Telemetry state", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "CXP-read,CXP-write,Cloud OnRamp-read,Cloud OnRamp-write" } }, "/cloudservices/connect": { "get": { "tags": [ "System - Cloud Service" ], "description": "Telemetry Opt In", "operationId": "connect_SystemCloudService_2203", "responses": { "200": { "description": "Success", "content": { "application/octet-stream": { "schema": { "type": "object" }, "examples": { "Telemetry Opt In": { "description": "Telemetry Opt In", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "CXP-read,CXP-write,Cloud OnRamp-read,Cloud OnRamp-write" } }, "/cloudservices/credentials": { "get": { "tags": [ "System - Cloud Service" ], "description": "Get cloud service credentials", "operationId": "getCloudCredentials", "responses": { "200": { "description": "Success", "content": { "application/octet-stream": { "schema": { "type": "object" }, "examples": { "Cloud service credentials": { "description": "Cloud service credentials", "value": { "clientId": "exampleClientId" } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "CXP-read,CXP-write,Cloud OnRamp-read,Cloud OnRamp-write" }, "post": { "tags": [ "System - Cloud Service" ], "description": "Add cloud service credentials", "operationId": "addCloudCredentials", "requestBody": { "description": "Cloud service credentials", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Cloud service credentials": { "description": "Cloud service credentials", "value": { "clientId": "exampleClientId", "clientsecret": "exampleClientSecret", "cloudTenantId": "exampleCloudTenantId" } } } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "dca,CXP-write,Cloud OnRamp-write" } }, "/cloudservices/devicecode": { "post": { "tags": [ "System - Cloud Service" ], "description": "Get Azure device code", "operationId": "getDeviceCode", "responses": { "200": { "description": "Success", "content": { "application/octet-stream": { "schema": { "type": "object" }, "examples": { "Telemetry state": { "description": "Telemetry state", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "CXP-read,CXP-write,Cloud OnRamp-read,Cloud OnRamp-write" } }, "/cloudservices/m365/preferredpath": { "post": { "tags": [ "System - Cloud Service" ], "description": "Get vAnalytics Preferred Path for Office365 over time. The data can be filtered on time and other unique parameters based upon necessity and intended usage", "operationId": "getO365PreferredPathFromVAnalytics", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "object", "properties": { "valueType": { "type": "string", "enum": [ "ARRAY", "OBJECT", "STRING", "NUMBER", "TRUE", "FALSE", "NULL" ] } } } } } }, "required": true }, "responses": { "default": { "description": "default response", "content": { "application/json": {} } } } } }, "/cloudservices/staging": { "get": { "tags": [ "System - Cloud Service" ], "description": "Check if testbed or production", "operationId": "isStaging", "responses": { "200": { "description": "Success", "content": { "application/octet-stream": { "schema": { "type": "object" }, "examples": { "Environment": { "description": "Environment", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "CXP-read,CXP-write,Cloud OnRamp-read,Cloud OnRamp-write" } }, "/cloudservices/telemetry": { "get": { "tags": [ "System - Cloud Service" ], "description": "Get Telemetry state", "operationId": "getTelemetryState", "responses": { "200": { "description": "Success", "content": { "application/octet-stream": { "schema": { "type": "object" }, "examples": { "Telemetry state": { "description": "Telemetry state", "value": [ { "tenantId": "default", "optIn": "true", "geography": "north-america", "feature_name": "webex-group", "cloudTenantId": "113d24ba-139b-4dfe-a0eb-9a4e32d525a0", "org_name": "my org name" } ], "$$ref": "#/components/examples/ComViptelaVmanageServerCloudservicesResponseExampleO365Telemetry" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "CXP-read,CXP-write,Settings-read,Settings-write,Cloud OnRamp-read,Cloud OnRamp-write" } }, "/cloudservices/telemetry/optin": { "put": { "tags": [ "System - Cloud Service" ], "description": "Telemetry Opt In", "operationId": "optIn", "requestBody": { "content": { "*/*": { "schema": { "type": "string" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/octet-stream": { "schema": { "type": "object" }, "examples": { "Telemetry Opt In": { "description": "Telemetry Opt In", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "CXP-read,CXP-write,Cloud OnRamp-read,Cloud OnRamp-write" } }, "/cloudservices/telemetry/optout": { "delete": { "tags": [ "System - Cloud Service" ], "description": "Telemetry Opt Out", "operationId": "optOut", "requestBody": { "content": { "*/*": { "schema": { "type": "string" } } } }, "responses": { "200": { "description": "Success", "content": { "application/octet-stream": { "schema": { "type": "object" }, "examples": { "Telemetry Opt Out": { "description": "Telemetry Opt Out", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "Template Configuration-write,Template Deploy-write,CXP-read,CXP-write,Cloud OnRamp-read,Cloud OnRamp-write" } }, "/cloudservices/vanalytics/dashboardlist": { "get": { "tags": [ "System - Cloud Service" ], "description": "Get vAnalytics Dashboard List", "operationId": "getvAnalyticsDashboardList", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "DCA access token": { "description": "DCA access token", "value": { "body": [ { "dashboardContainer": "monitor", "dashboardName": "overview", "displayName": "Overview", "path": "/analytics/v4/overview", "srcUrl": "analytics-us-stg01.sdwan.cisco.com" }, { "dashboardContainer": "Monitor", "dashboardName": "applications", "displayName": "Applications", "path": "/analytics/v4/applications", "srcUrl": "analytics-us-stg01.sdwan.cisco.com" }, { "dashboardContainer": "Monitor", "dashboardName": "sites", "displayName": "Sites", "path": "/analytics/v4/sites", "srcUrl": "analytics-us-stg01.sdwan.cisco.com" } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerCloudservicesResponseExampleVaDashboardList" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "vAnalytics-readvAnalytics-write" } }, "/dca/analytics": { "put": { "tags": [ "Data Collection Agent" ], "description": "Update collection time of DCARest stat for vAnalytics", "operationId": "createStats", "requestBody": { "description": "Stats query", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats query": { "description": "Stats query", "value": [ { "tenantId": "15d42ac9-94d2-4c2b-bad1-4b7d5259ce84", "stats": [ { "statisticsName": "status", "collectionTime": 1717158934 }, { "statisticsName": "device", "collectionTime": 1717158934 } ] } ], "$$ref": "#/components/examples/ComViptelaVmanageServerDcaRequestExampleDcaAnalytics" } } } }, "required": true }, "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats data": { "description": "Stats data", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/dca/analytics/all": { "post": { "tags": [ "Data Collection Agent" ], "description": "Get all statistics setting data", "operationId": "getAllStatsDataDCA", "requestBody": { "description": "Stats setting", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats query": { "description": "Stats query", "value": { "tenantId": [ "15d42ac9-94d2-4c2b-bad1-4b7d5259ce84", "84706b7c-6a71-4423-a55f-9bc069139e87" ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerDcaRequestExampleDcaAnalyticsAll" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats index status": { "description": "Stats index status", "value": [ { "statisticsName": "status", "tenantId": "15d42ac9-94d2-4c2b-bad1-4b7d5259ce84", "collectionTime": 1717155340, "@rid": 4660 }, { "statisticsName": "device", "tenantId": "15d42ac9-94d2-4c2b-bad1-4b7d5259ce84", "collectionTime": 1717157134, "@rid": 4661 }, { "statisticsName": "status", "tenantId": "84706b7c-6a71-4423-a55f-9bc069139e87", "collectionTime": 1717157437, "@rid": 4662 }, { "statisticsName": "device", "tenantId": "84706b7c-6a71-4423-a55f-9bc069139e87", "collectionTime": 1717155334, "@rid": 4696 } ], "$$ref": "#/components/examples/ComViptelaVmanageServerDcaResponseExampleDcaAnalyticsAll" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/dca/cloudservices": { "get": { "tags": [ "System - Cloud Service" ], "description": "Get cloud service settings", "operationId": "getCloudSettings", "responses": { "200": { "description": "Success", "content": { "application/octet-stream": { "schema": { "type": "object" }, "examples": { "Cloud service setting": { "description": "Cloud service setting", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "dca" } }, "/dca/cloudservices/accesstoken": { "get": { "tags": [ "Data Collection Agent" ], "description": "Get DCA access token", "operationId": "getAccessToken", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "DCA access token": { "description": "DCA access token", "value": { "token": "token text", "exp": 1717313731, "sp_org_name": "my sp org name", "cloud": "AWS", "region": "Americas", "vmonitor_url": "vmonitor.sdwan.cisco.com", "dcs_url": "analytics.sdwan.cisco.com", "iss": "urn:dms", "iat": 1717140931, "aud": "urn:vanalytics" }, "$$ref": "#/components/examples/ComViptelaVmanageServerDcaResponseExampleAccessToken" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Data Collection Agent" ], "description": "Set DCA access token", "operationId": "storeAccessToken", "requestBody": { "description": "DCA access token", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "DCA access token": { "description": "DCA access token", "value": { "token": "token data", "exp": 1717331845, "sp_org_name": "my org name", "cloud": "AWS", "region": "Americas", "vmonitor_url": "sdwan.cisco.com", "dcs_url": "sdwan.cisco.com", "iss": "urn:dms", "iat": 1717159044, "aud": "urn:vanalytics" }, "$$ref": "#/components/examples/ComViptelaVmanageServerDcaRequestExampleAccessToken" } } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/dca/cloudservices/alarm": { "post": { "tags": [ "Data Collection Agent" ], "description": "Generate DCA alarms", "operationId": "generateAlarm", "requestBody": { "description": "DCA alarm message", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "DCA alarm message": { "description": "DCA alarm message", "value": { "type": "otp_expired", "message": "Cloud service OTP expired" } } } } }, "required": true }, "responses": { "202": { "description": "Accepted" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/dca/cloudservices/idtoken": { "get": { "tags": [ "Data Collection Agent" ], "description": "Get DCA Id token", "operationId": "getIdToken", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "DCA Id token": { "description": "DCA Id token", "value": { "token": "token text", "exp": 1717313731, "sp_org_name": "my sp org name", "cloud": "AWS", "region": "Americas", "vmonitor_url": "vmonitor.sdwan.cisco.com", "dcs_url": "analytics.sdwan.cisco.com", "iss": "urn:dms", "iat": 1717140931, "aud": "urn:vanalytics" }, "$$ref": "#/components/examples/ComViptelaVmanageServerDcaResponseExampleIdToken" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Data Collection Agent" ], "description": "Set DCA Id token", "operationId": "storeIdToken", "requestBody": { "description": "DCA Id token", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "DCA Id token": { "description": "DCA Id token", "value": { "token": "token data", "sp_org_name": "VMANAGE", "cloud": "AWS", "region": "Americas", "vmonitor_url": "sdwan.cisco.com", "dcs_url": "sdwan.cisco.com", "exp": 1717180644, "iss": "urn:dms", "iat": 1717159044, "aud": "urn:vanalytics" }, "$$ref": "#/components/examples/ComViptelaVmanageServerDcaRequestExampleIdToken" } } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/dca/cloudservices/otp": { "get": { "tags": [ "System - Cloud Service" ], "description": "Get cloud service OTP value", "operationId": "getOTP", "responses": { "200": { "description": "Success", "content": { "application/octet-stream": { "schema": { "type": "object" }, "examples": { "Cloud service OTP value": { "description": "Cloud service OTP value", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "dca" }, "put": { "tags": [ "System - Cloud Service" ], "description": "Update cloud service OTP value", "operationId": "updatetOTP", "requestBody": { "description": "Cloud service OTP value", "content": { "application/octet-stream": { "schema": { "type": "object" }, "examples": { "Cloud service OTP value": { "description": "Cloud service OTP value", "value": {} } } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "dca" } }, "/dca/cloudservices/telemetry": { "get": { "tags": [ "Data Collection Agent" ], "description": "Get DCA telemetry settings", "operationId": "getTelemetrySettings", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "DCA telemetry settings": { "description": "DCA telemetry settings", "value": [ { "tenantId": "default", "optIn": "true", "geography": "north-america", "feature_name": "webex-group", "cloudTenantId": "443d24ba-149b-4dfe-a0eb-9a4e32d525a0", "org_name": "my org name" } ], "$$ref": "#/components/examples/ComViptelaVmanageServerDcaResponseExampleAppTelemetry" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/dca/cloudservices/vanalytics": { "post": { "tags": [ "System - Cloud Service" ], "description": "Get session from DCS for vAnalytics", "operationId": "getvAnalytics", "requestBody": { "content": { "*/*": { "schema": { "type": "string" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/octet-stream": { "schema": { "type": "object" }, "examples": { "Cloud service OTP value": { "description": "Cloud service OTP value", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "x-roles-required": "vAnalytics-readvAnalytics-writedca" } }, "/dca/data/device/state/{state_data_type}": { "post": { "tags": [ "Data Collection Agent" ], "description": "Get device state data", "operationId": "generateDCADeviceStateData", "parameters": [ { "name": "state_data_type", "in": "path", "description": "Device state data", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query string": { "description": "Query string", "value": { "tenantId": [ "84706b7c-6a71-4423-a55f-9bc069139e87" ], "count": 10000 }, "$$ref": "#/components/examples/ComViptelaVmanageServerDcaRequestExampleDeviceDataState" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Device state": { "description": "Device state", "value": { "header": { "generatedOn": 1717159047358, "viewKeys": { "uniqueKey": [ "vdevice-dataKey" ], "preferenceKey": "grid-ControlWanInterface" }, "columns": [ { "title": "Instance", "property": "instance", "width": 100, "dataType": "number" }, { "title": "Index", "property": "index", "width": 100, "dataType": "number" }, { "title": "Interface", "property": "interface", "width": 120, "dataType": "string" }, { "title": "Public IP", "property": "public-ip", "width": 100, "dataType": "ip" }, { "title": "Public Port", "property": "public-port", "width": 100, "dataType": "number" }, { "title": "Private IP", "property": "private-ip", "width": 100, "dataType": "ip" }, { "title": "Private Port", "property": "private-port", "width": 100, "dataType": "number" }, { "title": "Num vSmarts", "property": "num-vsmarts", "width": 150, "dataType": "number" }, { "title": "Num vManages", "property": "num-vmanages", "width": 150, "dataType": "number" }, { "title": "Weight", "property": "weight", "width": 100, "dataType": "number" }, { "title": "Color", "property": "color", "width": 100, "dataType": "string" }, { "title": "Carrier", "property": "carrier", "width": 100, "dataType": "string" }, { "title": "Preference", "property": "preference", "width": 100, "dataType": "string" }, { "title": "Max Controllers", "property": "per-wan-max-controllers", "width": 100, "dataType": "number" }, { "title": "Admin State", "property": "admin-state", "width": 100, "dataType": "string" }, { "title": "Operation State", "property": "operation-state", "width": 150, "dataType": "string" }, { "title": "Last Connection", "property": "last-conn-time-date", "displayFormat": "DD MMM YYYY h:mm:ss A z", "inputFormat": "unix-time", "width": 150, "dataType": "date" }, { "title": "Restrict", "property": "restrict-str", "width": 50, "dataType": "string" }, { "title": "Control Conn Rqd", "property": "control-str", "width": 50, "dataType": "string" }, { "title": "Vbond As Stun Server", "property": "vbond-as-stun-server", "width": 150, "dataType": "string" }, { "title": "vManage Preference", "property": "vmanage-connection-preference", "width": 150, "dataType": "string" }, { "title": "Private IPv6", "property": "private-ipv6", "width": 150, "dataType": "string" }, { "title": "SPI Time Remaining", "property": "spi-change", "width": 150, "dataType": "string" }, { "title": "Last Resort Interface", "property": "last-resort", "width": 150, "dataType": "string" }, { "title": "Interface Changed Port", "property": "wan-port-hopped", "width": 150, "dataType": "string" }, { "title": "Time Since Last Port Hop", "property": "wan-time-since-port-hop", "width": 150, "dataType": "string" }, { "title": "Low Bandwidth Interface", "property": "low-bandwidth-link", "width": 150, "dataType": "string" }, { "title": "NAT Type", "property": "nat-type", "width": 150, "dataType": "string" }, { "title": "Region ID", "property": "region-id", "width": 100, "dataType": "string" }, { "title": "Bind Interface", "property": "bind-interface", "width": 100, "dataType": "string" }, { "title": "Last Updated", "property": "lastupdated", "displayFormat": "DD MMM YYYY h:mm:ss A z", "inputFormat": "unix-time", "hideable": false, "minWidth": 220, "dataType": "date" } ], "fields": [ { "property": "vdevice-name", "dataType": "string" }, { "property": "vdevice-host-name", "dataType": "string" }, { "property": "instance", "dataType": "number" }, { "property": "index", "dataType": "number" }, { "property": "interface", "dataType": "string" }, { "property": "public-ip", "dataType": "ip" }, { "property": "public-port", "dataType": "number" }, { "property": "private-ip", "dataType": "ip" }, { "property": "private-port", "dataType": "number" }, { "property": "num-vsmarts", "dataType": "number" }, { "property": "num-vmanages", "dataType": "number" }, { "property": "weight", "dataType": "number" }, { "property": "color", "dataType": "string" }, { "property": "carrier", "dataType": "string" }, { "property": "preference", "dataType": "string" }, { "property": "per-wan-max-controllers", "dataType": "number" }, { "property": "admin-state", "dataType": "string" }, { "property": "operation-state", "dataType": "string" }, { "property": "last-conn-time", "dataType": "uptime" }, { "property": "last-conn-time-date", "dataType": "date" }, { "property": "restrict-str", "dataType": "string" }, { "property": "control-str", "dataType": "string" }, { "property": "vbond-as-stun-server", "dataType": "string" }, { "property": "vmanage-connection-preference", "dataType": "string" }, { "property": "private-ipv6", "dataType": "string" }, { "property": "spi-change", "dataType": "string" }, { "property": "last-resort", "dataType": "string" }, { "property": "wan-port-hopped", "dataType": "string" }, { "property": "wan-time-since-port-hop", "dataType": "string" }, { "property": "low-bandwidth-link", "dataType": "string" }, { "property": "nat-type", "dataType": "string" }, { "property": "region-id", "dataType": "string" }, { "property": "bind-interface", "dataType": "string" }, { "property": "service-provider", "dataType": "string" }, { "property": "bandwidth-upstream", "dataType": "number" }, { "property": "bandwidth-downstream", "dataType": "number" }, { "property": "createTimeStamp", "dataType": "date" }, { "property": "lastupdated", "dataType": "date" } ], "chart": {} }, "data": [ { "recordId": "0:ControlWanInterfaceNode:1717138766789:7619", "instance": 0, "low-bandwidth-link": "No", "vdevice-name": "172.16.254.1", "color": "3g", "nat-type": "E", "admin-state": "up", "interface": "ge0/1", "restrict-str": "no", "@rid": 11469, "private-ipv6": "::", "private-ip": "10.101.2.2", "per-wan-max-controllers": 2, "num-vsmarts": 2, "num-vmanages": 0, "preference": "0", "createTimeStamp": 1717138766789, "weight": 1, "index": 0, "private-port": 12366, "vdevice-host-name": "vm2", "vbond-as-stun-server": "no", "control-str": "yes", "carrier": "default", "last-resort": "No", "vdevice-dataKey": "172.16.254.1-0-0", "vmanage-connection-preference": "5", "vmanage-system-ip": "169.254.10.9", "operation-state": "up", "public-ip": "10.101.2.2", "tenantId": "84706b7c-6a71-4423-a55f-9bc069139e87", "public-port": 12366, "region-id": "Default", "lastupdated": 1717138787774, "wan-port-hopped": "TRUE" } ], "pageInfo": { "startId": "11469", "endId": "11469", "moreEntries": false, "count": 1 } }, "$$ref": "#/components/examples/ComViptelaVmanageServerDcaResponseExampleDeviceDataState" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/dca/data/device/statistics/{stats_data_type}": { "post": { "tags": [ "Data Collection Agent" ], "description": "Get device statistics data", "operationId": "generateDCADeviceStatisticsData", "parameters": [ { "name": "stats_data_type", "in": "path", "description": "Device statistics data", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query string": { "description": "Query string", "value": { "tenantId": [ "15d42ac9-94d2-4c2b-bad1-4b7d5259ce84", "26cef033-8569-402e-8742-dcab44fb82e3", "84706b7c-6a71-4423-a55f-9bc069139e87" ], "startDate": "2024-05-31T12:20:37", "endDate": "2024-05-31T12:25:37", "timeZone": "UTC", "count": 10000 }, "$$ref": "#/components/examples/ComViptelaVmanageServerDcaRequestExampleDataDeviceStatistics" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Device statistics": { "description": "Device statistics", "value": { "header": { "generatedOn": 1717159053944, "viewKeys": { "uniqueKey": [], "preferenceKey": "grid-raw_auditlog" }, "columns": [ { "title": "Entry_time", "property": "entry_time", "displayFormat": "DD MMM YYYY h:mm:ss A z", "inputFormat": "unix-time", "dataType": "date" }, { "title": "Log id", "property": "logid", "dataType": "string" }, { "title": "Log module", "property": "logmodule", "dataType": "string" } ], "fields": [ { "property": "entry_time", "dataType": "date" }, { "property": "logid", "dataType": "string" }, { "property": "logmodule", "dataType": "string" } ], "chart": {} }, "data": [], "pageInfo": { "hasMoreData": false, "count": 0, "totalCount": 0 } }, "$$ref": "#/components/examples/ComViptelaVmanageServerDcaResponseExampleDataDeviceStatistics" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/dca/dcatenantowners": { "get": { "tags": [ "Data Collection Agent" ], "description": "Get DCA tenant owners", "operationId": "getDCATenantOwners", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "DCA service owner": { "description": "DCA service owner", "value": { "2755bda8-49e7-4069-8a8f-47973a6db193": [ "7c72845a-6808-4a75-ad00-96d6c1741d42" ], "342466c6-d0ed-49a8-96bf-1ad66e78dfcb": [ "2f38520a-ddc2-47cd-911d-5c83f2af2fd5", "9e5ca1f3-e313-4ac1-870a-fc20e57ea460", "99f164ee-72df-47c5-92b5-bc2ab9f22b02", "f8eb289f-81b3-4a4d-86eb-bdd0a37f928f" ], "e3b38ba2-5f4d-492b-a624-e048028111c5": [ "f6c58a1d-67f6-4c76-9006-c367c37eeb0b", "30f18e33-8a12-4c17-882f-a57fd558027b" ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerDcaResponseExampleDcaTenantOwners" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/dca/device": { "post": { "tags": [ "Data Collection Agent" ], "description": "Get all devices", "operationId": "listAllDevicesDCA", "requestBody": { "description": "Query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query string": { "description": "Query string", "value": { "tenantId": [ "57501bad-32a7-4f52-8f54-8547dcd7403e", "07917db1-bb13-40a0-a075-f81e91cd3bd4" ] } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "Device lists": { "description": "Device lists", "value": { "header": { "generatedOn": 1717672137403, "viewKeys": { "uniqueKey": [ "system-ip" ], "preferenceKey": "grid-DeviceMultitenant" }, "columns": [ { "title": "System IP", "property": "local-system-ip", "width": 110, "dataType": "ipv4" }, { "title": "Site ID", "property": "site-id", "width": 70, "dataType": "numberStr" }, { "title": "Device Model", "property": "device-model", "display": "multiColumns", "width": 100, "dataType": "deviceModel" }, { "title": "Version", "property": "version", "width": 150, "dataType": "string" }, { "title": "Up Since", "property": "uptime-date", "displayFormat": "DD MMM YYYY h:mm:ss A z", "inputFormat": "unix-time", "width": 200, "dataType": "date" }, { "title": "Chassis Number/ID", "property": "uuid", "width": 220, "dataType": "string" }, { "title": "Connected Manager", "property": "connectedVManages", "visible": true, "width": 500, "dataType": "array" } ], "fields": [ { "property": "local-system-ip", "dataType": "ipv4" }, { "property": "site-id", "dataType": "numberStr" }, { "property": "device-model", "dataType": "deviceModel", "display": "multiColumns" }, { "property": "version", "dataType": "string" }, { "property": "uptime-date", "dataType": "date" }, { "property": "uuid", "dataType": "string" }, { "property": "connectedVManages", "dataType": "array" } ] }, "data": [ { "uuid": "e730d2b0-20ab-4875-81ac-4994e1386f9e", "device-model": "vmanage", "version": "20.15.0-89", "connectedVManages": [ "169.254.10.1" ], "site-id": "200", "uptime-date": 1717477260000, "local-system-ip": "172.16.255.200", "tenantId": "57501bad-32a7-4f52-8f54-8547dcd7403e" }, { "uuid": "059e6962-a06e-4e03-93ca-1e32a1f65bab", "device-model": "vsmart", "version": "20.15.0-47", "connectedVManages": [ "169.254.10.1" ], "site-id": "129", "uptime-date": 1717476420000, "local-system-ip": "172.16.253.129", "tenantId": "57501bad-32a7-4f52-8f54-8547dcd7403e" }, { "uuid": "b368ff1a-640c-4440-8f4d-1380ef86d4e6", "version": "20.15.0-47", "connectedVManages": [ "169.254.10.1" ], "uptime-date": 1717476360000, "local-system-ip": "172.16.255.128", "tenantId": "57501bad-32a7-4f52-8f54-8547dcd7403e" }, { "uuid": "03bbab85-fa08-490b-bb1b-e787999c0e10", "device-model": "vedge-cloud", "version": "20.9.5-789", "connectedVManages": [ "169.254.10.1" ], "site-id": "3", "uptime-date": 1717475880000, "local-system-ip": "172.16.254.2", "tenantId": "07917db1-bb13-40a0-a075-f81e91cd3bd4" } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerDcaResponseExampleDevice" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/dca/device/crashlog/details": { "post": { "tags": [ "Data Collection Agent" ], "description": "Get crash log", "operationId": "getCrashLogs", "requestBody": { "description": "Query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats query": { "description": "Stats query", "value": { "tenantId": [ "07917db1-bb13-40a0-a075-f81e91cd3bd4", "57501bad-32a7-4f52-8f54-8547dcd7403e" ] } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Crash logs": { "description": "Crash logs", "value": { "header": { "generatedOn": 1717660655976, "viewKeys": { "uniqueKey": [ "vdevice-dataKey" ], "preferenceKey": "grid-CrashLog" }, "columns": [ { "title": "Hostname", "property": "vdevice-host-name", "hideable": false, "dataType": "string" }, { "title": "System IP", "property": "vdevice-name", "hideable": false, "minWidth": 120, "dataType": "string" }, { "title": "Index", "property": "index", "hideable": false, "width": 100, "dataType": "number" }, { "title": "Core Time", "property": "core-time-date", "displayFormat": "DD MMM YYYY h:mm:ss A z", "inputFormat": "unix-time", "hideable": false, "width": 200, "dataType": "date" }, { "title": "Core Filename", "property": "core-filename", "hideable": false, "width": 220, "dataType": "string" } ], "fields": [ { "property": "vdevice-host-name", "dataType": "string" }, { "property": "vdevice-name", "dataType": "string" }, { "property": "index", "dataType": "number" }, { "property": "core-time", "dataType": "datePrettyWithMixedTZ" }, { "property": "core-time-date", "dataType": "date" }, { "property": "core-filename", "dataType": "string" }, { "property": "lastupdated", "dataType": "date" } ] }, "data": [ { "vdevice-name": "172.16.254.3", "createTimeStamp": 1717658754622, "index": 0, "core-filename": "core.vdaemon.vm4.gz", "vdevice-host-name": "vm4", "core-time": "Thu Jun 6 07:23:17 UTC 2024", "vdevice-dataKey": "172.16.254.3-0", "@rid": 15894, "vmanage-system-ip": "169.254.10.11", "tenantId": "07917db1-bb13-40a0-a075-f81e91cd3bd4", "lastupdated": 1717658754575, "core-time-date": 1717658597000 } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerDcaResponseExampleCrashlogDetails" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/dca/device/crashlog/synced": { "get": { "tags": [ "Data Collection Agent" ], "description": "Get device crash log", "operationId": "getCrashLogsSynced", "parameters": [ { "name": "deviceId", "in": "query", "description": "Device Id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Crash logs": { "description": "Crash logs", "value": { "header": { "generatedOn": 1717659767636, "viewKeys": { "uniqueKey": [ "vdevice-dataKey" ], "preferenceKey": "grid-CrashLog" }, "columns": [ { "title": "Hostname", "property": "vdevice-host-name", "hideable": false, "dataType": "string" }, { "title": "System IP", "property": "vdevice-name", "hideable": false, "minWidth": 120, "dataType": "string" }, { "title": "Index", "property": "index", "hideable": false, "width": 100, "dataType": "number" }, { "title": "Core Time", "property": "core-time-date", "displayFormat": "DD MMM YYYY h:mm:ss A z", "inputFormat": "unix-time", "hideable": false, "width": 200, "dataType": "date" }, { "title": "Core Filename", "property": "core-filename", "hideable": false, "width": 220, "dataType": "string" } ], "fields": [ { "property": "vdevice-host-name", "dataType": "string" }, { "property": "vdevice-name", "dataType": "string" }, { "property": "index", "dataType": "number" }, { "property": "core-time", "dataType": "datePrettyWithMixedTZ" }, { "property": "core-time-date", "dataType": "date" }, { "property": "core-filename", "dataType": "string" }, { "property": "lastupdated", "dataType": "date" } ] }, "data": [ { "vdevice-name": "172.16.254.14", "createTimeStamp": 1717492338526, "index": 0, "core-filename": "core.cfgmgr.vm14.gz", "vdevice-host-name": "vm14", "core-time": "Tue Jun 4 09:09:50 UTC 2024", "vdevice-dataKey": "172.16.254.14-0", "@rid": 12710, "vmanage-system-ip": "169.254.10.15", "tenantId": "0bb00e4a-10e1-4d8b-a754-d9e6afed547d", "lastupdated": 1717492338517, "core-time-date": 1717492190000 }, { "vdevice-name": "172.16.254.14", "createTimeStamp": 1717492338651, "index": 1, "core-filename": "core.vdaemon.vm14.gz", "vdevice-host-name": "vm14", "core-time": "Tue Jun 4 09:09:35 UTC 2024", "vdevice-dataKey": "172.16.254.14-1", "@rid": 12711, "vmanage-system-ip": "169.254.10.15", "tenantId": "0bb00e4a-10e1-4d8b-a754-d9e6afed547d", "lastupdated": 1717492338517, "core-time-date": 1717492175000 } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerDcaResponseExampleCrashlogSynced" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/dca/settings/configuration/cloudservices/dca": { "get": { "tags": [ "Data Collection Agent" ], "description": "Get DCA cloud service configuration", "operationId": "getCloudServicesConfigurationDCA", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "DCA cloud service configuration": { "description": "DCA cloud service configuration", "value": { "header": { "generatedOn": 1717153091638 }, "data": { "tenants": [ { "vanalyticsEnabled": true, "eulaAccepted": true, "vanalyticsEnabledTime": 1717140940, "rml": false, "tenantId": "15d42ac9-94d2-4c2b-bad1-4b7d5259ce84", "enabled": true, "otp": "********", "cloudGatewayUrl": "datamanagement-us-01.sdwan.cisco.com" }, { "vanalyticsEnabled": true, "eulaAccepted": true, "vanalyticsEnabledTime": 1717140937, "rml": false, "tenantId": "26cef033-8569-402e-8742-dcab44fb82e3", "enabled": true, "otp": "********", "cloudGatewayUrl": "datamanagement-us-01.sdwan.cisco.com" }, { "vanalyticsEnabled": true, "eulaAccepted": true, "vanalyticsEnabledTime": 1717140934, "rml": false, "tenantId": "84706b7c-6a71-4423-a55f-9bc069139e87", "enabled": true, "otp": "********", "cloudGatewayUrl": "datamanagement-us-01.sdwan.cisco.com" } ] } }, "$$ref": "#/components/examples/ComViptelaVmanageServerDcaResponseExampleDcaCloudservicesSettings" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/dca/settings/configuration/{type}/dca": { "post": { "tags": [ "Data Collection Agent" ], "description": "Create analytics config data", "operationId": "createDCAAnalyticsDataFile", "parameters": [ { "name": "type", "in": "path", "description": "Data type", "required": true, "schema": { "type": "string", "enum": [ "analytics", "callHome" ] } } ], "requestBody": { "description": "Query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query string": { "description": "Query string", "value": { "tenantId": [ "tenant1", "tenant2" ] } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Analytics config data": { "description": "Analytics config data", "value": { "header": { "generatedOn": 1717561371848 }, "data": { "dcs-region": "N/A", "tenants": [] } } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true } }, "/dca/statistics/settings/status": { "post": { "tags": [ "Data Collection Agent" ], "description": "Get statistics setting status", "operationId": "getStatsDBIndexStatus", "requestBody": { "description": "Stats setting", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats query": { "description": "Stats query", "value": { "tenantId": [ "15d42ac9-94d2-4c2b-bad1-4b7d5259ce84", "26cef033-8569-402e-8742-dcab44fb82e3", "84706b7c-6a71-4423-a55f-9bc069139e87" ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerDcaRequestExampleStatisticsSettingsStatus" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Stats response": { "description": "Stats response", "value": [ { "indexName": "aggregatedappsdpistatistics", "status": "enable", "tenantId": "84706b7c-6a71-4423-a55f-9bc069139e87" }, { "indexName": "aggregatedappsdpistatistics", "status": "enable", "tenantId": "26cef033-8569-402e-8742-dcab44fb82e3" }, { "indexName": "aggregatedappsdpistatistics", "status": "enable", "tenantId": "15d42ac9-94d2-4c2b-bad1-4b7d5259ce84" }, { "indexName": "aggregatedappsdpisummary", "status": "enable", "tenantId": "84706b7c-6a71-4423-a55f-9bc069139e87" }, { "indexName": "aggregatedappsdpisummary", "status": "enable", "tenantId": "26cef033-8569-402e-8742-dcab44fb82e3" }, { "indexName": "aggregatedappsdpisummary", "status": "enable", "tenantId": "15d42ac9-94d2-4c2b-bad1-4b7d5259ce84" }, { "indexName": "apphostingstatistics", "status": "enable", "tenantId": "84706b7c-6a71-4423-a55f-9bc069139e87" }, { "indexName": "apphostingstatistics", "status": "enable", "tenantId": "26cef033-8569-402e-8742-dcab44fb82e3" }, { "indexName": "apphostingstatistics", "status": "enable", "tenantId": "15d42ac9-94d2-4c2b-bad1-4b7d5259ce84" }, { "indexName": "approutestatsstatistics", "status": "enable", "tenantId": "84706b7c-6a71-4423-a55f-9bc069139e87" } ], "$$ref": "#/components/examples/ComViptelaVmanageServerDcaResponseExampleStatisticsSettingsStatus" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/dca/system/device": { "post": { "tags": [ "Data Collection Agent" ], "description": "Get device details", "operationId": "getDevicesDetailsDCA", "requestBody": { "description": "Query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query string": { "description": "Query string", "value": { "tenantId": [ "07917db1-bb13-40a0-a075-f81e91cd3bd4" ] } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Device details": { "description": "Device details", "value": { "header": { "generatedOn": 1717565961425, "viewKeys": { "uniqueKey": [ "system-ip" ], "preferenceKey": "grid-DeviceMultitenant" }, "columns": [ { "title": "System IP", "property": "local-system-ip", "width": 110, "dataType": "ipv4" }, { "title": "Site ID", "property": "site-id", "width": 70, "dataType": "numberStr" }, { "title": "Device Model", "property": "device-model", "display": "multiColumns", "width": 100, "dataType": "deviceModel" }, { "title": "Version", "property": "version", "width": 150, "dataType": "string" }, { "title": "Up Since", "property": "uptime-date", "displayFormat": "DD MMM YYYY h:mm:ss A z", "inputFormat": "unix-time", "width": 200, "dataType": "date" }, { "title": "Connected Manager", "property": "connectedVManages", "visible": true, "width": 500, "dataType": "array" } ], "fields": [ { "property": "local-system-ip", "dataType": "ipv4" }, { "property": "site-id", "dataType": "numberStr" }, { "property": "device-model", "dataType": "deviceModel", "display": "multiColumns" }, { "property": "version", "dataType": "string" }, { "property": "uptime-date", "dataType": "date" }, { "property": "connectedVManages", "dataType": "array" } ] }, "data": [ { "device-model": "vedge-cloud", "version": "20.9.5-789", "connectedVManages": [ "169.254.10.1" ], "site-id": "2", "uptime-date": 1717475880000, "local-system-ip": "172.16.254.1", "tenantId": "07917db1-bb13-40a0-a075-f81e91cd3bd4" }, { "device-model": "vedge-cloud", "version": "20.9.5-789", "connectedVManages": [ "169.254.10.1" ], "site-id": "3", "uptime-date": 1717475880000, "local-system-ip": "172.16.254.2", "tenantId": "07917db1-bb13-40a0-a075-f81e91cd3bd4" } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerDcaResponseExampleSystemDevice" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/dca/template/device/config/attachedconfig": { "post": { "tags": [ "Data Collection Agent" ], "description": "Get attached config to device", "operationId": "getDCAAttachedConfigToDevice", "requestBody": { "description": "Query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query string": { "description": "Query string", "value": { "tenantId": [ "57501bad-32a7-4f52-8f54-8547dcd7403e", "07917db1-bb13-40a0-a075-f81e91cd3bd4" ] } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Attached config to device": { "description": "Attached config to device", "value": [ { "deviceConfiguration": "viptela-system:system\nhost-name vm200\nsystem-ip 172.16.255.200\nsite-id 200\nadmin-tech-on-failure\nno vrrp-advt-with-phymac\nsp-organization-name \"MY ORG\"\norganization-name \"MY ORG\"\nvbond vbond\naaa\n auth-order local radius tacacs\n usergroup all\n !\n usergroup basic\n task system read\n task interface read\n !\n usergroup global\n !\n usergroup netadmin\n !\n usergroup network_operations\n task policy read write\n !\n usergroup operator\n task system read\n task interface read\n task policy read\n task routing read\n task security read\n !\n usergroup security_operations\n task security read write\n !\n usergroup tenantadmin\n !\n user admin\n password $6$681c9c8f17cc6e08$xFwi15faKVz/0.v5C1eeztUMus0iTwyLF.artuRBYD1cc7vTMsNomIVkqdmOcR4fmAGCZFAb6ACtir4oRkE6O0\n !\n ciscotacro-user true\n ciscotacrw-user true\n!\nlogging\n disk\n enable\n !\n!\nssh-server\n cipher aes-128-192\n kex-algo sha1\n!\nntp\n parent\n no enable\n stratum 5\n exit\n!\n!\nsnmp\nno shutdown\nview v2\n oid 1.3.6.1\n!\ncommunity $8$5EAF66F834F9B7194399D513C741AB2A\n view v2\n authorization read-only\n!\ntrap target vpn 0 10.0.1.1 16662\n group-name test\n community-name $8$5EAF66F834F9B7194399D513C741AB2A\n!\ntrap group test\n all\n level critical major minor\n exit\nexit\n!\nvpn 0\ndns 10.0.99.1 secondary\ndns 171.70.168.183 primary\nhost api.cisco.com ip 72.163.8.72\nhost certmanager-webservices.websecurity.digicert.com ip 216.168.246.82\nhost certmanager-webservices.websecurity.symantec.com ip 216.168.246.82\nhost proxy.esl.cisco.com ip 173.36.224.108\nhost vbond ip 10.103.128.128 10.103.135.135\nhost viptela.testbed ip 10.0.1.1\ninterface eth0\n ip address 10.0.1.200/24\n ipv6 dhcp-client\n no shutdown\n!\ninterface eth1\n ip address 10.103.200.200/16\n tunnel-interface\n allow-service all\n allow-service dhcp\n allow-service dns\n allow-service icmp\n no allow-service sshd\n no allow-service netconf\n no allow-service ntp\n no allow-service stun\n allow-service https\n !\n no shutdown\n!\ninterface eth2\n ip address 10.0.100.200/24\n no shutdown\n!\ninterface eth3\n ip address 10.104.1.200/24\n no shutdown\n!\ninterface eth4\n ip address 10.105.0.200/24\n no shutdown\n!\nip route 0.0.0.0/0 10.0.12.13\nip route 0.0.0.0/0 10.103.254.254\nip route 46.4.105.116/32 10.0.1.1\nip route 171.70.168.0/24 10.0.1.1\nip route 173.36.224.108/32 10.0.1.1\n!\nvpn 512\n!", "deviceIP": "169.254.10.1", "tenantId": "57501bad-32a7-4f52-8f54-8547dcd7403e" }, { "deviceConfiguration": "viptela-system:system\nsystem-ip 172.16.254.5\ndomain-id 1\nsite-id 6\nadmin-tech-on-failure\nsp-organization-name \"MY ORG\"\norganization-name \"MY ORG-Apple Inc\"\nvbond vbond\n!\nmemory free low-watermark processor 166245\nservice timestamps debug datetime msec\nservice timestamps log datetime msec\nno service tcp-small-servers\nno service udp-small-servers\nplatform console serial\nplatform qfp utilization monitor load 80\nplatform sslvpn use-pd\nhostname vm6\nusername admin privilege 15 secret 9 $9$pPlT8B.3SExgjE$aA9M6arkumX.SK6odu9soQK05qqbXNIeRfBJ7X5vV8Q\nvrf definition 1\nrd 1:1\naddress-family ipv4\n exit-address-family\n!\naddress-family ipv6\n exit-address-family\n!\n!\nvrf definition 11\nrd 11:11\naddress-family ipv4\n exit-address-family\n!\naddress-family ipv6\n exit-address-family\n!\n!\nvrf definition 20\nrd 20:20\naddress-family ipv4\n exit-address-family\n!\naddress-family ipv6\n exit-address-family\n!\n!\nvrf definition Mgmt-intf\nrd 1:512\naddress-family ipv4\n exit-address-family\n!\naddress-family ipv6\n exit-address-family\n!\n!\nno ip finger\nno ip rcmd rcp-enable\nno ip rcmd rsh-enable\nip host vbond 10.103.128.128 10.103.135.135\nip route 0.0.0.0 0.0.0.0 10.101.254.254\nip route 0.0.0.0 0.0.0.0 10.102.254.254\nip scp server enable\nip ssh pubkey-chain\nusername admin\n key-hash ssh-rsa 5cc0b10027d65dd46667acf4464f49f5 vtest@enrtp-vtest-280\n !\n!\n!\nno ip ssh bulk-mode\nip tcp RST-count 10 RST-window 5000\nip http server\nip http secure-server\nip nat settings central-policy\nip nat settings gatekeeper-size 1024\nipv6 unicast-routing\nipv6 rip vrf-mode enable\ninterface GigabitEthernet1\nno shutdown\nvrf forwarding Mgmt-intf\nip address 10.0.1.6 255.255.255.0\nnegotiation auto\nexit\ninterface GigabitEthernet2\nno shutdown\nvrf forwarding 1\nip address 10.0.6.6 255.255.255.0\nnegotiation auto\nexit\ninterface GigabitEthernet3\nno shutdown\nip address 10.101.6.6 255.255.0.0\nnegotiation auto\nexit\ninterface GigabitEthernet4\nno shutdown\nip address 10.0.100.6 255.255.255.0\nnegotiation auto\nexit\ninterface GigabitEthernet5\nno shutdown\nip address 10.102.6.6 255.255.0.0\nnegotiation auto\nexit\ninterface GigabitEthernet6\nno shutdown\nvrf forwarding 20\nip address 10.0.32.6 255.255.255.0\nnegotiation auto\nexit\ninterface GigabitEthernet7\nno shutdown\nvrf forwarding 11\nip address 10.0.33.6 255.255.255.0\nnegotiation auto\nexit\ninterface Tunnel1\nno shutdown\nip unnumbered GigabitEthernet3\ntunnel source GigabitEthernet3\ntunnel mode sdwan\nexit\ninterface Tunnel2\nno shutdown\nip unnumbered GigabitEthernet5\ntunnel source GigabitEthernet5\ntunnel mode sdwan\nexit\ncontrol-plane\n!\nno logging console\nno logging trap\nno logging queue-limit\naaa authentication login default local\naaa authorization console\naaa authorization exec default local\nlogin on-success log\nredundancy\n!\nvtp mode server\nradius-server cache expiry 24\nno crypto ikev2 diagnose error\nsnmp-server community private view v2 ro\nsnmp-server host 10.0.100.1 version 2c private udp-port 16662\nsnmp-server view v2 1.3.6.1 included\nfhrp version vrrp v3\nline aux 0\n!\nline con 0\nstopbits 1\n!\nline vty 0 4\ntransport input ssh\n!\nline vty 5 80\ntransport input none\n!\nno process cpu extended history\nsdwan\ninterface GigabitEthernet2\nexit\ninterface GigabitEthernet3\n tunnel-interface\n encapsulation ipsec\n color 3g\n no allow-service bgp\n allow-service dhcp\n allow-service dns\n allow-service icmp\n no allow-service sshd\n no allow-service netconf\n no allow-service ntp\n no allow-service ospf\n no allow-service stun\n allow-service https\n no allow-service snmp\n no allow-service bfd\n exit\nexit\ninterface GigabitEthernet4\nexit\ninterface GigabitEthernet5\n tunnel-interface\n encapsulation ipsec\n color lte\n no allow-service bgp\n allow-service dhcp\n allow-service dns\n allow-service icmp\n no allow-service sshd\n no allow-service netconf\n no allow-service ntp\n no allow-service ospf\n no allow-service stun\n allow-service https\n no allow-service snmp\n no allow-service bfd\n exit\nexit\ninterface GigabitEthernet6\nexit\ninterface GigabitEthernet7\nexit\nappqoe\n no tcpopt enable\n no dreopt enable\n no httpopt enable\n!\nomp\n no shutdown\n graceful-restart\n no as-dot-notation\n timers\n graceful-restart-timer 120\n exit\n address-family ipv4\n advertise connected\n advertise static\n !\n address-family ipv6\n advertise connected\n advertise static\n !\n!\n!\nsslproxy\nno enable\nrsa-key-modulus 2048\ncertificate-lifetime 730\neckey-type P256\nca-tp-label PROXY-SIGNING-CA\nsettings expired-certificate drop\nsettings untrusted-certificate drop\nsettings unknown-status drop\nsettings certificate-revocation-check none\nsettings unsupported-protocol-versions drop\nsettings unsupported-cipher-suites drop\nsettings failure-mode close\nsettings minimum-tls-ver TLSv1\ndual-side optimization enable\n!", "deviceIP": "169.254.10.13", "tenantId": "07917db1-bb13-40a0-a075-f81e91cd3bd4" } ], "$$ref": "#/components/examples/ComViptelaVmanageServerDcaResponseExampleAttachedConfig" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true } }, "/dca/template/policy/definition/approute": { "post": { "tags": [ "Data Collection Agent" ], "description": "Get template policy definitions", "operationId": "getTemplatePolicyDefinitionsDCA", "requestBody": { "description": "Query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query string": { "description": "Query string", "value": { "tenantId": [ "07917db1-bb13-40a0-a075-f81e91cd3bd4" ] } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "Template policy definition": { "description": "Template policy definition", "value": { "header": { "generatedOn": 1717667065133, "viewKeys": { "uniqueKey": [], "preferenceKey": "grid-PolicyDefinition" }, "columns": [ { "title": "Name", "property": "name", "hideable": false, "dataType": "string" }, { "title": "Type", "property": "type", "display": "keyvalue", "keyvalueProperty": "type", "hideable": false, "keyvalue": [ { "key": "data", "value": "Data" }, { "key": "appRoute", "value": "App Route" }, { "key": "control", "value": "Custom Control" }, { "key": "cflowd", "value": "Cflowd" }, { "key": "mesh", "value": "Mesh" }, { "key": "hubAndSpoke", "value": "Hub and Spoke" }, { "key": "vpnMembershipGroup", "value": "VPN Membership" }, { "key": "qosMap", "value": "QoS Map" }, { "key": "vpnQosMap", "value": "VPN QoS Map" }, { "key": "rewriteRule", "value": "Rewrite Rule" }, { "key": "acl", "value": "Access Control List(IPv4)" }, { "key": "aclv6", "value": "Access Control List(IPv6)" }, { "key": "deviceAccessPolicy", "value": "Device Access Control List(IPv4)" }, { "key": "deviceAccessPolicyv6", "value": "Device Access Control List(IPv6)" }, { "key": "vedgeRoute", "value": "Route" }, { "key": "zoneBasedFW", "value": "Zone Based" }, { "key": "fxoPort", "value": "FXO" }, { "key": "fxsPort", "value": "FXS" }, { "key": "fxsDidPort", "value": "FXS DID" }, { "key": "dialPeer", "value": "Dial Peer" }, { "key": "srstPhoneProfile", "value": "SRST Phone" }, { "key": "priIsdnPort", "value": "PRI ISDN" } ], "dataType": "string" }, { "title": "Description", "property": "description", "dataType": "string" }, { "title": "Mode", "property": "mode", "dataType": "string" }, { "title": "Reference Count", "property": "referenceCount", "hideable": true, "dataType": "string" }, { "title": "Updated By", "property": "owner", "dataType": "string" }, { "title": "Last Updated", "property": "lastUpdated", "displayFormat": "DD MMM YYYY h:mm:ss A z", "inputFormat": "unix-time", "dataType": "date" } ], "fields": [ { "property": "name", "dataType": "string" }, { "property": "type", "dataType": "string", "display": "keyvalue" }, { "property": "description", "dataType": "string" }, { "property": "mode", "dataType": "string" }, { "property": "id", "dataType": "string" }, { "property": "defaultAction", "dataType": "object" }, { "property": "sequences", "dataType": "array" }, { "property": "referenceCount", "dataType": "string" }, { "property": "owner", "dataType": "string" }, { "property": "lastUpdated", "dataType": "date" } ] }, "data": [ { "name": "my_aar_policy", "definitionId": "3e3edb25-5002-4b3c-b889-33c70e60da87", "type": "appRoute", "description": "my_aar_policy", "owner": "admin", "lastUpdated": 1717666867890, "infoTag": "", "mode": "", "optimized": "false", "referenceCount": 0, "references": [] } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerDcaResponseExamplePolicyDefApproute" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true } }, "/dca/template/policy/list/vpn": { "post": { "tags": [ "Data Collection Agent" ], "description": "Get VPN details", "operationId": "getVPNListsDCA", "requestBody": { "description": "Query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query string": { "description": "Query string", "value": { "tenantId": [ "07917db1-bb13-40a0-a075-f81e91cd3bd4" ] } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "VPN": { "description": "VPN", "value": { "header": { "generatedOn": 1717496151334, "viewKeys": { "uniqueKey": [], "preferenceKey": "grid-PolicyList" }, "columns": [ { "title": "Name", "property": "name", "hideable": false, "dataType": "string" }, { "title": "Entries", "property": "entries", "hideable": true, "dataType": "array" }, { "title": "Internet Protocal", "property": "type", "hideable": true, "dataType": "string" }, { "title": "Reference Count", "property": "referenceCount", "hideable": true, "dataType": "string" }, { "title": "Updated By", "property": "owner", "dataType": "string" }, { "title": "Last Updated", "property": "lastUpdated", "displayFormat": "DD MMM YYYY h:mm:ss A z", "inputFormat": "unix-time", "dataType": "date" } ], "fields": [ { "property": "name", "dataType": "string" }, { "property": "type", "dataType": "string" }, { "property": "description", "dataType": "string" }, { "property": "listId", "dataType": "string" }, { "property": "entries", "dataType": "array" }, { "property": "type", "dataType": "string" }, { "property": "referenceCount", "dataType": "string" }, { "property": "owner", "dataType": "string" }, { "property": "lastUpdated", "dataType": "date" } ] }, "data": [ { "listId": "37d48573-ca30-450a-8ec2-8fc7852477a0", "name": "VPN_100", "type": "vpn", "description": "Desc Not Required", "entries": [ { "vpn": "100" } ], "lastUpdated": 1717495776426, "owner": "tenantadmin", "readOnly": false, "version": "0", "infoTag": "", "referenceCount": 0, "references": [] } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerDcaResponseExamplePolicyVpnList" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true } }, "/dca/template/policy/vedge": { "post": { "tags": [ "Data Collection Agent" ], "description": "Get vEdge template list", "operationId": "getVedgeTemplateListDCA", "requestBody": { "description": "Query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query string": { "description": "Query string", "value": { "tenantId": [ "07917db1-bb13-40a0-a075-f81e91cd3bd4" ] } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "vEdge template": { "description": "vEdge template", "value": { "header": { "generatedOn": 1717667785825, "viewKeys": { "uniqueKey": [], "preferenceKey": "grid-VEdgePolicy" }, "columns": [ { "title": "Name", "property": "policyName", "hideable": false, "dataType": "string" }, { "title": "Description", "property": "policyDescription", "dataType": "string" }, { "title": "Devices Attached", "property": "devicesAttached", "hideable": false, "dataType": "number" }, { "title": "Device Templates", "property": "mastersAttached", "hideable": false, "dataType": "number" }, { "title": "Updated By", "property": "lastUpdatedBy", "dataType": "string" }, { "title": "Last Updated", "property": "lastUpdatedOn", "displayFormat": "DD MMM YYYY h:mm:ss A z", "inputFormat": "unix-time", "dataType": "date" } ], "fields": [ { "property": "policyName", "dataType": "string" }, { "property": "policyDescription", "dataType": "string" }, { "property": "devicesAttached", "dataType": "number" }, { "property": "mastersAttached", "dataType": "number" }, { "property": "lastUpdatedBy", "dataType": "string" }, { "property": "lastUpdatedOn", "dataType": "date" } ] }, "data": [ { "mastersAttached": 0, "lastUpdatedBy": "tenantadmin", "policyName": "Reject_99_101", "policyDefinitionEdit": "{\"assembly\":[{\"definitionId\":\"a325fc61-c9c1-467d-92d4-6c5caa217685\",\"type\":\"vedgeRoute\"}],\"settings\":{}}", "policyDefinition": "{\"assembly\":[{\"definitionId\":\"a325fc61-c9c1-467d-92d4-6c5caa217685\",\"type\":\"vedgeRoute\"}],\"settings\":{}}", "createdOn": 1717495890136, "policyDescription": "Reject_99_101", "@rid": 11804, "policyId": "2266c613-b2f3-4028-bcbc-0a95311bc787", "createdBy": "tenantadmin", "devicesAttached": 0, "policyType": "feature", "tenantId": "07917db1-bb13-40a0-a075-f81e91cd3bd4", "lastUpdatedOn": 1717495890136 }, { "mastersAttached": 0, "lastUpdatedBy": "tenantadmin", "policyName": "policy_99_100", "policyDefinitionEdit": "{\"assembly\":[{\"definitionId\":\"6b192cd9-9ebd-4dec-9555-5d7cba993739\",\"type\":\"deviceaccesspolicy\"},{\"definitionId\":\"8923d524-ced5-4ab3-9967-6abbe46fb372\",\"type\":\"vedgeRoute\"}],\"settings\":{\"appVisibility\":true,\"logFrequency\":100}}", "policyDefinition": "{\"assembly\":[{\"definitionId\":\"6b192cd9-9ebd-4dec-9555-5d7cba993739\",\"type\":\"deviceaccesspolicy\"},{\"definitionId\":\"8923d524-ced5-4ab3-9967-6abbe46fb372\",\"type\":\"vedgeRoute\"}],\"settings\":{\"appVisibility\":true,\"logFrequency\":100}}", "createdOn": 1717568343247, "policyDescription": "policy_99_100", "@rid": 11838, "policyId": "9ac90533-a873-404c-a735-ebe8e7719b3a", "createdBy": "tenantadmin", "devicesAttached": 0, "policyType": "feature", "tenantId": "07917db1-bb13-40a0-a075-f81e91cd3bd4", "lastUpdatedOn": 1717568343247 } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerDcaResponseExampleVedgePolicy" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true } }, "/dca/template/policy/vsmart": { "post": { "tags": [ "Data Collection Agent" ], "description": "Get vSmart template list", "operationId": "getVsmartTemplateListDCA", "requestBody": { "description": "Query string", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Query string": { "description": "Query string", "value": { "tenantId": [ "07917db1-bb13-40a0-a075-f81e91cd3bd4" ] } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "vSmart template": { "description": "vSmart template", "value": { "header": { "generatedOn": 1717495213603, "viewKeys": { "uniqueKey": [], "preferenceKey": "grid-VSmartPolicy" }, "columns": [ { "title": "Name", "property": "policyName", "hideable": false, "dataType": "string" }, { "title": "Description", "property": "policyDescription", "dataType": "string" }, { "title": "Type", "property": "policyType", "display": "keyvalue", "keyvalueProperty": "policyType", "hideable": false, "keyvalue": [ { "key": "cli", "value": "CLI" }, { "key": "feature", "value": "UI Policy Builder" } ], "dataType": "string" }, { "title": "Activated", "property": "isPolicyActivated", "display": "iconAndText", "iconProperty": "isPolicyActivated", "hideable": false, "icon": [ { "key": "true", "value": "images/policy_active.png" }, { "key": "false", "value": "images/policy_inactive.png" } ], "dataType": "string" }, { "title": "Updated By", "property": "lastUpdatedBy", "dataType": "string" }, { "title": "Policy Version", "property": "policyVersion", "dataType": "string" }, { "title": "Last Updated", "property": "lastUpdatedOn", "displayFormat": "DD MMM YYYY h:mm:ss A z", "inputFormat": "unix-time", "dataType": "date" } ], "fields": [ { "property": "policyName", "dataType": "string" }, { "property": "policyDescription", "dataType": "string" }, { "property": "policyType", "dataType": "string", "display": "keyvalue" }, { "property": "isPolicyActivated", "dataType": "string", "display": "iconAndText" }, { "property": "lastUpdatedBy", "dataType": "string" }, { "property": "policyVersion", "dataType": "string" }, { "property": "lastUpdatedOn", "dataType": "date" } ] }, "data": [ { "policyVersion": "06042024T095611718", "lastUpdatedBy": "tenantadmin", "policyCli": "viptela-policy:policy\n control-policy Test\n default-action accept\n !\n lists\n site-list Test\n site-id 100 \n !\n !\n!\napply-policy\n site-list Test\n control-policy Test in\n control-policy Test out\n !\n!", "policyName": "Test", "policyXml": "\n\n DCA AUT VMANAGE-Apple Inc\n3cc401fa-aac4-490d-ae58-0e48be929633\nvsmart_policy_config-6bb37b09-b16b-41b0-aacf-06464f7c81d8\n \n \n \n Test\n \n 100\n \n \n \n \n Test\n accept\n \n \n \n \n Test\n \n in\n Test\n \n \n out\n Test\n \n \n \n\n", "policyDefinition": "{\"assembly\":[{\"definitionId\":\"b2fa4139-9c37-4fdf-abd1-0a6c6f9725c9\",\"type\":\"control\",\"entries\":[{\"direction\":\"in\",\"siteLists\":[\"7b66f7a5-4f56-4e24-8034-992296f67d92\"]},{\"direction\":\"out\",\"siteLists\":[\"7b66f7a5-4f56-4e24-8034-992296f67d92\"]}]}],\"regionRoleAssembly\":[]}", "createdOn": 1717494971718, "policyXmlVersion": "vsmart_policy_config-6bb37b09-b16b-41b0-aacf-06464f7c81d8", "isPolicyActivated": true, "policyDescription": "Test", "@rid": 11062, "policyId": "3cc401fa-aac4-490d-ae58-0e48be929633", "createdBy": "tenantadmin", "policyType": "feature", "tenantId": "07917db1-bb13-40a0-a075-f81e91cd3bd4", "lastUpdatedOn": 1717494971718 } ] }, "$$ref": "#/components/examples/ComViptelaVmanageServerDcaResponseExampleVsmartPolicy" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true } }, "/entityownership/list": { "get": { "tags": [ "System - Cloud Service" ], "summary": "List all entity ownership info", "description": "List all entity ownership info", "operationId": "listEntityOwnershipInfo", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "bucket": { "type": "string" }, "entityName": { "type": "string" }, "owner": { "type": "string" } }, "$$ref": "#/components/schemas/EntityOwnershipInfo" }, "examples": { "Entity Ownership List Response": { "description": "Entity Ownership List Response", "value": [ { "entityName": "all", "bucket": "bucket1", "owner": "e730d2b0-20ab-4875-81ac-4994e1386f9e" }, { "entityName": "singleton-service-selector", "bucket": "bucket1", "owner": "e730d2b0-20ab-4875-81ac-4994e1386f9e" }, { "entityName": "singleton-service-client", "bucket": "bucket1", "owner": "e730d2b0-20ab-4875-81ac-4994e1386f9e" }, { "entityName": "tenantCreator", "bucket": "bucket1", "owner": "e730d2b0-20ab-4875-81ac-4994e1386f9e" }, { "entityName": "notificationService", "bucket": "bucket1", "owner": "e730d2b0-20ab-4875-81ac-4994e1386f9e" } ], "$$ref": "#/components/examples/ComViptelaVmanageServerEntityownershipResponseExampleEntityOwnershipList" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/entityownership/tree": { "get": { "tags": [ "System - Cloud Service" ], "description": "Entity ownership info grouped by buckets", "operationId": "entityOwnershipInfo", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Entity ownership": { "description": "Entity ownership", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/accounts/edge": { "post": { "tags": [ "Configuration - Multi Cloud" ], "description": "Authenticate edge account credentials", "operationId": "validateEdgeAccountAdd", "requestBody": { "description": "Multicloud edge account info", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Edge Account info": { "description": "Edge Account info" } } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true }, "get": { "tags": [ "Configuration - Multi Cloud" ], "description": "Get all Multicloud edge accounts", "operationId": "getEdgeAccounts", "parameters": [ { "name": "edgeType", "in": "query", "description": "Edge type", "schema": { "type": "string", "enum": [ "MEGAPORT" ] } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Edge accounts": { "description": "Edge accounts" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true } }, "/multicloud/accounts/edge/{accountId}": { "get": { "tags": [ "Configuration - Multi Cloud" ], "description": "Get edge account by account Id", "operationId": "getEdgeAccountDetails", "parameters": [ { "name": "accountId", "in": "path", "description": "Edge Account Id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Cloud account": { "description": "Cloud account" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true }, "put": { "tags": [ "Configuration - Multi Cloud" ], "description": "Update Multicloud edge account", "operationId": "updateEdgeAccount", "parameters": [ { "name": "accountId", "in": "path", "description": "Multicloud Edge Account Id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Multicloud edge account info", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Account info": { "description": "Account info" } } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true }, "delete": { "tags": [ "Configuration - Multi Cloud" ], "description": "Delete edge account", "operationId": "deleteEdgeAccount", "parameters": [ { "name": "accountId", "in": "path", "description": "Edge Account Id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true } }, "/multicloud/accounts/edge/{accountId}/credentials": { "put": { "tags": [ "Configuration - Multi Cloud" ], "description": "Update Multicloud edge account credential", "operationId": "validateEdgeAccountUpdateCredentials", "parameters": [ { "name": "accountId", "in": "path", "description": "Multicloud Edge Account Id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Multicloud edge account info", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Account info": { "description": "Account info" } } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true } }, "/multicloud/billingaccounts/edge/{edgeType}/{edgeAccountId}": { "get": { "tags": [ "Configuration - Multi Cloud" ], "description": "Get Edge Billing Accounts", "operationId": "getEdgeBillingAccounts", "parameters": [ { "name": "edgeType", "in": "path", "description": "Interconnect Provider", "required": true, "schema": { "type": "string", "enum": [ "EQUINIX" ] } }, { "name": "edgeAccountId", "in": "path", "description": "Interconnect Provider Account ID", "required": true, "schema": { "type": "string" } }, { "name": "region", "in": "query", "description": "Region", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Edge Billing Accounts": { "description": "Edge Billing Accounts", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true } }, "/multicloud/cloudRoutersAndAttachments": { "get": { "tags": [ "Configuration - Multi Cloud" ], "description": "Get all Cloud Routers and their Attachments", "operationId": "getCloudRoutersAndAttachments", "parameters": [ { "name": "accountId", "in": "query", "description": "Account Id", "schema": { "type": "string" } }, { "name": "region", "in": "query", "description": "Region", "schema": { "type": "string" } }, { "name": "network", "in": "query", "description": "Network", "schema": { "type": "string" } }, { "name": "connectivityGatewayName", "in": "query", "description": "Connectivity Gateway Name", "schema": { "type": "string" } }, { "name": "cloudGatewayName", "in": "query", "description": "Cloud Gateway Name", "schema": { "type": "string" } }, { "name": "state", "in": "query", "description": "State", "schema": { "type": "string" } }, { "name": "refresh", "in": "query", "description": "Refresh", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Cloud Router": { "description": "Cloud Router", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true } }, "/multicloud/connected-sites/edge/{edgeType}": { "get": { "tags": [ "Configuration - Multi Cloud" ], "description": "Get sites with connectivity to the interconnect gateways by edge type", "operationId": "getCloudConnectedSites_ConfigurationMultiCloud_4303", "parameters": [ { "name": "edgeType", "in": "path", "description": "Edge type", "required": true, "schema": { "type": "string" } }, { "name": "edgeGatewayName", "in": "query", "description": "Interconnect Gateway Name", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Interconnect connected sites": { "description": "Interconnect connected sites", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true, "x-roles-required": "Cloud OnRamp-read" } }, "/multicloud/connectivity/edge": { "get": { "tags": [ "Configuration - Multi Cloud" ], "description": "Get Interconnect Connectivity details", "operationId": "getEdgeConnectivityDetails", "parameters": [ { "name": "edgeType", "in": "query", "description": "Edge type", "schema": { "type": "string", "enum": [ "MEGAPORT", "EQUINIX" ] } }, { "name": "connectivityName", "in": "query", "description": "Connectivity Name", "schema": { "type": "string" } }, { "name": "connectivityType", "in": "query", "description": "Connectivity Type", "schema": { "type": "string" } }, { "name": "edgeGatewayName", "in": "query", "description": "Interconnect Gateway name", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "IC-GW Connectivity": { "description": "IC-GW Connectivity", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true }, "put": { "tags": [ "Configuration - Multi Cloud" ], "description": "Update Interconnect connectivity", "operationId": "updateEdgeConnectivity", "requestBody": { "description": "Edge connectivity", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Edge connectivity": { "description": "Edge connectivity" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Task Id": { "description": "Task Id", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true }, "post": { "tags": [ "Configuration - Multi Cloud" ], "description": "Create Interconnect connectivity", "operationId": "createEdgeConnectivity", "requestBody": { "description": "Edge connectivity", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Edge connectivity": { "description": "Edge connectivity" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Task Id": { "description": "Task Id", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true } }, "/multicloud/connectivity/edge/{connectionName}": { "delete": { "tags": [ "Configuration - Multi Cloud" ], "description": "Delete Interconnect connectivity", "operationId": "deleteEdgeConnectivity", "parameters": [ { "name": "connectionName", "in": "path", "description": "Edge connectivity name", "required": true, "schema": { "type": "string" } }, { "name": "deleteCloudResources", "in": "query", "description": "Delete Cloud Resources", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Task Id": { "description": "Task Id", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true }, "get": { "tags": [ "Configuration - Multi Cloud" ], "description": "Get Interconnect Connectivity by name", "operationId": "getEdgeConnectivityDetailByName", "parameters": [ { "name": "connectionName", "in": "path", "description": "IC-GW connectivity name", "required": true, "schema": { "type": "string", "example": "interconnect" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "IC-GW Connectivity Name": { "description": "IC-GW Connectivity Name", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true } }, "/multicloud/connectivitygateway": { "post": { "tags": [ "Configuration - Multi Cloud" ], "description": "Create Connectivity gateway", "operationId": "createConnectivityGateway", "requestBody": { "description": "Connectivity gateway", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Connectivity gateway": { "description": "Connectivity gateway" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Task Id": { "description": "Task Id", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true }, "get": { "tags": [ "Configuration - Multi Cloud" ], "description": "Get all Connectivity Gateways", "operationId": "getConnectivityGateways", "parameters": [ { "name": "accountId", "in": "query", "description": "Account Id", "schema": { "type": "string" } }, { "name": "cloudType", "in": "query", "description": "Cloud Type", "schema": { "type": "string" } }, { "name": "connectivityType", "in": "query", "description": "Cloud Connectivity Type", "schema": { "type": "string" } }, { "name": "connectivityGatewayName", "in": "query", "description": "Connectivity Gateway Name", "schema": { "type": "string" } }, { "name": "region", "in": "query", "description": "Region", "schema": { "type": "string" } }, { "name": "network", "in": "query", "description": "Network", "schema": { "type": "string" } }, { "name": "state", "in": "query", "description": "State", "schema": { "type": "string" } }, { "name": "refresh", "in": "query", "description": "Refresh", "schema": { "type": "string" } }, { "name": "edgeType", "in": "query", "description": "Edge type", "schema": { "type": "string", "enum": [ "MEGAPORT", "EQUINIX" ] } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Edge gateways": { "description": "Edge gateways", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true }, "delete": { "tags": [ "Configuration - Multi Cloud" ], "description": "Delete all Connectivity Gateways in local DB", "operationId": "cleanUpAllConnectivityGatewaysInLocalDB", "parameters": [ { "name": "deletionType", "in": "query", "description": "Deletion Type", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Task Id": { "description": "Task Id", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true } }, "/multicloud/connectivitygateway/{cloudProvider}/{connectivityGatewayName}": { "delete": { "tags": [ "Configuration - Multi Cloud" ], "description": "Delete Connectivity Gateway", "operationId": "deleteConnectivityGateway", "parameters": [ { "name": "cloudProvider", "in": "path", "description": "Cloud Provider", "required": true, "schema": { "type": "string" } }, { "name": "connectivityGatewayName", "in": "path", "description": "Connectivity gateway name", "required": true, "schema": { "type": "string" } }, { "name": "connectivityType", "in": "query", "description": "Cloud Connectivity Type", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Task Id": { "description": "Task Id", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true } }, "/multicloud/connectivitygatewaycreationoptions": { "get": { "tags": [ "Configuration - Multi Cloud" ], "description": "Get connectivity gateway creation options", "operationId": "getConnectivityGatewayCreationOptions", "parameters": [ { "name": "accountId", "in": "query", "description": "Account Id", "schema": { "type": "string" } }, { "name": "cloudType", "in": "query", "description": "Cloud Type", "schema": { "type": "string" } }, { "name": "connectivityType", "in": "query", "description": "Cloud Connectivity Type", "schema": { "type": "string" } }, { "name": "refresh", "in": "query", "description": "Refresh", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Connectivity Gateway Creation options": { "description": "Connectivity Gateway Creation options", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true } }, "/multicloud/dashboard/edge": { "get": { "tags": [ "Configuration - Multi Cloud" ], "description": "Get interconnect edge gateway dashboard info", "operationId": "getDashboardEdgeInfo", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Dashboard edge info": { "description": "Dashboard edge info" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true } }, "/multicloud/devicelink/edge": { "put": { "tags": [ "Configuration - Multi Cloud" ], "description": "Update Device Link", "operationId": "updateDeviceLink", "requestBody": { "description": "Device Link", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Device Link": { "description": "Device Link" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Task Id": { "description": "Task Id", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true }, "get": { "tags": [ "Configuration - Multi Cloud" ], "description": "Get Device Links", "operationId": "getDeviceLinks", "parameters": [ { "name": "edgeType", "in": "query", "description": "Edge type", "schema": { "type": "string", "enum": [ "MEGAPORT", "EQUINIX" ] } }, { "name": "deviceLinkName", "in": "query", "description": "Device Link Name", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Device Links": { "description": "Device Links", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true }, "post": { "tags": [ "Configuration - Multi Cloud" ], "description": "Create Device Link", "operationId": "createDeviceLink", "requestBody": { "description": "Device Link", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Device Link": { "description": "Device Link" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Task Id": { "description": "Task Id", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true } }, "/multicloud/devicelink/edge/portspeed/{edgeType}": { "get": { "tags": [ "Configuration - Multi Cloud" ], "description": "Get supported port speed for Device Link", "operationId": "getDlPortSpeed", "parameters": [ { "name": "edgeType", "in": "path", "description": "Interconnect Provider", "required": true, "schema": { "type": "string", "enum": [ "MEGAPORT", "EQUINIX" ] } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "port-speed": { "description": "port-speed", "value": "{100, 200}" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true } }, "/multicloud/devicelink/edge/{deviceLinkName}": { "delete": { "tags": [ "Configuration - Multi Cloud" ], "description": "Delete Device Link", "operationId": "deleteDeviceLink", "parameters": [ { "name": "deviceLinkName", "in": "path", "description": "Device Link Name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Task Id": { "description": "Task Id", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true } }, "/multicloud/devicelink/metroSpeed/edge": { "post": { "tags": [ "Configuration - Multi Cloud" ], "description": "Get Device Link Metro Speed based on device link config", "operationId": "getDeviceLinkMetroSpeed", "requestBody": { "description": "Device Link", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Device Link": { "description": "Device Link", "value": { "edgeType": "EQUINIX", "edgeAccountId": "cisco_dev", "deviceLinkName": "test", "bandwidth": "50", "deviceList": [ { "deviceName": "test-dev-0" }, { "deviceName": "test-dev-1" } ] } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "dlMetroBandwidth": { "description": "dlMetroBandwidth", "value": 1000 } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true } }, "/multicloud/devices/edge/{edgeType}": { "get": { "tags": [ "Configuration - Multi Cloud" ], "description": "Get cloud devices by cloud type", "operationId": "getCloudDevices_ConfigurationMultiCloud_3503", "parameters": [ { "name": "edgeType", "in": "path", "description": "Edge type", "required": true, "schema": { "type": "string" } }, { "name": "edgeGatewayName", "in": "query", "description": "Edge Gateway Name", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Cloud devices": { "description": "Cloud devices", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true, "x-roles-required": "Cloud OnRamp-read" } }, "/multicloud/edge/{edgeType}/device": { "get": { "tags": [ "Configuration - Multi Cloud" ], "description": "Get available WAN edge devices", "operationId": "getEdgeWanDevices", "parameters": [ { "name": "edgeType", "in": "path", "description": "Edge Type", "required": true, "schema": { "type": "string", "enum": [ "MEGAPORT", "EQUINIX" ], "default": "MEGAPORT" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Edge devices": { "description": "Edge devices" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true, "x-roles-required": "Cloud OnRamp-read" } }, "/multicloud/gateway/edge": { "get": { "tags": [ "Configuration - Multi Cloud" ], "description": "Get Interconnect Gateways", "operationId": "getIcgws", "parameters": [ { "name": "edgeType", "in": "query", "description": "Edge type", "schema": { "type": "string", "enum": [ "MEGAPORT", "EQUINIX" ] } }, { "name": "accountId", "in": "query", "description": "Account Id", "schema": { "type": "string" } }, { "name": "region", "in": "query", "description": "Region", "schema": { "type": "string" } }, { "name": "regionId", "in": "query", "description": "Region Id", "schema": { "type": "string" } }, { "name": "resourceState", "in": "query", "description": "Resource State", "schema": { "type": "string" } }, { "name": "edgeGatewayName", "in": "query", "description": "Edge gateway name", "schema": { "type": "string" } }, { "name": "billingAccountId", "in": "query", "description": "billing Account Id", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Interconnect Gateways": { "description": "Interconnect Gateways", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true }, "post": { "tags": [ "Configuration - Multi Cloud" ], "description": "Create Interconnect Gateway", "operationId": "createIcgw", "requestBody": { "description": "Interconnect Gateway", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Interconnect Gateway": { "description": "Interconnect Gateway" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Task Id": { "description": "Task Id", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true } }, "/multicloud/gateway/edge/setting/{edgeGatewayName}": { "get": { "tags": [ "Configuration - Multi Cloud" ], "description": "Get Interconnect Gateway custom setting by Interconnect Gateway name", "operationId": "getIcgwCustomSettingDetails", "parameters": [ { "name": "edgeGatewayName", "in": "path", "description": "Edge gateway name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Interconnect Gateway custom setting": { "description": "Interconnect Gateway custom setting", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true } }, "/multicloud/gateway/edge/types": { "get": { "tags": [ "Configuration - Multi Cloud" ], "description": "Get Interconnect Gateway type for specified Edge Provider", "operationId": "getIcgwTypes", "parameters": [ { "name": "edgeType", "in": "query", "description": "Edge type", "schema": { "type": "string", "enum": [ "MEGAPORT", "EQUINIX" ] } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Interconnect Gateway type": { "description": "Interconnect Gateway type", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true } }, "/multicloud/gateway/edge/{edgeGatewayName}": { "get": { "tags": [ "Configuration - Multi Cloud" ], "description": "Get Interconnect Gateway by name", "operationId": "getIcgwDetails", "parameters": [ { "name": "edgeGatewayName", "in": "path", "description": "Edge gateway name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Interconnect Gateway": { "description": "Interconnect Gateway", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true }, "put": { "tags": [ "Configuration - Multi Cloud" ], "description": "Update Interconnect Gateway", "operationId": "updateIcgw", "parameters": [ { "name": "edgeGatewayName", "in": "path", "description": "Edge gateway name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "object", "properties": { "valueType": { "type": "string", "enum": [ "ARRAY", "OBJECT", "STRING", "NUMBER", "TRUE", "FALSE", "NULL" ] } } } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Task Id": { "description": "Task Id", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true }, "delete": { "tags": [ "Configuration - Multi Cloud" ], "description": "Delete Interconnect Gateway", "operationId": "deleteIcgw", "parameters": [ { "name": "edgeGatewayName", "in": "path", "description": "Edge gateway name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Task Id": { "description": "Task Id", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true } }, "/multicloud/gateways/edge/{edgeType}": { "get": { "tags": [ "Configuration - Multi Cloud" ], "description": "Get sites with connectivity to the interconnect gateways by edge type", "operationId": "getEdgeGateways", "parameters": [ { "name": "edgeType", "in": "path", "description": "Edge type", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Edge Gateways": { "description": "Edge Gateways", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true, "x-roles-required": "Cloud OnRamp-read" } }, "/multicloud/imagename/edge": { "get": { "tags": [ "Configuration - Multi Cloud" ], "description": "Get Edge provider supported images", "operationId": "getSupportedEdgeImageNames", "parameters": [ { "name": "edgeType", "in": "query", "description": "Edge type", "schema": { "type": "string", "enum": [ "MEGAPORT", "EQUINIX" ], "default": "MEGAPORT" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Edge provider images": { "description": "Edge provider images" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true } }, "/multicloud/instancesize/edge": { "get": { "tags": [ "Configuration - Multi Cloud" ], "description": "Get Edge provider supported size", "operationId": "getSupportedEdgeInstanceSize", "parameters": [ { "name": "edgeType", "in": "query", "description": "Edge type", "schema": { "type": "string", "enum": [ "MEGAPORT", "EQUINIX" ], "default": "MEGAPORT" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Edge provider size": { "description": "Edge provider size" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true } }, "/multicloud/interconnect/accounts": { "get": { "tags": [ "Multicloud Interconnect - Accounts" ], "summary": "Get Interconnect provider accounts.", "description": "API to retrieve Interconnect provider accounts.", "operationId": "getInterconnectAccounts", "parameters": [ { "name": "interconnect-type", "in": "query", "description": "Interconnect provider type", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Accepted", "content": { "application/json": { "schema": { "type": "array", "items": { "required": [ "attCredentials", "edgeAccountId", "edgeAccountName", "edgeType", "equinixCredentials" ], "type": "object", "properties": { "attCredentials": { "required": [ "clientId", "clientSecret" ], "type": "object", "properties": { "clientId": { "type": "string", "description": "Client id of the AT&T Account.", "example": "att-abcd-1234" }, "clientSecret": { "type": "string", "description": "Client secret of the AT&T Account.", "example": "XXXX-XXXX-XXXX" } }, "description": "AT&T Credential information.", "$$ref": "#/components/schemas/InterconnectAccountAttCredentials" }, "billingProviderType": { "type": "string" }, "credType": { "type": "string" }, "description": { "maxLength": 1024, "minLength": 1, "pattern": "^[a-zA-Z0-9_\\-\\s]+$", "type": "string" }, "edgeAccountId": { "maxLength": 255, "minLength": 1, "type": "string" }, "edgeAccountName": { "maxLength": 255, "minLength": 1, "pattern": "^[a-zA-Z0-9_\\-\\s]+$", "type": "string" }, "edgeType": { "type": "string" }, "equinixCredentials": { "required": [ "clientId", "clientSecret" ], "type": "object", "properties": { "clientId": { "type": "string", "description": "Client id of the Equinix Account.", "example": "abcd-1234" }, "clientSecret": { "type": "string", "description": "Client secret of the Equinix Account.", "example": "XXXX-XXXX-XXXX" } }, "description": "Equinix Credential information.", "$$ref": "#/components/schemas/InterconnectAccountEquinixCredentials" }, "megaportCredentials": { "required": [ "password", "username" ], "type": "object", "properties": { "password": { "type": "string", "description": "Password of the Megaport Account.", "example": "XXXXX" }, "username": { "type": "string", "description": "Username of the Megaport Account.", "example": "cisco@megaport.com" } }, "description": "Megaport Credential Information", "$$ref": "#/components/schemas/InterconnectAccountMegaportCredentials" }, "megaportOauthCredentials": { "required": [ "clientId", "clientSecret" ], "type": "object", "properties": { "clientId": { "type": "string", "description": "Client id of the Megaport Account.", "example": "abcd-1234" }, "clientSecret": { "type": "string", "description": "Client secret of the Megaport Account.", "example": "XXXXX-XXXXX-XXXXX" } }, "description": "Megaport Oauth Credential Information", "$$ref": "#/components/schemas/InterconnectAccountMegaportOauthCredentials" }, "regionList": { "type": "array", "properties": { "empty": { "type": "boolean" } }, "description": "List of regions", "items": { "type": "string", "description": "List of regions" } } }, "$$ref": "#/components/schemas/InterconnectAccount" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Multicloud Interconnect - Accounts" ], "summary": "Add an Interconnect provider account to vManage.", "description": "API to associate an Interconnect provider account to vManage.", "operationId": "addInterconnectAccount", "requestBody": { "description": "Request Payload for Multicloud Interconnect Accounts", "content": { "application/json": { "schema": { "required": [ "attCredentials", "edgeAccountId", "edgeAccountName", "edgeType", "equinixCredentials" ], "type": "object", "properties": { "attCredentials": { "required": [ "clientId", "clientSecret" ], "type": "object", "properties": { "clientId": { "type": "string", "description": "Client id of the AT&T Account.", "example": "att-abcd-1234" }, "clientSecret": { "type": "string", "description": "Client secret of the AT&T Account.", "example": "XXXX-XXXX-XXXX" } }, "description": "AT&T Credential information.", "$$ref": "#/components/schemas/InterconnectAccountAttCredentials" }, "billingProviderType": { "type": "string" }, "credType": { "type": "string" }, "description": { "maxLength": 1024, "minLength": 1, "pattern": "^[a-zA-Z0-9_\\-\\s]+$", "type": "string" }, "edgeAccountId": { "maxLength": 255, "minLength": 1, "type": "string" }, "edgeAccountName": { "maxLength": 255, "minLength": 1, "pattern": "^[a-zA-Z0-9_\\-\\s]+$", "type": "string" }, "edgeType": { "type": "string" }, "equinixCredentials": { "required": [ "clientId", "clientSecret" ], "type": "object", "properties": { "clientId": { "type": "string", "description": "Client id of the Equinix Account.", "example": "abcd-1234" }, "clientSecret": { "type": "string", "description": "Client secret of the Equinix Account.", "example": "XXXX-XXXX-XXXX" } }, "description": "Equinix Credential information.", "$$ref": "#/components/schemas/InterconnectAccountEquinixCredentials" }, "megaportCredentials": { "required": [ "password", "username" ], "type": "object", "properties": { "password": { "type": "string", "description": "Password of the Megaport Account.", "example": "XXXXX" }, "username": { "type": "string", "description": "Username of the Megaport Account.", "example": "cisco@megaport.com" } }, "description": "Megaport Credential Information", "$$ref": "#/components/schemas/InterconnectAccountMegaportCredentials" }, "megaportOauthCredentials": { "required": [ "clientId", "clientSecret" ], "type": "object", "properties": { "clientId": { "type": "string", "description": "Client id of the Megaport Account.", "example": "abcd-1234" }, "clientSecret": { "type": "string", "description": "Client secret of the Megaport Account.", "example": "XXXXX-XXXXX-XXXXX" } }, "description": "Megaport Oauth Credential Information", "$$ref": "#/components/schemas/InterconnectAccountMegaportOauthCredentials" }, "regionList": { "type": "array", "properties": { "empty": { "type": "boolean" } }, "description": "List of regions", "items": { "type": "string", "description": "List of regions" } } }, "$$ref": "#/components/schemas/InterconnectAccount" }, "examples": { "Interconnect Megaport Account": { "description": "Interconnect Megaport Account", "value": { "edgeType": "MEGAPORT", "edgeAccountName": "interconnect-mp-account-name", "edgeAccountId": "ABCD-1234-CDEF", "description": "This is my Megaport account", "megaportCredentials": { "username": "cisco@megaport.com", "password": "XXXXX" } } }, "Interconnect Megaport OAuth Account": { "description": "Interconnect Megaport OAuth Account", "value": { "edgeType": "MEGAPORT", "edgeAccountName": "interconnect-mp-account-name", "edgeAccountId": "ABCD-1234-CDEF", "description": "This is my Megaport account", "megaportOauthCredentials": { "clientId": "abcd-1234", "clientSecret": "XXXX-XXXX-XXXX" } } }, "Interconnect Equinix Account": { "description": "Interconnect Equinix Account", "value": { "edgeType": "EQUINIX", "edgeAccountName": "interconnect-eq-account-name", "edgeAccountId": "ABCD-1234-CDEF", "description": "This is my Equinix account", "equinixCredentials": { "clientId": "abcd-1234", "clientSecret": "XXXX-XXXX-XXXX" } } } } } }, "required": true }, "responses": { "200": { "description": "Interconnect Provider Account Information.", "content": { "application/json": { "schema": { "required": [ "attCredentials", "edgeAccountId", "edgeAccountName", "edgeType", "equinixCredentials" ], "type": "object", "properties": { "attCredentials": { "required": [ "clientId", "clientSecret" ], "type": "object", "properties": { "clientId": { "type": "string", "description": "Client id of the AT&T Account.", "example": "att-abcd-1234" }, "clientSecret": { "type": "string", "description": "Client secret of the AT&T Account.", "example": "XXXX-XXXX-XXXX" } }, "description": "AT&T Credential information.", "$$ref": "#/components/schemas/InterconnectAccountAttCredentials" }, "billingProviderType": { "type": "string" }, "credType": { "type": "string" }, "description": { "maxLength": 1024, "minLength": 1, "pattern": "^[a-zA-Z0-9_\\-\\s]+$", "type": "string" }, "edgeAccountId": { "maxLength": 255, "minLength": 1, "type": "string" }, "edgeAccountName": { "maxLength": 255, "minLength": 1, "pattern": "^[a-zA-Z0-9_\\-\\s]+$", "type": "string" }, "edgeType": { "type": "string" }, "equinixCredentials": { "required": [ "clientId", "clientSecret" ], "type": "object", "properties": { "clientId": { "type": "string", "description": "Client id of the Equinix Account.", "example": "abcd-1234" }, "clientSecret": { "type": "string", "description": "Client secret of the Equinix Account.", "example": "XXXX-XXXX-XXXX" } }, "description": "Equinix Credential information.", "$$ref": "#/components/schemas/InterconnectAccountEquinixCredentials" }, "megaportCredentials": { "required": [ "password", "username" ], "type": "object", "properties": { "password": { "type": "string", "description": "Password of the Megaport Account.", "example": "XXXXX" }, "username": { "type": "string", "description": "Username of the Megaport Account.", "example": "cisco@megaport.com" } }, "description": "Megaport Credential Information", "$$ref": "#/components/schemas/InterconnectAccountMegaportCredentials" }, "megaportOauthCredentials": { "required": [ "clientId", "clientSecret" ], "type": "object", "properties": { "clientId": { "type": "string", "description": "Client id of the Megaport Account.", "example": "abcd-1234" }, "clientSecret": { "type": "string", "description": "Client secret of the Megaport Account.", "example": "XXXXX-XXXXX-XXXXX" } }, "description": "Megaport Oauth Credential Information", "$$ref": "#/components/schemas/InterconnectAccountMegaportOauthCredentials" }, "regionList": { "type": "array", "properties": { "empty": { "type": "boolean" } }, "description": "List of regions", "items": { "type": "string", "description": "List of regions" } } }, "$$ref": "#/components/schemas/InterconnectAccount" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/interconnect/accounts/{interconnect-account-id}": { "get": { "tags": [ "Multicloud Interconnect - Accounts" ], "summary": "Get associated Interconnect provider account by id.", "description": "API to retrieve associated Interconnect provider account details by id.", "operationId": "getInterconnectAccount", "parameters": [ { "name": "interconnect-account-id", "in": "path", "description": "Interconnect provider account id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Interconnect Provider Account Information.", "content": { "application/json": { "schema": { "required": [ "attCredentials", "edgeAccountId", "edgeAccountName", "edgeType", "equinixCredentials" ], "type": "object", "properties": { "attCredentials": { "required": [ "clientId", "clientSecret" ], "type": "object", "properties": { "clientId": { "type": "string", "description": "Client id of the AT&T Account.", "example": "att-abcd-1234" }, "clientSecret": { "type": "string", "description": "Client secret of the AT&T Account.", "example": "XXXX-XXXX-XXXX" } }, "description": "AT&T Credential information.", "$$ref": "#/components/schemas/InterconnectAccountAttCredentials" }, "billingProviderType": { "type": "string" }, "credType": { "type": "string" }, "description": { "maxLength": 1024, "minLength": 1, "pattern": "^[a-zA-Z0-9_\\-\\s]+$", "type": "string" }, "edgeAccountId": { "maxLength": 255, "minLength": 1, "type": "string" }, "edgeAccountName": { "maxLength": 255, "minLength": 1, "pattern": "^[a-zA-Z0-9_\\-\\s]+$", "type": "string" }, "edgeType": { "type": "string" }, "equinixCredentials": { "required": [ "clientId", "clientSecret" ], "type": "object", "properties": { "clientId": { "type": "string", "description": "Client id of the Equinix Account.", "example": "abcd-1234" }, "clientSecret": { "type": "string", "description": "Client secret of the Equinix Account.", "example": "XXXX-XXXX-XXXX" } }, "description": "Equinix Credential information.", "$$ref": "#/components/schemas/InterconnectAccountEquinixCredentials" }, "megaportCredentials": { "required": [ "password", "username" ], "type": "object", "properties": { "password": { "type": "string", "description": "Password of the Megaport Account.", "example": "XXXXX" }, "username": { "type": "string", "description": "Username of the Megaport Account.", "example": "cisco@megaport.com" } }, "description": "Megaport Credential Information", "$$ref": "#/components/schemas/InterconnectAccountMegaportCredentials" }, "megaportOauthCredentials": { "required": [ "clientId", "clientSecret" ], "type": "object", "properties": { "clientId": { "type": "string", "description": "Client id of the Megaport Account.", "example": "abcd-1234" }, "clientSecret": { "type": "string", "description": "Client secret of the Megaport Account.", "example": "XXXXX-XXXXX-XXXXX" } }, "description": "Megaport Oauth Credential Information", "$$ref": "#/components/schemas/InterconnectAccountMegaportOauthCredentials" }, "regionList": { "type": "array", "properties": { "empty": { "type": "boolean" } }, "description": "List of regions", "items": { "type": "string", "description": "List of regions" } } }, "$$ref": "#/components/schemas/InterconnectAccount" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Multicloud Interconnect - Accounts" ], "summary": "Delete Interconnect provider account from vManage.", "description": "API to disassociate Interconnect provider account from vManage.", "operationId": "deleteInterconnectAccount", "parameters": [ { "name": "interconnect-account-id", "in": "path", "description": "Interconnect provider account id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Accepted" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "Multicloud Interconnect - Accounts" ], "summary": "Edit Interconnect provider account details.", "description": "API to edit associated Interconnect provider account name and description.", "operationId": "updateInterconnectAccount", "parameters": [ { "name": "interconnect-account-id", "in": "path", "description": "Interconnect provider account id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request Payload for Multicloud Interconnect Accounts", "content": { "application/json": { "schema": { "required": [ "attCredentials", "edgeAccountId", "edgeAccountName", "edgeType", "equinixCredentials" ], "type": "object", "properties": { "attCredentials": { "required": [ "clientId", "clientSecret" ], "type": "object", "properties": { "clientId": { "type": "string", "description": "Client id of the AT&T Account.", "example": "att-abcd-1234" }, "clientSecret": { "type": "string", "description": "Client secret of the AT&T Account.", "example": "XXXX-XXXX-XXXX" } }, "description": "AT&T Credential information.", "$$ref": "#/components/schemas/InterconnectAccountAttCredentials" }, "billingProviderType": { "type": "string" }, "credType": { "type": "string" }, "description": { "maxLength": 1024, "minLength": 1, "pattern": "^[a-zA-Z0-9_\\-\\s]+$", "type": "string" }, "edgeAccountId": { "maxLength": 255, "minLength": 1, "type": "string" }, "edgeAccountName": { "maxLength": 255, "minLength": 1, "pattern": "^[a-zA-Z0-9_\\-\\s]+$", "type": "string" }, "edgeType": { "type": "string" }, "equinixCredentials": { "required": [ "clientId", "clientSecret" ], "type": "object", "properties": { "clientId": { "type": "string", "description": "Client id of the Equinix Account.", "example": "abcd-1234" }, "clientSecret": { "type": "string", "description": "Client secret of the Equinix Account.", "example": "XXXX-XXXX-XXXX" } }, "description": "Equinix Credential information.", "$$ref": "#/components/schemas/InterconnectAccountEquinixCredentials" }, "megaportCredentials": { "required": [ "password", "username" ], "type": "object", "properties": { "password": { "type": "string", "description": "Password of the Megaport Account.", "example": "XXXXX" }, "username": { "type": "string", "description": "Username of the Megaport Account.", "example": "cisco@megaport.com" } }, "description": "Megaport Credential Information", "$$ref": "#/components/schemas/InterconnectAccountMegaportCredentials" }, "megaportOauthCredentials": { "required": [ "clientId", "clientSecret" ], "type": "object", "properties": { "clientId": { "type": "string", "description": "Client id of the Megaport Account.", "example": "abcd-1234" }, "clientSecret": { "type": "string", "description": "Client secret of the Megaport Account.", "example": "XXXXX-XXXXX-XXXXX" } }, "description": "Megaport Oauth Credential Information", "$$ref": "#/components/schemas/InterconnectAccountMegaportOauthCredentials" }, "regionList": { "type": "array", "properties": { "empty": { "type": "boolean" } }, "description": "List of regions", "items": { "type": "string", "description": "List of regions" } } }, "$$ref": "#/components/schemas/InterconnectAccount" }, "examples": { "Interconnect Megaport Account": { "description": "Interconnect Megaport Account", "value": { "edgeType": "MEGAPORT", "edgeAccountName": "interconnect-mp-account-name", "edgeAccountId": "ABCD-1234-CDEF", "description": "This is my Megaport account", "megaportCredentials": { "username": "cisco@megaport.com", "password": "XXXXX" } } }, "Interconnect Megaport OAuth Account": { "description": "Interconnect Megaport OAuth Account", "value": { "edgeType": "MEGAPORT", "edgeAccountName": "interconnect-mp-account-name", "edgeAccountId": "ABCD-1234-CDEF", "description": "This is my Megaport account", "megaportOauthCredentials": { "clientId": "abcd-1234", "clientSecret": "XXXX-XXXX-XXXX" } } }, "Interconnect Equinix Account": { "description": "Interconnect Equinix Account", "value": { "edgeType": "EQUINIX", "edgeAccountName": "interconnect-eq-account-name", "edgeAccountId": "ABCD-1234-CDEF", "description": "This is my Equinix account", "equinixCredentials": { "clientId": "abcd-1234", "clientSecret": "XXXX-XXXX-XXXX" } } } } } }, "required": true }, "responses": { "200": { "description": "Accepted" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/interconnect/accounts/{interconnect-account-id}/credentials": { "put": { "tags": [ "Multicloud Interconnect - Accounts" ], "summary": "Edit associated Interconnect provider account credentials.", "description": "API to edit associated Interconnect provider account credentials.", "operationId": "updateInterconnectAccountCredentials", "parameters": [ { "name": "interconnect-account-id", "in": "path", "description": "Interconnect provider account id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request Payload for Multicloud Interconnect Accounts", "content": { "application/json": { "schema": { "required": [ "attCredentials", "edgeAccountId", "edgeAccountName", "edgeType", "equinixCredentials" ], "type": "object", "properties": { "attCredentials": { "required": [ "clientId", "clientSecret" ], "type": "object", "properties": { "clientId": { "type": "string", "description": "Client id of the AT&T Account.", "example": "att-abcd-1234" }, "clientSecret": { "type": "string", "description": "Client secret of the AT&T Account.", "example": "XXXX-XXXX-XXXX" } }, "description": "AT&T Credential information.", "$$ref": "#/components/schemas/InterconnectAccountAttCredentials" }, "billingProviderType": { "type": "string" }, "credType": { "type": "string" }, "description": { "maxLength": 1024, "minLength": 1, "pattern": "^[a-zA-Z0-9_\\-\\s]+$", "type": "string" }, "edgeAccountId": { "maxLength": 255, "minLength": 1, "type": "string" }, "edgeAccountName": { "maxLength": 255, "minLength": 1, "pattern": "^[a-zA-Z0-9_\\-\\s]+$", "type": "string" }, "edgeType": { "type": "string" }, "equinixCredentials": { "required": [ "clientId", "clientSecret" ], "type": "object", "properties": { "clientId": { "type": "string", "description": "Client id of the Equinix Account.", "example": "abcd-1234" }, "clientSecret": { "type": "string", "description": "Client secret of the Equinix Account.", "example": "XXXX-XXXX-XXXX" } }, "description": "Equinix Credential information.", "$$ref": "#/components/schemas/InterconnectAccountEquinixCredentials" }, "megaportCredentials": { "required": [ "password", "username" ], "type": "object", "properties": { "password": { "type": "string", "description": "Password of the Megaport Account.", "example": "XXXXX" }, "username": { "type": "string", "description": "Username of the Megaport Account.", "example": "cisco@megaport.com" } }, "description": "Megaport Credential Information", "$$ref": "#/components/schemas/InterconnectAccountMegaportCredentials" }, "megaportOauthCredentials": { "required": [ "clientId", "clientSecret" ], "type": "object", "properties": { "clientId": { "type": "string", "description": "Client id of the Megaport Account.", "example": "abcd-1234" }, "clientSecret": { "type": "string", "description": "Client secret of the Megaport Account.", "example": "XXXXX-XXXXX-XXXXX" } }, "description": "Megaport Oauth Credential Information", "$$ref": "#/components/schemas/InterconnectAccountMegaportOauthCredentials" }, "regionList": { "type": "array", "properties": { "empty": { "type": "boolean" } }, "description": "List of regions", "items": { "type": "string", "description": "List of regions" } } }, "$$ref": "#/components/schemas/InterconnectAccount" }, "examples": { "Interconnect Megaport Account": { "description": "Interconnect Megaport Account", "value": { "edgeType": "MEGAPORT", "edgeAccountName": "interconnect-mp-account-name", "edgeAccountId": "ABCD-1234-CDEF", "description": "This is my Megaport account", "megaportCredentials": { "username": "cisco@megaport.com", "password": "XXXXX" } } }, "Interconnect Megaport OAuth Account": { "description": "Interconnect Megaport OAuth Account", "value": { "edgeType": "MEGAPORT", "edgeAccountName": "interconnect-mp-account-name", "edgeAccountId": "ABCD-1234-CDEF", "description": "This is my Megaport account", "megaportOauthCredentials": { "clientId": "abcd-1234", "clientSecret": "XXXX-XXXX-XXXX" } } }, "Interconnect Equinix Account": { "description": "Interconnect Equinix Account", "value": { "edgeType": "EQUINIX", "edgeAccountName": "interconnect-eq-account-name", "edgeAccountId": "ABCD-1234-CDEF", "description": "This is my Equinix account", "equinixCredentials": { "clientId": "abcd-1234", "clientSecret": "XXXX-XXXX-XXXX" } } } } } }, "required": true }, "responses": { "200": { "description": "Interconnect Provider Account Information.", "content": { "application/json": { "schema": { "required": [ "attCredentials", "edgeAccountId", "edgeAccountName", "edgeType", "equinixCredentials" ], "type": "object", "properties": { "attCredentials": { "required": [ "clientId", "clientSecret" ], "type": "object", "properties": { "clientId": { "type": "string", "description": "Client id of the AT&T Account.", "example": "att-abcd-1234" }, "clientSecret": { "type": "string", "description": "Client secret of the AT&T Account.", "example": "XXXX-XXXX-XXXX" } }, "description": "AT&T Credential information.", "$$ref": "#/components/schemas/InterconnectAccountAttCredentials" }, "billingProviderType": { "type": "string" }, "credType": { "type": "string" }, "description": { "maxLength": 1024, "minLength": 1, "pattern": "^[a-zA-Z0-9_\\-\\s]+$", "type": "string" }, "edgeAccountId": { "maxLength": 255, "minLength": 1, "type": "string" }, "edgeAccountName": { "maxLength": 255, "minLength": 1, "pattern": "^[a-zA-Z0-9_\\-\\s]+$", "type": "string" }, "edgeType": { "type": "string" }, "equinixCredentials": { "required": [ "clientId", "clientSecret" ], "type": "object", "properties": { "clientId": { "type": "string", "description": "Client id of the Equinix Account.", "example": "abcd-1234" }, "clientSecret": { "type": "string", "description": "Client secret of the Equinix Account.", "example": "XXXX-XXXX-XXXX" } }, "description": "Equinix Credential information.", "$$ref": "#/components/schemas/InterconnectAccountEquinixCredentials" }, "megaportCredentials": { "required": [ "password", "username" ], "type": "object", "properties": { "password": { "type": "string", "description": "Password of the Megaport Account.", "example": "XXXXX" }, "username": { "type": "string", "description": "Username of the Megaport Account.", "example": "cisco@megaport.com" } }, "description": "Megaport Credential Information", "$$ref": "#/components/schemas/InterconnectAccountMegaportCredentials" }, "megaportOauthCredentials": { "required": [ "clientId", "clientSecret" ], "type": "object", "properties": { "clientId": { "type": "string", "description": "Client id of the Megaport Account.", "example": "abcd-1234" }, "clientSecret": { "type": "string", "description": "Client secret of the Megaport Account.", "example": "XXXXX-XXXXX-XXXXX" } }, "description": "Megaport Oauth Credential Information", "$$ref": "#/components/schemas/InterconnectAccountMegaportOauthCredentials" }, "regionList": { "type": "array", "properties": { "empty": { "type": "boolean" } }, "description": "List of regions", "items": { "type": "string", "description": "List of regions" } } }, "$$ref": "#/components/schemas/InterconnectAccount" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/interconnect/audit": { "get": { "tags": [ "Multicloud Interconnect - Resource Audit" ], "summary": "Get audit report for resources.", "description": "API to generate audit report for resources.", "operationId": "getAuditReport", "parameters": [ { "name": "interconnect-type", "in": "query", "description": "Interconnect provider type", "required": true, "schema": { "type": "string" } }, { "name": "connection-type", "in": "query", "description": "Interconnect connectivity type", "schema": { "type": "string" } }, { "name": "cloud-type", "in": "query", "description": "Cloud provider type", "schema": { "type": "string" } }, { "name": "device-links", "in": "query", "description": "Interconnect Equinix device link enabled", "schema": { "pattern": "(true|false)", "type": "string", "default": "false" } }, { "name": "refresh", "in": "query", "description": "Interconnect Audit Refresh Option", "schema": { "pattern": "(true|false)", "type": "string", "default": "true" } } ], "responses": { "200": { "description": "Audit Report Get Response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "auditReport": { "type": "array", "items": { "type": "object", "properties": { "errString": { "type": "string" }, "region": { "type": "string", "example": "My-Region-1" }, "reportType": { "type": "string", "example": "Edge Gateway" }, "resourceName": { "type": "string", "example": "My-Interconnect-Gateway-1" }, "status": { "type": "string", "example": "IN_SYNC" } }, "$$ref": "#/components/schemas/AuditReportAuditReport" } }, "auditStatus": { "type": "string", "example": "IN_SYNC" } }, "$$ref": "#/components/schemas/AuditReport" }, "examples": { "Interconnect Audit In-Sync": { "description": "Interconnect Audit In-Sync", "value": { "auditStatus": "IN_SYNC", "auditReport": [ { "status": "IN_SYNC", "errString": "", "reportType": "Edge Gateway", "resourceName": "MY-ICGW-1", "region": "Equinix SY1, Sydney, NSW, Australia : Sydney" } ] } }, "Interconnect Audit Out-Of-Sync": { "description": "Interconnect Audit Out-Of-Sync", "value": { "auditStatus": "OUT_OF_SYNC", "auditReport": [ { "status": "IN_SYNC", "errString": "", "reportType": "Edge Gateway", "resourceName": "MY-ICGW-1", "region": "Equinix SY1, Sydney, NSW, Australia : Sydney" }, { "status": "OUT_OF_SYNC_DRY_RUN", "errString": "BGP Status down", "reportType": "Edge Connection", "resourceName": "test-az-conn-1", "region": "New York Primary - New York - NY - USA" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/interconnect/cloud/{cloud-type}/accounts/{cloud-account-id}/gcr-and-attachments": { "get": { "tags": [ "Multicloud Interconnect - Cloud Resource Management" ], "summary": "Get Google Cloud Router and Attachments.", "description": "API to get Google Cloud Router and Attachments.", "operationId": "getGoogleCloudRouterAndAttachments", "parameters": [ { "name": "cloud-type", "in": "path", "description": "Cloud Provider Type", "required": true, "schema": { "type": "string", "enum": [ "AWS", "AZURE", "GCP" ] } }, { "name": "cloud-account-id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "connectivity-gateway-name", "in": "query", "schema": { "type": "string" } }, { "name": "cloud-gateway-name", "in": "query", "schema": { "type": "string" } }, { "name": "region", "in": "query", "schema": { "type": "string" } }, { "name": "network", "in": "query", "schema": { "type": "string" } }, { "name": "resource-state", "in": "query", "schema": { "type": "string" } }, { "name": "refresh", "in": "query", "schema": { "pattern": "(true|false)", "type": "string", "default": "false" } } ], "responses": { "200": { "description": "Google Cloud Router and Attachments Response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "gcpCloudRouters": { "type": "array", "items": { "required": [ "name", "network" ], "type": "object", "properties": { "attachmentDetails": { "type": "array", "description": "List of GCR Attachments", "items": { "type": "object", "properties": { "cloudRouterIpAddress": { "type": "string" }, "customerIpAddress": { "type": "string" }, "id": { "type": "string" }, "mtu": { "type": "string", "description": "MTU of the Interconnect attachment", "example": "1500" }, "name": { "pattern": "(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)", "type": "string" }, "pairingKey": { "type": "string", "example": "96fbc59c-8926-40ec-b6cd-4cb3501e4c47/us-west1/1" }, "region": { "type": "string" }, "secondaryZone": { "type": "string", "description": "Option to create Interconnect attachment in secondary zone", "example": "true" }, "state": { "type": "string" } }, "description": "Google cloud Interconnect Attachment Object.", "$$ref": "#/components/schemas/GcpInterconnectAttachment" } }, "cloudRouterAsn": { "pattern": "\\d+", "type": "string" }, "id": { "type": "string" }, "name": { "pattern": "(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)", "type": "string" }, "network": { "type": "string" }, "region": { "type": "string" } }, "description": "Google cloud GCR Object.", "$$ref": "#/components/schemas/GcpCloudRouter" } } }, "$$ref": "#/components/schemas/InlineResponse20010" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/interconnect/cloud/{cloud-type}/accounts/{cloud-account-id}/transit-gateways": { "get": { "tags": [ "Multicloud Interconnect - Cloud Resource Management" ], "summary": "Get AWS Transit Gateways.", "description": "API to retrieve AWS Transit Gateways.", "operationId": "getAwsTransitGateways", "parameters": [ { "name": "cloud-type", "in": "path", "description": "Cloud Provider Type", "required": true, "schema": { "type": "string", "enum": [ "AWS" ] } }, { "name": "cloud-account-id", "in": "path", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } }, { "name": "transit-gateway-name", "in": "query", "schema": { "type": "string" } }, { "name": "region", "in": "query", "schema": { "type": "string" } }, { "name": "tag-name", "in": "query", "schema": { "type": "string" } }, { "name": "refresh", "in": "query", "schema": { "pattern": "(true|false)", "type": "string", "default": "false" } } ], "responses": { "200": { "description": "Accepted", "content": { "application/json": { "schema": { "type": "object", "properties": { "connectivityGateway": { "type": "array", "items": { "required": [ "awsConnectivityGateway", "azureConnectivityGateway", "cloudAccountId", "cloudType", "gatewayName", "gcpConnectivityGateway", "region" ], "type": "object", "properties": { "awsConnectivityGateway": { "required": [ "awsConnectivityType" ], "type": "object", "properties": { "awsConnectivityType": { "type": "string", "example": "DIRECT_CONNECT_GATEWAY" }, "directConnectGateway": { "required": [ "amazonSideAsn" ], "type": "object", "properties": { "amazonSideAsn": { "pattern": "^[1-9]\\d*$", "type": "string" }, "gatewayAssociationList": { "type": "array", "description": "List of associated Gateways", "items": { "type": "object", "properties": { "advertisedPrefixList": { "type": "array", "description": "Advertized prefix list", "example": [ "10.10.0.0/24", "10.20.0.0/24" ], "items": { "type": "string", "description": "prefix", "example": "10.10.0.0/24" } }, "associatedGateway": { "type": "object", "properties": { "cloudAccountId": { "type": "string" }, "cloudGatewayName": { "type": "string" }, "cloudType": { "type": "string", "enum": [ "AWS", "AWS_GOVCLOUD", "AZURE", "AZURE_GOVCLOUD", "GCP" ] }, "description": { "type": "string" }, "gatewayId": { "type": "string" }, "gatewayName": { "type": "string" }, "region": { "type": "string" } }, "description": "Cloud Connectivity Gateway Object", "$$ref": "#/components/schemas/GatewayAssociationAssociatedGateway" }, "associationAction": { "type": "string", "example": "ASSOCIATE", "enum": [ "ASSOCIATE", "DISASSOCIATE", "REMOVE_PREFIX_LIST", "NO_ACTION" ] }, "associationId": { "type": "string", "example": "12345" }, "associationState": { "type": "string", "example": "ASSOCIATED" }, "stateChangeError": { "type": "string" } }, "description": "Generic multicloud gateway association object", "$$ref": "#/components/schemas/GatewayAssociation" } }, "ownerAccount": { "type": "string" }, "virtualInterfaceAttachmentList": { "type": "array", "description": "List of virtual interfaces attached to DxGW", "items": { "type": "object", "properties": { "attachmentState": { "type": "string" }, "cloudType": { "type": "string", "enum": [ "AWS", "AWS_GOVCLOUD", "AZURE", "AZURE_GOVCLOUD", "GCP" ] }, "connectionId": { "type": "string", "description": "Id of the private cross connect", "example": "12345-1234-1234" }, "connectionType": { "type": "string", "description": "Type of AWS connection", "example": "HCONN", "enum": [ "HVIF", "HCONN" ] }, "ownerAccount": { "type": "string" }, "region": { "type": "string" }, "stateChangeError": { "type": "string" }, "virtualInterfaceData": { "type": "object", "properties": { "advertisedPrefixList": { "type": "array", "items": { "type": "string" } }, "asn": { "type": "integer", "format": "int64", "example": 65500 }, "bgpKey": { "type": "string", "example": "EC-12345678" }, "customerIpAddress": { "type": "string" }, "ipAddress": { "type": "string" }, "vlan": { "type": "integer", "format": "int64", "example": 45678 } }, "description": "VIrtual Interface Object", "$$ref": "#/components/schemas/AwsDirectConnectGatewayVirtualInterfaceData" }, "virtualInterfaceId": { "type": "string" }, "virtualInterfaceName": { "type": "string" }, "virtualInterfaceType": { "type": "string", "example": "TRANSIT", "enum": [ "TRANSIT", "PRIVATE", "PUBLIC", "ATTACHMENT" ] } }, "description": "Virtual Interface Object", "$$ref": "#/components/schemas/AwsDirectConnectGatewayVirtualInterfaceAttachmentList" } }, "vpcTagNamesForGatewayAssociations": { "type": "array", "description": "VPC Tags associated to the Direct Connect Gateway", "items": { "type": "string", "description": "VPC Tags associated to the Direct Connect Gateway" } } }, "description": "AWS Direct Connect Gateway specific Object.", "$$ref": "#/components/schemas/AwsDirectConnectGateway" }, "transitGateway": { "required": [ "amazonSideAsn" ], "type": "object", "properties": { "amazonSideAsn": { "pattern": "^[1-9]\\d*$", "type": "string" }, "associationDefaultRouteTableId": { "type": "string", "example": "tgw-rtb-07ace6b22f9de8502" }, "autoAcceptSharedAttachments": { "type": "boolean" }, "creationTime": { "type": "string", "example": "11-Jun-2022 (00:10:30:00000)" }, "defaultRouteTableAssociation": { "type": "boolean" }, "defaultRouteTablePropogation": { "type": "boolean" }, "dnsSupport": { "type": "boolean" }, "multicastSupport": { "type": "boolean" }, "ownerAccount": { "type": "string" }, "propogationDefaultRouteTableId": { "type": "string" }, "vpcAttachmentList": { "type": "array", "description": "List of VPC attachments", "items": { "type": "object", "properties": { "region": { "type": "string" }, "vpcId": { "type": "string", "description": "VPC Id", "example": "vpc-012345-2000" }, "vpcRoutePrefixList": { "type": "array", "description": "List of ip prefixes to be advertized towards DxGw on the VPC routing table.", "example": [ "198.18.0.4/30", "198.18.0.7/30" ], "items": { "type": "string", "description": "ip prefix", "example": "198.18.0.4/30" } }, "vpcState": { "type": "string" }, "vpcSubnetPrefixList": { "type": "array", "description": "List of VPC subnets to be added to DxGw association", "example": [ "10.10.0.0/24", "10.10.1.0/24" ], "items": { "type": "string", "description": "VPC subnet", "example": "10.10.0.0/24" } } }, "description": "AWS VPC attachment Object", "$$ref": "#/components/schemas/AwsVpcAttachments" } }, "vpnEcmpSupport": { "type": "boolean" } }, "description": "AWS Transit Gateway specific Object.", "$$ref": "#/components/schemas/AwsTransitGateway" }, "virtualPrivateGateway": { "type": "object", "properties": { "amazonSideAsn": { "type": "integer", "format": "int64" }, "availabilityZone": { "type": "string" }, "vpcAttachmentList": { "type": "array", "description": "List of VPC attachments", "items": { "type": "object", "properties": { "region": { "type": "string" }, "vpcId": { "type": "string", "description": "VPC Id", "example": "vpc-012345-2000" }, "vpcRoutePrefixList": { "type": "array", "description": "List of ip prefixes to be advertized towards DxGw on the VPC routing table.", "example": [ "198.18.0.4/30", "198.18.0.7/30" ], "items": { "type": "string", "description": "ip prefix", "example": "198.18.0.4/30" } }, "vpcState": { "type": "string" }, "vpcSubnetPrefixList": { "type": "array", "description": "List of VPC subnets to be added to DxGw association", "example": [ "10.10.0.0/24", "10.10.1.0/24" ], "items": { "type": "string", "description": "VPC subnet", "example": "10.10.0.0/24" } } }, "description": "AWS VPC attachment Object", "$$ref": "#/components/schemas/AwsVpcAttachments" } }, "vpgType": { "type": "string", "example": "ipsec.1" } }, "description": "AWS Virtual Private Gateway specific Object.", "$$ref": "#/components/schemas/AwsVirtualPrivateGateway" } }, "description": "AWS cloud Connectivity Gateway Object", "$$ref": "#/components/schemas/CloudConnectivityGatewayAws" }, "azureConnectivityGateway": { "required": [ "azureConnectivityType" ], "type": "object", "properties": { "azureConnectivityType": { "type": "string" }, "expressRouteCircuit": { "required": [ "resourceGroupName" ], "type": "object", "properties": { "allowClassicOperations": { "type": "boolean", "example": true }, "bandwidthInGbps": { "type": "integer", "format": "int32", "example": 200 }, "gatewayAssociationList": { "type": "array", "items": { "type": "object", "properties": { "advertisedPrefixList": { "type": "array", "description": "Advertized prefix list", "example": [ "10.10.0.0/24", "10.20.0.0/24" ], "items": { "type": "string", "description": "prefix", "example": "10.10.0.0/24" } }, "associatedGateway": { "type": "object", "properties": { "cloudAccountId": { "type": "string" }, "cloudGatewayName": { "type": "string" }, "cloudType": { "type": "string", "enum": [ "AWS", "AWS_GOVCLOUD", "AZURE", "AZURE_GOVCLOUD", "GCP" ] }, "description": { "type": "string" }, "gatewayId": { "type": "string" }, "gatewayName": { "type": "string" }, "region": { "type": "string" } }, "description": "Cloud Connectivity Gateway Object", "$$ref": "#/components/schemas/GatewayAssociationAssociatedGateway" }, "associationAction": { "type": "string", "example": "ASSOCIATE", "enum": [ "ASSOCIATE", "DISASSOCIATE", "REMOVE_PREFIX_LIST", "NO_ACTION" ] }, "associationId": { "type": "string", "example": "12345" }, "associationState": { "type": "string", "example": "ASSOCIATED" }, "stateChangeError": { "type": "string" } }, "description": "Generic multicloud gateway association object", "$$ref": "#/components/schemas/GatewayAssociation" } }, "globalReachEnabled": { "type": "boolean", "example": true }, "peeringList": { "type": "array", "items": { "type": "object", "properties": { "advertisedPublicPrefixList": { "type": "array", "items": { "type": "string" } }, "azureAsn": { "type": "string" }, "expressRouteConnectionId": { "type": "string", "example": "12345" }, "id": { "type": "string" }, "name": { "type": "string" }, "peerAsn": { "type": "string" }, "peeringState": { "type": "string", "example": "ENABLED", "enum": [ "DISABLED", "ENABLED" ] }, "peeringType": { "type": "string", "example": "PUBLIC", "enum": [ "PRIVATE", "PUBLIC" ] }, "primaryAzurePort": { "type": "string" }, "primaryPeerAddressPrefix": { "type": "string" }, "secondaryAzurePort": { "type": "string" }, "secondaryPeerAddressPrefix": { "type": "string" }, "sharedKey": { "type": "string", "description": "BGP Peering Key", "example": "EC-12345" }, "vlanId": { "type": "integer", "format": "int64", "example": 1618 } }, "description": "Azure Express Route Circuit Peering", "$$ref": "#/components/schemas/AzureERCPeering" } }, "provisioningState": { "type": "string", "example": "PROVISIONED" }, "resourceGroupName": { "type": "string" }, "serviceKey": { "type": "string" }, "serviceProviderProperties": { "type": "object", "properties": { "bandwidthInMbps": { "type": "integer", "format": "int64", "example": 1000 }, "peeringLocation": { "type": "string", "example": "New York" }, "serviceProviderName": { "type": "string" } }, "description": "Azure Express Route Circuit Service Provider Properties", "$$ref": "#/components/schemas/AzureERCServiceProviderProperties" }, "serviceProviderProvisioningState": { "type": "string", "enum": [ "DEPROVISIONING", "NOT_PROVISIONED", "PROVISIONED", "PROVISIONING" ] }, "sku": { "required": [ "family", "tier" ], "type": "object", "properties": { "family": { "type": "string" }, "name": { "type": "string" }, "tier": { "type": "string", "example": "STANDARD" } }, "description": "Express Route Circuit SKU", "$$ref": "#/components/schemas/AzureExpressRouteCircuitSku" }, "vWanAttachmentList": { "type": "array", "items": { "type": "object", "properties": { "vHubList": { "type": "array", "items": { "type": "object", "properties": { "isDelete": { "type": "boolean", "example": true }, "vHub": { "type": "object", "properties": { "accountId": { "type": "string" }, "accountName": { "type": "string" }, "addressPrefix": { "type": "string" }, "cloudType": { "type": "string", "enum": [ "AWS", "AWS_GOVCLOUD", "AZURE", "AZURE_GOVCLOUD", "GCP" ] }, "id": { "type": "string" }, "name": { "type": "string" }, "provisioningState": { "type": "string", "example": "PROVISIONED" }, "region": { "type": "string" }, "resourceGroupName": { "type": "string" }, "routingState": { "type": "string" }, "sku": { "type": "string", "example": "STANDARD" }, "tagList": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string", "example": "mytag" } }, "description": "Azure Virtual WAN Tag Object", "$$ref": "#/components/schemas/AzureVirtualWanTagList" } }, "virtualRouterAsn": { "type": "string" }, "virtualRouterIp": { "type": "array", "items": { "type": "object", "properties": { "privateIp": { "type": "string" } }, "description": "Virtual Router IP", "$$ref": "#/components/schemas/AzureVirtualHubVirtualRouterIp" } }, "vwanName": { "type": "string" } }, "description": "Azure Virtual Hub", "$$ref": "#/components/schemas/AzureVirtualHub" } }, "$$ref": "#/components/schemas/AzureExpressRouteCircuitVHubList" } }, "vWan": { "required": [ "name", "region", "resourceGroupName" ], "type": "object", "properties": { "accountId": { "maxLength": 255, "minLength": 1, "type": "string" }, "accountName": { "type": "string", "description": "Cloud account name", "example": "my-cloud-account" }, "allowBranchToBranchTraffic": { "type": "boolean", "example": false }, "cloudType": { "type": "string" }, "description": { "type": "string" }, "id": { "type": "string" }, "name": { "maxLength": 80, "minLength": 1, "type": "string" }, "provisioningState": { "type": "string", "example": "PROVISIONED" }, "region": { "maxLength": 255, "minLength": 1, "type": "string" }, "resourceGroupName": { "maxLength": 80, "minLength": 1, "type": "string" }, "tagList": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string", "example": "mytag" } }, "description": "Azure Virtual WAN Tag Object", "$$ref": "#/components/schemas/AzureVirtualWanTagList" } }, "virtualWanType": { "type": "string" }, "vnetTovnetTrafficEnabled": { "type": "boolean", "example": false } }, "description": "Azure Virtual Wan", "$$ref": "#/components/schemas/AzureVirtualWan" } }, "description": "vWan Attachment Name", "$$ref": "#/components/schemas/AzureExpressRouteCircuitVWanAttachmentList" } }, "vnetTagNamesForConnections": { "type": "array", "items": { "type": "object", "properties": { "isDelete": { "type": "boolean", "example": true }, "vnetTagName": { "type": "string" } }, "description": "Vnet Tag Object Names", "$$ref": "#/components/schemas/AzureExpressRouteCircuitVnetTagNamesForConnections" } } }, "description": "Azure Express Route Circuit Object", "$$ref": "#/components/schemas/AzureExpressRouteCircuit" }, "expressRouteGateway": { "type": "object", "properties": { "autoScaleConfiguration": { "type": "string" }, "resourceGroupName": { "type": "string" }, "vHubId": { "type": "string", "description": "Id of the Azure vHUB.", "example": "vhub-1234" } }, "description": "Azure Express Route Gateway Object", "$$ref": "#/components/schemas/AzureExpressRouteGateway" }, "virtualNetworkGateway": { "type": "object", "properties": { "enableBgp": { "type": "boolean", "example": true }, "publicIPAddress": { "type": "string" }, "sku": { "type": "object", "properties": { "capacity": { "type": "integer", "format": "int32", "example": 100 }, "name": { "type": "string" }, "tier": { "type": "string", "example": "STANDARD" } }, "description": "VNET Gateway SKU parameters", "$$ref": "#/components/schemas/AzureVirtualNetworkGatewaySku" }, "subnet": { "type": "string" }, "virtualNetworkGatewayType": { "type": "string", "example": "EXPRESS_ROUTE", "enum": [ "VPN", "EXPRESS_ROUTE" ] } }, "description": "Azure Virtual Network Gateway Object", "$$ref": "#/components/schemas/AzureVirtualNetworkGateway" } }, "description": "Cloud Connectivity Gateway Object", "$$ref": "#/components/schemas/CloudConnectivityGatewayAzure" }, "cloudAccountId": { "type": "string" }, "cloudGatewayName": { "type": "string" }, "cloudType": { "type": "string" }, "connectivityGatewayState": { "type": "string" }, "description": { "type": "string" }, "gatewayId": { "type": "string" }, "gatewayName": { "type": "string" }, "gcpConnectivityGateway": { "required": [ "gcConnectivityType", "routerInfo" ], "type": "object", "properties": { "gcConnectivityType": { "type": "string", "example": "GCR_ATTACHMENT" }, "interconnectAsn": { "pattern": "\\d+", "type": "string", "description": "BGP ASN assigned to Interconnect Gateway.", "example": "64500" }, "pairingKey": { "type": "string", "example": "96fbc59c-8926-40ec-b6cd-4cb3501e4c47/us-west1/1" }, "routerInfo": { "required": [ "name", "network" ], "type": "object", "properties": { "attachmentDetails": { "type": "array", "description": "List of GCR Attachments", "items": { "type": "object", "properties": { "cloudRouterIpAddress": { "type": "string" }, "customerIpAddress": { "type": "string" }, "id": { "type": "string" }, "mtu": { "type": "string", "description": "MTU of the Interconnect attachment", "example": "1500" }, "name": { "pattern": "(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)", "type": "string" }, "pairingKey": { "type": "string", "example": "96fbc59c-8926-40ec-b6cd-4cb3501e4c47/us-west1/1" }, "region": { "type": "string" }, "secondaryZone": { "type": "string", "description": "Option to create Interconnect attachment in secondary zone", "example": "true" }, "state": { "type": "string" } }, "description": "Google cloud Interconnect Attachment Object.", "$$ref": "#/components/schemas/GcpInterconnectAttachment" } }, "cloudRouterAsn": { "pattern": "\\d+", "type": "string" }, "id": { "type": "string" }, "name": { "pattern": "(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)", "type": "string" }, "network": { "type": "string" }, "region": { "type": "string" } }, "description": "Google cloud GCR Object.", "$$ref": "#/components/schemas/GcpCloudRouter" } }, "description": "Google cloud Connectivity Gateway Object.", "$$ref": "#/components/schemas/CloudConnectivityGatewayGcp" }, "isVmanageCreated": { "type": "boolean", "description": "Resource created by vManage", "example": true }, "newFormat": { "type": "boolean", "description": "Option indicates object type", "example": true }, "region": { "type": "string" } }, "description": "Cloud Connectivity Gateway Object", "$$ref": "#/components/schemas/CloudConnectivityGateway" } } }, "description": "Cloud Connectivity Gateway Object", "$$ref": "#/components/schemas/InlineResponse2008" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/interconnect/cloud/{cloud-type}/accounts/{cloud-account-id}/vhubs": { "get": { "tags": [ "Multicloud Interconnect - Cloud Resource Management" ], "summary": "Get Azure Virtual Hubs.", "description": "API to retrieve Azure Virtual Hubs.", "operationId": "getAzVirtualHubs", "parameters": [ { "name": "cloud-type", "in": "path", "description": "Cloud Provider Type", "required": true, "schema": { "type": "string" } }, { "name": "cloud-account-id", "in": "path", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } }, { "name": "resource-group", "in": "query", "description": "Azure cloud resource group name", "schema": { "maxLength": 128, "minLength": 1, "type": "string" } }, { "name": "refresh", "in": "query", "schema": { "pattern": "(true|false)", "type": "string", "default": "false" } }, { "name": "vwan-name", "in": "query", "schema": { "type": "string" } }, { "name": "tag-name", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Accepted", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/interconnect/cloud/{cloud-type}/accounts/{cloud-account-id}/vwans": { "get": { "tags": [ "Multicloud Interconnect - Cloud Resource Management" ], "summary": "Get Azure Virtual Wans.", "description": "API to retrieve Azure Virtual Wans.", "operationId": "getAzVirtualWans", "parameters": [ { "name": "cloud-type", "in": "path", "description": "Cloud Provider Type", "required": true, "schema": { "type": "string" } }, { "name": "cloud-account-id", "in": "path", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } }, { "name": "resource-group", "in": "query", "description": "Azure cloud resource group name", "required": true, "schema": { "type": "string" } }, { "name": "refresh", "in": "query", "schema": { "pattern": "(true|false)", "type": "string", "default": "false" } }, { "name": "vwan-name", "in": "query", "description": "Vwan Name", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Azure Virtual Wan Response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "vWans": { "type": "array", "items": { "type": "object", "properties": { "vWan": { "required": [ "name", "region", "resourceGroupName" ], "type": "object", "properties": { "accountId": { "maxLength": 255, "minLength": 1, "type": "string" }, "accountName": { "type": "string", "description": "Cloud account name", "example": "my-cloud-account" }, "allowBranchToBranchTraffic": { "type": "boolean", "example": false }, "cloudType": { "type": "string" }, "description": { "type": "string" }, "id": { "type": "string" }, "name": { "maxLength": 80, "minLength": 1, "type": "string" }, "provisioningState": { "type": "string", "example": "PROVISIONED" }, "region": { "maxLength": 255, "minLength": 1, "type": "string" }, "resourceGroupName": { "maxLength": 80, "minLength": 1, "type": "string" }, "tagList": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string", "example": "mytag" } }, "description": "Azure Virtual WAN Tag Object", "$$ref": "#/components/schemas/AzureVirtualWanTagList" } }, "virtualWanType": { "type": "string" }, "vnetTovnetTrafficEnabled": { "type": "boolean", "example": false } }, "description": "Azure Virtual Wan", "$$ref": "#/components/schemas/AzureVirtualWan" }, "vWanInUse": { "type": "boolean", "example": false } }, "$$ref": "#/components/schemas/InlineResponse2009VWans" } } }, "$$ref": "#/components/schemas/InlineResponse2009" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Multicloud Interconnect - Cloud Resource Management" ], "summary": "Create an Azure Virtual Wan.", "description": "API to create an Azure Virtual Wan..", "operationId": "createAzVirtualWan", "parameters": [ { "name": "cloud-type", "in": "path", "description": "Cloud Provider Type", "required": true, "schema": { "type": "string" } }, { "name": "cloud-account-id", "in": "path", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "requestBody": { "description": "Request Payload for Multicloud Interconnect Azure Vwan", "content": { "application/json": { "schema": { "required": [ "name", "region", "resourceGroupName" ], "type": "object", "properties": { "accountId": { "maxLength": 255, "minLength": 1, "type": "string" }, "accountName": { "type": "string", "description": "Cloud account name", "example": "my-cloud-account" }, "allowBranchToBranchTraffic": { "type": "boolean", "example": false }, "cloudType": { "type": "string" }, "description": { "type": "string" }, "id": { "type": "string" }, "name": { "maxLength": 80, "minLength": 1, "type": "string" }, "provisioningState": { "type": "string", "example": "PROVISIONED" }, "region": { "maxLength": 255, "minLength": 1, "type": "string" }, "resourceGroupName": { "maxLength": 80, "minLength": 1, "type": "string" }, "tagList": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string", "example": "mytag" } }, "description": "Azure Virtual WAN Tag Object", "$$ref": "#/components/schemas/AzureVirtualWanTagList" } }, "virtualWanType": { "type": "string" }, "vnetTovnetTrafficEnabled": { "type": "boolean", "example": false } }, "description": "Azure Virtual Wan", "$$ref": "#/components/schemas/AzureVirtualWan" }, "examples": { "Interconnect Azure VWAN": { "description": "Interconnect Azure VWAN", "value": { "cloudType": "AZURE", "accountId": "cloud-account-id", "accountName": "my-cloud-account-name", "name": "my-vwan-name", "description": "string", "region": "My Azure Region", "resourceGroupName": "az-resource-group", "tagList": [ { "name": "string", "value": "mytag" } ], "virtualWanType": "optional vwan type", "allowBranchToBranchTraffic": false, "vnetTovnetTrafficEnabled": false } } } } }, "required": true }, "responses": { "200": { "description": "Azure Virtual Wan Response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "vWans": { "type": "array", "items": { "type": "object", "properties": { "vWan": { "required": [ "name", "region", "resourceGroupName" ], "type": "object", "properties": { "accountId": { "maxLength": 255, "minLength": 1, "type": "string" }, "accountName": { "type": "string", "description": "Cloud account name", "example": "my-cloud-account" }, "allowBranchToBranchTraffic": { "type": "boolean", "example": false }, "cloudType": { "type": "string" }, "description": { "type": "string" }, "id": { "type": "string" }, "name": { "maxLength": 80, "minLength": 1, "type": "string" }, "provisioningState": { "type": "string", "example": "PROVISIONED" }, "region": { "maxLength": 255, "minLength": 1, "type": "string" }, "resourceGroupName": { "maxLength": 80, "minLength": 1, "type": "string" }, "tagList": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string", "example": "mytag" } }, "description": "Azure Virtual WAN Tag Object", "$$ref": "#/components/schemas/AzureVirtualWanTagList" } }, "virtualWanType": { "type": "string" }, "vnetTovnetTrafficEnabled": { "type": "boolean", "example": false } }, "description": "Azure Virtual Wan", "$$ref": "#/components/schemas/AzureVirtualWan" }, "vWanInUse": { "type": "boolean", "example": false } }, "$$ref": "#/components/schemas/InlineResponse2009VWans" } } }, "$$ref": "#/components/schemas/InlineResponse2009" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/interconnect/cloud/{cloud-type}/accounts/{cloud-account-id}/vwans/{vwan-name}": { "delete": { "tags": [ "Multicloud Interconnect - Cloud Resource Management" ], "summary": "Delete an Azure Virtual Wan.", "description": "API to delete an Azure Virtual Wan.", "operationId": "deleteAzVirtualWan", "parameters": [ { "name": "cloud-type", "in": "path", "description": "Cloud Provider Type", "required": true, "schema": { "type": "string", "enum": [ "AWS", "AZURE", "GCP" ] } }, { "name": "cloud-account-id", "in": "path", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } }, { "name": "vwan-name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "resource-group", "in": "query", "description": "Azure cloud resource group name", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Accepted", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/interconnect/cloud/{cloud-type}/cloud-connectivity-gateways": { "get": { "tags": [ "Multicloud Interconnect - Cloud Resource Management" ], "summary": "Get all Cloud Connectivity Gateways.", "description": "API to retrieve all Cloud Connectivity Gateways.", "operationId": "getCloudConnectivityGateways", "parameters": [ { "name": "cloud-type", "in": "path", "description": "Cloud Provider Type", "required": true, "schema": { "type": "string", "enum": [ "AWS", "AZURE", "GCP" ] } }, { "name": "cloud-account-id", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "connectivity-gateway-name", "in": "query", "schema": { "type": "string" } }, { "name": "connectivity-gateway-type", "in": "query", "description": "Cloud Connectivity Gateway Type", "schema": { "type": "string", "enum": [ "DIRECT_CONNECT_GATEWAY", "VIRTUAL_PRIVATE_GATEWAY", "TRANSIT_GATEWAY", "VIRTUAL_INTERFACES", "EXPRESS_ROUTE_CIRCUIT", "GCR_ATTACHMENT" ] } }, { "name": "interconnect-type", "in": "query", "description": "Interconnect Provider Type", "schema": { "type": "string", "enum": [ "MEGAPORT", "EQUINIX" ] } }, { "name": "region", "in": "query", "schema": { "type": "string" } }, { "name": "network", "in": "query", "schema": { "type": "string" } }, { "name": "resource-state", "in": "query", "description": "resource state", "schema": { "type": "string" } }, { "name": "refresh", "in": "query", "schema": { "pattern": "(true|false)", "type": "string", "default": "false" } } ], "responses": { "200": { "description": "Accepted", "content": { "application/json": { "schema": { "type": "object", "properties": { "connectivityGateway": { "type": "array", "items": { "required": [ "awsConnectivityGateway", "azureConnectivityGateway", "cloudAccountId", "cloudType", "gatewayName", "gcpConnectivityGateway", "region" ], "type": "object", "properties": { "awsConnectivityGateway": { "required": [ "awsConnectivityType" ], "type": "object", "properties": { "awsConnectivityType": { "type": "string", "example": "DIRECT_CONNECT_GATEWAY" }, "directConnectGateway": { "required": [ "amazonSideAsn" ], "type": "object", "properties": { "amazonSideAsn": { "pattern": "^[1-9]\\d*$", "type": "string" }, "gatewayAssociationList": { "type": "array", "description": "List of associated Gateways", "items": { "type": "object", "properties": { "advertisedPrefixList": { "type": "array", "description": "Advertized prefix list", "example": [ "10.10.0.0/24", "10.20.0.0/24" ], "items": { "type": "string", "description": "prefix", "example": "10.10.0.0/24" } }, "associatedGateway": { "type": "object", "properties": { "cloudAccountId": { "type": "string" }, "cloudGatewayName": { "type": "string" }, "cloudType": { "type": "string", "enum": [ "AWS", "AWS_GOVCLOUD", "AZURE", "AZURE_GOVCLOUD", "GCP" ] }, "description": { "type": "string" }, "gatewayId": { "type": "string" }, "gatewayName": { "type": "string" }, "region": { "type": "string" } }, "description": "Cloud Connectivity Gateway Object", "$$ref": "#/components/schemas/GatewayAssociationAssociatedGateway" }, "associationAction": { "type": "string", "example": "ASSOCIATE", "enum": [ "ASSOCIATE", "DISASSOCIATE", "REMOVE_PREFIX_LIST", "NO_ACTION" ] }, "associationId": { "type": "string", "example": "12345" }, "associationState": { "type": "string", "example": "ASSOCIATED" }, "stateChangeError": { "type": "string" } }, "description": "Generic multicloud gateway association object", "$$ref": "#/components/schemas/GatewayAssociation" } }, "ownerAccount": { "type": "string" }, "virtualInterfaceAttachmentList": { "type": "array", "description": "List of virtual interfaces attached to DxGW", "items": { "type": "object", "properties": { "attachmentState": { "type": "string" }, "cloudType": { "type": "string", "enum": [ "AWS", "AWS_GOVCLOUD", "AZURE", "AZURE_GOVCLOUD", "GCP" ] }, "connectionId": { "type": "string", "description": "Id of the private cross connect", "example": "12345-1234-1234" }, "connectionType": { "type": "string", "description": "Type of AWS connection", "example": "HCONN", "enum": [ "HVIF", "HCONN" ] }, "ownerAccount": { "type": "string" }, "region": { "type": "string" }, "stateChangeError": { "type": "string" }, "virtualInterfaceData": { "type": "object", "properties": { "advertisedPrefixList": { "type": "array", "items": { "type": "string" } }, "asn": { "type": "integer", "format": "int64", "example": 65500 }, "bgpKey": { "type": "string", "example": "EC-12345678" }, "customerIpAddress": { "type": "string" }, "ipAddress": { "type": "string" }, "vlan": { "type": "integer", "format": "int64", "example": 45678 } }, "description": "VIrtual Interface Object", "$$ref": "#/components/schemas/AwsDirectConnectGatewayVirtualInterfaceData" }, "virtualInterfaceId": { "type": "string" }, "virtualInterfaceName": { "type": "string" }, "virtualInterfaceType": { "type": "string", "example": "TRANSIT", "enum": [ "TRANSIT", "PRIVATE", "PUBLIC", "ATTACHMENT" ] } }, "description": "Virtual Interface Object", "$$ref": "#/components/schemas/AwsDirectConnectGatewayVirtualInterfaceAttachmentList" } }, "vpcTagNamesForGatewayAssociations": { "type": "array", "description": "VPC Tags associated to the Direct Connect Gateway", "items": { "type": "string", "description": "VPC Tags associated to the Direct Connect Gateway" } } }, "description": "AWS Direct Connect Gateway specific Object.", "$$ref": "#/components/schemas/AwsDirectConnectGateway" }, "transitGateway": { "required": [ "amazonSideAsn" ], "type": "object", "properties": { "amazonSideAsn": { "pattern": "^[1-9]\\d*$", "type": "string" }, "associationDefaultRouteTableId": { "type": "string", "example": "tgw-rtb-07ace6b22f9de8502" }, "autoAcceptSharedAttachments": { "type": "boolean" }, "creationTime": { "type": "string", "example": "11-Jun-2022 (00:10:30:00000)" }, "defaultRouteTableAssociation": { "type": "boolean" }, "defaultRouteTablePropogation": { "type": "boolean" }, "dnsSupport": { "type": "boolean" }, "multicastSupport": { "type": "boolean" }, "ownerAccount": { "type": "string" }, "propogationDefaultRouteTableId": { "type": "string" }, "vpcAttachmentList": { "type": "array", "description": "List of VPC attachments", "items": { "type": "object", "properties": { "region": { "type": "string" }, "vpcId": { "type": "string", "description": "VPC Id", "example": "vpc-012345-2000" }, "vpcRoutePrefixList": { "type": "array", "description": "List of ip prefixes to be advertized towards DxGw on the VPC routing table.", "example": [ "198.18.0.4/30", "198.18.0.7/30" ], "items": { "type": "string", "description": "ip prefix", "example": "198.18.0.4/30" } }, "vpcState": { "type": "string" }, "vpcSubnetPrefixList": { "type": "array", "description": "List of VPC subnets to be added to DxGw association", "example": [ "10.10.0.0/24", "10.10.1.0/24" ], "items": { "type": "string", "description": "VPC subnet", "example": "10.10.0.0/24" } } }, "description": "AWS VPC attachment Object", "$$ref": "#/components/schemas/AwsVpcAttachments" } }, "vpnEcmpSupport": { "type": "boolean" } }, "description": "AWS Transit Gateway specific Object.", "$$ref": "#/components/schemas/AwsTransitGateway" }, "virtualPrivateGateway": { "type": "object", "properties": { "amazonSideAsn": { "type": "integer", "format": "int64" }, "availabilityZone": { "type": "string" }, "vpcAttachmentList": { "type": "array", "description": "List of VPC attachments", "items": { "type": "object", "properties": { "region": { "type": "string" }, "vpcId": { "type": "string", "description": "VPC Id", "example": "vpc-012345-2000" }, "vpcRoutePrefixList": { "type": "array", "description": "List of ip prefixes to be advertized towards DxGw on the VPC routing table.", "example": [ "198.18.0.4/30", "198.18.0.7/30" ], "items": { "type": "string", "description": "ip prefix", "example": "198.18.0.4/30" } }, "vpcState": { "type": "string" }, "vpcSubnetPrefixList": { "type": "array", "description": "List of VPC subnets to be added to DxGw association", "example": [ "10.10.0.0/24", "10.10.1.0/24" ], "items": { "type": "string", "description": "VPC subnet", "example": "10.10.0.0/24" } } }, "description": "AWS VPC attachment Object", "$$ref": "#/components/schemas/AwsVpcAttachments" } }, "vpgType": { "type": "string", "example": "ipsec.1" } }, "description": "AWS Virtual Private Gateway specific Object.", "$$ref": "#/components/schemas/AwsVirtualPrivateGateway" } }, "description": "AWS cloud Connectivity Gateway Object", "$$ref": "#/components/schemas/CloudConnectivityGatewayAws" }, "azureConnectivityGateway": { "required": [ "azureConnectivityType" ], "type": "object", "properties": { "azureConnectivityType": { "type": "string" }, "expressRouteCircuit": { "required": [ "resourceGroupName" ], "type": "object", "properties": { "allowClassicOperations": { "type": "boolean", "example": true }, "bandwidthInGbps": { "type": "integer", "format": "int32", "example": 200 }, "gatewayAssociationList": { "type": "array", "items": { "type": "object", "properties": { "advertisedPrefixList": { "type": "array", "description": "Advertized prefix list", "example": [ "10.10.0.0/24", "10.20.0.0/24" ], "items": { "type": "string", "description": "prefix", "example": "10.10.0.0/24" } }, "associatedGateway": { "type": "object", "properties": { "cloudAccountId": { "type": "string" }, "cloudGatewayName": { "type": "string" }, "cloudType": { "type": "string", "enum": [ "AWS", "AWS_GOVCLOUD", "AZURE", "AZURE_GOVCLOUD", "GCP" ] }, "description": { "type": "string" }, "gatewayId": { "type": "string" }, "gatewayName": { "type": "string" }, "region": { "type": "string" } }, "description": "Cloud Connectivity Gateway Object", "$$ref": "#/components/schemas/GatewayAssociationAssociatedGateway" }, "associationAction": { "type": "string", "example": "ASSOCIATE", "enum": [ "ASSOCIATE", "DISASSOCIATE", "REMOVE_PREFIX_LIST", "NO_ACTION" ] }, "associationId": { "type": "string", "example": "12345" }, "associationState": { "type": "string", "example": "ASSOCIATED" }, "stateChangeError": { "type": "string" } }, "description": "Generic multicloud gateway association object", "$$ref": "#/components/schemas/GatewayAssociation" } }, "globalReachEnabled": { "type": "boolean", "example": true }, "peeringList": { "type": "array", "items": { "type": "object", "properties": { "advertisedPublicPrefixList": { "type": "array", "items": { "type": "string" } }, "azureAsn": { "type": "string" }, "expressRouteConnectionId": { "type": "string", "example": "12345" }, "id": { "type": "string" }, "name": { "type": "string" }, "peerAsn": { "type": "string" }, "peeringState": { "type": "string", "example": "ENABLED", "enum": [ "DISABLED", "ENABLED" ] }, "peeringType": { "type": "string", "example": "PUBLIC", "enum": [ "PRIVATE", "PUBLIC" ] }, "primaryAzurePort": { "type": "string" }, "primaryPeerAddressPrefix": { "type": "string" }, "secondaryAzurePort": { "type": "string" }, "secondaryPeerAddressPrefix": { "type": "string" }, "sharedKey": { "type": "string", "description": "BGP Peering Key", "example": "EC-12345" }, "vlanId": { "type": "integer", "format": "int64", "example": 1618 } }, "description": "Azure Express Route Circuit Peering", "$$ref": "#/components/schemas/AzureERCPeering" } }, "provisioningState": { "type": "string", "example": "PROVISIONED" }, "resourceGroupName": { "type": "string" }, "serviceKey": { "type": "string" }, "serviceProviderProperties": { "type": "object", "properties": { "bandwidthInMbps": { "type": "integer", "format": "int64", "example": 1000 }, "peeringLocation": { "type": "string", "example": "New York" }, "serviceProviderName": { "type": "string" } }, "description": "Azure Express Route Circuit Service Provider Properties", "$$ref": "#/components/schemas/AzureERCServiceProviderProperties" }, "serviceProviderProvisioningState": { "type": "string", "enum": [ "DEPROVISIONING", "NOT_PROVISIONED", "PROVISIONED", "PROVISIONING" ] }, "sku": { "required": [ "family", "tier" ], "type": "object", "properties": { "family": { "type": "string" }, "name": { "type": "string" }, "tier": { "type": "string", "example": "STANDARD" } }, "description": "Express Route Circuit SKU", "$$ref": "#/components/schemas/AzureExpressRouteCircuitSku" }, "vWanAttachmentList": { "type": "array", "items": { "type": "object", "properties": { "vHubList": { "type": "array", "items": { "type": "object", "properties": { "isDelete": { "type": "boolean", "example": true }, "vHub": { "type": "object", "properties": { "accountId": { "type": "string" }, "accountName": { "type": "string" }, "addressPrefix": { "type": "string" }, "cloudType": { "type": "string", "enum": [ "AWS", "AWS_GOVCLOUD", "AZURE", "AZURE_GOVCLOUD", "GCP" ] }, "id": { "type": "string" }, "name": { "type": "string" }, "provisioningState": { "type": "string", "example": "PROVISIONED" }, "region": { "type": "string" }, "resourceGroupName": { "type": "string" }, "routingState": { "type": "string" }, "sku": { "type": "string", "example": "STANDARD" }, "tagList": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string", "example": "mytag" } }, "description": "Azure Virtual WAN Tag Object", "$$ref": "#/components/schemas/AzureVirtualWanTagList" } }, "virtualRouterAsn": { "type": "string" }, "virtualRouterIp": { "type": "array", "items": { "type": "object", "properties": { "privateIp": { "type": "string" } }, "description": "Virtual Router IP", "$$ref": "#/components/schemas/AzureVirtualHubVirtualRouterIp" } }, "vwanName": { "type": "string" } }, "description": "Azure Virtual Hub", "$$ref": "#/components/schemas/AzureVirtualHub" } }, "$$ref": "#/components/schemas/AzureExpressRouteCircuitVHubList" } }, "vWan": { "required": [ "name", "region", "resourceGroupName" ], "type": "object", "properties": { "accountId": { "maxLength": 255, "minLength": 1, "type": "string" }, "accountName": { "type": "string", "description": "Cloud account name", "example": "my-cloud-account" }, "allowBranchToBranchTraffic": { "type": "boolean", "example": false }, "cloudType": { "type": "string" }, "description": { "type": "string" }, "id": { "type": "string" }, "name": { "maxLength": 80, "minLength": 1, "type": "string" }, "provisioningState": { "type": "string", "example": "PROVISIONED" }, "region": { "maxLength": 255, "minLength": 1, "type": "string" }, "resourceGroupName": { "maxLength": 80, "minLength": 1, "type": "string" }, "tagList": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string", "example": "mytag" } }, "description": "Azure Virtual WAN Tag Object", "$$ref": "#/components/schemas/AzureVirtualWanTagList" } }, "virtualWanType": { "type": "string" }, "vnetTovnetTrafficEnabled": { "type": "boolean", "example": false } }, "description": "Azure Virtual Wan", "$$ref": "#/components/schemas/AzureVirtualWan" } }, "description": "vWan Attachment Name", "$$ref": "#/components/schemas/AzureExpressRouteCircuitVWanAttachmentList" } }, "vnetTagNamesForConnections": { "type": "array", "items": { "type": "object", "properties": { "isDelete": { "type": "boolean", "example": true }, "vnetTagName": { "type": "string" } }, "description": "Vnet Tag Object Names", "$$ref": "#/components/schemas/AzureExpressRouteCircuitVnetTagNamesForConnections" } } }, "description": "Azure Express Route Circuit Object", "$$ref": "#/components/schemas/AzureExpressRouteCircuit" }, "expressRouteGateway": { "type": "object", "properties": { "autoScaleConfiguration": { "type": "string" }, "resourceGroupName": { "type": "string" }, "vHubId": { "type": "string", "description": "Id of the Azure vHUB.", "example": "vhub-1234" } }, "description": "Azure Express Route Gateway Object", "$$ref": "#/components/schemas/AzureExpressRouteGateway" }, "virtualNetworkGateway": { "type": "object", "properties": { "enableBgp": { "type": "boolean", "example": true }, "publicIPAddress": { "type": "string" }, "sku": { "type": "object", "properties": { "capacity": { "type": "integer", "format": "int32", "example": 100 }, "name": { "type": "string" }, "tier": { "type": "string", "example": "STANDARD" } }, "description": "VNET Gateway SKU parameters", "$$ref": "#/components/schemas/AzureVirtualNetworkGatewaySku" }, "subnet": { "type": "string" }, "virtualNetworkGatewayType": { "type": "string", "example": "EXPRESS_ROUTE", "enum": [ "VPN", "EXPRESS_ROUTE" ] } }, "description": "Azure Virtual Network Gateway Object", "$$ref": "#/components/schemas/AzureVirtualNetworkGateway" } }, "description": "Cloud Connectivity Gateway Object", "$$ref": "#/components/schemas/CloudConnectivityGatewayAzure" }, "cloudAccountId": { "type": "string" }, "cloudGatewayName": { "type": "string" }, "cloudType": { "type": "string" }, "connectivityGatewayState": { "type": "string" }, "description": { "type": "string" }, "gatewayId": { "type": "string" }, "gatewayName": { "type": "string" }, "gcpConnectivityGateway": { "required": [ "gcConnectivityType", "routerInfo" ], "type": "object", "properties": { "gcConnectivityType": { "type": "string", "example": "GCR_ATTACHMENT" }, "interconnectAsn": { "pattern": "\\d+", "type": "string", "description": "BGP ASN assigned to Interconnect Gateway.", "example": "64500" }, "pairingKey": { "type": "string", "example": "96fbc59c-8926-40ec-b6cd-4cb3501e4c47/us-west1/1" }, "routerInfo": { "required": [ "name", "network" ], "type": "object", "properties": { "attachmentDetails": { "type": "array", "description": "List of GCR Attachments", "items": { "type": "object", "properties": { "cloudRouterIpAddress": { "type": "string" }, "customerIpAddress": { "type": "string" }, "id": { "type": "string" }, "mtu": { "type": "string", "description": "MTU of the Interconnect attachment", "example": "1500" }, "name": { "pattern": "(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)", "type": "string" }, "pairingKey": { "type": "string", "example": "96fbc59c-8926-40ec-b6cd-4cb3501e4c47/us-west1/1" }, "region": { "type": "string" }, "secondaryZone": { "type": "string", "description": "Option to create Interconnect attachment in secondary zone", "example": "true" }, "state": { "type": "string" } }, "description": "Google cloud Interconnect Attachment Object.", "$$ref": "#/components/schemas/GcpInterconnectAttachment" } }, "cloudRouterAsn": { "pattern": "\\d+", "type": "string" }, "id": { "type": "string" }, "name": { "pattern": "(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)", "type": "string" }, "network": { "type": "string" }, "region": { "type": "string" } }, "description": "Google cloud GCR Object.", "$$ref": "#/components/schemas/GcpCloudRouter" } }, "description": "Google cloud Connectivity Gateway Object.", "$$ref": "#/components/schemas/CloudConnectivityGatewayGcp" }, "isVmanageCreated": { "type": "boolean", "description": "Resource created by vManage", "example": true }, "newFormat": { "type": "boolean", "description": "Option indicates object type", "example": true }, "region": { "type": "string" } }, "description": "Cloud Connectivity Gateway Object", "$$ref": "#/components/schemas/CloudConnectivityGateway" } } }, "description": "Cloud Connectivity Gateway Object", "$$ref": "#/components/schemas/InlineResponse2008" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Multicloud Interconnect - Cloud Resource Management" ], "summary": "Create a Cloud Connectivity Gateway.", "description": "API to create a Cloud Connectivity Gateway such as Direct Connect Gateway, Express Route Circuit or Google Cloud routers.", "operationId": "addCloudConnectivityGateway", "parameters": [ { "name": "cloud-type", "in": "path", "description": "Cloud Provider Type", "required": true, "schema": { "type": "string", "enum": [ "AWS", "AZURE", "GCP" ] } } ], "requestBody": { "description": "Request Payload for Multicloud Interconnect Cloud Connectivity Gateways", "content": { "application/json": { "schema": { "required": [ "awsConnectivityGateway", "azureConnectivityGateway", "cloudAccountId", "cloudType", "gatewayName", "gcpConnectivityGateway", "region" ], "type": "object", "properties": { "awsConnectivityGateway": { "required": [ "awsConnectivityType" ], "type": "object", "properties": { "awsConnectivityType": { "type": "string", "example": "DIRECT_CONNECT_GATEWAY" }, "directConnectGateway": { "required": [ "amazonSideAsn" ], "type": "object", "properties": { "amazonSideAsn": { "pattern": "^[1-9]\\d*$", "type": "string" }, "gatewayAssociationList": { "type": "array", "description": "List of associated Gateways", "items": { "type": "object", "properties": { "advertisedPrefixList": { "type": "array", "description": "Advertized prefix list", "example": [ "10.10.0.0/24", "10.20.0.0/24" ], "items": { "type": "string", "description": "prefix", "example": "10.10.0.0/24" } }, "associatedGateway": { "type": "object", "properties": { "cloudAccountId": { "type": "string" }, "cloudGatewayName": { "type": "string" }, "cloudType": { "type": "string", "enum": [ "AWS", "AWS_GOVCLOUD", "AZURE", "AZURE_GOVCLOUD", "GCP" ] }, "description": { "type": "string" }, "gatewayId": { "type": "string" }, "gatewayName": { "type": "string" }, "region": { "type": "string" } }, "description": "Cloud Connectivity Gateway Object", "$$ref": "#/components/schemas/GatewayAssociationAssociatedGateway" }, "associationAction": { "type": "string", "example": "ASSOCIATE", "enum": [ "ASSOCIATE", "DISASSOCIATE", "REMOVE_PREFIX_LIST", "NO_ACTION" ] }, "associationId": { "type": "string", "example": "12345" }, "associationState": { "type": "string", "example": "ASSOCIATED" }, "stateChangeError": { "type": "string" } }, "description": "Generic multicloud gateway association object", "$$ref": "#/components/schemas/GatewayAssociation" } }, "ownerAccount": { "type": "string" }, "virtualInterfaceAttachmentList": { "type": "array", "description": "List of virtual interfaces attached to DxGW", "items": { "type": "object", "properties": { "attachmentState": { "type": "string" }, "cloudType": { "type": "string", "enum": [ "AWS", "AWS_GOVCLOUD", "AZURE", "AZURE_GOVCLOUD", "GCP" ] }, "connectionId": { "type": "string", "description": "Id of the private cross connect", "example": "12345-1234-1234" }, "connectionType": { "type": "string", "description": "Type of AWS connection", "example": "HCONN", "enum": [ "HVIF", "HCONN" ] }, "ownerAccount": { "type": "string" }, "region": { "type": "string" }, "stateChangeError": { "type": "string" }, "virtualInterfaceData": { "type": "object", "properties": { "advertisedPrefixList": { "type": "array", "items": { "type": "string" } }, "asn": { "type": "integer", "format": "int64", "example": 65500 }, "bgpKey": { "type": "string", "example": "EC-12345678" }, "customerIpAddress": { "type": "string" }, "ipAddress": { "type": "string" }, "vlan": { "type": "integer", "format": "int64", "example": 45678 } }, "description": "VIrtual Interface Object", "$$ref": "#/components/schemas/AwsDirectConnectGatewayVirtualInterfaceData" }, "virtualInterfaceId": { "type": "string" }, "virtualInterfaceName": { "type": "string" }, "virtualInterfaceType": { "type": "string", "example": "TRANSIT", "enum": [ "TRANSIT", "PRIVATE", "PUBLIC", "ATTACHMENT" ] } }, "description": "Virtual Interface Object", "$$ref": "#/components/schemas/AwsDirectConnectGatewayVirtualInterfaceAttachmentList" } }, "vpcTagNamesForGatewayAssociations": { "type": "array", "description": "VPC Tags associated to the Direct Connect Gateway", "items": { "type": "string", "description": "VPC Tags associated to the Direct Connect Gateway" } } }, "description": "AWS Direct Connect Gateway specific Object.", "$$ref": "#/components/schemas/AwsDirectConnectGateway" }, "transitGateway": { "required": [ "amazonSideAsn" ], "type": "object", "properties": { "amazonSideAsn": { "pattern": "^[1-9]\\d*$", "type": "string" }, "associationDefaultRouteTableId": { "type": "string", "example": "tgw-rtb-07ace6b22f9de8502" }, "autoAcceptSharedAttachments": { "type": "boolean" }, "creationTime": { "type": "string", "example": "11-Jun-2022 (00:10:30:00000)" }, "defaultRouteTableAssociation": { "type": "boolean" }, "defaultRouteTablePropogation": { "type": "boolean" }, "dnsSupport": { "type": "boolean" }, "multicastSupport": { "type": "boolean" }, "ownerAccount": { "type": "string" }, "propogationDefaultRouteTableId": { "type": "string" }, "vpcAttachmentList": { "type": "array", "description": "List of VPC attachments", "items": { "type": "object", "properties": { "region": { "type": "string" }, "vpcId": { "type": "string", "description": "VPC Id", "example": "vpc-012345-2000" }, "vpcRoutePrefixList": { "type": "array", "description": "List of ip prefixes to be advertized towards DxGw on the VPC routing table.", "example": [ "198.18.0.4/30", "198.18.0.7/30" ], "items": { "type": "string", "description": "ip prefix", "example": "198.18.0.4/30" } }, "vpcState": { "type": "string" }, "vpcSubnetPrefixList": { "type": "array", "description": "List of VPC subnets to be added to DxGw association", "example": [ "10.10.0.0/24", "10.10.1.0/24" ], "items": { "type": "string", "description": "VPC subnet", "example": "10.10.0.0/24" } } }, "description": "AWS VPC attachment Object", "$$ref": "#/components/schemas/AwsVpcAttachments" } }, "vpnEcmpSupport": { "type": "boolean" } }, "description": "AWS Transit Gateway specific Object.", "$$ref": "#/components/schemas/AwsTransitGateway" }, "virtualPrivateGateway": { "type": "object", "properties": { "amazonSideAsn": { "type": "integer", "format": "int64" }, "availabilityZone": { "type": "string" }, "vpcAttachmentList": { "type": "array", "description": "List of VPC attachments", "items": { "type": "object", "properties": { "region": { "type": "string" }, "vpcId": { "type": "string", "description": "VPC Id", "example": "vpc-012345-2000" }, "vpcRoutePrefixList": { "type": "array", "description": "List of ip prefixes to be advertized towards DxGw on the VPC routing table.", "example": [ "198.18.0.4/30", "198.18.0.7/30" ], "items": { "type": "string", "description": "ip prefix", "example": "198.18.0.4/30" } }, "vpcState": { "type": "string" }, "vpcSubnetPrefixList": { "type": "array", "description": "List of VPC subnets to be added to DxGw association", "example": [ "10.10.0.0/24", "10.10.1.0/24" ], "items": { "type": "string", "description": "VPC subnet", "example": "10.10.0.0/24" } } }, "description": "AWS VPC attachment Object", "$$ref": "#/components/schemas/AwsVpcAttachments" } }, "vpgType": { "type": "string", "example": "ipsec.1" } }, "description": "AWS Virtual Private Gateway specific Object.", "$$ref": "#/components/schemas/AwsVirtualPrivateGateway" } }, "description": "AWS cloud Connectivity Gateway Object", "$$ref": "#/components/schemas/CloudConnectivityGatewayAws" }, "azureConnectivityGateway": { "required": [ "azureConnectivityType" ], "type": "object", "properties": { "azureConnectivityType": { "type": "string" }, "expressRouteCircuit": { "required": [ "resourceGroupName" ], "type": "object", "properties": { "allowClassicOperations": { "type": "boolean", "example": true }, "bandwidthInGbps": { "type": "integer", "format": "int32", "example": 200 }, "gatewayAssociationList": { "type": "array", "items": { "type": "object", "properties": { "advertisedPrefixList": { "type": "array", "description": "Advertized prefix list", "example": [ "10.10.0.0/24", "10.20.0.0/24" ], "items": { "type": "string", "description": "prefix", "example": "10.10.0.0/24" } }, "associatedGateway": { "type": "object", "properties": { "cloudAccountId": { "type": "string" }, "cloudGatewayName": { "type": "string" }, "cloudType": { "type": "string", "enum": [ "AWS", "AWS_GOVCLOUD", "AZURE", "AZURE_GOVCLOUD", "GCP" ] }, "description": { "type": "string" }, "gatewayId": { "type": "string" }, "gatewayName": { "type": "string" }, "region": { "type": "string" } }, "description": "Cloud Connectivity Gateway Object", "$$ref": "#/components/schemas/GatewayAssociationAssociatedGateway" }, "associationAction": { "type": "string", "example": "ASSOCIATE", "enum": [ "ASSOCIATE", "DISASSOCIATE", "REMOVE_PREFIX_LIST", "NO_ACTION" ] }, "associationId": { "type": "string", "example": "12345" }, "associationState": { "type": "string", "example": "ASSOCIATED" }, "stateChangeError": { "type": "string" } }, "description": "Generic multicloud gateway association object", "$$ref": "#/components/schemas/GatewayAssociation" } }, "globalReachEnabled": { "type": "boolean", "example": true }, "peeringList": { "type": "array", "items": { "type": "object", "properties": { "advertisedPublicPrefixList": { "type": "array", "items": { "type": "string" } }, "azureAsn": { "type": "string" }, "expressRouteConnectionId": { "type": "string", "example": "12345" }, "id": { "type": "string" }, "name": { "type": "string" }, "peerAsn": { "type": "string" }, "peeringState": { "type": "string", "example": "ENABLED", "enum": [ "DISABLED", "ENABLED" ] }, "peeringType": { "type": "string", "example": "PUBLIC", "enum": [ "PRIVATE", "PUBLIC" ] }, "primaryAzurePort": { "type": "string" }, "primaryPeerAddressPrefix": { "type": "string" }, "secondaryAzurePort": { "type": "string" }, "secondaryPeerAddressPrefix": { "type": "string" }, "sharedKey": { "type": "string", "description": "BGP Peering Key", "example": "EC-12345" }, "vlanId": { "type": "integer", "format": "int64", "example": 1618 } }, "description": "Azure Express Route Circuit Peering", "$$ref": "#/components/schemas/AzureERCPeering" } }, "provisioningState": { "type": "string", "example": "PROVISIONED" }, "resourceGroupName": { "type": "string" }, "serviceKey": { "type": "string" }, "serviceProviderProperties": { "type": "object", "properties": { "bandwidthInMbps": { "type": "integer", "format": "int64", "example": 1000 }, "peeringLocation": { "type": "string", "example": "New York" }, "serviceProviderName": { "type": "string" } }, "description": "Azure Express Route Circuit Service Provider Properties", "$$ref": "#/components/schemas/AzureERCServiceProviderProperties" }, "serviceProviderProvisioningState": { "type": "string", "enum": [ "DEPROVISIONING", "NOT_PROVISIONED", "PROVISIONED", "PROVISIONING" ] }, "sku": { "required": [ "family", "tier" ], "type": "object", "properties": { "family": { "type": "string" }, "name": { "type": "string" }, "tier": { "type": "string", "example": "STANDARD" } }, "description": "Express Route Circuit SKU", "$$ref": "#/components/schemas/AzureExpressRouteCircuitSku" }, "vWanAttachmentList": { "type": "array", "items": { "type": "object", "properties": { "vHubList": { "type": "array", "items": { "type": "object", "properties": { "isDelete": { "type": "boolean", "example": true }, "vHub": { "type": "object", "properties": { "accountId": { "type": "string" }, "accountName": { "type": "string" }, "addressPrefix": { "type": "string" }, "cloudType": { "type": "string", "enum": [ "AWS", "AWS_GOVCLOUD", "AZURE", "AZURE_GOVCLOUD", "GCP" ] }, "id": { "type": "string" }, "name": { "type": "string" }, "provisioningState": { "type": "string", "example": "PROVISIONED" }, "region": { "type": "string" }, "resourceGroupName": { "type": "string" }, "routingState": { "type": "string" }, "sku": { "type": "string", "example": "STANDARD" }, "tagList": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string", "example": "mytag" } }, "description": "Azure Virtual WAN Tag Object", "$$ref": "#/components/schemas/AzureVirtualWanTagList" } }, "virtualRouterAsn": { "type": "string" }, "virtualRouterIp": { "type": "array", "items": { "type": "object", "properties": { "privateIp": { "type": "string" } }, "description": "Virtual Router IP", "$$ref": "#/components/schemas/AzureVirtualHubVirtualRouterIp" } }, "vwanName": { "type": "string" } }, "description": "Azure Virtual Hub", "$$ref": "#/components/schemas/AzureVirtualHub" } }, "$$ref": "#/components/schemas/AzureExpressRouteCircuitVHubList" } }, "vWan": { "required": [ "name", "region", "resourceGroupName" ], "type": "object", "properties": { "accountId": { "maxLength": 255, "minLength": 1, "type": "string" }, "accountName": { "type": "string", "description": "Cloud account name", "example": "my-cloud-account" }, "allowBranchToBranchTraffic": { "type": "boolean", "example": false }, "cloudType": { "type": "string" }, "description": { "type": "string" }, "id": { "type": "string" }, "name": { "maxLength": 80, "minLength": 1, "type": "string" }, "provisioningState": { "type": "string", "example": "PROVISIONED" }, "region": { "maxLength": 255, "minLength": 1, "type": "string" }, "resourceGroupName": { "maxLength": 80, "minLength": 1, "type": "string" }, "tagList": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string", "example": "mytag" } }, "description": "Azure Virtual WAN Tag Object", "$$ref": "#/components/schemas/AzureVirtualWanTagList" } }, "virtualWanType": { "type": "string" }, "vnetTovnetTrafficEnabled": { "type": "boolean", "example": false } }, "description": "Azure Virtual Wan", "$$ref": "#/components/schemas/AzureVirtualWan" } }, "description": "vWan Attachment Name", "$$ref": "#/components/schemas/AzureExpressRouteCircuitVWanAttachmentList" } }, "vnetTagNamesForConnections": { "type": "array", "items": { "type": "object", "properties": { "isDelete": { "type": "boolean", "example": true }, "vnetTagName": { "type": "string" } }, "description": "Vnet Tag Object Names", "$$ref": "#/components/schemas/AzureExpressRouteCircuitVnetTagNamesForConnections" } } }, "description": "Azure Express Route Circuit Object", "$$ref": "#/components/schemas/AzureExpressRouteCircuit" }, "expressRouteGateway": { "type": "object", "properties": { "autoScaleConfiguration": { "type": "string" }, "resourceGroupName": { "type": "string" }, "vHubId": { "type": "string", "description": "Id of the Azure vHUB.", "example": "vhub-1234" } }, "description": "Azure Express Route Gateway Object", "$$ref": "#/components/schemas/AzureExpressRouteGateway" }, "virtualNetworkGateway": { "type": "object", "properties": { "enableBgp": { "type": "boolean", "example": true }, "publicIPAddress": { "type": "string" }, "sku": { "type": "object", "properties": { "capacity": { "type": "integer", "format": "int32", "example": 100 }, "name": { "type": "string" }, "tier": { "type": "string", "example": "STANDARD" } }, "description": "VNET Gateway SKU parameters", "$$ref": "#/components/schemas/AzureVirtualNetworkGatewaySku" }, "subnet": { "type": "string" }, "virtualNetworkGatewayType": { "type": "string", "example": "EXPRESS_ROUTE", "enum": [ "VPN", "EXPRESS_ROUTE" ] } }, "description": "Azure Virtual Network Gateway Object", "$$ref": "#/components/schemas/AzureVirtualNetworkGateway" } }, "description": "Cloud Connectivity Gateway Object", "$$ref": "#/components/schemas/CloudConnectivityGatewayAzure" }, "cloudAccountId": { "type": "string" }, "cloudGatewayName": { "type": "string" }, "cloudType": { "type": "string" }, "connectivityGatewayState": { "type": "string" }, "description": { "type": "string" }, "gatewayId": { "type": "string" }, "gatewayName": { "type": "string" }, "gcpConnectivityGateway": { "required": [ "gcConnectivityType", "routerInfo" ], "type": "object", "properties": { "gcConnectivityType": { "type": "string", "example": "GCR_ATTACHMENT" }, "interconnectAsn": { "pattern": "\\d+", "type": "string", "description": "BGP ASN assigned to Interconnect Gateway.", "example": "64500" }, "pairingKey": { "type": "string", "example": "96fbc59c-8926-40ec-b6cd-4cb3501e4c47/us-west1/1" }, "routerInfo": { "required": [ "name", "network" ], "type": "object", "properties": { "attachmentDetails": { "type": "array", "description": "List of GCR Attachments", "items": { "type": "object", "properties": { "cloudRouterIpAddress": { "type": "string" }, "customerIpAddress": { "type": "string" }, "id": { "type": "string" }, "mtu": { "type": "string", "description": "MTU of the Interconnect attachment", "example": "1500" }, "name": { "pattern": "(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)", "type": "string" }, "pairingKey": { "type": "string", "example": "96fbc59c-8926-40ec-b6cd-4cb3501e4c47/us-west1/1" }, "region": { "type": "string" }, "secondaryZone": { "type": "string", "description": "Option to create Interconnect attachment in secondary zone", "example": "true" }, "state": { "type": "string" } }, "description": "Google cloud Interconnect Attachment Object.", "$$ref": "#/components/schemas/GcpInterconnectAttachment" } }, "cloudRouterAsn": { "pattern": "\\d+", "type": "string" }, "id": { "type": "string" }, "name": { "pattern": "(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)", "type": "string" }, "network": { "type": "string" }, "region": { "type": "string" } }, "description": "Google cloud GCR Object.", "$$ref": "#/components/schemas/GcpCloudRouter" } }, "description": "Google cloud Connectivity Gateway Object.", "$$ref": "#/components/schemas/CloudConnectivityGatewayGcp" }, "isVmanageCreated": { "type": "boolean", "description": "Resource created by vManage", "example": true }, "newFormat": { "type": "boolean", "description": "Option indicates object type", "example": true }, "region": { "type": "string" } }, "description": "Cloud Connectivity Gateway Object", "$$ref": "#/components/schemas/CloudConnectivityGateway" }, "examples": { "AWS Direct Connect Gateway": { "description": "AWS Direct Connect Gateway", "value": "{\n \"gatewayName\": \"resource-name\",\n \"description\": \"This is my resource\",\n \"cloudType\": \"AWS\",\n \"cloudAccountId\": \"ABCD-1234-CDEF\",\n \"region\": \"My AWS region\",\n \"cloudGatewayName\": \"my-mc-cloud-gateway\",\n \"awsConnectivityGateway\": {\n \"awsConnectivityType\": \"DIRECT_CONNECT_GATEWAY\",\n \"directConnectGateway\": {\n \"amazonSideAsn\": 64515,\n }\n }\n}" }, "AWS Virtual Private Gateway": { "description": "AWS Virtual Private Gateway", "value": "{\n \"gatewayName\": \"resource-name\",\n \"description\": \"This is my resource\",\n \"cloudType\": \"AWS\",\n \"cloudAccountId\": \"ABCD-1234-CDEF\",\n \"region\": \"My AWS region\",\n \"cloudGatewayName\": \"my-mc-cloud-gateway\",\n \"awsConnectivityGateway\": {\n \"awsConnectivityType\": \"VIRTUAL_PRIVATE_GATEWAY\",\n \"virtualPrivateGateway\": {\n \"availabilityZone\": \"\",\n \"vpgType\": \"ipsec.1\",\n \"amazonSideAsn\": 64515\n },\n }\n}" }, "AWS Transit Gateway": { "description": "AWS Transit Gateway", "value": { "gatewayName": "resource-name", "description": "This is my resource", "cloudType": "AWS", "cloudAccountId": "ABCD-1234-CDEF", "region": "My AWS region", "cloudGatewayName": "my-mc-cloud-gateway", "awsConnectivityGateway": { "awsConnectivityType": "TRANSIT_GATEWAY", "transitGateway": { "amazonSideAsn": 64515 } } } }, "AZURE Express Route Circuit": { "description": "AZURE Express Route Circuit", "value": { "gatewayName": "resource-name", "description": "This is my resource", "cloudType": "AZURE", "cloudAccountId": "ABCD-1234-CDEF", "region": "My Azure region", "azureConnectivityGateway": { "azureConnectivityType": "EXPRESS_ROUTE_CIRCUIT", "expressRouteCircuit": { "resourceGroupName": "az-resource-group", "allowClassicOperations": true, "globalReachEnabled": true, "bandwidthInGbps": 200, "sku": { "name": "resource-name", "tier": "STANDARD", "family": "METERED_DATA" }, "serviceProviderProperties": { "serviceProviderName": "Equinix", "peeringLocation": "New York", "bandwidthInMbps": 200 } } } } }, "AZURE Express Route Gateway": { "description": "AZURE Express Route Gateway", "value": { "gatewayName": "resource-name", "description": "This is my resource", "cloudType": "AZURE", "cloudAccountId": "ABCD-1234-CDEF", "region": "My Azure region", "azureConnectivityGateway": { "azureConnectivityType": "EXPRESS_ROUTE_GATEWAY", "expressRouteGateway": { "resourceGroupName": "az-resource-group", "vHubId": "vhub-1234" } } } }, "AZURE Virtual Network Gateway": { "description": "AZURE Virtual Network Gateway", "value": { "gatewayName": "resource-name", "description": "This is my resource", "cloudType": "AZURE", "cloudAccountId": "ABCD-1234-CDEF", "region": "My Azure region", "azureConnectivityGateway": { "azureConnectivityType": "VIRTUAL_NETWORK_GATEWAY", "virtualNetworkGateway": { "virtualNetworkGatewayType": "EXPRESS_ROUTE", "enableBgp": true, "subnet": "192.168.10.0/24", "publicIPAddress": "198.18.0.34/30", "sku": { "name": "resource-name", "tier": "STANDARD", "capacity": 100 } } } } }, "Google Cloud Router and Attachments": { "description": "Google Cloud Router and Attachments", "value": { "gatewayName": "resource-name", "description": "This is my resource", "cloudType": "GCP", "cloudAccountId": "ABCD-1234-CDEF", "region": "My GCP region", "gcpConnectivityGateway": { "gcConnectivityType": "GCR_ATTACHMENT", "routerInfo": { "name": "resource-name", "region": "My GCP region", "network": "my-vpc-network", "attachmentDetails": [ { "name": "resource-name", "region": "My GCP region", "secondaryZone": true } ] } } } } } } }, "required": true }, "responses": { "200": { "description": "Accepted", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Multicloud Interconnect - Cloud Resource Management" ], "summary": "Delete Cloud Connectivity Gateways by type.", "description": "API to delete Cloud Connectivity Gateways by type.", "operationId": "deleteCloudConnectivityGateways", "parameters": [ { "name": "cloud-type", "in": "path", "description": "Cloud Provider Type", "required": true, "schema": { "type": "string", "enum": [ "AWS", "AZURE", "GCP" ] } }, { "name": "connectivity-gateway-type", "in": "query", "description": "Cloud Connectivity Gateway Type", "schema": { "type": "string", "enum": [ "DIRECT_CONNECT_GATEWAY", "VIRTUAL_PRIVATE_GATEWAY", "TRANSIT_GATEWAY", "VIRTUAL_INTERFACES", "EXPRESS_ROUTE_CIRCUIT", "GCR_ATTACHMENT" ] } } ], "responses": { "200": { "description": "Accepted", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/interconnect/cloud/{cloud-type}/cloud-connectivity-gateways/create-options": { "get": { "tags": [ "Multicloud Interconnect - Cloud Resource Management" ], "summary": "Get Cloud Connectivity Gateway create Options.", "description": "API to retrieve Cloud Connectivity Gateway create options.", "operationId": "getCloudConnectivityGatewayCreateOptions", "parameters": [ { "name": "cloud-type", "in": "path", "description": "Cloud Provider Type", "required": true, "schema": { "type": "string" } }, { "name": "cloud-account-id", "in": "query", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } }, { "name": "connectivity-gateway-type", "in": "query", "description": "Cloud Connectivity Gateway Type", "schema": { "type": "string", "enum": [ "DIRECT_CONNECT_GATEWAY", "VIRTUAL_PRIVATE_GATEWAY", "TRANSIT_GATEWAY", "VIRTUAL_INTERFACES", "EXPRESS_ROUTE_CIRCUIT", "GCR_ATTACHMENT" ] } }, { "name": "refresh", "in": "query", "schema": { "pattern": "(true|false)", "type": "string", "default": "false" } } ], "responses": { "200": { "description": "Cloud Connectivity Gateway Create Options Response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "creationOptions": { "type": "object", "properties": { "expressRouteCircuitServiceProviderList": { "type": "array", "items": { "type": "object", "properties": { "bandwidthsOffered": { "type": "array", "example": [ 50, 100, 200 ], "items": { "type": "integer", "format": "int64" } }, "id": { "type": "string" }, "location": { "type": "string" }, "name": { "type": "string" }, "peeringLocations": { "type": "array", "items": { "type": "string" } }, "provisioningState": { "type": "string", "description": "Provisioning state of the resource", "example": "Succeeded" }, "type": { "type": "string", "description": "Type of Resource", "example": "/subscriptions//resourceGroups//providers/Microsoft.Network/expressRouteServiceProviders/" } }, "$$ref": "#/components/schemas/InlineResponse20014CreationOptionsExpressRouteCircuitServiceProviderList" } }, "resourceGroupList": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "location": { "type": "string" }, "name": { "type": "string" } }, "$$ref": "#/components/schemas/InlineResponse20014CreationOptionsResourceGroupList" } } }, "$$ref": "#/components/schemas/InlineResponse20014CreationOptions" } }, "$$ref": "#/components/schemas/InlineResponse20014" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/interconnect/cloud/{cloud-type}/cloud-connectivity-gateways/{connectivity-gateway-name}": { "delete": { "tags": [ "Multicloud Interconnect - Cloud Resource Management" ], "summary": "Delete a Cloud Connectivity Gateway.", "description": "API to delete a Cloud Connectivity Gateway.", "operationId": "deleteCloudConnectivityGateway", "parameters": [ { "name": "connectivity-gateway-name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "cloud-type", "in": "path", "description": "Cloud Provider Type", "required": true, "schema": { "type": "string", "enum": [ "AWS", "AZURE", "GCP" ] } }, { "name": "connectivity-gateway-type", "in": "query", "description": "Cloud Connectivity Gateway Type", "schema": { "type": "string", "enum": [ "DIRECT_CONNECT_GATEWAY", "VIRTUAL_PRIVATE_GATEWAY", "TRANSIT_GATEWAY", "VIRTUAL_INTERFACES", "EXPRESS_ROUTE_CIRCUIT", "GCR_ATTACHMENT" ] } } ], "responses": { "200": { "description": "Accepted", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/interconnect/colors/{tunnel-type}": { "get": { "tags": [ "Multicloud Interconnect - Global Settings" ], "summary": "Get supported Colors for Interconnect tunnel type.", "description": "API to retrieve supported Colors for Interconnect tunnel type.", "operationId": "getInterconnectColors", "parameters": [ { "name": "tunnel-type", "in": "path", "description": "Interconnect Loopback Tunnel Type", "required": true, "schema": { "type": "string", "enum": [ "loopbackTransit", "loopbackCgw" ] } } ], "responses": { "200": { "description": "Accepted", "content": { "application/json": { "schema": { "type": "object", "properties": { "loopbackCgwColor": { "type": "array", "description": "Loopback cgw color list", "example": [ "gold", "biz-internet", "private1", "private2" ], "items": { "type": "string", "description": "Loopback cgw color", "example": "gold" } }, "loopbackTunnelColor": { "type": "array", "description": "Loopback tunnel color list", "example": [ "gold", "biz-internet", "private1", "private2" ], "items": { "type": "string", "description": "Loopback tunnel color", "example": "gold" } } }, "$$ref": "#/components/schemas/InlineResponse2002" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/interconnect/connectivity/cloud-onramp-gateway-connections": { "get": { "tags": [ "Multicloud Interconnect - Connectivity" ], "summary": "Retrieve an Interconnect OnRamp gateway connection.", "description": "API to retrieve all Interconnect OnRamp gateway connection.", "operationId": "getInterconnectOnRampGatewayConnections", "parameters": [ { "name": "cloud-type", "in": "query", "description": "Cloud provider type", "schema": { "pattern": "^(AWS|AZURE|GCP)$", "type": "string" } }, { "name": "cloud-account-id", "in": "query", "description": "Cloud account id", "schema": { "maxLength": 255, "minLength": 1, "type": "string" } }, { "name": "connection-name", "in": "query", "description": "Interconnect OnRamp gateway connection name", "schema": { "pattern": "^[\\w.:-]{1,256}$", "type": "string" } }, { "name": "refresh", "in": "query", "description": "Interconnect connection provider sync enabled", "schema": { "pattern": "(true|false)", "type": "string", "default": "false" } } ], "responses": { "200": { "description": "Get all Interconnect OnRamp gateway connections", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Multicloud Interconnect - Connectivity" ], "summary": "Create an Interconnect OnRamp gateway connection.", "description": "API to create an Interconnect OnRamp gateway connection.", "operationId": "createInterconnectOnRampGatewayConnection", "requestBody": { "description": "Request payload for Interconnect OnRamp gateway connection", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "valueType": { "type": "string", "enum": [ "ARRAY", "OBJECT", "STRING", "NUMBER", "TRUE", "FALSE", "NULL" ] } } } } } }, "required": true }, "responses": { "200": { "description": "Create a Interconnect OnRamp gateway connection.", "content": { "application/json": { "schema": { "type": "array", "items": { "required": [ "cloudAccessType", "cloudAccountId", "cloudAccountName", "cloudType", "connectionId", "connectionName" ], "type": "object", "properties": { "cloudAccessType": { "type": "string", "description": "Interconnect cloud connect cloud access type" }, "cloudAccountId": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Interconnect OnRamp gateway connection cloud connect cloud account id" }, "cloudAccountName": { "type": "string", "description": "Interconnect OnRamp gateway connection cloud connect cloud account id" }, "cloudType": { "type": "string", "description": "Interconnect OnRamp gateway connection cloud connect cloud provider type" }, "connectionId": { "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", "type": "string", "description": "Interconnect OnRamp gateway connection id" }, "connectionName": { "pattern": "^[\\w.:-]{1,256}$", "type": "string", "description": "Interconnect OnRamp gateway connection name" }, "description": { "type": "string", "description": "Interconnect OnRamp gateway optional description" }, "directConnectGatewayDetails": { "required": [ "cloudResourceId" ], "type": "object", "properties": { "cloudResourceId": { "maxLength": 255, "minLength": 1, "pattern": "^.+:{2}.+$", "type": "string", "description": "Interconnect OnRamp AWS Direct Connect Gateway cloud resource id" }, "id": { "type": "string", "description": "Interconnect On Ramp AWS Direct Connect Gateway cloud resource id" }, "name": { "type": "string", "description": "Interconnect On Ramp AWS Direct Connect Gateway cloud resource name" } }, "description": "Interconnect OnRamp gateway connection Direct connect gateway details", "$$ref": "#/components/schemas/DirectConnectGatewayDetails" }, "expressRouteCircuitDetails": { "required": [ "cloudResourceId" ], "type": "object", "properties": { "cloudResourceId": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Interconnect OnRamp Azure express route circuit cloud resource id" }, "id": { "type": "string", "description": "Interconnect OnRamp Azure express route circuit id" }, "name": { "type": "string", "description": "Interconnect OnRamp Azure express route circuit name" }, "resourceGroupName": { "type": "string", "description": "Interconnect OnRamp Azure express route circuit resource group" }, "serviceKey": { "type": "string", "description": "Interconnect OnRamp Azure express route circuit service key" } }, "description": "Interconnect OnRamp gateway connection Express route circuit details", "$$ref": "#/components/schemas/ExpressRouteCircuitDetails" }, "gatewayAssociations": { "type": "array", "description": "Interconnect OnRamp gateway connection gateway associations", "items": { "required": [ "resourceType" ], "type": "object", "properties": { "cgwDetails": { "required": [ "cloudAccountId", "name" ], "type": "object", "properties": { "advertisedPrefixes": { "type": "array", "description": "Interconnect on ramp gateway connection cgw advertised prefixes", "items": { "type": "string", "description": "Interconnect on ramp gateway connection cgw advertised prefixes" } }, "cloudAccountId": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Interconnect On Ramp Gateway connection cloud connect cloud account id" }, "id": { "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", "type": "string", "description": "Interconnect OnRamp gateway associated cgw gateway id" }, "name": { "type": "string", "description": "Interconnect OnRamp gateway associated cgw gateway name" } }, "description": "Interconnect OnRamp gateway association MultiCloud gateway details", "$$ref": "#/components/schemas/CgwDetails" }, "resourceType": { "type": "string", "description": "Interconnect OnRamp gateway association type" }, "tgwDetails": { "required": [ "advertisedPrefixes", "cloudAccountId", "isCreate" ], "type": "object", "properties": { "advertisedPrefixes": { "type": "array", "description": "Prefixes to be advertised to the Direct Connect Gateway", "items": { "type": "string", "description": "Prefixes to be advertised to the Direct Connect Gateway" } }, "bgpAsn": { "pattern": "\\d+", "type": "string", "description": "Transit Gateway cloud side BGP ASN" }, "cloudAccountId": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Transit gateway cloud account id" }, "cloudResourceId": { "pattern": "^.+:{2}.+$", "type": "string", "description": "Transit gateway cloud resource id" }, "create": { "type": "boolean" }, "id": { "type": "string", "description": "Transit gateway id" }, "isCreate": { "pattern": "(true|false)", "type": "string", "description": "Transit gateway create flag" }, "name": { "type": "string", "description": "Transit gateway name" }, "region": { "type": "string", "description": "Transit gateway region" } }, "description": "Interconnect OnRamp gateway association Transit gateway details", "$$ref": "#/components/schemas/TgwDetails" }, "vhubDetails": { "required": [ "addressPrefix", "cloudAccountId", "isCreate" ], "type": "object", "properties": { "addressPrefix": { "pattern": "^(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(?:\\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}\\/(?:3[0-2]|[0-2]?[0-9])$", "type": "string", "description": "Virtual hub gateway address prefix" }, "cloudAccountId": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Virtual hub gateway cloud account id" }, "cloudResourceId": { "pattern": "^.+:{2}.+$", "type": "string", "description": "Virtual hub gateway cloud resource id" }, "create": { "type": "boolean" }, "id": { "type": "string", "description": "Virtual hub gateway id" }, "isCreate": { "pattern": "(true|false)", "type": "string", "description": "Virtual hub gateway create flag" }, "name": { "type": "string", "description": "Virtual hub gateway name" }, "region": { "type": "string", "description": "Virtual hub gateway region" }, "resourceGroupName": { "type": "string", "description": "Virtual hub gateway resource group" } }, "description": "Interconnect OnRamp gateway association Virtual hub details", "$$ref": "#/components/schemas/VhubDetails" } }, "description": "Interconnect OnRamp gateway connection gateway associations", "$$ref": "#/components/schemas/GatewayAssociationDetail" } }, "googleCloudRouterDetails": { "type": "array", "description": "Interconnect OnRamp gateway connection Google cloud router details", "items": { "required": [ "cloudResourceId", "role" ], "type": "object", "properties": { "cloudResourceId": { "maxLength": 255, "minLength": 1, "pattern": "^.+:{2}.+$", "type": "string", "description": "Interconnect OnRamp Google cloud router & attachment cloud resource id" }, "googleAttachmentDetail": { "type": "string", "description": "Interconnect OnRamp Google cloud router attachment detail" }, "id": { "type": "string", "description": "Interconnect OnRamp Google cloud router id" }, "name": { "type": "string", "description": "Interconnect OnRamp Google cloud router name" }, "network": { "type": "string", "description": "Interconnect OnRamp Google cloud router network" }, "region": { "type": "string", "description": "Interconnect OnRamp Google cloud router region" }, "role": { "type": "string", "description": "Interconnect OnRamp Google cloud router & attachment role" } }, "description": "Interconnect OnRamp gateway connection Google cloud router details", "$$ref": "#/components/schemas/GoogleCloudRouterDetails" } }, "interconnectAttachments": { "type": "array", "description": "Interconnect OnRamp gateway connection interconnect attachments", "items": { "required": [ "resourceType" ], "type": "object", "properties": { "connectionDetails": { "required": [ "connectionName" ], "type": "object", "properties": { "connectionName": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Interconnect cross connection name" } }, "description": "Interconnect cross connection attachment connection details", "$$ref": "#/components/schemas/ConnectionDetail" }, "resourceType": { "type": "string", "description": "Interconnect cross connection attachment resource type" } }, "description": "Interconnect OnRamp gateway connection interconnect attachments", "$$ref": "#/components/schemas/InterconnectAttachments" } }, "interconnectResourceState": { "type": "object", "properties": { "resourceAssociationDetails": { "type": "array", "items": { "type": "object", "properties": { "associatedResourceConnectionStatus": { "type": "string" }, "associatedResourceId": { "type": "string" }, "associatedResourceName": { "type": "string" }, "associatedResourceStatus": { "type": "string" }, "associatedResourceType": { "type": "string" } }, "$$ref": "#/components/schemas/ResourceAssociationDetail" } }, "resourceState": { "type": "string" }, "resourceStateMessage": { "type": "string" }, "resourceStateUpdateTs": { "type": "string" } }, "description": "Interconnect virtual network connection resource state information", "$$ref": "#/components/schemas/InterconnectResourceState" }, "onRampGatewayType": { "type": "string", "description": "Interconnect cloud connect cloud access type" }, "virtualNetworkAssociationType": { "type": "string", "description": "Interconnect cloud connect virtual network association type" }, "virtualWanDetails": { "required": [ "cloudResourceId" ], "type": "object", "properties": { "cloudResourceId": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Interconnect OnRamp Azure virtual wan cloud resource id" }, "id": { "type": "string", "description": "Interconnect OnRamp Azure virtual wan id" }, "name": { "type": "string", "description": "Interconnect OnRamp Azure virtual wan name" }, "resourceGroupName": { "type": "string", "description": "Interconnect OnRamp Azure virtual wan resource group" } }, "description": "Interconnect OnRamp gateway connection Azure virtual wan details", "$$ref": "#/components/schemas/VirtualWanDetails" } }, "$$ref": "#/components/schemas/InterconnectOnRampGatewayConnection" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/interconnect/connectivity/cloud-onramp-gateway-connections/{connection-name}": { "delete": { "tags": [ "Multicloud Interconnect - Connectivity" ], "summary": "Delete an Interconnect OnRamp gateway connection.", "description": "API to delete an Interconnect OnRamp gateway connection.", "operationId": "deleteInterconnectOnRampGatewayConnection", "parameters": [ { "name": "connection-name", "in": "path", "description": "Interconnect OnRamp gateway connection name", "required": true, "schema": { "pattern": "^[\\w.:-]{1,256}$", "type": "string" } }, { "name": "delete-cloud-resources", "in": "query", "description": "Interconnect connection provider sync enabled", "schema": { "pattern": "(true|false)", "type": "string", "default": "false" } } ], "responses": { "200": { "description": "Interconnect Process ID Information.", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "Procees Id of the task", "example": "51d0a0e4-983a-471c-9abb-724d58144884" } }, "$$ref": "#/components/schemas/ProcessResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "Multicloud Interconnect - Connectivity" ], "summary": "Get OnRamp gateway connection by name.", "description": "API to retrieve a specific Interconnect OnRamp gateway connection.", "operationId": "getInterconnectOnRampGatewayConnection", "parameters": [ { "name": "connection-name", "in": "path", "description": "Interconnect OnRamp gateway connection name", "required": true, "schema": { "pattern": "^[\\w.:-]{1,256}$", "type": "string" } } ], "responses": { "200": { "description": "Get an Interconnect OnRamp gateway connection", "content": { "application/json": { "schema": { "required": [ "cloudAccessType", "cloudAccountId", "cloudAccountName", "cloudType", "connectionId", "connectionName" ], "type": "object", "properties": { "cloudAccessType": { "type": "string", "description": "Interconnect cloud connect cloud access type" }, "cloudAccountId": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Interconnect OnRamp gateway connection cloud connect cloud account id" }, "cloudAccountName": { "type": "string", "description": "Interconnect OnRamp gateway connection cloud connect cloud account id" }, "cloudType": { "type": "string", "description": "Interconnect OnRamp gateway connection cloud connect cloud provider type" }, "connectionId": { "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", "type": "string", "description": "Interconnect OnRamp gateway connection id" }, "connectionName": { "pattern": "^[\\w.:-]{1,256}$", "type": "string", "description": "Interconnect OnRamp gateway connection name" }, "description": { "type": "string", "description": "Interconnect OnRamp gateway optional description" }, "directConnectGatewayDetails": { "required": [ "cloudResourceId" ], "type": "object", "properties": { "cloudResourceId": { "maxLength": 255, "minLength": 1, "pattern": "^.+:{2}.+$", "type": "string", "description": "Interconnect OnRamp AWS Direct Connect Gateway cloud resource id" }, "id": { "type": "string", "description": "Interconnect On Ramp AWS Direct Connect Gateway cloud resource id" }, "name": { "type": "string", "description": "Interconnect On Ramp AWS Direct Connect Gateway cloud resource name" } }, "description": "Interconnect OnRamp gateway connection Direct connect gateway details", "$$ref": "#/components/schemas/DirectConnectGatewayDetails" }, "expressRouteCircuitDetails": { "required": [ "cloudResourceId" ], "type": "object", "properties": { "cloudResourceId": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Interconnect OnRamp Azure express route circuit cloud resource id" }, "id": { "type": "string", "description": "Interconnect OnRamp Azure express route circuit id" }, "name": { "type": "string", "description": "Interconnect OnRamp Azure express route circuit name" }, "resourceGroupName": { "type": "string", "description": "Interconnect OnRamp Azure express route circuit resource group" }, "serviceKey": { "type": "string", "description": "Interconnect OnRamp Azure express route circuit service key" } }, "description": "Interconnect OnRamp gateway connection Express route circuit details", "$$ref": "#/components/schemas/ExpressRouteCircuitDetails" }, "gatewayAssociations": { "type": "array", "description": "Interconnect OnRamp gateway connection gateway associations", "items": { "required": [ "resourceType" ], "type": "object", "properties": { "cgwDetails": { "required": [ "cloudAccountId", "name" ], "type": "object", "properties": { "advertisedPrefixes": { "type": "array", "description": "Interconnect on ramp gateway connection cgw advertised prefixes", "items": { "type": "string", "description": "Interconnect on ramp gateway connection cgw advertised prefixes" } }, "cloudAccountId": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Interconnect On Ramp Gateway connection cloud connect cloud account id" }, "id": { "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", "type": "string", "description": "Interconnect OnRamp gateway associated cgw gateway id" }, "name": { "type": "string", "description": "Interconnect OnRamp gateway associated cgw gateway name" } }, "description": "Interconnect OnRamp gateway association MultiCloud gateway details", "$$ref": "#/components/schemas/CgwDetails" }, "resourceType": { "type": "string", "description": "Interconnect OnRamp gateway association type" }, "tgwDetails": { "required": [ "advertisedPrefixes", "cloudAccountId", "isCreate" ], "type": "object", "properties": { "advertisedPrefixes": { "type": "array", "description": "Prefixes to be advertised to the Direct Connect Gateway", "items": { "type": "string", "description": "Prefixes to be advertised to the Direct Connect Gateway" } }, "bgpAsn": { "pattern": "\\d+", "type": "string", "description": "Transit Gateway cloud side BGP ASN" }, "cloudAccountId": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Transit gateway cloud account id" }, "cloudResourceId": { "pattern": "^.+:{2}.+$", "type": "string", "description": "Transit gateway cloud resource id" }, "create": { "type": "boolean" }, "id": { "type": "string", "description": "Transit gateway id" }, "isCreate": { "pattern": "(true|false)", "type": "string", "description": "Transit gateway create flag" }, "name": { "type": "string", "description": "Transit gateway name" }, "region": { "type": "string", "description": "Transit gateway region" } }, "description": "Interconnect OnRamp gateway association Transit gateway details", "$$ref": "#/components/schemas/TgwDetails" }, "vhubDetails": { "required": [ "addressPrefix", "cloudAccountId", "isCreate" ], "type": "object", "properties": { "addressPrefix": { "pattern": "^(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(?:\\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}\\/(?:3[0-2]|[0-2]?[0-9])$", "type": "string", "description": "Virtual hub gateway address prefix" }, "cloudAccountId": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Virtual hub gateway cloud account id" }, "cloudResourceId": { "pattern": "^.+:{2}.+$", "type": "string", "description": "Virtual hub gateway cloud resource id" }, "create": { "type": "boolean" }, "id": { "type": "string", "description": "Virtual hub gateway id" }, "isCreate": { "pattern": "(true|false)", "type": "string", "description": "Virtual hub gateway create flag" }, "name": { "type": "string", "description": "Virtual hub gateway name" }, "region": { "type": "string", "description": "Virtual hub gateway region" }, "resourceGroupName": { "type": "string", "description": "Virtual hub gateway resource group" } }, "description": "Interconnect OnRamp gateway association Virtual hub details", "$$ref": "#/components/schemas/VhubDetails" } }, "description": "Interconnect OnRamp gateway connection gateway associations", "$$ref": "#/components/schemas/GatewayAssociationDetail" } }, "googleCloudRouterDetails": { "type": "array", "description": "Interconnect OnRamp gateway connection Google cloud router details", "items": { "required": [ "cloudResourceId", "role" ], "type": "object", "properties": { "cloudResourceId": { "maxLength": 255, "minLength": 1, "pattern": "^.+:{2}.+$", "type": "string", "description": "Interconnect OnRamp Google cloud router & attachment cloud resource id" }, "googleAttachmentDetail": { "type": "string", "description": "Interconnect OnRamp Google cloud router attachment detail" }, "id": { "type": "string", "description": "Interconnect OnRamp Google cloud router id" }, "name": { "type": "string", "description": "Interconnect OnRamp Google cloud router name" }, "network": { "type": "string", "description": "Interconnect OnRamp Google cloud router network" }, "region": { "type": "string", "description": "Interconnect OnRamp Google cloud router region" }, "role": { "type": "string", "description": "Interconnect OnRamp Google cloud router & attachment role" } }, "description": "Interconnect OnRamp gateway connection Google cloud router details", "$$ref": "#/components/schemas/GoogleCloudRouterDetails" } }, "interconnectAttachments": { "type": "array", "description": "Interconnect OnRamp gateway connection interconnect attachments", "items": { "required": [ "resourceType" ], "type": "object", "properties": { "connectionDetails": { "required": [ "connectionName" ], "type": "object", "properties": { "connectionName": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Interconnect cross connection name" } }, "description": "Interconnect cross connection attachment connection details", "$$ref": "#/components/schemas/ConnectionDetail" }, "resourceType": { "type": "string", "description": "Interconnect cross connection attachment resource type" } }, "description": "Interconnect OnRamp gateway connection interconnect attachments", "$$ref": "#/components/schemas/InterconnectAttachments" } }, "interconnectResourceState": { "type": "object", "properties": { "resourceAssociationDetails": { "type": "array", "items": { "type": "object", "properties": { "associatedResourceConnectionStatus": { "type": "string" }, "associatedResourceId": { "type": "string" }, "associatedResourceName": { "type": "string" }, "associatedResourceStatus": { "type": "string" }, "associatedResourceType": { "type": "string" } }, "$$ref": "#/components/schemas/ResourceAssociationDetail" } }, "resourceState": { "type": "string" }, "resourceStateMessage": { "type": "string" }, "resourceStateUpdateTs": { "type": "string" } }, "description": "Interconnect virtual network connection resource state information", "$$ref": "#/components/schemas/InterconnectResourceState" }, "onRampGatewayType": { "type": "string", "description": "Interconnect cloud connect cloud access type" }, "virtualNetworkAssociationType": { "type": "string", "description": "Interconnect cloud connect virtual network association type" }, "virtualWanDetails": { "required": [ "cloudResourceId" ], "type": "object", "properties": { "cloudResourceId": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Interconnect OnRamp Azure virtual wan cloud resource id" }, "id": { "type": "string", "description": "Interconnect OnRamp Azure virtual wan id" }, "name": { "type": "string", "description": "Interconnect OnRamp Azure virtual wan name" }, "resourceGroupName": { "type": "string", "description": "Interconnect OnRamp Azure virtual wan resource group" } }, "description": "Interconnect OnRamp gateway connection Azure virtual wan details", "$$ref": "#/components/schemas/VirtualWanDetails" } }, "$$ref": "#/components/schemas/InterconnectOnRampGatewayConnection" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "Multicloud Interconnect - Connectivity" ], "summary": "Update an Interconnect OnRamp Gateway Connection.", "description": "API to update an Interconnect OnRamp gateway connection.", "operationId": "updateInterconnectOnRampGatewayConnection", "parameters": [ { "name": "connection-name", "in": "path", "description": "Interconnect OnRamp gateway connection name", "required": true, "schema": { "pattern": "^[\\w.:-]{1,256}$", "type": "string" } } ], "requestBody": { "description": "Request payload for Interconnect OnRamp gateway connection", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "object", "properties": { "valueType": { "type": "string", "enum": [ "ARRAY", "OBJECT", "STRING", "NUMBER", "TRUE", "FALSE", "NULL" ] } } } } } }, "required": true }, "responses": { "200": { "description": "Update an Interconnect OnRamp gateway connection", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "Procees Id of the task", "example": "51d0a0e4-983a-471c-9abb-724d58144884" } }, "$$ref": "#/components/schemas/ProcessResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/interconnect/connectivity/cloud-onramp-gateway-connections/{connection-name}/resources": { "get": { "tags": [ "Multicloud Interconnect - Connectivity" ], "summary": "Get OnRamp gateway connection resources.", "description": "API to retrieve all resources used by a specific Interconnect OnRamp gateway connection.", "operationId": "getInterconnectOnRampGatewayConnectionResources", "parameters": [ { "name": "connection-name", "in": "path", "description": "Interconnect OnRamp gateway connection name", "required": true, "schema": { "pattern": "^[\\w.:-]{1,256}$", "type": "string" } }, { "name": "refresh", "in": "query", "description": "Retrieve and update all cloud resource state", "schema": { "pattern": "(true|false)", "type": "string", "default": "false" } } ], "responses": { "200": { "description": "Interconnect OnRamp gateway connection associated resources", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/interconnect/connectivity/connections/tags": { "get": { "tags": [ "Multicloud Interconnect - Connectivity" ], "summary": "Get configured Interconnect host VPC/VNET mapping tags.", "description": "API to retrieve configured Interconnect host VPC/VNET mapping tags.", "operationId": "getInterconnectMappingTags", "parameters": [ { "name": "cloud-type", "in": "query", "description": "Cloud provider type", "required": true, "schema": { "type": "string" } }, { "name": "cloud-account-id", "in": "query", "description": "Cloud account id", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } }, { "name": "resource-group", "in": "query", "description": "Azure cloud resource group name", "schema": { "maxLength": 128, "minLength": 1, "type": "string" } } ], "responses": { "200": { "description": "Accepted", "content": { "application/json": { "schema": { "type": "object", "properties": { "loopbackCgwColor": { "type": "array", "description": "Loopback cgw color list", "example": [ "gold", "biz-internet", "private1", "private2" ], "items": { "type": "string", "description": "Loopback cgw color", "example": "gold" } }, "loopbackTunnelColor": { "type": "array", "description": "Loopback tunnel color list", "example": [ "gold", "biz-internet", "private1", "private2" ], "items": { "type": "string", "description": "Loopback tunnel color", "example": "gold" } } }, "$$ref": "#/components/schemas/InlineResponse2002" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/interconnect/connectivity/device-links": { "get": { "tags": [ "Multicloud Interconnect - Connectivity" ], "summary": "Get Interconnect provider Device-Link.", "description": "API to retrieve Interconnect provider Device-Link.", "operationId": "getInterconnectDeviceLinks", "parameters": [ { "name": "device-link-name", "in": "query", "description": "Interconnect Device Link name", "schema": { "pattern": "^[\\w.-]{3,50}$", "type": "string" } }, { "name": "interconnect-type", "in": "query", "description": "Interconnect Provider Type", "schema": { "type": "string", "enum": [ "MEGAPORT", "EQUINIX" ] } }, { "name": "refresh", "in": "query", "description": "Retrieve Interconnect Device-Link from provider enabled", "schema": { "pattern": "(true|false)", "type": "string", "default": "false" } } ], "responses": { "200": { "description": "Interconnect Device-Link Get Response.", "content": { "application/json": { "schema": { "required": [ "bandwidth", "deviceLinkName", "edgeAccountId", "edgeType" ], "type": "object", "properties": { "bandwidth": { "type": "string", "description": "Device-Link Bandwidth Input.", "example": "50" }, "deviceLinkName": { "maxLength": 50, "minLength": 3, "pattern": "^[\\w.-]{3,50}$", "type": "string", "description": "Name of the Interconnect Device-Link.", "example": "my-device-link" }, "deviceLinkUuid": { "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", "type": "string", "description": "Uuid of the Interconnect Device-Link", "example": "496bddbd-e104-44a7-ba62-7a285f642304" }, "deviceLinksubnet": { "type": "string", "description": "Subnet pool for Interconnect Gateway interfaces in the Device-Link.", "example": "20.10.0.0/16" }, "deviceList": { "maxItems": 2147483647, "minItems": 2, "type": "array", "items": { "type": "object", "properties": { "deviceInterfaceId": { "type": "string", "description": "Interface used on the Interconnect Gateway to connect to the Device-Link.", "example": "GigabitEthernet4" }, "deviceIntfIpAddress": { "type": "string", "description": "IP assigned to the Interconnect Gateway interface to connect to the Device-Link.", "example": "20.10.0.2" }, "deviceName": { "pattern": "^[\\w.-]{3,50}$", "type": "string", "description": "Name of the Interconnect Gateway in the Device-Link.", "example": "ICGW_1" }, "deviceUuid": { "type": "string", "description": "Uuid of Interconnect Gateway in the Device-Link.", "example": "0dc43131-47c9-4fce-8499-f02e3340c9fb" }, "egwLoopBackCidr": { "type": "string", "description": "IP assigned to the loopback interface of the Interconnect Gateway to form SDWAN tunnel.", "example": "172.31.251.8/30" } }, "$$ref": "#/components/schemas/InterconnectDeviceLinkDeviceList" } }, "dlMetroBandwidth": { "type": "string", "description": "Device-Link Bandwidth at a given Metro.", "example": "150" }, "edgeAccountId": { "maxLength": 255, "minLength": 1, "type": "string" }, "edgeAccountName": { "maxLength": 255, "minLength": 1, "pattern": "^[a-zA-Z0-9_\\-\\s]+$", "type": "string" }, "edgeType": { "type": "string" }, "linkBandwidth": { "type": "string", "description": "Device-Link Bandwidth.", "example": "50" }, "resourceState": { "type": "string" }, "resourceStateMessage": { "type": "string" }, "resourceStateUpdateTs": { "type": "string" }, "subnet": { "pattern": "^(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(?:\\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}\\/(?:3[0-2]|[0-2]?[0-9])$", "type": "string", "description": "Subnet pool for Interconnect Gateway interfaces in the Device-Link.", "example": "20.10.0.0/16" }, "version": { "type": "string", "description": "Version of the payload.", "example": "1" } }, "description": "Interconnect Device-Link Object", "$$ref": "#/components/schemas/InterconnectDeviceLink" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Multicloud Interconnect - Connectivity" ], "summary": "Add an Interconnect Device-Link to vManage.", "description": "API to create a Device-Link in vManage.", "operationId": "addInterconnectDeviceLink", "requestBody": { "description": "Request Payload for Multicloud Interconnect Device Links", "content": { "application/json": { "schema": { "required": [ "bandwidth", "deviceLinkName", "edgeAccountId", "edgeType" ], "type": "object", "properties": { "bandwidth": { "type": "string", "description": "Device-Link Bandwidth Input.", "example": "50" }, "deviceLinkName": { "maxLength": 50, "minLength": 3, "pattern": "^[\\w.-]{3,50}$", "type": "string", "description": "Name of the Interconnect Device-Link.", "example": "my-device-link" }, "deviceLinkUuid": { "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", "type": "string", "description": "Uuid of the Interconnect Device-Link", "example": "496bddbd-e104-44a7-ba62-7a285f642304" }, "deviceLinksubnet": { "type": "string", "description": "Subnet pool for Interconnect Gateway interfaces in the Device-Link.", "example": "20.10.0.0/16" }, "deviceList": { "maxItems": 2147483647, "minItems": 2, "type": "array", "items": { "type": "object", "properties": { "deviceInterfaceId": { "type": "string", "description": "Interface used on the Interconnect Gateway to connect to the Device-Link.", "example": "GigabitEthernet4" }, "deviceIntfIpAddress": { "type": "string", "description": "IP assigned to the Interconnect Gateway interface to connect to the Device-Link.", "example": "20.10.0.2" }, "deviceName": { "pattern": "^[\\w.-]{3,50}$", "type": "string", "description": "Name of the Interconnect Gateway in the Device-Link.", "example": "ICGW_1" }, "deviceUuid": { "type": "string", "description": "Uuid of Interconnect Gateway in the Device-Link.", "example": "0dc43131-47c9-4fce-8499-f02e3340c9fb" }, "egwLoopBackCidr": { "type": "string", "description": "IP assigned to the loopback interface of the Interconnect Gateway to form SDWAN tunnel.", "example": "172.31.251.8/30" } }, "$$ref": "#/components/schemas/InterconnectDeviceLinkDeviceList" } }, "dlMetroBandwidth": { "type": "string", "description": "Device-Link Bandwidth at a given Metro.", "example": "150" }, "edgeAccountId": { "maxLength": 255, "minLength": 1, "type": "string" }, "edgeAccountName": { "maxLength": 255, "minLength": 1, "pattern": "^[a-zA-Z0-9_\\-\\s]+$", "type": "string" }, "edgeType": { "type": "string" }, "linkBandwidth": { "type": "string", "description": "Device-Link Bandwidth.", "example": "50" }, "resourceState": { "type": "string" }, "resourceStateMessage": { "type": "string" }, "resourceStateUpdateTs": { "type": "string" }, "subnet": { "pattern": "^(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(?:\\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}\\/(?:3[0-2]|[0-2]?[0-9])$", "type": "string", "description": "Subnet pool for Interconnect Gateway interfaces in the Device-Link.", "example": "20.10.0.0/16" }, "version": { "type": "string", "description": "Version of the payload.", "example": "1" } }, "description": "Interconnect Device-Link Object", "$$ref": "#/components/schemas/InterconnectDeviceLink" }, "examples": { "Interconnect Equinix Device Link": { "description": "Interconnect Equinix Device Link", "value": { "edgeType": "EQUINIX", "edgeAccountId": "ABCD-1234-CDEF", "edgeAccountName": "interconnect-account-name", "deviceLinkName": "my-device-link", "subnet": "20.10.0.0/16", "bandwidth": "100", "deviceList": [ { "deviceName": "ICGW_1" }, { "deviceName": "ICGW_2" } ] } } } } }, "required": true }, "responses": { "200": { "description": "Interconnect Process ID Information.", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "Procees Id of the task", "example": "51d0a0e4-983a-471c-9abb-724d58144884" } }, "$$ref": "#/components/schemas/ProcessResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/interconnect/connectivity/device-links/{device-link-name}": { "get": { "tags": [ "Multicloud Interconnect - Connectivity" ], "summary": "Get Interconnect provider Device-Link.", "description": "API to retrieve Interconnect provider Device-Link.", "operationId": "getInterconnectDeviceLink", "parameters": [ { "name": "device-link-name", "in": "path", "description": "Interconnect Device Link name", "required": true, "schema": { "pattern": "^[\\w.-]{3,50}$", "type": "string" } } ], "responses": { "200": { "description": "Interconnect Device-Link Get Response.", "content": { "application/json": { "schema": { "required": [ "bandwidth", "deviceLinkName", "edgeAccountId", "edgeType" ], "type": "object", "properties": { "bandwidth": { "type": "string", "description": "Device-Link Bandwidth Input.", "example": "50" }, "deviceLinkName": { "maxLength": 50, "minLength": 3, "pattern": "^[\\w.-]{3,50}$", "type": "string", "description": "Name of the Interconnect Device-Link.", "example": "my-device-link" }, "deviceLinkUuid": { "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", "type": "string", "description": "Uuid of the Interconnect Device-Link", "example": "496bddbd-e104-44a7-ba62-7a285f642304" }, "deviceLinksubnet": { "type": "string", "description": "Subnet pool for Interconnect Gateway interfaces in the Device-Link.", "example": "20.10.0.0/16" }, "deviceList": { "maxItems": 2147483647, "minItems": 2, "type": "array", "items": { "type": "object", "properties": { "deviceInterfaceId": { "type": "string", "description": "Interface used on the Interconnect Gateway to connect to the Device-Link.", "example": "GigabitEthernet4" }, "deviceIntfIpAddress": { "type": "string", "description": "IP assigned to the Interconnect Gateway interface to connect to the Device-Link.", "example": "20.10.0.2" }, "deviceName": { "pattern": "^[\\w.-]{3,50}$", "type": "string", "description": "Name of the Interconnect Gateway in the Device-Link.", "example": "ICGW_1" }, "deviceUuid": { "type": "string", "description": "Uuid of Interconnect Gateway in the Device-Link.", "example": "0dc43131-47c9-4fce-8499-f02e3340c9fb" }, "egwLoopBackCidr": { "type": "string", "description": "IP assigned to the loopback interface of the Interconnect Gateway to form SDWAN tunnel.", "example": "172.31.251.8/30" } }, "$$ref": "#/components/schemas/InterconnectDeviceLinkDeviceList" } }, "dlMetroBandwidth": { "type": "string", "description": "Device-Link Bandwidth at a given Metro.", "example": "150" }, "edgeAccountId": { "maxLength": 255, "minLength": 1, "type": "string" }, "edgeAccountName": { "maxLength": 255, "minLength": 1, "pattern": "^[a-zA-Z0-9_\\-\\s]+$", "type": "string" }, "edgeType": { "type": "string" }, "linkBandwidth": { "type": "string", "description": "Device-Link Bandwidth.", "example": "50" }, "resourceState": { "type": "string" }, "resourceStateMessage": { "type": "string" }, "resourceStateUpdateTs": { "type": "string" }, "subnet": { "pattern": "^(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(?:\\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}\\/(?:3[0-2]|[0-2]?[0-9])$", "type": "string", "description": "Subnet pool for Interconnect Gateway interfaces in the Device-Link.", "example": "20.10.0.0/16" }, "version": { "type": "string", "description": "Version of the payload.", "example": "1" } }, "description": "Interconnect Device-Link Object", "$$ref": "#/components/schemas/InterconnectDeviceLink" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "Multicloud Interconnect - Connectivity" ], "summary": "Update an Interconnect Device-Link to vManage.", "description": "API to update a Device-Link in vManage.", "operationId": "updateInterconnectDeviceLink", "parameters": [ { "name": "device-link-name", "in": "path", "description": "Interconnect Device Link name", "required": true, "schema": { "pattern": "^[\\w.-]{3,50}$", "type": "string" } } ], "requestBody": { "description": "Request Payload for Multicloud Interconnect Device Links", "content": { "application/json": { "schema": { "required": [ "bandwidth", "deviceLinkName", "edgeAccountId", "edgeType" ], "type": "object", "properties": { "bandwidth": { "type": "string", "description": "Device-Link Bandwidth Input.", "example": "50" }, "deviceLinkName": { "maxLength": 50, "minLength": 3, "pattern": "^[\\w.-]{3,50}$", "type": "string", "description": "Name of the Interconnect Device-Link.", "example": "my-device-link" }, "deviceLinkUuid": { "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", "type": "string", "description": "Uuid of the Interconnect Device-Link", "example": "496bddbd-e104-44a7-ba62-7a285f642304" }, "deviceLinksubnet": { "type": "string", "description": "Subnet pool for Interconnect Gateway interfaces in the Device-Link.", "example": "20.10.0.0/16" }, "deviceList": { "maxItems": 2147483647, "minItems": 2, "type": "array", "items": { "type": "object", "properties": { "deviceInterfaceId": { "type": "string", "description": "Interface used on the Interconnect Gateway to connect to the Device-Link.", "example": "GigabitEthernet4" }, "deviceIntfIpAddress": { "type": "string", "description": "IP assigned to the Interconnect Gateway interface to connect to the Device-Link.", "example": "20.10.0.2" }, "deviceName": { "pattern": "^[\\w.-]{3,50}$", "type": "string", "description": "Name of the Interconnect Gateway in the Device-Link.", "example": "ICGW_1" }, "deviceUuid": { "type": "string", "description": "Uuid of Interconnect Gateway in the Device-Link.", "example": "0dc43131-47c9-4fce-8499-f02e3340c9fb" }, "egwLoopBackCidr": { "type": "string", "description": "IP assigned to the loopback interface of the Interconnect Gateway to form SDWAN tunnel.", "example": "172.31.251.8/30" } }, "$$ref": "#/components/schemas/InterconnectDeviceLinkDeviceList" } }, "dlMetroBandwidth": { "type": "string", "description": "Device-Link Bandwidth at a given Metro.", "example": "150" }, "edgeAccountId": { "maxLength": 255, "minLength": 1, "type": "string" }, "edgeAccountName": { "maxLength": 255, "minLength": 1, "pattern": "^[a-zA-Z0-9_\\-\\s]+$", "type": "string" }, "edgeType": { "type": "string" }, "linkBandwidth": { "type": "string", "description": "Device-Link Bandwidth.", "example": "50" }, "resourceState": { "type": "string" }, "resourceStateMessage": { "type": "string" }, "resourceStateUpdateTs": { "type": "string" }, "subnet": { "pattern": "^(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(?:\\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}\\/(?:3[0-2]|[0-2]?[0-9])$", "type": "string", "description": "Subnet pool for Interconnect Gateway interfaces in the Device-Link.", "example": "20.10.0.0/16" }, "version": { "type": "string", "description": "Version of the payload.", "example": "1" } }, "description": "Interconnect Device-Link Object", "$$ref": "#/components/schemas/InterconnectDeviceLink" }, "examples": { "Interconnect Equinix Device Link": { "description": "Interconnect Equinix Device Link", "value": { "edgeType": "EQUINIX", "edgeAccountId": "ABCD-1234-CDEF", "edgeAccountName": "interconnect-account-name", "deviceLinkName": "my-device-link", "subnet": "20.10.0.0/16", "bandwidth": "100", "deviceList": [ { "deviceName": "ICGW_1" }, { "deviceName": "ICGW_2" } ] } } } } }, "required": true }, "responses": { "200": { "description": "Interconnect Process ID Information.", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "Procees Id of the task", "example": "51d0a0e4-983a-471c-9abb-724d58144884" } }, "$$ref": "#/components/schemas/ProcessResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Multicloud Interconnect - Connectivity" ], "summary": "Delete Interconnect provider Device-Link.", "description": "API to Delete Interconnect provider Device-Link.", "operationId": "deleteInterconnectDeviceLink", "parameters": [ { "name": "device-link-name", "in": "path", "description": "Interconnect Device Link name", "required": true, "schema": { "pattern": "^[\\w.-]{3,50}$", "type": "string" } } ], "responses": { "200": { "description": "Accepted" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/interconnect/connectivity/virtual-cross-connections": { "get": { "tags": [ "Multicloud Interconnect - Connectivity" ], "summary": "Retrieve all Interconnect virtual cross connections.", "description": "API to retrieve all exisiting Interconnect virtual cross connections.", "operationId": "getInterconnectCrossConnections", "parameters": [ { "name": "interconnect-type", "in": "query", "description": "Interconnect provider Type", "schema": { "type": "string" } }, { "name": "interconnect-gateway-name", "in": "query", "description": "Interconnect gateway name", "schema": { "maxLength": 255, "minLength": 1, "type": "string" } }, { "name": "connection-name", "in": "query", "description": "Interconnect virtual cross connection name", "schema": { "maxLength": 255, "minLength": 1, "type": "string" } }, { "name": "connection-type", "in": "query", "description": "Interconnect virtual cross connection type", "schema": { "type": "string" } }, { "name": "cloud-type", "in": "query", "description": "Cloud provider type", "schema": { "pattern": "^(AWS|AZURE|GCP)$", "type": "string" } }, { "name": "refresh", "in": "query", "description": "Interconnect connection provider sync enabled", "schema": { "pattern": "(true|false)", "type": "string", "default": "false" } } ], "responses": { "200": { "description": "Accepted", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Multicloud Interconnect - Connectivity" ], "summary": "Create private Interconnect cross connection.", "description": "API to create an Interconnect virtual cross connection on an Interconnect Gateway at an Interconnect Provider.", "operationId": "createInterconnectCrossConnection", "requestBody": { "description": "Request Payload for Interconnect virtual cross connections", "content": { "application/json": { "schema": { "type": "array", "items": { "required": [ "connectionId", "connectionName", "connectionRole", "connectionSpeed", "connectionType", "interconnectAccountId", "interconnectType" ], "type": "object", "properties": { "cloudConnectDetail": { "required": [ "cloudAccessType", "cloudType", "connectionDestination", "connectionSource", "peeringInfo" ], "type": "object", "properties": { "awsCloudDetail": { "required": [ "cloudAccountId", "cloudAccountName", "crossConnectType" ], "type": "object", "properties": { "cloudAccountId": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Interconnect cloud connect AWS cloud account id" }, "cloudAccountName": { "type": "string", "description": "Interconnect cloud connect cloud account name" }, "cloudSideBgpAsn": { "pattern": "\\d+", "type": "string", "description": "Interconnect cloud connect AWS cloud side BGP ASN" }, "crossConnectType": { "pattern": "^(HVIF|HCONN)$", "type": "string", "description": "Interconnect cloud connect AWS cross connect type" }, "hostedConnectionId": { "type": "string", "description": "Interconnect cloud connect AWS hosted connection id" }, "virtualInterfaceId": { "type": "string", "description": "Interconnect cloud connect AWS hosted virtual interface id" } }, "description": "Interconnect cloud connect AWS cloud detail", "$$ref": "#/components/schemas/AwsCloudDetail" }, "azureCloudDetail": { "required": [ "cloudAccountId", "cloudAccountName", "crossConnectType", "serviceKey" ], "type": "object", "properties": { "cloudAccountId": { "type": "string", "description": "Interconnect cloud connect Azure cloud account id" }, "cloudAccountName": { "type": "string", "description": "Interconnect cloud connect cloud account name" }, "crossConnectType": { "pattern": "^EXPRESS_ROUTE_CIRCUIT$", "type": "string", "description": "Interconnect cloud connect Azure cross connect type" }, "serviceKey": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Interconnect cloud connect Azure Express Route Circuit service key" } }, "description": "Interconnect cloud connect Azure cloud detail", "$$ref": "#/components/schemas/AzureCloudDetail" }, "cloudAccessType": { "type": "string", "description": "Interconnect cloud connect cloud access type" }, "cloudType": { "type": "string", "description": "Interconnect cloud connect cloud provider type" }, "connectionDestination": { "required": [ "resourceType" ], "type": "object", "properties": { "gatewayDetail": { "required": [ "name" ], "type": "object", "properties": { "id": { "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", "type": "string", "description": "Interconnect gateway id" }, "name": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Interconnect gateway name" }, "ownerId": { "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", "type": "string", "description": "Interconnect gateway owner account id" }, "region": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Interconnect gateway region name" }, "regionId": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Interconnect gateway region id" } }, "description": "Interconnect connection end gateway detail", "$$ref": "#/components/schemas/GatewayDetail" }, "interfaceDetail": { "type": "object", "properties": { "bgpAsn": { "pattern": "\\d+", "type": "string", "description": "BGP ASN of the connection end" }, "bgpKey": { "maxLength": 25, "minLength": 1, "type": "string", "description": "BGP key of the connection end" }, "interfaceName": { "maxLength": 64, "minLength": 1, "type": "string", "description": "Interface name of the connection end" }, "ipAddress": { "pattern": "^((([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\\p{N}\\p{L}]+)?)((\\s)(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\\p{N}\\p{L}]+)?)?$", "type": "string", "description": "Interface IP address of the connection end" }, "mtu": { "pattern": "^(1400|1496|1500)$", "type": "string", "description": "MTU of the connection end" }, "prefix": { "pattern": "^(?:3[0-0]|[0-2]?[0-9])$", "type": "string", "description": "Interface IP address prefix of the connection end" }, "vlanId": { "pattern": "\\d+", "type": "string", "description": "VLAN ID of the connection end" } }, "description": "Interconnect connection end interface detail", "$$ref": "#/components/schemas/InterconnectInterfaceDetail" }, "portDetail": { "required": [ "id", "name", "ownerId", "region", "regionId" ], "type": "object", "properties": { "id": { "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", "type": "string", "description": "Interconnect connection port id" }, "name": { "maxLength": 1024, "minLength": 1, "type": "string", "description": "Interconnect connection port name" }, "ownerId": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Interconnect connection port owner account id" }, "region": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Interconnect connection port region name" }, "regionId": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Interconnect connection port region id" } }, "description": "Interconnect connection end port detail", "$$ref": "#/components/schemas/PortDetail" }, "resourceType": { "type": "string", "description": "Interconnect connection end resource type" } }, "description": "Interconnect device connect connection destination", "$$ref": "#/components/schemas/ConnectionEndDetail" }, "connectionSource": { "required": [ "resourceType" ], "type": "object", "properties": { "gatewayDetail": { "required": [ "name" ], "type": "object", "properties": { "id": { "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", "type": "string", "description": "Interconnect gateway id" }, "name": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Interconnect gateway name" }, "ownerId": { "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", "type": "string", "description": "Interconnect gateway owner account id" }, "region": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Interconnect gateway region name" }, "regionId": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Interconnect gateway region id" } }, "description": "Interconnect connection end gateway detail", "$$ref": "#/components/schemas/GatewayDetail" }, "interfaceDetail": { "type": "object", "properties": { "bgpAsn": { "pattern": "\\d+", "type": "string", "description": "BGP ASN of the connection end" }, "bgpKey": { "maxLength": 25, "minLength": 1, "type": "string", "description": "BGP key of the connection end" }, "interfaceName": { "maxLength": 64, "minLength": 1, "type": "string", "description": "Interface name of the connection end" }, "ipAddress": { "pattern": "^((([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\\p{N}\\p{L}]+)?)((\\s)(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\\p{N}\\p{L}]+)?)?$", "type": "string", "description": "Interface IP address of the connection end" }, "mtu": { "pattern": "^(1400|1496|1500)$", "type": "string", "description": "MTU of the connection end" }, "prefix": { "pattern": "^(?:3[0-0]|[0-2]?[0-9])$", "type": "string", "description": "Interface IP address prefix of the connection end" }, "vlanId": { "pattern": "\\d+", "type": "string", "description": "VLAN ID of the connection end" } }, "description": "Interconnect connection end interface detail", "$$ref": "#/components/schemas/InterconnectInterfaceDetail" }, "portDetail": { "required": [ "id", "name", "ownerId", "region", "regionId" ], "type": "object", "properties": { "id": { "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", "type": "string", "description": "Interconnect connection port id" }, "name": { "maxLength": 1024, "minLength": 1, "type": "string", "description": "Interconnect connection port name" }, "ownerId": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Interconnect connection port owner account id" }, "region": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Interconnect connection port region name" }, "regionId": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Interconnect connection port region id" } }, "description": "Interconnect connection end port detail", "$$ref": "#/components/schemas/PortDetail" }, "resourceType": { "type": "string", "description": "Interconnect connection end resource type" } }, "description": "Interconnect device connect connection destination", "$$ref": "#/components/schemas/ConnectionEndDetail" }, "googleCloudDetail": { "required": [ "cloudAccountName", "crossConnectType", "pairingKey" ], "type": "object", "properties": { "cloudAccountId": { "type": "string", "description": "Google cloud account id" }, "cloudAccountName": { "type": "string", "description": "Interconnect cloud connect cloud account name" }, "crossConnectType": { "pattern": "^GCR_ATTACHMENT$", "type": "string", "description": "Google cross connect type" }, "pairingKey": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Google GCR attachment pairing key" } }, "description": "Interconnect cloud connect Google cloud detail", "$$ref": "#/components/schemas/GoogleCloudDetail" }, "peeringInfo": { "required": [ "peeringType", "vpnSegment" ], "type": "object", "properties": { "customPeeringInfo": { "type": "object", "properties": { "advertisedPrefixes": { "type": "array", "description": "Custom prefixes to be advertised to cloud for public connections", "items": { "type": "string", "description": "Custom prefixes to be advertised to cloud for public connections" } }, "destinationEnd": { "type": "object", "properties": { "bgpAsn": { "pattern": "\\d+", "type": "string", "description": "Custom BGP ASN for a connection end" }, "ipAddress": { "pattern": "^((([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\\p{N}\\p{L}]+)?)((\\s)(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\\p{N}\\p{L}]+)?)?$", "type": "string", "description": "Custom ip address for a connection end" }, "prefix": { "pattern": "^(?:3[0-0]|[0-2]?[0-9])$", "type": "string", "description": "Custom ip address prefix for a connection end" } }, "description": "Custom peering information for Interconnect cross connection destination", "$$ref": "#/components/schemas/CustomPeeringDetails" }, "sourceEnd": { "type": "object", "properties": { "bgpAsn": { "pattern": "\\d+", "type": "string", "description": "Custom BGP ASN for a connection end" }, "ipAddress": { "pattern": "^((([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\\p{N}\\p{L}]+)?)((\\s)(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\\p{N}\\p{L}]+)?)?$", "type": "string", "description": "Custom ip address for a connection end" }, "prefix": { "pattern": "^(?:3[0-0]|[0-2]?[0-9])$", "type": "string", "description": "Custom ip address prefix for a connection end" } }, "description": "Custom peering information for Interconnect cross connection destination", "$$ref": "#/components/schemas/CustomPeeringDetails" } }, "description": "Interconnect cross connection custom peering information", "$$ref": "#/components/schemas/CustomPeeringInfo" }, "peeringType": { "type": "string", "description": "Interconnect cross connection peering type" }, "vpnSegment": { "pattern": "\\d+", "type": "string", "description": "Interconnect cross connection peering VPN segment" } }, "description": "Interconnect device connect peering information", "$$ref": "#/components/schemas/InterconnectCrossConnectionPeeringInfo" }, "virtualNetworkAssociationType": { "type": "string", "description": "Interconnect cloud connect virtual network association type" } }, "description": "Interconnect cross connection cloud connection detail", "$$ref": "#/components/schemas/CloudConnectDetail" }, "connectionId": { "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", "type": "string", "description": "Interconnect cross connection id" }, "connectionName": { "type": "string", "description": "Interconnect cross connection name" }, "connectionRole": { "type": "string", "description": "Interconnect cross connection role" }, "connectionSpeed": { "type": "string", "description": "Interconnect connectivity bandwidth" }, "connectionType": { "type": "string", "description": "Interconnect cross connection type" }, "deviceConnectDetail": { "required": [ "connectionDestination", "connectionSource", "peeringInfo" ], "type": "object", "properties": { "connectionDestination": { "required": [ "resourceType" ], "type": "object", "properties": { "gatewayDetail": { "required": [ "name" ], "type": "object", "properties": { "id": { "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", "type": "string", "description": "Interconnect gateway id" }, "name": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Interconnect gateway name" }, "ownerId": { "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", "type": "string", "description": "Interconnect gateway owner account id" }, "region": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Interconnect gateway region name" }, "regionId": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Interconnect gateway region id" } }, "description": "Interconnect connection end gateway detail", "$$ref": "#/components/schemas/GatewayDetail" }, "interfaceDetail": { "type": "object", "properties": { "bgpAsn": { "pattern": "\\d+", "type": "string", "description": "BGP ASN of the connection end" }, "bgpKey": { "maxLength": 25, "minLength": 1, "type": "string", "description": "BGP key of the connection end" }, "interfaceName": { "maxLength": 64, "minLength": 1, "type": "string", "description": "Interface name of the connection end" }, "ipAddress": { "pattern": "^((([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\\p{N}\\p{L}]+)?)((\\s)(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\\p{N}\\p{L}]+)?)?$", "type": "string", "description": "Interface IP address of the connection end" }, "mtu": { "pattern": "^(1400|1496|1500)$", "type": "string", "description": "MTU of the connection end" }, "prefix": { "pattern": "^(?:3[0-0]|[0-2]?[0-9])$", "type": "string", "description": "Interface IP address prefix of the connection end" }, "vlanId": { "pattern": "\\d+", "type": "string", "description": "VLAN ID of the connection end" } }, "description": "Interconnect connection end interface detail", "$$ref": "#/components/schemas/InterconnectInterfaceDetail" }, "portDetail": { "required": [ "id", "name", "ownerId", "region", "regionId" ], "type": "object", "properties": { "id": { "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", "type": "string", "description": "Interconnect connection port id" }, "name": { "maxLength": 1024, "minLength": 1, "type": "string", "description": "Interconnect connection port name" }, "ownerId": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Interconnect connection port owner account id" }, "region": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Interconnect connection port region name" }, "regionId": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Interconnect connection port region id" } }, "description": "Interconnect connection end port detail", "$$ref": "#/components/schemas/PortDetail" }, "resourceType": { "type": "string", "description": "Interconnect connection end resource type" } }, "description": "Interconnect device connect connection destination", "$$ref": "#/components/schemas/ConnectionEndDetail" }, "connectionSource": { "required": [ "resourceType" ], "type": "object", "properties": { "gatewayDetail": { "required": [ "name" ], "type": "object", "properties": { "id": { "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", "type": "string", "description": "Interconnect gateway id" }, "name": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Interconnect gateway name" }, "ownerId": { "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", "type": "string", "description": "Interconnect gateway owner account id" }, "region": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Interconnect gateway region name" }, "regionId": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Interconnect gateway region id" } }, "description": "Interconnect connection end gateway detail", "$$ref": "#/components/schemas/GatewayDetail" }, "interfaceDetail": { "type": "object", "properties": { "bgpAsn": { "pattern": "\\d+", "type": "string", "description": "BGP ASN of the connection end" }, "bgpKey": { "maxLength": 25, "minLength": 1, "type": "string", "description": "BGP key of the connection end" }, "interfaceName": { "maxLength": 64, "minLength": 1, "type": "string", "description": "Interface name of the connection end" }, "ipAddress": { "pattern": "^((([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\\p{N}\\p{L}]+)?)((\\s)(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\\p{N}\\p{L}]+)?)?$", "type": "string", "description": "Interface IP address of the connection end" }, "mtu": { "pattern": "^(1400|1496|1500)$", "type": "string", "description": "MTU of the connection end" }, "prefix": { "pattern": "^(?:3[0-0]|[0-2]?[0-9])$", "type": "string", "description": "Interface IP address prefix of the connection end" }, "vlanId": { "pattern": "\\d+", "type": "string", "description": "VLAN ID of the connection end" } }, "description": "Interconnect connection end interface detail", "$$ref": "#/components/schemas/InterconnectInterfaceDetail" }, "portDetail": { "required": [ "id", "name", "ownerId", "region", "regionId" ], "type": "object", "properties": { "id": { "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", "type": "string", "description": "Interconnect connection port id" }, "name": { "maxLength": 1024, "minLength": 1, "type": "string", "description": "Interconnect connection port name" }, "ownerId": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Interconnect connection port owner account id" }, "region": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Interconnect connection port region name" }, "regionId": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Interconnect connection port region id" } }, "description": "Interconnect connection end port detail", "$$ref": "#/components/schemas/PortDetail" }, "resourceType": { "type": "string", "description": "Interconnect connection end resource type" } }, "description": "Interconnect device connect connection destination", "$$ref": "#/components/schemas/ConnectionEndDetail" }, "peeringInfo": { "required": [ "peeringType", "vpnSegment" ], "type": "object", "properties": { "customPeeringInfo": { "type": "object", "properties": { "advertisedPrefixes": { "type": "array", "description": "Custom prefixes to be advertised to cloud for public connections", "items": { "type": "string", "description": "Custom prefixes to be advertised to cloud for public connections" } }, "destinationEnd": { "type": "object", "properties": { "bgpAsn": { "pattern": "\\d+", "type": "string", "description": "Custom BGP ASN for a connection end" }, "ipAddress": { "pattern": "^((([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\\p{N}\\p{L}]+)?)((\\s)(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\\p{N}\\p{L}]+)?)?$", "type": "string", "description": "Custom ip address for a connection end" }, "prefix": { "pattern": "^(?:3[0-0]|[0-2]?[0-9])$", "type": "string", "description": "Custom ip address prefix for a connection end" } }, "description": "Custom peering information for Interconnect cross connection destination", "$$ref": "#/components/schemas/CustomPeeringDetails" }, "sourceEnd": { "type": "object", "properties": { "bgpAsn": { "pattern": "\\d+", "type": "string", "description": "Custom BGP ASN for a connection end" }, "ipAddress": { "pattern": "^((([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\\p{N}\\p{L}]+)?)((\\s)(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\\p{N}\\p{L}]+)?)?$", "type": "string", "description": "Custom ip address for a connection end" }, "prefix": { "pattern": "^(?:3[0-0]|[0-2]?[0-9])$", "type": "string", "description": "Custom ip address prefix for a connection end" } }, "description": "Custom peering information for Interconnect cross connection destination", "$$ref": "#/components/schemas/CustomPeeringDetails" } }, "description": "Interconnect cross connection custom peering information", "$$ref": "#/components/schemas/CustomPeeringInfo" }, "peeringType": { "type": "string", "description": "Interconnect cross connection peering type" }, "vpnSegment": { "pattern": "\\d+", "type": "string", "description": "Interconnect cross connection peering VPN segment" } }, "description": "Interconnect device connect peering information", "$$ref": "#/components/schemas/InterconnectCrossConnectionPeeringInfo" } }, "description": "Interconnect cross connection device connection detail", "$$ref": "#/components/schemas/DeviceConnectDetail" }, "interconnectAccountId": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Interconnect account id" }, "interconnectType": { "type": "string", "description": "Interconnect provider type" }, "licenseDetail": { "type": "object", "properties": { "awsHcSkuEndDate": { "type": "string" }, "awsHcSkuId": { "type": "string" }, "endDate": { "type": "string" }, "maxLicensedBandwidth": { "type": "string" }, "skuId": { "type": "string" } }, "description": "Interconnect cross connection license information", "$$ref": "#/components/schemas/InterconnectCrossConnectionLicenseDetail" }, "licenseType": { "type": "string", "description": "Interconnect cross connection license type" }, "redundancyInfo": { "required": [ "connectionPairName" ], "type": "object", "properties": { "connectionPairId": { "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", "type": "string", "description": "Interconnect cross connection pair id" }, "connectionPairName": { "type": "string", "description": "Interconnect cross connection pair name" } }, "description": "Interconnect cross connection redundancy information", "$$ref": "#/components/schemas/RedundancyInfo" }, "resourceState": { "type": "object", "properties": { "resourceAssociationDetails": { "type": "array", "items": { "type": "object", "properties": { "associatedResourceConnectionStatus": { "type": "string" }, "associatedResourceId": { "type": "string" }, "associatedResourceName": { "type": "string" }, "associatedResourceStatus": { "type": "string" }, "associatedResourceType": { "type": "string" } }, "$$ref": "#/components/schemas/ResourceAssociationDetail" } }, "resourceState": { "type": "string" }, "resourceStateMessage": { "type": "string" }, "resourceStateUpdateTs": { "type": "string" } }, "description": "Interconnect virtual network connection resource state information", "$$ref": "#/components/schemas/InterconnectResourceState" } }, "$$ref": "#/components/schemas/InterconnectCrossConnection" } } } }, "required": true }, "responses": { "200": { "description": "Interconnect Process ID Information.", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "Procees Id of the task", "example": "51d0a0e4-983a-471c-9abb-724d58144884" } }, "$$ref": "#/components/schemas/ProcessResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/interconnect/connectivity/virtual-cross-connections/{connection-name}": { "get": { "tags": [ "Multicloud Interconnect - Connectivity" ], "summary": "Retrieve an Interconnect virtual cross connection.", "description": "API to retrieve an exisiting Interconnect virtual cross connection.", "operationId": "getInterconnectCrossConnection", "parameters": [ { "name": "connection-name", "in": "path", "description": "Interconnect virtual cross connection name", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "responses": { "200": { "description": "Accepted", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "Multicloud Interconnect - Connectivity" ], "summary": "Update private Interconnect cross connection.", "description": "API to update a virtual cross connection connection on an Interconnect Gateway at an Interconnect Provider.", "operationId": "updateInterconnectCrossConnection", "parameters": [ { "name": "connection-name", "in": "path", "description": "Interconnect virtual cross connection name", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "requestBody": { "description": "Request Payload for Multicloud Interconnect Virtual Cross Connections", "content": { "application/json": { "schema": { "required": [ "connectionId", "connectionName", "connectionRole", "connectionSpeed", "connectionType", "interconnectAccountId", "interconnectType" ], "type": "object", "properties": { "cloudConnectDetail": { "required": [ "cloudAccessType", "cloudType", "connectionDestination", "connectionSource", "peeringInfo" ], "type": "object", "properties": { "awsCloudDetail": { "required": [ "cloudAccountId", "cloudAccountName", "crossConnectType" ], "type": "object", "properties": { "cloudAccountId": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Interconnect cloud connect AWS cloud account id" }, "cloudAccountName": { "type": "string", "description": "Interconnect cloud connect cloud account name" }, "cloudSideBgpAsn": { "pattern": "\\d+", "type": "string", "description": "Interconnect cloud connect AWS cloud side BGP ASN" }, "crossConnectType": { "pattern": "^(HVIF|HCONN)$", "type": "string", "description": "Interconnect cloud connect AWS cross connect type" }, "hostedConnectionId": { "type": "string", "description": "Interconnect cloud connect AWS hosted connection id" }, "virtualInterfaceId": { "type": "string", "description": "Interconnect cloud connect AWS hosted virtual interface id" } }, "description": "Interconnect cloud connect AWS cloud detail", "$$ref": "#/components/schemas/AwsCloudDetail" }, "azureCloudDetail": { "required": [ "cloudAccountId", "cloudAccountName", "crossConnectType", "serviceKey" ], "type": "object", "properties": { "cloudAccountId": { "type": "string", "description": "Interconnect cloud connect Azure cloud account id" }, "cloudAccountName": { "type": "string", "description": "Interconnect cloud connect cloud account name" }, "crossConnectType": { "pattern": "^EXPRESS_ROUTE_CIRCUIT$", "type": "string", "description": "Interconnect cloud connect Azure cross connect type" }, "serviceKey": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Interconnect cloud connect Azure Express Route Circuit service key" } }, "description": "Interconnect cloud connect Azure cloud detail", "$$ref": "#/components/schemas/AzureCloudDetail" }, "cloudAccessType": { "type": "string", "description": "Interconnect cloud connect cloud access type" }, "cloudType": { "type": "string", "description": "Interconnect cloud connect cloud provider type" }, "connectionDestination": { "required": [ "resourceType" ], "type": "object", "properties": { "gatewayDetail": { "required": [ "name" ], "type": "object", "properties": { "id": { "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", "type": "string", "description": "Interconnect gateway id" }, "name": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Interconnect gateway name" }, "ownerId": { "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", "type": "string", "description": "Interconnect gateway owner account id" }, "region": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Interconnect gateway region name" }, "regionId": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Interconnect gateway region id" } }, "description": "Interconnect connection end gateway detail", "$$ref": "#/components/schemas/GatewayDetail" }, "interfaceDetail": { "type": "object", "properties": { "bgpAsn": { "pattern": "\\d+", "type": "string", "description": "BGP ASN of the connection end" }, "bgpKey": { "maxLength": 25, "minLength": 1, "type": "string", "description": "BGP key of the connection end" }, "interfaceName": { "maxLength": 64, "minLength": 1, "type": "string", "description": "Interface name of the connection end" }, "ipAddress": { "pattern": "^((([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\\p{N}\\p{L}]+)?)((\\s)(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\\p{N}\\p{L}]+)?)?$", "type": "string", "description": "Interface IP address of the connection end" }, "mtu": { "pattern": "^(1400|1496|1500)$", "type": "string", "description": "MTU of the connection end" }, "prefix": { "pattern": "^(?:3[0-0]|[0-2]?[0-9])$", "type": "string", "description": "Interface IP address prefix of the connection end" }, "vlanId": { "pattern": "\\d+", "type": "string", "description": "VLAN ID of the connection end" } }, "description": "Interconnect connection end interface detail", "$$ref": "#/components/schemas/InterconnectInterfaceDetail" }, "portDetail": { "required": [ "id", "name", "ownerId", "region", "regionId" ], "type": "object", "properties": { "id": { "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", "type": "string", "description": "Interconnect connection port id" }, "name": { "maxLength": 1024, "minLength": 1, "type": "string", "description": "Interconnect connection port name" }, "ownerId": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Interconnect connection port owner account id" }, "region": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Interconnect connection port region name" }, "regionId": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Interconnect connection port region id" } }, "description": "Interconnect connection end port detail", "$$ref": "#/components/schemas/PortDetail" }, "resourceType": { "type": "string", "description": "Interconnect connection end resource type" } }, "description": "Interconnect device connect connection destination", "$$ref": "#/components/schemas/ConnectionEndDetail" }, "connectionSource": { "required": [ "resourceType" ], "type": "object", "properties": { "gatewayDetail": { "required": [ "name" ], "type": "object", "properties": { "id": { "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", "type": "string", "description": "Interconnect gateway id" }, "name": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Interconnect gateway name" }, "ownerId": { "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", "type": "string", "description": "Interconnect gateway owner account id" }, "region": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Interconnect gateway region name" }, "regionId": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Interconnect gateway region id" } }, "description": "Interconnect connection end gateway detail", "$$ref": "#/components/schemas/GatewayDetail" }, "interfaceDetail": { "type": "object", "properties": { "bgpAsn": { "pattern": "\\d+", "type": "string", "description": "BGP ASN of the connection end" }, "bgpKey": { "maxLength": 25, "minLength": 1, "type": "string", "description": "BGP key of the connection end" }, "interfaceName": { "maxLength": 64, "minLength": 1, "type": "string", "description": "Interface name of the connection end" }, "ipAddress": { "pattern": "^((([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\\p{N}\\p{L}]+)?)((\\s)(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\\p{N}\\p{L}]+)?)?$", "type": "string", "description": "Interface IP address of the connection end" }, "mtu": { "pattern": "^(1400|1496|1500)$", "type": "string", "description": "MTU of the connection end" }, "prefix": { "pattern": "^(?:3[0-0]|[0-2]?[0-9])$", "type": "string", "description": "Interface IP address prefix of the connection end" }, "vlanId": { "pattern": "\\d+", "type": "string", "description": "VLAN ID of the connection end" } }, "description": "Interconnect connection end interface detail", "$$ref": "#/components/schemas/InterconnectInterfaceDetail" }, "portDetail": { "required": [ "id", "name", "ownerId", "region", "regionId" ], "type": "object", "properties": { "id": { "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", "type": "string", "description": "Interconnect connection port id" }, "name": { "maxLength": 1024, "minLength": 1, "type": "string", "description": "Interconnect connection port name" }, "ownerId": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Interconnect connection port owner account id" }, "region": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Interconnect connection port region name" }, "regionId": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Interconnect connection port region id" } }, "description": "Interconnect connection end port detail", "$$ref": "#/components/schemas/PortDetail" }, "resourceType": { "type": "string", "description": "Interconnect connection end resource type" } }, "description": "Interconnect device connect connection destination", "$$ref": "#/components/schemas/ConnectionEndDetail" }, "googleCloudDetail": { "required": [ "cloudAccountName", "crossConnectType", "pairingKey" ], "type": "object", "properties": { "cloudAccountId": { "type": "string", "description": "Google cloud account id" }, "cloudAccountName": { "type": "string", "description": "Interconnect cloud connect cloud account name" }, "crossConnectType": { "pattern": "^GCR_ATTACHMENT$", "type": "string", "description": "Google cross connect type" }, "pairingKey": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Google GCR attachment pairing key" } }, "description": "Interconnect cloud connect Google cloud detail", "$$ref": "#/components/schemas/GoogleCloudDetail" }, "peeringInfo": { "required": [ "peeringType", "vpnSegment" ], "type": "object", "properties": { "customPeeringInfo": { "type": "object", "properties": { "advertisedPrefixes": { "type": "array", "description": "Custom prefixes to be advertised to cloud for public connections", "items": { "type": "string", "description": "Custom prefixes to be advertised to cloud for public connections" } }, "destinationEnd": { "type": "object", "properties": { "bgpAsn": { "pattern": "\\d+", "type": "string", "description": "Custom BGP ASN for a connection end" }, "ipAddress": { "pattern": "^((([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\\p{N}\\p{L}]+)?)((\\s)(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\\p{N}\\p{L}]+)?)?$", "type": "string", "description": "Custom ip address for a connection end" }, "prefix": { "pattern": "^(?:3[0-0]|[0-2]?[0-9])$", "type": "string", "description": "Custom ip address prefix for a connection end" } }, "description": "Custom peering information for Interconnect cross connection destination", "$$ref": "#/components/schemas/CustomPeeringDetails" }, "sourceEnd": { "type": "object", "properties": { "bgpAsn": { "pattern": "\\d+", "type": "string", "description": "Custom BGP ASN for a connection end" }, "ipAddress": { "pattern": "^((([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\\p{N}\\p{L}]+)?)((\\s)(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\\p{N}\\p{L}]+)?)?$", "type": "string", "description": "Custom ip address for a connection end" }, "prefix": { "pattern": "^(?:3[0-0]|[0-2]?[0-9])$", "type": "string", "description": "Custom ip address prefix for a connection end" } }, "description": "Custom peering information for Interconnect cross connection destination", "$$ref": "#/components/schemas/CustomPeeringDetails" } }, "description": "Interconnect cross connection custom peering information", "$$ref": "#/components/schemas/CustomPeeringInfo" }, "peeringType": { "type": "string", "description": "Interconnect cross connection peering type" }, "vpnSegment": { "pattern": "\\d+", "type": "string", "description": "Interconnect cross connection peering VPN segment" } }, "description": "Interconnect device connect peering information", "$$ref": "#/components/schemas/InterconnectCrossConnectionPeeringInfo" }, "virtualNetworkAssociationType": { "type": "string", "description": "Interconnect cloud connect virtual network association type" } }, "description": "Interconnect cross connection cloud connection detail", "$$ref": "#/components/schemas/CloudConnectDetail" }, "connectionId": { "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", "type": "string", "description": "Interconnect cross connection id" }, "connectionName": { "type": "string", "description": "Interconnect cross connection name" }, "connectionRole": { "type": "string", "description": "Interconnect cross connection role" }, "connectionSpeed": { "type": "string", "description": "Interconnect connectivity bandwidth" }, "connectionType": { "type": "string", "description": "Interconnect cross connection type" }, "deviceConnectDetail": { "required": [ "connectionDestination", "connectionSource", "peeringInfo" ], "type": "object", "properties": { "connectionDestination": { "required": [ "resourceType" ], "type": "object", "properties": { "gatewayDetail": { "required": [ "name" ], "type": "object", "properties": { "id": { "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", "type": "string", "description": "Interconnect gateway id" }, "name": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Interconnect gateway name" }, "ownerId": { "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", "type": "string", "description": "Interconnect gateway owner account id" }, "region": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Interconnect gateway region name" }, "regionId": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Interconnect gateway region id" } }, "description": "Interconnect connection end gateway detail", "$$ref": "#/components/schemas/GatewayDetail" }, "interfaceDetail": { "type": "object", "properties": { "bgpAsn": { "pattern": "\\d+", "type": "string", "description": "BGP ASN of the connection end" }, "bgpKey": { "maxLength": 25, "minLength": 1, "type": "string", "description": "BGP key of the connection end" }, "interfaceName": { "maxLength": 64, "minLength": 1, "type": "string", "description": "Interface name of the connection end" }, "ipAddress": { "pattern": "^((([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\\p{N}\\p{L}]+)?)((\\s)(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\\p{N}\\p{L}]+)?)?$", "type": "string", "description": "Interface IP address of the connection end" }, "mtu": { "pattern": "^(1400|1496|1500)$", "type": "string", "description": "MTU of the connection end" }, "prefix": { "pattern": "^(?:3[0-0]|[0-2]?[0-9])$", "type": "string", "description": "Interface IP address prefix of the connection end" }, "vlanId": { "pattern": "\\d+", "type": "string", "description": "VLAN ID of the connection end" } }, "description": "Interconnect connection end interface detail", "$$ref": "#/components/schemas/InterconnectInterfaceDetail" }, "portDetail": { "required": [ "id", "name", "ownerId", "region", "regionId" ], "type": "object", "properties": { "id": { "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", "type": "string", "description": "Interconnect connection port id" }, "name": { "maxLength": 1024, "minLength": 1, "type": "string", "description": "Interconnect connection port name" }, "ownerId": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Interconnect connection port owner account id" }, "region": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Interconnect connection port region name" }, "regionId": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Interconnect connection port region id" } }, "description": "Interconnect connection end port detail", "$$ref": "#/components/schemas/PortDetail" }, "resourceType": { "type": "string", "description": "Interconnect connection end resource type" } }, "description": "Interconnect device connect connection destination", "$$ref": "#/components/schemas/ConnectionEndDetail" }, "connectionSource": { "required": [ "resourceType" ], "type": "object", "properties": { "gatewayDetail": { "required": [ "name" ], "type": "object", "properties": { "id": { "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", "type": "string", "description": "Interconnect gateway id" }, "name": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Interconnect gateway name" }, "ownerId": { "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", "type": "string", "description": "Interconnect gateway owner account id" }, "region": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Interconnect gateway region name" }, "regionId": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Interconnect gateway region id" } }, "description": "Interconnect connection end gateway detail", "$$ref": "#/components/schemas/GatewayDetail" }, "interfaceDetail": { "type": "object", "properties": { "bgpAsn": { "pattern": "\\d+", "type": "string", "description": "BGP ASN of the connection end" }, "bgpKey": { "maxLength": 25, "minLength": 1, "type": "string", "description": "BGP key of the connection end" }, "interfaceName": { "maxLength": 64, "minLength": 1, "type": "string", "description": "Interface name of the connection end" }, "ipAddress": { "pattern": "^((([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\\p{N}\\p{L}]+)?)((\\s)(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\\p{N}\\p{L}]+)?)?$", "type": "string", "description": "Interface IP address of the connection end" }, "mtu": { "pattern": "^(1400|1496|1500)$", "type": "string", "description": "MTU of the connection end" }, "prefix": { "pattern": "^(?:3[0-0]|[0-2]?[0-9])$", "type": "string", "description": "Interface IP address prefix of the connection end" }, "vlanId": { "pattern": "\\d+", "type": "string", "description": "VLAN ID of the connection end" } }, "description": "Interconnect connection end interface detail", "$$ref": "#/components/schemas/InterconnectInterfaceDetail" }, "portDetail": { "required": [ "id", "name", "ownerId", "region", "regionId" ], "type": "object", "properties": { "id": { "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", "type": "string", "description": "Interconnect connection port id" }, "name": { "maxLength": 1024, "minLength": 1, "type": "string", "description": "Interconnect connection port name" }, "ownerId": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Interconnect connection port owner account id" }, "region": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Interconnect connection port region name" }, "regionId": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Interconnect connection port region id" } }, "description": "Interconnect connection end port detail", "$$ref": "#/components/schemas/PortDetail" }, "resourceType": { "type": "string", "description": "Interconnect connection end resource type" } }, "description": "Interconnect device connect connection destination", "$$ref": "#/components/schemas/ConnectionEndDetail" }, "peeringInfo": { "required": [ "peeringType", "vpnSegment" ], "type": "object", "properties": { "customPeeringInfo": { "type": "object", "properties": { "advertisedPrefixes": { "type": "array", "description": "Custom prefixes to be advertised to cloud for public connections", "items": { "type": "string", "description": "Custom prefixes to be advertised to cloud for public connections" } }, "destinationEnd": { "type": "object", "properties": { "bgpAsn": { "pattern": "\\d+", "type": "string", "description": "Custom BGP ASN for a connection end" }, "ipAddress": { "pattern": "^((([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\\p{N}\\p{L}]+)?)((\\s)(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\\p{N}\\p{L}]+)?)?$", "type": "string", "description": "Custom ip address for a connection end" }, "prefix": { "pattern": "^(?:3[0-0]|[0-2]?[0-9])$", "type": "string", "description": "Custom ip address prefix for a connection end" } }, "description": "Custom peering information for Interconnect cross connection destination", "$$ref": "#/components/schemas/CustomPeeringDetails" }, "sourceEnd": { "type": "object", "properties": { "bgpAsn": { "pattern": "\\d+", "type": "string", "description": "Custom BGP ASN for a connection end" }, "ipAddress": { "pattern": "^((([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\\p{N}\\p{L}]+)?)((\\s)(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])(%[\\p{N}\\p{L}]+)?)?$", "type": "string", "description": "Custom ip address for a connection end" }, "prefix": { "pattern": "^(?:3[0-0]|[0-2]?[0-9])$", "type": "string", "description": "Custom ip address prefix for a connection end" } }, "description": "Custom peering information for Interconnect cross connection destination", "$$ref": "#/components/schemas/CustomPeeringDetails" } }, "description": "Interconnect cross connection custom peering information", "$$ref": "#/components/schemas/CustomPeeringInfo" }, "peeringType": { "type": "string", "description": "Interconnect cross connection peering type" }, "vpnSegment": { "pattern": "\\d+", "type": "string", "description": "Interconnect cross connection peering VPN segment" } }, "description": "Interconnect device connect peering information", "$$ref": "#/components/schemas/InterconnectCrossConnectionPeeringInfo" } }, "description": "Interconnect cross connection device connection detail", "$$ref": "#/components/schemas/DeviceConnectDetail" }, "interconnectAccountId": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Interconnect account id" }, "interconnectType": { "type": "string", "description": "Interconnect provider type" }, "licenseDetail": { "type": "object", "properties": { "awsHcSkuEndDate": { "type": "string" }, "awsHcSkuId": { "type": "string" }, "endDate": { "type": "string" }, "maxLicensedBandwidth": { "type": "string" }, "skuId": { "type": "string" } }, "description": "Interconnect cross connection license information", "$$ref": "#/components/schemas/InterconnectCrossConnectionLicenseDetail" }, "licenseType": { "type": "string", "description": "Interconnect cross connection license type" }, "redundancyInfo": { "required": [ "connectionPairName" ], "type": "object", "properties": { "connectionPairId": { "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", "type": "string", "description": "Interconnect cross connection pair id" }, "connectionPairName": { "type": "string", "description": "Interconnect cross connection pair name" } }, "description": "Interconnect cross connection redundancy information", "$$ref": "#/components/schemas/RedundancyInfo" }, "resourceState": { "type": "object", "properties": { "resourceAssociationDetails": { "type": "array", "items": { "type": "object", "properties": { "associatedResourceConnectionStatus": { "type": "string" }, "associatedResourceId": { "type": "string" }, "associatedResourceName": { "type": "string" }, "associatedResourceStatus": { "type": "string" }, "associatedResourceType": { "type": "string" } }, "$$ref": "#/components/schemas/ResourceAssociationDetail" } }, "resourceState": { "type": "string" }, "resourceStateMessage": { "type": "string" }, "resourceStateUpdateTs": { "type": "string" } }, "description": "Interconnect virtual network connection resource state information", "$$ref": "#/components/schemas/InterconnectResourceState" } }, "$$ref": "#/components/schemas/InterconnectCrossConnection" } } }, "required": true }, "responses": { "200": { "description": "Interconnect Process ID Information.", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "Procees Id of the task", "example": "51d0a0e4-983a-471c-9abb-724d58144884" } }, "$$ref": "#/components/schemas/ProcessResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Multicloud Interconnect - Connectivity" ], "summary": "Delete an Interconnect virtual cross connection.", "description": "API to delete an Interconnect virtual cross connection at an Interconnect provider.", "operationId": "deleteInterconnectCrossConnection", "parameters": [ { "name": "connection-name", "in": "path", "description": "Interconnect virtual cross connection name", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "responses": { "200": { "description": "Interconnect Process ID Information.", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "Procees Id of the task", "example": "51d0a0e4-983a-471c-9abb-724d58144884" } }, "$$ref": "#/components/schemas/ProcessResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/interconnect/connectivity/virtual-network-connections": { "get": { "tags": [ "Multicloud Interconnect - Connectivity" ], "summary": "Retrieve all Interconnect virtual network connections.", "description": "API to retrieve all exisiting Interconnect virtual network connections.", "operationId": "getInterconnectVirtualNetworkConnections", "parameters": [ { "name": "connection-name", "in": "query", "description": "Interconnect virtual cross connection name", "schema": { "pattern": "^[\\w.:-]{1,256}$", "type": "string" } }, { "name": "cloud-type", "in": "query", "description": "Cloud provider type", "schema": { "pattern": "^(AWS|AZURE|GCP)$", "type": "string" } }, { "name": "cloud-account-id", "in": "query", "description": "Cloud account id", "schema": { "maxLength": 255, "minLength": 1, "type": "string" } }, { "name": "refresh", "in": "query", "description": "Interconnect virtual network connection provider sync enabled", "schema": { "pattern": "(true|false)", "type": "string", "default": "false" } } ], "responses": { "200": { "description": "Accepted", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Multicloud Interconnect - Connectivity" ], "summary": "Create an Interconnect virtual network connection.", "description": "API to create a Interconnect virtual network connection between virtual network Tags and OnRamp gateway connection.", "operationId": "createInterconenctVirtualNetworkConnection", "requestBody": { "description": "Request Payload for Interconnect virtual network Connections", "content": { "application/json": { "schema": { "type": "array", "items": { "required": [ "cloudAccountId", "cloudAccountName", "cloudType", "connectionName", "virtualNetworkTagAssociationType", "virtualNetworkTagAssociations", "virtualNetworkTags" ], "type": "object", "properties": { "cloudAccountId": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Interconnect virtual network connection cloud account id" }, "cloudAccountName": { "type": "string", "description": "Interconnect virtual network connection cloud account name" }, "cloudType": { "pattern": "^(AWS|AZURE)$", "type": "string", "description": "Cloud provider type" }, "connectionId": { "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", "type": "string", "description": "Interconnect virtual network connection id" }, "connectionName": { "pattern": "^[\\w.:-]{1,256}$", "type": "string", "description": "Interconnect virtual network connection name" }, "resourceState": { "type": "object", "properties": { "resourceAssociationDetails": { "type": "array", "items": { "type": "object", "properties": { "associatedResourceConnectionStatus": { "type": "string" }, "associatedResourceId": { "type": "string" }, "associatedResourceName": { "type": "string" }, "associatedResourceStatus": { "type": "string" }, "associatedResourceType": { "type": "string" } }, "$$ref": "#/components/schemas/ResourceAssociationDetail" } }, "resourceState": { "type": "string" }, "resourceStateMessage": { "type": "string" }, "resourceStateUpdateTs": { "type": "string" } }, "description": "Interconnect virtual network connection resource state information", "$$ref": "#/components/schemas/InterconnectResourceState" }, "virtualNetworkTagAssociationType": { "type": "string", "description": "Interconnect virtual network connection tag association type " }, "virtualNetworkTagAssociations": { "type": "array", "description": "Interconnect virtual network connection virtual network tag association list", "items": { "required": [ "resourceType" ], "type": "object", "properties": { "onRampGatewayConnection": { "required": [ "name" ], "type": "object", "properties": { "id": { "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", "type": "string", "description": "Interconnect onRamp gateway connection id" }, "name": { "pattern": "^[\\w.:-]{1,256}$", "type": "string", "description": "Interconnect onRamp gateway connection name" } }, "description": "Interconnect onRamp gateway connection information", "$$ref": "#/components/schemas/OnRampGatewayConnection" }, "resourceType": { "type": "string", "description": "Type of resource to be associated to the tag" } }, "description": "Interconnect virtual network connection virtual network tag association list", "$$ref": "#/components/schemas/VirtualNetworkTagAssociation" } }, "virtualNetworkTags": { "type": "array", "description": "Interconnect virtual network connection virtual network tag list", "items": { "required": [ "tagName" ], "type": "object", "properties": { "tagName": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Name of the Host VPC/VNET tag" } }, "description": "Interconnect virtual network connection virtual network tag list", "$$ref": "#/components/schemas/VirtualNetworkTag" } } }, "$$ref": "#/components/schemas/InterconnectVirtualNetworkConnection" } } } }, "required": true }, "responses": { "200": { "description": "Interconnect Process ID Information.", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "Procees Id of the task", "example": "51d0a0e4-983a-471c-9abb-724d58144884" } }, "$$ref": "#/components/schemas/ProcessResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/interconnect/connectivity/virtual-network-connections/{connection-name}": { "get": { "tags": [ "Multicloud Interconnect - Connectivity" ], "summary": "Retrieve an Interconnect virtual network connection.", "description": "API to retrieve an exisiting Interconnect Interconnect virtual network connection.", "operationId": "getInterconnectVirtualNetworkConnection", "parameters": [ { "name": "connection-name", "in": "path", "description": "Interconnect virtual network connection name", "required": true, "schema": { "pattern": "^[\\w.:-]{1,256}$", "type": "string" } } ], "responses": { "200": { "description": "Accepted", "content": { "application/json": { "schema": { "required": [ "cloudAccountId", "cloudAccountName", "cloudType", "connectionName", "virtualNetworkTagAssociationType", "virtualNetworkTagAssociations", "virtualNetworkTags" ], "type": "object", "properties": { "cloudAccountId": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Interconnect virtual network connection cloud account id" }, "cloudAccountName": { "type": "string", "description": "Interconnect virtual network connection cloud account name" }, "cloudType": { "pattern": "^(AWS|AZURE)$", "type": "string", "description": "Cloud provider type" }, "connectionId": { "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", "type": "string", "description": "Interconnect virtual network connection id" }, "connectionName": { "pattern": "^[\\w.:-]{1,256}$", "type": "string", "description": "Interconnect virtual network connection name" }, "resourceState": { "type": "object", "properties": { "resourceAssociationDetails": { "type": "array", "items": { "type": "object", "properties": { "associatedResourceConnectionStatus": { "type": "string" }, "associatedResourceId": { "type": "string" }, "associatedResourceName": { "type": "string" }, "associatedResourceStatus": { "type": "string" }, "associatedResourceType": { "type": "string" } }, "$$ref": "#/components/schemas/ResourceAssociationDetail" } }, "resourceState": { "type": "string" }, "resourceStateMessage": { "type": "string" }, "resourceStateUpdateTs": { "type": "string" } }, "description": "Interconnect virtual network connection resource state information", "$$ref": "#/components/schemas/InterconnectResourceState" }, "virtualNetworkTagAssociationType": { "type": "string", "description": "Interconnect virtual network connection tag association type " }, "virtualNetworkTagAssociations": { "type": "array", "description": "Interconnect virtual network connection virtual network tag association list", "items": { "required": [ "resourceType" ], "type": "object", "properties": { "onRampGatewayConnection": { "required": [ "name" ], "type": "object", "properties": { "id": { "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", "type": "string", "description": "Interconnect onRamp gateway connection id" }, "name": { "pattern": "^[\\w.:-]{1,256}$", "type": "string", "description": "Interconnect onRamp gateway connection name" } }, "description": "Interconnect onRamp gateway connection information", "$$ref": "#/components/schemas/OnRampGatewayConnection" }, "resourceType": { "type": "string", "description": "Type of resource to be associated to the tag" } }, "description": "Interconnect virtual network connection virtual network tag association list", "$$ref": "#/components/schemas/VirtualNetworkTagAssociation" } }, "virtualNetworkTags": { "type": "array", "description": "Interconnect virtual network connection virtual network tag list", "items": { "required": [ "tagName" ], "type": "object", "properties": { "tagName": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Name of the Host VPC/VNET tag" } }, "description": "Interconnect virtual network connection virtual network tag list", "$$ref": "#/components/schemas/VirtualNetworkTag" } } }, "$$ref": "#/components/schemas/InterconnectVirtualNetworkConnection" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Multicloud Interconnect - Connectivity" ], "summary": "Delete an Interconnect virtual network connection.", "description": "API to delete an Interconnect virtual network connection.", "operationId": "deleteInterconnectVirtualNetworkConnection", "parameters": [ { "name": "connection-name", "in": "path", "description": "Interconnect virtual cross connection name", "required": true, "schema": { "pattern": "^[\\w.:-]{1,256}$", "type": "string" } } ], "responses": { "200": { "description": "Interconnect Process ID Information.", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "Procees Id of the task", "example": "51d0a0e4-983a-471c-9abb-724d58144884" } }, "$$ref": "#/components/schemas/ProcessResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "Multicloud Interconnect - Connectivity" ], "summary": "Update a private Interconnect virtual network connection.", "description": "API to update a virtual network connection between virtual network Tags and onRamp gateway connection.", "operationId": "updateInterconnectVirtualNetworkConnection", "parameters": [ { "name": "connection-name", "in": "path", "description": "Interconnect virtual network connection name", "required": true, "schema": { "pattern": "^[\\w.:-]{1,256}$", "type": "string" } } ], "requestBody": { "description": "Request Payload for Interconnect virtual network connections", "content": { "application/json": { "schema": { "required": [ "cloudAccountId", "cloudAccountName", "cloudType", "connectionName", "virtualNetworkTagAssociationType", "virtualNetworkTagAssociations", "virtualNetworkTags" ], "type": "object", "properties": { "cloudAccountId": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Interconnect virtual network connection cloud account id" }, "cloudAccountName": { "type": "string", "description": "Interconnect virtual network connection cloud account name" }, "cloudType": { "pattern": "^(AWS|AZURE)$", "type": "string", "description": "Cloud provider type" }, "connectionId": { "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", "type": "string", "description": "Interconnect virtual network connection id" }, "connectionName": { "pattern": "^[\\w.:-]{1,256}$", "type": "string", "description": "Interconnect virtual network connection name" }, "resourceState": { "type": "object", "properties": { "resourceAssociationDetails": { "type": "array", "items": { "type": "object", "properties": { "associatedResourceConnectionStatus": { "type": "string" }, "associatedResourceId": { "type": "string" }, "associatedResourceName": { "type": "string" }, "associatedResourceStatus": { "type": "string" }, "associatedResourceType": { "type": "string" } }, "$$ref": "#/components/schemas/ResourceAssociationDetail" } }, "resourceState": { "type": "string" }, "resourceStateMessage": { "type": "string" }, "resourceStateUpdateTs": { "type": "string" } }, "description": "Interconnect virtual network connection resource state information", "$$ref": "#/components/schemas/InterconnectResourceState" }, "virtualNetworkTagAssociationType": { "type": "string", "description": "Interconnect virtual network connection tag association type " }, "virtualNetworkTagAssociations": { "type": "array", "description": "Interconnect virtual network connection virtual network tag association list", "items": { "required": [ "resourceType" ], "type": "object", "properties": { "onRampGatewayConnection": { "required": [ "name" ], "type": "object", "properties": { "id": { "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", "type": "string", "description": "Interconnect onRamp gateway connection id" }, "name": { "pattern": "^[\\w.:-]{1,256}$", "type": "string", "description": "Interconnect onRamp gateway connection name" } }, "description": "Interconnect onRamp gateway connection information", "$$ref": "#/components/schemas/OnRampGatewayConnection" }, "resourceType": { "type": "string", "description": "Type of resource to be associated to the tag" } }, "description": "Interconnect virtual network connection virtual network tag association list", "$$ref": "#/components/schemas/VirtualNetworkTagAssociation" } }, "virtualNetworkTags": { "type": "array", "description": "Interconnect virtual network connection virtual network tag list", "items": { "required": [ "tagName" ], "type": "object", "properties": { "tagName": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Name of the Host VPC/VNET tag" } }, "description": "Interconnect virtual network connection virtual network tag list", "$$ref": "#/components/schemas/VirtualNetworkTag" } } }, "$$ref": "#/components/schemas/InterconnectVirtualNetworkConnection" } } }, "required": true }, "responses": { "200": { "description": "Interconnect Process ID Information.", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "Procees Id of the task", "example": "51d0a0e4-983a-471c-9abb-724d58144884" } }, "$$ref": "#/components/schemas/ProcessResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/interconnect/dashboard": { "get": { "tags": [ "Multicloud Interconnect - General" ], "summary": "Get Multicloud Interconnect dashboard view.", "description": "API to retrieve Multicloud Interconnect dashboard view.", "operationId": "getInterconnectDashboard", "responses": { "200": { "description": "Interconnect Dashboard Response.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "connections": { "type": "array", "items": { "type": "object", "properties": { "connectivityName": { "type": "string" }, "resourceState": { "type": "string" } }, "$$ref": "#/components/schemas/InterconnectDashboardConnections" } }, "devices": { "type": "array", "items": { "type": "string" } }, "edgeAccountId": { "type": "string" }, "edgeAccountName": { "type": "string" }, "edgeGatewayId": { "type": "string" }, "edgeGatewayName": { "type": "string" }, "edgeType": { "type": "string", "enum": [ "MEGAPORT", "EQUINIX" ] }, "linkList": { "type": "array", "items": { "type": "object", "properties": { "deviceLinkName": { "type": "string" }, "resourceState": { "type": "string" } }, "$$ref": "#/components/schemas/InterconnectDashboardLinkList" } }, "region": { "type": "string" }, "resourceState": { "type": "string" }, "resourceStateUpdateTs": { "type": "string" } }, "$$ref": "#/components/schemas/InterconnectDashboard" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/interconnect/entitlement/licenses": { "get": { "tags": [ "Multicloud Interconnect - Entitlement" ], "summary": "Get Interconnect Licenses", "description": "API to retrieve Interconnect licences", "operationId": "getInterconnectLicenses", "parameters": [ { "name": "interconnect-type", "in": "query", "description": "Interconnect provider type", "required": true, "schema": { "type": "string" } }, { "name": "interconnect-account-id", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "refresh", "in": "query", "schema": { "pattern": "(true|false)", "type": "string", "default": "false" } }, { "name": "product-type", "in": "query", "description": "Interconnect License Product Type", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Accepted", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "currentStatus": { "type": "string", "example": "AVAILABLE" }, "edgeAccountName": { "type": "string", "example": "mp-license-acc" }, "endDate": { "type": "string", "example": "2025-01-15" }, "prodType": { "type": "string", "example": "AWSHC" }, "sku": { "type": "string", "example": "AWS-HC-IIVXC-C" }, "skuDaysForExpiry": { "type": "number", "example": 924 }, "skuId": { "type": "string" }, "smartAccountId": { "type": "string", "example": "100259" }, "startDate": { "type": "string", "example": "2022-01-19" }, "subscriptionReferenceId": { "type": "string", "example": "Sub1077241" }, "technicalServiceUid": { "type": "string" }, "virtualAccountId": { "type": "string", "example": "109733" }, "vxcBandwidth": { "type": "string", "example": "1000" }, "webOrderId": { "type": "string", "example": "91358156" } }, "$$ref": "#/components/schemas/InterconnectLicense" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/interconnect/gateways": { "get": { "tags": [ "Multicloud Interconnect - Gateways" ], "summary": "Get all Interconnect Gateways.", "description": "API to retrieve all Interconnect Gateways from vManage.", "operationId": "getInterconnectGateways", "parameters": [ { "name": "interconnect-type", "in": "query", "description": "Interconnect provider type", "schema": { "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]{1,22}[a-zA-Z0-9]$", "type": "string", "enum": [ "MEGAPORT", "EQUINIX" ] } }, { "name": "interconnect-account-id", "in": "query", "description": "Interconnect provider account id", "schema": { "type": "string" } }, { "name": "region", "in": "query", "description": "Interconnect Region", "schema": { "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]{1,22}[a-zA-Z0-9]$", "type": "string" } }, { "name": "region-id", "in": "query", "description": "Interconnect Region Id", "schema": { "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]{1,22}[a-zA-Z0-9]$", "type": "string" } }, { "name": "interconnect-gateway-name", "in": "query", "description": "Interconnect Gateway Name", "schema": { "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]{1,22}[a-zA-Z0-9]$", "type": "string" } }, { "name": "resource-state", "in": "query", "description": "Interconnect Resource State", "schema": { "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]{1,22}[a-zA-Z0-9]$", "type": "string" } }, { "name": "interconnect-billing-account-id", "in": "query", "description": "Interconnect Billing Account Id", "schema": { "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]{1,22}[a-zA-Z0-9]$", "type": "string" } }, { "name": "refresh", "in": "query", "schema": { "pattern": "(true|false)", "type": "string", "default": "false" } } ], "responses": { "200": { "description": "All Interconnect Gateways .", "content": { "application/json": { "schema": { "type": "array", "items": { "required": [ "deviceUuid", "edgeAccountId", "edgeBillingAccountId", "edgeGatewayName", "edgeType", "ipTransit", "licenseType", "region", "regionId", "siteName" ], "type": "object", "properties": { "configGroupSettings": { "required": [ "configGroupId", "configGroupName" ], "type": "object", "properties": { "configGroupId": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Config Group Id", "example": "482eb6f3-1168-4b6f-901a-bd2c788b370d" }, "configGroupName": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Config Group name", "example": "My-CG-1" } }, "$$ref": "#/components/schemas/InterconnectConfigGroupSettings" }, "description": { "maxLength": 255, "minLength": 1, "type": "string" }, "deviceUuid": { "maxLength": 255, "minLength": 1, "type": "string" }, "edgeAccountId": { "maxLength": 255, "minLength": 1, "type": "string" }, "edgeBillingAccountId": { "maxLength": 255, "minLength": 1, "type": "string" }, "edgeGatewayName": { "maxLength": 255, "minLength": 1, "type": "string" }, "edgeType": { "type": "string" }, "egwBgpAsn": { "type": "string", "description": "BGP ASN assigned to Interconnect Gateway", "example": "64500" }, "ipTransit": { "maxLength": 255, "minLength": 1, "type": "string" }, "ipTransitId": { "type": "string" }, "ipTransitSkuId": { "type": "string" }, "isCustomSetting": { "type": "boolean", "description": "Custom Settings enabled for Interconnect Gateway", "example": true }, "licenseSkuId": { "type": "string", "description": "License Sku Id of Interconnect Gateway", "example": "12345" }, "licenseType": { "type": "string", "enum": [ "PAYG", "PREPAID", "DIRECT" ] }, "loopbackCidr": { "type": "string", "description": "Ip pool allocated to Interconnect Gateway for Loopback Interfaces", "example": "172.31.251.4/30" }, "mrfSettings": { "type": "object", "properties": { "mrfRouterRole": { "type": "string", "description": "Multi Region Fabric router role", "example": "border" }, "mrfTransportGateway": { "type": "boolean", "description": "Multi Region Fabric Transport Gateway", "example": false }, "nhmRegionId": { "type": "integer", "description": "Network Hierarchy Region Id", "format": "int64", "example": 123 }, "nhmRegionName": { "type": "string", "description": "Network Hierarchy Region name", "example": "My-Region" } }, "$$ref": "#/components/schemas/InterconnectMrfSettings" }, "region": { "maxLength": 255, "minLength": 1, "type": "string" }, "regionId": { "maxLength": 255, "minLength": 1, "type": "string" }, "resourceState": { "type": "string" }, "resourceStateMessage": { "type": "string" }, "resourceStateUpdateTs": { "type": "string" }, "serviceChainAttachments": { "type": "string" }, "settings": { "required": [ "instanceSize", "softwareImageId" ], "type": "object", "properties": { "edgeGatewaySolution": { "type": "string", "enum": [ "MVE", "NE" ] }, "edgeType": { "type": "string", "enum": [ "MEGAPORT", "EQUINIX", "ATT" ] }, "egwCustomSettingName": { "type": "string", "description": "Assigned name of the Interconnect Gateway Custom Settings" }, "instanceSize": { "maxLength": 255, "minLength": 1, "type": "string" }, "ipSubnetPool": { "type": "string", "description": "Ip subnet pool assigned to the gateway", "example": "192.168.10.0/24" }, "softwareImageId": { "maxLength": 255, "minLength": 1, "pattern": "^C8000v.*$", "type": "string" } }, "$$ref": "#/components/schemas/InterconnectGatewaySettings" }, "siteName": { "maxLength": 255, "minLength": 1, "type": "string" } }, "$$ref": "#/components/schemas/InterconnectGatewayExtended" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "post": { "tags": [ "Multicloud Interconnect - Gateways" ], "summary": "Create Interconnect gateway.", "description": "API to create an Intercoonect gateway in an Interconnect provider.", "operationId": "createInterconnectGateway", "requestBody": { "description": "Request Payload for Multicloud Interconnect Gateways", "content": { "application/json": { "schema": { "required": [ "deviceUuid", "edgeAccountId", "edgeBillingAccountId", "edgeGatewayName", "edgeType", "ipTransit", "licenseType", "region", "regionId", "siteName" ], "type": "object", "properties": { "configGroupSettings": { "required": [ "configGroupId", "configGroupName" ], "type": "object", "properties": { "configGroupId": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Config Group Id", "example": "482eb6f3-1168-4b6f-901a-bd2c788b370d" }, "configGroupName": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Config Group name", "example": "My-CG-1" } }, "$$ref": "#/components/schemas/InterconnectConfigGroupSettings" }, "description": { "maxLength": 255, "minLength": 1, "type": "string" }, "deviceUuid": { "maxLength": 255, "minLength": 1, "type": "string" }, "edgeAccountId": { "maxLength": 255, "minLength": 1, "type": "string" }, "edgeBillingAccountId": { "maxLength": 255, "minLength": 1, "type": "string" }, "edgeGatewayName": { "maxLength": 255, "minLength": 1, "type": "string" }, "edgeType": { "type": "string" }, "egwBgpAsn": { "type": "string", "description": "BGP ASN assigned to Interconnect Gateway", "example": "64500" }, "ipTransit": { "maxLength": 255, "minLength": 1, "type": "string" }, "ipTransitId": { "type": "string" }, "ipTransitSkuId": { "type": "string" }, "isCustomSetting": { "type": "boolean", "description": "Custom Settings enabled for Interconnect Gateway", "example": true }, "licenseSkuId": { "type": "string", "description": "License Sku Id of Interconnect Gateway", "example": "12345" }, "licenseType": { "type": "string", "enum": [ "PAYG", "PREPAID", "DIRECT" ] }, "loopbackCidr": { "type": "string", "description": "Ip pool allocated to Interconnect Gateway for Loopback Interfaces", "example": "172.31.251.4/30" }, "mrfSettings": { "type": "object", "properties": { "mrfRouterRole": { "type": "string", "description": "Multi Region Fabric router role", "example": "border" }, "mrfTransportGateway": { "type": "boolean", "description": "Multi Region Fabric Transport Gateway", "example": false }, "nhmRegionId": { "type": "integer", "description": "Network Hierarchy Region Id", "format": "int64", "example": 123 }, "nhmRegionName": { "type": "string", "description": "Network Hierarchy Region name", "example": "My-Region" } }, "$$ref": "#/components/schemas/InterconnectMrfSettings" }, "region": { "maxLength": 255, "minLength": 1, "type": "string" }, "regionId": { "maxLength": 255, "minLength": 1, "type": "string" }, "resourceState": { "type": "string" }, "resourceStateMessage": { "type": "string" }, "resourceStateUpdateTs": { "type": "string" }, "serviceChainAttachments": { "type": "string" }, "settings": { "required": [ "instanceSize", "softwareImageId" ], "type": "object", "properties": { "edgeGatewaySolution": { "type": "string", "enum": [ "MVE", "NE" ] }, "edgeType": { "type": "string", "enum": [ "MEGAPORT", "EQUINIX", "ATT" ] }, "egwCustomSettingName": { "type": "string", "description": "Assigned name of the Interconnect Gateway Custom Settings" }, "instanceSize": { "maxLength": 255, "minLength": 1, "type": "string" }, "ipSubnetPool": { "type": "string", "description": "Ip subnet pool assigned to the gateway", "example": "192.168.10.0/24" }, "softwareImageId": { "maxLength": 255, "minLength": 1, "pattern": "^C8000v.*$", "type": "string" } }, "$$ref": "#/components/schemas/InterconnectGatewaySettings" }, "siteName": { "maxLength": 255, "minLength": 1, "type": "string" } }, "$$ref": "#/components/schemas/InterconnectGatewayExtended" }, "examples": { "Interconnect Megaport Gateways": { "description": "Interconnect Megaport Gateways", "value": { "edgeType": "MEGAPORT", "edgeAccountId": "ABCD-1234-CDEF", "edgeGatewayName": "mp-gateway-name", "description": "This is my Megaport gateway", "region": "Cologix TOR1, Toronto, ON, Canada : Toronto", "regionId": "10", "siteName": "My_Megaport_Site", "deviceUuid": "C8K-f7f6c42c-409d-11eb-9562-005056841be8", "settings": { "instanceSize": "Small", "softwareImageId": "C8000v 17.09.01a" }, "mrfSettings": { "mrfRouterRole": "border", "mrfTransportGateway": false } } }, "Interconnect Equinix Gateways - MRF Enabled": { "description": "Interconnect Equinix Gateways - MRF Enabled", "value": "{\n \"edgeType\": \"EQUINIX\",\n \"edgeAccountId\": \"ABCD-1234-CDEF\",\n \"edgeGatewayName\": \"eq-gateway-name\",\n \"description\": \"This is my Equinix Gateway\",\n \"region\": \"NY Metro\",\n \"regionId\": \"10\",\n \"edgeBillingAccountId\": \"ABCD-1234-CDEF\",\n \"siteName\": \"My_Equinix_Site\",\n \"deviceUuid\": \"CSR-725caea2-41a4-497c-821d-a2e280be40f2\",\n \"mrfSettings\": {\n \"mrfRouterRole\": \"edge\",\n \"mrfTransportGateway\": false\n }\n \"settings\": {\n \"instanceSize\": \"Small\",\n \"softwareImageId\": \"CSR1000v 17.03.03\"\n }\n}" } } } }, "required": true }, "responses": { "200": { "description": "Interconnect Process ID Information.", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "Procees Id of the task", "example": "51d0a0e4-983a-471c-9abb-724d58144884" } }, "$$ref": "#/components/schemas/ProcessResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/interconnect/gateways/config-group": { "post": { "tags": [ "Multicloud Interconnect - Gateways" ], "summary": "Create Interconnect gateway config group.", "description": "API to initiate a config group creation for an Interconnect gateway.", "operationId": "createInterconnectGatewayConfigGroup", "parameters": [ { "name": "interconnect-type", "in": "query", "description": "Interconnect provider type", "required": true, "schema": { "type": "string", "enum": [ "MEGAPORT", "EQUINIX" ] } } ], "requestBody": { "description": "Request Payload for Multicloud Interconnect Gateway Config Group Creation", "content": { "application/json": { "schema": { "required": [ "configGroupName" ], "type": "object", "properties": { "configGroupName": { "maxLength": 255, "minLength": 1, "type": "string" } }, "$$ref": "#/components/schemas/GatewaysConfiggroupBody" }, "examples": { "Interconnect Gateway Config Group Creation": { "description": "Interconnect Gateway Config Group Creation", "value": { "configGroupName": "ICGW_Config_Group" } } } } }, "required": true }, "responses": { "200": { "description": "Accepted", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/interconnect/gateways/image-names": { "get": { "tags": [ "Multicloud Interconnect - Gateways" ], "summary": "Get Interconnect gateway software versions.", "description": "API to retrieve Interconnect Gateway software image versions supported by an Interconnect Provider.", "operationId": "getInterconnectGatewayImageNames", "parameters": [ { "name": "interconnect-type", "in": "query", "description": "Interconnect provider type", "required": true, "schema": { "type": "string", "enum": [ "MEGAPORT", "EQUINIX" ] } } ], "responses": { "200": { "description": "Accepted", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "description": "version data list", "example": [ "C8000v 17.05.01a", "C8000v 17.06.01a" ], "items": { "type": "string", "description": "version data", "example": "C8000v 17.06.01a" } } }, "$$ref": "#/components/schemas/InlineResponse2005" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/interconnect/gateways/instance-sizes": { "get": { "tags": [ "Multicloud Interconnect - Gateways" ], "summary": "Get Interconnect gateway instance sizes.", "description": "API to retrieve Interconnect Gateway instance sizes supported by an Interconnect provider.", "operationId": "getInterconnectGatewayInstanceSizes", "parameters": [ { "name": "interconnect-type", "in": "query", "description": "Interconnect provider type", "required": true, "schema": { "type": "string", "enum": [ "MEGAPORT", "EQUINIX" ] } } ], "responses": { "200": { "description": "Accepted", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "description": "List of size specs data", "example": [ { "size": "Small", "spec": "small" }, { "size": "Medium", "spec": "medium" } ], "items": { "type": "object", "properties": { "size": { "type": "string", "description": "instance size", "example": "Small" }, "spec": { "type": "string", "description": "instance size", "example": "small" } }, "description": "Size spec object", "$$ref": "#/components/schemas/InlineResponse2004Data" } } }, "$$ref": "#/components/schemas/InlineResponse2004" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/interconnect/gateways/push-config": { "post": { "tags": [ "Multicloud Interconnect - Gateways" ], "summary": "Push Interconnect gateway configuration.", "description": "API to initiate a configuration push for an Interconnect gateway.", "operationId": "pushInterconnectGatewayConfig", "requestBody": { "description": "Request Payload for Multicloud Interconnect Gateway Configuration Push", "content": { "application/json": { "schema": { "required": [ "edgeGatewayName", "edgeType" ], "type": "object", "properties": { "edgeGatewayName": { "maxLength": 255, "minLength": 1, "type": "string" }, "edgeType": { "maxLength": 255, "minLength": 1, "type": "string" } }, "$$ref": "#/components/schemas/GatewaysPushconfigBody" }, "examples": { "Interconnect Gateway Configuration Push": { "description": "Interconnect Gateway Configuration Push", "value": { "edgeType": "MEGAPORT", "edgeGatewayName": "icgw-name" } } } } }, "required": true }, "responses": { "200": { "description": "Interconnect Process ID Information.", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "Procees Id of the task", "example": "51d0a0e4-983a-471c-9abb-724d58144884" } }, "$$ref": "#/components/schemas/ProcessResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/interconnect/gateways/types": { "get": { "tags": [ "Multicloud Interconnect - Gateways" ], "summary": "Get supported Interconnect Gateway solution types.", "description": "API to retrieve the supported Interconnect Gateway solution types.", "operationId": "getInterconnetGatewayTypes", "parameters": [ { "name": "interconnect-type", "in": "query", "description": "Interconnect provider type", "required": true, "schema": { "type": "string", "enum": [ "MEGAPORT", "EQUINIX" ] } } ], "responses": { "200": { "description": "Accepted", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/interconnect/gateways/{interconnect-gateway-name}": { "put": { "tags": [ "Multicloud Interconnect - Gateways" ], "summary": "Edit Interconnect Gateway Information.", "description": "API to update the Interconnect Gateway Information in vManage.", "operationId": "updateInterconnectGateway_MulticloudInterconnectGateways_6103", "parameters": [ { "name": "interconnect-gateway-name", "in": "path", "description": "Interconnect gateway name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request Payload for Multicloud Interconnect Gateways", "content": { "application/json": { "schema": { "required": [ "deviceUuid", "edgeAccountId", "edgeBillingAccountId", "edgeGatewayName", "edgeType", "ipTransit", "licenseType", "region", "regionId", "siteName" ], "type": "object", "properties": { "configGroupSettings": { "required": [ "configGroupId", "configGroupName" ], "type": "object", "properties": { "configGroupId": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Config Group Id", "example": "482eb6f3-1168-4b6f-901a-bd2c788b370d" }, "configGroupName": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Config Group name", "example": "My-CG-1" } }, "$$ref": "#/components/schemas/InterconnectConfigGroupSettings" }, "description": { "maxLength": 255, "minLength": 1, "type": "string" }, "deviceUuid": { "maxLength": 255, "minLength": 1, "type": "string" }, "edgeAccountId": { "maxLength": 255, "minLength": 1, "type": "string" }, "edgeBillingAccountId": { "maxLength": 255, "minLength": 1, "type": "string" }, "edgeGatewayName": { "maxLength": 255, "minLength": 1, "type": "string" }, "edgeType": { "type": "string" }, "egwBgpAsn": { "type": "string", "description": "BGP ASN assigned to Interconnect Gateway", "example": "64500" }, "ipTransit": { "maxLength": 255, "minLength": 1, "type": "string" }, "ipTransitId": { "type": "string" }, "ipTransitSkuId": { "type": "string" }, "isCustomSetting": { "type": "boolean", "description": "Custom Settings enabled for Interconnect Gateway", "example": true }, "licenseSkuId": { "type": "string", "description": "License Sku Id of Interconnect Gateway", "example": "12345" }, "licenseType": { "type": "string", "enum": [ "PAYG", "PREPAID", "DIRECT" ] }, "loopbackCidr": { "type": "string", "description": "Ip pool allocated to Interconnect Gateway for Loopback Interfaces", "example": "172.31.251.4/30" }, "mrfSettings": { "type": "object", "properties": { "mrfRouterRole": { "type": "string", "description": "Multi Region Fabric router role", "example": "border" }, "mrfTransportGateway": { "type": "boolean", "description": "Multi Region Fabric Transport Gateway", "example": false }, "nhmRegionId": { "type": "integer", "description": "Network Hierarchy Region Id", "format": "int64", "example": 123 }, "nhmRegionName": { "type": "string", "description": "Network Hierarchy Region name", "example": "My-Region" } }, "$$ref": "#/components/schemas/InterconnectMrfSettings" }, "region": { "maxLength": 255, "minLength": 1, "type": "string" }, "regionId": { "maxLength": 255, "minLength": 1, "type": "string" }, "resourceState": { "type": "string" }, "resourceStateMessage": { "type": "string" }, "resourceStateUpdateTs": { "type": "string" }, "serviceChainAttachments": { "type": "string" }, "settings": { "required": [ "instanceSize", "softwareImageId" ], "type": "object", "properties": { "edgeGatewaySolution": { "type": "string", "enum": [ "MVE", "NE" ] }, "edgeType": { "type": "string", "enum": [ "MEGAPORT", "EQUINIX", "ATT" ] }, "egwCustomSettingName": { "type": "string", "description": "Assigned name of the Interconnect Gateway Custom Settings" }, "instanceSize": { "maxLength": 255, "minLength": 1, "type": "string" }, "ipSubnetPool": { "type": "string", "description": "Ip subnet pool assigned to the gateway", "example": "192.168.10.0/24" }, "softwareImageId": { "maxLength": 255, "minLength": 1, "pattern": "^C8000v.*$", "type": "string" } }, "$$ref": "#/components/schemas/InterconnectGatewaySettings" }, "siteName": { "maxLength": 255, "minLength": 1, "type": "string" } }, "$$ref": "#/components/schemas/InterconnectGatewayExtended" }, "examples": { "Interconnect Megaport Gateways": { "description": "Interconnect Megaport Gateways", "value": { "edgeType": "MEGAPORT", "edgeAccountId": "ABCD-1234-CDEF", "edgeGatewayName": "mp-gateway-name", "description": "This is my Megaport gateway", "region": "Cologix TOR1, Toronto, ON, Canada : Toronto", "regionId": "10", "siteName": "My_Megaport_Site", "deviceUuid": "C8K-f7f6c42c-409d-11eb-9562-005056841be8", "settings": { "instanceSize": "Small", "softwareImageId": "C8000v 17.09.01a" }, "mrfSettings": { "mrfRouterRole": "border", "mrfTransportGateway": false } } }, "Interconnect Equinix Gateways - MRF Enabled": { "description": "Interconnect Equinix Gateways - MRF Enabled", "value": "{\n \"edgeType\": \"EQUINIX\",\n \"edgeAccountId\": \"ABCD-1234-CDEF\",\n \"edgeGatewayName\": \"eq-gateway-name\",\n \"description\": \"This is my Equinix Gateway\",\n \"region\": \"NY Metro\",\n \"regionId\": \"10\",\n \"edgeBillingAccountId\": \"ABCD-1234-CDEF\",\n \"siteName\": \"My_Equinix_Site\",\n \"deviceUuid\": \"CSR-725caea2-41a4-497c-821d-a2e280be40f2\",\n \"mrfSettings\": {\n \"mrfRouterRole\": \"edge\",\n \"mrfTransportGateway\": false\n }\n \"settings\": {\n \"instanceSize\": \"Small\",\n \"softwareImageId\": \"CSR1000v 17.03.03\"\n }\n}" } } } }, "required": true }, "responses": { "200": { "description": "Interconnect Gateway Information.", "content": { "application/json": { "schema": { "required": [ "deviceUuid", "edgeAccountId", "edgeBillingAccountId", "edgeGatewayName", "edgeType", "ipTransit", "licenseType", "region", "regionId", "siteName" ], "type": "object", "properties": { "configGroupSettings": { "required": [ "configGroupId", "configGroupName" ], "type": "object", "properties": { "configGroupId": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Config Group Id", "example": "482eb6f3-1168-4b6f-901a-bd2c788b370d" }, "configGroupName": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Config Group name", "example": "My-CG-1" } }, "$$ref": "#/components/schemas/InterconnectConfigGroupSettings" }, "description": { "maxLength": 255, "minLength": 1, "type": "string" }, "deviceUuid": { "maxLength": 255, "minLength": 1, "type": "string" }, "edgeAccountId": { "maxLength": 255, "minLength": 1, "type": "string" }, "edgeBillingAccountId": { "maxLength": 255, "minLength": 1, "type": "string" }, "edgeGatewayName": { "maxLength": 255, "minLength": 1, "type": "string" }, "edgeType": { "type": "string" }, "egwBgpAsn": { "type": "string", "description": "BGP ASN assigned to Interconnect Gateway", "example": "64500" }, "ipTransit": { "maxLength": 255, "minLength": 1, "type": "string" }, "ipTransitId": { "type": "string" }, "ipTransitSkuId": { "type": "string" }, "isCustomSetting": { "type": "boolean", "description": "Custom Settings enabled for Interconnect Gateway", "example": true }, "licenseSkuId": { "type": "string", "description": "License Sku Id of Interconnect Gateway", "example": "12345" }, "licenseType": { "type": "string", "enum": [ "PAYG", "PREPAID", "DIRECT" ] }, "loopbackCidr": { "type": "string", "description": "Ip pool allocated to Interconnect Gateway for Loopback Interfaces", "example": "172.31.251.4/30" }, "mrfSettings": { "type": "object", "properties": { "mrfRouterRole": { "type": "string", "description": "Multi Region Fabric router role", "example": "border" }, "mrfTransportGateway": { "type": "boolean", "description": "Multi Region Fabric Transport Gateway", "example": false }, "nhmRegionId": { "type": "integer", "description": "Network Hierarchy Region Id", "format": "int64", "example": 123 }, "nhmRegionName": { "type": "string", "description": "Network Hierarchy Region name", "example": "My-Region" } }, "$$ref": "#/components/schemas/InterconnectMrfSettings" }, "region": { "maxLength": 255, "minLength": 1, "type": "string" }, "regionId": { "maxLength": 255, "minLength": 1, "type": "string" }, "resourceState": { "type": "string" }, "resourceStateMessage": { "type": "string" }, "resourceStateUpdateTs": { "type": "string" }, "serviceChainAttachments": { "type": "string" }, "settings": { "required": [ "instanceSize", "softwareImageId" ], "type": "object", "properties": { "edgeGatewaySolution": { "type": "string", "enum": [ "MVE", "NE" ] }, "edgeType": { "type": "string", "enum": [ "MEGAPORT", "EQUINIX", "ATT" ] }, "egwCustomSettingName": { "type": "string", "description": "Assigned name of the Interconnect Gateway Custom Settings" }, "instanceSize": { "maxLength": 255, "minLength": 1, "type": "string" }, "ipSubnetPool": { "type": "string", "description": "Ip subnet pool assigned to the gateway", "example": "192.168.10.0/24" }, "softwareImageId": { "maxLength": 255, "minLength": 1, "pattern": "^C8000v.*$", "type": "string" } }, "$$ref": "#/components/schemas/InterconnectGatewaySettings" }, "siteName": { "maxLength": 255, "minLength": 1, "type": "string" } }, "$$ref": "#/components/schemas/InterconnectGatewayExtended" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "Multicloud Interconnect - Gateways" ], "summary": "Get Interconnect Gateway Information.", "description": "API to retrieve the Interconnect Gateway Information from vManage.", "operationId": "getInterconnectGateway", "parameters": [ { "name": "interconnect-gateway-name", "in": "path", "description": "Interconnect gateway name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Interconnect Gateway Information.", "content": { "application/json": { "schema": { "required": [ "deviceUuid", "edgeAccountId", "edgeBillingAccountId", "edgeGatewayName", "edgeType", "ipTransit", "licenseType", "region", "regionId", "siteName" ], "type": "object", "properties": { "configGroupSettings": { "required": [ "configGroupId", "configGroupName" ], "type": "object", "properties": { "configGroupId": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Config Group Id", "example": "482eb6f3-1168-4b6f-901a-bd2c788b370d" }, "configGroupName": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Config Group name", "example": "My-CG-1" } }, "$$ref": "#/components/schemas/InterconnectConfigGroupSettings" }, "description": { "maxLength": 255, "minLength": 1, "type": "string" }, "deviceUuid": { "maxLength": 255, "minLength": 1, "type": "string" }, "edgeAccountId": { "maxLength": 255, "minLength": 1, "type": "string" }, "edgeBillingAccountId": { "maxLength": 255, "minLength": 1, "type": "string" }, "edgeGatewayName": { "maxLength": 255, "minLength": 1, "type": "string" }, "edgeType": { "type": "string" }, "egwBgpAsn": { "type": "string", "description": "BGP ASN assigned to Interconnect Gateway", "example": "64500" }, "ipTransit": { "maxLength": 255, "minLength": 1, "type": "string" }, "ipTransitId": { "type": "string" }, "ipTransitSkuId": { "type": "string" }, "isCustomSetting": { "type": "boolean", "description": "Custom Settings enabled for Interconnect Gateway", "example": true }, "licenseSkuId": { "type": "string", "description": "License Sku Id of Interconnect Gateway", "example": "12345" }, "licenseType": { "type": "string", "enum": [ "PAYG", "PREPAID", "DIRECT" ] }, "loopbackCidr": { "type": "string", "description": "Ip pool allocated to Interconnect Gateway for Loopback Interfaces", "example": "172.31.251.4/30" }, "mrfSettings": { "type": "object", "properties": { "mrfRouterRole": { "type": "string", "description": "Multi Region Fabric router role", "example": "border" }, "mrfTransportGateway": { "type": "boolean", "description": "Multi Region Fabric Transport Gateway", "example": false }, "nhmRegionId": { "type": "integer", "description": "Network Hierarchy Region Id", "format": "int64", "example": 123 }, "nhmRegionName": { "type": "string", "description": "Network Hierarchy Region name", "example": "My-Region" } }, "$$ref": "#/components/schemas/InterconnectMrfSettings" }, "region": { "maxLength": 255, "minLength": 1, "type": "string" }, "regionId": { "maxLength": 255, "minLength": 1, "type": "string" }, "resourceState": { "type": "string" }, "resourceStateMessage": { "type": "string" }, "resourceStateUpdateTs": { "type": "string" }, "serviceChainAttachments": { "type": "string" }, "settings": { "required": [ "instanceSize", "softwareImageId" ], "type": "object", "properties": { "edgeGatewaySolution": { "type": "string", "enum": [ "MVE", "NE" ] }, "edgeType": { "type": "string", "enum": [ "MEGAPORT", "EQUINIX", "ATT" ] }, "egwCustomSettingName": { "type": "string", "description": "Assigned name of the Interconnect Gateway Custom Settings" }, "instanceSize": { "maxLength": 255, "minLength": 1, "type": "string" }, "ipSubnetPool": { "type": "string", "description": "Ip subnet pool assigned to the gateway", "example": "192.168.10.0/24" }, "softwareImageId": { "maxLength": 255, "minLength": 1, "pattern": "^C8000v.*$", "type": "string" } }, "$$ref": "#/components/schemas/InterconnectGatewaySettings" }, "siteName": { "maxLength": 255, "minLength": 1, "type": "string" } }, "$$ref": "#/components/schemas/InterconnectGatewayExtended" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Multicloud Interconnect - Gateways" ], "summary": "Delete an Interconnect gateway.", "description": "API to delete an Interconnect Gateway from an Interconnect provider.", "operationId": "deleteInterconnectGateway", "parameters": [ { "name": "interconnect-gateway-name", "in": "path", "description": "Interconnect gateway name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Interconnect Process ID Information.", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "Procees Id of the task", "example": "51d0a0e4-983a-471c-9abb-724d58144884" } }, "$$ref": "#/components/schemas/ProcessResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/interconnect/gateways/{interconnect-gateway-name}/settings": { "get": { "tags": [ "Multicloud Interconnect - Gateways" ], "summary": "Get Interconnect gateway custom settings.", "description": "API to retrieve the custom settings specified for an Interconnect Gateway", "operationId": "getInterconnectGatewayCustomSettings", "parameters": [ { "name": "interconnect-gateway-name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "interconnect-account-id", "in": "query", "description": "Interconnect Account Id", "required": true, "schema": { "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]{1,22}[a-zA-Z0-9]$", "type": "string" } } ], "responses": { "200": { "description": "Interconnect Gateway Custom Settings", "content": { "application/json": { "schema": { "required": [ "instanceSize", "softwareImageId" ], "type": "object", "properties": { "edgeGatewaySolution": { "type": "string", "enum": [ "MVE", "NE" ] }, "edgeType": { "type": "string", "enum": [ "MEGAPORT", "EQUINIX", "ATT" ] }, "egwCustomSettingName": { "type": "string", "description": "Assigned name of the Interconnect Gateway Custom Settings" }, "instanceSize": { "maxLength": 255, "minLength": 1, "type": "string" }, "ipSubnetPool": { "type": "string", "description": "Ip subnet pool assigned to the gateway", "example": "192.168.10.0/24" }, "softwareImageId": { "maxLength": 255, "minLength": 1, "pattern": "^C8000v.*$", "type": "string" } }, "$$ref": "#/components/schemas/InterconnectGatewaySettings" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/interconnect/ip-transit": { "get": { "tags": [ "Multicloud Interconnect - General" ], "summary": "Get Interconnect IP transit support.", "description": "API to retrieve Interconnect ip transit in MB supported by an Interconnect provider.", "operationId": "getInterconnectIpTransit", "parameters": [ { "name": "interconnect-service-type", "in": "query", "description": "Interconnect Service Type", "required": true, "schema": { "type": "string" } }, { "name": "interconnect-type", "in": "query", "description": "Interconnect provider type", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Accepted", "content": { "application/json": { "schema": { "type": "object", "properties": { "sshKeys": { "type": "array", "items": { "type": "object", "properties": { "keyName": { "type": "string", "description": "Ssh Key Name", "example": "service-ssh-key" }, "keyType": { "type": "string", "description": "Ssh key Type", "example": "RSA" }, "keyValue": { "type": "string", "description": "Ssh Key Value", "example": "ssh-rsa xxxxxxxxxxxxxxxxxxxxxxxxxxxx" } }, "$$ref": "#/components/schemas/InterconnectSshKeyInfo" } } }, "$$ref": "#/components/schemas/InlineResponse20016" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/interconnect/service-sw-package": { "get": { "tags": [ "Multicloud Interconnect - Service Sw package types" ], "summary": "Get Interconnect Services software package Types Information.", "description": "API to retrieve the Interconnect Services Sw Package Types Information from vManage.", "operationId": "getInterconnectServiceSwPkg", "parameters": [ { "name": "interconnect-provider-name", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "interconnect-account-id", "in": "query", "description": "Interconnect account id", "required": true, "schema": { "type": "string" } }, { "name": "interconnect-service-type", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "interconnect-service-vendor-name", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "region", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "All Interconnect Services types and locations", "content": { "application/json": { "schema": { "type": "object", "properties": { "swPackages": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the service package", "example": "PA-100" }, "packageCode": { "type": "string", "description": "provider assigned service package code", "example": "PA100" }, "serviceSwVersion": { "type": "array", "items": { "type": "object", "properties": { "imageName": { "type": "string", "description": "Service Software Version Image Name", "example": "PaloAlto-VM-Series-10.1.3-9554" }, "version": { "type": "string", "description": "Service Software Version", "example": "10.1.3" } }, "$$ref": "#/components/schemas/InterconnectServiceSwVersion" } } }, "$$ref": "#/components/schemas/InterconnectServiceTypes" } } }, "$$ref": "#/components/schemas/InlineResponse20015" }, "examples": { "Service Software packages": { "description": "Service Software packages", "value": { "swPackages": [ { "name": "PA-100", "packageCode": "PA100", "serviceSwVersion": [ { "version": "10.1.3", "imageName": "PaloAlto-VM-Series-10.1.3-9554" } ] } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/interconnect/services": { "get": { "tags": [ "Multicloud Interconnect - Services" ], "summary": "Get Interconnect Services Information.", "description": "API to retrieve the Interconnect Services Information from vManage.", "operationId": "getInterconnectServices", "parameters": [ { "name": "interconnect-service-vendor-name", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "interconnect-type", "in": "query", "description": "Interconnect provider type", "required": true, "schema": { "type": "string" } }, { "name": "interconnect-service-type", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "All Interconnect Services", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "flavor": { "type": "string", "description": "Virtual Instance flavor of the service instance", "example": "VM100" }, "interfaceCount": { "type": "string", "description": "Number of interfaces for the service", "example": "10" }, "mgmtIP": { "type": "string", "description": "IP of the management interface of the service", "example": "100.1.1.1" }, "name": { "type": "string", "description": "Name of the service", "example": "My-Firewall" }, "serviceRegion": { "type": "string", "description": "Region where the service is deployed", "example": "NY" }, "serviceRole": { "type": "string", "description": "HA role of the service", "example": "Primary" }, "status": { "type": "string", "description": "Status of the service", "example": "PROMISIONED" }, "swVersion": { "type": "string", "description": "Software version running on the service", "example": "10.1.3" }, "uuid": { "type": "string", "description": "provider assigned service Uuid" } }, "$$ref": "#/components/schemas/InterconnectService" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/interconnect/settings/global": { "post": { "tags": [ "Multicloud Interconnect - Global Settings" ], "summary": "Add global settings for an Interconnect provider.", "description": "API to add global settings for an Interconnect provider.", "operationId": "addInterconnectGlobalSettings", "requestBody": { "description": "Request Payload for Multicloud Interconnect Global Settings", "content": { "application/json": { "schema": { "required": [ "bgpAsn", "edgeGatewaySolution", "edgeType", "instanceSize", "loopbackCgwColor", "loopbackTunnelColor", "softwareImageId" ], "type": "object", "properties": { "bgpAsn": { "pattern": "\\d+", "type": "string" }, "edgeGatewaySolution": { "type": "string" }, "edgeType": { "type": "string" }, "instanceSize": { "maxLength": 255, "minLength": 1, "type": "string" }, "invoiceReference": { "type": "string" }, "ipSubnetPool": { "type": "string" }, "loopbackCgwColor": { "type": "string" }, "loopbackTunnelColor": { "type": "string" }, "multicloudSystemSettings": { "type": "object", "properties": { "enableMonitoring": { "type": "boolean", "writeOnly": true }, "useConfigurationGroup": { "pattern": "^(true|false)$", "type": "string", "description": "Enable or disable Configuration Group for Gateways" } }, "$$ref": "#/components/schemas/MulticloudSystemSettings" }, "softwareImageId": { "maxLength": 255, "minLength": 1, "pattern": "^C8000v.*$", "type": "string" } }, "$$ref": "#/components/schemas/InterconnectGlobalSettings" }, "examples": { "Interconnect Global Settings": { "description": "Interconnect Global Settings", "value": { "edgeType": "MEGAPORT", "softwareImageId": "C8000v 17.09.01a", "instanceSize": "Small", "loopbackTunnelColor": "private3", "loopbackCgwColor": "private5", "bgpAsn": 65000, "multicloudSystemSettings": { "useConfigurationGroup": true } } } } } }, "required": true }, "responses": { "200": { "description": "Accepted" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "Multicloud Interconnect - Global Settings" ], "summary": "Get Interconnect provider global settings.", "description": "API to retrieve global settings for an Interconnect provider type.", "operationId": "getInterconnectGlobalSettings", "parameters": [ { "name": "interconnect-type", "in": "query", "description": "Interconnect provider type", "required": true, "schema": { "type": "string", "enum": [ "MEGAPORT", "EQUINIX" ] } } ], "responses": { "200": { "description": "Accepted", "content": { "application/json": { "schema": { "required": [ "bgpAsn", "edgeGatewaySolution", "edgeType", "instanceSize", "loopbackCgwColor", "loopbackTunnelColor", "softwareImageId" ], "type": "object", "properties": { "bgpAsn": { "pattern": "\\d+", "type": "string" }, "edgeGatewaySolution": { "type": "string" }, "edgeType": { "type": "string" }, "instanceSize": { "maxLength": 255, "minLength": 1, "type": "string" }, "invoiceReference": { "type": "string" }, "ipSubnetPool": { "type": "string" }, "loopbackCgwColor": { "type": "string" }, "loopbackTunnelColor": { "type": "string" }, "multicloudSystemSettings": { "type": "object", "properties": { "enableMonitoring": { "type": "boolean", "writeOnly": true }, "useConfigurationGroup": { "pattern": "^(true|false)$", "type": "string", "description": "Enable or disable Configuration Group for Gateways" } }, "$$ref": "#/components/schemas/MulticloudSystemSettings" }, "softwareImageId": { "maxLength": 255, "minLength": 1, "pattern": "^C8000v.*$", "type": "string" } }, "$$ref": "#/components/schemas/InterconnectGlobalSettings" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "put": { "tags": [ "Multicloud Interconnect - Global Settings" ], "summary": "Edit global settings for an Interconnect provider.", "description": "API to update global settings for an Interconnect provider.", "operationId": "updateInterconnectGlobalSettings", "requestBody": { "description": "Request Payload for Multicloud Interconnect Global Settings", "content": { "application/json": { "schema": { "required": [ "bgpAsn", "edgeGatewaySolution", "edgeType", "instanceSize", "loopbackCgwColor", "loopbackTunnelColor", "softwareImageId" ], "type": "object", "properties": { "bgpAsn": { "pattern": "\\d+", "type": "string" }, "edgeGatewaySolution": { "type": "string" }, "edgeType": { "type": "string" }, "instanceSize": { "maxLength": 255, "minLength": 1, "type": "string" }, "invoiceReference": { "type": "string" }, "ipSubnetPool": { "type": "string" }, "loopbackCgwColor": { "type": "string" }, "loopbackTunnelColor": { "type": "string" }, "multicloudSystemSettings": { "type": "object", "properties": { "enableMonitoring": { "type": "boolean", "writeOnly": true }, "useConfigurationGroup": { "pattern": "^(true|false)$", "type": "string", "description": "Enable or disable Configuration Group for Gateways" } }, "$$ref": "#/components/schemas/MulticloudSystemSettings" }, "softwareImageId": { "maxLength": 255, "minLength": 1, "pattern": "^C8000v.*$", "type": "string" } }, "$$ref": "#/components/schemas/InterconnectGlobalSettings" }, "examples": { "Interconnect Global Settings": { "description": "Interconnect Global Settings", "value": { "edgeType": "MEGAPORT", "softwareImageId": "C8000v 17.09.01a", "instanceSize": "Small", "loopbackTunnelColor": "private3", "loopbackCgwColor": "private5", "bgpAsn": 65000, "multicloudSystemSettings": { "useConfigurationGroup": true } } } } } }, "required": true }, "responses": { "200": { "description": "Accepted" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/interconnect/sshkeys": { "get": { "tags": [ "Multicloud Interconnect - General" ], "summary": "Get ssh keys for Interconnect provider.", "description": "Get ssh keys for Interconnect provider.", "operationId": "getInterconnectSshKeys", "parameters": [ { "name": "interconnect-provider-name", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "interconnect-account-id", "in": "query", "description": "Interconnect account id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Service Ssh Keys in provider account.", "content": { "application/json": { "schema": { "type": "object", "properties": { "sshKeys": { "type": "array", "items": { "type": "object", "properties": { "keyName": { "type": "string", "description": "Ssh Key Name", "example": "service-ssh-key" }, "keyType": { "type": "string", "description": "Ssh key Type", "example": "RSA" }, "keyValue": { "type": "string", "description": "Ssh Key Value", "example": "ssh-rsa xxxxxxxxxxxxxxxxxxxxxxxxxxxx" } }, "$$ref": "#/components/schemas/InterconnectSshKeyInfo" } } }, "$$ref": "#/components/schemas/InlineResponse20016" }, "examples": { "Service Ssh Keys": { "description": "Service Ssh Keys", "value": { "sshKeys": [ { "keyName": "service-ssh-key", "keyType": "RSA", "keyValue": "ssh-rsa xxxxxxxxxxxxxxxxxxxxxxxxxxxx" } ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/interconnect/types": { "get": { "tags": [ "Multicloud Interconnect - General" ], "summary": "Get supported Multicloud Interconnect providers.", "description": "API to retrieve list of supported Interconnect provider Types.", "operationId": "getInterconnectTypes", "responses": { "200": { "description": "Accepted", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "description": "data list", "example": [ "MEGAPORT", "EQUINIX", "ATT" ], "items": { "type": "string", "description": "data", "example": "MEGAPORT" } } }, "$$ref": "#/components/schemas/InlineResponse200" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/interconnect/widget": { "get": { "tags": [ "Multicloud Interconnect - Monitoring" ], "summary": "Get all Interconnect widgets", "description": "API to retrieve all Interconnect widgets.", "operationId": "getAllInterconnectWidgets", "responses": { "200": { "description": "Accepted", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "edgeGatewaySolution": { "type": "string", "enum": [ "MVE", "NE" ] }, "edgeType": { "type": "string", "enum": [ "MEGAPORT", "EQUINIX" ] }, "gwDeviceSiteIds": { "type": "array", "properties": { "empty": { "type": "boolean" } }, "items": { "type": "integer", "format": "int64" } }, "gwDeviceStatus": { "type": "object", "properties": { "count": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "statusList": { "type": "array", "properties": { "empty": { "type": "boolean" } }, "items": { "type": "object", "properties": { "count": { "type": "integer", "format": "int64" }, "message": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string" } }, "$$ref": "#/components/schemas/StatusObject" } }, "unreachableCount": { "type": "integer", "format": "int64" } }, "$$ref": "#/components/schemas/GwDeviceStatus" }, "gwSitestatus": { "type": "object", "properties": { "count": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "statusList": { "type": "array", "properties": { "empty": { "type": "boolean" } }, "items": { "type": "object", "properties": { "count": { "type": "integer", "format": "int64" }, "message": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string" } }, "$$ref": "#/components/schemas/StatusObject" } } }, "$$ref": "#/components/schemas/GwSiteStatus" }, "gwStatus": { "type": "object", "properties": { "count": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "statusList": { "type": "array", "properties": { "empty": { "type": "boolean" } }, "items": { "type": "object", "properties": { "count": { "type": "integer", "format": "int64" }, "message": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string" } }, "$$ref": "#/components/schemas/StatusObject" } } }, "$$ref": "#/components/schemas/GwStatus" }, "numAccounts": { "type": "integer", "format": "int64" }, "numConn": { "type": "integer", "format": "int64" }, "numConnDown": { "type": "integer", "format": "int64" }, "numConnLive": { "type": "integer", "format": "int64", "writeOnly": true }, "numConnPartial": { "type": "integer", "format": "int64" }, "numConnUp": { "type": "integer", "format": "int64" }, "numSdwanTunnels": { "type": "integer", "format": "int64" } }, "$$ref": "#/components/schemas/InterconnectWidget" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/interconnect/{interconnect-type}/accounts/{interconnect-account-id}/billing-accounts": { "get": { "tags": [ "Multicloud Interconnect - Accounts" ], "summary": "Get Interconnect provider billing accounts.", "description": "API to retrieve billing accounts for an Interconnect provider type and account.", "operationId": "getInterconnectBillingAccounts", "parameters": [ { "name": "interconnect-type", "in": "path", "description": "Interconnect provider type", "required": true, "schema": { "type": "string" } }, { "name": "interconnect-account-id", "in": "path", "description": "Interconnect provider account id", "required": true, "schema": { "type": "string" } }, { "name": "region", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Accepted", "content": { "application/json": { "schema": { "type": "object", "properties": { "edgeBillingAccountInfoList": { "type": "array", "items": { "type": "object", "properties": { "edgeBillingAccountId": { "type": "string", "description": "Interconnect billing account Id", "example": "12345" }, "edgeBillingAccountName": { "type": "string", "description": "Interconnect billing account name", "example": "Cisco IC" } }, "description": "Interconnect billing account Information", "$$ref": "#/components/schemas/InterconnectBillingAccountInfo" } } }, "$$ref": "#/components/schemas/InlineResponse2001" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/interconnect/{interconnect-type}/accounts/{interconnect-account-id}/cloud/{cloud-type}/connectivity/connections/partner-ports": { "get": { "tags": [ "Multicloud Interconnect - Connectivity" ], "summary": "Get Interconnect provider partner regions.", "description": "API to retrieve supported partner regions for an Interconnect provider.", "operationId": "getInterconnectPartnerPorts", "parameters": [ { "name": "interconnect-type", "in": "path", "description": "Interconnect provider Type", "required": true, "schema": { "type": "string" } }, { "name": "interconnect-account-id", "in": "path", "description": "Interconnect provider account id", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } }, { "name": "cloud-type", "in": "path", "description": "Cloud provider type", "required": true, "schema": { "type": "string" } }, { "name": "connect-type", "in": "query", "description": "Interconnect connection connect type", "schema": { "type": "string" } }, { "name": "vxc-permitted", "in": "query", "description": "Interconnect connection cross connect enabled", "schema": { "pattern": "(true|false)", "type": "string" } }, { "name": "authorization-key", "in": "query", "description": "Cloud connectivity gateway service/pairing key", "schema": { "maxLength": 255, "minLength": 1, "type": "string" } }, { "name": "refresh", "in": "query", "description": "Interconnect connection provider sync enabled", "schema": { "pattern": "(true|false)", "type": "string", "default": "false" } } ], "responses": { "200": { "description": "Accepted", "content": { "application/json": { "schema": { "type": "object", "properties": { "edgePartnerPortsList": { "type": "array", "items": { "type": "object", "properties": { "attPartnerPort": { "type": "object", "properties": { "authorizationKey": { "type": "string" }, "companyUid": { "type": "string", "description": "Megaport companyId for the region.", "example": "2fa8c6c5-314f-4d14-8fb6-e1f7f86bdacc" }, "connectType": { "type": "string", "enum": [ "AWS", "AWSHC", "PRIMARY", "SECONDARY", "INTERCONNECT_ATTACHMENT" ] }, "productUid": { "type": "string", "description": "Megaport id for the region.", "example": "2fa8c6c5-314f-4d14-8fb6-e1f7f86bdacc" }, "speed": { "type": "string", "description": "Bandwidth speeds supported at the region." }, "vxcId": { "type": "string", "description": "Cross connect (VXC) id connected to the region", "example": "None" }, "vxcPermitted": { "type": "boolean", "description": "Cross Connect enabled Megaport region.", "example": true } }, "description": "Megaport specific partner port fields.", "$$ref": "#/components/schemas/InterconnectPartnerPortsDetails" }, "cloudType": { "type": "string", "enum": [ "AWS", "AWS_GOVCLOUD", "AZURE", "AZURE_GOVCLOUD", "GCP" ] }, "edgeType": { "type": "string", "enum": [ "MEGAPORT", "EQUINIX" ] }, "eqPartnerPort": { "type": "object", "properties": { "authorizationKey": { "type": "string" }, "companyUid": { "type": "string", "description": "Megaport companyId for the region.", "example": "2fa8c6c5-314f-4d14-8fb6-e1f7f86bdacc" }, "connectType": { "type": "string", "enum": [ "AWS", "AWSHC", "PRIMARY", "SECONDARY", "INTERCONNECT_ATTACHMENT" ] }, "productUid": { "type": "string", "description": "Megaport id for the region.", "example": "2fa8c6c5-314f-4d14-8fb6-e1f7f86bdacc" }, "speed": { "type": "string", "description": "Bandwidth speeds supported at the region." }, "vxcId": { "type": "string", "description": "Cross connect (VXC) id connected to the region", "example": "None" }, "vxcPermitted": { "type": "boolean", "description": "Cross Connect enabled Megaport region.", "example": true } }, "description": "Megaport specific partner port fields.", "$$ref": "#/components/schemas/InterconnectPartnerPortsDetails" }, "locationId": { "type": "string" }, "mpPartnerPort": { "type": "object", "properties": { "authorizationKey": { "type": "string" }, "companyUid": { "type": "string", "description": "Megaport companyId for the region.", "example": "2fa8c6c5-314f-4d14-8fb6-e1f7f86bdacc" }, "connectType": { "type": "string", "enum": [ "AWS", "AWSHC", "PRIMARY", "SECONDARY", "INTERCONNECT_ATTACHMENT" ] }, "productUid": { "type": "string", "description": "Megaport id for the region.", "example": "2fa8c6c5-314f-4d14-8fb6-e1f7f86bdacc" }, "speed": { "type": "string", "description": "Bandwidth speeds supported at the region." }, "vxcId": { "type": "string", "description": "Cross connect (VXC) id connected to the region", "example": "None" }, "vxcPermitted": { "type": "boolean", "description": "Cross Connect enabled Megaport region.", "example": true } }, "description": "Megaport specific partner port fields.", "$$ref": "#/components/schemas/InterconnectPartnerPortsDetails" }, "name": { "type": "string" } }, "description": "Interconnect partner port information", "$$ref": "#/components/schemas/InterconnectPartnerPorts" } } }, "$$ref": "#/components/schemas/InlineResponse2006" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/interconnect/{interconnect-type}/accounts/{interconnect-account-id}/connectivity/connections/{connection-type}/port-speeds": { "get": { "tags": [ "Multicloud Interconnect - Connectivity" ], "summary": "Get Interconnect port speeds.", "description": "API to retrieve supported port speeds for an Interconnect connectivity.", "operationId": "getInterconnectPortSpeeds", "parameters": [ { "name": "interconnect-type", "in": "path", "description": "Interconnect provider Type", "required": true, "schema": { "type": "string" } }, { "name": "interconnect-account-id", "in": "path", "description": "Interconnect provider account id", "required": true, "schema": { "maxLength": 255, "minLength": 1, "type": "string" } }, { "name": "connection-type", "in": "path", "description": "Interconnect connectivity type", "required": true, "schema": { "pattern": "(cloud|edge|saas|deviceLink|CLOUD_CONNECT|DEVICE_CONNECT)", "type": "string" } }, { "name": "cloud-type", "in": "query", "description": "Cloud provider type", "schema": { "type": "string" } }, { "name": "cloud-account-id", "in": "query", "description": "Cloud account id", "schema": { "maxLength": 255, "minLength": 1, "type": "string" } }, { "name": "connect-type", "in": "query", "description": "Interconnect connection connect type", "schema": { "type": "string" } }, { "name": "connect-subtype", "in": "query", "description": "Interconnect connection connect sub-type", "schema": { "type": "string" } }, { "name": "connectivity-gateway-name", "in": "query", "description": "Cloud connectivity gateway name", "schema": { "maxLength": 255, "minLength": 1, "type": "string" } }, { "name": "partner-port", "in": "query", "description": "Interconnect cloud onRamp partner port location name", "schema": { "maxLength": 1024, "minLength": 1, "type": "string" } }, { "name": "authorization-key", "in": "query", "description": "Cloud connectivity gateway service/pairing key", "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "responses": { "200": { "description": "Accepted", "content": { "application/json": { "schema": { "type": "object", "properties": { "portSpeeds": { "type": "array", "description": "port speed list", "example": [ "50", "100", "200", "500", "1000", "5000" ], "items": { "type": "string", "description": "port speed", "example": "50" } } }, "$$ref": "#/components/schemas/InlineResponse2007" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/interconnect/{interconnect-type}/accounts/{interconnect-account-id}/locations": { "put": { "tags": [ "Multicloud Interconnect - Accounts" ], "summary": "Update Interconnect provider available regions.", "description": "API to retrieve and update the available regions for an Interconnect provider and account.", "operationId": "updateInterconnectLocationInfo", "parameters": [ { "name": "interconnect-type", "in": "path", "description": "Interconnect provider type", "required": true, "schema": { "type": "string" } }, { "name": "interconnect-account-id", "in": "path", "description": "Interconnect account id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Interconnect Provider Location List.", "content": { "application/json": { "schema": { "type": "object", "properties": { "edgeLocationInfoList": { "type": "array", "items": { "type": "object", "properties": { "attLocationInfo": { "type": "object", "properties": { "attNEInfo": { "type": "object", "properties": { "imageNameList": { "type": "array", "description": "Image name list", "example": [ "oldest", "current", "newest" ], "items": { "type": "string", "description": "Image name", "example": "small" } }, "productSizeList": { "type": "array", "description": "Product size list", "example": [ "small", "medium", "large" ], "items": { "type": "string", "description": "product size", "example": "small" } } }, "$$ref": "#/components/schemas/InterconnectLocationInfoMegaportMpMVEInfo" }, "metroCode": { "type": "string", "example": "DT" }, "metroName": { "type": "string" }, "networkRegion": { "type": "string", "example": "AMER" }, "siteCode": { "type": "string" }, "status": { "type": "string" } }, "$$ref": "#/components/schemas/InterconnectLocationInfoAtt" }, "edgeType": { "type": "string", "enum": [ "MEGAPORT", "EQUINIX" ] }, "eqLocationInfo": { "type": "object", "properties": { "eqBillingAccountInfoList": { "type": "array", "items": { "type": "object", "properties": { "edgeBillingAccountId": { "type": "string", "description": "Interconnect billing account Id", "example": "12345" }, "edgeBillingAccountName": { "type": "string", "description": "Interconnect billing account name", "example": "Cisco IC" } }, "description": "Interconnect billing account Information", "$$ref": "#/components/schemas/InterconnectBillingAccountInfo" } }, "eqNEInfo": { "type": "object", "properties": { "imageNameList": { "type": "array", "description": "Image name list", "example": [ "oldest", "current", "newest" ], "items": { "type": "string", "description": "Image name", "example": "small" } }, "productSizeList": { "type": "array", "description": "Product size list", "example": [ "small", "medium", "large" ], "items": { "type": "string", "description": "product size", "example": "small" } } }, "$$ref": "#/components/schemas/InterconnectLocationInfoMegaportMpMVEInfo" }, "metroCode": { "type": "string", "example": "DT" }, "metroName": { "type": "string" }, "networkRegion": { "type": "string", "example": "AMER" }, "siteCode": { "type": "string" }, "status": { "type": "string" } }, "$$ref": "#/components/schemas/InterconnectLocationInfoEquinix" }, "locationId": { "type": "string" }, "locationName": { "type": "string" }, "mpLocationInfo": { "type": "object", "properties": { "address": { "type": "string", "example": "24700 Northwestern Highway, Southfield Michigan, Detroit, MI -24700, USA" }, "country": { "type": "string", "example": "USA" }, "liveDate": { "type": "string", "example": "1589292000000" }, "market": { "type": "string", "example": "US" }, "metroName": { "type": "string", "example": "Detroit" }, "mpMVEInfo": { "type": "object", "properties": { "imageNameList": { "type": "array", "description": "Image name list", "example": [ "oldest", "current", "newest" ], "items": { "type": "string", "description": "Image name", "example": "small" } }, "productSizeList": { "type": "array", "description": "Product size list", "example": [ "small", "medium", "large" ], "items": { "type": "string", "description": "product size", "example": "small" } } }, "$$ref": "#/components/schemas/InterconnectLocationInfoMegaportMpMVEInfo" }, "networkRegion": { "type": "string", "example": "MP1" }, "siteCode": { "type": "string", "example": "det-on1" }, "status": { "type": "string", "example": "Active" } }, "$$ref": "#/components/schemas/InterconnectLocationInfoMegaport" } }, "$$ref": "#/components/schemas/InterconnectLocationsEdgeLocationInfoList" } } }, "$$ref": "#/components/schemas/InterconnectLocations" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "Multicloud Interconnect - Accounts" ], "summary": "Get Interconnect provider available regions.", "description": "API to retrieve list of available regions for an Interconnect provider and account.", "operationId": "getInterconnectLocationInfo", "parameters": [ { "name": "interconnect-type", "in": "path", "description": "Interconnect provider type", "required": true, "schema": { "type": "string" } }, { "name": "interconnect-account-id", "in": "path", "description": "Interconnect account id", "required": true, "schema": { "type": "string" } }, { "name": "region", "in": "query", "description": "Interconnect provider location", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Interconnect Provider Location List.", "content": { "application/json": { "schema": { "type": "object", "properties": { "edgeLocationInfoList": { "type": "array", "items": { "type": "object", "properties": { "attLocationInfo": { "type": "object", "properties": { "attNEInfo": { "type": "object", "properties": { "imageNameList": { "type": "array", "description": "Image name list", "example": [ "oldest", "current", "newest" ], "items": { "type": "string", "description": "Image name", "example": "small" } }, "productSizeList": { "type": "array", "description": "Product size list", "example": [ "small", "medium", "large" ], "items": { "type": "string", "description": "product size", "example": "small" } } }, "$$ref": "#/components/schemas/InterconnectLocationInfoMegaportMpMVEInfo" }, "metroCode": { "type": "string", "example": "DT" }, "metroName": { "type": "string" }, "networkRegion": { "type": "string", "example": "AMER" }, "siteCode": { "type": "string" }, "status": { "type": "string" } }, "$$ref": "#/components/schemas/InterconnectLocationInfoAtt" }, "edgeType": { "type": "string", "enum": [ "MEGAPORT", "EQUINIX" ] }, "eqLocationInfo": { "type": "object", "properties": { "eqBillingAccountInfoList": { "type": "array", "items": { "type": "object", "properties": { "edgeBillingAccountId": { "type": "string", "description": "Interconnect billing account Id", "example": "12345" }, "edgeBillingAccountName": { "type": "string", "description": "Interconnect billing account name", "example": "Cisco IC" } }, "description": "Interconnect billing account Information", "$$ref": "#/components/schemas/InterconnectBillingAccountInfo" } }, "eqNEInfo": { "type": "object", "properties": { "imageNameList": { "type": "array", "description": "Image name list", "example": [ "oldest", "current", "newest" ], "items": { "type": "string", "description": "Image name", "example": "small" } }, "productSizeList": { "type": "array", "description": "Product size list", "example": [ "small", "medium", "large" ], "items": { "type": "string", "description": "product size", "example": "small" } } }, "$$ref": "#/components/schemas/InterconnectLocationInfoMegaportMpMVEInfo" }, "metroCode": { "type": "string", "example": "DT" }, "metroName": { "type": "string" }, "networkRegion": { "type": "string", "example": "AMER" }, "siteCode": { "type": "string" }, "status": { "type": "string" } }, "$$ref": "#/components/schemas/InterconnectLocationInfoEquinix" }, "locationId": { "type": "string" }, "locationName": { "type": "string" }, "mpLocationInfo": { "type": "object", "properties": { "address": { "type": "string", "example": "24700 Northwestern Highway, Southfield Michigan, Detroit, MI -24700, USA" }, "country": { "type": "string", "example": "USA" }, "liveDate": { "type": "string", "example": "1589292000000" }, "market": { "type": "string", "example": "US" }, "metroName": { "type": "string", "example": "Detroit" }, "mpMVEInfo": { "type": "object", "properties": { "imageNameList": { "type": "array", "description": "Image name list", "example": [ "oldest", "current", "newest" ], "items": { "type": "string", "description": "Image name", "example": "small" } }, "productSizeList": { "type": "array", "description": "Product size list", "example": [ "small", "medium", "large" ], "items": { "type": "string", "description": "product size", "example": "small" } } }, "$$ref": "#/components/schemas/InterconnectLocationInfoMegaportMpMVEInfo" }, "networkRegion": { "type": "string", "example": "MP1" }, "siteCode": { "type": "string", "example": "det-on1" }, "status": { "type": "string", "example": "Active" } }, "$$ref": "#/components/schemas/InterconnectLocationInfoMegaport" } }, "$$ref": "#/components/schemas/InterconnectLocationsEdgeLocationInfoList" } } }, "$$ref": "#/components/schemas/InterconnectLocations" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "delete": { "tags": [ "Multicloud Interconnect - Accounts" ], "summary": "Delete Interconnect provider stored regions.", "description": "API to delete the stored regions for an Interconnect provider and account from vManage.", "operationId": "deleteInterconnectLocationInfo", "parameters": [ { "name": "interconnect-type", "in": "path", "description": "Interconnect provider type", "required": true, "schema": { "type": "string" } }, { "name": "interconnect-account-id", "in": "path", "description": "Interconnect account id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Accepted" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/interconnect/{interconnect-type}/config-group/{config-group-id}/topology": { "put": { "tags": [ "Multicloud Interconnect - General" ], "summary": "Update Multicloud Interconnect topology.", "description": "API to update current Multicloud Interconnect topology for the Config Group.", "operationId": "updateInterconnectConfigGroupTopology", "parameters": [ { "name": "interconnect-type", "in": "path", "description": "Interconnect provider type", "required": true, "schema": { "type": "string" } }, { "name": "config-group-id", "in": "path", "description": "Config Group Id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Interconnect Config-Group Topology Response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "topology": { "type": "object", "properties": { "devices": { "type": "array", "items": { "type": "object", "properties": { "criteria": { "type": "object", "properties": { "attribute": { "type": "string", "description": "Name of attribute type", "example": "tag" }, "value": { "type": "string", "description": "Value of attribute", "example": "ICGW_NAME" } }, "$$ref": "#/components/schemas/InlineResponse20013TopologyCriteria" }, "unsupportedFeatures": { "type": "object", "properties": { "parcelId": { "type": "string", "description": "Config-Group Parcel Id", "example": "e16efd46-6d7b-4d09-872d-d34ce307400f" }, "parcelType": { "type": "string", "description": "Config-Group Parcel Type", "example": "wan/vpn/interface/ethernet" } }, "$$ref": "#/components/schemas/InlineResponse20013TopologyUnsupportedFeatures" } }, "$$ref": "#/components/schemas/InlineResponse20013TopologyDevices" } } }, "$$ref": "#/components/schemas/InlineResponse20013Topology" } }, "$$ref": "#/components/schemas/InlineResponse20013" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } }, "get": { "tags": [ "Multicloud Interconnect - General" ], "summary": "Get Multicloud Interconnect topology.", "description": "API to retrieve current Multicloud Interconnect topology for the Config Group.", "operationId": "getInterconnectConfigGroupTopology", "parameters": [ { "name": "interconnect-type", "in": "path", "description": "Interconnect provider type", "required": true, "schema": { "type": "string" } }, { "name": "config-group-id", "in": "path", "description": "Config Group Id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Interconnect Config-Group Topology Response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "topology": { "type": "object", "properties": { "devices": { "type": "array", "items": { "type": "object", "properties": { "criteria": { "type": "object", "properties": { "attribute": { "type": "string", "description": "Name of attribute type", "example": "tag" }, "value": { "type": "string", "description": "Value of attribute", "example": "ICGW_NAME" } }, "$$ref": "#/components/schemas/InlineResponse20013TopologyCriteria" }, "unsupportedFeatures": { "type": "object", "properties": { "parcelId": { "type": "string", "description": "Config-Group Parcel Id", "example": "e16efd46-6d7b-4d09-872d-d34ce307400f" }, "parcelType": { "type": "string", "description": "Config-Group Parcel Type", "example": "wan/vpn/interface/ethernet" } }, "$$ref": "#/components/schemas/InlineResponse20013TopologyUnsupportedFeatures" } }, "$$ref": "#/components/schemas/InlineResponse20013TopologyDevices" } } }, "$$ref": "#/components/schemas/InlineResponse20013Topology" } }, "$$ref": "#/components/schemas/InlineResponse20013" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/interconnect/{interconnect-type}/connectivity/device-links/metro-speed": { "post": { "tags": [ "Multicloud Interconnect - Connectivity" ], "summary": "Get Device-Link metro speed.", "description": "API to get metro speed for Device-Link by Device-Link Configuration.", "operationId": "getInterconnectDeviceLinkMetroSpeed", "parameters": [ { "name": "interconnect-type", "in": "path", "description": "Interconnect Provider Type", "required": true, "schema": { "type": "string", "enum": [ "MEGAPORT", "EQUINIX" ] } } ], "requestBody": { "description": "Request Payload for Multicloud Interconnect Device Links", "content": { "application/json": { "schema": { "required": [ "bandwidth", "deviceLinkName", "edgeAccountId", "edgeType" ], "type": "object", "properties": { "bandwidth": { "type": "string", "description": "Device-Link Bandwidth Input.", "example": "50" }, "deviceLinkName": { "maxLength": 50, "minLength": 3, "pattern": "^[\\w.-]{3,50}$", "type": "string", "description": "Name of the Interconnect Device-Link.", "example": "my-device-link" }, "deviceLinkUuid": { "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", "type": "string", "description": "Uuid of the Interconnect Device-Link", "example": "496bddbd-e104-44a7-ba62-7a285f642304" }, "deviceLinksubnet": { "type": "string", "description": "Subnet pool for Interconnect Gateway interfaces in the Device-Link.", "example": "20.10.0.0/16" }, "deviceList": { "maxItems": 2147483647, "minItems": 2, "type": "array", "items": { "type": "object", "properties": { "deviceInterfaceId": { "type": "string", "description": "Interface used on the Interconnect Gateway to connect to the Device-Link.", "example": "GigabitEthernet4" }, "deviceIntfIpAddress": { "type": "string", "description": "IP assigned to the Interconnect Gateway interface to connect to the Device-Link.", "example": "20.10.0.2" }, "deviceName": { "pattern": "^[\\w.-]{3,50}$", "type": "string", "description": "Name of the Interconnect Gateway in the Device-Link.", "example": "ICGW_1" }, "deviceUuid": { "type": "string", "description": "Uuid of Interconnect Gateway in the Device-Link.", "example": "0dc43131-47c9-4fce-8499-f02e3340c9fb" }, "egwLoopBackCidr": { "type": "string", "description": "IP assigned to the loopback interface of the Interconnect Gateway to form SDWAN tunnel.", "example": "172.31.251.8/30" } }, "$$ref": "#/components/schemas/InterconnectDeviceLinkDeviceList" } }, "dlMetroBandwidth": { "type": "string", "description": "Device-Link Bandwidth at a given Metro.", "example": "150" }, "edgeAccountId": { "maxLength": 255, "minLength": 1, "type": "string" }, "edgeAccountName": { "maxLength": 255, "minLength": 1, "pattern": "^[a-zA-Z0-9_\\-\\s]+$", "type": "string" }, "edgeType": { "type": "string" }, "linkBandwidth": { "type": "string", "description": "Device-Link Bandwidth.", "example": "50" }, "resourceState": { "type": "string" }, "resourceStateMessage": { "type": "string" }, "resourceStateUpdateTs": { "type": "string" }, "subnet": { "pattern": "^(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(?:\\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}\\/(?:3[0-2]|[0-2]?[0-9])$", "type": "string", "description": "Subnet pool for Interconnect Gateway interfaces in the Device-Link.", "example": "20.10.0.0/16" }, "version": { "type": "string", "description": "Version of the payload.", "example": "1" } }, "description": "Interconnect Device-Link Object", "$$ref": "#/components/schemas/InterconnectDeviceLink" }, "examples": { "Interconnect Equinix Device Link": { "description": "Interconnect Equinix Device Link", "value": { "edgeType": "EQUINIX", "edgeAccountId": "ABCD-1234-CDEF", "edgeAccountName": "interconnect-account-name", "deviceLinkName": "my-device-link", "subnet": "20.10.0.0/16", "bandwidth": "100", "deviceList": [ { "deviceName": "ICGW_1" }, { "deviceName": "ICGW_2" } ] } } } } }, "required": true }, "responses": { "200": { "description": "Accepted", "content": { "application/json": { "schema": { "type": "object", "properties": { "dlMetroBandwidth": { "type": "integer", "description": "Device-Link metro speed", "format": "int64", "example": 200 } }, "$$ref": "#/components/schemas/InlineResponse20012" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/interconnect/{interconnect-type}/connectivity/device-links/port-speeds": { "get": { "tags": [ "Multicloud Interconnect - Connectivity" ], "summary": "Get Device-Link port speeds.", "description": "API to get supported port speeds for Device-Link by Interconnect provider.", "operationId": "getInterconnectDeviceLinkPortSpeeds", "parameters": [ { "name": "interconnect-type", "in": "path", "description": "Interconnect Provider Type", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Accepted", "content": { "application/json": { "schema": { "type": "object", "properties": { "portSpeeds": { "type": "array", "description": "Supported port speeds", "example": [ "50, 100" ], "items": { "type": "string", "description": "speed", "example": "50" } } }, "$$ref": "#/components/schemas/InlineResponse20011" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/interconnect/{interconnect-type}/gateways/device-chassis-numbers": { "get": { "tags": [ "Multicloud Interconnect - Gateways" ], "summary": "Get Interconnect gateway devices by config ID.", "description": "API to retrieve available devices or devices associated to a config group.", "operationId": "getAvailableDevicesOrByCGId_MulticloudInterconnectGateways_7603", "parameters": [ { "name": "interconnect-type", "in": "path", "description": "Interconnect provider type", "required": true, "schema": { "type": "string", "enum": [ "MEGAPORT", "EQUINIX" ] } }, { "name": "config-group-id", "in": "query", "description": "Config Group Id", "schema": { "pattern": "[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}", "type": "string" } }, { "name": "device-solution-type", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Accepted", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "configuredHostname": { "type": "string", "example": "ICGW1" }, "configuredSystemIP": { "type": "string", "example": "1.1.1.10" }, "deviceModel": { "type": "string", "example": "C8000v" }, "uuid": { "type": "string" } }, "$$ref": "#/components/schemas/InlineResponse2003" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/interconnect/{interconnect-type}/gateways/devices": { "get": { "tags": [ "Multicloud Interconnect - Gateways" ], "summary": "Get available Interconnect Gateway devices.", "description": "API to retrieve available Interconnect Gateway devices.", "operationId": "getInterconnectGatewayDevices", "parameters": [ { "name": "interconnect-type", "in": "path", "description": "Interconnect Provider Type", "required": true, "schema": { "type": "string", "enum": [ "MEGAPORT", "EQUINIX" ] } } ], "responses": { "200": { "description": "Accepted", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "configuredHostname": { "type": "string", "example": "ICGW1" }, "configuredSystemIP": { "type": "string", "example": "1.1.1.10" }, "deviceModel": { "type": "string", "example": "C8000v" }, "uuid": { "type": "string" } }, "$$ref": "#/components/schemas/InlineResponse2003" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/interconnect/{interconnect-type}/locations": { "delete": { "tags": [ "Multicloud Interconnect - Accounts" ], "summary": "Delete Interconnect provider type regions.", "description": "API to delete the stored regions for an Interconnect provider type from vManage.", "operationId": "deleteAllInterconnectLocationInfo", "parameters": [ { "name": "interconnect-type", "in": "path", "description": "Interconnect provider type", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Accepted" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/interconnect/{interconnect-type}/monitoring/connected-sites": { "get": { "tags": [ "Multicloud Interconnect - Monitoring" ], "summary": "Get Interconnect devices for monitoring.", "description": "API to retrieve Interconnect devices by Interconnect type for monitoring.", "operationId": "getMonitoringInterconnectConnectedSites", "parameters": [ { "name": "interconnect-type", "in": "path", "description": "Interconnect provider type", "required": true, "schema": { "type": "string" } }, { "name": "interconnect-gateway-name", "in": "query", "description": "Interconnect Gateway Name", "schema": { "maxLength": 255, "minLength": 1, "type": "string" } } ], "responses": { "200": { "description": "Accepted", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "bfdSessions": { "type": "integer", "format": "int32" }, "bfdSessionsUp": { "type": "integer", "format": "int32" }, "device-model": { "type": "string" }, "device-type": { "type": "string" }, "host-name": { "type": "string" }, "lastUpdated": { "type": "number" }, "local-system-ip": { "type": "string" }, "reachability": { "type": "string" }, "site-id": { "type": "string" }, "status": { "type": "string" }, "statusBfd": { "type": "string" }, "system-ip": { "type": "string" }, "uuid": { "type": "string" }, "version": { "type": "string" } }, "$$ref": "#/components/schemas/InterconnectConnectedSite" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/interconnect/{interconnect-type}/monitoring/devices": { "get": { "tags": [ "Multicloud Interconnect - Monitoring" ], "summary": "Retrieve Interconnect devices for monitoring.", "description": "API to retrieve Interconnect devices by Interconnect type for monitoring.", "operationId": "getMonitoringInterconnectDevices", "parameters": [ { "name": "interconnect-type", "in": "path", "description": "Interconnect provider type", "required": true, "schema": { "type": "string" } }, { "name": "interconnect-gateway-name", "in": "query", "description": "Interconnect Gateway Name", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Accepted", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "configStatusMessage": { "type": "string" }, "configuredSystemIP": { "type": "string" }, "device-model": { "type": "string" }, "device-type": { "type": "string" }, "edgeGatewayName": { "type": "string" }, "host-name": { "type": "string" }, "lastUpdated": { "type": "number" }, "local-system-ip": { "type": "string" }, "reachability": { "type": "string" }, "site-id": { "type": "string" }, "status": { "type": "string" }, "system-ip": { "type": "string" }, "uptimeDate": { "type": "number" }, "uuid": { "type": "string" }, "version": { "type": "string" } }, "$$ref": "#/components/schemas/InterconnectDeviceInfoExtended" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/interconnect/{interconnect-type}/monitoring/gateways": { "get": { "tags": [ "Multicloud Interconnect - Monitoring" ], "summary": "Get Interconnect gateways for monitoring.", "description": "API to retrieve Interconnect gateways by Interconnect type for monitoring.", "operationId": "getMonitoringInterconnectGateways", "parameters": [ { "name": "interconnect-type", "in": "path", "description": "Interconnect provider type", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Accepted", "content": { "application/json": { "schema": { "type": "array", "items": { "required": [ "deviceUuid", "edgeAccountId", "edgeGatewayName", "edgeType", "region", "siteName" ], "type": "object", "properties": { "description": { "maxLength": 255, "minLength": 1, "type": "string" }, "deviceUuid": { "maxLength": 255, "minLength": 1, "type": "string" }, "edgeAccountId": { "maxLength": 255, "minLength": 1, "type": "string" }, "edgeAccountName": { "type": "string" }, "edgeGatewayId": { "type": "string" }, "edgeGatewayName": { "maxLength": 255, "minLength": 1, "type": "string" }, "edgeType": { "type": "string" }, "isCustomSetting": { "type": "boolean", "description": "Custom Settings enabled for Interconnect Gateway", "example": true }, "region": { "maxLength": 255, "minLength": 1, "type": "string" }, "resourceState": { "type": "string" }, "siteName": { "maxLength": 255, "minLength": 1, "type": "string" }, "status": { "type": "string" } }, "$$ref": "#/components/schemas/InterconnectGatewayMonitoring" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/interconnect/{interconnect-type}/widget": { "get": { "tags": [ "Multicloud Interconnect - Monitoring" ], "summary": "Get an Interconnect widget for Interconnect type.", "description": "API to retrieve an Interconnect widget for an Interconnect type.", "operationId": "getInterconnectWidget", "parameters": [ { "name": "interconnect-type", "in": "path", "description": "Interconnect provider type", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Accepted", "content": { "application/json": { "schema": { "type": "object", "properties": { "edgeGatewaySolution": { "type": "string", "enum": [ "MVE", "NE" ] }, "edgeType": { "type": "string", "enum": [ "MEGAPORT", "EQUINIX" ] }, "gwDeviceSiteIds": { "type": "array", "properties": { "empty": { "type": "boolean" } }, "items": { "type": "integer", "format": "int64" } }, "gwDeviceStatus": { "type": "object", "properties": { "count": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "statusList": { "type": "array", "properties": { "empty": { "type": "boolean" } }, "items": { "type": "object", "properties": { "count": { "type": "integer", "format": "int64" }, "message": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string" } }, "$$ref": "#/components/schemas/StatusObject" } }, "unreachableCount": { "type": "integer", "format": "int64" } }, "$$ref": "#/components/schemas/GwDeviceStatus" }, "gwSitestatus": { "type": "object", "properties": { "count": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "statusList": { "type": "array", "properties": { "empty": { "type": "boolean" } }, "items": { "type": "object", "properties": { "count": { "type": "integer", "format": "int64" }, "message": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string" } }, "$$ref": "#/components/schemas/StatusObject" } } }, "$$ref": "#/components/schemas/GwSiteStatus" }, "gwStatus": { "type": "object", "properties": { "count": { "type": "integer", "format": "int64" }, "name": { "type": "string" }, "statusList": { "type": "array", "properties": { "empty": { "type": "boolean" } }, "items": { "type": "object", "properties": { "count": { "type": "integer", "format": "int64" }, "message": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string" } }, "$$ref": "#/components/schemas/StatusObject" } } }, "$$ref": "#/components/schemas/GwStatus" }, "numAccounts": { "type": "integer", "format": "int64" }, "numConn": { "type": "integer", "format": "int64" }, "numConnDown": { "type": "integer", "format": "int64" }, "numConnLive": { "type": "integer", "format": "int64", "writeOnly": true }, "numConnPartial": { "type": "integer", "format": "int64" }, "numConnUp": { "type": "integer", "format": "int64" }, "numSdwanTunnels": { "type": "integer", "format": "int64" } }, "$$ref": "#/components/schemas/InterconnectWidget" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/multicloud/license/edge": { "get": { "tags": [ "Configuration - Multi Cloud" ], "description": "Get License Info for Edge Gateways/Connections", "operationId": "getLicenses", "parameters": [ { "name": "edgeType", "in": "query", "description": "Edge type", "schema": { "type": "string", "enum": [ "MEGAPORT" ] } }, { "name": "accountId", "in": "query", "description": "Edge Account Id", "schema": { "type": "string" } }, { "name": "productType", "in": "query", "description": "product Type", "schema": { "type": "string", "enum": [ "GATEWAY", "CONNECTION", "AWSHC" ] } }, { "name": "refresh", "in": "query", "description": "Refresh License Cache from Megaport", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Licenses": { "description": "Licenses", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true } }, "/multicloud/locations/edge/{edgeType}": { "delete": { "tags": [ "Configuration - Multi Cloud" ], "description": "Delete edge account", "operationId": "deleteAllEdgeLocationInfo", "parameters": [ { "name": "edgeType", "in": "path", "description": "Edge Type", "required": true, "schema": { "type": "string", "enum": [ "MEGAPORT", "EQUINIX" ], "default": "MEGAPORT" } } ], "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true }, "get": { "tags": [ "Configuration - Multi Cloud" ], "description": "Get Edge Locations", "operationId": "getEdgeLocationsInfo", "parameters": [ { "name": "edgeType", "in": "path", "description": "Edge Type", "required": true, "schema": { "type": "string", "enum": [ "MEGAPORT", "EQUINIX" ], "default": "MEGAPORT" } }, { "name": "accountId", "in": "query", "description": "Edge Account Id", "schema": { "type": "string" } }, { "name": "region", "in": "query", "description": "Region", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Edge locations": { "description": "Edge locations" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true } }, "/multicloud/locations/edge/{edgeType}/accountId/{accountId}": { "put": { "tags": [ "Configuration - Multi Cloud" ], "description": "Update Edge Locations", "operationId": "updateEdgeLocationsInfo", "parameters": [ { "name": "edgeType", "in": "path", "description": "Edge Type", "required": true, "schema": { "type": "string", "enum": [ "MEGAPORT", "EQUINIX" ], "default": "MEGAPORT" } }, { "name": "accountId", "in": "path", "description": "Edge Account Id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Edge locations": { "description": "Edge locations" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true } }, "/multicloud/loopbackCGWColor/edge": { "get": { "tags": [ "Configuration - Multi Cloud" ], "description": "Get Edge Loopback CGW supported colors", "operationId": "getSupportedLoopbackCgwColors", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Edge Loopback CGW colors": { "description": "Edge Loopback CGW colors" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true } }, "/multicloud/loopbacktransportcolor/edge": { "get": { "tags": [ "Configuration - Multi Cloud" ], "description": "Get Edge Loopback Tunnel supported colors", "operationId": "getSupportedLoopbackTransportColors", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Edge Loopback Tunnel colors": { "description": "Edge Loopback Tunnel colors", "value": { "loopbackTunnelColor": [ "mpls", "metro-ethernet", "biz-internet", "public-internet", "lte", "3g", "red", "green", "blue", "gold", "silver", "bronze", "custom1", "custom2", "custom3", "private1", "private2", "private3", "private4", "private5", "private6" ] } } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true } }, "/multicloud/map/tags/edge": { "get": { "tags": [ "Configuration - Multi Cloud" ], "description": "Get default Interconnect mapping tag values", "operationId": "getEdgeMappingTags", "parameters": [ { "name": "cloudType", "in": "query", "description": "Cloud type", "required": true, "schema": { "type": "string", "enum": [ "AWS", "AWS_GOVCLOUD", "AZURE" ] } }, { "name": "accountId", "in": "query", "description": "Cloud Account Id", "schema": { "type": "string" } }, { "name": "resourceGroup", "in": "query", "description": "Resource Group", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Interconnect Cloud Tags": { "description": "Interconnect Cloud Tags", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true, "x-roles-required": "Cloud OnRamp-read" } }, "/multicloud/partnerports/edge": { "get": { "tags": [ "Configuration - Multi Cloud" ], "description": "Get partner ports", "operationId": "getPartnerPorts", "parameters": [ { "name": "edgeType", "in": "query", "description": "Edge type", "schema": { "type": "string", "enum": [ "MEGAPORT", "EQUINIX" ] } }, { "name": "accountId", "in": "query", "description": "Edge Account Id", "schema": { "type": "string" } }, { "name": "cloudType", "in": "query", "description": "Cloud Type", "schema": { "type": "string" } }, { "name": "connectType", "in": "query", "description": "Connect Type filter", "schema": { "type": "string" } }, { "name": "vxcPermitted", "in": "query", "description": "VXC Permitted on the port", "schema": { "type": "string" } }, { "name": "authorizationKey", "in": "query", "description": "authorization Key", "schema": { "type": "string" } }, { "name": "refresh", "in": "query", "description": "Refresh", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Edge Partners ": { "description": "Edge Partners ", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true } }, "/multicloud/portSpeed/edge/{edgeType}/{edgeAccountId}/{connectivityType}": { "get": { "tags": [ "Configuration - Multi Cloud" ], "description": "Get supported port speed", "operationId": "getPortSpeed", "parameters": [ { "name": "edgeType", "in": "path", "description": "Interconnect Provider", "required": true, "schema": { "type": "string", "enum": [ "MEGAPORT", "EQUINIX" ] } }, { "name": "edgeAccountId", "in": "path", "description": "Interconnect Provider Account ID", "required": true, "schema": { "type": "string" } }, { "name": "connectivityType", "in": "path", "description": "Interconnect Connectivity Type", "required": true, "schema": { "type": "string" } }, { "name": "cloudType", "in": "query", "description": "Cloud Service Provider", "schema": { "type": "string", "enum": [ "AWS", "AZURE", "GCP" ] } }, { "name": "cloudAccountId", "in": "query", "description": "Cloud Service Provider Account ID", "schema": { "type": "string" } }, { "name": "connectType", "in": "query", "description": "Connection Type filter", "schema": { "type": "string" } }, { "name": "connectSubType", "in": "query", "description": "Connection Sub-Type filter", "schema": { "type": "string" } }, { "name": "connectivityGateway", "in": "query", "description": "Connectivity Gateway", "schema": { "type": "string" } }, { "name": "partnerPort", "in": "query", "description": "partnerPort", "schema": { "type": "string" } }, { "name": "authorizationKey", "in": "query", "description": "authorizationKey", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "port-speed": { "description": "port-speed", "value": "{100, 200}" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true } }, "/multicloud/settings/edge/global": { "post": { "tags": [ "Configuration - Multi Cloud" ], "description": "Add global settings for Edge provider", "operationId": "addEdgeGlobalSettings", "requestBody": { "description": "Global setting", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Global setting": { "description": "Global setting" } } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true }, "get": { "tags": [ "Configuration - Multi Cloud" ], "description": "Get edge global settings", "operationId": "getEdgeGlobalSettings", "parameters": [ { "name": "edgeType", "in": "query", "description": "Edge type", "required": true, "schema": { "type": "string", "enum": [ "MP", "EQ" ] } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Global setting": { "description": "Global setting" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true }, "put": { "tags": [ "Configuration - Multi Cloud" ], "description": "Update edge global settings for Edge provider", "operationId": "updateEdgeGlobalSettings", "requestBody": { "description": "Global setting", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Global setting": { "description": "Global setting" } } } }, "required": true }, "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true } }, "/multicloud/types/edge": { "get": { "tags": [ "Configuration - Multi Cloud" ], "description": "Get edge types", "operationId": "getEdgeTypes", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Cloud types": { "description": "Cloud types" } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true } }, "/multicloud/vhubs": { "get": { "tags": [ "Configuration - Multi Cloud" ], "description": "Get Virtual Hubs", "operationId": "getVHubs", "parameters": [ { "name": "cloudType", "in": "query", "description": "Cloud Type", "schema": { "type": "string" } }, { "name": "accountId", "in": "query", "description": "Account Id", "schema": { "type": "string" } }, { "name": "resourceGroup", "in": "query", "description": "Resource Group", "schema": { "type": "string" } }, { "name": "vWanName", "in": "query", "description": "VWan Name", "schema": { "type": "string" } }, { "name": "vNetTags", "in": "query", "description": "VNet Tags", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Azure Virtual WANs": { "description": "Azure Virtual WANs", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true } }, "/multicloud/vwan": { "post": { "tags": [ "Configuration - Multi Cloud" ], "description": "Create Virtual WAN", "operationId": "createVirtualWan", "requestBody": { "description": "Virtual WAN", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Virtual WAN": { "description": "Virtual WAN" } } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Task Id": { "description": "Task Id", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true } }, "/multicloud/vwan/{cloudProvider}/{vWanName}": { "delete": { "tags": [ "Configuration - Multi Cloud" ], "description": "Delete Virtual Wan", "operationId": "deleteVirtualWan", "parameters": [ { "name": "cloudProvider", "in": "path", "description": "Cloud Provider", "required": true, "schema": { "type": "string" } }, { "name": "vWanName", "in": "path", "description": "Virtual Wan name", "required": true, "schema": { "type": "string" } }, { "name": "accountId", "in": "query", "description": "Account Id", "schema": { "type": "string" } }, { "name": "resourceGroup", "in": "query", "description": "Resource Group", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Task Id": { "description": "Task Id", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true } }, "/multicloud/vwans": { "get": { "tags": [ "Configuration - Multi Cloud" ], "description": "Get Virtual Wans", "operationId": "getVWans", "parameters": [ { "name": "accountId", "in": "query", "description": "Account Id", "schema": { "type": "string" } }, { "name": "cloudType", "in": "query", "description": "Cloud Type", "schema": { "type": "string" } }, { "name": "resourceGroup", "in": "query", "description": "Resource Group", "schema": { "type": "string" } }, { "name": "refresh", "in": "query", "description": "Refresh", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Azure Virtual WANs": { "description": "Azure Virtual WANs", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true } }, "/multicloud/widget/edge": { "get": { "tags": [ "Configuration - Multi Cloud" ], "description": "Get All Interconnect Edge widgets ", "operationId": "getAllEdgeWidgets", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Edge widget": { "description": "Edge widget", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true, "x-roles-required": "Cloud OnRamp-read" } }, "/multicloud/widget/edge/{edgeType}": { "get": { "tags": [ "Configuration - Multi Cloud" ], "description": "Get Interconnect Edge widget by edge type", "operationId": "getEdgeWidget", "parameters": [ { "name": "edgeType", "in": "path", "description": "Edge type", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object" }, "examples": { "Edge widget": { "description": "Edge widget", "value": {} } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } }, "deprecated": true, "x-roles-required": "Cloud OnRamp-read" } }, "/v1/multicloud/interconnect/gateways/{interconnect-gateway-name}": { "put": { "tags": [ "Multicloud Interconnect - Gateways" ], "summary": "Edit Interconnect Gateway Information.", "description": "Asynchronous API to update the Interconnect Gateway Information in vManage.", "operationId": "updateInterconnectGateway_MulticloudInterconnectGateways_6403", "parameters": [ { "name": "interconnect-gateway-name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Request Payload for Multicloud Interconnect Gateways", "content": { "application/json": { "schema": { "required": [ "deviceUuid", "edgeAccountId", "edgeBillingAccountId", "edgeGatewayName", "edgeType", "ipTransit", "licenseType", "region", "regionId", "siteName" ], "type": "object", "properties": { "configGroupSettings": { "required": [ "configGroupId", "configGroupName" ], "type": "object", "properties": { "configGroupId": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Config Group Id", "example": "482eb6f3-1168-4b6f-901a-bd2c788b370d" }, "configGroupName": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Config Group name", "example": "My-CG-1" } }, "$$ref": "#/components/schemas/InterconnectConfigGroupSettings" }, "description": { "maxLength": 255, "minLength": 1, "type": "string" }, "deviceUuid": { "maxLength": 255, "minLength": 1, "type": "string" }, "edgeAccountId": { "maxLength": 255, "minLength": 1, "type": "string" }, "edgeBillingAccountId": { "maxLength": 255, "minLength": 1, "type": "string" }, "edgeGatewayName": { "maxLength": 255, "minLength": 1, "type": "string" }, "edgeType": { "type": "string" }, "egwBgpAsn": { "type": "string", "description": "BGP ASN assigned to Interconnect Gateway", "example": "64500" }, "ipTransit": { "maxLength": 255, "minLength": 1, "type": "string" }, "ipTransitId": { "type": "string" }, "ipTransitSkuId": { "type": "string" }, "isCustomSetting": { "type": "boolean", "description": "Custom Settings enabled for Interconnect Gateway", "example": true }, "licenseSkuId": { "type": "string", "description": "License Sku Id of Interconnect Gateway", "example": "12345" }, "licenseType": { "type": "string", "enum": [ "PAYG", "PREPAID", "DIRECT" ] }, "loopbackCidr": { "type": "string", "description": "Ip pool allocated to Interconnect Gateway for Loopback Interfaces", "example": "172.31.251.4/30" }, "mrfSettings": { "type": "object", "properties": { "mrfRouterRole": { "type": "string", "description": "Multi Region Fabric router role", "example": "border" }, "mrfTransportGateway": { "type": "boolean", "description": "Multi Region Fabric Transport Gateway", "example": false }, "nhmRegionId": { "type": "integer", "description": "Network Hierarchy Region Id", "format": "int64", "example": 123 }, "nhmRegionName": { "type": "string", "description": "Network Hierarchy Region name", "example": "My-Region" } }, "$$ref": "#/components/schemas/InterconnectMrfSettings" }, "region": { "maxLength": 255, "minLength": 1, "type": "string" }, "regionId": { "maxLength": 255, "minLength": 1, "type": "string" }, "resourceState": { "type": "string" }, "resourceStateMessage": { "type": "string" }, "resourceStateUpdateTs": { "type": "string" }, "serviceChainAttachments": { "type": "string" }, "settings": { "required": [ "instanceSize", "softwareImageId" ], "type": "object", "properties": { "edgeGatewaySolution": { "type": "string", "enum": [ "MVE", "NE" ] }, "edgeType": { "type": "string", "enum": [ "MEGAPORT", "EQUINIX", "ATT" ] }, "egwCustomSettingName": { "type": "string", "description": "Assigned name of the Interconnect Gateway Custom Settings" }, "instanceSize": { "maxLength": 255, "minLength": 1, "type": "string" }, "ipSubnetPool": { "type": "string", "description": "Ip subnet pool assigned to the gateway", "example": "192.168.10.0/24" }, "softwareImageId": { "maxLength": 255, "minLength": 1, "pattern": "^C8000v.*$", "type": "string" } }, "$$ref": "#/components/schemas/InterconnectGatewaySettings" }, "siteName": { "maxLength": 255, "minLength": 1, "type": "string" } }, "$$ref": "#/components/schemas/InterconnectGatewayExtended" }, "examples": { "Interconnect Megaport Gateways": { "description": "Interconnect Megaport Gateways", "value": { "edgeType": "MEGAPORT", "edgeAccountId": "ABCD-1234-CDEF", "edgeGatewayName": "mp-gateway-name", "description": "This is my Megaport gateway", "region": "Cologix TOR1, Toronto, ON, Canada : Toronto", "regionId": "10", "siteName": "My_Megaport_Site", "deviceUuid": "C8K-f7f6c42c-409d-11eb-9562-005056841be8", "settings": { "instanceSize": "Small", "softwareImageId": "C8000v 17.09.01a" }, "mrfSettings": { "mrfRouterRole": "border", "mrfTransportGateway": false } } }, "Interconnect Equinix Gateways - MRF Enabled": { "description": "Interconnect Equinix Gateways - MRF Enabled", "value": "{\n \"edgeType\": \"EQUINIX\",\n \"edgeAccountId\": \"ABCD-1234-CDEF\",\n \"edgeGatewayName\": \"eq-gateway-name\",\n \"description\": \"This is my Equinix Gateway\",\n \"region\": \"NY Metro\",\n \"regionId\": \"10\",\n \"edgeBillingAccountId\": \"ABCD-1234-CDEF\",\n \"siteName\": \"My_Equinix_Site\",\n \"deviceUuid\": \"CSR-725caea2-41a4-497c-821d-a2e280be40f2\",\n \"mrfSettings\": {\n \"mrfRouterRole\": \"edge\",\n \"mrfTransportGateway\": false\n }\n \"settings\": {\n \"instanceSize\": \"Small\",\n \"softwareImageId\": \"CSR1000v 17.03.03\"\n }\n}" }, "Interconnect ATT Gateways - Config Group based": { "description": "Interconnect ATT Gateways - Config Group based", "value": "{\n \"edgeType\": \"ATT\",\n \"edgeAccountId\": \"ABCD-1234-CDEF\",\n \"edgeGatewayName\": \"att-gateway-name\",\n \"description\": \"This is my ATT Gateway\",\n \"region\": \"NY Metro\",\n \"regionId\": \"10\",\n \"siteName\": \"My_ATT_Site\",\n \"deviceUuid\": \"CSR-725caea2-41a4-497c-821d-a2e280be40f2\",\n \"settings\": {\n \"instanceSize\": \"Small\",\n \"softwareImageId\": \"CSR1000v 17.03.03\"\n }\n \"configGroupSettings\": {\n \"configGroupName\": \"ATT-ICGW-CG1\",\n \"configGroupId\": \"a15fa637-7985-4833-a24c-c8db32d378e1\"\n }\n}" } } } }, "required": true }, "responses": { "200": { "description": "Interconnect Gateway Information.", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "Procees Id of the task", "example": "51d0a0e4-983a-471c-9abb-724d58144884" } }, "$$ref": "#/components/schemas/ProcessResponse" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "500": { "description": "Internal Server Error" } } } }, "/v1/service-insertion/service-chain-mapping": { "get": { "tags": [ "Service Chain Mapping" ], "description": "Gets all the Service Chain Mapping with service chain definition name and service chain number.", "operationId": "serviceChainMapping", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } }, "examples": { "serviceChainMapping": { "description": "serviceChainMapping", "value": [ { "serviceChainName": "SC-Firewall", "serviceChainNumber": "SC1" } ] } } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden" }, "405": { "description": "Method not Supported" }, "500": { "description": "Internal Server Error" } } } } } }