diff --git a/openapi/spec2.json b/openapi/spec2.json index 3ff85a1..3075fdb 100644 --- a/openapi/spec2.json +++ b/openapi/spec2.json @@ -1,9 +1,9 @@ { "swagger": "2.0", "info": { - "version": "1.54.0-beta.1", + "version": "1.54.0-beta.2", "title": "Meraki Dashboard API", - "description": "The Cisco Meraki Dashboard API is a modern REST API based on the OpenAPI specification.\n\n> Date: 08 January, 2025\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: 15 January, 2025\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" @@ -13518,7 +13518,7 @@ "properties": { "interfaceId": { "type": "string", - "description": "The id" + "description": "The ID" }, "name": { "type": "string", @@ -13538,14 +13538,22 @@ }, "vlanId": { "type": "integer", - "description": "VLAN id" + "description": "VLAN ID" + }, + "uplinkV4": { + "type": "boolean", + "description": "When true, this interface is the switch's static IPv4 uplink" + }, + "uplinkV6": { + "type": "boolean", + "description": "When true, this interface is the switch's static IPv6 uplink" }, "ospfSettings": { "type": "object", "properties": { "area": { "type": "string", - "description": "Area id" + "description": "Area ID" }, "cost": { "type": "integer", @@ -13563,7 +13571,7 @@ "properties": { "area": { "type": "string", - "description": "Area id" + "description": "Area ID" }, "cost": { "type": "integer", @@ -13614,6 +13622,8 @@ "interfaceIp": "192.168.1.2", "multicastRouting": "disabled", "vlanId": 100, + "uplinkV4": false, + "uplinkV6": false, "ospfSettings": { "area": "0", "cost": 1, @@ -13761,7 +13771,7 @@ "properties": { "interfaceId": { "type": "string", - "description": "The id" + "description": "The ID" }, "name": { "type": "string", @@ -13781,14 +13791,22 @@ }, "vlanId": { "type": "integer", - "description": "VLAN id" + "description": "VLAN ID" + }, + "uplinkV4": { + "type": "boolean", + "description": "When true, this interface is the switch's static IPv4 uplink" + }, + "uplinkV6": { + "type": "boolean", + "description": "When true, this interface is the switch's static IPv6 uplink" }, "ospfSettings": { "type": "object", "properties": { "area": { "type": "string", - "description": "Area id" + "description": "Area ID" }, "cost": { "type": "integer", @@ -13806,7 +13824,7 @@ "properties": { "area": { "type": "string", - "description": "Area id" + "description": "Area ID" }, "cost": { "type": "integer", @@ -13855,6 +13873,8 @@ "interfaceIp": "192.168.1.2", "multicastRouting": "disabled", "vlanId": 100, + "uplinkV4": false, + "uplinkV6": false, "ospfSettings": { "area": "0", "cost": 1, @@ -13913,7 +13933,7 @@ "properties": { "interfaceId": { "type": "string", - "description": "The id" + "description": "The ID" }, "name": { "type": "string", @@ -13933,14 +13953,22 @@ }, "vlanId": { "type": "integer", - "description": "VLAN id" + "description": "VLAN ID" + }, + "uplinkV4": { + "type": "boolean", + "description": "When true, this interface is the switch's static IPv4 uplink" + }, + "uplinkV6": { + "type": "boolean", + "description": "When true, this interface is the switch's static IPv6 uplink" }, "ospfSettings": { "type": "object", "properties": { "area": { "type": "string", - "description": "Area id" + "description": "Area ID" }, "cost": { "type": "integer", @@ -13958,7 +13986,7 @@ "properties": { "area": { "type": "string", - "description": "Area id" + "description": "Area ID" }, "cost": { "type": "integer", @@ -14007,6 +14035,8 @@ "interfaceIp": "192.168.1.2", "multicastRouting": "disabled", "vlanId": 100, + "uplinkV4": false, + "uplinkV6": false, "ospfSettings": { "area": "0", "cost": 1, @@ -14160,7 +14190,7 @@ "properties": { "interfaceId": { "type": "string", - "description": "The id" + "description": "The ID" }, "name": { "type": "string", @@ -14180,14 +14210,22 @@ }, "vlanId": { "type": "integer", - "description": "VLAN id" + "description": "VLAN ID" + }, + "uplinkV4": { + "type": "boolean", + "description": "When true, this interface is the switch's static IPv4 uplink" + }, + "uplinkV6": { + "type": "boolean", + "description": "When true, this interface is the switch's static IPv6 uplink" }, "ospfSettings": { "type": "object", "properties": { "area": { "type": "string", - "description": "Area id" + "description": "Area ID" }, "cost": { "type": "integer", @@ -14205,7 +14243,7 @@ "properties": { "area": { "type": "string", - "description": "Area id" + "description": "Area ID" }, "cost": { "type": "integer", @@ -14254,6 +14292,8 @@ "interfaceIp": "192.168.1.2", "multicastRouting": "disabled", "vlanId": 100, + "uplinkV4": false, + "uplinkV6": false, "ospfSettings": { "area": "0", "cost": 1, @@ -71542,7 +71582,7 @@ "properties": { "interfaceId": { "type": "string", - "description": "The id" + "description": "The ID" }, "name": { "type": "string", @@ -71562,14 +71602,22 @@ }, "vlanId": { "type": "integer", - "description": "VLAN id" + "description": "VLAN ID" + }, + "uplinkV4": { + "type": "boolean", + "description": "When true, this interface is the switch's static IPv4 uplink" + }, + "uplinkV6": { + "type": "boolean", + "description": "When true, this interface is the switch's static IPv6 uplink" }, "ospfSettings": { "type": "object", "properties": { "area": { "type": "string", - "description": "Area id" + "description": "Area ID" }, "cost": { "type": "integer", @@ -71587,7 +71635,7 @@ "properties": { "area": { "type": "string", - "description": "Area id" + "description": "Area ID" }, "cost": { "type": "integer", @@ -71638,6 +71686,8 @@ "interfaceIp": "192.168.1.2", "multicastRouting": "disabled", "vlanId": 100, + "uplinkV4": false, + "uplinkV6": false, "ospfSettings": { "area": "0", "cost": 1, @@ -71822,7 +71872,7 @@ "properties": { "interfaceId": { "type": "string", - "description": "The id" + "description": "The ID" }, "name": { "type": "string", @@ -71842,14 +71892,22 @@ }, "vlanId": { "type": "integer", - "description": "VLAN id" + "description": "VLAN ID" + }, + "uplinkV4": { + "type": "boolean", + "description": "When true, this interface is the switch's static IPv4 uplink" + }, + "uplinkV6": { + "type": "boolean", + "description": "When true, this interface is the switch's static IPv6 uplink" }, "ospfSettings": { "type": "object", "properties": { "area": { "type": "string", - "description": "Area id" + "description": "Area ID" }, "cost": { "type": "integer", @@ -71867,7 +71925,7 @@ "properties": { "area": { "type": "string", - "description": "Area id" + "description": "Area ID" }, "cost": { "type": "integer", @@ -71916,6 +71974,8 @@ "interfaceIp": "192.168.1.2", "multicastRouting": "disabled", "vlanId": 100, + "uplinkV4": false, + "uplinkV6": false, "ospfSettings": { "area": "0", "cost": 1, @@ -71982,7 +72042,7 @@ "properties": { "interfaceId": { "type": "string", - "description": "The id" + "description": "The ID" }, "name": { "type": "string", @@ -72002,14 +72062,22 @@ }, "vlanId": { "type": "integer", - "description": "VLAN id" + "description": "VLAN ID" + }, + "uplinkV4": { + "type": "boolean", + "description": "When true, this interface is the switch's static IPv4 uplink" + }, + "uplinkV6": { + "type": "boolean", + "description": "When true, this interface is the switch's static IPv6 uplink" }, "ospfSettings": { "type": "object", "properties": { "area": { "type": "string", - "description": "Area id" + "description": "Area ID" }, "cost": { "type": "integer", @@ -72027,7 +72095,7 @@ "properties": { "area": { "type": "string", - "description": "Area id" + "description": "Area ID" }, "cost": { "type": "integer", @@ -72076,6 +72144,8 @@ "interfaceIp": "192.168.1.2", "multicastRouting": "disabled", "vlanId": 100, + "uplinkV4": false, + "uplinkV6": false, "ospfSettings": { "area": "0", "cost": 1, @@ -72261,7 +72331,7 @@ "properties": { "interfaceId": { "type": "string", - "description": "The id" + "description": "The ID" }, "name": { "type": "string", @@ -72281,14 +72351,22 @@ }, "vlanId": { "type": "integer", - "description": "VLAN id" + "description": "VLAN ID" + }, + "uplinkV4": { + "type": "boolean", + "description": "When true, this interface is the switch's static IPv4 uplink" + }, + "uplinkV6": { + "type": "boolean", + "description": "When true, this interface is the switch's static IPv6 uplink" }, "ospfSettings": { "type": "object", "properties": { "area": { "type": "string", - "description": "Area id" + "description": "Area ID" }, "cost": { "type": "integer", @@ -72306,7 +72384,7 @@ "properties": { "area": { "type": "string", - "description": "Area id" + "description": "Area ID" }, "cost": { "type": "integer", @@ -72351,6 +72429,8 @@ "interfaceIp": "192.168.1.2", "multicastRouting": "disabled", "vlanId": 100, + "uplinkV4": false, + "uplinkV6": false, "ospfSettings": { "area": "0", "cost": 1, @@ -82115,8 +82195,7 @@ "wireless", "configure", "opportunisticPcap" - ], - "x-release-stage": "beta" + ] } }, "/networks/{networkId}/wireless/radio/autoRf": { @@ -101326,6 +101405,23 @@ "operationId": { "type": "string", "description": "Operation ID for the endpoint." + }, + "client": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID for the client which made the request, if applicable." + }, + "type": { + "type": "string", + "enum": [ + "oauth" + ], + "description": "Type of client which made the request, if applicable. Available options are: oauth" + } + }, + "description": "Client information" } } } @@ -101349,7 +101445,11 @@ "responseCode": 200, "sourceIp": "123.123.123.1", "version": 1, - "operationId": "getOrganizationApiRequests" + "operationId": "getOrganizationApiRequests", + "client": { + "id": "0hoXjtjX6C-Nk4Nr6kEbCJJFRmIgycaG1HBE572hlIc", + "type": "oauth" + } } ] } @@ -106211,12 +106311,10 @@ "aaa_not_enabled", "afc_height_empty", "afc_status_bad", - "all_auto_vpn_peers_down", "ap_became_repeater", "ap_noauth", "arp_failure", "asymmetry", - "auto_vpn_peer_down", "bad_connectivity", "bad_gateway", "bad_ip6conf", @@ -106226,7 +106324,6 @@ "cellular_failover", "cloud_archive_alert", "collisions_errors", - "config", "config_bad_fetch", "config_error", "config_stale", @@ -106240,13 +106337,11 @@ "device_access_issue", "device_config_failure", "device_no_space", - "device_reporting", "dfs_event_pattern", "disassociation", "dns_down", "dom_stats_alert", "door_tamper", - "dormant", "eapol_test_failed", "error_enable_password", "ethernet_negotiation_failure", @@ -106261,7 +106356,6 @@ "http_acl_ipv6_conflict", "insecure_sm_networks_disabled_enrollment_auth_alert", "insight_web_app", - "insight_web_app_alert", "invalid_config", "ip_conflict", "isp_issue_local_branch", @@ -106302,7 +106396,6 @@ "ntp_issue", "odd_upstream_gateway", "openroaming_firmware_incompatible", - "over_recommended_site_to_site_vpn_tunnels", "pcc_apns_check_cert", "pcc_apns_expired", "pcc_apns_expires_soon", @@ -106781,12 +106874,10 @@ "aaa_not_enabled", "afc_height_empty", "afc_status_bad", - "all_auto_vpn_peers_down", "ap_became_repeater", "ap_noauth", "arp_failure", "asymmetry", - "auto_vpn_peer_down", "bad_connectivity", "bad_gateway", "bad_ip6conf", @@ -106796,7 +106887,6 @@ "cellular_failover", "cloud_archive_alert", "collisions_errors", - "config", "config_bad_fetch", "config_error", "config_stale", @@ -106810,13 +106900,11 @@ "device_access_issue", "device_config_failure", "device_no_space", - "device_reporting", "dfs_event_pattern", "disassociation", "dns_down", "dom_stats_alert", "door_tamper", - "dormant", "eapol_test_failed", "error_enable_password", "ethernet_negotiation_failure", @@ -106831,7 +106919,6 @@ "http_acl_ipv6_conflict", "insecure_sm_networks_disabled_enrollment_auth_alert", "insight_web_app", - "insight_web_app_alert", "invalid_config", "ip_conflict", "isp_issue_local_branch", @@ -106872,7 +106959,6 @@ "ntp_issue", "odd_upstream_gateway", "openroaming_firmware_incompatible", - "over_recommended_site_to_site_vpn_tunnels", "pcc_apns_check_cert", "pcc_apns_expired", "pcc_apns_expires_soon", @@ -107189,12 +107275,10 @@ "aaa_not_enabled", "afc_height_empty", "afc_status_bad", - "all_auto_vpn_peers_down", "ap_became_repeater", "ap_noauth", "arp_failure", "asymmetry", - "auto_vpn_peer_down", "bad_connectivity", "bad_gateway", "bad_ip6conf", @@ -107204,7 +107288,6 @@ "cellular_failover", "cloud_archive_alert", "collisions_errors", - "config", "config_bad_fetch", "config_error", "config_stale", @@ -107218,13 +107301,11 @@ "device_access_issue", "device_config_failure", "device_no_space", - "device_reporting", "dfs_event_pattern", "disassociation", "dns_down", "dom_stats_alert", "door_tamper", - "dormant", "eapol_test_failed", "error_enable_password", "ethernet_negotiation_failure", @@ -107239,7 +107320,6 @@ "http_acl_ipv6_conflict", "insecure_sm_networks_disabled_enrollment_auth_alert", "insight_web_app", - "insight_web_app_alert", "invalid_config", "ip_conflict", "isp_issue_local_branch", @@ -107280,7 +107360,6 @@ "ntp_issue", "odd_upstream_gateway", "openroaming_firmware_incompatible", - "over_recommended_site_to_site_vpn_tunnels", "pcc_apns_check_cert", "pcc_apns_expired", "pcc_apns_expires_soon", @@ -107644,12 +107723,10 @@ "aaa_not_enabled", "afc_height_empty", "afc_status_bad", - "all_auto_vpn_peers_down", "ap_became_repeater", "ap_noauth", "arp_failure", "asymmetry", - "auto_vpn_peer_down", "bad_connectivity", "bad_gateway", "bad_ip6conf", @@ -107659,7 +107736,6 @@ "cellular_failover", "cloud_archive_alert", "collisions_errors", - "config", "config_bad_fetch", "config_error", "config_stale", @@ -107673,13 +107749,11 @@ "device_access_issue", "device_config_failure", "device_no_space", - "device_reporting", "dfs_event_pattern", "disassociation", "dns_down", "dom_stats_alert", "door_tamper", - "dormant", "eapol_test_failed", "error_enable_password", "ethernet_negotiation_failure", @@ -107694,7 +107768,6 @@ "http_acl_ipv6_conflict", "insecure_sm_networks_disabled_enrollment_auth_alert", "insight_web_app", - "insight_web_app_alert", "invalid_config", "ip_conflict", "isp_issue_local_branch", @@ -107735,7 +107808,6 @@ "ntp_issue", "odd_upstream_gateway", "openroaming_firmware_incompatible", - "over_recommended_site_to_site_vpn_tunnels", "pcc_apns_check_cert", "pcc_apns_expired", "pcc_apns_expires_soon", @@ -108057,12 +108129,10 @@ "aaa_not_enabled", "afc_height_empty", "afc_status_bad", - "all_auto_vpn_peers_down", "ap_became_repeater", "ap_noauth", "arp_failure", "asymmetry", - "auto_vpn_peer_down", "bad_connectivity", "bad_gateway", "bad_ip6conf", @@ -108072,7 +108142,6 @@ "cellular_failover", "cloud_archive_alert", "collisions_errors", - "config", "config_bad_fetch", "config_error", "config_stale", @@ -108086,13 +108155,11 @@ "device_access_issue", "device_config_failure", "device_no_space", - "device_reporting", "dfs_event_pattern", "disassociation", "dns_down", "dom_stats_alert", "door_tamper", - "dormant", "eapol_test_failed", "error_enable_password", "ethernet_negotiation_failure", @@ -108107,7 +108174,6 @@ "http_acl_ipv6_conflict", "insecure_sm_networks_disabled_enrollment_auth_alert", "insight_web_app", - "insight_web_app_alert", "invalid_config", "ip_conflict", "isp_issue_local_branch", @@ -108148,7 +108214,6 @@ "ntp_issue", "odd_upstream_gateway", "openroaming_firmware_incompatible", - "over_recommended_site_to_site_vpn_tunnels", "pcc_apns_check_cert", "pcc_apns_expired", "pcc_apns_expires_soon", @@ -114113,6 +114178,10 @@ "type": "string", "description": "Certificate Version" }, + "signatureAlgorithmId": { + "type": "string", + "description": "Signature algorithm ID of the certificate" + }, "publicKeyAlgorithm": { "type": "string", "description": "Certificate's public key algorithm" @@ -114187,6 +114256,7 @@ "serial": "7C 08 29 E8 CC", "policy": "policy string here", "version": "1.2.3.4", + "signatureAlgorithmId": "SHA256withRSA", "publicKeyAlgorithm": "RSA", "keyUsage": { "isCritical": false, @@ -114383,6 +114453,10 @@ "type": "string", "description": "Certificate Version" }, + "signatureAlgorithmId": { + "type": "string", + "description": "Signature algorithm ID of the certificate" + }, "publicKeyAlgorithm": { "type": "string", "description": "Certificate's public key algorithm" @@ -114457,6 +114531,7 @@ "serial": "7C 08 29 E8 CC", "policy": "policy string here", "version": "1.2.3.4", + "signatureAlgorithmId": "SHA256withRSA", "publicKeyAlgorithm": "RSA", "keyUsage": { "isCritical": false, @@ -115047,6 +115122,10 @@ "type": "string", "description": "Certificate Version" }, + "signatureAlgorithmId": { + "type": "string", + "description": "Signature algorithm ID of the certificate" + }, "publicKeyAlgorithm": { "type": "string", "description": "Certificate's public key algorithm" @@ -115121,6 +115200,7 @@ "serial": "7C 08 29 E8 CC", "policy": "policy string here", "version": "1.2.3.4", + "signatureAlgorithmId": "SHA256withRSA", "publicKeyAlgorithm": "RSA", "keyUsage": { "isCritical": false, @@ -118610,6 +118690,23 @@ "newValue": { "type": "string", "description": "The value of the configuration, after the change was applied." + }, + "client": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID for the client which made the change, if applicable." + }, + "type": { + "type": "string", + "enum": [ + "oauth" + ], + "description": "Type of client which made the change, if applicable. Available options are: oauth" + } + }, + "description": "Client information" } } } @@ -118635,7 +118732,11 @@ "page": "via API", "label": "PUT /api/v1/organizations/2930418", "oldValue": "{\"id\":\"2930418\",\"name\":\"My organization\",\"url\":\"https://dashboard.meraki.com/o/VjjsAd/manage/organization/overview\"}", - "newValue": "{\"id\":\"2930418\",\"name\":\"My organization changed\",\"url\":\"https://dashboard.meraki.com/o/VjjsAd/manage/organization/overview\"}" + "newValue": "{\"id\":\"2930418\",\"name\":\"My organization changed\",\"url\":\"https://dashboard.meraki.com/o/VjjsAd/manage/organization/overview\"}", + "client": { + "id": "0hoXjtjX6C-Nk4Nr6kEbCJJFRmIgycaG1HBE572hlIc", + "type": "oauth" + } } ] } @@ -120406,10 +120507,10 @@ "name": "file_name", "startTime": "2018-02-11T00:00:00.090210Z", "ports": "1, 2", - "status": "downloading", + "status": "capturing", "errorMessage": "Some error message", - "outputType": "cloudshark", - "captureSource": "scheduled", + "outputType": "pcap", + "captureSource": "proactive", "captureReason": "capture reason", "fileSize": 1066, "duration": 60, @@ -120669,10 +120770,10 @@ "name": "file_name", "startTime": "2018-02-11T00:00:00.090210Z", "ports": "1, 2", - "status": "downloading", + "status": "capturing", "errorMessage": "Some error message", - "outputType": "cloudshark", - "captureSource": "scheduled", + "outputType": "pcap", + "captureSource": "proactive", "captureReason": "capture reason", "fileSize": 1066, "duration": 60, @@ -121001,10 +121102,10 @@ "name": "file_name", "startTime": "2018-02-11T00:00:00.090210Z", "ports": "1, 2", - "status": "downloading", + "status": "capturing", "errorMessage": "Some error message", - "outputType": "cloudshark", - "captureSource": "scheduled", + "outputType": "pcap", + "captureSource": "proactive", "captureReason": "capture reason", "fileSize": 1066, "duration": 60, @@ -130189,7 +130290,7 @@ "schema": { "type": "object", "properties": { - "orderClaimId": { + "claimId": { "type": "string", "description": "The unique order claim id" }, @@ -130216,7 +130317,7 @@ } }, "example": { - "orderClaimId": "12345", + "claimId": "12345", "subscriptions": [ { "subscriptionId": "SUB1234132", @@ -130238,10 +130339,18 @@ "type": "string", "description": "The order claim id" }, + "claimId": { + "type": "string", + "description": "The order claim id" + }, "orderNumber": { "type": "string", "description": "Order Number" }, + "number": { + "type": "string", + "description": "Order Number" + }, "serials": { "type": "array", "items": { @@ -130319,7 +130428,9 @@ "examples": { "application/json": { "orderClaimId": "ABCDEFG12345", + "claimId": "ABCDEFG12345", "orderNumber": "97001888", + "number": "97001888", "serials": [ "1234-ABCD-4567" ], @@ -130369,7 +130480,7 @@ }, { "type": "string", - "name": "orderClaimId", + "name": "claimId", "in": "query", "description": "The unique order claim id" } @@ -130384,10 +130495,18 @@ "type": "string", "description": "The secure unique order claim number" }, + "claimId": { + "type": "string", + "description": "The secure unique order claim number" + }, "orderNumber": { "type": "string", "description": "Order Number" }, + "number": { + "type": "string", + "description": "Order Number" + }, "shipments": { "type": "array", "items": { @@ -130512,7 +130631,9 @@ "examples": { "application/json": { "orderClaimId": "ABCD1EFGH4IJ", + "claimId": "ABCD1EFGH4IJ", "orderNumber": "97001888", + "number": "97001888", "shipments": [ { "shippedAt": "2024-06-30T00:00:00Z", @@ -156444,8 +156565,7 @@ "configure", "opportunisticPcap", "byNetwork" - ], - "x-release-stage": "beta" + ] } }, "/organizations/{organizationId}/wireless/opportunisticPcap/license/byNetwork": { @@ -162155,6 +162275,10 @@ "type": "string", "description": "Wireless LAN controller chassis name" }, + "redundantSerial": { + "type": "string", + "description": "Wireless LAN controller redundant device serial" + }, "management": { "type": "object", "properties": { @@ -162257,6 +162381,7 @@ "role": "Active", "id": "123456", "chassisName": "Chassis 1", + "redundantSerial": "Q234-ABCD-5679", "management": { "addresses": [ { diff --git a/openapi/spec3.json b/openapi/spec3.json index ca45363..462c35b 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: 08 January, 2025\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: 15 January, 2025\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.54.0-beta.1" + "version": "1.54.0-beta.2" }, "servers": [ { @@ -15776,7 +15776,7 @@ "properties": { "interfaceId": { "type": "string", - "description": "The id" + "description": "The ID" }, "name": { "type": "string", @@ -15796,14 +15796,22 @@ }, "vlanId": { "type": "integer", - "description": "VLAN id" + "description": "VLAN ID" + }, + "uplinkV4": { + "type": "boolean", + "description": "When true, this interface is the switch's static IPv4 uplink" + }, + "uplinkV6": { + "type": "boolean", + "description": "When true, this interface is the switch's static IPv6 uplink" }, "ospfSettings": { "type": "object", "properties": { "area": { "type": "string", - "description": "Area id" + "description": "Area ID" }, "cost": { "type": "integer", @@ -15821,7 +15829,7 @@ "properties": { "area": { "type": "string", - "description": "Area id" + "description": "Area ID" }, "cost": { "type": "integer", @@ -15871,6 +15879,8 @@ "interfaceIp": "192.168.1.2", "multicastRouting": "disabled", "vlanId": 100, + "uplinkV4": false, + "uplinkV6": false, "ospfSettings": { "area": "0", "cost": 1, @@ -16026,7 +16036,7 @@ "properties": { "interfaceId": { "type": "string", - "description": "The id" + "description": "The ID" }, "name": { "type": "string", @@ -16046,14 +16056,22 @@ }, "vlanId": { "type": "integer", - "description": "VLAN id" + "description": "VLAN ID" + }, + "uplinkV4": { + "type": "boolean", + "description": "When true, this interface is the switch's static IPv4 uplink" + }, + "uplinkV6": { + "type": "boolean", + "description": "When true, this interface is the switch's static IPv6 uplink" }, "ospfSettings": { "type": "object", "properties": { "area": { "type": "string", - "description": "Area id" + "description": "Area ID" }, "cost": { "type": "integer", @@ -16071,7 +16089,7 @@ "properties": { "area": { "type": "string", - "description": "Area id" + "description": "Area ID" }, "cost": { "type": "integer", @@ -16119,6 +16137,8 @@ "interfaceIp": "192.168.1.2", "multicastRouting": "disabled", "vlanId": 100, + "uplinkV4": false, + "uplinkV6": false, "ospfSettings": { "area": "0", "cost": 1, @@ -16184,7 +16204,7 @@ "properties": { "interfaceId": { "type": "string", - "description": "The id" + "description": "The ID" }, "name": { "type": "string", @@ -16204,14 +16224,22 @@ }, "vlanId": { "type": "integer", - "description": "VLAN id" + "description": "VLAN ID" + }, + "uplinkV4": { + "type": "boolean", + "description": "When true, this interface is the switch's static IPv4 uplink" + }, + "uplinkV6": { + "type": "boolean", + "description": "When true, this interface is the switch's static IPv6 uplink" }, "ospfSettings": { "type": "object", "properties": { "area": { "type": "string", - "description": "Area id" + "description": "Area ID" }, "cost": { "type": "integer", @@ -16229,7 +16257,7 @@ "properties": { "area": { "type": "string", - "description": "Area id" + "description": "Area ID" }, "cost": { "type": "integer", @@ -16277,6 +16305,8 @@ "interfaceIp": "192.168.1.2", "multicastRouting": "disabled", "vlanId": 100, + "uplinkV4": false, + "uplinkV6": false, "ospfSettings": { "area": "0", "cost": 1, @@ -16440,7 +16470,7 @@ "properties": { "interfaceId": { "type": "string", - "description": "The id" + "description": "The ID" }, "name": { "type": "string", @@ -16460,14 +16490,22 @@ }, "vlanId": { "type": "integer", - "description": "VLAN id" + "description": "VLAN ID" + }, + "uplinkV4": { + "type": "boolean", + "description": "When true, this interface is the switch's static IPv4 uplink" + }, + "uplinkV6": { + "type": "boolean", + "description": "When true, this interface is the switch's static IPv6 uplink" }, "ospfSettings": { "type": "object", "properties": { "area": { "type": "string", - "description": "Area id" + "description": "Area ID" }, "cost": { "type": "integer", @@ -16485,7 +16523,7 @@ "properties": { "area": { "type": "string", - "description": "Area id" + "description": "Area ID" }, "cost": { "type": "integer", @@ -16533,6 +16571,8 @@ "interfaceIp": "192.168.1.2", "multicastRouting": "disabled", "vlanId": 100, + "uplinkV4": false, + "uplinkV6": false, "ospfSettings": { "area": "0", "cost": 1, @@ -76122,7 +76162,7 @@ "properties": { "interfaceId": { "type": "string", - "description": "The id" + "description": "The ID" }, "name": { "type": "string", @@ -76142,14 +76182,22 @@ }, "vlanId": { "type": "integer", - "description": "VLAN id" + "description": "VLAN ID" + }, + "uplinkV4": { + "type": "boolean", + "description": "When true, this interface is the switch's static IPv4 uplink" + }, + "uplinkV6": { + "type": "boolean", + "description": "When true, this interface is the switch's static IPv6 uplink" }, "ospfSettings": { "type": "object", "properties": { "area": { "type": "string", - "description": "Area id" + "description": "Area ID" }, "cost": { "type": "integer", @@ -76167,7 +76215,7 @@ "properties": { "area": { "type": "string", - "description": "Area id" + "description": "Area ID" }, "cost": { "type": "integer", @@ -76217,6 +76265,8 @@ "interfaceIp": "192.168.1.2", "multicastRouting": "disabled", "vlanId": 100, + "uplinkV4": false, + "uplinkV6": false, "ospfSettings": { "area": "0", "cost": 1, @@ -76410,7 +76460,7 @@ "properties": { "interfaceId": { "type": "string", - "description": "The id" + "description": "The ID" }, "name": { "type": "string", @@ -76430,14 +76480,22 @@ }, "vlanId": { "type": "integer", - "description": "VLAN id" + "description": "VLAN ID" + }, + "uplinkV4": { + "type": "boolean", + "description": "When true, this interface is the switch's static IPv4 uplink" + }, + "uplinkV6": { + "type": "boolean", + "description": "When true, this interface is the switch's static IPv6 uplink" }, "ospfSettings": { "type": "object", "properties": { "area": { "type": "string", - "description": "Area id" + "description": "Area ID" }, "cost": { "type": "integer", @@ -76455,7 +76513,7 @@ "properties": { "area": { "type": "string", - "description": "Area id" + "description": "Area ID" }, "cost": { "type": "integer", @@ -76503,6 +76561,8 @@ "interfaceIp": "192.168.1.2", "multicastRouting": "disabled", "vlanId": 100, + "uplinkV4": false, + "uplinkV6": false, "ospfSettings": { "area": "0", "cost": 1, @@ -76578,7 +76638,7 @@ "properties": { "interfaceId": { "type": "string", - "description": "The id" + "description": "The ID" }, "name": { "type": "string", @@ -76598,14 +76658,22 @@ }, "vlanId": { "type": "integer", - "description": "VLAN id" + "description": "VLAN ID" + }, + "uplinkV4": { + "type": "boolean", + "description": "When true, this interface is the switch's static IPv4 uplink" + }, + "uplinkV6": { + "type": "boolean", + "description": "When true, this interface is the switch's static IPv6 uplink" }, "ospfSettings": { "type": "object", "properties": { "area": { "type": "string", - "description": "Area id" + "description": "Area ID" }, "cost": { "type": "integer", @@ -76623,7 +76691,7 @@ "properties": { "area": { "type": "string", - "description": "Area id" + "description": "Area ID" }, "cost": { "type": "integer", @@ -76671,6 +76739,8 @@ "interfaceIp": "192.168.1.2", "multicastRouting": "disabled", "vlanId": 100, + "uplinkV4": false, + "uplinkV6": false, "ospfSettings": { "area": "0", "cost": 1, @@ -76868,7 +76938,7 @@ "properties": { "interfaceId": { "type": "string", - "description": "The id" + "description": "The ID" }, "name": { "type": "string", @@ -76888,14 +76958,22 @@ }, "vlanId": { "type": "integer", - "description": "VLAN id" + "description": "VLAN ID" + }, + "uplinkV4": { + "type": "boolean", + "description": "When true, this interface is the switch's static IPv4 uplink" + }, + "uplinkV6": { + "type": "boolean", + "description": "When true, this interface is the switch's static IPv6 uplink" }, "ospfSettings": { "type": "object", "properties": { "area": { "type": "string", - "description": "Area id" + "description": "Area ID" }, "cost": { "type": "integer", @@ -76913,7 +76991,7 @@ "properties": { "area": { "type": "string", - "description": "Area id" + "description": "Area ID" }, "cost": { "type": "integer", @@ -76957,6 +77035,8 @@ "interfaceIp": "192.168.1.2", "multicastRouting": "disabled", "vlanId": 100, + "uplinkV4": false, + "uplinkV6": false, "ospfSettings": { "area": "0", "cost": 1, @@ -87478,8 +87558,7 @@ "wireless", "configure", "opportunisticPcap" - ], - "x-release-stage": "beta" + ] } }, "/networks/{networkId}/wireless/radio/autoRf": { @@ -107384,6 +107463,23 @@ "operationId": { "type": "string", "description": "Operation ID for the endpoint." + }, + "client": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID for the client which made the request, if applicable." + }, + "type": { + "type": "string", + "enum": [ + "oauth" + ], + "description": "Type of client which made the request, if applicable. Available options are: oauth" + } + }, + "description": "Client information" } } } @@ -107400,7 +107496,11 @@ "responseCode": 200, "sourceIp": "123.123.123.1", "version": 1, - "operationId": "getOrganizationApiRequests" + "operationId": "getOrganizationApiRequests", + "client": { + "id": "0hoXjtjX6C-Nk4Nr6kEbCJJFRmIgycaG1HBE572hlIc", + "type": "oauth" + } } ] } @@ -112752,12 +112852,10 @@ "aaa_not_enabled", "afc_height_empty", "afc_status_bad", - "all_auto_vpn_peers_down", "ap_became_repeater", "ap_noauth", "arp_failure", "asymmetry", - "auto_vpn_peer_down", "bad_connectivity", "bad_gateway", "bad_ip6conf", @@ -112767,7 +112865,6 @@ "cellular_failover", "cloud_archive_alert", "collisions_errors", - "config", "config_bad_fetch", "config_error", "config_stale", @@ -112781,13 +112878,11 @@ "device_access_issue", "device_config_failure", "device_no_space", - "device_reporting", "dfs_event_pattern", "disassociation", "dns_down", "dom_stats_alert", "door_tamper", - "dormant", "eapol_test_failed", "error_enable_password", "ethernet_negotiation_failure", @@ -112802,7 +112897,6 @@ "http_acl_ipv6_conflict", "insecure_sm_networks_disabled_enrollment_auth_alert", "insight_web_app", - "insight_web_app_alert", "invalid_config", "ip_conflict", "isp_issue_local_branch", @@ -112843,7 +112937,6 @@ "ntp_issue", "odd_upstream_gateway", "openroaming_firmware_incompatible", - "over_recommended_site_to_site_vpn_tunnels", "pcc_apns_check_cert", "pcc_apns_expired", "pcc_apns_expires_soon", @@ -113360,12 +113453,10 @@ "aaa_not_enabled", "afc_height_empty", "afc_status_bad", - "all_auto_vpn_peers_down", "ap_became_repeater", "ap_noauth", "arp_failure", "asymmetry", - "auto_vpn_peer_down", "bad_connectivity", "bad_gateway", "bad_ip6conf", @@ -113375,7 +113466,6 @@ "cellular_failover", "cloud_archive_alert", "collisions_errors", - "config", "config_bad_fetch", "config_error", "config_stale", @@ -113389,13 +113479,11 @@ "device_access_issue", "device_config_failure", "device_no_space", - "device_reporting", "dfs_event_pattern", "disassociation", "dns_down", "dom_stats_alert", "door_tamper", - "dormant", "eapol_test_failed", "error_enable_password", "ethernet_negotiation_failure", @@ -113410,7 +113498,6 @@ "http_acl_ipv6_conflict", "insecure_sm_networks_disabled_enrollment_auth_alert", "insight_web_app", - "insight_web_app_alert", "invalid_config", "ip_conflict", "isp_issue_local_branch", @@ -113451,7 +113538,6 @@ "ntp_issue", "odd_upstream_gateway", "openroaming_firmware_incompatible", - "over_recommended_site_to_site_vpn_tunnels", "pcc_apns_check_cert", "pcc_apns_expired", "pcc_apns_expires_soon", @@ -113806,12 +113892,10 @@ "aaa_not_enabled", "afc_height_empty", "afc_status_bad", - "all_auto_vpn_peers_down", "ap_became_repeater", "ap_noauth", "arp_failure", "asymmetry", - "auto_vpn_peer_down", "bad_connectivity", "bad_gateway", "bad_ip6conf", @@ -113821,7 +113905,6 @@ "cellular_failover", "cloud_archive_alert", "collisions_errors", - "config", "config_bad_fetch", "config_error", "config_stale", @@ -113835,13 +113918,11 @@ "device_access_issue", "device_config_failure", "device_no_space", - "device_reporting", "dfs_event_pattern", "disassociation", "dns_down", "dom_stats_alert", "door_tamper", - "dormant", "eapol_test_failed", "error_enable_password", "ethernet_negotiation_failure", @@ -113856,7 +113937,6 @@ "http_acl_ipv6_conflict", "insecure_sm_networks_disabled_enrollment_auth_alert", "insight_web_app", - "insight_web_app_alert", "invalid_config", "ip_conflict", "isp_issue_local_branch", @@ -113897,7 +113977,6 @@ "ntp_issue", "odd_upstream_gateway", "openroaming_firmware_incompatible", - "over_recommended_site_to_site_vpn_tunnels", "pcc_apns_check_cert", "pcc_apns_expired", "pcc_apns_expires_soon", @@ -114301,12 +114380,10 @@ "aaa_not_enabled", "afc_height_empty", "afc_status_bad", - "all_auto_vpn_peers_down", "ap_became_repeater", "ap_noauth", "arp_failure", "asymmetry", - "auto_vpn_peer_down", "bad_connectivity", "bad_gateway", "bad_ip6conf", @@ -114316,7 +114393,6 @@ "cellular_failover", "cloud_archive_alert", "collisions_errors", - "config", "config_bad_fetch", "config_error", "config_stale", @@ -114330,13 +114406,11 @@ "device_access_issue", "device_config_failure", "device_no_space", - "device_reporting", "dfs_event_pattern", "disassociation", "dns_down", "dom_stats_alert", "door_tamper", - "dormant", "eapol_test_failed", "error_enable_password", "ethernet_negotiation_failure", @@ -114351,7 +114425,6 @@ "http_acl_ipv6_conflict", "insecure_sm_networks_disabled_enrollment_auth_alert", "insight_web_app", - "insight_web_app_alert", "invalid_config", "ip_conflict", "isp_issue_local_branch", @@ -114392,7 +114465,6 @@ "ntp_issue", "odd_upstream_gateway", "openroaming_firmware_incompatible", - "over_recommended_site_to_site_vpn_tunnels", "pcc_apns_check_cert", "pcc_apns_expired", "pcc_apns_expires_soon", @@ -114750,12 +114822,10 @@ "aaa_not_enabled", "afc_height_empty", "afc_status_bad", - "all_auto_vpn_peers_down", "ap_became_repeater", "ap_noauth", "arp_failure", "asymmetry", - "auto_vpn_peer_down", "bad_connectivity", "bad_gateway", "bad_ip6conf", @@ -114765,7 +114835,6 @@ "cellular_failover", "cloud_archive_alert", "collisions_errors", - "config", "config_bad_fetch", "config_error", "config_stale", @@ -114779,13 +114848,11 @@ "device_access_issue", "device_config_failure", "device_no_space", - "device_reporting", "dfs_event_pattern", "disassociation", "dns_down", "dom_stats_alert", "door_tamper", - "dormant", "eapol_test_failed", "error_enable_password", "ethernet_negotiation_failure", @@ -114800,7 +114867,6 @@ "http_acl_ipv6_conflict", "insecure_sm_networks_disabled_enrollment_auth_alert", "insight_web_app", - "insight_web_app_alert", "invalid_config", "ip_conflict", "isp_issue_local_branch", @@ -114841,7 +114907,6 @@ "ntp_issue", "odd_upstream_gateway", "openroaming_firmware_incompatible", - "over_recommended_site_to_site_vpn_tunnels", "pcc_apns_check_cert", "pcc_apns_expired", "pcc_apns_expires_soon", @@ -121124,6 +121189,10 @@ "type": "string", "description": "Certificate Version" }, + "signatureAlgorithmId": { + "type": "string", + "description": "Signature algorithm ID of the certificate" + }, "publicKeyAlgorithm": { "type": "string", "description": "Certificate's public key algorithm" @@ -121197,6 +121266,7 @@ "serial": "7C 08 29 E8 CC", "policy": "policy string here", "version": "1.2.3.4", + "signatureAlgorithmId": "SHA256withRSA", "publicKeyAlgorithm": "RSA", "keyUsage": { "isCritical": false, @@ -121400,6 +121470,10 @@ "type": "string", "description": "Certificate Version" }, + "signatureAlgorithmId": { + "type": "string", + "description": "Signature algorithm ID of the certificate" + }, "publicKeyAlgorithm": { "type": "string", "description": "Certificate's public key algorithm" @@ -121473,6 +121547,7 @@ "serial": "7C 08 29 E8 CC", "policy": "policy string here", "version": "1.2.3.4", + "signatureAlgorithmId": "SHA256withRSA", "publicKeyAlgorithm": "RSA", "keyUsage": { "isCritical": false, @@ -122112,6 +122187,10 @@ "type": "string", "description": "Certificate Version" }, + "signatureAlgorithmId": { + "type": "string", + "description": "Signature algorithm ID of the certificate" + }, "publicKeyAlgorithm": { "type": "string", "description": "Certificate's public key algorithm" @@ -122185,6 +122264,7 @@ "serial": "7C 08 29 E8 CC", "policy": "policy string here", "version": "1.2.3.4", + "signatureAlgorithmId": "SHA256withRSA", "publicKeyAlgorithm": "RSA", "keyUsage": { "isCritical": false, @@ -125856,6 +125936,23 @@ "newValue": { "type": "string", "description": "The value of the configuration, after the change was applied." + }, + "client": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID for the client which made the change, if applicable." + }, + "type": { + "type": "string", + "enum": [ + "oauth" + ], + "description": "Type of client which made the change, if applicable. Available options are: oauth" + } + }, + "description": "Client information" } } } @@ -125874,7 +125971,11 @@ "page": "via API", "label": "PUT /api/v1/organizations/2930418", "oldValue": "{\"id\":\"2930418\",\"name\":\"My organization\",\"url\":\"https://dashboard.meraki.com/o/VjjsAd/manage/organization/overview\"}", - "newValue": "{\"id\":\"2930418\",\"name\":\"My organization changed\",\"url\":\"https://dashboard.meraki.com/o/VjjsAd/manage/organization/overview\"}" + "newValue": "{\"id\":\"2930418\",\"name\":\"My organization changed\",\"url\":\"https://dashboard.meraki.com/o/VjjsAd/manage/organization/overview\"}", + "client": { + "id": "0hoXjtjX6C-Nk4Nr6kEbCJJFRmIgycaG1HBE572hlIc", + "type": "oauth" + } } ] } @@ -127843,10 +127944,10 @@ "name": "file_name", "startTime": "2018-02-11T00:00:00.090210Z", "ports": "1, 2", - "status": "failed", + "status": "capturing", "errorMessage": "Some error message", "outputType": "upload_to_cloud", - "captureSource": "manual", + "captureSource": "proactive", "captureReason": "capture reason", "fileSize": 1066, "duration": 60, @@ -128120,10 +128221,10 @@ "name": "file_name", "startTime": "2018-02-11T00:00:00.090210Z", "ports": "1, 2", - "status": "failed", + "status": "capturing", "errorMessage": "Some error message", "outputType": "upload_to_cloud", - "captureSource": "manual", + "captureSource": "proactive", "captureReason": "capture reason", "fileSize": 1066, "duration": 60, @@ -128470,10 +128571,10 @@ "name": "file_name", "startTime": "2018-02-11T00:00:00.090210Z", "ports": "1, 2", - "status": "failed", + "status": "capturing", "errorMessage": "Some error message", "outputType": "upload_to_cloud", - "captureSource": "manual", + "captureSource": "proactive", "captureReason": "capture reason", "fileSize": 1066, "duration": 60, @@ -138260,7 +138361,7 @@ "schema": { "type": "object", "properties": { - "orderClaimId": { + "claimId": { "type": "string", "description": "The unique order claim id" }, @@ -138287,7 +138388,7 @@ } }, "example": { - "orderClaimId": "12345", + "claimId": "12345", "subscriptions": [ { "subscriptionId": "SUB1234132", @@ -138313,10 +138414,18 @@ "type": "string", "description": "The order claim id" }, + "claimId": { + "type": "string", + "description": "The order claim id" + }, "orderNumber": { "type": "string", "description": "Order Number" }, + "number": { + "type": "string", + "description": "Order Number" + }, "serials": { "type": "array", "items": { @@ -138393,7 +138502,9 @@ }, "example": { "orderClaimId": "ABCDEFG12345", + "claimId": "ABCDEFG12345", "orderNumber": "97001888", + "number": "97001888", "serials": [ "1234-ABCD-4567" ], @@ -138445,7 +138556,7 @@ "required": true }, { - "name": "orderClaimId", + "name": "claimId", "in": "query", "description": "The unique order claim id", "schema": { @@ -138465,10 +138576,18 @@ "type": "string", "description": "The secure unique order claim number" }, + "claimId": { + "type": "string", + "description": "The secure unique order claim number" + }, "orderNumber": { "type": "string", "description": "Order Number" }, + "number": { + "type": "string", + "description": "Order Number" + }, "shipments": { "type": "array", "items": { @@ -138592,7 +138711,9 @@ }, "example": { "orderClaimId": "ABCD1EFGH4IJ", + "claimId": "ABCD1EFGH4IJ", "orderNumber": "97001888", + "number": "97001888", "shipments": [ { "shippedAt": "2024-06-30T00:00:00Z", @@ -166403,8 +166524,7 @@ "configure", "opportunisticPcap", "byNetwork" - ], - "x-release-stage": "beta" + ] } }, "/organizations/{organizationId}/wireless/opportunisticPcap/license/byNetwork": { @@ -172625,6 +172745,10 @@ "type": "string", "description": "Wireless LAN controller chassis name" }, + "redundantSerial": { + "type": "string", + "description": "Wireless LAN controller redundant device serial" + }, "management": { "type": "object", "properties": { @@ -172720,6 +172844,7 @@ "role": "Active", "id": "123456", "chassisName": "Chassis 1", + "redundantSerial": "Q234-ABCD-5679", "management": { "addresses": [ {