From b7404705122975bcc478a3f1d9a30c42ea030e13 Mon Sep 17 00:00:00 2001 From: mdurban Date: Wed, 23 Oct 2024 12:04:41 +0000 Subject: [PATCH] API version v1.51.1-beta.1 --- openapi/spec2.json | 392 ++++++++++++++++++++++++++++++++++++++++- openapi/spec3.json | 422 +++++++++++++++++++++++++++++++++++++++++++-- 2 files changed, 794 insertions(+), 20 deletions(-) diff --git a/openapi/spec2.json b/openapi/spec2.json index eabced7..5a3f280 100644 --- a/openapi/spec2.json +++ b/openapi/spec2.json @@ -1,9 +1,9 @@ { "swagger": "2.0", "info": { - "version": "1.51.1-beta", + "version": "1.51.1-beta.1", "title": "Meraki Dashboard API", - "description": "The Cisco Meraki Dashboard API is a modern REST API based on the OpenAPI specification.\n\n> Date: 16 October, 2024\n>\n> [Recent Updates](https://meraki.io/whats-new/)\n\n---\n\n[API Documentation](https://meraki.io/api)\n\n[Community Support](https://meraki.io/community)\n\n[Meraki Homepage](https://www.meraki.com)\n", + "description": "The Cisco Meraki Dashboard API is a modern REST API based on the OpenAPI specification.\n\n> Date: 23 October, 2024\n>\n> [Recent Updates](https://meraki.io/whats-new/)\n\n---\n\n[API Documentation](https://meraki.io/api)\n\n[Community Support](https://meraki.io/community)\n\n[Meraki Homepage](https://www.meraki.com)\n", "contact": { "name": "Meraki Developer Community", "url": "https://meraki.io/community" @@ -81215,7 +81215,6 @@ "description": "Toggle to activate or deactivate FRA in a network, contingent on AI-RRM being enabled." } }, - "x-release-stage": "beta", "description": "FRA settings" }, "aiRrm": { @@ -81226,7 +81225,6 @@ "description": "Toggle for enabling or disabling AI-RRM in a network" } }, - "x-release-stage": "beta", "description": "AI-RRM settings" } }, @@ -81349,6 +81347,26 @@ } }, "description": "Channel settings" + }, + "fra": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Toggle to activate or deactivate FRA in a network, contingent on AI-RRM being enabled." + } + }, + "description": "FRA settings" + }, + "aiRrm": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Toggle for enabling or disabling AI-RRM in a network" + } + }, + "description": "AI-RRM settings" } } }, @@ -81377,6 +81395,12 @@ "avoidance": { "enabled": true } + }, + "fra": { + "enabled": false + }, + "aiRrm": { + "enabled": true } } } @@ -117053,7 +117077,7 @@ "ports": "1, 2", "status": "completed", "errorMessage": "Some error message", - "outputType": "text", + "outputType": "pcap", "captureSource": "scheduled", "captureReason": "capture reason", "fileSize": 1066, @@ -117316,7 +117340,7 @@ "ports": "1, 2", "status": "completed", "errorMessage": "Some error message", - "outputType": "text", + "outputType": "pcap", "captureSource": "scheduled", "captureReason": "capture reason", "fileSize": 1066, @@ -117648,7 +117672,7 @@ "ports": "1, 2", "status": "completed", "errorMessage": "Some error message", - "outputType": "text", + "outputType": "pcap", "captureSource": "scheduled", "captureReason": "capture reason", "fileSize": 1066, @@ -120148,6 +120172,319 @@ "x-release-stage": "beta" } }, + "/organizations/{organizationId}/extensions/xdr/networks": { + "get": { + "description": "Returns the networks in the organization that have XDR enabled", + "operationId": "getOrganizationExtensionsXdrNetworks", + "parameters": [ + { + "name": "organizationId", + "in": "path", + "description": "Organization ID", + "type": "string", + "required": true + }, + { + "type": "array", + "items": { + "type": "string" + }, + "name": "networkIds", + "in": "query", + "description": "Optional parameter to filter the results by network IDs" + } + ], + "responses": { + "200": { + "description": "Successful operation", + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "networkId": { + "type": "string", + "description": "Network ID" + }, + "productTypes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of products that have XDR enabled" + }, + "name": { + "type": "string", + "description": "The name of the network" + }, + "enabled": { + "type": "boolean", + "description": "Represents whether XDR is enabled for the network" + } + } + } + }, + "examples": { + "application/json": [ + { + "networkId": "N_1234567", + "productTypes": [ + "appliance" + ], + "name": "Test network", + "enabled": true + } + ] + } + } + }, + "summary": "Returns the networks in the organization that have XDR enabled", + "tags": [ + "organizations", + "configure", + "extensions", + "xdr", + "networks" + ], + "x-release-stage": "beta" + } + }, + "/organizations/{organizationId}/extensions/xdr/networks/disable": { + "post": { + "description": "Disable XDR on networks", + "operationId": "disableOrganizationExtensionsXdrNetworks", + "parameters": [ + { + "name": "organizationId", + "in": "path", + "description": "Organization ID", + "type": "string", + "required": true + }, + { + "name": "disableOrganizationExtensionsXdrNetworks", + "in": "body", + "schema": { + "type": "object", + "properties": { + "networks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "networkId": { + "type": "string", + "description": "Network ID" + }, + "productTypes": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "appliance" + ] + }, + "description": "List of products for which to disable XDR" + } + }, + "required": [ + "networkId", + "productTypes" + ] + }, + "description": "List containing the network ID and the product type to disable XDR on" + } + }, + "example": { + "networks": [ + { + "networkId": "N_1234567", + "productTypes": [ + "appliance" + ] + } + ] + }, + "required": [ + "networks" + ] + }, + "required": true + } + ], + "responses": { + "200": { + "description": "Successful operation", + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "networkId": { + "type": "string", + "description": "Network ID" + }, + "productTypes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of products that have XDR disabled" + }, + "name": { + "type": "string", + "description": "The name of the network" + }, + "enabled": { + "type": "boolean", + "description": "Represents whether XDR is enabled for the network" + } + } + } + }, + "examples": { + "application/json": [ + { + "networkId": "N_1234567", + "productTypes": [ + "appliance" + ], + "name": "Test network", + "enabled": false + } + ] + } + } + }, + "summary": "Disable XDR on networks", + "tags": [ + "organizations", + "configure", + "extensions", + "xdr", + "networks" + ], + "x-release-stage": "beta" + } + }, + "/organizations/{organizationId}/extensions/xdr/networks/enable": { + "post": { + "description": "Enable XDR on networks", + "operationId": "enableOrganizationExtensionsXdrNetworks", + "parameters": [ + { + "name": "organizationId", + "in": "path", + "description": "Organization ID", + "type": "string", + "required": true + }, + { + "name": "enableOrganizationExtensionsXdrNetworks", + "in": "body", + "schema": { + "type": "object", + "properties": { + "networks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "networkId": { + "type": "string", + "description": "Network ID" + }, + "productTypes": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "appliance" + ] + }, + "description": "List of products for which to enable XDR" + } + }, + "required": [ + "networkId", + "productTypes" + ] + }, + "description": "List containing the network ID and the product type to enable XDR on" + } + }, + "example": { + "networks": [ + { + "networkId": "N_1234567", + "productTypes": [ + "appliance" + ] + } + ] + }, + "required": [ + "networks" + ] + }, + "required": true + } + ], + "responses": { + "200": { + "description": "Successful operation", + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "networkId": { + "type": "string", + "description": "Network ID" + }, + "productTypes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of products that have XDR enabled" + }, + "name": { + "type": "string", + "description": "The name of the network" + }, + "enabled": { + "type": "boolean", + "description": "Represents whether XDR is enabled for the network" + } + } + } + }, + "examples": { + "application/json": [ + { + "networkId": "N_1234567", + "productTypes": [ + "appliance" + ], + "name": "Test network", + "enabled": true + } + ] + } + } + }, + "summary": "Enable XDR on networks", + "tags": [ + "organizations", + "configure", + "extensions", + "xdr", + "networks" + ], + "x-release-stage": "beta" + } + }, "/organizations/{organizationId}/firmware/upgrades": { "get": { "description": "Get firmware upgrade information for an organization", @@ -149657,6 +149994,26 @@ } }, "description": "Channel settings" + }, + "fra": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Toggle to activate or deactivate FRA in a network, contingent on AI-RRM being enabled." + } + }, + "description": "FRA settings" + }, + "aiRrm": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Toggle for enabling or disabling AI-RRM in a network" + } + }, + "description": "AI-RRM settings" } } } @@ -149687,6 +150044,12 @@ "avoidance": { "enabled": true } + }, + "fra": { + "enabled": false + }, + "aiRrm": { + "enabled": true } } ] @@ -155775,6 +156138,9 @@ { "name": "wlanLists" }, + { + "name": "xdr" + }, { "name": "zigbee" }, @@ -157337,6 +157703,18 @@ "resource": "/organizations/{organizationId}/appliance/vpn/thirdPartyVPNPeers", "operation": "update" }, + { + "group": "Wired/xdr/api/actions/xdr", + "summary": "Disable XDR on networks", + "resource": "/organizations/{organizationId}/extensions/xdr/networks", + "operation": "disable" + }, + { + "group": "Wired/xdr/api/actions/xdr", + "summary": "Enable XDR on networks", + "resource": "/organizations/{organizationId}/extensions/xdr/networks", + "operation": "enable" + }, { "group": "Wireless alternate management interface", "summary": "Update alternate management interface and device static IP", diff --git a/openapi/spec3.json b/openapi/spec3.json index 469f833..b7d8f32 100644 --- a/openapi/spec3.json +++ b/openapi/spec3.json @@ -2,12 +2,12 @@ "openapi": "3.0.1", "info": { "title": "Meraki Dashboard API", - "description": "A RESTful API to programmatically manage and monitor Cisco Meraki networks at scale.\n\n> Date: 16 October, 2024\n>\n> [Recent Updates](https://meraki.io/whats-new/)\n\n---\n\n[API Documentation](https://meraki.io/api)\n\n[Community Support](https://meraki.io/community)\n\n[Meraki Homepage](https://www.meraki.com)\n", + "description": "A RESTful API to programmatically manage and monitor Cisco Meraki networks at scale.\n\n> Date: 23 October, 2024\n>\n> [Recent Updates](https://meraki.io/whats-new/)\n\n---\n\n[API Documentation](https://meraki.io/api)\n\n[Community Support](https://meraki.io/community)\n\n[Meraki Homepage](https://www.meraki.com)\n", "contact": { "name": "Meraki Developer Community", "url": "https://meraki.io/community" }, - "version": "1.51.1-beta" + "version": "1.51.1-beta.1" }, "servers": [ { @@ -86521,7 +86521,6 @@ "description": "Toggle to activate or deactivate FRA in a network, contingent on AI-RRM being enabled." } }, - "x-release-stage": "beta", "description": "FRA settings" }, "aiRrm": { @@ -86532,7 +86531,6 @@ "description": "Toggle for enabling or disabling AI-RRM in a network" } }, - "x-release-stage": "beta", "description": "AI-RRM settings" } }, @@ -86659,6 +86657,26 @@ } }, "description": "Channel settings" + }, + "fra": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Toggle to activate or deactivate FRA in a network, contingent on AI-RRM being enabled." + } + }, + "description": "FRA settings" + }, + "aiRrm": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Toggle for enabling or disabling AI-RRM in a network" + } + }, + "description": "AI-RRM settings" } } }, @@ -86686,6 +86704,12 @@ "avoidance": { "enabled": true } + }, + "fra": { + "enabled": false + }, + "aiRrm": { + "enabled": true } } } @@ -124270,10 +124294,10 @@ "name": "file_name", "startTime": "2018-02-11T00:00:00.090210Z", "ports": "1, 2", - "status": "capturing", + "status": "new", "errorMessage": "Some error message", - "outputType": "text", - "captureSource": "proactive", + "outputType": "upload_to_cloud", + "captureSource": "automatic", "captureReason": "capture reason", "fileSize": 1066, "duration": 60, @@ -124547,10 +124571,10 @@ "name": "file_name", "startTime": "2018-02-11T00:00:00.090210Z", "ports": "1, 2", - "status": "capturing", + "status": "new", "errorMessage": "Some error message", - "outputType": "text", - "captureSource": "proactive", + "outputType": "upload_to_cloud", + "captureSource": "automatic", "captureReason": "capture reason", "fileSize": 1066, "duration": 60, @@ -124897,10 +124921,10 @@ "name": "file_name", "startTime": "2018-02-11T00:00:00.090210Z", "ports": "1, 2", - "status": "capturing", + "status": "new", "errorMessage": "Some error message", - "outputType": "text", - "captureSource": "proactive", + "outputType": "upload_to_cloud", + "captureSource": "automatic", "captureReason": "capture reason", "fileSize": 1066, "duration": 60, @@ -127600,6 +127624,337 @@ "x-release-stage": "beta" } }, + "/organizations/{organizationId}/extensions/xdr/networks": { + "get": { + "description": "Returns the networks in the organization that have XDR enabled", + "operationId": "getOrganizationExtensionsXdrNetworks", + "parameters": [ + { + "name": "organizationId", + "in": "path", + "description": "Organization ID", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "networkIds", + "in": "query", + "description": "Optional parameter to filter the results by network IDs", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + ], + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "networkId": { + "type": "string", + "description": "Network ID" + }, + "productTypes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of products that have XDR enabled" + }, + "name": { + "type": "string", + "description": "The name of the network" + }, + "enabled": { + "type": "boolean", + "description": "Represents whether XDR is enabled for the network" + } + } + } + }, + "example": [ + { + "networkId": "N_1234567", + "productTypes": [ + "appliance" + ], + "name": "Test network", + "enabled": true + } + ] + } + } + } + }, + "summary": "Returns the networks in the organization that have XDR enabled", + "tags": [ + "organizations", + "configure", + "extensions", + "xdr", + "networks" + ], + "x-release-stage": "beta" + } + }, + "/organizations/{organizationId}/extensions/xdr/networks/disable": { + "post": { + "description": "Disable XDR on networks", + "operationId": "disableOrganizationExtensionsXdrNetworks", + "parameters": [ + { + "name": "organizationId", + "in": "path", + "description": "Organization ID", + "schema": { + "type": "string" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "networks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "networkId": { + "type": "string", + "description": "Network ID" + }, + "productTypes": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "appliance" + ] + }, + "description": "List of products for which to disable XDR" + } + }, + "required": [ + "networkId", + "productTypes" + ] + }, + "description": "List containing the network ID and the product type to disable XDR on" + } + }, + "example": { + "networks": [ + { + "networkId": "N_1234567", + "productTypes": [ + "appliance" + ] + } + ] + }, + "required": [ + "networks" + ] + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "networkId": { + "type": "string", + "description": "Network ID" + }, + "productTypes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of products that have XDR disabled" + }, + "name": { + "type": "string", + "description": "The name of the network" + }, + "enabled": { + "type": "boolean", + "description": "Represents whether XDR is enabled for the network" + } + } + } + }, + "example": [ + { + "networkId": "N_1234567", + "productTypes": [ + "appliance" + ], + "name": "Test network", + "enabled": false + } + ] + } + } + } + }, + "summary": "Disable XDR on networks", + "tags": [ + "organizations", + "configure", + "extensions", + "xdr", + "networks" + ], + "x-release-stage": "beta" + } + }, + "/organizations/{organizationId}/extensions/xdr/networks/enable": { + "post": { + "description": "Enable XDR on networks", + "operationId": "enableOrganizationExtensionsXdrNetworks", + "parameters": [ + { + "name": "organizationId", + "in": "path", + "description": "Organization ID", + "schema": { + "type": "string" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "networks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "networkId": { + "type": "string", + "description": "Network ID" + }, + "productTypes": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "appliance" + ] + }, + "description": "List of products for which to enable XDR" + } + }, + "required": [ + "networkId", + "productTypes" + ] + }, + "description": "List containing the network ID and the product type to enable XDR on" + } + }, + "example": { + "networks": [ + { + "networkId": "N_1234567", + "productTypes": [ + "appliance" + ] + } + ] + }, + "required": [ + "networks" + ] + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "Successful operation", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "networkId": { + "type": "string", + "description": "Network ID" + }, + "productTypes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of products that have XDR enabled" + }, + "name": { + "type": "string", + "description": "The name of the network" + }, + "enabled": { + "type": "boolean", + "description": "Represents whether XDR is enabled for the network" + } + } + } + }, + "example": [ + { + "networkId": "N_1234567", + "productTypes": [ + "appliance" + ], + "name": "Test network", + "enabled": true + } + ] + } + } + } + }, + "summary": "Enable XDR on networks", + "tags": [ + "organizations", + "configure", + "extensions", + "xdr", + "networks" + ], + "x-release-stage": "beta" + } + }, "/organizations/{organizationId}/firmware/upgrades": { "get": { "description": "Get firmware upgrade information for an organization", @@ -159251,6 +159606,26 @@ } }, "description": "Channel settings" + }, + "fra": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Toggle to activate or deactivate FRA in a network, contingent on AI-RRM being enabled." + } + }, + "description": "FRA settings" + }, + "aiRrm": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Toggle for enabling or disabling AI-RRM in a network" + } + }, + "description": "AI-RRM settings" } } } @@ -159280,6 +159655,12 @@ "avoidance": { "enabled": true } + }, + "fra": { + "enabled": false + }, + "aiRrm": { + "enabled": true } } ] @@ -165816,6 +166197,9 @@ { "name": "wlanLists" }, + { + "name": "xdr" + }, { "name": "zigbee" }, @@ -167378,6 +167762,18 @@ "resource": "/organizations/{organizationId}/appliance/vpn/thirdPartyVPNPeers", "operation": "update" }, + { + "group": "Wired/xdr/api/actions/xdr", + "summary": "Disable XDR on networks", + "resource": "/organizations/{organizationId}/extensions/xdr/networks", + "operation": "disable" + }, + { + "group": "Wired/xdr/api/actions/xdr", + "summary": "Enable XDR on networks", + "resource": "/organizations/{organizationId}/extensions/xdr/networks", + "operation": "enable" + }, { "group": "Wireless alternate management interface", "summary": "Update alternate management interface and device static IP",