{"components":{"examples":{"WebhookCreateApiKeyRequest__c1c7772865ac":{"summary":"Create webhook with API key authentication","value":{"input":{"apiKey":"testAPIKEY","authMechanism":"API_KEY","endpoint":"https://example.com/webhook","name":"webhook-api-key"}}},"WebhookCreateOidcRequest__c1c7772865ac":{"summary":"Create webhook with OIDC authentication","value":{"input":{"authMechanism":"OIDC","endpoint":"https://example.com/webhook","name":"webhook-oidc","oidcDetails":{"clientId":"sample-client-id","clientSecret":"sample-client-secret","wellKnownUrl":"https://example.com/.well-known/openid-configuration"}}}},"WebhookPatchApiKeyRequest__fa99fffcc525":{"summary":"Patch webhook with API key authentication","value":{"input":{"apiKey":"testAPIKEY","authMechanism":"API_KEY"}}},"WebhookPatchOidcRequest__fa99fffcc525":{"summary":"Patch webhook with OIDC authentication","value":{"input":{"authMechanism":"OIDC","oidcDetails":{"clientId":"sample-client-id","clientSecret":"sample-client-secret","wellKnownUrl":"https://example.com/.well-known/openid-configuration"}}}},"WebhookUpdateApiKeyRequest__d01d12c7fb0d":{"summary":"Update webhook with API key authentication","value":{"input":{"apiKey":"testAPIKEY","authMechanism":"API_KEY","endpoint":"https://example.com/webhook","name":"webhook-api-key"}}},"WebhookUpdateOidcRequest__d01d12c7fb0d":{"summary":"Update webhook with OIDC authentication","value":{"input":{"authMechanism":"OIDC","endpoint":"https://example.com/webhook","name":"webhook-oidc","oidcDetails":{"clientId":"sample-client-id","clientSecret":"sample-client-secret","wellKnownUrl":"https://example.com/.well-known/openid-configuration"}}}}},"headers":{"Location__8bd44b0ed12d":{"description":"The URI to query the modified device location.","schema":{"format":"const","maxLength":512,"type":"string"}},"Locationopen__16fa337a67ef":{"description":"The URI to query the ftm scan.","schema":{"format":"const","maxLength":512,"type":"string"}},"RetryAfter__0c2a95c4aa99":{"description":"Number of seconds to wait before retrying the request.","schema":{"example":60,"format":"int32","minimum":0,"type":"integer"}},"X-Rate-Limit-Limit__000172564380":{"description":"Request limit per hour.","schema":{"format":"int64","maximum":9223372036854776000,"minimum":0,"type":"integer"}},"X-Rate-Limit-Remaining__000172564380":{"description":"The number of requests left for the time window.","schema":{"format":"int64","maximum":9223372036854776000,"minimum":0,"type":"integer"}},"X-Rate-Limit-Reset__000172564380":{"description":"The UTC date/time at which the current rate limit window resets.","schema":{"format":"date-time","maxLength":20,"type":"string"}},"X-RateLimit-Limit__09b903e67f2b":{"description":"The request limit per hour.","schema":{"format":"int64","maximum":9223372036854776000,"minimum":0,"type":"integer"}},"X-RateLimit-Remainingfco__09b903e67f2b":{"description":"The number of requests left for the time window.","schema":{"$ref":"#/components/schemas/X-RateLimit-Remainingfco__09b903e67f2b"}},"X-RateLimit-Reset__004689200476":{"description":"The date-time (RFC 3339 timestamp in UTC+0) at which the current rate limit window resets.","schema":{"format":"date-time","maxLength":20,"type":"string"}},"X-RateLimit-Resetfco__09b903e67f2b":{"description":"The UTC date/time at which the current rate limit window resets.","schema":{"$ref":"#/components/schemas/X-RateLimit-Resetfco__09b903e67f2b"}},"XRateLimitLimitHeader__0288a339fc72":{"schema":{"description":"The request limit per hour.","format":"int64","maximum":9223372036854776000,"minimum":0,"type":"integer"}},"XRateLimitLimitHeaderapp__7c5b5fe9ca66":{"description":"Request limit per hour.\n","schema":{"format":"int64","maximum":9223372036854776000,"minimum":0,"type":"integer"}},"XRateLimitRemainingHeader__0288a339fc72":{"schema":{"description":"The number of requests left for the time window.","format":"int64","maximum":9223372036854776000,"minimum":0,"type":"integer"}},"XRateLimitRemainingHeaderapp__7c5b5fe9ca66":{"description":"The number of requests left for the time window.\n","schema":{"format":"int64","maximum":9223372036854776000,"minimum":0,"type":"integer"}},"XRateLimitReset__02a6567f3633":{"description":"The date-time (RFC 3339 timestamp in UTC) at which the current rate limit window resets.","schema":{"format":"date-time","maxLength":20,"type":"string"}}},"parameters":{"AsyncTaskId__03efdde95a47":{"description":"ID of the asynchronous operation task","in":"path","name":"task-id","required":true,"schema":{"format":"uuid","type":"string"}},"ClusterId__a3f300af1174":{"description":"Cluster ID of a swarm (cluster).","in":"path","name":"cluster-id","required":true,"schema":{"$ref":"#/components/schemas/ClusterId__54309c5cca60"}},"ClusterName__3a50015484e1":{"description":"The name of the cluster formed by the gateway.","in":"path","name":"cluster-name","required":true,"schema":{"$ref":"#/components/schemas/ClusterName__3a50015484e1"}},"DeviceSerial__02a6567f3633":{"description":"Serial number of the target device","in":"path","name":"serial-number","required":true,"schema":{"type":"string"}},"EndAt__2ca376caec3f":{"description":"Aggregation is computed up to this timestamp, which must be in RFC 3339 (ISO 8601) format in UTC+0 timezone. The timestamp must be earlier than the current time and later than start-at.\n","in":"query","name":"end-at","required":false,"schema":{"$ref":"#/components/schemas/DateTime__1ff3457b62c0"}},"FilterDeviceInventory__cd77b09562fb":{"description":"OData Version 4.0 filter string (limited functionality). Supports only 'and' conjunction; ('or' and 'not' are NOT supported). Supported fields and operators are in the below given table.\n| Field | Operators |\n| --------- | -------- |\n| `siteId` | `eq` and `in` |\n| `siteName` | `eq` and `in` |\n| `serialNumber` | `eq` and `in` |\n| `deviceName` | `eq` and `in` |\n| `deviceType` | `eq` and `in` |\n| `model` | `eq` and `in` |\n| `firmwareVersion` | `eq` and `in` |\n| `deviceFunction` | `eq` and `in` |\n| `isProvisioned` | `eq` and `in` |\n| `deviceGroupName` | `eq` and `in` |\n\n**The operators are implemented as follows:**\n\n* `eq`: Only values exactly matching the given value are returned.\n\n* `in`: Only values present in the given list are returned.","example":"siteId eq '12345' and deployment in ('Standalone', 'Virtual Controller')","in":"query","name":"filter","required":false,"schema":{"format":"const","maxLength":256,"type":"string"}},"FilterDevices__6b9c5f08b869":{"description":"OData Version 4.0 filter string (limited functionality). Supports only 'and' conjunction; ('or' and 'not' are NOT supported). Supported fields and operators are in the below given table.\n| Field | Operators |\n| --------- | -------- |\n| `siteId` | `eq` and `in` |\n| `siteName` | `eq` and `in` |\n| `serialNumber` | `eq` and `in` |\n| `deviceName` | `eq` and `in` |\n| `deviceType` | `eq` and `in` |\n| `status` | `eq` and `in` |\n| `model` | `eq` and `in` |\n| `firmwareVersion` | `eq` and `in` |\n| `deployment` | `eq` and `in` |\n| `clusterName` | `eq` and `in` |\n\n**The operators are implemented as follows:**\n\n* `eq`: Only values exactly matching the given value are returned.\n\n* `in`: Only values present in the given list are returned.","example":"siteId eq '12345' and deployment in ('Standalone', 'Virtual Controller')","in":"query","name":"filter","required":false,"schema":{"format":"const","maxLength":256,"type":"string"}},"Filter__6ff1f6639f14":{"description":"OData Version 4.0 filter string (limited functionality). Supports only 'and' conjunction ('or' and 'not' are NOT supported). Supported fields and operators are in the below given table.\n| Field | Operators |\n| ----------------- | ---- |\n| `tenantName`    | `eq` |\n| `deviceOwnership` | `in` |\n\n**The operators are implemented as follows:**\n\n* `eq`: Only values exactly matching the given value are returned.\n\n* `in`: Only values present in the given list are returned.\n\n**Using Special Character for filtering the `tenantName`**\n\n* If the `tenantName` needs to be filtered with a special character like a single quote `'`, then it has to be passed as escaped character.\n\n* For example: `tenantName eq 'Tenant\\\\'s account 1'`\n","example":"tenantName eq 'tenant A' and deviceOwnership in ('MSP', 'TENANT')","in":"query","name":"filter","required":false,"schema":{"$ref":"#/components/schemas/Filter__6ff1f6639f14"}},"Filter__c0c1228d8f7d":{"description":"OData Version 4.0 filter string (limited functionality). Supports only 'and' conjunction ('or' and 'not' are NOT supported). Supported fields and operators are in the below given table.\n| Field | Operators |\n| --------- | -------- |\n| `siteId` | `eq` and `in` |\n| `siteName` | `eq` and `in` |\n| `serialNumber` | `eq` and `in` |\n| `deviceName` | `eq` and `in` |\n| `deviceType` | `eq` and `in` |\n| `upgradeStatus` | `eq` and `in` |\n| `firmwareClassification` | `eq` and `in` |\n| `firmwareVersion` | `eq` and `in` |\n\n**The operators are implemented as follows:**\n\n* `eq`: Only values exactly matching the given value are returned.\n\n* `in`: Only values present in the given list are returned.\n\n","example":"siteId eq '12345' and deviceType in ('ACCESS_POINT', 'GATEWAY')","in":"query","name":"filter","required":false,"schema":{"format":"const","maxLength":256,"type":"string"}},"Filterwebhooks__2efde5827a74":{"description":"Optional OData filter expression used to narrow the returned webhooks. Filtering is supported on the webhook fields (id, name, endpoint, authMechanism, type, generation, createdAt, updatedAt, messageFormat) using the comparison operators eq, ne, gt, ge, lt and le, the logical operators and, or and not, the lambda operators any and all, and the boolean string functions startswith, endswith and contains. A malformed or non-predicate filter expression returns HTTP 400.","in":"query","name":"filter","required":false,"schema":{"examples":["contains(name,'prod') and authMechanism eq 'API_KEY'"],"maxLength":1024,"type":"string"}},"Id__715550e8d02e":{"description":"Unique identifier for the webhook. This can be obtained from the List Webhooks API.","in":"path","name":"id","required":true,"schema":{"format":"uuid","maxLength":16,"type":"string"}},"Id__f8f342aecdae":{"description":"ID of the Threat for which Threat detail information is requested\n","in":"path","name":"id","required":true,"schema":{"$ref":"#/components/schemas/Id__7006262f8c4c"}},"Iddevice__0288a339fc72":{"description":"The unique identifier of the asynchronous operation. This is the UUID returned in the `Location` header of the `POST /network-monitoring/v1/device-notes` response.","in":"path","name":"id","required":true,"schema":{"example":"550e8400-e29b-41d4-a716-446655440000","format":"uuid","type":"string"}},"Limit__6b9c5f08b869":{"description":"Specifies the maximum number of devices returned in the response. Maximum value is 1000.","in":"query","name":"limit","required":false,"schema":{"$ref":"#/components/schemas/Limit__4689c9697989"}},"Limit__6ff1f6639f14":{"description":"Denotes the maximum number of tenants returned in the response. Maximum value is 100.","example":10,"in":"query","name":"limit","required":true,"schema":{"$ref":"#/components/schemas/Limit__6ff1f6639f14"}},"LinkTag__1053ccf03958":{"description":"Name of the uplink interface.","in":"path","name":"link-tag","required":true,"schema":{"example":"Airtel","type":"string"}},"Next__6b9c5f08b869":{"description":"Specifies the pagination cursor for the next page of resources.\nThe minimum value is 1.","in":"query","name":"next","required":false,"schema":{"$ref":"#/components/schemas/Next__21874c7bfa12"}},"Next__6ff1f6639f14":{"description":"Specifies the pagination cursor for the next page of resources. The minimum value is 1.","example":"2","in":"query","name":"next","required":true,"schema":{"$ref":"#/components/schemas/Next__6ff1f6639f14"}},"PortIndex__951d038e6e20":{"description":"The port index of an access point.","in":"path","name":"port-index","required":true,"schema":{"$ref":"#/components/schemas/PortIndex__951d038e6e20"}},"PortNumber__8102176f16c5":{"description":"Port number that represents the physical port of the gateway interface (GE 0/0/{port-number}).","in":"path","name":"port-number","required":true,"schema":{"example":"2","type":"string"}},"RadioNumber__2226a59a3aaf":{"description":"radio number within an access point.","in":"path","name":"radio-number","required":true,"schema":{"example":"0","type":"string"}},"SerialNumberQueryOptional__5247473e8f2a":{"description":"Serial number of an access point device.","in":"query","name":"serial-number","required":false,"schema":{"$ref":"#/components/schemas/SerialNumber__05867e444b37"}},"SerialNumber__2d2b84f6c2b4":{"description":"The serial number of the device.","in":"path","name":"serial-number","required":true,"schema":{"$ref":"#/components/schemas/SerialNumber__05867e444b37"}},"SerialNumberap__05867e444b37":{"description":"Serial number of an access point device.","in":"path","name":"serial-number","required":true,"schema":{"$ref":"#/components/schemas/SerialNumber__05867e444b37"}},"SerialNumbergw__1053ccf03958":{"description":"Serial number of the gateway device.","in":"path","name":"serial-number","required":true,"schema":{"$ref":"#/components/schemas/SerialNumbergw__1053ccf03958"}},"SiteAssigned__cd77b09562fb":{"description":"Specifies the site assignment status of the devices. Can be either \"ASSIGNED\" or \"UNASSIGNED\".","in":"query","name":"site-assigned","required":false,"schema":{"enum":["ASSIGNED","UNASSIGNED"],"type":"string"}},"SiteIdOptional__05867e444b37":{"description":"ID of the Site for which access point related information is requested\n","in":"query","name":"site-id","required":false,"schema":{"$ref":"#/components/schemas/SiteID__05867e444b37"}},"SiteId__f8f342aecdae":{"description":"ID of the Site for which Threat detail information is requested\n","in":"query","name":"site-id","required":true,"schema":{"$ref":"#/components/schemas/SiteID__05867e444b37"}},"SiteIdgw__1053ccf03958":{"description":"ID of the site for which gateway-related information is requested.\n","in":"query","name":"site-id","required":false,"schema":{"$ref":"#/components/schemas/SiteID__05867e444b37"}},"SiteNameOptional__05867e444b37":{"description":"Name of the Site for which access point related information is requested\n","in":"query","name":"site-name","required":false,"schema":{"$ref":"#/components/schemas/SiteName__05867e444b37"}},"SortDeviceInventory__cd77b09562fb":{"description":"A comma-separated list of sort expressions. Each sort expression is a property name optionally followed by a direction indicator asc (ascending) or desc (descending).\n\nThe first sort expression in the list defines the primary sort order, the second defines the secondary sort order, and so on. If a direction indicator is omitted the default direction is ascending.\nSupported fields are `siteId`, `siteName`, `serialNumber`, `deviceName`, `macAddress`, `deviceType`, `ipv4`, `model`, `deviceGroupName`, and `deviceFunction`.","in":"query","name":"sort","required":false,"schema":{"$ref":"#/components/schemas/Sort__6b9c5f08b869"}},"SortDevices__6b9c5f08b869":{"description":"A comma-separated list of sort expressions. Each sort expression is a property name optionally followed by a direction indicator asc (ascending) or desc (descending).\n\nThe first sort expression in the list defines the primary sort order, the second defines the secondary sort order, and so on. If a direction indicator is omitted the default direction is ascending.\nSupported fields are `siteId`, `siteName`, `serialNumber`, `deviceName`, `deployment`, and `model`.","in":"query","name":"sort","required":false,"schema":{"$ref":"#/components/schemas/Sort__6b9c5f08b869"}},"SortV1__c0c1228d8f7d":{"description":"Comma separated list of sort expressions. Each sort expression is a property name optionally followed by a direction indicator asc(ascending) or desc (descending).\nThe first sort expression in the list defines the primary sort order, the second defines the secondary sort order, and so on. If a direction indicator is omitted the default direction is ascending.\nSupported fields are `siteId`, `serialNumber`, `deviceName`, `deviceType`, `upgradeStatus`, `firmwareClassification`, and `firmwareVersion`.\n","in":"query","name":"sort","required":false,"schema":{"$ref":"#/components/schemas/SortV1__c0c1228d8f7d"}},"Sort__6ff1f6639f14":{"description":"Sorting can be supported on the following fields: `tenantName`, `totalSites`, `deviceHealthStatus`, `degradedSites`, `alerts`, `deviceOwnership` and `createdTime`.\n\nFor `alerts`, sorting will be done in order of `critical`, `major` and `minor` counts. For example if input is `alerts DESC`, then the tenant row with the highest `critical` alerts count will appear at the top.\n\nFor `deviceHealthStatus` sorting will be done in order of `poor`, `fair` and `good` counts. For example if input is `deviceHealthStatus DESC`, then the tenant row with the highest `poor` health count will appear at the top.\n","example":"alerts DESC","in":"query","name":"sort","required":false,"schema":{"$ref":"#/components/schemas/Sort__6ff1f6639f14"}},"StartAt__2ca376caec3f":{"description":"When not provided, the response returns the latest statistics. When provided, the response returns aggregated statistics over the specified time range. Aggregation starts from this timestamp, which must be in RFC 3339 (ISO 8601) format in UTC+0 timezone. The difference between end-at and start-at must be less than 30 days.\n","in":"query","name":"start-at","required":false,"schema":{"$ref":"#/components/schemas/DateTime__1ff3457b62c0"}},"Timestamp__f8f342aecdae":{"description":"The timestamp (RFC 3339 UTC+0) of the threat occurrence for which threat detail information is requested.","in":"query","name":"time-at","required":true,"schema":{"$ref":"#/components/schemas/Timestamp__7006262f8c4c"}},"TrendsFilter__05867e444b37":{"description":"OData Version 4.0 filter string (limited functionality). Supports only 'and' conjunction ('or' and 'not' are NOT supported). Supported fields, operators and value format are in the below given table.\n\n| Field | Operators | Format |\n| --------- | -------- | -------- |\n| `timestamp` | `gt` and `lt` | **Date-time (RFC 3339 timestamp in UTC+0) string** |\n\n**The operators are implemented as follows:**\n\n* `gt`: Used to indicate the start of the timestamp range.\n\n* `lt`: Used to indicate the end of the timestamp range.\n\n","example":"timestamp gt 2022-07-30T19:38:16Z and timestamp lt 2022-08-01T20:28:52Z","in":"query","name":"filter","required":false,"schema":{"format":"const","maxLength":256,"type":"string"}},"TrendsFiltergw__1053ccf03958":{"description":"OData Version 4.0 filter string (limited functionality). Supports only 'and' conjunction ('or' and 'not' are NOT supported). Supported fields, operators and value format are in the below given table.\n\n| Field | Operators | Format |\n| --------- | -------- | -------- |\n| `timestamp` | `gt` and `lt` | **Date-time (RFC 3339 timestamp in UTC+0) string** |\n\n**The operators are implemented as follows:**\n\n* `gt`: Used to indicate the start of the timestamp range.\n\n* `lt`: Used to indicate the end of the timestamp range.\n\n","example":"timestamp gt 2022-07-30T19:38:16Z and timestamp lt 2022-08-01T20:28:52Z","in":"query","name":"filter","required":false,"schema":{"maxLength":256,"type":"string"}},"TunnelId__0f1d40c88b6b":{"description":"Tunnel ID of the tunnel","in":"path","name":"tunnel-id","required":true,"schema":{"$ref":"#/components/schemas/TunnelId__0f1d40c88b6b"}},"TunnelName__2ca376caec3f":{"description":"Tunnel ID configured in the gateway.","in":"path","name":"tunnel-name","required":true,"schema":{"example":"ap-ipsecmap-00:01:b2:22:02:25","type":"string"}},"VlanId__c99febaf4556":{"description":"VLAN ID configured in the gateway.","in":"path","name":"vlan-id","required":true,"schema":{"example":"33","type":"string"}},"WlanFilter__bfa0034decee":{"description":"OData Version 4.0 filter string (limited functionality). Supports only 'and' conjunction ('or' and 'not' are NOT supported). Supported fields and operators are in the below given table.\n\n| Field | Operators |\n| --------- | -------- |\n| `band` | `eq` and `in` |\n\n**The operators are implemented as follows:**\n\n* `eq`: Only values exactly matching the given value are returned.\n\n* `in`: Only values present in the given list are returned.\n\n","example":"band eq '2.4 GHz' or band in ('2.4 GHz', '5 GHz')","in":"query","name":"filter","required":false,"schema":{"format":"const","maxLength":256,"type":"string"}},"WlanNameMandatory__5247473e8f2a":{"description":"Name of the WLAN for which information is requested.\n","in":"path","name":"wlan-name","required":true,"schema":{"example":"wlan1","type":"string"}},"end-at__0052b7c55291":{"description":"End time for the location analytics trends/insights.","example":"1683284400000","in":"query","name":"end-at","required":true,"schema":{"$ref":"#/components/schemas/EndAt__0052b7c55291"}},"interface-id__0d6bfd060cf2":{"description":"Interface name of the switch.","in":"query","name":"interface-id","required":false,"schema":{"example":"7","type":"string"}},"limit__f20300aab7a0":{"description":"Specifies the number of objects returned in a single page. Default: 20.","example":20,"in":"query","name":"limit","required":false,"schema":{"$ref":"#/components/schemas/Limit__f20300aab7a0"}},"offset__f20300aab7a0":{"description":"Specifies the offset. Default: 0.","example":0,"in":"query","name":"offset","required":false,"schema":{"$ref":"#/components/schemas/Offset__f20300aab7a0"}},"search__244c7d3b837e":{"description":"Partial or full string free text search.","in":"query","name":"search","required":false,"schema":{"$ref":"#/components/schemas/Filterswitch__244c7d3b837e"}},"serial-number__0d6bfd060cf2":{"description":"Serial Number of the switch in case of standalone, StackId or conductor serial in case of stack for which the device related information is requested.","example":"ABCD1234","in":"path","name":"serial-number","required":true,"schema":{"$ref":"#/components/schemas/SerialNumber__05867e444b37"}},"serial-numbervsx__ed65ca41c4fc":{"description":"The serial number of the switch","in":"path","name":"serial-number","required":true,"schema":{"example":"SG9ZKN5018","pattern":"^[A-Z0-9]+$","type":"string"}},"site-id__0052b7c55291":{"description":"ID of the site for which location analytics trends is requested.","example":"123682","in":"query","name":"site-id","required":false,"schema":{"$ref":"#/components/schemas/SiteId__0052b7c55291"}},"site-id__0d6bfd060cf2":{"description":"ID of the site for which switch-related information is requested.","example":"2345678","in":"query","name":"site-id","required":false,"schema":{"$ref":"#/components/schemas/SiteID__05867e444b37"}},"sort__f20300aab7a0":{"description":"Sorting can be supported on the following fields: totalVisitorCount, passerbyCount. Default: totalVisitorCount. Directions supported: ASC, DESC. Default: DESC.","in":"query","name":"sort","required":false,"schema":{"$ref":"#/components/schemas/Sort__f20300aab7a0"}},"start-at__0052b7c55291":{"description":"Start time for the location analytics trends/insights.","example":"1683284400000","in":"query","name":"start-at","required":true,"schema":{"$ref":"#/components/schemas/StartAt__0052b7c55291"}},"trendsFilterswitch__0d6bfd060cf2":{"description":"OData Version 4.0 filter string (limited functionality). Supports only 'and' conjunction ('or' and 'not' are NOT supported). By default, aggregation is performed for three hours after the specified timestamp when only the gt operator is used, or up to the specified timestamp when only the lt operator is used. Supported fields, operators and value format are in the below given table.\n\n| Field | Operators | Format |\n| --------- | -------- | -------- |\n| `timestamp` | `gt` and `lt` | **Date-time (RFC 3339 timestamp in UTC+0) string** |\n\n**The operators are implemented as follows:**\n\n* `gt`: Used to indicate the start of the timestamp range.\n\n* `lt`: Used to indicate the end of the timestamp range.\n\n","example":"timestamp gt 2022-07-30T19:38:16Z and timestamp lt 2022-08-01T20:28:52Z","in":"query","name":"filter","required":false,"schema":{"format":"const","maxLength":256,"type":"string"}},"uplink__0d6bfd060cf2":{"description":"Uplink of the interface indicates true or false.","in":"query","name":"uplink","required":false,"schema":{"example":true,"type":"boolean"}}},"responses":{"APProbeTrendsResponse__24d76b0b1476":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APProbeTrend__24d76b0b1476"}}},"description":"The response object provides probe trends of an access point.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"APThroughputTrendsResponse__0931747ce8ba":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APThroughputTrend__0931747ce8ba"}}},"description":"The response object provides throughput trend of an access point.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"AccessPointCPUUtilizationResponse__d7f5998ad833":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessPointCPUUtilization__d7f5998ad833"}}},"description":"The response object provides cpu utilization trend of an access point over a period of time.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"AccessPointDHCPPoolListResponseV1__36b9a7c1ff51":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessPointDHCPPoolListResponseV1__36b9a7c1ff51"}}},"description":"List of access point DHCP pools, along with their details and associated pagination information.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"AccessPointListResponse__da78704f9a76":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessPointListResponse__da78704f9a76"}}},"description":"List of access points, along with their details and associated pagination information.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"AccessPointMemoryUtilizationResponse__9b696b333a10":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessPointMemoryUtilization__9b696b333a10"}}},"description":"The response object provides memory utilization trend of an access point over a period of time.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"AccessPointPowerConsumptionResponse__75dfc6cfa00f":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessPointPowerConsumption__75dfc6cfa00f"}}},"description":"The response object provides power consumption trend of an access point over a period of time.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"AccessPointRadioListResponseV1__8b147ff96285":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessPointRadioListResponseV1__8b147ff96285"}}},"description":"List of Radios of an access point, along with their details.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"AccessPointResponse__98bb0f033247":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessPointResponse__98bb0f033247"}}},"description":"Object containing information about the access point, such as MAC address, name, status, radios, ports, modem, and WLANs.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"AccessPointTunnelDetailResponseV1__0f1d40c88b6b":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessPointTunnelDetailResponseV1__0f1d40c88b6b"}}},"description":"Object containing information about the access point tunnel, such as name, status, encapsulation type, source and destination information based on the access point's serial number.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"AccessPointTunnelListResponseV1__d231f2b75fda":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessPointTunnelListResponseV1__d231f2b75fda"}}},"description":"List of access point tunnels, along with their details and associated pagination information.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"AccessPointWLANThroughputTrendsResponse__91253e313aa9":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessPointWLANThroughputTrend__91253e313aa9"}}},"description":"The response object provides throughput trend of an access point WLAN.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"AlertActionResponse__0c2a95c4aa99":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertActionResponseBody__0c2a95c4aa99"}}},"description":"Accepted response for asynchronous alert action operations.\n","headers":{"Location":{"description":"URL to check the status of the asynchronous operation.","schema":{"type":"string"}},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"AlertActionStatusResponse__4774edd10512":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertActionStatusResponseBody__4774edd10512"}}},"description":"Status of an asynchronous alert operation.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"AlertConfigListResponse__1f9b401b0047":{"content":{"application/json":{"schema":{"description":"Paginated list of alert configurations.\n","example":{"count":2,"items":[{"category":"System","clearTimeout":"1H","description":"Triggers when access point CPU usage exceeds configured thresholds.","deviceType":"Access Point","enabled":true,"inherited":false,"label":"CPU","name":"AP CPU Utilization","ruleSource":"USER","rules":[{"rule":{"additionalCondition":[],"condition":[{"expression":{"metric":"cpu_utilization","operator":"GTE","valueNumber":90},"severity":"CRITICAL"},{"expression":{"metric":"cpu_utilization","operator":"GTE","valueNumber":80},"severity":"MAJOR"},{"expression":{"metric":"cpu_utilization","operator":"GTE","valueNumber":70},"severity":"MINOR"}],"duration":5,"metric":"cpu_utilization"},"ruleNumber":0}],"scopeId":"1021882040","scopeType":"GLOBAL"},{"category":"System","clearTimeout":null,"description":"Triggers when switch CPU usage exceeds configured thresholds.","deviceType":"Switch","enabled":true,"inherited":false,"label":"CPU","name":"Switch CPU Utilization","ruleSource":"SYSTEM","rules":[],"scopeId":"1021882040","scopeType":"GLOBAL"}],"offset":0,"total":99},"properties":{"count":{"description":"Number of alert configurations returned in the current page.\n","example":10,"type":"integer"},"id":{"description":"Unique identifier for this collection resource.\n","example":"network-notifications/v1/alert-config","type":"string"},"items":{"description":"List of alert configuration entries in the current page.\n","items":{"$ref":"#/components/schemas/AlertConfigResponse__1f9b401b0047"},"type":"array"},"offset":{"description":"Zero-based index of the first item returned in this page. Present only when the request includes a `limit` parameter.\n","example":0,"type":"integer"},"total":{"description":"Total number of alert configurations available across all pages. Present only when the request includes a `limit` parameter.\n","example":99,"type":"integer"},"type":{"description":"Resource type identifier.\n","example":"network-notifications/alert-configs","type":"string"}},"required":["id","type","items","count"],"type":"object"}}},"description":"List of alert configurations for the requested scope.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"AlertListResponse__78d118144c60":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertListResponse__78d118144c60"}}},"description":"List of alerts, along with alert details and associated pagination information.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"AlertsClassificationResponse__7688f37a490e":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertsClassificationResponseBody__7688f37a490e"}}},"description":"Classification of alerts grouped by the specified type.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"BadRequestError__004689200476":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError__004689200476"}}},"description":"Bad Request","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"BadRequestError__0052b7c55291":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestsErrorSchema__0052b7c55291"}}},"description":"Bad Request","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"BadRequestError__0c2a95c4aa99":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestErrorDetails__0c2a95c4aa99"}}},"description":"Invalid input received.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"BadRequestError__1335a419f403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError__1335a419f403"}}},"description":"Invalid input received.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit__09b903e67f2b"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/XRateLimitReset__02a6567f3633"}}},"BadRequestError__66b457073e9b":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError__66b457073e9b"}}},"description":"Invalid input received.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"BadRequestError__6ff1f6639f14":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestError__6ff1f6639f14"}}},"description":"Invalid input received.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"BadRequestShowCommand__1070839fcc3b":{"content":{"application/json":{"examples":{"commandNotShow":{"summary":"Command does not start with show","value":{"errorCode":"HPE_GL_ERROR_BAD_REQUEST","message":"Command denied: must start with 'show '"}},"tooManyCommands":{"summary":"Commands array over limit","value":{"errorCode":"HPE_GL_ERROR_BAD_REQUEST","message":"Too many commands, maximum allowed is 20"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse__02a6567f3633"}}},"description":"Bad Request. Validation errors in the request body or parameters, or invalid parameters for the specific device.","headers":{"X-RateLimit-Limit":{"description":"Request limit per hour.","schema":{"format":"int64","maximum":9223372036854776000,"minimum":0,"type":"integer"}},"X-RateLimit-Remaining":{"description":"The number of requests left for the time window.","schema":{"format":"int64","maximum":9223372036854776000,"minimum":0,"type":"integer"}},"X-RateLimit-Reset":{"description":"The date-time (RFC 3339 timestamp in UTC+0) at which the current rate limit window resets.","schema":{"format":"date-time","maxLength":20,"type":"string"}}}},"BadRequest__01cfa36ad727":{"content":{"application/json":{"schema":{"description":"Error details returned from the server.","properties":{"errorCode":{"description":"Error code","enum":["HPE_GL_NETWORK_SERVICES_INVALID_INPUT"],"example":"HPE_GL_NETWORK_SERVICES_INVALID_INPUT","maxLength":128,"type":"string"},"httpStatusCode":{"description":"HTTP status code","example":[400],"maximum":400,"minimum":400,"type":"integer"},"message":{"description":"Error message indicating the cause of the failure","example":"Invalid limit or offset input less than 0","maxLength":512,"type":"string"}},"required":["errorCode","message","httpStatusCode"],"type":"object"}}},"description":"Invalid input received.","headers":{"X-RateLimit-Limit":{"description":"The maximum number of requests allowed per time window","schema":{"$ref":"#/components/schemas/X-RateLimit-Limit__01cfa36ad727"}},"X-RateLimit-Remaining":{"description":"The number of requests remaining in the current time window","schema":{"$ref":"#/components/schemas/X-RateLimit-Remaining__01cfa36ad727"}},"X-RateLimit-Reset":{"description":"The time at which the current rate limit window resets","schema":{"$ref":"#/components/schemas/X-RateLimit-Reset__01cfa36ad727"}}}},"BadRequest__02a6567f3633":{"content":{"application/json":{"example":{"errorCode":"HPE_GL_ERROR_BAD_REQUEST","message":"Validation errors - packetSize must be between 10 and 2000"},"schema":{"$ref":"#/components/schemas/ErrorResponse__02a6567f3633"}}},"description":"Bad Request. Validation errors in the request body or parameters, or invalid parameters for the specific device.","headers":{"X-RateLimit-Limit":{"description":"Request limit per hour.","schema":{"format":"int64","maximum":9223372036854776000,"minimum":0,"type":"integer"}},"X-RateLimit-Remaining":{"description":"The number of requests left for the time window.","schema":{"format":"int64","maximum":9223372036854776000,"minimum":0,"type":"integer"}},"X-RateLimit-Reset":{"description":"The date-time (RFC 3339 timestamp in UTC+0) at which the current rate limit window resets.","schema":{"format":"date-time","maxLength":20,"type":"string"}}}},"BadRequestasset__8de6ce4ea240":{"content":{"application/json":{"schema":{"description":"Error details returned from the server.","properties":{"debugId":{"description":"A unique identifier used for troubleshooting purposes.","example":"e5b61232-83c8-401a-8e14-a4c75b4fb745","format":"const","maxLength":512,"type":"string"},"errorCode":{"description":"Error code","enum":["HPE_GL_NETWORK_SERVICES_INVALID_PAGE_INFO_INPUT","HPE_GL_NETWORK_SERVICES_INVALID_QUERY_TIME","HPE_GL_NETWORK_SERVICES_INVALID_FIELD_INPUT","HPE_GL_NETWORK_SERVICES_INVALID_QUERY_PARAMS"],"example":"HPE_GL_NETWORK_SERVICES_INVALID_PAGE_INFO_INPUT","maxLength":128,"type":"string"},"httpStatusCode":{"description":"HTTP status code","example":400,"maximum":400,"minimum":400,"type":"integer"},"message":{"description":"Error message indicating the cause of the failure","example":"Invalid limit or offset input less than 0","format":"const","maxLength":512,"type":"string"}},"required":["errorCode","message","debugId","httpStatusCode"],"type":"object"}}},"description":"Invalid input received.","headers":{"X-RateLimit-Limit":{"schema":{"$ref":"#/components/schemas/X-RateLimit-Limit__01cfa36ad727"}},"X-RateLimit-Remaining":{"schema":{"$ref":"#/components/schemas/X-RateLimit-Remaining__01cfa36ad727"}},"X-RateLimit-Reset":{"schema":{"$ref":"#/components/schemas/X-RateLimit-Reset__01cfa36ad727"}}}},"BadRequestaudit__13edfa6d725b":{"content":{"application/json":{"schema":{"description":"Error details returned from the server.","properties":{"debugId":{"description":"A unique identifier used for troubleshooting and debugging purposes.","example":["e5b61232-83c8-401a-8e14-a4c75b4fb745"],"maxLength":512,"type":"string"},"errorCode":{"description":"Error code","enum":["HPE_GL_NETWORK_SERVICES_INVALID_INPUT"],"example":["HPE_GL_NETWORK_SERVICES_INVALID_INPUT"],"maxLength":128,"type":"string"},"httpStatusCode":{"description":"HTTP status code","example":[400],"maximum":400,"minimum":400,"type":"integer"},"message":{"description":"Error message indicating the cause of the failure","example":["Bad Request, Your request was incorrect or incomplete. Please check and try again."],"maxLength":512,"type":"string"}},"required":["errorCode","message","debugId","httpStatusCode"],"type":"object"}}},"description":"Invalid input received.","headers":{"X-RateLimit-Limit":{"schema":{"$ref":"#/components/schemas/X-RateLimit-Limit__01cfa36ad727"}},"X-RateLimit-Remaining":{"schema":{"$ref":"#/components/schemas/X-RateLimit-Remaining__01cfa36ad727"}},"X-RateLimit-Reset":{"schema":{"$ref":"#/components/schemas/X-RateLimit-Reset__01cfa36ad727"}}}},"BadRequestfco__09b903e67f2b":{"content":{"application/json":{"schema":{"description":"Error details","properties":{"debugId":{"description":"A unique identifier used for troubleshooting and debugging purposes.","example":["e5b61232-83c8-401a-8e14-a4c75b4fb745"],"format":"const","maxLength":512,"type":"string"},"errorCode":{"description":"An error code","enum":["HPE_GL_NETWORK_MONITORING_INVALID_INPUT"],"example":["HPE_GL_NETWORK_MONITORING_INVALID_INPUT"],"maxLength":128,"type":"string"},"httpStatusCode":{"description":"The HTTP status code","example":[400],"maximum":400,"minimum":400,"type":"integer"},"message":{"description":"An error message indicating the cause of the failure","example":["Invalid limit or offset input less than 0"],"format":"const","maxLength":512,"type":"string"}},"required":["errorCode","message","debugId","httpStatusCode"],"type":"object"}}},"description":"Invalid input received.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit__09b903e67f2b"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"BadRequestwids__000172564380":{"content":{"application/json":{"schema":{"description":"Error details returned from the server.","properties":{"debugId":{"$ref":"#/components/schemas/DebugId__000172564380"},"errorCode":{"description":"Error code","enum":["HPE_GL_NETWORK_SERVICES_WIDS_INVALID_PAGE_INFO_INPUT","HPE_GL_NETWORK_SERVICES_WIDS_INVALID_QUERY_TIME","HPE_GL_NETWORK_SERVICES_WIDS_INVALID_FIELD_INPUT","HPE_GL_NETWORK_SERVICES_WIDS_INVALID_QUERY_PARAMS"],"examples":["HPE_GL_NETWORK_SERVICES_WIDS_INVALID_PAGE_INFO_INPUT"],"type":"string"},"httpStatusCode":{"description":"HTTP status code","examples":[400],"maximum":400,"minimum":400,"type":"integer"},"message":{"$ref":"#/components/schemas/ErrorMessage__000172564380"}},"required":["errorCode","message","debugId","httpStatusCode"],"type":"object"}}},"description":"Invalid input received.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"BssidListResponse__54309c5cca60":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BssidListResponse__54309c5cca60"}}},"description":"List of BSSIDs, along with their details and associated pagination information.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"ClientsTrendResponse__55ca259b8355":{"content":{"application/json":{"example":{"id":"4fce1e37-9e48-4fb4-bb62-2c11ee6e3d83","interval":"5 mins","keys":["Wired","Wireless","Remote"],"samples":[{"data":[2,4,1],"ts":"2025-08-29T03:45:00Z"},{"data":[2,4,1],"ts":"2025-08-29T03:50:00Z"}],"type":"network-monitoring/client-monitoring"},"schema":{"$ref":"#/components/schemas/GetClientsTrends__55ca259b8355"}}},"description":"Response schema for client Trends","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"ClientsUsageResponse__6bf98218c48a":{"content":{"application/json":{"example":{"interval":"5 mins","keys":["txUsage","rxUsage"],"samples":[{"data":[1048576,524288],"ts":"2025-08-19T06:45:00Z"},{"data":[2097152,1048576],"ts":"2025-08-19T06:50:00Z"}],"type":"network-monitoring/client-monitoring"},"schema":{"$ref":"#/components/schemas/GetClientsUsage__6bf98218c48a"}}},"description":"Response schema for clients usage trend.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"ClusterCapacityTrendResponse__7201244eb725":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClusterCapacityTrend__7201244eb725"}}},"description":"The response object provides the client and device capacity trend of a gateway cluster.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"ClusterConnectivityGraphResponse__facf932e9683":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClusterConnectivityGraphResponse__facf932e9683"}}},"description":"Object containing information about gateways and their peers in a gateway-cluster.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"ClusterMemberCapacityTrendResponse__3a50015484e1":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClusterMemberCapacityTrend__3a50015484e1"}}},"description":"The response object provides the client and device capacity trend of a gateway cluster member.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"ClusterMemberListResponse__de89a47d9bd8":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClusterMemberListResponse__de89a47d9bd8"}}},"description":"Object containing information about the gateways present in the cluster.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"ClusterTunnelHealthSummaryResponse__49fb391231f9":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClusterTunnelHealthSummaryResponse__49fb391231f9"}}},"description":"Object containing information about the health summary of tunnels present in the gateway-cluster.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"ClusterTunnelStatusSummaryResponse__eca6a91fa313":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClusterTunnelStatusSummaryResponse__eca6a91fa313"}}},"description":"Object containing the count of inter-gateway tunnels that are Up and Down in a gateway-cluster.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"ClusterVlanMismatchResponse__a51bf4679e93":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClusterVlanMismatchResponse__a51bf4679e93"}}},"description":"Object containing information about the good and poor VLANs, either for the entire gateway-cluster or for individual gateways within the gateway-cluster.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"ConflictError__4e865062885b":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictError__4e865062885b"}}},"description":"Conflict. The resource already exists.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"ConflictError__c34075768619":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictError__c34075768619"}}},"description":"Conflict. The request could not be completed because the resource already exists or is in a conflicting state.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"DatabaseError__3f58b16772b5":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatabaseError__3f58b16772b5"}}},"description":"Internal Server Error response.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"DeletedDeviceResponseV1__7d94a4e82655":{"description":"The device has been successfully deleted.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"DeviceConflictLocating__322170916979":{"content":{"application/json":{"example":{"summary":"Device Already Locating","value":{"code":"DOWNSTREAM_SERVICE_ERROR","errorCode":"HPE_GL_ERROR_CONFLICT","errorType":"CONFLICT","httpStatusCode":"409","message":"Device already locating: VN2ZLHB006","serviceName":"Troubleshooting"}},"schema":{"$ref":"#/components/schemas/DeviceNotReadyErrorResponse__322170916979"}}},"description":"Conflict. The device is already performing a locate operation.","headers":{"X-RateLimit-Limit":{"description":"Request limit per hour.","schema":{"format":"int64","maximum":9223372036854776000,"minimum":0,"type":"integer"}},"X-RateLimit-Remaining":{"description":"The number of requests left for the time window.","schema":{"format":"int64","maximum":9223372036854776000,"minimum":0,"type":"integer"}},"X-RateLimit-Reset":{"description":"The date-time (RFC 3339 timestamp in UTC+0) at which the current rate limit window resets.","schema":{"format":"date-time","maxLength":20,"type":"string"}}}},"DeviceConflictRebooting__78801b30c1be":{"content":{"application/json":{"example":{"summary":"Device Already Rebooting","value":{"code":"DOWNSTREAM_SERVICE_ERROR","errorCode":"HPE_GL_ERROR_CONFLICT","errorType":"CONFLICT","httpStatusCode":"409","message":"Device already rebooting: VN2ZLHB006","serviceName":"Troubleshooting"}},"schema":{"$ref":"#/components/schemas/DeviceNotReadyErrorResponse__322170916979"}}},"description":"Conflict. The device is already performing a reboot.","headers":{"X-RateLimit-Limit":{"description":"Request limit per hour.","schema":{"format":"int64","maximum":9223372036854776000,"minimum":0,"type":"integer"}},"X-RateLimit-Remaining":{"description":"The number of requests left for the time window.","schema":{"format":"int64","maximum":9223372036854776000,"minimum":0,"type":"integer"}},"X-RateLimit-Reset":{"description":"The date-time (RFC 3339 timestamp in UTC+0) at which the current rate limit window resets.","schema":{"format":"date-time","maxLength":20,"type":"string"}}}},"DeviceInventoryResponseV1__cd77b09562fb":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceInventoryResponseV1__cd77b09562fb"}}},"description":"List of network devices, including Access Points, Switches, and Gateways from device inventory, along with their details and associated pagination information.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"DeviceListResponseV1__6b9c5f08b869":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceListResponseV1__6b9c5f08b869"}}},"description":"List of network devices, including Access Points, Switches, and Gateways, along with their details and associated pagination information.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"DeviceNotFound__02a6567f3633":{"content":{"application/json":{"example":{"errorCode":"HPE_GL_ERROR_NOT_FOUND","message":"Device not found: CXXYYZZ001"},"schema":{"$ref":"#/components/schemas/ErrorResponse__02a6567f3633"}}},"description":"Not Found. The device with the specified serial number was not found.","headers":{"X-RateLimit-Limit":{"description":"Request limit per hour.","schema":{"format":"int64","maximum":9223372036854776000,"minimum":0,"type":"integer"}},"X-RateLimit-Remaining":{"description":"The number of requests left for the time window.","schema":{"format":"int64","maximum":9223372036854776000,"minimum":0,"type":"integer"}},"X-RateLimit-Reset":{"description":"The date-time (RFC 3339 timestamp in UTC+0) at which the current rate limit window resets.","schema":{"format":"date-time","maxLength":20,"type":"string"}}}},"DeviceNotFound__8bd44b0ed12d":{"content":{"application/json":{"schema":{"description":"Error details returned from the server.\n","properties":{"debugId":{"description":"Internal debug id.\n","examples":["e5b61232-83c8-401a-8e14-a4c75b4fb745"],"format":"const","maxLength":128,"type":"string"},"errorCode":{"description":"Internal error code.\n","enum":["HPE_GL_NETWORK_SERVICES_DEVICE_LOCATION_DEVICE_NOT_FOUND"],"examples":["HPE_GL_NETWORK_SERVICES_DEVICE_LOCATION_DEVICE_NOT_FOUND"],"maxLength":32,"type":"string"},"httpStatusCode":{"description":"HTTP status code.\n","examples":[404],"maximum":404,"minimum":404,"type":"integer"},"message":{"description":"Error message indicating the cause of the failure.\n","examples":[{"error_msg":"404 Route Not Found"}],"format":"const","maxLength":512,"type":"string"}},"required":["errorCode","message","debugId","httpStatusCode"],"type":"object"}}},"description":"Device with serial number not found.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit__09b903e67f2b"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"DeviceOffline__02a6567f3633":{"content":{"application/json":{"example":{"errorCode":"HPE_GL_ERROR_CONFLICT","message":"Device offline: CXXYYZZ001"},"schema":{"$ref":"#/components/schemas/ErrorResponse__02a6567f3633"}}},"description":"Conflict. The device is currently offline.","headers":{"X-RateLimit-Limit":{"description":"Request limit per hour.","schema":{"format":"int64","maximum":9223372036854776000,"minimum":0,"type":"integer"}},"X-RateLimit-Remaining":{"description":"The number of requests left for the time window.","schema":{"format":"int64","maximum":9223372036854776000,"minimum":0,"type":"integer"}},"X-RateLimit-Reset":{"description":"The date-time (RFC 3339 timestamp in UTC+0) at which the current rate limit window resets.","schema":{"format":"date-time","maxLength":20,"type":"string"}}}},"Error400__3f58b16772b5":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error400__3f58b16772b5"}}},"description":"Bad request error response.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"Error404__3f58b16772b5":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error404__0052b7c55291"}}},"description":"Resource not found error response.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"Error404audit__13edfa6d725b":{"content":{"application/json":{"schema":{"description":"Error details returned from the server.","properties":{"debugId":{"description":"A unique identifier used for troubleshooting and debugging purposes.","example":["e5b61232-83c8-401a-8e14-a4c75b4fb745"],"maxLength":512,"type":"string"},"errorCode":{"description":"A unique machine-friendly identifier for the error.","enum":["HPE_GL_NETWORK_SERVICES_RESOURCE_NOT_FOUND"],"example":["HPE_GL_NETWORK_SERVICES_RESOURCE_NOT_FOUND"],"maxLength":256,"type":"string"},"httpStatusCode":{"description":"HTTP status code.","example":[404],"maximum":404,"minimum":404,"type":"integer"},"message":{"description":"Error message indicating the cause of the failure.","example":["Requested resource was not found"],"maxLength":512,"type":"string"}},"required":["errorCode","message","debugId","httpStatusCode"],"type":"object"}}},"description":"Resource not found error response.","headers":{"X-RateLimit-Limit":{"schema":{"$ref":"#/components/schemas/X-RateLimit-Limit__01cfa36ad727"}},"X-RateLimit-Remaining":{"schema":{"$ref":"#/components/schemas/X-RateLimit-Remaining__01cfa36ad727"}},"X-RateLimit-Reset":{"schema":{"$ref":"#/components/schemas/X-RateLimit-Reset__01cfa36ad727"}}}},"EventDetailsResponse__1335a419f403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventDetails__1335a419f403"}}},"description":"Response schema for event details","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit__09b903e67f2b"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/XRateLimitReset__02a6567f3633"}}},"EventFiltersResponse__2c64e622674f":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventFilters__2c64e622674f"}}},"description":"Response schema for event filters","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit__09b903e67f2b"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/XRateLimitReset__02a6567f3633"}}},"ExpiringLicensesSummaryResponse__bf1f3740b270":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExpiringLicensesSummary__bf1f3740b270"}}},"description":"Successful response containing expiring licenses summary.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"FirmwareDetailsListResponse__c0c1228d8f7d":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FirmwareDetailsListResponse__c0c1228d8f7d"}}},"description":"List of device's firmware details, including Access Points, Switches, Gateways and associated pagination information.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"ForbiddenRequest__01cfa36ad727":{"content":{"application/json":{"schema":{"description":"Error details returned from the server.","properties":{"errorCode":{"description":"* A unique machine-friendly, but human-readable identifier for the error. It has prefix HPE_GL_.\n* For more details regarding error please refer to error message","enum":["HPE_GL_ERROR_FORBIDDEN"],"example":["HPE_GL_ERROR_FORBIDDEN"],"maxLength":256,"type":"string"},"httpStatusCode":{"description":"HTTP status code","example":[403],"maximum":403,"minimum":403,"type":"integer"},"message":{"description":"Forbidden request. The client does not have access rights to the content.","example":"Unauthorized Request","maxLength":512,"type":"string"}},"required":["errorCode","message","httpStatusCode"],"type":"object"}}},"description":"Forbidden request. The client does not have access rights to the content.","headers":{"X-RateLimit-Limit":{"description":"The maximum number of requests allowed per time window","schema":{"$ref":"#/components/schemas/X-RateLimit-Limit__01cfa36ad727"}},"X-RateLimit-Remaining":{"description":"The number of requests remaining in the current time window","schema":{"$ref":"#/components/schemas/X-RateLimit-Remaining__01cfa36ad727"}},"X-RateLimit-Reset":{"description":"The time at which the current rate limit window resets","schema":{"$ref":"#/components/schemas/X-RateLimit-Reset__01cfa36ad727"}}}},"ForbiddenRequestasset__8de6ce4ea240":{"content":{"application/json":{"schema":{"description":"Error details returned from the server.","properties":{"debugId":{"description":"A unique identifier used for troubleshooting purposes.","example":"e5b61232-83c8-401a-8e14-a4c75b4fb745","format":"const","maxLength":512,"type":"string"},"errorCode":{"description":"* A unique machine-friendly, but human-readable identifier for the error. It has the prefix HPE_GL_.\n* For more details regarding the error, please refer to the error message.","enum":["HPE_GL_ERROR_FORBIDDEN"],"example":"HPE_GL_ERROR_FORBIDDEN","maxLength":256,"type":"string"},"httpStatusCode":{"description":"HTTP status code","example":403,"maximum":403,"minimum":403,"type":"integer"},"message":{"description":"Forbidden","example":"Unauthorized Request","format":"const","maxLength":512,"type":"string"}},"required":["errorCode","message","debugId","httpStatusCode"],"type":"object"}}},"description":"Forbidden: Access is denied.","headers":{"X-RateLimit-Limit":{"schema":{"$ref":"#/components/schemas/X-RateLimit-Limit__01cfa36ad727"}},"X-RateLimit-Remaining":{"schema":{"$ref":"#/components/schemas/X-RateLimit-Remaining__01cfa36ad727"}},"X-RateLimit-Reset":{"schema":{"$ref":"#/components/schemas/X-RateLimit-Reset__01cfa36ad727"}}}},"ForbiddenRequestaudit__13edfa6d725b":{"content":{"application/json":{"schema":{"description":"Error details returned from the server.","properties":{"debugId":{"description":"A unique identifier used for troubleshooting and debugging purposes.","example":["e5b61232-83c8-401a-8e14-a4c75b4fb745"],"maxLength":512,"type":"string"},"errorCode":{"description":"* A unique machine-friendly, but human-readable identifier for the error. It has prefix HPE_GL_.\n* For more details regarding error please refer to error message","enum":["HPE_GL_ERROR_FORBIDDEN"],"example":["HPE_GL_ERROR_FORBIDDEN"],"maxLength":256,"type":"string"},"httpStatusCode":{"description":"HTTP status code","example":[403],"maximum":403,"minimum":403,"type":"integer"},"message":{"description":"Forbidden","example":["Unauthorized Request"],"maxLength":512,"type":"string"}},"required":["errorCode","message","debugId","httpStatusCode"],"type":"object"}}},"description":"Forbidden: Access is denied.","headers":{"X-RateLimit-Limit":{"schema":{"$ref":"#/components/schemas/X-RateLimit-Limit__01cfa36ad727"}},"X-RateLimit-Remaining":{"schema":{"$ref":"#/components/schemas/X-RateLimit-Remaining__01cfa36ad727"}},"X-RateLimit-Reset":{"schema":{"$ref":"#/components/schemas/X-RateLimit-Reset__01cfa36ad727"}}}},"ForbiddenRequestfco__09b903e67f2b":{"content":{"application/json":{"schema":{"description":"Error details","properties":{"debugId":{"description":"A unique identifier used for troubleshooting and debugging purposes.","example":["e5b61232-83c8-401a-8e14-a4c75b4fb745"],"format":"const","maxLength":512,"type":"string"},"errorCode":{"description":"* A unique machine-friendly, but human-readable identifier for the error. It has prefix HPE_GL_.\n* For more details regarding error please refer to error message","enum":["HPE_GL_ERROR_FORBIDDEN"],"example":["HPE_GL_ERROR_FORBIDDEN"],"maxLength":256,"type":"string"},"httpStatusCode":{"description":"The HTTP status code","example":[403],"maximum":403,"minimum":403,"type":"integer"},"message":{"description":"Forbidden","example":["Unauthorized Request"],"format":"const","maxLength":512,"type":"string"}},"required":["errorCode","message","debugId","httpStatusCode"],"type":"object"}}},"description":"Forbidden: Access is denied.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit__09b903e67f2b"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"ForbiddenRequestwids__000172564380":{"content":{"application/json":{"schema":{"description":"Error details returned from the server.","properties":{"debugId":{"$ref":"#/components/schemas/DebugId__000172564380"},"errorCode":{"description":"* A unique machine-friendly, but human-readable identifier for the error. It has prefix HPE_GL_.\n\n* For more details regarding error please refer to error message","enum":["HPE_GL_ERROR_FORBIDDEN"],"examples":["HPE_GL_ERROR_FORBIDDEN"],"type":"string"},"httpStatusCode":{"description":"HTTP status code","examples":[403],"maximum":403,"minimum":403,"type":"integer"},"message":{"$ref":"#/components/schemas/ErrorMessage__000172564380"}},"required":["errorCode","message","debugId","httpStatusCode"],"type":"object"}}},"description":"Forbidden: Access is denied.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"Forbidden__004689200476":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenRequest__004689200476"}}},"description":"Forbidden: Access is denied.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"Forbidden__0052b7c55291":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Forbidden__0052b7c55291"}}},"description":"Forbidden: Access is denied.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"Forbidden__02a6567f3633":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError__02a6567f3633"}}},"description":"Forbidden: Access is denied.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit__09b903e67f2b"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/XRateLimitReset__02a6567f3633"}}},"Forbidden__0c2a95c4aa99":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenErrorDetails__0c2a95c4aa99"}}},"description":"Forbidden. Access is denied.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"Forbidden__66b457073e9b":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError__66b457073e9b"}}},"description":"Forbidden: Access is denied.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"Forbidden__6ff1f6639f14":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError__6ff1f6639f14"}}},"description":"Forbidden: Access is denied.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"GatewayCPUTrendResponse__51aa0b146279":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GwCPUTrend__51aa0b146279"}}},"description":"The response object provides CPU utilization trends of gateway.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"GatewayClusterTunnelListResponse__608b430a0026":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayClusterTunnelListResponse__608b430a0026"}}},"description":"Object containing information about the tunnels present in a gateway cluster.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"GatewayDhcpLeaseListResponse__21874c7bfa12":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayDhcpLeaseListResponse__21874c7bfa12"}}},"description":"Object containing information about the leases in the pool.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"GatewayDhcpPoolListResponse__f07d3dc27fa5":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayDhcpPoolListResponse__f07d3dc27fa5"}}},"description":"Object containing information about the DHCP pools configured in the gateway.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"GatewayFramesErrorsTrendResponse__ab9c9f33ae99":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GwFramesErrorsTrend__ab9c9f33ae99"}}},"description":"The response object provides the data of the errors in runts, giants, collisions and crc/Fcs.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"GatewayFramesPacketsTrendResponse__b5fe37f7cc07":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GwFramesPacketsTrend__b5fe37f7cc07"}}},"description":"The response object provides the data of the packets processed in broadcast and multicast.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"GatewayFramesTrendResponse__8102176f16c5":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GwFramesTrend__8102176f16c5"}}},"description":"The response object provides the data of the broadcastMulticast frames and its related error percentage.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"GatewayInterfaceThroughputTrendResponse__b3fc83ccae26":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GwInterfaceThroughputTrend__b3fc83ccae26"}}},"description":"The response object provides throughput trends of a gateway interface.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"GatewayListResponse__51d6c5968454":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayListResponse__51d6c5968454"}}},"description":"List of Gateways, along with their details and associated pagination information.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"GatewayMemTrendResponse__77dda74866ce":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GwMemTrend__77dda74866ce"}}},"description":"The response object provides memory utilization trends of gateway.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"GatewayModemStatsResponse__e46fc9dcc985":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GwModemStats__e46fc9dcc985"}}},"description":"The response object provides modem stats for the specified gateway.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"GatewayPortListResponse__b0584996a91f":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayPortListResponse__b0584996a91f"}}},"description":"Object containing information about the wired interfaces present in the gateway.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"GatewayPortResponse__988495a6329d":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayPortResponse__988495a6329d"}}},"description":"Object containing information about the physical ports in a gateway.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"GatewayProbeListResponse__cded6adac170":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GwProbeList__cded6adac170"}}},"description":"The response object provides a list of probes that are available for the uplink.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"GatewayProbePerformanceResponse__3b1a72220c8c":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GwProbePerformanceTrends__3b1a72220c8c"}}},"description":"The response object provides the performance trends of the uplink probe.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"GatewayResponse__3b77411f6985":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayResponse__3b77411f6985"}}},"description":"Object containing information about the gateway, such as MAC address, name, status, uplinks, ports, and VLANs.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"GatewayTempTrendResponse__4ea249a3349f":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GwTempTrend__4ea249a3349f"}}},"description":"The response object provides hardware temperature trends of gateway.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"GatewayTunnelDetailResponse__2ca376caec3f":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTunnelDetailResponse__2ca376caec3f"}}},"description":"Object containing details about a tunnel configured in the gateway.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"GatewayTunnelHealthSummaryResponse__7df654afe471":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTunnelHealthSummaryResponse__7df654afe471"}}},"description":"Object containing information about the health summary of tunnels present in the gateway.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"GatewayTunnelListResponse__d4fec30749ee":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayTunnelListResponse__d4fec30749ee"}}},"description":"Object containing information about the tunnels present in the gateway.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"GatewayTunnelPacketsTrendResponse__7b41d1172fa8":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GwTunnelPacketsTrend__7b41d1172fa8"}}},"description":"The response object provides the trend of dropped packets by the tunnel.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"GatewayTunnelStatusTrendResponse__4b0780db8ebd":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GwLanTunnelStatusTrend__4b0780db8ebd"}}},"description":"The response object provides status trends of a gateway tunnel.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"GatewayTunnelThroughputTrendResponse__e0ccaf5b72e7":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GwLanTunnelThroughputTrend__e0ccaf5b72e7"}}},"description":"The response object provides throughput trends of a gateway tunnel.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"GatewayUplVpnAvailResponse__ceaebbdf1a3d":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GwUplVpnAvailTrends__ceaebbdf1a3d"}}},"description":"The response object provides VPN availability trends of the specified gateway uplink.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"GatewayUplWanAvailResponse__ed53668aec87":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GwUplWanAvailTrends__ed53668aec87"}}},"description":"The response object provides WAN availability trends of the specified gateway uplink.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"GatewayUplinkDetailResponse__dff1b4103f68":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayUplinkDetailResponse__dff1b4103f68"}}},"description":"Object containing information about the uplink connected to the gateway.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"GatewayUplinkListResponse__9683aa3d9df6":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayUplinkListResponse__9683aa3d9df6"}}},"description":"Object containing information about the WAN interfaces present in the gateway.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"GatewayUplinkThroughputTrendResponse__21365dd4a16e":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GwUplinkThroughputTrend__21365dd4a16e"}}},"description":"The response object provides throughput trends of a gateway interface.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"GatewayVlanDetailResponse__c99febaf4556":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayVlanDetailResponse__c99febaf4556"}}},"description":"Object containing information about a VLAN configured in the gateway.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"GatewayVlanListResponse__d5538d9e1ebf":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayVlanListResponse__d5538d9e1ebf"}}},"description":"Object containing information about the VLANs present in the gateway.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"GatewayVpnAvailabilityTrendResponse__997aa0335c83":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GwVpnAvailTrend__997aa0335c83"}}},"description":"The response object provides VPN availability trends of a gateway.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"GatewayWanAvailabilityTrendResponse__624829d8bb9e":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GwWanAvailTrend__624829d8bb9e"}}},"description":"The response object provides WAN availability trends of a gateway.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"GatewayWanCompressionTrendResponse__1053ccf03958":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GwWanCompressionTrend__1053ccf03958"}}},"description":"The response object provides the WAN compression trends of a gateway uplink interface.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"GatewayWanTunnelHealthSummaryResponse__6ed6e4998ea3":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GatewayWanTunnelHealthSummaryResponse__6ed6e4998ea3"}}},"description":"Object containing information about the WAN health summary of tunnels present in the gateway.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"GetClientMobilityDetailsResponse__972dd6d46bea":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetClientMobilityDetails__972dd6d46bea"}}},"description":"Response schema for getting client mobility details","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"HardwareTrendsResponse__5cf5b3c37fbc":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/HardwareTrendsResponse__5cf5b3c37fbc"}}},"description":"Object containing hardware trends related to the switch.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"InsightsSchemasResponse__78ccd937f281":{"content":{"application/json":{"examples":{"allSchemas":{"summary":"All insight schemas — no insight-id provided","value":{"count":22,"schemaJson":"{\"701\":{\"analyzer_id\":\"string\",\"category\":\"string\"},\"702\":{\"analyzer_id\":\"string\"}}"}},"singleSchema":{"summary":"Single insight schema for insight-id=702","value":{"count":1,"schemaJson":"{\"702\":{\"analyzer_id\":\"string\",\"category\":\"string\",\"timestamp\":\"long\"}}"}}},"schema":{"$ref":"#/components/schemas/AIOpsInsightsSchemasResult__78ccd937f281"}}},"description":"Insights schema definitions response.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"InterfacePoeResponse__87866266e647":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterfacePoeResponse__87866266e647"}}},"description":"Object containing interface poe related to the switch.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"InterfaceTrendsResponse__0d6bfd060cf2":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InterfaceTrendsResponse__0d6bfd060cf2"}}},"description":"Object containing interface trends related to the switch.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"InternalServerError__000172564380":{"content":{"application/json":{"schema":{"description":"Error details returned from the server.","properties":{"debugId":{"$ref":"#/components/schemas/DebugId__000172564380"},"errorCode":{"description":"Internal error code.","enum":["HPE_GL_NETWORK_SERVICES_WIDS_INTERNAL_SERVER_ERROR","HPE_GL_NETWORK_SERVICES_WIDS_UNKNOWN_ERROR","HPE_GL_NETWORK_SERVICES_WIDS_CLICKHOUSE_DATABASE_ERROR","HPE_GL_NETWORK_SERVICES_WIDS_ARANGODB_DATABASE_ERROR","HPE_GL_NETWORK_SERVICES_WIDS_KAFKA_PUBLISH_ERROR","HPE_GL_NETWORK_SERVICES_WIDS_FILE_STORAGE_ERROR"],"examples":["HPE_GL_NETWORK_SERVICES_WIDS_INTERNAL_SERVER_ERROR"],"type":"string"},"httpStatusCode":{"description":"HTTP status code.","examples":[500],"maximum":500,"minimum":500,"type":"integer"},"message":{"$ref":"#/components/schemas/ErrorMessage__000172564380"}},"required":["errorCode","message","debugId","httpStatusCode"],"type":"object"}}},"description":"Internal Server Error.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"InternalServerError__004689200476":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError__004689200476"}}},"description":"Internal server error.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"InternalServerError__02a6567f3633":{"content":{"application/json":{"example":{"errorCode":"HPE_GL_ERROR_INTERNAL_SERVER_ERROR","message":"An unexpected error occurred."},"schema":{"$ref":"#/components/schemas/ErrorResponse__02a6567f3633"}}},"description":"Internal Server Error. An unexpected error occurred on the server.","headers":{"X-RateLimit-Limit":{"description":"Request limit per hour.","schema":{"format":"int64","maximum":9223372036854776000,"minimum":0,"type":"integer"}},"X-RateLimit-Remaining":{"description":"The number of requests left for the time window.","schema":{"format":"int64","maximum":9223372036854776000,"minimum":0,"type":"integer"}},"X-RateLimit-Reset":{"description":"The date-time (RFC 3339 timestamp in UTC+0) at which the current rate limit window resets.","schema":{"format":"date-time","maxLength":20,"type":"string"}}}},"InternalServerError__0c2a95c4aa99":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErrorDetails__0c2a95c4aa99"}}},"description":"Internal server error.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"InternalServerError__66b457073e9b":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError__66b457073e9b"}}},"description":"Internal server error.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"InternalServerError__6ff1f6639f14":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerError__6ff1f6639f14"}}},"description":"Internal server error.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"IsolatedDevicesResponse__beb9b17f8005":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IsolatedNodes__beb9b17f8005"}}},"description":"Success","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"LaSitesInsightsResponseForAPI__f20300aab7a0":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LaSitesInsightsResponseForAPI__f20300aab7a0"}}},"description":"Object containing the location analytics insights for each site.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"LaTrendsResponseForAPI__0052b7c55291":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LaTrendsResponseForAPI__0052b7c55291"}}},"description":"Object containing the location analytics trends.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"ListClientsResponse__b58ef4da0e1a":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListClients__b58ef4da0e1a"}}},"description":"Response schema for listing clients","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"ListEventsResponse__15b755dc22d8":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventList__15b755dc22d8"}}},"description":"Response schema for listing events","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit__09b903e67f2b"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/XRateLimitReset__02a6567f3633"}}},"ListReportRunsResponse__c419fe321fd2":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListReportRuns__c419fe321fd2"}}},"description":"List Report runs Response \n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"ListReportsResponse__7d827151e05e":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListReports__7d827151e05e"}}},"description":"List Report Response \n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"ListTenantsResponse__6ff1f6639f14":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListTenantsResponse__6ff1f6639f14"}}},"description":"List of tenants for an MSP. It includes details like tenant name, tenant CID, sites count, devices count with health status, alerts count, etc.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"NeighboursResponse__f6c586a7da1c":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Neighbours__f6c586a7da1c"}}},"description":"Success","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"NoAPsFound__cb302d396c40":{"content":{"application/json":{"schema":{"description":"Error details returned from the server.\n","properties":{"debugId":{"description":"Internal debug id.\n","examples":["e5b61232-83c8-401a-8e14-a4c75b4fb745"],"format":"const","maxLength":128,"type":"string"},"errorCode":{"description":"Internal error code.\n","enum":["HPE_GL_NETWORK_SERVICES_RFGRAPH_NOT_FOUND"],"examples":["HPE_GL_NETWORK_SERVICES_RFGRAPH_NOT_FOUND"],"maxLength":32,"type":"string"},"httpStatusCode":{"description":"HTTP status code.\n","examples":[404],"maximum":404,"minimum":404,"type":"integer"},"message":{"description":"Error message indicating the cause of the failure.\n","examples":[{"error_msg":"siteId or floorId for tenantId cid1234567890 are invalid or no APs are assigned to the floor 00000000-0000-0000-0000-000000000002"}],"format":"const","maxLength":512,"type":"string"}},"required":["errorCode","message","debugId","httpStatusCode"],"type":"object"}}},"description":"No APs found to start scan.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit__09b903e67f2b"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"NotFoundError__0052b7c55291":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error404__0052b7c55291"}}},"description":"Not Found error","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"NotFoundError__0288a339fc72":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error404__0288a339fc72"}}},"description":"Not Found error","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/XRateLimitLimitHeader__0288a339fc72"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/XRateLimitRemainingHeader__0288a339fc72"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"NotFoundError__0c2a95c4aa99":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundErrorDetails__0c2a95c4aa99"}}},"description":"The requested resource was not found.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"NotFoundError__1335a419f403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError__1335a419f403"}}},"description":"Not Found error.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit__09b903e67f2b"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/XRateLimitReset__02a6567f3633"}}},"NotFoundError__66b457073e9b":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError__66b457073e9b"}}},"description":"Not Found error","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"NotFoundError__6ff1f6639f14":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError__6ff1f6639f14"}}},"description":"Not Found error","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"NotFound__01cfa36ad727":{"content":{"application/json":{"schema":{"description":"Error details returned from the server.","properties":{"errorCode":{"description":"Resource not found error code","enum":["HPE_GL_ERROR_NOT_FOUND"],"example":["HPE_GL_ERROR_NOT_FOUND"],"maxLength":256,"type":"string"},"httpStatusCode":{"description":"HTTP status code","example":[404],"maximum":404,"minimum":404,"type":"integer"},"message":{"description":"Error message indicating the resource was not found.","example":"Requested resource not found","maxLength":512,"type":"string"}},"required":["errorCode","message","httpStatusCode"],"type":"object"}}},"description":"Requested resource was not found.","headers":{"X-RateLimit-Limit":{"description":"The maximum number of requests allowed per time window","schema":{"$ref":"#/components/schemas/X-RateLimit-Limit__01cfa36ad727"}},"X-RateLimit-Remaining":{"description":"The number of requests remaining in the current time window","schema":{"$ref":"#/components/schemas/X-RateLimit-Remaining__01cfa36ad727"}},"X-RateLimit-Reset":{"description":"The time at which the current rate limit window resets","schema":{"$ref":"#/components/schemas/X-RateLimit-Reset__01cfa36ad727"}}}},"NotFoundasset__8de6ce4ea240":{"content":{"application/json":{"schema":{"description":"Error details returned from the server.","properties":{"debugId":{"description":"Debug ID of the failed request used for troubleshooting.","example":"a53ea9f0efeb99b2a9a52ef9c7e3093b","format":"const","maxLength":1024,"type":"string"},"errorCode":{"description":"A unique machine-friendly, but human-readable identifier for the error. It has prefix HPE_GL_.","enum":["HPE_GL_NETWORK_SERVICES_TAG_DATA_NOT_FOUND"],"example":"HPE_GL_NETWORK_SERVICES_TAG_DATA_NOT_FOUND","format":"const","maxLength":128,"type":"string"},"httpStatusCode":{"description":"HTTP status code.","example":404,"maximum":404,"minimum":404,"type":"integer"},"message":{"description":"Error message indicating the cause of the failure.","example":"Error message","format":"const","maxLength":1024,"type":"string"}},"required":["errorCode","message","debugId","httpStatusCode"],"type":"object"}}},"description":"Resource not found.","headers":{"X-RateLimit-Limit":{"schema":{"$ref":"#/components/schemas/X-RateLimit-Limit__01cfa36ad727"}},"X-RateLimit-Remaining":{"schema":{"$ref":"#/components/schemas/X-RateLimit-Remaining__01cfa36ad727"}},"X-RateLimit-Reset":{"schema":{"$ref":"#/components/schemas/X-RateLimit-Reset__01cfa36ad727"}}}},"NotesConflict__039ba698cb40":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictError__039ba698cb40"}}},"description":"Conflict. Another notes operation is already in progress for this tenant.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"NotificationRuleCreated__4e865062885b":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationRule__4e865062885b"}}},"description":"Notification rule created successfully.","headers":{"Location":{"description":"URI of the newly created notification rule.","schema":{"example":"/network-notifications/v1/notification-rules/3f96ffea-73fe-4a9b-b253-ddc58c76fe25","format":"uri","type":"string"}},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"NotificationRule__75a43303d99b":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationRule__4e865062885b"}}},"description":"Notification rule.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"NotificationRules__4d16a4598b40":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationRules__4d16a4598b40"}}},"description":"List of notification rules.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"OnboardingCountResponse__edc7bc848e84":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OnboardingCountResult__edc7bc848e84"}}},"description":"Top grouped onboarding counts by stage.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"OnboardingReasonsResponse__ec4a680d09ad":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OnboardingReasonsResult__ec4a680d09ad"}}},"description":"Top onboarding reasons by stage.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"OnboardingScoreResponse__540f40c96fc2":{"content":{"application/json":{"examples":{"errorResponseShape":{"summary":"Error shape returned by resolver when score fetch fails","value":{"count":null,"items":null,"overallScore":null}},"siteLevelSingleStage":{"summary":"Site-level score for a single stage","value":{"count":1,"items":[{"score":"77.92","scorePercentage":"77.92%","stage":"assoc"}],"overallScore":"77.92"}},"tenantLevelAllStages":{"summary":"Tenant-level score for all default stages","value":{"count":4,"items":[{"score":"82.13","scorePercentage":"82.13%","stage":"assoc"},{"score":"12.10","scorePercentage":"12.10%","stage":"auth"},{"score":"99.87","scorePercentage":"99.87%","stage":"dhcp"},{"score":"100.00","scorePercentage":"100.00%","stage":"dns"}],"overallScore":"73.53"}}},"schema":{"$ref":"#/components/schemas/OnboardingScoreResult__540f40c96fc2"}}},"description":"Onboarding score details.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"OnboardingStageExportResponse__5359db3f2927":{"content":{"application/json":{"examples":{"stageExport":{"summary":"Stage export response with summary and top delayed/failed groupings","value":{"count":1,"id":"12345","items":[{"data":[{"attempts":"100","delays":"11","failures":"9","success":"80","type":"SUMMARY"},{"accessDevice":["BB:BB:BB:BB:BB:BB"],"authTopServers":["10.1.1.10"],"band":["5"],"clients":["AA:AA:AA:AA:AA:AA"],"topReasons":["AUTH_TIMEOUT"],"type":"DELAY","wlans":["corp-ssid"]},{"accessDevice":["BB:BB:BB:BB:BB:BB"],"authTopServers":["10.1.1.19"],"band":["2","5"],"clients":["AA:AA:AA:AA:AA:AA"],"topReasons":["AUTH_TIMEOUT"],"type":"FAILED","wlans":["corp-ssid"]}],"type":"auth"}],"overallSuccessScore":"77.92","type":"CLIENT_CONNECTIVITY"}}},"schema":{"$ref":"#/components/schemas/OnboardingStageExportResult__5359db3f2927"}}},"description":"Onboarding stage export details.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"PortCollisionsTrendResponse__fcccfb2a0f94":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortCollisionsTrend__fcccfb2a0f94"}}},"description":"The response object contains transmission trend data for Collisions and percentage for a port of an access point.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"PortCrcTrendResponse__f5cda28c0fa4":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortCrcTrend__f5cda28c0fa4"}}},"description":"The response object contains transmission trend data for CRC Errors and percentage for a port of an access point.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"PortFramesTrendResponse__951d038e6e20":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortFramesTrend__951d038e6e20"}}},"description":"The response object contains transmission trend data for Drops, Errors Frames (with percentage) for a port of an access point.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"PortListResponseV1__3db2e3f4369e":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortListResponseV1__3db2e3f4369e"}}},"description":"List of Ports of an access point, along with their details.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"PortThroughputTrendsResponse__05867e444b37":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortThroughputTrend__05867e444b37"}}},"description":"The response object provides throughput trend of an access point port.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"RFChannelQualityTrendResponse__ea71ed8f910a":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RFChannelQualityTrend__ea71ed8f910a"}}},"description":"The response object contains channel quality data for a specified radio.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"RFChannelUtilizationTrendResponse__2226a59a3aaf":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RFChannelUtilizationTrend__2226a59a3aaf"}}},"description":"The response object contains data on radio channel utilization, including percentages for Transmitting (tx), Receiving (rx), and Non-Wi-Fi interference, providing insights into how effectively radio channels are being utilized.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"RFFramesTrendResponse__fc5c7ee1666d":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RFFramesTrend__fc5c7ee1666d"}}},"description":"The response object contains transmission trend data for Drops and Retries Frames for a radio.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"RFNoiseFloorTrendResponse__9d04c74d9734":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RFNoiseFloorTrend__9d04c74d9734"}}},"description":"The response object contains noise floor data for a specified radio.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"RadioListResponseV1__34350f7e707e":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RadioListResponseV1__34350f7e707e"}}},"description":"List of Radios, along with their details and associated pagination information.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"RadioThroughputTrendsResponse__cbb2c3e96d46":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RadioThroughputTrend__cbb2c3e96d46"}}},"description":"The response object provides throughput trend of an access point radio.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"ReportsMetadataResponse__66b457073e9b":{"content":{"application/json":{"examples":{"KPI Sample":{"value":{"createdAt":"2024-01-15T08:00:00.000Z","generation":1,"id":"123e4567-e89b-12d3-a456-426614174000","kpiWidgets":[{"allowedRenderTypes":["DONUT_CHART","TABLE","DONUT_TABLE"],"columns":[{"column":"name","displayName":"Name","optionality":"MANDATORY"},{"column":"count","displayName":"Device Count","optionality":"MANDATORY"},{"column":"totalPercentage","displayName":"Percentage","optionality":"MANDATORY"}],"description":"Vendor Summary","displayName":"Vendor Summary","filters":[{"description":"Global Filter","displayName":"Global","filter":"global","validations":[]},{"description":"Sites Filter","displayName":"Sites","filter":"sites","validations":[{"type":"REQUIRED"}]},{"description":"List of Device Types","displayName":"Device Types","filter":"deviceTypes","validations":[{"type":"REQUIRED"},{"type":"ENUM","values":["access_points","switches","gateways"]}]}],"isTimeSliceEnabled":false,"kpi":"vendorSummary","kpiDescription":"Vendor Summary","kpiDisplayName":"Vendor Summary","kpiWidget":"vendorSummary","reportCategory":"infrastructure","reportName":"Inventory","reportType":"inventory"},{"allowedRenderTypes":["DONUT_CHART","TABLE","DONUT_TABLE"],"columns":[{"column":"name","displayName":"Firmware Version","optionality":"MANDATORY"},{"column":"count","displayName":"Device Count","optionality":"MANDATORY"},{"column":"totalPercentage","displayName":"Percentage","optionality":"MANDATORY"}],"description":"Firmware Summary","displayName":"Firmware Summary","filters":[{"description":"Global Filter","displayName":"Global","filter":"global","validations":[]},{"description":"Sites Filter","displayName":"Sites","filter":"sites","validations":[{"type":"REQUIRED"}]},{"description":"List of Device Types","displayName":"Device Types","filter":"deviceTypes","validations":[{"type":"REQUIRED"},{"type":"ENUM","values":["access_points","switches","gateways"]}]}],"isTimeSliceEnabled":false,"kpi":"firmwareSummary","kpiDescription":"Firmware Summary","kpiDisplayName":"Firmware Summary","kpiWidget":"firmwareSummary","reportCategory":"infrastructure","reportName":"Inventory","reportType":"inventory"}],"type":"network-reporting/reports-meta","updatedAt":"2024-01-15T08:00:00.000Z"}}},"schema":{"$ref":"#/components/schemas/ReportsMetadata__66b457073e9b"}}},"description":"Get Reports Metadata Response \n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"ResponseWithNoContent__b3ff19dfda7f":{"description":"Operation completed successfully with no response.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"ScanNotFound__16fa337a67ef":{"content":{"application/json":{"schema":{"description":"Error details returned from the server.\n","properties":{"debugId":{"description":"Internal debug id.\n","examples":["e5b61232-83c8-401a-8e14-a4c75b4fb745"],"format":"const","maxLength":128,"type":"string"},"errorCode":{"description":"Internal error code.\n","enum":["HPE_GL_NETWORK_SERVICES_RFGRAPH_NOT_FOUND"],"examples":["HPE_GL_NETWORK_SERVICES_RFGRAPH_NOT_FOUND"],"maxLength":32,"type":"string"},"httpStatusCode":{"description":"HTTP status code.\n","examples":[404],"maximum":404,"minimum":404,"type":"integer"},"message":{"description":"Error message indicating the cause of the failure.\n","examples":[{"error_msg":"No result found for tenant cid1234567890"}],"format":"const","maxLength":512,"type":"string"}},"required":["errorCode","message","debugId","httpStatusCode"],"type":"object"}}},"description":"No scan details found.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit__09b903e67f2b"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"ServiceUnavailable__0a8a2717a0c0":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableError__0a8a2717a0c0"}}},"description":"Service unavailable.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"ServiceUnavailable__7006262f8c4c":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableError__0288a339fc72"}}},"description":"Service unavailable.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"ServiceUnavailableapp__7c5b5fe9ca66":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableErrorDetails__4689c9697989"}}},"description":"Service unavailable.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/XRateLimitLimitHeader__0288a339fc72"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/XRateLimitRemainingHeader__0288a339fc72"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"ServiceUnavailabledevice__0288a339fc72":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableError__0288a339fc72"}}},"description":"Service Unavailable. The server cannot process the request due to capacity constraints. Please retry after some time.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"ServiceUnavailabledles__bf1f3740b270":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceUnavailableError__0288a339fc72"}}},"description":"Service Unavailable.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"SiteHealthResponse__0bffa6fb51f5":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteHealth__0bffa6fb51f5"}}},"description":"Success","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"SitesClientHealthResponse__7f65987649fe":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SitesClientHealth__7f65987649fe"}}},"description":"Success","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"SitesDeviceHealthResponse__ac50e32cc892":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SitesDeviceHealth__ac50e32cc892"}}},"description":"Success","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"SitesHealthResponse__edaaa4919013":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SitesHealth__edaaa4919013"}}},"description":"Success","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"SourceRecommendationsResponse__cb479bb6e163":{"content":{"application/json":{"examples":{"globalLevel":{"summary":"Global recommendations when site-id is omitted.","value":{"count":1,"id":"network-notifications/v1/insights","items":[{"category":"Wireless","description":"New firmware recommendation available for 9 access point(s). These upgrades provide new features and bug fixes.","id":"c539f92800ea11edbc10aa7fd39913ac_-1_702_5482_7_1770855661666","impactedSites":[{"impactedClientCount":0,"impactedDeviceCount":0,"siteId":"165678616917","siteName":"Bengaluru (BLR) - Campus"}],"insightId":"702","recordId":"c539f92800ea11edbc10aa7fd39913ac_-1_702_5482_7_1770855661666","siteId":"-1","tenantId":"c539f92800ea11edbc10aa7fd39913ac","timestamp":"1770858000000","title":"Access Point Firmware Recommendation","type":"network-notifications/insight"}],"type":"collection"}},"siteLevelDetailed":{"summary":"Site-level with insight filter and detailed payload","value":{"count":1,"id":"network-notifications/v1/insights","items":[{"category":"Wireless","data":"{\"actions_per_coverage_hole\":[{\"coverage_hole_network_impact\":[{\"coverage_description\":\"Network quality in terms of uplink signal-to-noise ratio (SNR) of?access point BO-IND-AP01?in comparison with all other access points in the site.\",\"proportion_of_client_minutes\":[{\"impacted_ap_proportion_of_client_minutes\":0,\"other_ap_proportion_of_client_minutes\":0,\"snr_inDB\":64}]}],\"devices_per_floor\":[{\"device_list\":[{\"client_type\":\"Debian\",\"client_vendor\":\"Big Field Global PTE. Ltd.\",\"impacted_clients_count\":7,\"oui_year\":\"2023\"}],\"impacted_clients_per_client_type\":[{\"impacted_clients_count\":2,\"name\":\"User Experience Insight Sensor\"}],\"ssid\":\"IND-1X\"},{\"impacted_client_details\":[{\"client_type\":\"User Experience Insight Sensor\",\"client_vendor\":\"Aruba, a Hewlett Packard Enterprise Company\",\"impacted_clients_count\":2,\"oui_year\":\"2022\"}],\"impacted_clients_per_client_type\":[{\"impacted_clients_count\":2,\"name\":\"User Experience Insight Sensor\"},{\"impacted_clients_count\":1,\"name\":\"Apple iPhone\"}],\"ssid\":\"IND-PSK\"}],\"impacted_client_type_details_description\":\"Clients impacted on access point: BO-IND-AP01\",\"impacted_clients_count\":19,\"recommendation\":\"Add AP(s) to sufficiently cover area\",\"root_cause\":\"Low Uplink SNR\"},{\"coverage_hole_network_impact\":[{\"coverage_description\":\"Network quality in terms of downlink 2.4GHz signal-to-noise ratio (SNR) of?access point BO-IND-AP04?in comparison with all other access points in the site.\",\"proportion_of_client_minutes\":[{\"impacted_ap_proportion_of_client_minutes\":0,\"other_ap_proportion_of_client_minutes\":0,\"snr_inDB\":64}]}],\"devices_per_floor\":[{\"device_list\":[{\"device_serial\":\"VNLSK9Y14H\",\"device_tag\":\"coverage_hole_ap\",\"device_type\":\"Access Point\"}],\"floor_id\":\"1.0\"}],\"impacted_ap_name\":\"BO-IND-AP04\",\"impacted_client_type_details\":[{\"impacted_client_details\":[{\"client_type\":\"Unclassified Device\",\"client_vendor\":\"Big Field Global PTE. Ltd.\",\"impacted_clients_count\":1,\"oui_year\":\"2023\"}],\"impacted_clients_per_client_type\":[{\"impacted_clients_count\":1,\"name\":\"Unclassified Device\"}],\"ssid\":\"IND-1X\"},{\"impacted_client_details\":[{\"client_type\":\"Sonos\",\"client_vendor\":\"Sonos, Inc.\",\"impacted_clients_count\":1,\"oui_year\":\"2020\"}],\"impacted_clients_per_client_type\":[{\"impacted_clients_count\":1,\"name\":\"Polycom IP Phone/Conference\"}],\"ssid\":\"IND-PSK\"}],\"impacted_client_type_details_description\":\"Clients impacted on access point: BO-IND-AP04\",\"impacted_clients_count\":19,\"recommendation\":\"Increase minimum transmit power of the AP Group:Radio Profile::Branch Offices IAP:default from 9dBm to 12dBm for 5GHz radio\",\"root_cause\":\"Low Downlink SNR for 5GHz radio\"}],\"analyzer_id\":\"75cdc36000ea11ed98cf1aed776dc866_18567345677_728_26030_2_1775607696334\",\"analyzer_type_id\":\"728\",\"coverage_hole_impact_summary\":[{\"coverage_hole_summary_detail\":{\"description\":\"Impacted APs\",\"downlink_2g_5g_coverage_hole\":0,\"downlink_2g_coverage_hole\":0,\"downlink_5g_coverage_hole\":1,\"healthy_minutes\":0,\"total_count\":2,\"uplink_coverage_hole\":1},\"coverage_hole_summary_type\":\"Impacted APs\"}],\"coverage_hole_network_impact\":[{\"coverage_description\":\"Check below for?network quality?in terms of signal-to-noise ratio (SNR) of the impacted access points relative to other access points in the site.\",\"coverage_type\":\"Overall SNR coverage\",\"proportion_of_client_minutes\":[{\"impacted_ap_proportion_of_client_minutes\":0,\"other_ap_proportion_of_client_minutes\":0,\"snr_inDB\":0}]},{\"coverage_description\":\"Check below for?network quality?in terms of downlink 5GHz signal-to-noise ratio (SNR) of the impacted access points relative to other access points across sites.\",\"coverage_type\":\"Downlink 5GHz SNR coverage\",\"proportion_of_client_minutes\":[{\"impacted_ap_proportion_of_client_minutes\":0,\"other_ap_proportion_of_client_minutes\":0,\"snr_inDB\":64}]},{\"coverage_description\":\"Check below for?network quality?in terms of uplink signal-to-noise ratio (SNR) of the impacted access points relative to other access points in the site.\",\"coverage_type\":\"Uplink SNR coverage\",\"proportion_of_client_minutes\":[{\"impacted_ap_proportion_of_client_minutes\":0,\"other_ap_proportion_of_client_minutes\":0,\"snr_inDB\":64}]}],\"devices_per_floor\":[{\"device_list\":[{\"device_serial\":\"VNLSK9Y14H\",\"device_tag\":\"coverage_hole_ap\",\"device_type\":\"Access Point\"}],\"floor_id\":\"1.0\"}],\"impacted_clients_per_site\":[{\"count\":38,\"name\":\"IWF-BAI01 - Bengaluru - Branch\",\"site_id\":\"18567345677\"}],\"impacted_devices_per_site\":[{\"count\":2,\"name\":\"IWF-BAI01 - Bengaluru - Branch\",\"site_id\":\"18567345677\"}],\"no_of_sites_w_recommendations\":1,\"schema_version\":\"v2\",\"site\":\"IWF-BAI01 - Bengaluru - Branch\",\"is_active\":true,\"user_allow_list\":[],\"derived_policy_rules\":[],\"derived_anomalies_upload\":[],\"derived_anomalies\":[],\"derived_anomalies_new_country_upload\":[],\"derived_anomalies_new_host_access\":[],\"derived_anomalies_excessive_host_access\":[],\"derived_anomalies_suspicious_protocols\":[],\"site_count\":1,\"impacted_app_per_site\":[],\"rollup\":[],\"dfs_channel_summary\":[],\"site_map\":[],\"swap_ap_action\":[],\"ap_coverage_score\":[],\"iap_config_11ax_feature_contrib\":[]}","description":"New firmware recommendation available for 3 access point(s) in the site. These upgrades provide new features and bug fixes.","id":"c539f92800ea11edbc10aa7fd39913ac_6985764272_702_8646_4_1770855661607","insightId":"702","recordId":"c539f92800ea11edbc10aa7fd39913ac_6985764272_702_8646_4_1770855661607","siteId":"6985764272","tenantId":"c539f92800ea11edbc10aa7fd39913ac","timestamp":"1770858000000","title":"Access Point Firmware Recommendation","type":"network-notifications/insight"}],"type":"collection"}}},"schema":{"$ref":"#/components/schemas/AIOpsSourceRecommendationsResult__cb479bb6e163"}}},"description":"Source recommendations list response.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"StackMemberResponse__cfefefc40ef4":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StackMemberResponse__cfefefc40ef4"}}},"description":"Object containing the stack member information","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"SuccessResponse__3f58b16772b5":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListClientLocationsForAPI__3f58b16772b5"}}},"description":"Response returned with a list of Wifi client locations and the associated page information. Users can request the next page based on the information returned.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"SwarmListResponse__eb0984f2beb1":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SwarmListResponse__eb0984f2beb1"}}},"description":"List of swarms, along with their details and associated pagination information.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"SwarmNotFoundError__a3f300af1174":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SwarmNotFoundError__a3f300af1174"}}},"description":"Swarm Not Found error","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"SwarmResponse__a3f300af1174":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SwarmInfo__a3f300af1174"}}},"description":"Object containing information about the swarm, such as cluster name, siteId, conductor information, IP addresses, member count, and software version.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"SwitchHardwareResponse__eb47230c21a4":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SwitchHardwareResponse__eb47230c21a4"}}},"description":"Object containing the switch information","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"SwitchInterfaceResponse__3b087684a285":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SwitchInterfaceResponse__3b087684a285"}}},"description":"Object containing the interfaces information","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"SwitchLagSummaryResponse__e3b5991a5b2b":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SwitchLagSummaryResponse__e3b5991a5b2b"}}},"description":"Object containing the lag summary information","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"SwitchListResponse__c64bceb851d6":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SwitchListResponse__c64bceb851d6"}}},"description":"Object containing list of switches.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"SwitchNotFoundResponse__0d6bfd060cf2":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError__0d6bfd060cf2"}}},"description":"Device with serial number not found.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"SwitchResponse__134f5ffbb7f8":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SwitchResponse__134f5ffbb7f8"}}},"description":"Object containing the switch information","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"SwitchVlanResponse__244c7d3b837e":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SwitchVlanResponse__244c7d3b837e"}}},"description":"Object containing the vlans information.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"TaskNotFound__03efdde95a47":{"content":{"application/json":{"example":{"errorCode":"HPE_GL_ERROR_NOT_FOUND","message":"Async operation task not found: c7a3f2d1-e8a9-4b7c-8d1e-0f9a3b2c1d0e"},"schema":{"$ref":"#/components/schemas/ErrorResponse__02a6567f3633"}}},"description":"Not Found. The specified async task ID or device serial was not found for this operation type.","headers":{"X-RateLimit-Limit":{"description":"Request limit per hour.","schema":{"format":"int64","maximum":9223372036854776000,"minimum":0,"type":"integer"}},"X-RateLimit-Remaining":{"description":"The number of requests left for the time window.","schema":{"format":"int64","maximum":9223372036854776000,"minimum":0,"type":"integer"}},"X-RateLimit-Reset":{"description":"The date-time (RFC 3339 timestamp in UTC+0) at which the current rate limit window resets.","schema":{"format":"date-time","maxLength":20,"type":"string"}}}},"TenantClientHealthResponse__a586e9b21225":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TenantClientHealth__a586e9b21225"}}},"description":"Success","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"TenantDeviceHealthResponse__911671808d98":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TenantDeviceHealth__911671808d98"}}},"description":"Success","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"TenantWlanListResponseV1__bfa0034decee":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TenantWlanListResponseV1__bfa0034decee"}}},"description":"List of WLANs with comprehensive details, including filtering and pagination support.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"ThreatDetailResponse__f8f342aecdae":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThreatDetailResponse__f8f342aecdae"}}},"description":"Object containing information about the threat, such as affected products, attack target, category, CVE reference, description, device MAC, device type, threat ID, impact, malware family, MITRE tags, severity, signature ID, signature name, site ID, site name, source city, source IP, summary and username.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"ThreatListResponse__7006262f8c4c":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThreatListResponse__7006262f8c4c"}}},"description":"A list of threats along with their respective details.\n The list will contain only the latest 20 threats sorted in descending order of occurredAt if no sorting and pagination are applied. Otherwise, it will contain the requested number of threats starting from the given offset, with the default offset value being 0.\n If there is no data, an empty list will be returned.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"TooManyRequests__000172564380":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequests__000172564380"}}},"description":"Too Many Requests. Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"TooManyRequests__004689200476":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequest__004689200476"}}},"description":"Too Many Requests. Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"TooManyRequests__02a6567f3633":{"content":{"application/json":{"example":{"errorCode":"HPE_GL_ERROR_TOO_MANY_REQUESTS","message":"Rate limit exceeded."},"schema":{"$ref":"#/components/schemas/ErrorResponse__02a6567f3633"}}},"description":"Too Many Requests. The user has sent too many requests in a given amount of time.","headers":{"X-RateLimit-Limit":{"description":"Request limit per hour.","schema":{"format":"int64","maximum":9223372036854776000,"minimum":0,"type":"integer"}},"X-RateLimit-Remaining":{"description":"The number of requests left for the time window.","schema":{"format":"int64","maximum":9223372036854776000,"minimum":0,"type":"integer"}},"X-RateLimit-Reset":{"description":"The date-time (RFC 3339 timestamp in UTC+0) at which the current rate limit window resets.","schema":{"format":"date-time","maxLength":20,"type":"string"}}}},"TooManyRequests__0c2a95c4aa99":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsErrorDetails__0c2a95c4aa99"}}},"description":"Too Many Requests. Rate limit exceeded.","headers":{"Retry-After":{"$ref":"#/components/headers/RetryAfter__0c2a95c4aa99"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"TooManyRequests__66b457073e9b":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError__66b457073e9b"}}},"description":"Too Many Requests. Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"TooManyRequests__6ff1f6639f14":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError__6ff1f6639f14"}}},"description":"Too Many Requests. Rate limit exceeded.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"TopAccessPointsByUsageResponse__1ff3457b62c0":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TopAccessPointsResponse__1ff3457b62c0"}}},"description":"A list of access point (AP) serial numbers along with their respective bandwidth usage. The list is sorted in descending order based on bandwidth usage. If there is no data, an empty list will be returned.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"TopNClientsUsageResponse__c21517c4950b":{"content":{"application/json":{"example":{"count":3,"items":[{"clientConnectionType":"Wireless","clientName":"34:1B:9F:BE:40:01","id":"34:1b:9f:be:40:01","macAddress":"34:1b:9f:be:40:01","siteId":2778382,"siteName":"Site-1","type":"network-monitoring/client-monitoring","usage":8339422},{"clientConnectionType":"Wireless","clientName":"D0_94_2A_F8_30_01","id":"d0:94:2a:f8:30:01","macAddress":"d0:94:2a:f8:30:01","siteId":2778392,"siteName":"Site-2","type":"network-monitoring/client-monitoring","usage":7102255},{"clientConnectionType":"Wired","clientName":"36:6C:11:9D:10:01","id":"36:6c:11:9d:10:01","macAddress":"36:6c:11:9d:10:01","siteId":2778342,"siteName":"Site-3","type":"network-monitoring/client-monitoring","usage":6644045}]},"schema":{"$ref":"#/components/schemas/GetTopNClientsByUsageResponse__c21517c4950b"}}},"description":"Response schema for top N clients by usage.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"TopnInterfaceTrendsResponse__f1560a40cf92":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TopnInterfaceTrendsResponse__f1560a40cf92"}}},"description":"Object containing interface trends related to the switches.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"TopologyResponse__b8d35392fbec":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Topology__b8d35392fbec"}}},"description":"Success","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"TunnelNotFoundError__0f1d40c88b6b":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TunnelNotFoundError__0f1d40c88b6b"}}},"description":"Tunnel Not Found error","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"TunnelThroughputTrendsResponse__ed3aa0a73a3f":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TunnelThroughputTrend__ed3aa0a73a3f"}}},"description":"The response object provides throughput trend of an access point tunnel.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"Unauthorized__000172564380":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Unauthorized__000172564380"}}},"description":"Unauthorized request.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"Unauthorized__004689200476":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Unauthorized__004689200476"}}},"description":"Unauthorized request.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"Unauthorized__02a6567f3633":{"content":{"application/json":{"example":{"errorCode":"HPE_GL_ERROR_UNAUTHORIZED","message":"Authentication required."},"schema":{"$ref":"#/components/schemas/ErrorResponse__02a6567f3633"}}},"description":"Unauthorized. Authentication credentials are required or invalid.","headers":{"X-RateLimit-Limit":{"description":"Request limit per hour.","schema":{"format":"int64","maximum":9223372036854776000,"minimum":0,"type":"integer"}},"X-RateLimit-Remaining":{"description":"The number of requests left for the time window.","schema":{"format":"int64","maximum":9223372036854776000,"minimum":0,"type":"integer"}},"X-RateLimit-Reset":{"description":"The date-time (RFC 3339 timestamp in UTC+0) at which the current rate limit window resets.","schema":{"format":"date-time","maxLength":20,"type":"string"}}}},"Unauthorized__0c2a95c4aa99":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorDetails__0c2a95c4aa99"}}},"description":"Unauthorized request.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"Unauthorized__66b457073e9b":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError__66b457073e9b"}}},"description":"Unauthorized request.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"Unauthorized__6ff1f6639f14":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError__6ff1f6639f14"}}},"description":"Unauthorized request.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"UnmanagedDeviceResponse__004689200476":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnmanagedDevice__004689200476"}}},"description":"Success","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"UnprocessableEntity__4e865062885b":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableEntityErrorDetails__4e865062885b"}}},"description":"Unprocessable Entity. The request was well-formed but failed semantic validation.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"UnsupportedMediaType__039ba698cb40":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnsupportedMediaTypeError__039ba698cb40"}}},"description":"Unsupported Media Type. The request payload format is not supported by the server.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"UpdateDeviceNotesResponseV1__2d2b84f6c2b4":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateDeviceNotesData__2d2b84f6c2b4"}}},"description":"Response containing the updated device notes.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"WLANThroughputTrendsResponse__cf469a65323a":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WLANThroughputTrend__cf469a65323a"}}},"description":"The response object provides throughput trend of a WLAN.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"WebhookCreate__c1c7772865ac":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookCreateResponse__c1c7772865ac"}}},"description":"Creating new webhook.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"WebhookDetailsList__2efde5827a74":{"content":{"application/json":{"schema":{"properties":{"count":{"description":"The number of webhooks in the current response.","example":5,"type":"integer"},"items":{"description":"A list of webhooks created by the customer.","items":{"properties":{"authMechanism":{"$ref":"#/components/schemas/AuthMechanism__2efde5827a74"},"createdAt":{"$ref":"#/components/schemas/CreatedAt__2efde5827a74"},"endpoint":{"$ref":"#/components/schemas/Endpoint__2efde5827a74"},"generation":{"$ref":"#/components/schemas/Generation__2efde5827a74"},"id":{"description":"The unique identifier of the webhook.","example":"65f1397c-1137-4f89-9a3b-123456789abc","format":"uuid","type":"string"},"name":{"$ref":"#/components/schemas/Name__2efde5827a74"},"type":{"description":"The type of the resource.","example":"webhook","type":"string"},"updatedAt":{"$ref":"#/components/schemas/UpdatedAt__2efde5827a74"}},"required":["id","type"],"type":"object"},"type":"array"},"totalCount":{"description":"The total number of webhooks available.","example":10,"type":"integer"}},"required":["items","count"],"type":"object"}}},"description":"Returns list of webhooks created by the customer."},"WebhookDetailsResponse__715550e8d02e":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookDetails__715550e8d02e"}}},"description":"Returns webhook details by ID.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"WebhookPatchResponse__fa99fffcc525":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookPatch__fa99fffcc525"}}},"description":"Patches the webhook","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"WebhookRotateHmacKeyResponse__d05e666c56bb":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookRotateHmacKey__d05e666c56bb"}}},"description":"Rotates the webhook HMAC Key","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"WebhookUpdateResponse__d01d12c7fb0d":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookUpdate__d01d12c7fb0d"}}},"description":"Updates the webhook","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"WlanInfoResponse__5247473e8f2a":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WlanInfoWithClientCount__2dcf9a625ef5"}}},"description":"Detailed information about a specific WLAN, including name, primary usage, security level, security, band, status, and VLAN configuration.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"WlanListResponse__2dcf9a625ef5":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WlanListResponse__2dcf9a625ef5"}}},"description":"List of WLANs of an access point, along with their details.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"WlanNotFoundError__5247473e8f2a":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WlanNotFoundError__5247473e8f2a"}}},"description":"WLAN Not Found error","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"getClientDetailsResponse__284f33982989":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientDetails__284f33982989"}}},"description":"Response schema for client details","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}}},"schemas":{"AIOpsGlobalSites__cb479bb6e163":{"properties":{"impactedClientCount":{"example":0,"type":"integer"},"impactedDeviceCount":{"example":0,"type":"integer"},"siteId":{"example":"165678616917","type":"string"},"siteName":{"example":"Bengaluru (BLR) - Campus","type":"string"}},"required":["siteId","siteName","impactedDeviceCount","impactedClientCount"],"type":"object"},"AIOpsInsightsSchemasResult__78ccd937f281":{"properties":{"count":{"description":"Number of insight schemas returned.","example":1,"minimum":0,"type":"integer"},"schemaJson":{"description":"JSON string containing schema definitions keyed by insight ID.","example":"{\"702\":{\"analyzer_id\":\"string\",\"category\":\"string\",\"timestamp\":\"long\"}}","type":"string"}},"required":["schemaJson","count"],"type":"object"},"AIOpsSourceRecommendationsResult__cb479bb6e163":{"properties":{"count":{"example":1,"minimum":0,"type":"integer"},"id":{"description":"Unique identifier for this API resource.","example":"network-notifications/v1/insights","type":"string"},"items":{"items":{"$ref":"#/components/schemas/AIOpsSourceRecommendations__cb479bb6e163"},"type":"array"},"type":{"example":"collection","type":"string"}},"required":["id","type","items","count"],"type":"object"},"AIOpsSourceRecommendations__cb479bb6e163":{"properties":{"category":{"example":"Wireless","type":"string"},"data":{"description":"Complete recommendation payload serialized as a JSON string. Contains detailed information about the recommendation, including root cause analysis, and suggested actions and impacted devices.","example":"{\"analyzer_id\":\"c539f92800ea11edbc10aa7fd39913ac_6985764272_702_8646_4_1770855661607\"}","type":["string","null"]},"description":{"example":"New firmware recommendation available for 3 access point(s) in the site. These upgrades provide new features and bug fixes.","type":"string"},"id":{"description":"Unique identifier for this record.","example":"c539f92800ea11edbc10aa7fd39913ac_6985764272_702_8646_4_1770855661607","type":"string"},"impactedSites":{"items":{"$ref":"#/components/schemas/AIOpsGlobalSites__cb479bb6e163"},"type":"array"},"insightId":{"example":"702","type":"string"},"siteId":{"example":"6985764272","type":"string"},"tenantId":{"example":"c539f92800ea11edbc10aa7fd39913ac","type":"string"},"timestamp":{"example":"1770858000000","type":"string"},"title":{"example":"Access Point Firmware Recommendation","type":"string"},"type":{"example":"network-notifications/insight","type":"string"}},"required":["id","type","timestamp","tenantId","siteId","title","description","category","insightId"],"type":"object"},"APProbeTrend__24d76b0b1476":{"example":{"graph":{"keys":["avg_jitter"],"samples":[{"data":[10],"timestamp":"2022-07-30T20:00:00Z"}],"samplingIntervalInMinutes":5},"id":"AP00000001/tunnels/Tunnel1~Primary","metric":"jitter","type":"network-monitoring/access-point-monitoring"},"properties":{"graph":{"properties":{"keys":{"description":"List of metrics which helps to evaluate the probe trend of an access point.\n","example":["avg_jitter"],"items":{"format":"const","type":"string"},"maxItems":1,"type":"array"},"samples":{"items":{"$ref":"#/components/schemas/GraphDataPoint__05867e444b37"},"maxItems":10000,"type":"array"},"samplingIntervalInMinutes":{"$ref":"#/components/schemas/SamplingIntervalInMinutes__05867e444b37"}},"required":["keys","samples","samplingIntervalInMinutes"],"type":"object"},"id":{"$ref":"#/components/schemas/ID__c0c1228d8f7d"},"metric":{"description":"Metric for the probe trends of an access point.","example":"jitter","format":"const","maxLength":128,"type":"string"},"type":{"$ref":"#/components/schemas/Typeap__05867e444b37"}},"required":["metric","graph","id","type"],"type":"object"},"APPublicIpAddress__da78704f9a76":{"description":"Public IP address of the access point.\n","example":"104.36.250.13","format":"ipv4","maxLength":15,"type":"string"},"APThroughputTrend__0931747ce8ba":{"example":{"graph":{"keys":["tx","rx"],"samples":[{"data":[10,12],"timestamp":"2022-07-30T20:00:00Z"}],"samplingIntervalInMinutes":5},"id":"AP00000001","metric":"ap_throughput","type":"network-monitoring/access-point-monitoring"},"properties":{"graph":{"properties":{"keys":{"description":"List of metrics which helps to evaluate the throughput trend of an access point network or an interface.\n","example":["tx","rx"],"items":{"format":"const","type":"string"},"maxItems":2,"type":"array"},"samples":{"items":{"$ref":"#/components/schemas/GraphDataPoint__05867e444b37"},"maxItems":10000,"type":"array"},"samplingIntervalInMinutes":{"$ref":"#/components/schemas/SamplingIntervalInMinutes__05867e444b37"}},"required":["keys","samples","samplingIntervalInMinutes"],"type":"object"},"id":{"$ref":"#/components/schemas/ID__c0c1228d8f7d"},"metric":{"description":"Metric for the throughput trend of an access point network or interface.","example":"ap_throughput","format":"const","maxLength":128,"type":"string"},"type":{"$ref":"#/components/schemas/Typeap__05867e444b37"}},"required":["metric","graph","id","type"],"type":"object"},"AaaApParsedOutput__840e5db6667e":{"properties":{"authenticationStatus":{"description":"The result of the authentication test.","enum":["Passed","Failed"],"type":"string"},"serverName":{"description":"The name of the RADIUS server tested against.","type":"string"}},"title":"AP AAA RESPONSE","type":"object"},"AaaApRequest__10d7df8bd8fe":{"properties":{"password":{"description":"Password","type":"string"},"serverName":{"description":"Radius Server Name Required","type":"string"},"username":{"description":"Username","type":"string"}},"required":["serverName","username","password"],"title":"AP AAA REQUEST","type":"object"},"AaaApResult__840e5db6667e":{"allOf":[{"$ref":"#/components/schemas/AsyncOperationResultBase__03efdde95a47"},{"properties":{"output":{"allOf":[{"$ref":"#/components/schemas/AaaApParsedOutput__840e5db6667e"}],"type":["object","null"]}},"type":"object"}],"title":"AP AAA RESULT"},"AaaCxParsedOutput__931317077098":{"properties":{"authMethodType":{"description":"The authentication method used.","type":"string"},"authenticationStatus":{"description":"The status of the authentication process.","type":"string"},"radiusServerIp":{"description":"The IP address of the RADIUS server.","type":"string"},"username":{"description":"The username used for authentication.","type":"string"}},"title":"CX AAA RESPONSE","type":"object"},"AaaCxRequest__dbd7deaef1e9":{"properties":{"authMethodType":{"description":"","enum":["chap","pap"],"type":"string"},"password":{"description":"Password","type":"string"},"radiusServerIp":{"description":"RADIUS Server IP Address","type":"string"},"radiusServerPort":{"description":"RADIUS Server Port (1-65535)","maximum":65535,"minimum":1,"type":"integer"},"username":{"description":"Username","type":"string"},"vrfName":{"description":"VRF Name","type":"string"}},"required":["authMethodType","radiusServerIp","username","password"],"title":"CX AAA REQUEST","type":"object"},"AaaCxResult__931317077098":{"allOf":[{"$ref":"#/components/schemas/AsyncOperationResultBase__03efdde95a47"},{"properties":{"output":{"allOf":[{"$ref":"#/components/schemas/AaaCxParsedOutput__931317077098"}],"type":["object","null"]}},"type":"object"}],"title":"CX AAA RESULT"},"AccessPointCPUUtilization__d7f5998ad833":{"example":{"graph":{"keys":["cpu_utilization"],"samples":[{"data":[4.2],"timestamp":"2022-07-30T19:38:16Z"}],"samplingIntervalInMinutes":5},"id":"AP00000001","metric":"cpu_utilization","type":"network-monitoring/access-point-monitoring"},"properties":{"graph":{"properties":{"keys":{"description":"List of metrics which helps to evaluate the cpu utilization trend of an access point.","example":["cpu_utilization"],"items":{"format":"const","type":"string"},"maxItems":10,"type":"array"},"samples":{"items":{"$ref":"#/components/schemas/GraphDataPoint__05867e444b37"},"maxItems":10000,"type":"array"},"samplingIntervalInMinutes":{"$ref":"#/components/schemas/SamplingIntervalInMinutes__05867e444b37"}},"required":["keys","samples","samplingIntervalInMinutes"],"type":"object"},"id":{"$ref":"#/components/schemas/ID__c0c1228d8f7d"},"metric":{"description":"Hardware performance metric for the cpu utilization of an access point.","example":"cpu_utilization","format":"const","maxLength":128,"type":"string"},"type":{"$ref":"#/components/schemas/Typeap__05867e444b37"}},"required":["metric","graph","id","type"],"type":"object"},"AccessPointDHCPPoolListResponseV1__36b9a7c1ff51":{"allOf":[{"properties":{"items":{"items":{"properties":{"availableAddresses":{"description":"Number of available IP addresses in the DHCP pool.\n","example":200,"format":"int64","minimum":0,"type":"integer"},"id":{"$ref":"#/components/schemas/DHCPPoolIdentifier__36b9a7c1ff51"},"leaseDurationInSecs":{"$ref":"#/components/schemas/LeaseDurationInSecs__36b9a7c1ff51"},"poolName":{"description":"Name of the DHCP pool.\n","example":"Pool-Alpha","format":"const","maxLength":128,"type":"string"},"poolSize":{"description":"Total number of IP addresses in the DHCP pool.\n","example":254,"format":"int64","minimum":0,"type":"integer"},"subnet":{"description":"Subnet of the DHCP pool in CIDR notation.\n","example":"192.168.10.0/24","format":"const","maxLength":19,"type":"string"},"type":{"$ref":"#/components/schemas/Typeap__05867e444b37"},"utilization":{"description":"Percentage of IP addresses in use in the DHCP pool.\n","example":21,"format":"int64","maximum":100,"minimum":0,"type":"integer"},"vlan":{"description":"VLAN ID associated with the DHCP pool.\n","example":10,"format":"int64","maximum":4094,"minimum":0,"type":"integer"}},"required":["id","type","poolName"],"type":"object"},"maxItems":1000,"type":"array"}},"required":["items"],"type":"object"},{"$ref":"#/components/schemas/PaginatedResponseap__2dcf9a625ef5"}],"example":{"count":1,"items":[{"availableAddresses":200,"id":"AP00000001/dhcp-pools/Pool-Alpha","leaseDurationInSecs":86400,"poolName":"Pool-Alpha","poolSize":254,"subnet":"192.168.10.0/24","type":"network-monitoring/access-point-monitoring","utilization":21,"vlan":10}],"next":null,"total":1}},"AccessPointListResponse__da78704f9a76":{"allOf":[{"properties":{"items":{"items":{"properties":{"buildingId":{"$ref":"#/components/schemas/BuildingIdap__da78704f9a76"},"clientCount":{"$ref":"#/components/schemas/clientCount__2dcf9a625ef5","description":"The number of wireless clients associated to an Access Point. This field is supported on firmware versions 8.12.x.x and later, as well as 10.6.x.x and later."},"clusterId":{"$ref":"#/components/schemas/ClusterId__54309c5cca60"},"clusterName":{"$ref":"#/components/schemas/ClusterName__3a50015484e1"},"cpuUtilization":{"description":"Represents the percentage of CPU utilization by the access point.\n","example":80,"maxLength":16,"type":"integer"},"deployment":{"$ref":"#/components/schemas/Deploymentap__98bb0f033247"},"deviceFunction":{"$ref":"#/components/schemas/DeviceFunctionap__da78704f9a76"},"deviceGroupId":{"description":"DeviceGroupId property represents the unique identifier for the group to which the device belongs. This identifier is used to group devices that share common characteristics or are part of the same operational group, facilitating easier management and monitoring.\n","example":"8100143262","format":"const","maxLength":16,"type":"string"},"deviceGroupName":{"description":"DeviceGroupName represents the name of the group to which the device belongs. This name is used to categorize and manage devices that share common characteristics or are part of the same operational group.\n","example":"AP Persona group","format":"const","maxLength":256,"type":"string"},"deviceName":{"$ref":"#/components/schemas/DeviceNameap__1ff3457b62c0"},"firmwareVersion":{"$ref":"#/components/schemas/FirmwareVersionap__98bb0f033247"},"floorId":{"$ref":"#/components/schemas/FloorIdap__da78704f9a76"},"gatewayClusters":{"description":"List of gateway clusters associated with the AP tunnel.","example":["cluster-alpha","cluster-beta"],"items":{"$ref":"#/components/schemas/GatewayCluster__98bb0f033247"},"type":"array"},"hibernate":{"$ref":"#/components/schemas/Hibernate__98bb0f033247"},"id":{"$ref":"#/components/schemas/ID__c0c1228d8f7d"},"ipv4":{"$ref":"#/components/schemas/IPv4Addressap__98bb0f033247"},"ipv6":{"$ref":"#/components/schemas/IPv6Addressap__98bb0f033247"},"lastRebootReason":{"$ref":"#/components/schemas/LastRebootReason__da78704f9a76"},"lastSeenAt":{"$ref":"#/components/schemas/LastSeenAtap__98bb0f033247"},"macAddress":{"$ref":"#/components/schemas/MacAddressap__54309c5cca60"},"memoryUtilization":{"description":"Represents the percentage of memory utilization by the access point.\n","maxLength":16,"type":"integer"},"meshRole":{"$ref":"#/components/schemas/MeshRole__98bb0f033247"},"model":{"$ref":"#/components/schemas/Modelap__98bb0f033247"},"partNumber":{"$ref":"#/components/schemas/PartNumberap__da78704f9a76"},"powerConsumption":{"description":"Current power drawn by the access point, in watts.\n","example":87,"maxLength":16,"type":"number"},"publicIpv4":{"$ref":"#/components/schemas/APPublicIpAddress__da78704f9a76"},"role":{"$ref":"#/components/schemas/Roleap__98bb0f033247"},"serialNumber":{"$ref":"#/components/schemas/SerialNumberap__1ff3457b62c0"},"siteId":{"$ref":"#/components/schemas/SiteIDap__34350f7e707e"},"siteName":{"$ref":"#/components/schemas/SiteNameap__34350f7e707e"},"status":{"$ref":"#/components/schemas/Statusap__98bb0f033247"},"subnetMask":{"$ref":"#/components/schemas/SubnetMask__98bb0f033247"},"type":{"$ref":"#/components/schemas/Typeap__05867e444b37"},"uptimeInMillis":{"$ref":"#/components/schemas/UptimeInMillisap__98bb0f033247"},"wlanCount":{"$ref":"#/components/schemas/wlanCount__da78704f9a76","description":"The number of SSIDs configured on the access point."}},"required":["serialNumber","macAddress","deviceName","siteId","id","type"],"type":"object"},"maxItems":1000,"type":"array"}},"required":["items"],"type":"object"},{"$ref":"#/components/schemas/PaginatedResponseap__2dcf9a625ef5"}],"example":{"count":1,"items":[{"buildingId":"b1d2bd91-de81-4097-8420-3ca7f87450fd","clientCount":8,"clusterId":"00e6b9e8015c1e1dd8f32d83e39606377a205ba2317015ed76","clusterName":"cluster_1","cpuUtilization":25,"deployment":"Standalone","deviceFunction":"Instant","deviceGroupId":"8100143262","deviceGroupName":"DeviceGroup1","deviceName":"ArubaAP","firmwareVersion":"8.5.2.0_59123","floorId":"16a0aad7-4070-4a19-8a19-fd6b8e1ff012","gatewayClusters":["cluster-alpha","cluster-beta"],"hibernate":false,"id":"AP00000001","ipv4":"114.191.59.254","ipv6":"2001:0db8:85a3:0000:0000:8a2e:0370:7334","lastRebootReason":"AP_RELOAD","lastSeenAt":null,"macAddress":"bb:5d:11:85:c0:00","memoryUtilization":11,"meshRole":"Portal","model":"AP-115","partNumber":"JZ336A","powerConsumption":11.891,"publicIpv4":"192.170.12.150","role":"Conductor","serialNumber":"AP00000001","siteId":"1120972196","siteName":"site1","status":"ONLINE","subnetMask":"255.255.255.0","type":"network-monitoring/access-point-monitoring","uptimeInMillis":1702794777,"wlanCount":4}],"next":"2","total":4}},"AccessPointMemoryUtilization__9b696b333a10":{"example":{"graph":{"keys":["memory_utilization"],"samples":[{"data":[56],"timestamp":"2022-07-30T21:00:00Z"}],"samplingIntervalInMinutes":5},"id":"AP00000001","metric":"memory_utilization","type":"network-monitoring/access-point-monitoring"},"properties":{"graph":{"properties":{"keys":{"description":"List of metrics which helps to evaluate the memory utilization trend of an access point.","example":["memory_utilization"],"items":{"format":"const","type":"string"},"maxItems":10,"type":"array"},"samples":{"items":{"$ref":"#/components/schemas/GraphDataPoint__05867e444b37"},"maxItems":10000,"type":"array"},"samplingIntervalInMinutes":{"$ref":"#/components/schemas/SamplingIntervalInMinutes__05867e444b37"}},"required":["keys","samples","samplingIntervalInMinutes"],"type":"object"},"id":{"$ref":"#/components/schemas/ID__c0c1228d8f7d"},"metric":{"description":"Hardware performance metric for the memory utilization of an access point.","example":"memory_utilization","format":"const","maxLength":128,"type":"string"},"type":{"$ref":"#/components/schemas/Typeap__05867e444b37"}},"required":["metric","graph","id","type"],"type":"object"},"AccessPointPort__98bb0f033247":{"description":"Access point interface details\n","properties":{"accessVlan":{"$ref":"#/components/schemas/accessVlan__3db2e3f4369e"},"allowedVlan":{"$ref":"#/components/schemas/allowedVlan__3db2e3f4369e"},"connector":{"$ref":"#/components/schemas/connector__3db2e3f4369e"},"duplex":{"$ref":"#/components/schemas/duplex__3db2e3f4369e"},"isUplink":{"$ref":"#/components/schemas/isUplink__3db2e3f4369e"},"macAddress":{"$ref":"#/components/schemas/portMacAddress__3db2e3f4369e"},"name":{"$ref":"#/components/schemas/portName__3db2e3f4369e"},"nativeVlan":{"$ref":"#/components/schemas/nativeVlan__3db2e3f4369e"},"portIndex":{"$ref":"#/components/schemas/PortIndex__951d038e6e20"},"portStatus":{"$ref":"#/components/schemas/portStatus__3db2e3f4369e"},"speed":{"$ref":"#/components/schemas/speed__3db2e3f4369e"},"vlanMode":{"$ref":"#/components/schemas/vlanMode__3db2e3f4369e"}},"required":["macAddress","name","status"],"type":"object"},"AccessPointPowerConsumption__75dfc6cfa00f":{"example":{"graph":{"keys":["power_consumption"],"samples":[{"data":[56],"timestamp":"2022-07-30T21:00:00Z"}],"samplingIntervalInMinutes":5},"id":"AP00000001","metric":"power_consumption","type":"network-monitoring/access-point-monitoring"},"properties":{"graph":{"properties":{"keys":{"description":"List of metrics which helps to evaluate the power consumption trend of an access point.","example":["power_consumption"],"items":{"format":"const","type":"string"},"maxItems":10,"type":"array"},"samples":{"items":{"$ref":"#/components/schemas/GraphDataPoint__05867e444b37"},"maxItems":10000,"type":"array"},"samplingIntervalInMinutes":{"$ref":"#/components/schemas/SamplingIntervalInMinutes__05867e444b37"}},"required":["keys","samples","samplingIntervalInMinutes"],"type":"object"},"id":{"$ref":"#/components/schemas/ID__c0c1228d8f7d"},"metric":{"description":"Hardware performance metric for the power consumption of an access point.","example":"power_consumption","format":"const","maxLength":128,"type":"string"},"type":{"$ref":"#/components/schemas/Typeap__05867e444b37"}},"required":["metric","graph","id","type"],"type":"object"},"AccessPointRadioListResponseV1__8b147ff96285":{"allOf":[{"properties":{"items":{"items":{"properties":{"band":{"$ref":"#/components/schemas/Band__34350f7e707e"},"bandRange":{"$ref":"#/components/schemas/BandRange__34350f7e707e"},"bandwidth":{"$ref":"#/components/schemas/Bandwidth__34350f7e707e"},"channel":{"$ref":"#/components/schemas/Channel__34350f7e707e"},"channelChangeCount":{"$ref":"#/components/schemas/ChannelChangeCount__34350f7e707e"},"channelQuality":{"$ref":"#/components/schemas/ChannelQuality__34350f7e707e"},"channelUtilization":{"$ref":"#/components/schemas/ChannelUtilization__34350f7e707e"},"clientCount":{"$ref":"#/components/schemas/clientCount__2dcf9a625ef5","description":"The number of wireless clients associated to a radio. This field is supported on firmware versions 8.12.x.x and later, as well as 10.6.x.x and later."},"drops":{"$ref":"#/components/schemas/Drops__34350f7e707e"},"id":{"$ref":"#/components/schemas/RadioIdentifier__2226a59a3aaf"},"macAddress":{"description":"The radio MAC address.\n","example":"11:22:33:44:55:66","format":"const","maxLength":18,"type":"string"},"mode":{"$ref":"#/components/schemas/Mode__34350f7e707e"},"noiseFloor":{"$ref":"#/components/schemas/NoiseFloor__34350f7e707e"},"nonWifiInterference":{"$ref":"#/components/schemas/NonWifiInterference__34350f7e707e"},"power":{"$ref":"#/components/schemas/Power__34350f7e707e"},"powerChangeCount":{"$ref":"#/components/schemas/PowerChangeCount__34350f7e707e"},"radioNumber":{"$ref":"#/components/schemas/RadioNumber__34350f7e707e"},"retries":{"$ref":"#/components/schemas/Retries__34350f7e707e"},"rxUtilization":{"$ref":"#/components/schemas/RxUtilization__34350f7e707e"},"siteId":{"$ref":"#/components/schemas/SiteIDap__34350f7e707e"},"status":{"description":"Represents the operational status of the radio.\n","enum":["UP","DOWN","DISABLED"],"example":"UP","maxLength":10,"type":"string"},"txUtilization":{"$ref":"#/components/schemas/TxUtilization__34350f7e707e"},"type":{"$ref":"#/components/schemas/Typeap__05867e444b37"}},"required":["macAddress","radioNumber","status","band","siteId","id","type"],"type":"object"},"maxItems":100,"type":"array"}},"required":["items"],"type":"object"},{"$ref":"#/components/schemas/PaginatedResponseap__2dcf9a625ef5"}],"example":{"count":1,"items":[{"band":"2.4 GHz","bandRange":"","bandwidth":"20 MHz","channel":"8","channelChangeCount":9,"channelQuality":"99","channelUtilization":"87","clientCount":4,"drops":"14.44","health":"Poor","id":"AP00000001/radios/1","macAddress":"11:22:33:44:55:66","mode":"Client Access","noiseFloor":"-50","nonWifiInterference":"3","power":13,"powerChangeCount":6,"radioNumber":1,"retries":"0","rxUtilization":"41","siteId":"6658275","status":"UP","txUtilization":"21","type":"network-monitoring/access-point-monitoring"}],"next":null,"total":1}},"AccessPointRadio__98bb0f033247":{"description":"Access point radio attributes i.e. radio mac, band, radio status, mode, and antenna.\n","properties":{"antenna":{"description":"The type of antennae.\n","enum":["Internal","External"],"example":"Internal","maxLength":15,"type":"string"},"band":{"description":"The radio band refers to a specified range of frequencies of electromagnetic radiation. Possible values are 2.4 GHz, 5 GHz, 5 GHz Lower Band, 5 GHz Upper Band and 6 GHz.\n","example":"5 GHz","format":"const","maxLength":16,"type":"string"},"bandwidth":{"$ref":"#/components/schemas/Bandwidth__34350f7e707e"},"channel":{"$ref":"#/components/schemas/Channel__34350f7e707e"},"macAddress":{"description":"Radio MAC address.\n","example":"11:22:33:44:66:60","format":"const","maxLength":18,"type":"string"},"mode":{"description":"The type of mode for the radio. For example Client Access, Air Monitor, Mesh Portal, Unknown, and Spectrum Analysis.\n","example":"Client Access","format":"const","maxLength":32,"type":"string"},"power":{"$ref":"#/components/schemas/Power__34350f7e707e"},"radioNumber":{"description":"The radio number within an access point\n","example":0,"format":"int64","maximum":10,"minimum":0,"type":"integer"},"radioStats":{"description":"Radio statistics including channel utilization and noise floor.","properties":{"channelUtilization":{"description":"Channel utilization percentage of the radio.\n","example":35.5,"format":"float","maximum":100,"minimum":0,"type":"number"},"noiseFloor":{"description":"Noise floor level in dBm.\n","example":-95,"format":"int32","type":"integer"}},"type":"object"},"radioType":{"$ref":"#/components/schemas/RadioType__34350f7e707e"},"spatialStream":{"description":"Displays the number of spatial streams. By default, the spatial stream value for Radio 5 GHz is 8x8. When tri-radio mode is enabled, the spatial stream value for both the lower 5 GHz and upper 5 GHz frequency bands is 4x4.\n","example":"2x2:2","format":"const","maxLength":15,"type":"string"},"status":{"description":"The access point radio status.\n","enum":["UP","DOWN","DISABLED"],"example":"UP","maxLength":10,"type":"string"}},"required":["macAddress","band","radioNumber"],"type":"object"},"AccessPointResponse__98bb0f033247":{"example":{"apStats":{"clientCount":20,"cpuUtilization":25.5,"memoryUtilization":45.2},"bandSelection":"Dual band","countryCode":"US","currentUplinkInUse":"Ethernet","defaultGateway":"104.38.250.23 (DHCP)","deployment":"Standalone","deviceName":"ap_1","firmwareVersion":"8.5.2.0_59123","gatewayClusters":["cluster-alpha","cluster-beta"],"hibernate":false,"id":"AP00000001","ipv4":"198.51.100.42","ipv6":"2001:0db8:85a3:0000:0000:8a2e:0370:7334","lastRebootReason":"AP_RELOAD","lastSeenAt":null,"macAddress":"11:22:33:44:55:66","manufacturer":"Aruba","meshRole":"Portal","mode":"Client Access","model":"AP-275","modem":{"accessTechnology":"TDD LTE","band":"TDD B40","bandwidth":"20 MHz","firmwareVersion":"EM12GPAR01A20M4G","iccid":"89918610400322214587","imei":"869710031619392","imsi":"405861081571487","manufacturer":"Aruba","model":"MDM-USB-LTE/R8F34A","simState":"SIM_READY","state":"DISCONNECTED","status":"DISCONNECTED"},"negotiatedPower":"802.3at","notes":"Located in Building A, Floor 2","ports":[{"accessVlan":"1","allowedVlan":"all","connector":"RJ45","duplex":"Auto","macAddress":"11:22:33:44:55:66","name":"eth0","nativeVlan":"1","portIndex":0,"speed":"5 Gbps","status":"UP","vlanMode":"Trunk"}],"publicIpv4":"172.51.100.42","radios":[{"antenna":"Internal","band":"5 GHz","bandwidth":"40 MHz","channel":"36+","macAddress":"11:22:33:44:66:60","mode":"Client Access","power":13,"radioNumber":0,"radioStats":{"channelUtilization":35.5,"noiseFloor":-95},"radioType":"802.11ax","spatialStream":"3x3:3","status":"UP"}],"role":"Conductor","serialNumber":"AP00000001","siteId":"24833497","status":"ONLINE","subnetMask":"255.255.255.0","type":"network-monitoring/access-point-monitoring","uptimeInMillis":1702794777,"wlans":[{"band":"5 GHz","security":"Open","securityLevel":"Captive Portal","status":"ENABLED","vlan":"11","wlanName":"wlan1"}]},"properties":{"apStats":{"$ref":"#/components/schemas/AccessPointStats__98bb0f033247"},"bandSelection":{"description":"The operating band of the access point. Possible values are Dual band, Tri band, Dual 5 GHz, Tri radio, Flexible 5 GHz/6 GHz, or Flexible 2.4 GHz/6 GHz.\n","example":"Dual Band","format":"const","maxLength":25,"type":"string"},"countryCode":{"description":"Country code in which the access point operates.\n","example":"US","format":"const","maxLength":32,"type":"string"},"currentUplinkInUse":{"$ref":"#/components/schemas/CurrentUplinkInUse__98bb0f033247"},"defaultGateway":{"description":"The IP address and the source of default gateway. The possible values for source are 'DHCP' and 'Static'\n","example":"104.38.250.23 (DHCP)","maxLength":64,"type":"string"},"deployment":{"$ref":"#/components/schemas/Deploymentap__98bb0f033247"},"deviceName":{"$ref":"#/components/schemas/DeviceNameap__1ff3457b62c0"},"firmwareVersion":{"$ref":"#/components/schemas/FirmwareVersionap__98bb0f033247"},"gatewayClusters":{"description":"List of gateway clusters associated with the AP tunnel.","example":["cluster-alpha","cluster-beta"],"items":{"$ref":"#/components/schemas/GatewayCluster__98bb0f033247"},"type":"array"},"hibernate":{"$ref":"#/components/schemas/Hibernate__98bb0f033247"},"id":{"$ref":"#/components/schemas/ID__c0c1228d8f7d"},"ipv4":{"$ref":"#/components/schemas/IPv4Addressap__98bb0f033247"},"ipv6":{"$ref":"#/components/schemas/IPv6Addressap__98bb0f033247"},"lastRebootReason":{"description":"last reboot reason description:\n* UNKNOWN:  'Unknown'\n* AP_RELOAD: 'Reload'\n* USER_REBOOT: 'User reboot'\n* WRITE_ERASE_REBOOT: 'Write erase reboot'\n* WRITE_ERASE_ALL_REBOOT: 'Write erase all reboot'\n* IMAGE_SYNC_FAILED: 'Image sync failed'\n* IMAGE_SYNC_SUCCESSFUL: 'Image sync successful'\n* IMAGE_UPGRADE: 'Image upgrade successful'\n* IMAGE_DOWNLOAD_FAILURE: 'Image download failure'\n* OUT_OF_MEMORY: 'Reboot caused by out of memory'\n* DOWN_UPLINK: 'Current uplink down, no useable uplink.'\n* CONDUCTOR_TO_LOCAL: 'Conductor transitioned to local'\n* NETWORK_DISCONNECT_USB_RESET: 'Internet connection lost, reset usb modem'\n* NETWORK_DISCONNECT: 'Internet connection lost'\n* UNREACHABLE_GATEWAY: 'Gateway unreachable'\n* FATAL_EXCEPTION: 'Reboot caused by kernel panic: fatal exception'\n* FATAL_EXCEPTION_IN_INTERRUPT: 'Reboot caused by kernel panic: fatal exception in interrupt'\n* SOFTLOCKUP: 'Reboot caused by kernel panic: softlockup: hung tasks'\n* NTP_SYNC: 'System clock is too far ahead of ntp sync result'\n* BAD_MESH_LINK: 'Mesh link bad. Rebooting mesh point by sapd'\n* MESH_TO_PORTAL: 'Mesh point transitioned to portal'\n* REBOOT_BY_AIRWAVE: 'Reboot by Airwave'\n* AMP_COMMAND: 'Amp'\n* VC_COMMAND: 'VC'\n* REBOOTED_BY_CENTRAL: 'Reboot by Central'\n* CLOUD_MANAGEMENT_COMMAND: 'Cloud management'\n* CLI_COMMAND: 'CLI'\n* CONDUCTOR_IP_FAILURE: 'Failed to get conductor-ip'\n* NON_FIPS: 'Non-fips --> fips'\n* FIPS: 'Fips --> non-fips'\n* TOPOLOGY_CHANGE: 'Rebooting AP due to topology change: hierarchy to flat'\n* AP_DISCONNECTED: 'AP disconnected from Aruba Central'\n* VC_DISCONNECTED: 'Virtual controller disconnected from Aruba Central'\n* COLD_HW_RESET: 'AP reboot caused by cold hw reset(power loss)'\n* POWER_LOSS: 'AP rebooted due to loss power'\n* THERMAL_MODE: 'Reboot due to trigger the cooldown event'\n* OVERHEAT_EVENT: 'Reboot due to trigger the overheat event'\n* PREEMPTED_BY_CONDUCTOR: 'Preempted by provisioned conductor'\n","example":"AP_RELOAD","format":"const","maxLength":256,"type":"string"},"lastSeenAt":{"$ref":"#/components/schemas/LastSeenAtap__98bb0f033247"},"macAddress":{"$ref":"#/components/schemas/MacAddressap__54309c5cca60"},"manufacturer":{"description":"Manufacturer of the access point.\n","example":"Aruba","format":"const","maxLength":32,"type":"string"},"meshRole":{"$ref":"#/components/schemas/MeshRole__98bb0f033247"},"mode":{"description":"The operational mode of the access point. The possible values are : 'Client Access', 'Air Monitor', 'Dedicated Spectrum' and 'Hybrid Spectrum'\n","example":"Client Access","maxLength":18,"type":"string"},"model":{"$ref":"#/components/schemas/Modelap__98bb0f033247"},"modem":{"description":"Access point modem attributes i.e. manufacturer, simState, status,state, model, imei, imsi, iccid, firmwareVersion, accessTechnology and bandwidth.","properties":{"accessTechnology":{"description":"The access technology currently used by the modem.\n","example":"TDD LTE","format":"const","maxLength":32,"type":"string"},"band":{"description":"Cellular network band.\n","example":"TDD B40","format":"const","maxLength":32,"type":"string"},"bandwidth":{"description":"Cellular network bandwidth.\n","example":"20 MHz","format":"const","maxLength":32,"type":"string"},"firmwareVersion":{"description":"The firmware version of the modem.\n","example":"EM12GPAR01A20M4G","format":"const","maxLength":32,"type":"string"},"iccid":{"description":"Integrated Circuit Card Identification.\n","example":"89918610400322214587","maxLength":32,"type":"string"},"imei":{"description":"International Mobile Equipment Identity.\n","example":"869710031619392","maxLength":32,"type":"string"},"imsi":{"description":"International Mobile Subscriber Identity.\n","example":"405861081571487","format":"const","maxLength":32,"type":"string"},"manufacturer":{"description":"Modem manufacturer information.\n","example":"Aruba","format":"const","maxLength":64,"type":"string"},"model":{"description":"The model of the modem.\n","example":"MDM-USB-LTE/R8F34A","format":"const","maxLength":32,"type":"string"},"simState":{"description":"The modem sim state.\n","enum":["SIM_READY","SIM_NOT_READY","DISABLE","SIM_ABSENT","OTHER_STATE"],"example":"SIM_READY","format":"const","maxLength":32,"type":"string"},"state":{"description":"The connection state of the modem, if it is in use or in standby.\n","enum":["CONNECTED","DISCONNECTED","IN_STANDBY","SIM_NOT_READY","OTHER_STATE"],"example":"IN_STANDBY","format":"const","maxLength":16,"type":"string"},"status":{"description":"The status of modem, that if it is online or offline.\n","enum":["CONNECTED","DISCONNECTED"],"example":"DISCONNECTED","format":"const","maxLength":16,"type":"string"}},"type":"object"},"negotiatedPower":{"description":"The power negotiated on the ethernet port of the access point.\n","enum":["802.3bt","802.3af","802.3at","DC power","-"],"example":"802.3at","maxLength":32,"type":"string"},"notes":{"description":"Notes or comments about the access point.\n","example":"Located in Building A, Floor 2","maxLength":512,"type":"string"},"ports":{"description":"List of access point ports","items":{"$ref":"#/components/schemas/AccessPointPort__98bb0f033247"},"maxItems":2147483647,"type":"array"},"publicIpv4":{"description":"IP address logged by servers when the access point device is connected through internet connection.\n","example":"172.51.100.42","format":"ipv4","maxLength":15,"type":"string"},"radios":{"description":"List of access point radios","items":{"$ref":"#/components/schemas/AccessPointRadio__98bb0f033247"},"maxItems":10,"type":"array"},"role":{"$ref":"#/components/schemas/Roleap__98bb0f033247"},"serialNumber":{"$ref":"#/components/schemas/SerialNumberap__1ff3457b62c0"},"siteId":{"$ref":"#/components/schemas/SiteIDap__34350f7e707e"},"status":{"$ref":"#/components/schemas/Statusap__98bb0f033247"},"subnetMask":{"$ref":"#/components/schemas/SubnetMask__98bb0f033247"},"type":{"$ref":"#/components/schemas/Typeap__05867e444b37"},"uptimeInMillis":{"$ref":"#/components/schemas/UptimeInMillisap__98bb0f033247"},"wlans":{"description":"List of WLANs associated with the access point","items":{"$ref":"#/components/schemas/WlanInfo__98bb0f033247"},"type":"array"}},"required":["serialNumber","macAddress","siteId","deviceName","radios","ports","modem","id","type"],"type":"object"},"AccessPointStats__98bb0f033247":{"description":"Access point statistics including CPU utilization, memory utilization, and client count.","properties":{"clientCount":{"$ref":"#/components/schemas/clientCount__2dcf9a625ef5","description":"The number of wireless clients associated to the access point. This field is supported on firmware versions 8.12.x.x and later, as well as 10.6.x.x and later."},"cpuUtilization":{"description":"CPU utilization percentage of the access point.\n","example":25.5,"format":"float","maximum":100,"minimum":0,"type":"number"},"memoryUtilization":{"description":"Memory utilization percentage of the access point.\n","example":45.2,"format":"float","maximum":100,"minimum":0,"type":"number"}},"type":"object"},"AccessPointTunnelDetailResponseV1__0f1d40c88b6b":{"example":{"active":true,"authentication":"SHA-256","cryptoType":"TUNNEL_CRYPTO_TYPE_CERTIFICATE","destinationIpAddress":"11.0.0.1","destinationMacAddress":"00:01:02:03:04:05","destinationName":"GW2","encapsulationType":"IPSec","encryption":"AES","id":"AP00000001/tunnels/c2c_tunnel_01~Primary","inSpi":10933320,"index":"Primary","lastChangeReason":"Uplink Deleted","outSpi":11196835,"peerType":"Gateway","sourceIpAddress":"10.0.0.1","status":"Up","tunnelId":"c2c_tunnel_01~Primary","tunnelName":"c2c_tunnel_01","type":"network-monitoring/access-point-monitoring","uptimeInMillis":3600000},"properties":{"active":{"$ref":"#/components/schemas/TunnelActive__0f1d40c88b6b"},"authentication":{"description":"The authentication method used for the tunnel.","example":"SHA-256","format":"const","maxLength":32,"type":"string"},"cryptoType":{"$ref":"#/components/schemas/CryptoType__0f1d40c88b6b"},"destinationIpAddress":{"$ref":"#/components/schemas/DestinationIpAddress__0f1d40c88b6b"},"destinationMacAddress":{"$ref":"#/components/schemas/DestinationMacAddress__0f1d40c88b6b"},"destinationName":{"$ref":"#/components/schemas/DestinationName__0f1d40c88b6b"},"encapsulationType":{"$ref":"#/components/schemas/EncapsulationType__0f1d40c88b6b"},"encryption":{"description":"The encryption method used for the tunnel.","example":"AES","format":"const","maxLength":32,"type":"string"},"id":{"$ref":"#/components/schemas/TunnelIdentifier__0f1d40c88b6b"},"inSpi":{"description":"The inbound Security Parameter Index (SPI) for the tunnel.","example":10933320,"format":"double","type":"number"},"index":{"$ref":"#/components/schemas/TunnelIndex__0f1d40c88b6b"},"lastChangeReason":{"$ref":"#/components/schemas/TunnelLastChangeReason__0f1d40c88b6b"},"outSpi":{"description":"The outbound Security Parameter Index (SPI) for the tunnel.","example":11196835,"format":"double","type":"number"},"peerType":{"description":"The type of the peer endpoint.","example":"Gateway","format":"const","maxLength":32,"type":"string"},"sourceIpAddress":{"$ref":"#/components/schemas/SourceIpAddress__0f1d40c88b6b"},"status":{"$ref":"#/components/schemas/TunnelStatus__0f1d40c88b6b"},"tunnelId":{"$ref":"#/components/schemas/TunnelId__0f1d40c88b6b"},"tunnelName":{"$ref":"#/components/schemas/TunnelName__0f1d40c88b6b"},"type":{"$ref":"#/components/schemas/Typeap__05867e444b37"},"uptimeInMillis":{"$ref":"#/components/schemas/TunnelUptimeInMillis__0f1d40c88b6b"}},"required":["tunnelName","index","status","active","tunnelId","id","type"],"type":"object"},"AccessPointTunnelListResponseV1__d231f2b75fda":{"allOf":[{"properties":{"items":{"items":{"properties":{"active":{"$ref":"#/components/schemas/TunnelActive__0f1d40c88b6b"},"cryptoType":{"$ref":"#/components/schemas/CryptoType__0f1d40c88b6b"},"destinationIpAddress":{"$ref":"#/components/schemas/DestinationIpAddress__0f1d40c88b6b"},"destinationMacAddress":{"$ref":"#/components/schemas/DestinationMacAddress__0f1d40c88b6b"},"destinationName":{"$ref":"#/components/schemas/DestinationName__0f1d40c88b6b"},"encapsulationType":{"$ref":"#/components/schemas/EncapsulationType__0f1d40c88b6b"},"id":{"$ref":"#/components/schemas/TunnelIdentifier__0f1d40c88b6b"},"index":{"$ref":"#/components/schemas/TunnelIndex__0f1d40c88b6b"},"lastChangeReason":{"$ref":"#/components/schemas/TunnelLastChangeReason__0f1d40c88b6b"},"sourceIpAddress":{"$ref":"#/components/schemas/SourceIpAddress__0f1d40c88b6b"},"status":{"$ref":"#/components/schemas/TunnelStatus__0f1d40c88b6b"},"tunnelId":{"$ref":"#/components/schemas/TunnelId__0f1d40c88b6b"},"tunnelName":{"$ref":"#/components/schemas/TunnelName__0f1d40c88b6b"},"type":{"$ref":"#/components/schemas/Typeap__05867e444b37"},"uptimeInMillis":{"$ref":"#/components/schemas/TunnelUptimeInMillis__0f1d40c88b6b"}},"required":["tunnelName","index","status","encapsulationType","tunnelId","id","type"],"type":"object"},"maxItems":1000,"type":"array"}},"required":["items"],"type":"object"},{"$ref":"#/components/schemas/PaginatedResponseap__2dcf9a625ef5"}],"example":{"count":3,"items":[{"active":true,"cryptoType":"TUNNEL_CRYPTO_TYPE_CERTIFICATE","destinationIpAddress":"11.0.0.1","destinationMacAddress":"00:01:02:03:04:05","destinationName":"GW2","encapsulationType":"IPSec","id":"AP00000001/tunnels/c2c_tunnel_01~Primary","index":"Primary","lastChangeReason":"Uplink Deleted","sourceIpAddress":"10.0.0.1","status":"Up","tunnelId":"c2c_tunnel_01~Primary","tunnelName":"c2c_tunnel_01","type":"network-monitoring/access-point-monitoring","uptimeInMillis":3600000}],"next":null,"total":3}},"AccessPointWLANIdentifier__91253e313aa9":{"description":"Primary identifier of a WLAN under an access point.\n","example":"AP00000001/wlans/wlans1","format":"const","maxLength":36,"type":"string"},"AccessPointWLANThroughputTrend__91253e313aa9":{"example":{"graph":{"keys":["tx","rx"],"samples":[{"data":[10,12],"timestamp":"2022-07-30T20:00:00Z"}],"samplingIntervalInMinutes":5},"id":"AP00000001/wlans/wlan1","metric":"wlan_throughput","type":"network-monitoring/access-point-monitoring"},"properties":{"graph":{"properties":{"keys":{"description":"List of metrics which helps to evaluate the throughput trend of an access point WLAN.\n","example":["tx","rx"],"items":{"format":"const","type":"string"},"maxItems":2,"type":"array"},"samples":{"items":{"$ref":"#/components/schemas/GraphDataPoint__05867e444b37"},"maxItems":10000,"type":"array"},"samplingIntervalInMinutes":{"$ref":"#/components/schemas/SamplingIntervalInMinutes__05867e444b37"}},"required":["keys","samples","samplingIntervalInMinutes"],"type":"object"},"id":{"$ref":"#/components/schemas/AccessPointWLANIdentifier__91253e313aa9"},"metric":{"description":"Metric for the throughput trend of an access point WLAN.","example":"wlan_throughput","format":"const","maxLength":128,"type":"string"},"type":{"$ref":"#/components/schemas/Typeap__05867e444b37"}},"required":["metric","graph","id","type"],"type":"object"},"Accuracy__3f58b16772b5":{"description":"Indicates the radius of horizontal uncertainty, computed at 95%. This means the sum of the probability of potential locations contained in this uncertainty circle represents 95% of the whole venue probability. The unit of this radius is in metres.\n","example":25.2,"format":"float","type":"number"},"ActionInitiatedStatus__11d6968be580":{"properties":{"startTime":{"description":"ISO 8601 timestamp indicating when the action was initiated.","format":"date-time","type":"string"},"status":{"description":"The initial status of the action.","enum":["INITIATED"],"type":"string"}},"required":["startTime","status"],"title":"Action Initiation Response","type":"object"},"Action__13edfa6d725b":{"description":"Brief text specifying the executed operation.\n","example":"Scope unmapped","maxLength":256,"type":"string"},"Action__7006262f8c4c":{"description":"The action taken on the threat.\n","examples":["ALLOWED"],"maxLength":32,"type":"string"},"Address__edaaa4919013":{"properties":{"address":{"example":"HPE Mahadevpura","type":"string"},"city":{"example":"Bangalore","type":"string"},"country":{"example":"India","type":"string"},"state":{"example":"Karnataka","type":"string"},"zipCode":{"example":"560048","type":"string"}},"type":"object"},"AffectedProducts__f8f342aecdae":{"description":"The products affected by the threat.\n","examples":["Web_Server_Applications"],"maxLength":128,"type":"string"},"AlertActionResponseBody__0c2a95c4aa99":{"description":"Response body for alert action operations.\n","properties":{"location":{"description":"URL to check the status of the asynchronous operation.\n","example":"/network-notifications/v1/alerts/async-operations/abc123-def456-ghi789","type":"string"},"response":{"description":"Response message indicating the action was accepted.\n","example":"Request accepted","type":"string"},"taskId":{"description":"Unique task identifier for tracking the asynchronous operation.\n","example":"abc123-def456-ghi789","type":"string"}},"type":"object"},"AlertActionStatusResponseBody__4774edd10512":{"description":"Response body for alert action status.\n","properties":{"endedAt":{"description":"Timestamp when the operation ended.\n","example":"2026-02-23T10:31:00Z","format":"date-time","type":"string"},"error":{"$ref":"#/components/schemas/AsyncOperationError__4774edd10512"},"id":{"description":"Unique identifier for this async operation resource.\n","example":"network-notifications/v1/alerts/action-status","type":"string"},"logMessages":{"description":"Log messages associated with the operation.\n","items":{"$ref":"#/components/schemas/LogMessage__4774edd10512"},"type":"array"},"progressPercent":{"description":"The progress percentage of the operation.\n","example":100,"maximum":100,"minimum":0,"type":"integer"},"sourceResourceUri":{"description":"The URI of the source resource associated with this operation.\n","example":"/network-notifications/v1/alerts/clear","type":"string"},"startedAt":{"description":"Timestamp when the operation started.\n","example":"2026-02-23T10:30:00Z","format":"date-time","type":"string"},"state":{"description":"The current state of the asynchronous operation.\n","enum":["PENDING","IN_PROGRESS","SUCCEEDED","FAILED"],"example":"SUCCEEDED","type":"string"},"type":{"description":"Resource type identifier.\n","example":"network-notifications/alert-action-status","type":"string"}},"required":["id","type"],"type":"object"},"AlertConfigResponse__1f9b401b0047":{"description":"A single alert configuration entry returned from the list endpoint.\n","properties":{"category":{"description":"Category the alert belongs to.\n","example":"System","type":"string"},"clearTimeout":{"description":"Auto-clear timeout duration, e.g. `1H`, `30D`.\n","example":"1H","type":"string"},"description":{"description":"Description of what the alert monitors.\n","example":"Triggers when access point CPU usage exceeds configured thresholds.","type":"string"},"deviceType":{"description":"Type of device this alert applies to.\n","example":"Access Point","type":"string"},"enabled":{"description":"Indicates whether this alert configuration is currently active or not.\n","example":true,"type":"boolean"},"inherited":{"description":"Indicates whether this configuration is inherited from a parent scope or not.\n","example":false,"type":"boolean"},"label":{"description":"Display label or tag for the alert configuration.\n","example":"CPU","type":"string"},"name":{"description":"Human-readable name of the alert type.\n","example":"AP CPU Utilization","type":"string"},"ruleSource":{"description":"Indicates whether the rule is system-defined or user-defined.\n","enum":["SYSTEM","USER"],"example":"USER","type":"string"},"rules":{"description":"List of threshold rules for this alert configuration.\n","items":{"$ref":"#/components/schemas/AlertConfigRuleResponse__1f9b401b0047"},"type":"array"},"scopeId":{"description":"The scope identifier this configuration belongs to.\n","example":"1021882040","type":"string"},"scopeType":{"description":"The scope type this configuration belongs to.\n","enum":["GLOBAL","SITE","DEVICE"],"example":"GLOBAL","type":"string"}},"type":"object"},"AlertConfigRuleResponse__1f9b401b0047":{"description":"A rule entry as returned by the list endpoint.\n","properties":{"rule":{"description":"Rule details.\n","properties":{"additionalCondition":{"description":"List of supplementary metric conditions.\n","items":{"properties":{"expression":{"properties":{"metric":{"example":"occurrences","type":"string"},"operator":{"example":"GTE","type":"string"},"valueNumber":{"example":100,"type":"number"}},"type":"object"},"index":{"example":0,"type":"integer"}},"type":"object"},"type":"array"},"condition":{"description":"List of severity-to-threshold conditions.\n","items":{"properties":{"expression":{"properties":{"metric":{"example":"cpu_utilization","type":"string"},"operator":{"example":"GTE","type":"string"},"valueNumber":{"example":90,"type":"number"}},"type":"object"},"severity":{"description":"Severity level for this condition.\n","example":"CRITICAL","type":"string"}},"type":"object"},"type":"array"},"duration":{"description":"Observation window in minutes.\n","example":5,"type":"integer"}},"type":"object"},"ruleNumber":{"description":"Ordering index of this rule.\n","example":0,"type":"integer"}},"type":"object"},"AlertGroup__edaaa4919013":{"properties":{"count":{"example":15,"type":"integer"},"name":{"example":"Critical","type":"string"}},"type":"object"},"AlertListResponse__78d118144c60":{"example":{"count":2,"items":[{"category":"System","clearedReason":null,"createdAt":"2025-12-10T07:04:33.352Z","deviceType":"Access Point","id":"22071893000:47765082406","key":"ad4c9f5b-25d2-37f9-a4ed-fc0e6b0f5825","name":"Insufficient PoE Received","priority":"Very High","severity":"Critical","status":"Cleared","summary":"AP LUHR000001 did not receive the requested PoE power which may limit its functions.","type":"network-notifications/alerts","updatedAt":"2025-12-10T08:37:02.475Z","updatedBy":null},{"category":"System","clearedReason":null,"createdAt":"2025-12-10T08:31:36.710Z","deviceType":"Access Point","id":"22071893000:47764775046","key":"ad4c9f5b-25d2-37f9-a4ed-fc0e6b0f5825","name":"USB Device Removed from AP","priority":"Medium","severity":"Minor","status":"Active","summary":"A USB device was removed from the AP LUHR000012's USB port.","type":"network-notifications/alerts","updatedAt":"","updatedBy":null}],"next":"2","total":85},"properties":{"count":{"description":"Number of alerts returned in the current response.\n","example":1,"type":"integer"},"items":{"description":"List of alerts.\n","items":{"$ref":"#/components/schemas/Alert__78d118144c60"},"type":"array"},"next":{"description":"Specifies the pagination cursor for the next page of resources. Null if there are no further pages.\n","example":[null,1,2,3],"type":"string"},"total":{"description":"Total number of alerts matching the query criteria.\n","example":1,"type":"integer"}},"type":"object"},"Alert__78d118144c60":{"description":"Alert details.\n","properties":{"category":{"description":"Category of the alert.\n","type":"string"},"clearedReason":{"description":"The reason an alert is cleared. This will be populated only when the status is cleared.\n","type":"string"},"createdAt":{"description":"Timestamp when the alert was created.\n","format":"date-time","type":"string"},"deviceType":{"description":"Type of device associated with the alert.\n","type":"string"},"id":{"description":"Unique identifier for the alert.\n","type":"string"},"key":{"description":"Alert key.\n","type":"string"},"name":{"description":"Name of the alert.\n","type":"string"},"priority":{"description":"Priority level of the alert.\n","type":"string"},"severity":{"description":"Severity level of the alert.\n","type":"string"},"status":{"description":"Current status of the alert.\n","type":"string"},"summary":{"description":"Summary description of the alert.\n","type":"string"},"type":{"description":"Type of the resource.\n","type":"string"},"updatedAt":{"description":"Timestamp when the alert was last updated.\n","format":"date-time","type":"string"},"updatedBy":{"description":"Identifier of the user who last updated the alert.\n","type":"string"}},"required":["id","key","category","name","severity","priority","status","summary","createdAt","updatedAt","updatedBy","type","deviceType","clearedReason"],"type":"object"},"AlertsClassificationResponseBody__7688f37a490e":{"description":"Response body for alerts classification.\n","properties":{"classificationData":{"description":"List of classification data entries.\n","items":{"$ref":"#/components/schemas/ClassificationDataItem__7688f37a490e"},"type":"array"},"type":{"description":"The type of classification used.\n","example":"category","type":"string"}},"type":"object"},"Altitude__6a214df6704a":{"description":"Describes a vertical elevation.\n","properties":{"elevation":{"description":"The elevation in meters in relation to the vertical datum identified by the \"elevationType\" field, with negative values indicating elevations below it.\n","examples":[18],"maximum":9999999,"minimum":0,"type":["number"]},"elevationType":{"description":"Identifies the vertical datum used to measure the device elevation.\n* 'ABOVE_MEAN_SEA_LEVEL' - Above Mean Sea Level, the elevation in meters in relation to the zero set by the vertical WGS 84 datum\n* 'ABOVE_GROUND_LEVEL'  - Above Ground Level, the elevation in meters above the local ground level\n* 'UNKNOWN' - The elevation type is unknown\n","enum":["ABOVE_MEAN_SEA_LEVEL","ABOVE_GROUND_LEVEL","UNKNOWN"],"examples":["ABOVE_GROUND_LEVEL"],"type":["string"]},"elevationUncertainty":{"description":"The elevation uncertainty in meters above and below the value specified in the \"elevation\" field.\n\nThe value 0 is reserved to indicate that the elevation uncertainty is unknown.\n","examples":[0],"maximum":9999999,"minimum":0,"type":["number"]}},"required":["elevationType","elevation","uncertainty"],"type":"object"},"AnchorGeometry__e40c06be8034":{"description":"anchor geometry values","properties":{"geoCoordinates":{"$ref":"#/components/schemas/GeoPoint__e40c06be8034"},"relativeCoordinates":{"$ref":"#/components/schemas/Point__e40c06be8034"}},"type":"object"},"Antenna__34350f7e707e":{"description":"Antenna type of the radio. Possible values are Internal or External.\n","example":null,"maxLength":16,"type":"string"},"ApRangingScanDeleteResponse__16fa337a67ef":{"description":"The result of the delete ftm scan request.\n\nSUCCESS - Scan was deleted (or was already completed).\nINVALID_SCAN_STATE - Scan could not be deleted because it has already been scheduled or started.\n","properties":{"result":{"enum":["SUCCESS","INVALID_SCAN_STATE"],"examples":["SUCCESS"],"format":"enum","type":"string"}},"type":"object"},"ApRangingScanStatus__306cd00aed2d":{"description":"The details of an ftm scan.\n","properties":{"createdAt":{"$ref":"#/components/schemas/Timestamp__306cd00aed2d","description":"The timestamp of the initial scan request."},"dwellTimeMillis":{"description":"The number of milliseconds that the scan spends on each channel to attempt ranging to other nearby APs.","examples":[90],"format":"uint32","maximum":4294967295,"minimum":1,"type":"integer"},"errorMessage":{"description":"An error message (if applicable). Indicates the reason for the scan failure.","examples":[null],"format":"const","maxLength":256,"type":"string"},"estimatedCompletionTime":{"$ref":"#/components/schemas/Timestamp__306cd00aed2d","description":"The estimated scan completion time and network restoration"},"floorId":{"$ref":"#/components/schemas/FloorIdopen__16fa337a67ef"},"id":{"$ref":"#/components/schemas/SessionId__16fa337a67ef"},"scanStartTime":{"$ref":"#/components/schemas/Timestamp__306cd00aed2d","description":"The estimated start time of the ftm scan and associated network outage."},"scannedChannels":{"items":{"$ref":"#/components/schemas/BandChannelList__306cd00aed2d"},"maxItems":2147483647,"type":"array"},"serialNumbers":{"items":{"$ref":"#/components/schemas/SerialNumberopen__306cd00aed2d"},"maxItems":2147483647,"type":"array"},"siteId":{"$ref":"#/components/schemas/SiteIdopen__16fa337a67ef"},"status":{"$ref":"#/components/schemas/ScanStatus__306cd00aed2d"},"type":{"description":"A string indicating the document type.\n","enum":["FTM_SCAN"],"examples":["FTM_SCAN"],"format":"enum","type":"string"},"updatedAt":{"$ref":"#/components/schemas/Timestamp__306cd00aed2d","description":"The timestamp of the latest ftm scan state change."}},"required":["id","type","createdAt","updatedAt","siteId","floorId","status","serialNumbers","scanStartTime","estimatedCompletionTime","dwellTimeMillis","scannedChannels"],"type":"object"},"ApiKey__715550e8d02e":{"description":"The API key used for API_KEY authentication.","maxLength":1024,"minLength":1,"type":"string"},"AppProto__7006262f8c4c":{"description":"The application protocol of the threat.\n","examples":["HTTP"],"maxLength":64,"type":"string"},"ApplicationCategoryUsageItem__7c5b5fe9ca66":{"description":"Usage statistics for a single application category.\n","properties":{"createdAt":{"description":"Creation timestamp in RFC 3339 format.\n","example":"2024-11-20T14:14:33Z","format":"date-time","type":"string"},"displayName":{"description":"Human-readable application category name.\n","example":"Google","format":"const","maxLength":256,"type":"string"},"generation":{"description":"Monotonically increasing update counter.\n","example":1,"format":"int64","minimum":0,"type":"integer"},"id":{"description":"The unique identifier of the application category.\n","example":"google","format":"const","maxLength":256,"type":"string"},"rxBytes":{"description":"Bytes received by clients for this category.\n","example":5242880,"format":"double","minimum":0,"type":"number"},"txBytes":{"description":"Bytes transmitted from clients for this category.\n","example":1048576,"format":"double","minimum":0,"type":"number"},"type":{"description":"Resource type.\n","example":"network-monitoring/application-category","format":"const","maxLength":64,"type":"string"},"updatedAt":{"description":"Last update timestamp in RFC 3339 format.\n","example":"2024-11-20T14:14:33Z","format":"date-time","type":"string"}},"required":["id","type","generation","createdAt","updatedAt","displayName","txBytes","rxBytes"],"type":"object"},"ApplicationCategoryUsageList__7c5b5fe9ca66":{"description":"Ordered list of application categories by usage.\n","example":{"count":2,"items":[{"createdAt":"2024-11-20T14:14:33Z","displayName":"Google","generation":1,"id":"google","rxBytes":5242880,"txBytes":1048576,"type":"network-monitoring/application-category","updatedAt":"2024-11-20T14:14:33Z"},{"createdAt":"2024-11-20T14:14:33Z","displayName":"Social Media","generation":1,"id":"social","rxBytes":2097152,"txBytes":524288,"type":"network-monitoring/application-category","updatedAt":"2024-11-20T14:14:33Z"}],"offset":0,"total":10},"properties":{"count":{"description":"Number of category entries returned.\n","example":2,"format":"int32","minimum":0,"type":"integer"},"items":{"description":"List of application category usage entries.\n","items":{"$ref":"#/components/schemas/ApplicationCategoryUsageItem__7c5b5fe9ca66"},"maxItems":500,"type":"array"},"offset":{"$ref":"#/components/schemas/Offsetapp__7c5b5fe9ca66"},"total":{"$ref":"#/components/schemas/Totalapp__7c5b5fe9ca66"}},"required":["items","count","total","offset"],"type":"object"},"ApplicationItems__7dced1181a4d":{"description":"This object gives details about the applications and websites.\n","example":{"applicationHostType":"Public","categories":["Social Networking","Social Networking Web"],"certificateExpiryDate":"","destLocation":[{"countryName":"United States"}],"experience":{"groups":[{"count":0,"name":"Poor"},{"count":0,"name":"Fair"},{"count":4,"name":"Good"}]},"id":"244","lastUsedTime":"1725574810044","name":"Facebook","risk":"LOW","rxBytes":82949479,"state":"ALLOWED","tlsVersion":"","txBytes":4615170,"type":"/network-monitoring/applications"},"properties":{"applicationHostType":{"description":"Host type of the application.\n","example":"Public","format":"const","maxLength":256,"type":"string"},"categories":{"description":"List of categories that application belong to.\n","example":["Streaming"],"items":{"format":"const","maxLength":256,"type":"string"},"maxItems":2147483647,"type":"array"},"certificateExpiryDate":{"description":"Date of Expiry of the certificate.\n","example":"1699550427000","format":"const","maxLength":256,"type":"string"},"destLocation":{"description":"Locations where the application or website is hosted.\n","example":[{"countryName":"United States"}],"items":{"type":"object"},"maxLength":205,"type":"array"},"experience":{"description":"The experience of the application or website across the clients.\n","example":{"groups":[{"count":0,"name":"Poor"},{"count":0,"name":"Fair"},{"count":4,"name":"Good"}]},"type":"object"},"id":{"description":"The unique identifier of the application or website.\n","example":"169","format":"const","maxLength":13,"type":"string"},"lastUsedTime":{"description":"The last used timestamp of the application or website.\n","example":"1699550427000","format":"const","maxLength":13,"type":"string"},"name":{"description":"The name of the application or website.\n","example":"Facebook","format":"const","maxLength":256,"type":"string"},"risk":{"description":"The security risk of the application.\n","example":"LOW","format":"const","maxLength":256,"type":"string"},"rxBytes":{"description":"Received bytes.\n","example":123456789,"format":"int64","maximum":9223372036854776000,"minimum":0,"type":"integer"},"state":{"description":"String representing whether the application was allowed or blocked.\n","example":"allowed","format":"const","maxLength":7,"type":"string"},"tlsVersion":{"description":"The TLS server version.\n","example":"TLSv1.2","format":"const","maxLength":256,"type":"string"},"txBytes":{"description":"Transmitted bytes.\n","example":123456789,"format":"int64","maximum":9223372036854776000,"minimum":0,"type":"integer"},"type":{"description":"Resource type.\n","example":"network-monitoring/applications","format":"const","maxLength":13,"type":"string"}},"required":["type","id"],"type":"object"},"ApplicationsResponse__7dced1181a4d":{"description":"List of applications and websites.\n","example":{"count":1,"items":[{"applicationHostType":"Public","categories":["Social Networking","Social Networking Web"],"certificateExpiryDate":"","destLocation":[{"countryName":"United States"}],"experience":{"groups":[{"count":0,"name":"Poor"},{"count":0,"name":"Fair"},{"count":4,"name":"Good"}]},"id":"244","lastUsedTime":"1725574810044","name":"Facebook","risk":"LOW","rxBytes":82949479,"state":"ALLOWED","tlsVersion":"","txBytes":4615170,"type":"/network-monitoring/applications"}],"next":"NyBErRdk6czGUyDAX5Cp","total":256},"maxItems":1000,"properties":{"count":{"$ref":"#/components/schemas/Countapp__7dced1181a4d"},"items":{"items":{"$ref":"#/components/schemas/ApplicationItems__7dced1181a4d"},"type":"array"},"next":{"$ref":"#/components/schemas/Next__21874c7bfa12"},"offset":{"$ref":"#/components/schemas/Offsetapp__7c5b5fe9ca66"},"total":{"$ref":"#/components/schemas/Totalapp__7c5b5fe9ca66"}},"required":["items","next","count","total"],"type":"object"},"AssetTagImageResponse__bd05c508a545":{"description":"Response body returned after a successful asset tag image upload.","properties":{"id":{"$ref":"#/components/schemas/DeviceId__8de6ce4ea240"},"type":{"description":"Resource type.","example":"network-services/asset-tags","format":"const","maxLength":64,"type":"string"}},"required":["id","type"],"type":"object"},"AssignedAps__8ac069ee99d0":{"allOf":[{"$ref":"#/components/schemas/PaginationResponseProperties__4ee94b04d313"},{"properties":{"items":{"items":{"properties":{"deviceName":{"description":"device name\n","example":"AP 001","format":"const","maxLength":128,"type":"string"},"id":{"description":"Device serial number.\n","example":"AP00000001","format":"const","maxLength":16,"type":"string"},"ipAddress":{"format":"ipv4","maxLength":15,"type":"string"},"macAddress":{"example":"11:22:33:44:55:66","format":"const","maxLength":18,"type":"string"},"model":{"example":"AP-635","format":"const","maxLength":32,"type":"string"},"partNumber":{"description":"device part number\n","example":"JX973A","format":"const","maxLength":12,"type":"string"},"serialNumber":{"description":"Device serial number.\n","example":"AP00000001","format":"const","maxLength":16,"type":"string"},"state":{"example":"ASSOCIATED","format":"const","maxLength":32,"type":"string"},"type":{"enum":["Access Point","Switch","Gateway"],"type":"string"}},"required":["id","type","deviceName","accesspointProperties"],"type":"object"},"maxItems":9999,"type":"array"},"response":{"$ref":"#/components/schemas/response__4ee94b04d313"}},"required":["response","items"],"type":"object"}],"type":"object"},"AssociatedBssid__3f58b16772b5":{"description":"Provides the associated BSSID for this client.\n","example":"11:22:33:44:55:77","format":"mac","maxLength":18,"minLength":18,"type":["string","null"]},"Associated__3f58b16772b5":{"description":"Provides Boolean indication of whether this client is associated to an AP.\n","example":true,"type":"boolean"},"AsyncNotesResult__0288a339fc72":{"description":"Status and results of an asynchronous notes update operation.","properties":{"endedAt":{"description":"ISO 8601 timestamp indicating when the operation finished. `null` if not yet finished.","example":"2026-03-25T10:30:05Z","format":"date-time","type":["string","null"]},"error":{"description":"Error details if the entire operation failed. `null` otherwise.","oneOf":[{"$ref":"#/components/schemas/AsyncOperationError__0288a339fc72"},{"type":"null"}]},"failed":{"description":"Number of devices whose notes update failed.","example":1,"format":"int32","minimum":0,"type":"integer"},"id":{"description":"The unique identifier of the asynchronous notes update operation.","example":"550e8400-e29b-41d4-a716-446655440000","type":"string"},"logMessages":{"description":"Chronological log messages describing the progress of the operation.","items":{"$ref":"#/components/schemas/AsyncOperationLogMessage__0288a339fc72"},"type":"array"},"progressPercent":{"description":"Percentage completion of the operation (0–100).","example":100,"format":"int32","maximum":100,"minimum":0,"type":"integer"},"results":{"description":"Detailed per-device results. `null` before processing begins.","oneOf":[{"$ref":"#/components/schemas/NotesOperationResults__0288a339fc72"},{"type":"null"}]},"sourceResourceUri":{"description":"The URI of the resource that initiated the asynchronous operation.","example":"/network-monitoring/v1/device-notes","format":"uri-reference","type":"string"},"startedAt":{"description":"ISO 8601 timestamp indicating when the operation started processing. `null` if not yet started.","example":"2026-03-25T10:30:00Z","format":"date-time","type":["string","null"]},"state":{"$ref":"#/components/schemas/AsyncOperationState__0288a339fc72"},"succeeded":{"description":"Number of devices whose notes were updated successfully.","example":2,"format":"int32","minimum":0,"type":"integer"},"total":{"description":"Total number of devices in the request.","example":3,"format":"int32","minimum":0,"type":"integer"},"type":{"$ref":"#/components/schemas/Typedevice__0288a339fc72"}},"required":["id","type","sourceResourceUri","state","progressPercent","total","succeeded","failed"],"type":"object"},"AsyncOperationError__0288a339fc72":{"description":"Error details when the entire asynchronous operation fails.","properties":{"debugId":{"description":"A unique identifier for debugging and troubleshooting.","example":"78f002e32e0cefba3d8cc94fa8179342","type":"string"},"errorCode":{"description":"Machine-readable error code with HPE_GL_ prefix.","example":"HPE_GL_NETWORK_MONITORING_INTERNAL_SERVER_ERROR","type":"string"},"httpStatusCode":{"description":"HTTP status code of the error.","example":500,"type":"integer"},"message":{"description":"Human-readable error message.","example":"Device with serial number AP00000002 not found.","type":"string"}},"type":"object"},"AsyncOperationError__4774edd10512":{"description":"Error details for a failed async operation.\n","properties":{"code":{"description":"The error code.\n","example":"HPE_GL_ERROR_OPERATION_FAILED","type":"string"},"details":{"description":"Additional details about the error.\n","example":"Alert ID not found","type":"string"},"message":{"description":"The error message.\n","example":"The operation failed due to an internal error.","type":"string"}},"type":"object"},"AsyncOperationLogMessage__0288a339fc72":{"description":"A timestamped log message from the asynchronous operation.","properties":{"message":{"description":"A human-readable log message describing an operation event.","example":"Notes update initiated","type":"string"},"timestamp":{"description":"ISO 8601 timestamp of when the log message was recorded.","example":"2026-03-25T10:30:00Z","format":"date-time","type":"string"}},"required":["message"],"type":"object"},"AsyncOperationResultBase__03efdde95a47":{"properties":{"endTime":{"description":"ISO 8601 timestamp indicating when the operation finished (null if not finished).","format":"date-time","type":["string","null"]},"progressPercent":{"description":"Percentage completion of the operation (0-100).","format":"int32","maximum":100,"minimum":0,"type":"integer"},"startTime":{"description":"ISO 8601 timestamp indicating when the operation was initiated.","format":"date-time","type":"string"},"status":{"description":"The final or current status of the operation.","enum":["INITIATED","RUNNING","COMPLETED","FAILED"],"type":"string"}},"required":["status","progressPercent","startTime"],"title":"Base structure for test GET","type":"object"},"AsyncOperationState__0288a339fc72":{"description":"The state of the asynchronous operation.","enum":["INITIALIZED","RUNNING","SUCCEEDED","FAILED","CANCELLED","TIMEDOUT"],"example":"SUCCEEDED","type":"string"},"AsyncOperationStatus__02a6567f3633":{"properties":{"location":{"description":"The relative URL path to query the status and result of the asynchronous operation.","format":"uri-reference","type":"string"},"startTime":{"description":"ISO 8601 timestamp indicating when the operation was initiated.","format":"date-time","type":"string"},"status":{"description":"The initial status of the operation.","enum":["INITIATED"],"type":"string"}},"title":"Test Initiation Response","type":"object"},"AttackTarget__f8f342aecdae":{"description":"The target of the attack threat\n","examples":["Client_Endpoint"],"maxLength":128,"type":"string"},"AuditDetailResponse__13edfa6d725b":{"example":{"action":"Scope unmapped","auditId":"1a7a4e3d-6ab8-4d34-93cf-7443e0f32bbe","category":"Alert Management","createdAt":"2019-10-12T07:20:50Z","description":"Audit log description","destination":"Global","destinationName":"CX0001066","generation":1,"id":"1a7a4e3d-6ab8-4d34-93cf-7443e0f32bbe","ipAddress":"127.0.0.1","occurredOn":"2019-10-12T07:20:50Z","source":"System","subCategory":"Configuration","type":"audit","updatedAt":"2019-10-12T07:20:50Z"},"properties":{"action":{"$ref":"#/components/schemas/Action__13edfa6d725b"},"auditId":{"$ref":"#/components/schemas/AuditId__13edfa6d725b"},"category":{"$ref":"#/components/schemas/Category__13edfa6d725b"},"createdAt":{"description":"RFC 3339 UTC timestamp when the resource was created.","example":"2019-10-12T07:20:50Z","format":"date-time","maxLength":64,"type":"string"},"description":{"$ref":"#/components/schemas/Description__13edfa6d725b"},"destination":{"$ref":"#/components/schemas/Destination__13edfa6d725b"},"destinationName":{"$ref":"#/components/schemas/DestinationName__13edfa6d725b"},"generation":{"description":"Monotonically increasing update counter.","example":1,"maximum":9223372036854776000,"minimum":0,"type":"integer"},"id":{"description":"Unique identifier of the resource.","example":"1a7a4e3d-6ab8-4d34-93cf-7443e0f32bbe","format":"uuid","maxLength":128,"type":"string"},"ipAddress":{"$ref":"#/components/schemas/IpAddress__13edfa6d725b"},"occurredOn":{"$ref":"#/components/schemas/occurredOn__13edfa6d725b"},"source":{"$ref":"#/components/schemas/Source__13edfa6d725b"},"subCategory":{"$ref":"#/components/schemas/SubCategory__13edfa6d725b"},"type":{"description":"Resource type.","example":"network-services/audit","maxLength":64,"type":"string"},"updatedAt":{"description":"RFC 3339 UTC timestamp when the resource was last updated.","example":"2019-10-12T07:20:50Z","format":"date-time","maxLength":64,"type":"string"}},"required":["id","type","generation","createdAt","updatedAt","category","description","destination","destinationName","auditId","ipAddress","occurredOn","action","source","subCategory"],"type":"object"},"AuditId__13edfa6d725b":{"description":"The audit id of audit.\n","example":"e5b61232-83c8-401a-8e14-a4c75b4fb745","maxLength":128,"type":"string"},"AuditListResponse__3246551a91fd":{"description":"Get audit List belonging to the tenant.","properties":{"count":{"description":"Number of objects returned in the list. Maximum will be page size.","example":[1],"format":"int32","maximum":2147483647,"minimum":0,"type":"integer"},"items":{"items":{"$ref":"#/components/schemas/AuditDetailResponse__13edfa6d725b"},"maxItems":2147483647,"type":"array"},"offset":{"description":"Number of items skipped before the returned results.","example":0,"format":"int32","maximum":2147483647,"minimum":0,"type":"integer"},"total":{"description":"The total number of objects contained in the datastore.\n","example":200,"format":"int64","maximum":9223372036854776000,"minimum":0,"type":"integer"}},"required":["items","count","offset"],"type":"object"},"AuthMechanismRequest__c1c7772865ac":{"description":"The authentication mechanism to be used for the webhook request.","type":"string"},"AuthMechanism__2efde5827a74":{"description":"The authentication mechanism to be used for the webhook.","enum":["API_KEY","OIDC"],"type":"string"},"AuthenticationType__284f33982989":{"description":"Authentication type used by the client to connect with the device.","example":"Captive Portal","type":"string"},"Authentication__2ca376caec3f":{"description":"The authentication method used in the tunnel.\n","enum":["MD5","SHA-1","SHA-2 256","SHA-2 384","SHA-2 512","AES",""],"example":"SHA1","type":"string"},"BadRequestErrorDetails__0c2a95c4aa99":{"description":"Error details returned from the server.","properties":{"debugId":{"$ref":"#/components/schemas/DebugId__0c2a95c4aa99"},"errorCode":{"description":"Internal error code.","example":"HPE_GL_NETWORK_NOTIFICATIONS_BAD_REQUEST","maxLength":128,"type":"string"},"httpStatusCode":{"description":"HTTP status code.","example":400,"maximum":400,"minimum":400,"type":"integer"},"message":{"description":"Error message indicating the cause of the failure.","example":"Invalid input received for notification rule.","maxLength":512,"type":"string"}},"required":["httpStatusCode","errorCode","message","debugId"],"type":"object"},"BadRequestError__004689200476":{"description":"Bad request error details returned from the server.","properties":{"debugId":{"$ref":"#/components/schemas/DebugIdtopology__004689200476"},"errorCode":{"description":"Error code","enum":["HPE_GL_NETWORK_MONITORING_INVALID_INPUT"],"example":"HPE_GL_NETWORK_MONITORING_INVALID_INPUT","maxLength":128,"type":"string"},"httpStatusCode":{"description":"HTTP status code.","example":400,"maximum":400,"minimum":400,"type":"integer"},"message":{"$ref":"#/components/schemas/ErrorMessagedevice__039ba698cb40"}},"required":["httpStatusCode","errorCode","message","debugId"],"type":"object"},"BadRequestError__1335a419f403":{"description":"Bad request error details returned from the server.","properties":{"code":{"description":"Internal service error code.","example":"DOWNSTREAM_SERVICE_ERROR","maxLength":256,"type":"string"},"debugId":{"description":"Debug identifier for troubleshooting.","example":"abc-123-456","maxLength":256,"type":"string"},"errorCode":{"description":"Error code for the specific error.","example":"HPE_GL_NETWORK_EVENTS_INVALID_INPUT","maxLength":256,"type":"string"},"errorType":{"description":"Classification of the error type.","example":"BAD_REQUEST","maxLength":256,"type":"string"},"httpStatusCode":{"description":"HTTP status code.","example":400,"maximum":400,"minimum":400,"type":"integer"},"message":{"description":"Error message describing the issue.","example":"Invalid input parameters provided","maxLength":1024,"type":"string"},"serviceName":{"description":"The name of the service where the error originated.","example":"Events","maxLength":256,"type":"string"}},"required":["httpStatusCode","errorCode","message","debugId"],"type":"object"},"BadRequestError__66b457073e9b":{"description":"Error details returned from the server.\n","properties":{"debugId":{"$ref":"#/components/schemas/DebugId__0288a339fc72"},"errorCode":{"description":"Error code\n","enum":["HPE_GL_NETWORK_REPORTING_INVALID_INPUT"],"examples":["HPE_GL_NETWORK_REPORTING_INVALID_INPUT"],"maxLength":128,"type":"string"},"httpStatusCode":{"description":"HTTP status code.\n","examples":[400],"maximum":400,"minimum":400,"type":"integer"},"message":{"$ref":"#/components/schemas/ErrorMessage__66b457073e9b"}},"required":["httpStatusCode","errorCode","message","debugId"],"type":"object"},"BadRequestError__6ff1f6639f14":{"description":"Error details returned from the server.\n","properties":{"debugId":{"$ref":"#/components/schemas/DebugId__000172564380"},"errorCode":{"description":"Error code\n","enum":["HPE_GL_NETWORK_MSP_INVALID_INPUT"],"example":"HPE_GL_NETWORK_MSP_INVALID_INPUT","maxLength":128,"type":"string"},"httpStatusCode":{"description":"HTTP status code.\n","example":400,"maximum":400,"minimum":400,"type":"integer"},"message":{"$ref":"#/components/schemas/ErrorMessage__6ff1f6639f14"}},"required":["httpStatusCode","errorCode","message","debugId"],"type":"object"},"BadRequestsErrorSchema__0052b7c55291":{"description":"Error details returned from the server.\n","properties":{"debugId":{"$ref":"#/components/schemas/DebugId__000172564380"},"errorCode":{"description":"Error code\n","enum":["HPE_GL_NETWORK_SERVICES_INVALID_INPUT"],"example":"HPE_GL_NETWORK_SERVICES_INVALID_INPUT","maxLength":128,"type":"string"},"errorDetails":{"$ref":"#/components/schemas/ErrorDetails400__0052b7c55291"},"httpStatusCode":{"description":"HTTP status code.\n","example":400,"maximum":400,"minimum":400,"type":"integer"},"message":{"$ref":"#/components/schemas/ErrorMessageap__0f1d40c88b6b"}},"required":["httpStatusCode","errorCode","message","debugId"],"type":"object"},"BandChannelList__306cd00aed2d":{"description":"A list of channels identified by their band, bandwidth, and channel number.","properties":{"band":{"description":"The channel frequency band","enum":["RADIO_BAND_5GHZ","RADIO_BAND_6GHZ"],"examples":["RADIO_BAND_5GHZ"],"type":"string"},"bandwidth":{"description":"The channel bandwidth","enum":["CHANNEL_BW_80MHZ","CHANNEL_BW_160MHZ"],"examples":["CHANNEL_BW_80MHZ"],"type":"string"},"primaryChannelList":{"items":{"$ref":"#/components/schemas/Channel__306cd00aed2d"},"maxItems":214783647,"type":"array"}},"required":["band","bandwidth","primaryChannelList"],"type":"object"},"BandRange__34350f7e707e":{"description":"Defines the range of the frequency band used by the radio.\n","example":"Lower","maxLength":16,"type":"string"},"Band__34350f7e707e":{"description":"Specifies the frequency band on which the radio operates.\n","example":"2.4 GHz","maxLength":16,"type":"string"},"Bandwidth__34350f7e707e":{"description":"Indicates the channel bandwidth.\n","example":"20 MHz","maxLength":32,"type":"string"},"BatteryLevel__a39bf531822f":{"description":"Battery level of the Asset Tag.","example":"75","format":"int","maximum":100,"minimum":0,"type":["integer","null"]},"BssidIdentifier__54309c5cca60":{"description":"Primary identifier for a BSSID in the format serialNumber/bssids/bssid.\n","example":"AP00000001/bssids/11:22:33:44:55:88","format":"const","maxLength":32,"type":"string"},"BssidListResponse__54309c5cca60":{"allOf":[{"properties":{"items":{"items":{"properties":{"bssid":{"$ref":"#/components/schemas/Bssid__54309c5cca60"},"clientCount":{"$ref":"#/components/schemas/clientCount__2dcf9a625ef5","description":"The number of wireless clients associated to a Virtual Access Point. This field is supported on firmware versions 8.12.x.x and later, as well as 10.6.x.x and later."},"clusterId":{"$ref":"#/components/schemas/ClusterId__54309c5cca60"},"deviceName":{"$ref":"#/components/schemas/DeviceNameap__1ff3457b62c0"},"id":{"$ref":"#/components/schemas/BssidIdentifier__54309c5cca60"},"macAddress":{"$ref":"#/components/schemas/MacAddressap__54309c5cca60"},"radioMacAddress":{"$ref":"#/components/schemas/RadioMacAddress__54309c5cca60"},"radioNumber":{"$ref":"#/components/schemas/RadioNumber__34350f7e707e"},"serialNumber":{"$ref":"#/components/schemas/SerialNumberap__1ff3457b62c0"},"siteId":{"$ref":"#/components/schemas/SiteIDap__34350f7e707e"},"siteName":{"$ref":"#/components/schemas/SiteNameap__34350f7e707e"},"type":{"$ref":"#/components/schemas/Typeap__05867e444b37"},"wlanName":{"$ref":"#/components/schemas/WlanName__54309c5cca60"}},"required":["serialNumber","deviceName","macAddress","radioNumber","bssid","siteId","id","type"],"type":"object"},"maxItems":1000,"type":"array"}},"required":["items"],"type":"object"},{"$ref":"#/components/schemas/PaginatedResponseap__2dcf9a625ef5"}],"example":{"count":1,"items":[{"bssid":"11:22:33:44:55:88","clientcount":3,"clusterId":"cluster1","deviceName":"ap_1","id":"AP00000001/bssids/11:22:33:44:55:88","macAddress":"11:22:33:44:55:66","radioMacAddress":"11:22:33:44:55:77","radioNumber":0,"serialNumber":"AP00000001","siteId":"24833497","siteName":"site1","type":"network-monitoring/access-point-monitoring","wlanName":"wlan1"}],"next":"2","total":4}},"Bssid__54309c5cca60":{"description":"Basic Service Set Identifier (BSSID) for wireless events\n","example":"11:22:33:44:55:88","format":"const","maxLength":18,"type":"string"},"Bssid__d67ae4720000":{"description":"BSSID of the Monitored AP","examples":["11:22:33:44:55:66"],"format":"mac","maxLength":17,"minLength":17,"type":"string"},"Bssidclients__284f33982989":{"description":"The BSSID to which the client is connected on the device.","example":"b8:3a:5a:47:29:41","type":"string"},"BuildingAddress__de49ac93aa56":{"description":"Complete address of the building.\n","properties":{"address":{"description":"Street address of the building.\n","example":"123 Main St","maxLength":128,"type":"string"},"city":{"description":"City of the building.\n","example":"Springfield","maxLength":64,"type":"string"},"country":{"description":"Country of the building.\n","example":"USA","maxLength":64,"type":"string"},"state":{"description":"State of the building.\n","example":"IL","maxLength":64,"type":"string"},"zipCode":{"description":"Zip code of the building.\n","example":"62704","maxLength":16,"type":"string"}},"type":"object"},"BuildingCoordinates__de49ac93aa56":{"description":"longitude and latitude","items":{"example":"40.75249839381482","format":"double","type":"number"},"maxItems":2,"minItems":2,"type":"array"},"BuildingId__6a214df6704a":{"description":"Building ID associated with the device in UUID format. Omitted if no specific building is associated with the device.\n","examples":["bld2bd91-de81-4097-8420-3ca7f87450fd"],"format":"uuid","maxLength":256,"type":["string"]},"BuildingId__6b9c5f08b869":{"description":"Building ID associated with the device in UUID format. Omitted if no specific building is associated with the device.","example":"bld2bd91-de81-4097-8420-3ca7f87450fd","format":"uuid","maxLength":256,"type":"string"},"BuildingIdap__da78704f9a76":{"description":"Building ID associated with the access point in UUID format. Omitted if no specific building is associated with the access point.\n","example":"b1d2bd91-de81-4097-8420-3ca7f87450fd","format":"uuid","maxLength":256,"type":"string"},"BuildingIdasset__a39bf531822f":{"description":"Building ID associated with the Asset Tag.","examples":["3b5b-0e6c-4b73-9f6e-4e895a080190"],"format":"uuid","maxLength":128,"type":["string","null"]},"BuildingIdwifi__3f58b16772b5":{"description":"Building ID associated with the client in UUID format. Omitted if no specific building is associated with the client.\n","example":"cfd5dfe0-1476-49b1-ac37-6576801d1124","format":"uuid","maxLength":36,"type":["string","null"]},"BuildingInput__de49ac93aa56":{"description":"BuildingInput used to update a building","properties":{"buildingAddress":{"$ref":"#/components/schemas/BuildingAddress__de49ac93aa56"},"buildingCoordinates":{"$ref":"#/components/schemas/BuildingCoordinates__de49ac93aa56"},"buildingType":{"$ref":"#/components/schemas/BuildingType__de49ac93aa56"},"name":{"description":"Name of the building in which floors are present.\n","example":"Brooke","maxLength":32,"type":"string"},"siteId":{"description":"Site under which the floor will be created.\n","example":"16a-aad7-4070-8a19-fd6b8e1ff012","maxLength":128,"type":"string"}},"required":["name"],"type":"object"},"BuildingName__a39bf531822f":{"description":"The name of the building.","example":"Building A","type":["string","null"]},"BuildingResponse__de49ac93aa56":{"properties":{"buildingId":{"description":"building Id associated with the site in UUID format.\n","example":"123a-aad7-4070-8a19-fd6b8e1ff012","maxLength":128,"type":"string"},"properties":{"properties":{"name":{"format":"string","type":"string"},"siteId":{"type":"string"}},"type":"object"}},"required":["buildingId"],"type":"object"},"BuildingType__de49ac93aa56":{"description":"Type of the building in which floor will be created.\n","enum":["WAREHOUSE","OFFICE","PUBLIC_SPACE"],"example":"OFFICE","type":"string"},"BuildingWithFloorsResponse__b1ad4f23f337":{"properties":{"count":{"description":"The number of objects returned in the current list.","example":1,"format":"int32","maximum":2147483647,"minimum":1,"type":"integer"},"items":{"items":{"properties":{"buildingId":{"description":"building Id associated with the site in UUID format.\n","example":"123a-aad7-4070-8a19-fd6b8e1ff012","maxLength":128,"type":"string"},"floors":{"items":{"$ref":"#/components/schemas/FloorMapResponse__232e2ad4eff8"},"type":"array"},"id":{"description":"id of the building associated with the site commonly in UUID format.\n","example":"3b5b-0e6c-4b73-9f6e-4e895a080190","format":"const","maxLength":128,"type":"string"},"properties":{"properties":{"name":{"format":"string","type":"string"}},"type":"object"},"type":{"description":"API type.\n","example":"feature","format":"const","maxLength":512,"type":"string"}},"required":["id","type"],"type":"object"},"maxItems":100,"type":"array"}},"required":["items","count"],"type":"object"},"CableTestCxCablepairdiagnosticsresult__eca40f050f94":{"properties":{"accuracy":{"description":"The accuracy of the diagnostic measurement.","type":"string"},"length":{"description":"The measured length of the cable.","type":"string"},"pairName":{"description":"The name of the cable pair.","type":"string"},"status":{"description":"The status of the cable pair test.","type":"string"}},"title":"CX CABLE PAIR DIAGNOSTICS","type":"object"},"CableTestCxCabletestrowresult__eca40f050f94":{"properties":{"cablePairDiagnostics":{"description":"Diagnostics for each cable pair.","items":{"$ref":"#/components/schemas/CableTestCxCablepairdiagnosticsresult__eca40f050f94"},"type":"array"},"interfaceName":{"description":"The name of the network interface.","type":"string"},"state":{"description":"The state of the interface.","type":"string"}},"title":"CX CABLE TEST ROW","type":"object"},"CableTestCxParsedOutput__eca40f050f94":{"properties":{"ports":{"description":"The list of ports involved in the cable test.","type":"string"},"results":{"description":"The results for each port.","items":{"$ref":"#/components/schemas/CableTestCxCabletestrowresult__eca40f050f94"},"type":"array"}},"title":"CX CABLE TEST RESPONSE","type":"object"},"CableTestCxRequest__69f41ecbf63b":{"properties":{"ports":{"description":"","type":"array"}},"required":["ports"],"title":"CX CABLE TEST REQUEST","type":"object"},"CableTestCxResult__eca40f050f94":{"allOf":[{"$ref":"#/components/schemas/AsyncOperationResultBase__03efdde95a47"},{"properties":{"output":{"allOf":[{"$ref":"#/components/schemas/CableTestCxParsedOutput__eca40f050f94"}],"type":["object","null"]}},"type":"object"}],"title":"CX CABLE TEST RESULT"},"CableTestHppcCablepairdiagnosticsresult__66f350adb118":{"properties":{"length":{"description":"The measured length of the cable.","type":"string"},"pairName":{"description":"The name of the cable pair.","type":"string"},"status":{"description":"The status of the cable pair test.","type":"string"}},"title":"AOS-S CABLE PAIR DIAGNOSTICS","type":"object"},"CableTestHppcCabletestrowresult__66f350adb118":{"properties":{"cablePairDiagnostics":{"description":"Diagnostics for each cable pair.","items":{"$ref":"#/components/schemas/CableTestHppcCablepairdiagnosticsresult__66f350adb118"},"type":"array"},"interfaceName":{"description":"The name of the network interface.","type":"string"}},"title":"AOS-S CABLE TEST ROW","type":"object"},"CableTestHppcParsedOutput__66f350adb118":{"properties":{"ports":{"description":"The list of ports involved in the cable test.","type":"string"},"results":{"description":"The results for each port.","items":{"$ref":"#/components/schemas/CableTestHppcCabletestrowresult__66f350adb118"},"type":"array"}},"title":"AOS-S CABLE TEST RESPONSE","type":"object"},"CableTestHppcRequest__5abd6a941c65":{"properties":{"ports":{"description":"","type":"array"}},"required":["ports"],"title":"AOS-S CABLE TEST REQUEST","type":"object"},"CableTestHppcResult__66f350adb118":{"allOf":[{"$ref":"#/components/schemas/AsyncOperationResultBase__03efdde95a47"},{"properties":{"output":{"allOf":[{"$ref":"#/components/schemas/CableTestHppcParsedOutput__66f350adb118"}],"type":["object","null"]}},"type":"object"}],"title":"AOS-S CABLE TEST RESULT"},"CartesianCoordinates__6a214df6704a":{"description":"The x and y coordinates on the plane representing the associated floorplan for this device.\n","properties":{"unit":{"description":"The units of measure for xPosition and yPosition.\n","enum":["METERS","FEET"],"examples":["METERS"],"type":["string"]},"xPosition":{"description":"The position of the device on the horizontal axis of the floorplan.\n","examples":[19],"maximum":9999999,"minimum":0,"type":["number"]},"yPosition":{"description":"The position of the device on the vertical axis of the floorplan.\n","examples":[74],"maximum":9999999,"minimum":0,"type":["number"]}},"required":["xPosition","yPosition"],"type":"object"},"CartesianCoordinatesasset__a39bf531822f":{"description":"X and Y coordinates on the plane representing the associated floorplan for this Asset Tag.\n","properties":{"xInMetre":{"description":"The position of the client in metres on the horizontal axis of the floorplan.\n","example":19.12,"type":"number"},"yInMetre":{"description":"The position of the client in metres on the vertical axis of the floorplan.\n","example":74.9,"type":"number"}},"required":["xInMetre","yInMetre"],"type":"object"},"CartesianCoordinateswifi__3f58b16772b5":{"description":"x and y coordinates on the plane representing the associated floorplan for this client.\n","properties":{"xInMetre":{"description":"The position of the client in metres on the horizontal axis of the floorplan.\n","example":19.12,"type":"number"},"yInMetre":{"description":"The position of the client in metres on the vertical axis of the floorplan.\n","example":74.9,"type":"number"}},"required":["xInMetre","yInMetre"],"type":"object"},"CatalogueAps__2a40a211350c":{"properties":{"count":{"description":"The number of objects returned in the current list.","example":1,"format":"int32","maximum":2147483647,"minimum":1,"type":"integer"},"items":{"items":{"properties":{"id":{"description":"Catalogue Ap model","example":"AP-650","format":"const","maxLength":128,"type":"string"},"manufacturer":{"description":"Catalogue AP manufacturer.","example":"Aruba","format":"const","maxLength":128,"type":"string"},"partNumber":{"description":"Catalogue AP part number.","example":"AP-650","format":"const","maxLength":128,"type":"string"},"type":{"description":"network-monitoring/catalogue-aps","example":"network-monitoring/catalogue-aps","format":"const","maxLength":128,"type":"string"}},"required":["id","type"],"type":"object"},"maxItems":100,"type":"array"}},"required":["items","count"],"type":"object"},"CategoryFilterItem__2c64e622674f":{"description":"Event category filter item with count information.","properties":{"category":{"description":"Event category name.","example":"Connectivity","type":"string"},"count":{"description":"Number of events in this category.","example":45,"minimum":0,"type":"integer"}},"required":["category","count"],"type":"object"},"Category__13edfa6d725b":{"description":"Category of the executed action.\n","example":"Configuration","maxLength":256,"type":"string"},"Category__f8f342aecdae":{"description":"The category of the threat.\n","examples":["EXPLOIT"],"maxLength":256,"type":"string"},"Center__6a214df6704a":{"description":"Contains the coordinates of the center of the area of location uncertainty for the device.\n","properties":{"latitude":{"$ref":"#/components/schemas/Latitude__6a214df6704a"},"longitude":{"$ref":"#/components/schemas/Longitude__6a214df6704a"}},"required":["longitude","latitude"],"type":"object"},"ChannelChangeCount__34350f7e707e":{"description":"The number of times the channel has been changed in last 3 hours.\n","example":9,"format":"int32","minimum":0,"type":"integer"},"ChannelQuality__34350f7e707e":{"description":"Represents the quality of the channel used by the radio as a percentage.\n","example":99,"maxLength":16,"type":"string"},"ChannelUtilization__34350f7e707e":{"description":"Represents the percentage of channel utilization by the radio.\n","example":87,"maxLength":16,"type":"string"},"Channel__306cd00aed2d":{"description":"A channel identifier for a given frequency band.","examples":[36],"format":"uint32","maximum":500,"minimum":1,"type":"integer"},"Channel__34350f7e707e":{"description":"Indicates the channel used by the radio for communication.\n","example":8,"maxLength":32,"type":"string"},"ClassificationDataItem__7688f37a490e":{"description":"A single classification data entry.\n","properties":{"count":{"description":"The number of alerts in this classification group.\n","example":25,"type":"integer"},"name":{"description":"The name of the classification group.\n","example":"System","type":"string"}},"type":"object"},"ClassificationMethod__d67ae4720000":{"description":"The method used to classify the monitored AP","enum":["DEVICE","RULE","MANUAL","UNSPECIFIED"],"examples":["RULE"],"type":"string"},"ClassificationRule__d67ae4720000":{"description":"The name of the classification rule used to classify the monitored AP","examples":["Corporate_SSID_Whitelist"],"maxLength":48,"type":"string"},"Classification__d67ae4720000":{"description":"The classification of the monitored AP","enum":["UNKNOWN","INTERFERING","SUSPECT_ROGUE","ROGUE","VALID","DOS","KNOWN_INTERFERING"],"examples":["SUSPECT_ROGUE"],"type":"string"},"ClearAlertsRequest__0c2a95c4aa99":{"description":"Request body for clearing alerts.\n","properties":{"keys":{"description":"List of alert keys to clear.\n","example":["22071893000:47765082406","22071893000:47764775046"],"items":{"type":"string"},"type":"array"},"notes":{"description":"Additional notes about clearing the alerts.\n","example":"Firmware updated to version 10.4.0","type":"string"},"reason":{"description":"The reason for clearing the alerts.\n","enum":["Problem was resolved","False Positive","Insufficient information for troubleshooting","Alert is not important","Other"],"example":"Problem was resolved","type":"string"}},"required":["keys"],"type":"object"},"ClientCapabilities__284f33982989":{"description":"Client 802.11 capabilities.","example":"802.11ac","type":"string"},"ClientCategory__284f33982989":{"description":"Specifies the category of the client device.","example":"Smart Device","type":"string"},"ClientClassification__3f58b16772b5":{"description":"System estimated classification for this client.\n","example":"Unknown","format":"const","maxLength":32,"type":"string"},"ClientConnectionType__284f33982989":{"description":"Specifies the client type.","enum":["Wired","Wireless","Remote"],"example":"Wireless","type":"string"},"ClientDetails__284f33982989":{"properties":{"authenticationType":{"$ref":"#/components/schemas/AuthenticationType__284f33982989"},"bssid":{"$ref":"#/components/schemas/Bssidclients__284f33982989"},"clientCapabilities":{"$ref":"#/components/schemas/ClientCapabilities__284f33982989"},"clientCategory":{"$ref":"#/components/schemas/ClientCategory__284f33982989"},"clientConnectionType":{"$ref":"#/components/schemas/ClientConnectionType__284f33982989"},"clientFunction":{"$ref":"#/components/schemas/ClientFunction__284f33982989"},"clientManufacturer":{"$ref":"#/components/schemas/ClientManufacturer__284f33982989"},"clientName":{"$ref":"#/components/schemas/ClientName__284f33982989"},"clientOperatingSystem":{"$ref":"#/components/schemas/ClientOperatingSystem__284f33982989"},"clientTags":{"$ref":"#/components/schemas/ClientTags__284f33982989"},"clientVendor":{"$ref":"#/components/schemas/ClientVendor__284f33982989"},"connectedAt":{"$ref":"#/components/schemas/ConnectedAt__284f33982989"},"connectedDeviceSerial":{"$ref":"#/components/schemas/ConnectedDeviceSerial__284f33982989"},"connectedDeviceType":{"$ref":"#/components/schemas/ConnectedDeviceType__284f33982989"},"connectedTo":{"$ref":"#/components/schemas/ConnectedTo__284f33982989"},"hostName":{"$ref":"#/components/schemas/HostName__284f33982989"},"id":{"$ref":"#/components/schemas/IDclients__284f33982989"},"ipv4":{"$ref":"#/components/schemas/IPV4__284f33982989"},"ipv6":{"$ref":"#/components/schemas/IPV6__284f33982989"},"keyManagement":{"$ref":"#/components/schemas/KeyManagement__284f33982989"},"lastSeenAt":{"$ref":"#/components/schemas/LastSeenAtclients__284f33982989"},"macAddress":{"$ref":"#/components/schemas/MacAddressclients__284f33982989"},"mloOperMode":{"$ref":"#/components/schemas/MloOperMode__284f33982989"},"phyType":{"$ref":"#/components/schemas/PhyType__284f33982989"},"port":{"$ref":"#/components/schemas/Port__284f33982989"},"radioMacAddress":{"$ref":"#/components/schemas/RadioMacAddressclients__284f33982989"},"role":{"$ref":"#/components/schemas/Roleclients__284f33982989"},"siteId":{"$ref":"#/components/schemas/SiteIdclients__284f33982989"},"siteName":{"$ref":"#/components/schemas/SiteNameclients__284f33982989"},"snr":{"$ref":"#/components/schemas/Snr__284f33982989"},"status":{"$ref":"#/components/schemas/Statusclients__284f33982989"},"tunnelId":{"$ref":"#/components/schemas/TunnelIdclients__284f33982989"},"tunnelType":{"$ref":"#/components/schemas/TunnelType__284f33982989"},"type":{"$ref":"#/components/schemas/Typeclients__284f33982989"},"userName":{"$ref":"#/components/schemas/UserNameclients__284f33982989"},"vlanId":{"$ref":"#/components/schemas/VlanId__284f33982989"},"vlanName":{"$ref":"#/components/schemas/VlanName__284f33982989"},"wirelessBand":{"$ref":"#/components/schemas/WirelessBand__284f33982989"},"wirelessChannel":{"$ref":"#/components/schemas/WirelessChannel__284f33982989"},"wirelessSecurity":{"$ref":"#/components/schemas/WirelessSecurity__284f33982989"},"wlanName":{"$ref":"#/components/schemas/WlanNameclients__284f33982989"}},"required":["type","id"],"type":"object"},"ClientEntityNameHealth__0bffa6fb51f5":{"properties":{"health":{"$ref":"#/components/schemas/Health__0bffa6fb51f5"},"name":{"example":"Wired","type":"string"}},"type":"object"},"ClientFunction__284f33982989":{"description":"Specifies the functional category of the client device.","example":"Mobile","type":"string"},"ClientItems__4689c9697989":{"description":"This object gives details about the firewall session log.\n","example":{"clientMac":"00:00:00:00:00:00","clientUsername":"aruba-test@hpe.com","id":"1699550427000-10.53.110.142-00:00:00:00:00:00-13.107.42.14","type":"network-monitoring/site-firewall-sessions"},"properties":{"clientMac":{"description":"The MAC address of the client.\n","example":"b8:27:eb:61:34:f0","format":"const","maxLength":17,"type":"string"},"clientUsername":{"description":"The logged-in username of the client.\n","example":"aruba-test@hpe.com","format":"const","maxLength":256,"type":"string"},"id":{"description":"Resource ID: session_timestamp-src_ip-client_mac-dest_ip.\n","example":"1699550427000-10.53.110.142-b8:27:eb:61:34:f0-13.107.42.14","format":"string","maxLength":50,"type":"string"},"type":{"description":"Resource type.\n","example":"network-monitoring/site-firewall-sessions","format":"const","maxLength":13,"type":"string"}},"required":["type","id"],"type":"object"},"ClientLocation__3f58b16772b5":{"description":"Object with client's location along with additional metadata.\n","properties":{"accuracy":{"$ref":"#/components/schemas/Accuracy__3f58b16772b5"},"associated":{"$ref":"#/components/schemas/Associated__3f58b16772b5"},"associatedBssid":{"$ref":"#/components/schemas/AssociatedBssid__3f58b16772b5"},"buildingId":{"$ref":"#/components/schemas/BuildingIdwifi__3f58b16772b5"},"cartesianCoordinates":{"$ref":"#/components/schemas/CartesianCoordinateswifi__3f58b16772b5"},"clientClassification":{"$ref":"#/components/schemas/ClientClassification__3f58b16772b5"},"connected":{"$ref":"#/components/schemas/Connected__3f58b16772b5"},"createdAt":{"$ref":"#/components/schemas/CreatedAt__2efde5827a74"},"floorId":{"$ref":"#/components/schemas/FloorIdwifi__3f58b16772b5"},"geoCoordinates":{"$ref":"#/components/schemas/GeoCoordinates__3f58b16772b5"},"hashedMacAddress":{"$ref":"#/components/schemas/HashedMacAddress__3f58b16772b5"},"id":{"$ref":"#/components/schemas/Idwifi__3f58b16772b5"},"macAddress":{"$ref":"#/components/schemas/MacAddress__3f58b16772b5"},"numOfReportingAps":{"$ref":"#/components/schemas/NumOfReportingAPs__3f58b16772b5"},"siteId":{"$ref":"#/components/schemas/SiteIdwifi__3f58b16772b5"},"type":{"$ref":"#/components/schemas/Typewifi__3f58b16772b5"}},"required":["type","id","siteId","floorId","associated","cartesianCoordinates","clientClassification","accuracy","numOfReportingAps","connected","createdAt"],"type":"object"},"ClientMacaddr__7006262f8c4c":{"description":"The MAC address of the client.\n","examples":["00:00:00:00:xx:xx"],"maxLength":32,"type":"string"},"ClientManufacturer__284f33982989":{"description":"Specifies the manufacturer of the client device.","example":"Samsung","type":"string"},"ClientName__284f33982989":{"description":"Specifies the name of the client.","example":"Client1","type":"string"},"ClientOperatingSystem__284f33982989":{"description":"OS model of the client device.","example":"Android","type":"string"},"ClientResponse__4689c9697989":{"description":"List of clients.\n","example":{"count":1,"items":[{"clientMac":"00:00:00:00:00:00","clientUsername":"aruba-test@hpe.com"}],"next":"NyBErRdk6czGUyDAX5Cp","total":101},"maxItems":1000,"properties":{"count":{"$ref":"#/components/schemas/Countapp__7dced1181a4d"},"items":{"items":{"$ref":"#/components/schemas/ClientItems__4689c9697989"},"type":"array"},"next":{"$ref":"#/components/schemas/Next__21874c7bfa12"},"offset":{"$ref":"#/components/schemas/Offsetapp__7c5b5fe9ca66"},"total":{"$ref":"#/components/schemas/Totalfirewall__4689c9697989"}},"required":["items","next","count","total"],"type":"object"},"ClientSessionLogResponse__85be29963a81":{"description":"List of client firewall session logs.\n","example":{"count":1,"items":[{"applicationCategories":["Streaming"],"applicationName":"Netflix","blockedSessionReason":"Web Classification","clientConnectionType":"wireless","clientHostname":"host1","clientIp":"10.53.110.142","clientRole":"guest","clientUsername":"aruba-test@hpe.com","destinationIp":"13.107.42.14","deviceType":"DEVICE_TYPE_AP","id":"1699550427000-10.53.110.142-b8:27:eb:61:34:f0-13.107.42.14","rxBytes":572522496,"serialNumber":"CN00000000","sessionCount":100,"sessionType":"blocked","ssidName":"guestWifi","timestamp":"1699551447000","tunneledTraffic":false,"txBytes":5433,"type":"network-monitoring/client-firewall-sessions","vlanId":12,"webCategories":"Streaming Media","webReputation":"Trustworthy","webUrl":"netflix.com"}],"next":"NyBErRdk6czGUyDAX5Cp","total":101},"maxItems":1000,"properties":{"count":{"$ref":"#/components/schemas/Countapp__7dced1181a4d"},"items":{"items":{"$ref":"#/components/schemas/SessionItems__8523b012636f"},"type":"array"},"next":{"$ref":"#/components/schemas/Next__21874c7bfa12"},"offset":{"$ref":"#/components/schemas/Offsetapp__7c5b5fe9ca66"},"total":{"$ref":"#/components/schemas/Totalfirewall__4689c9697989"}},"required":["items","next","count","total"],"type":"object"},"ClientTags__284f33982989":{"description":"Comma-separated tags associated with the client.","example":"tag1","type":"string"},"ClientTypesHealth__7f65987649fe":{"properties":{"health":{"properties":{"groups":{"items":{"properties":{"name":{"example":"Fair","type":"string"},"value":{"example":4,"type":"integer"}},"type":"object"},"type":"array"}},"type":"object"},"name":{"example":"Wireless","type":"string"}},"type":"object"},"ClientVendor__284f33982989":{"description":"Specifies the vendor of the client device.","example":"Android","type":"string"},"Client__b58ef4da0e1a":{"properties":{"authenticationType":{"$ref":"#/components/schemas/AuthenticationType__284f33982989"},"bssid":{"$ref":"#/components/schemas/Bssidclients__284f33982989"},"clientCapabilities":{"$ref":"#/components/schemas/ClientCapabilities__284f33982989"},"clientCategory":{"$ref":"#/components/schemas/ClientCategory__284f33982989"},"clientConnectionType":{"$ref":"#/components/schemas/ClientConnectionType__284f33982989"},"clientFunction":{"$ref":"#/components/schemas/ClientFunction__284f33982989"},"clientManufacturer":{"$ref":"#/components/schemas/ClientManufacturer__284f33982989"},"clientName":{"$ref":"#/components/schemas/ClientName__284f33982989"},"clientOperatingSystem":{"$ref":"#/components/schemas/ClientOperatingSystem__284f33982989"},"clientTags":{"$ref":"#/components/schemas/ClientTags__284f33982989"},"clientVendor":{"$ref":"#/components/schemas/ClientVendor__284f33982989"},"connectedAt":{"$ref":"#/components/schemas/ConnectedAt__284f33982989"},"connectedDeviceSerial":{"$ref":"#/components/schemas/ConnectedDeviceSerial__284f33982989"},"connectedDeviceType":{"$ref":"#/components/schemas/ConnectedDeviceType__284f33982989"},"connectedTo":{"$ref":"#/components/schemas/ConnectedTo__284f33982989"},"hostName":{"$ref":"#/components/schemas/HostName__284f33982989"},"id":{"$ref":"#/components/schemas/IDclients__284f33982989"},"ipv4":{"$ref":"#/components/schemas/IPV4__284f33982989"},"ipv6":{"$ref":"#/components/schemas/IPV6__284f33982989"},"keyManagement":{"$ref":"#/components/schemas/KeyManagement__284f33982989"},"lastSeenAt":{"$ref":"#/components/schemas/LastSeenAtclients__284f33982989"},"macAddress":{"$ref":"#/components/schemas/MacAddressclients__284f33982989"},"mloOperMode":{"$ref":"#/components/schemas/MloOperMode__284f33982989"},"phyType":{"$ref":"#/components/schemas/PhyType__284f33982989"},"port":{"$ref":"#/components/schemas/Port__284f33982989"},"radioMacAddress":{"$ref":"#/components/schemas/RadioMacAddressclients__284f33982989"},"role":{"$ref":"#/components/schemas/Roleclients__284f33982989"},"siteId":{"$ref":"#/components/schemas/SiteIdclients__284f33982989"},"siteName":{"$ref":"#/components/schemas/SiteNameclients__284f33982989"},"snr":{"$ref":"#/components/schemas/Snr__284f33982989"},"status":{"$ref":"#/components/schemas/Statusclients__284f33982989"},"tunnelId":{"$ref":"#/components/schemas/TunnelIdclients__284f33982989"},"tunnelType":{"$ref":"#/components/schemas/TunnelType__284f33982989"},"type":{"$ref":"#/components/schemas/Typeclients__284f33982989"},"userName":{"$ref":"#/components/schemas/UserNameclients__284f33982989"},"vlanId":{"$ref":"#/components/schemas/VlanId__284f33982989"},"vlanName":{"$ref":"#/components/schemas/VlanName__284f33982989"},"wirelessBand":{"$ref":"#/components/schemas/WirelessBand__284f33982989"},"wirelessChannel":{"$ref":"#/components/schemas/WirelessChannel__284f33982989"},"wirelessSecurity":{"$ref":"#/components/schemas/WirelessSecurity__284f33982989"},"wlanName":{"$ref":"#/components/schemas/WlanNameclients__284f33982989"}},"required":["macAddress","type","id"],"type":"object"},"ClusterCapacityTrend__7201244eb725":{"example":[{"capacityType":"client_capacity","graph":{"keys":["active_client_count","standby_client_count","cluster_client_max_capacity","active_client_percentage","standby_client_percentage"],"samples":[{"data":[150,50,250,75,25],"timestamp":"2022-07-30T20:00:00Z"}]},"id":"cluster1","type":"network-monitoring/gateway-monitoring"},{"capacityType":"device_capacity","graph":{"keys":["active_ap_count","standby_ap_count","active_sw_count","standby_sw_count","active_ap_percentage","standby_ap_percentage","active_sw_percentage","standby_sw_percentage","cluster_device_max_capacity"],"samples":[{"data":[100,5,20,1,95,4,95,4,150],"timestamp":"2022-07-30T20:00:00Z"}]},"id":"cluster1","type":"network-monitoring/gateway-monitoring"}],"properties":{"graph":{"properties":{"keys":{"description":"List of metrics which help to evaluate the client and device capacity trend of a gateway cluster.\n","example":["active_client_count","standby_client_count","cluster_client_max_capacity","active_client_percentage","standby_client_percentage"],"items":{"type":"string"},"maxItems":9,"type":"array"},"samples":{"items":{"$ref":"#/components/schemas/GraphDataPoint__05867e444b37"},"maxItems":10000,"type":"array"}},"required":["keys","samples"],"type":"object"},"id":{"$ref":"#/components/schemas/IDgw__1053ccf03958"},"type":{"$ref":"#/components/schemas/Typegw__1053ccf03958"}},"required":["capacityType","graph","id","type"],"type":"object"},"ClusterConnectivityGraphResponse__facf932e9683":{"example":{"id":"gw-cluster-2","nodes":[{"health":"Good","name":"9240-VPNC-7011","peers":[{"mismatchedVlan":0,"name":"BCX1540221","vlanMismatch":"No"}],"role":"Leader","serialNumber":"CNP5KYH02L"},{"health":"Good","name":"BCX1540221","peers":[{"mismatchedVlan":0,"name":"9240-VPNC-7011","vlanMismatch":"No"}],"role":"Member","serialNumber":"BCX1540221"}],"type":"network-monitoring/gateway-monitoring"},"properties":{"id":{"$ref":"#/components/schemas/IDgw__1053ccf03958"},"nodes":{"description":"Gateway and its peers","properties":{"health":{"description":"The health of the gateway.\n","enum":["Good","Poor"],"example":"Good","maxLength":4,"type":"string"},"name":{"description":"The gateway name.\n","example":"gw_1","maxLength":256,"type":"string"},"peers":{"description":"Peer gateways and their VLAN mismatch details","properties":{"mismatchedVlan":{"description":"The VLAN ID that has a mismatch.\n","example":100,"format":"int32","type":"integer"},"name":{"description":"The name of the peer gateway in the cluster.\n","example":"gw_2","maxLength":256,"type":"string"},"vlanMismatch":{"description":"Boolean that says whether the gateway has a VLAN mismatch.\n","enum":["Yes","No"],"example":"Yes","maxLength":3,"type":"string"}},"type":"object"},"role":{"$ref":"#/components/schemas/Rolegw__3b77411f6985"},"serialNumber":{"$ref":"#/components/schemas/SerialNumbergw__1053ccf03958"}},"type":"object"},"type":{"$ref":"#/components/schemas/Typegw__1053ccf03958"}},"required":["nodes","id","type"],"type":"object"},"ClusterId__54309c5cca60":{"description":"The unique identifier of the swarm (cluster).","example":"1j4ehold0qj06kpbuy1a89dy5c69xe82ob27givar6mnbq135u","format":"const","maxLength":256,"type":"string"},"ClusterMemberCapacityTrend__3a50015484e1":{"example":[{"capacityType":"client_capacity","graph":{"keys":["active_client_count","standby_client_count","cluster_client_max_capacity","active_client_percentage","standby_client_percentage"],"samples":[{"data":[150,50,250,75,25],"timestamp":"2022-07-30T20:00:00Z"}]},"id":"cluster1/gw1","type":"network-monitoring/gateway-monitoring"},{"capacityType":"device_capacity","graph":{"keys":["active_ap_count","standby_ap_count","active_sw_count","standby_sw_count","active_ap_percentage","standby_ap_percentage","active_sw_percentage","standby_sw_percentage","cluster_device_max_capacity"],"samples":[{"data":[100,5,20,1,95,4,95,4,150],"timestamp":"2022-07-30T20:00:00Z"}]},"id":"cluster1/gw1","type":"network-monitoring/gateway-monitoring"}],"properties":{"graph":{"properties":{"keys":{"description":"List of metrics which help to evaluate the client and device capacity trend of a gateway cluster member.\n","example":["active_client_count","standby_client_count","cluster_client_max_capacity","active_client_percentage","standby_client_percentage"],"items":{"type":"string"},"maxItems":9,"type":"array"},"samples":{"items":{"$ref":"#/components/schemas/GraphDataPoint__05867e444b37"},"maxItems":10000,"type":"array"}},"required":["keys","samples"],"type":"object"},"id":{"$ref":"#/components/schemas/IDgw__1053ccf03958"},"type":{"$ref":"#/components/schemas/Typegw__1053ccf03958"}},"required":["capacityType","graph","id","type"],"type":"object"},"ClusterMemberListResponse__de89a47d9bd8":{"allOf":[{"properties":{"items":{"items":{"properties":{"clusterName":{"$ref":"#/components/schemas/ClusterNamegw__3b77411f6985"},"deviceName":{"$ref":"#/components/schemas/DeviceNamegw__3b77411f6985"},"firmwareVersion":{"$ref":"#/components/schemas/FirmwareVersiongw__3b77411f6985"},"id":{"$ref":"#/components/schemas/IDgw__1053ccf03958"},"ipv4":{"$ref":"#/components/schemas/Ipv4Addressgw__3b77411f6985"},"ipv6":{"$ref":"#/components/schemas/Ipv6Addressgw__de89a47d9bd8"},"lastSeenAt":{"$ref":"#/components/schemas/LastSeenAtgw__de89a47d9bd8"},"macAddress":{"$ref":"#/components/schemas/MacAddressgw__3b77411f6985"},"model":{"$ref":"#/components/schemas/Modelgw__3b77411f6985"},"partNumber":{"$ref":"#/components/schemas/PartNumbergw__de89a47d9bd8"},"role":{"$ref":"#/components/schemas/Rolegw__3b77411f6985"},"serialNumber":{"$ref":"#/components/schemas/SerialNumbergw__1053ccf03958"},"siteId":{"$ref":"#/components/schemas/SiteIDgw__3b77411f6985"},"siteName":{"$ref":"#/components/schemas/SiteNamegw__3b77411f6985"},"softwareVersion":{"$ref":"#/components/schemas/FirmwareVersiongw__3b77411f6985"},"status":{"$ref":"#/components/schemas/Statusgw__de89a47d9bd8"},"type":{"$ref":"#/components/schemas/Typegw__1053ccf03958"}},"required":["clusterName","ipv4","ipv6","lastSeenAt","macAddress","model","deviceName","partNumber","role","serialNumber","siteId","siteName","softwareVersion","firmwareVersion","status","id","type"],"type":"object"},"maxItems":100,"type":"array"}},"required":["items"],"type":"object"},{"$ref":"#/components/schemas/PaginatedResponsegw__21874c7bfa12"}],"example":{"count":1,"items":[{"clusterName":"Demo GW Cluster","deviceName":"Gateway-1","firmwareVersion":"10.7.0.0_90051","id":"CZ0001156","ipv4":"167.34.21.6","ipv6":"2001:0db8:85a3:0000:0000:8a2e:0370:7334","lastSeenAt":"2024-03-12T07:20:50.52Z","macAddress":"28:de:65:f1:c1:c0","model":"A9240","partNumber":"R7H95A","role":"Isoleader","serialNumber":"CZ0001156","siteId":"12345","siteName":"prestige-zackaria","softwareVersion":"10.7.0.0_90051","status":"OFFLINE","type":"network-monitoring/gateway-monitoring"}],"next":null,"total":1}},"ClusterName__3a50015484e1":{"description":"The name of the cluster to which the device belongs. If the device is not part of any cluster then the cluster name will be null.","example":"cluster 1","format":"const","maxLength":256,"type":"string"},"ClusterNamegw__3b77411f6985":{"description":"The cluster to which the gateway belongs.\n","example":"gw_cluster_1","maxLength":256,"type":"string"},"ClusterTunnelHealthSummaryResponse__49fb391231f9":{"example":[{"deviceName":"Gateway-1","id":"cluster1/GW1/tunnels","serialNumber":"GW1","siteId":"12345","tunnelHealth":{"fair":0,"good":3,"poor":0},"type":"network-monitoring/gateway-monitoring"},{"deviceName":"Gateway-2","id":"cluster1/GW2/tunnels","serialNumber":"GW2","siteId":"12345","tunnelHealth":{"fair":0,"good":1,"poor":3},"type":"network-monitoring/gateway-monitoring"}],"properties":{"deviceName":{"$ref":"#/components/schemas/DeviceNamegw__3b77411f6985"},"id":{"$ref":"#/components/schemas/IDgw__1053ccf03958"},"serialNumber":{"$ref":"#/components/schemas/SerialNumbergw__1053ccf03958"},"siteId":{"$ref":"#/components/schemas/SiteIDgw__3b77411f6985"},"tunnelHealth":{"description":"Tunnel health summary for a cluster member.","properties":{"fair":{"description":"The number of tunnels that are of fair health.\n","example":"2","format":"int32","type":"integer"},"good":{"description":"The number of tunnels that are of good health.\n","example":"5","format":"int32","type":"integer"},"poor":{"description":"The number of tunnels that are of poor health.\n","example":"1","format":"int32","type":"integer"}},"type":"object"},"type":{"$ref":"#/components/schemas/Typegw__1053ccf03958"}},"required":["id","type"],"type":"object"},"ClusterTunnelStatusSummaryResponse__eca6a91fa313":{"example":{"down":0,"id":"cluster1/tunnels","type":"network-monitoring/gateway-monitoring","up":3},"properties":{"down":{"description":"The number of tunnels that are Down.\n","example":"2","format":"int32","type":"integer"},"id":{"$ref":"#/components/schemas/IDgw__1053ccf03958"},"type":{"$ref":"#/components/schemas/Typegw__1053ccf03958"},"up":{"description":"The number of tunnels that are Up.\n","example":"2","format":"int32","type":"integer"}},"required":["id","type"],"type":"object"},"ClusterVlanMismatchResponse__a51bf4679e93":{"example":{"good":4,"id":"gw-cluster-1","poor":2,"type":"network-monitoring/gateway-monitoring"},"properties":{"good":{"$ref":"#/components/schemas/Good__a51bf4679e93"},"id":{"$ref":"#/components/schemas/IDgw__1053ccf03958"},"poor":{"$ref":"#/components/schemas/Poor__a51bf4679e93"},"type":{"$ref":"#/components/schemas/Typegw__1053ccf03958"}},"required":["clusterName","id","type"],"type":"object"},"Columns__66b457073e9b":{"properties":{"column":{"examples":["name"],"type":"string"},"displayName":{"examples":["Name"],"type":"string"},"optionality":{"enum":["OPTIONAL","OPTIONAL_PRESELECTED","MANDATORY"],"examples":["MANDATORY"],"type":"string"}},"type":"object"},"ComputeEntityNameHealth__0bffa6fb51f5":{"properties":{"health":{"$ref":"#/components/schemas/Health__0bffa6fb51f5"},"name":{"example":"VM","type":"string"}},"type":"object"},"ConductorDeviceName__a3f300af1174":{"description":"The name of the conductor device in the swarm.","example":"IAP1","format":"const","maxLength":256,"type":"string"},"ConductorSerialNumber__a3f300af1174":{"description":"The serial number of the conductor device in the swarm.","example":"AP00000001","format":"const","maxLength":16,"type":"string"},"ConfigLastModifiedAt__6b9c5f08b869":{"description":"An RFC 3339 date-time indicating the last config modified time of the device.","example":"2025-03-12T07:20:50.52Z","format":"date-time","maxLength":128,"type":"string"},"ConfigStatus__6b9c5f08b869":{"description":"Config status of the device. Possible values are `Synchronized`, `Out of Sync`, `Update in Progress`, and `Synchronized with Limitations`.","example":"Synchronized","format":"const","maxLength":256,"type":"string"},"ConflictError__039ba698cb40":{"description":"Conflict error details returned from the server.","properties":{"debugId":{"$ref":"#/components/schemas/DebugIddevice__039ba698cb40"},"errorCode":{"description":"* A unique, machine-friendly, but human-readable identifier for the error. It has the prefix HPE_GL_.\n* For more details regarding the error please refer to the error message.","enum":["HPE_GL_NETWORK_MONITORING_CONFLICT"],"example":"HPE_GL_NETWORK_MONITORING_CONFLICT","maxLength":256,"type":"string"},"httpStatusCode":{"description":"The HTTP status code.","example":409,"maximum":409,"minimum":409,"type":"integer"},"message":{"$ref":"#/components/schemas/ErrorMessagedevice__039ba698cb40"}},"required":["httpStatusCode","errorCode","message","debugId"],"type":"object"},"ConflictError__4e865062885b":{"description":"Conflict Error details returned from the server.","properties":{"debugId":{"$ref":"#/components/schemas/DebugId__0c2a95c4aa99"},"errorCode":{"description":"Internal error code.","example":"HPE_GL_NETWORK_NOTIFICATIONS_CONFLICT","maxLength":256,"type":"string"},"httpStatusCode":{"description":"HTTP status code.","example":409,"maximum":409,"minimum":409,"type":"integer"},"message":{"description":"Error message indicating the cause of the failure.","example":"Conflict. The resource already exists.","maxLength":512,"type":"string"}},"required":["httpStatusCode","errorCode","message","debugId"],"type":"object"},"ConflictError__c34075768619":{"description":"Conflict error details returned from the server.\n","properties":{"debugId":{"$ref":"#/components/schemas/DebugId__0288a339fc72"},"errorCode":{"description":"Error code\n","enum":["HPE_GL_NETWORK_REPORTING_CONFLICT"],"examples":["HPE_GL_NETWORK_REPORTING_CONFLICT"],"maxLength":128,"type":"string"},"httpStatusCode":{"description":"HTTP status code.\n","examples":[409],"maximum":409,"minimum":409,"type":"integer"},"message":{"$ref":"#/components/schemas/ErrorMessage__66b457073e9b"}},"required":["httpStatusCode","errorCode","message","debugId"],"type":"object"},"ConnectedAt__284f33982989":{"description":"Specifies the timestamp when the client was connected.","example":"2025-07-10T08:09:17.419Z","format":"date-time","type":"string"},"ConnectedDeviceSerial__284f33982989":{"description":"Specifies the serial number of the connected device.","example":"DTXC000001","type":"string"},"ConnectedDeviceType__284f33982989":{"description":"Type of connected device (AP/Switch/Gateway).","example":"AP","type":"string"},"ConnectedTo__284f33982989":{"description":"Specifies the device name that the client is connected to.","example":"20:4c:03:a4:a4:28","type":"string"},"Connected__3f58b16772b5":{"description":"Provides Boolean indication of whether this client is connected to an AP of our network.\n","example":true,"type":"boolean"},"ContainmentStatus__d67ae4720000":{"description":"The containment status of the monitored AP","enum":["CONTAINED","UN_CONTAINED","KNOWN_INTERFERING"],"examples":["CONTAINED"],"type":"string"},"Coordinates__a39bf531822f":{"description":"The location of the tag.","properties":{"cartesianCoordinates":{"$ref":"#/components/schemas/CartesianCoordinatesasset__a39bf531822f"},"geoCoordinates":{"$ref":"#/components/schemas/GeoCoordinatesasset__a39bf531822f"}},"type":"object"},"Count__7006262f8c4c":{"description":"Specifies the number of items in the response.\n","examples":[1],"format":"int64","type":"integer"},"Count__c0c1228d8f7d":{"description":"Number of items in the response.\n","example":1,"format":"int32","type":"integer"},"Countapp__7dced1181a4d":{"description":"The count of items returned in the response.\n","example":0,"format":"int32","type":"integer"},"Countdevice__6b9c5f08b869":{"description":"Number of items in the response.","example":1,"format":"int32","type":"integer"},"Countgw__21874c7bfa12":{"description":"The number of items in the response.\n","example":1,"format":"int32","type":"integer"},"CreateReportsInput__c34075768619":{"properties":{"email":{"properties":{"formats":{"$ref":"#/components/schemas/ReportFormats__70734de364b7"},"recipients":{"$ref":"#/components/schemas/Emails__70734de364b7"}},"type":"object"},"filters":{"$ref":"#/components/schemas/Filters__c34075768619"},"kpiWidgets":{"items":{"$ref":"#/components/schemas/KPIWidgetInput__c34075768619"},"type":"array"},"name":{"type":"string"},"reportPeriod":{"$ref":"#/components/schemas/ReportPeriodInput__c34075768619"},"reportSchedule":{"$ref":"#/components/schemas/ReportScheduleInput__c34075768619"},"timeZone":{"type":"string"},"type":{"$ref":"#/components/schemas/Type__c34075768619"}},"required":["name","type","timeZone","filters","reportPeriod","reportSchedule"],"type":"object"},"CreatedAt__2efde5827a74":{"description":"Provides the timestamp ISO 8601 format when the computed client location is persisted in database.\n","example":"2023-02-14T12:23:00.000Z","format":"date-time","maxLength":30,"type":"string"},"CreatedAt__7006262f8c4c":{"description":"The date-time (RFC 3339 UTC+0) at which the resource was created.\n","examples":["2024-11-10T00:01:43.000Z"],"format":"date-time","type":"string"},"CreatedAt__7d827151e05e":{"description":"Specifies the report creation timestamp in UTC+0 timezone (RFC 3339 format).","examples":["2019-10-12T07:20:50Z"],"format":"date-time","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z$","type":"string"},"CreatedAtasset__a39bf531822f":{"description":"Time of resource creation.","example":"2023-10-01T12:00:00Z","format":"date-time","maxLength":20,"type":"string"},"CreatedAtwebhooks__715550e8d02e":{"description":"The creation timestamp of the webhook in RFC 3339 format.","format":"date-time","type":"string"},"CreatedAtwids__000172564380":{"description":"Time of resource creation. RFC 3339 (and ISO 8601) in UTC+0 timezone.","examples":["2023-10-01T12:00:00.000Z"],"format":"date-time","maxLength":24,"type":"string"},"CreatedBy__7d827151e05e":{"description":"The user who saved the report.","examples":["user1@mail.com"],"type":"string"},"CryptoType__0f1d40c88b6b":{"description":"The cryptographic key exchange type used by the tunnel.","enum":["TUNNEL_CRYPTO_TYPE_UNSPECIFIED","TUNNEL_CRYPTO_TYPE_CERTIFICATE","TUNNEL_CRYPTO_TYPE_PSK"],"example":"TUNNEL_CRYPTO_TYPE_CERTIFICATE","maxLength":32,"type":"string"},"CurrentUplinkInUse__98bb0f033247":{"description":"Identifier of the uplink interface currently used by the access point.\n","example":"Ethernet","maxLength":64,"type":"string"},"CustomId__a39bf531822f":{"description":"Custom ID of the Asset Tag.","example":"e5b61232-83c8-401a-8e14-a4c75b4fb745","format":"uuid","maxLength":100,"type":["string","null"]},"CustomerId__7006262f8c4c":{"description":"The ID of the customer.\n","examples":["cf3f80d06b7011ef85c8dac199bxxxxx"],"maxLength":64,"type":"string"},"CveReference__7006262f8c4c":{"description":"The CVE related to the signature that detected the threat.\n","examples":["CVE-2007-0015"],"maxLength":32,"type":"string"},"DHCPPoolIdentifier__36b9a7c1ff51":{"description":"Primary identifier of a DHCP pool under an access point.","example":"AP00000001/dhcp-pools/Pool-Alpha","format":"const","maxLength":36,"type":"string"},"DataPoint__55ca259b8355":{"description":"An object containing data points and a corresponding timestamp.","properties":{"data":{"description":"A list of values corresponding to the keys","items":{"format":"double","maximum":10000000000000000,"minimum":-10000000000000000,"type":"number"},"maxItems":10,"type":"array"},"ts":{"description":"An RFC 3339 date-time string","example":"2025-08-19T06:45:00Z","format":"date-time","maxLength":128,"type":"string"}},"required":["data","timestamp"],"type":"object"},"DatabaseError__3f58b16772b5":{"description":"Internal Server Error response","properties":{"debugId":{"$ref":"#/components/schemas/debugIdwifi__000172564380"},"errorCode":{"description":"* A unique machine-friendly, but human-readable identifier for the error. It has prefix HPE_GL_.\n* For more details regarding error please refer to error message\n","enum":["HPE_GL_NETWORK_SERVICES_WIFI_CLIENT_LOCATION_DATABASE_ERROR","HPE_GL_NETWORK_SERVICES_WIFI_CLIENT_LOCATION_UNKNOWN_ERROR"],"example":"HPE_GL_NETWORK_SERVICES_WIFI_CLIENT_LOCATION_DATABASE_ERROR","format":"const","maxLength":128,"type":"string"},"httpStatusCode":{"description":"HTTP status code.","example":500,"maximum":500,"minimum":500,"type":"integer"},"message":{"$ref":"#/components/schemas/message__000172564380"}},"required":["httpStatusCode","errorCode","message","debugId"],"type":"object"},"DateTime__1335a419f403":{"description":"Date-time in RFC 3339 format (ISO 8601) in UTC timezone with milliseconds.","example":"2025-08-06T12:34:56.124Z","format":"date-time","maxLength":30,"type":"string"},"DateTime__1ff3457b62c0":{"example":"2024-03-12T07:20:50.52Z","format":"date-time","maxLength":128,"type":"string"},"DateTime__3f58b16772b5":{"description":"Date-time in RFC 3339 format (ISO 8601) in UTC+0 timezone.","example":"2025-08-06T12:34:56.324Z","format":"date-time","maxLength":30,"type":"string"},"DebugId__000172564380":{"description":"A unique identifier used for troubleshooting and debugging purposes.\n","example":"78f002e32e0cefba3d8cc94fa8179342","format":"const","maxLength":512,"type":"string"},"DebugId__0288a339fc72":{"description":"A unique identifier used for troubleshooting and debugging purposes.\n","examples":["78f002e32e0cefba3d8cc94fa8179342"],"maxLength":512,"type":"string"},"DebugId__0c2a95c4aa99":{"description":"A unique identifier used for troubleshooting and debugging purposes.","example":"78f002e32e0cefba3d8cc94fa8179342","maxLength":512,"type":"string"},"DebugIddevice__039ba698cb40":{"description":"A unique identifier used for troubleshooting and debugging purposes.","example":"78f002e32e0cefba3d8cc94fa8179342","format":"const","maxLength":512,"type":"string"},"DebugIdtopology__004689200476":{"description":"A unique identifier used for troubleshooting purposes.","example":"78f002e32e0cefba3d8cc94fa8179342","format":"const","maxLength":512,"type":"string"},"DeferAlertsRequest__f61270eea99f":{"description":"Request body for deferring alerts.\n","properties":{"deferUntil":{"description":"The date-time until which the alerts should be deferred.\n","example":"2026-03-01T00:00:00Z","format":"date-time","type":"string"},"keys":{"description":"List of alert keys to defer.\n","example":["22071893000:47765082406","22071893000:47764775046"],"items":{"type":"string"},"type":"array"}},"required":["keys","deferUntil"],"type":"object"},"Deployment__6b9c5f08b869":{"description":"The operating mode of the device.","example":"Standalone","format":"const","maxLength":16,"type":"string"},"Deploymentap__98bb0f033247":{"description":"The operating mode of the access point.\n","example":"Standalone","format":"const","maxLength":16,"type":"string"},"Deploymentgw__3b77411f6985":{"description":"The operating mode of the gateway.\n","enum":["Standalone","Cluster"],"example":"Standalone","maxLength":10,"type":"string"},"Description__13edfa6d725b":{"description":"Description of the executed action \n","example":"Gateway [CX0001066] - Configuration Synchronized","maxLength":4096,"type":"string"},"Description__7006262f8c4c":{"description":"The description of the signature that detected the threat.\n","examples":["WEB_CLIENT signatures are designed to alert on attacks against web client software"],"maxLength":4096,"type":"string"},"Descriptionwids__000172564380":{"description":"Description of the WIDS event","examples":["An AP detected performing suspicious activity"],"maxLength":256,"type":"string"},"DestCity__7006262f8c4c":{"description":"The destination city of the threat.\n","examples":["San Jose"],"maxLength":128,"type":"string"},"DestCountry__7006262f8c4c":{"description":"The destination country of the threat.\n","examples":["USA"],"maxLength":128,"type":"string"},"DestIp__7006262f8c4c":{"description":"The destination IP of the threat.\n","examples":["192.168.x.x"],"maxLength":64,"type":"string"},"DestPort__7006262f8c4c":{"description":"The destination Port of the threat.\n","examples":[80],"format":"int64","type":"integer"},"DestinationAp__972dd6d46bea":{"description":"Specifies the AP name to which the client roamed.","example":"QNRR000001","type":"string"},"DestinationIpAddress__0f1d40c88b6b":{"description":"The IP address of the destination endpoint.","example":"11.0.0.1","format":"const","maxLength":64,"type":"string"},"DestinationIpAddressgw__2ca376caec3f":{"description":"IP address to which the tunnel terminates.\n","example":"172.51.100.42","format":"ipv4","maxLength":15,"type":"string"},"DestinationMacAddress__0f1d40c88b6b":{"description":"The MAC address of the destination endpoint.","example":"00:01:02:03:04:05","format":"const","maxLength":18,"type":"string"},"DestinationName__0f1d40c88b6b":{"description":"The name of the destination endpoint.","example":"GW2","format":"const","maxLength":256,"type":"string"},"DestinationName__13edfa6d725b":{"description":"The serial number or Host Name of the audit.\n","example":"CX0001066","maxLength":128,"type":"string"},"DestinationNamegw__608b430a0026":{"description":"The name of the destination gateway to which the tunnel is connected.\n","example":"gw_1","maxLength":256,"type":"string"},"DestinationSerial__608b430a0026":{"description":"The serial number of the destination gateway to which the tunnel is connected.\n","example":"GW00000001","maxLength":16,"type":"string"},"DestinationSite__608b430a0026":{"description":"The site to which the destination gateway is assigned.\n","example":"site_1","maxLength":256,"type":"string"},"Destination__13edfa6d725b":{"description":"Name of the entity/component on which action has been performed.\n","example":"Global","maxLength":128,"type":"string"},"DetectingAp__000172564380":{"description":"Serial of the AP that detected the intrusion","examples":["QWR124780123"],"maxLength":20,"type":"string"},"DeviceClassification__a39bf531822f":{"description":"Device classifications for the Asset Tag.","example":["ArubaAssetTag","Blyott"],"items":{"maxLength":256,"type":"string"},"type":"array"},"DeviceFunction__6b9c5f08b869":{"description":"Device function (persona) of the device.","example":"Instant","format":"const","maxLength":20,"type":"string"},"DeviceFunctionap__da78704f9a76":{"description":"Device Function (Persona identifier) for the access point.\n","example":"Instant","format":"const","maxLength":20,"type":"string"},"DeviceGroupId__cd77b09562fb":{"description":"Device group ID represents the unique identifier for the group to which the device belongs. This identifier is used to group devices that share common characteristics or are part of the same operational group, facilitating easier management and monitoring.","example":8100143262,"format":"const","maxLength":16,"type":"string"},"DeviceGroupName__cd77b09562fb":{"description":"Device group name represents the name of the group to which the device belongs. This name is used to categorize and manage devices that share common characteristics or are part of the same operational group.","example":"AP Persona group","format":"const","maxLength":256,"type":"string"},"DeviceId__8de6ce4ea240":{"description":"The UUID identifier of the Asset Tag.","example":"e5b61232-83c8-401a-8e14-a4c75b4fb745","format":"uuid","maxLength":36,"type":"string"},"DeviceInventoryResponseV1__cd77b09562fb":{"allOf":[{"properties":{"items":{"items":{"properties":{"deployment":{"$ref":"#/components/schemas/Deployment__6b9c5f08b869"},"deviceFunction":{"$ref":"#/components/schemas/DeviceFunction__6b9c5f08b869"},"deviceGroupId":{"$ref":"#/components/schemas/DeviceGroupId__cd77b09562fb"},"deviceGroupName":{"$ref":"#/components/schemas/DeviceGroupName__cd77b09562fb"},"deviceName":{"$ref":"#/components/schemas/DeviceNamedevice__6b9c5f08b869"},"deviceType":{"$ref":"#/components/schemas/DeviceTypedevice__6b9c5f08b869"},"firmwareVersion":{"$ref":"#/components/schemas/FirmwareVersion__6b9c5f08b869"},"id":{"$ref":"#/components/schemas/IDdevice__6b9c5f08b869"},"ipv4":{"$ref":"#/components/schemas/IPv4Address__6b9c5f08b869"},"isProvisioned":{"$ref":"#/components/schemas/IsProvisioned__cd77b09562fb"},"macAddress":{"$ref":"#/components/schemas/MacAddress__6b9c5f08b869"},"model":{"$ref":"#/components/schemas/Model__6b9c5f08b869"},"partNumber":{"$ref":"#/components/schemas/PartNumber__6b9c5f08b869"},"role":{"$ref":"#/components/schemas/Role__6b9c5f08b869"},"scopeId":{"$ref":"#/components/schemas/ScopeId__cd77b09562fb"},"serialNumber":{"$ref":"#/components/schemas/SerialNumber__05867e444b37"},"siteId":{"$ref":"#/components/schemas/SiteIDdevice__6b9c5f08b869"},"siteName":{"$ref":"#/components/schemas/SiteNamedevice__6b9c5f08b869"},"stackId":{"$ref":"#/components/schemas/StackId__cd77b09562fb"},"status":{"$ref":"#/components/schemas/Status__6b9c5f08b869"},"subscriptionKey":{"$ref":"#/components/schemas/SubscriptionKey__cd77b09562fb"},"tier":{"$ref":"#/components/schemas/Tier__cd77b09562fb"},"type":{"$ref":"#/components/schemas/Typedevice__0288a339fc72"}},"required":["serialNumber","macAddress","deviceName","deviceType","siteId","id","type"],"type":"object"},"maxItems":1000,"type":"array"}},"required":["items"],"type":"object"},{"$ref":"#/components/schemas/PaginatedResponseV1__6b9c5f08b869"}],"example":{"count":1,"items":[{"deployment":"Stack","deviceFunction":"-","deviceGroupId":"8100143262","deviceGroupName":"SWITCH Persona group","deviceName":"Aruba-Stack-2930M","deviceType":"SWITCH","firmwareVersion":"WC.16.11.0014","id":"SG7BJQL6PD","ipv4":"10.27.113.203","isProvisioned":"Yes","macAddress":"D0:67:26:7E:DC:80","model":"2930M","partNumber":"JL320A","role":"Conductor","scopeId":"9842216","serialNumber":"SG7BJQL6PD","siteId":"8022800","siteName":"site-12-dec","stackId":"1f00d067-267edc80","status":"OFFLINE","subscriptionKey":"ET45ENIPPEADN9FQ","tier":null,"type":"network-monitoring/device-monitoring"}],"next":"2","total":4}},"DeviceIp__7006262f8c4c":{"description":"The IP address of the device.\n","examples":["192.168.x.x"],"maxLength":64,"type":"string"},"DeviceListResponseV1__6b9c5f08b869":{"allOf":[{"properties":{"items":{"items":{"$ref":"#/components/schemas/DeviceResponseV1__6b9c5f08b869"},"maxItems":1000,"type":"array"}},"required":["items"],"type":"object"},{"$ref":"#/components/schemas/PaginatedResponseV1__6b9c5f08b869"}],"example":{"count":1,"items":[{"buildingId":"1120972196_1","clusterName":"cluster 1","configLastModifiedAt":null,"configStatus":null,"deployment":"Standalone","deviceFunction":"Instant","deviceName":"ArubaAP","deviceType":"ACCESS_POINT","firmwareVersion":"8.5.2.0_59123","floorId":"1120972196_1_","id":"AP00000001","ipv4":"114.191.59.254","ipv6":"10.27.119.19","lastSeenAt":null,"macAddress":"bb:5d:11:85:c0:00","model":"AP-115","notes":"Device is located in Building A, Floor 2","partNumber":"JZ336A","role":"Conductor","serialNumber":"CMZR001874","siteId":"1120972196","siteName":"site-12-dec","status":"ONLINE","type":"network-monitoring/device-monitoring","uptimeInMillis":1702794777}],"next":"2","total":4}},"DeviceLocationSummary__6a214df6704a":{"description":"Geographic coordinates of a device.\n\n**consolidatedLocation** contains the best estimate of the device location.  The location in this field can be derived automatically by the system or overridden manually by the system administrator (by placing it on a floorplan or via another NBAPI call). The sytem generated location is almost always available, when an AP is removed from a floorplan then the system generated location will be used as the consolidated location.\n","properties":{"buildingId":{"$ref":"#/components/schemas/BuildingId__6a214df6704a"},"consolidatedLocation":{"$ref":"#/components/schemas/Location__6a214df6704a"},"createdAt":{"$ref":"#/components/schemas/Timestamp__306cd00aed2d"},"deployment":{"format":"const","maxLength":32,"type":["string"]},"floorId":{"$ref":"#/components/schemas/FloorId__6a214df6704a"},"floorLevel":{"$ref":"#/components/schemas/FloorLevel__6a214df6704a"},"id":{"$ref":"#/components/schemas/LocationId__6a214df6704a"},"ipv4":{"format":"ipv4","maxLength":15,"type":["string"]},"ipv6":{"format":"ipv6","maxLength":39,"type":["string"]},"macAddress":{"examples":["11:22:33:44:55:66"],"format":"const","maxLength":18,"type":["string"]},"model":{"examples":["AP-635"],"format":"const","maxLength":32,"type":["string"]},"serialNumber":{"$ref":"#/components/schemas/DeviceSerial__6a214df6704a"},"siteId":{"$ref":"#/components/schemas/SiteIddeviceloc__6a214df6704a"},"status":{"enum":["ONLINE","OFFLINE"],"examples":["ONLINE"],"type":["string"]},"tenantId":{"examples":["cid1234567890"],"format":"const","maxLength":128,"type":["string"]},"type":{"$ref":"#/components/schemas/DeviceType__6a214df6704a"}},"required":["id","type","createdAt","siteId","floorId"],"type":"object"},"DeviceMac__f8f342aecdae":{"description":"The Mac address of the device.\n","examples":["00:1A:2B:3C:4D:5F"],"maxLength":64,"type":"string"},"DeviceModel__7006262f8c4c":{"description":"The model of the device.\n","examples":["GW-275"],"maxLength":64,"type":"string"},"DeviceName__7006262f8c4c":{"description":"The name of the device.\n","examples":["ap_1"],"maxLength":128,"type":"string"},"DeviceName__c0c1228d8f7d":{"description":"The name of the device.\n","example":"ap_1","format":"const","maxLength":256,"type":"string"},"DeviceNameap__1ff3457b62c0":{"description":"The access point name.\n","example":"ap_1","format":"const","maxLength":256,"type":"string"},"DeviceNamedevice__6b9c5f08b869":{"description":"The name of the device.","example":"ap_1","format":"const","maxLength":256,"type":"string"},"DeviceNamegw__3b77411f6985":{"description":"The gateway name.\n","example":"gw_1","maxLength":256,"type":"string"},"DeviceNotReadyErrorResponse__322170916979":{"properties":{"errorCode":{"description":"A unique code identifying the error type.","type":"string"},"message":{"description":"A human-readable description of the error.","type":"string"}},"required":["message","errorCode"],"title":"Device Not Ready Error Response","type":"object"},"DeviceNotesFailedResult__0288a339fc72":{"description":"A device whose notes update failed.","properties":{"errorCode":{"description":"Machine-readable error code with HPE_GL_ prefix.","example":"HPE_GL_NETWORK_MONITORING_DEVICE_NOT_FOUND","type":"string"},"errorMessage":{"description":"Human-readable error message.","example":"Device not found","type":"string"},"id":{"description":"The serial number of the device, used as the resource identifier.","example":"AP00000004","type":"string"},"notes":{"description":"The notes from the request. `null` if the device was not found.","example":null,"type":["string","null"]},"serialNumber":{"description":"The serial number of the device.","example":"AP00000002","type":"string"},"type":{"description":"The type of the resource.","example":"network-monitoring/device-monitoring","type":"string"}},"type":"object"},"DeviceNotesInput__039ba698cb40":{"properties":{"notes":{"description":"The note text to set for the device. Set to an empty string (`\"\"`) to clear/delete the note.","example":"Device is located in Building A, Floor 2","maxLength":256,"type":"string"},"serialNumber":{"description":"The serial number of the device.","example":"AP00000001","type":"string"}},"required":["serialNumber","notes"],"type":"object"},"DeviceNotesSucceededResult__0288a339fc72":{"description":"A device whose notes were updated successfully.","properties":{"id":{"description":"The serial number of the device, used as the resource identifier.","example":"AP00000001","type":"string"},"notes":{"description":"The notes that were set on the device.","example":"Device is located in Building A, Floor 2","type":"string"},"serialNumber":{"description":"The serial number of the device.","example":"AP00000001","type":"string"},"type":{"description":"The type of the resource.","example":"network-monitoring/device-monitoring","type":"string"}},"type":"object"},"DeviceResponseV1__6b9c5f08b869":{"example":{"buildingId":"1120972196_1","clusterName":"cluster 1","configLastModifiedAt":null,"configStatus":null,"deployment":"Standalone","deviceFunction":"Instant","deviceName":"ArubaAP","deviceType":"ACCESS_POINT","firmwareVersion":"8.5.2.0_59123","floorId":"1120972196_1_","id":"CMZR001874","ipv4":"114.191.59.254","ipv6":"10.27.119.19","lastSeenAt":null,"macAddress":"bb:5d:11:85:c0:00","model":"AP-115","notes":"Device is located in Building A, Floor 2","partNumber":"JZ336A","role":"Conductor","serialNumber":"CMZR001874","siteId":"1120972196","siteName":"site-12-dec","status":"ONLINE","type":"network-monitoring/device-monitoring","uptimeInMillis":1702794777},"properties":{"buildingId":{"$ref":"#/components/schemas/BuildingId__6b9c5f08b869"},"clusterName":{"$ref":"#/components/schemas/ClusterName__3a50015484e1"},"configLastModifiedAt":{"$ref":"#/components/schemas/ConfigLastModifiedAt__6b9c5f08b869"},"configStatus":{"$ref":"#/components/schemas/ConfigStatus__6b9c5f08b869"},"deployment":{"$ref":"#/components/schemas/Deployment__6b9c5f08b869"},"deviceFunction":{"$ref":"#/components/schemas/DeviceFunction__6b9c5f08b869"},"deviceName":{"$ref":"#/components/schemas/DeviceNamedevice__6b9c5f08b869"},"deviceType":{"$ref":"#/components/schemas/DeviceTypedevice__6b9c5f08b869"},"firmwareVersion":{"$ref":"#/components/schemas/FirmwareVersion__6b9c5f08b869"},"floorId":{"$ref":"#/components/schemas/FloorId__6b9c5f08b869"},"id":{"$ref":"#/components/schemas/IDdevice__6b9c5f08b869"},"ipv4":{"$ref":"#/components/schemas/IPv4Address__6b9c5f08b869"},"ipv6":{"$ref":"#/components/schemas/IPv6Address__6b9c5f08b869"},"lastSeenAt":{"$ref":"#/components/schemas/LastSeenAt__6b9c5f08b869"},"macAddress":{"$ref":"#/components/schemas/MacAddress__6b9c5f08b869"},"model":{"$ref":"#/components/schemas/Model__6b9c5f08b869"},"notes":{"$ref":"#/components/schemas/Notes__6b9c5f08b869"},"partNumber":{"$ref":"#/components/schemas/PartNumber__6b9c5f08b869"},"role":{"$ref":"#/components/schemas/Role__6b9c5f08b869"},"serialNumber":{"$ref":"#/components/schemas/SerialNumber__05867e444b37"},"siteId":{"$ref":"#/components/schemas/SiteIDdevice__6b9c5f08b869"},"siteName":{"$ref":"#/components/schemas/SiteNamedevice__6b9c5f08b869"},"status":{"$ref":"#/components/schemas/Status__6b9c5f08b869"},"type":{"$ref":"#/components/schemas/Typedevice__0288a339fc72"},"uptimeInMillis":{"$ref":"#/components/schemas/UptimeInMillis__6b9c5f08b869"}},"required":["serialNumber","macAddress","deviceName","deviceType","siteId","id","type"],"type":"object"},"DeviceSerialNum__7006262f8c4c":{"description":"The serial number of the device.\n","examples":["GW00000001"],"maxLength":128,"type":"string"},"DeviceSerial__6a214df6704a":{"description":"The device serial number.\n","examples":["AP00000001"],"format":"const","maxLength":16,"type":"string"},"DeviceSummary__097c7eac5a23":{"properties":{"nonassociatedDevices":{"properties":{"aps":{"format":"int32","maximum":999999,"minimum":0,"type":"integer"}},"type":"object"},"nondeployedDevices":{"properties":{"aps":{"format":"int32","maximum":999999,"minimum":0,"type":"integer"}},"type":"object"}},"type":"object"},"DeviceType__6a214df6704a":{"description":"A string indicating the networking device type.\n","enum":["ACCESS_POINT","SWITCH","GATEWAY"],"type":"string"},"DeviceType__f8f342aecdae":{"description":"The type of the device.\n","examples":["GW"],"maxLength":64,"type":"string"},"DeviceTypedevice__6b9c5f08b869":{"description":"The type of network device.","enum":["ACCESS_POINT","SWITCH","GATEWAY"],"example":"ACCESS_POINT","type":"string"},"DeviceTypefirmware__c0c1228d8f7d":{"description":"The type of network device.\n","enum":["ACCESS_POINT","SWITCH","GATEWAY"],"example":"ACCESS_POINT","type":"string"},"DeviceTypesHealth__ac50e32cc892":{"properties":{"health":{"properties":{"groups":{"items":{"properties":{"name":{"example":"Fair","type":"string"},"value":{"example":4,"type":"integer"}},"type":"object"},"type":"array"}},"type":"object"},"name":{"example":"Access Points","type":"string"}},"type":"object"},"DeviceassignmentPost__3879aac47dc4":{"properties":{"code":{"description":"status code.\n","example":"SUC-001","format":"const","maxLength":32,"type":"string"},"devices":{"items":{"properties":{"failedDevices":{"items":{"description":"Device serial number.\n","example":"AP00000001","format":"const","maxLength":16,"type":"string"},"maxItems":9999,"type":"array"},"floor":{"$ref":"#/components/schemas/uuId__08d3c9863d87"},"statusCode":{"description":"status code.\n","example":"SUC-001","format":"const","maxLength":512,"type":"string"},"statusMessage":{"description":"status message.\n","example":"Successfully assigned","format":"const","maxLength":512,"type":"string"},"successDevices":{"items":{"description":"Device serial number.\n","example":"AP00000001","format":"const","maxLength":16,"type":"string"},"maxItems":9999,"type":"array"}},"type":"object"},"maxItems":9999,"type":"array"},"message":{"description":"status message.\n","example":"Successfully placed","format":"const","maxLength":512,"type":"string"},"status":{"description":"final status.\n","example":"SUCCESS","format":"const","maxLength":32,"type":"string"}},"required":["code","message","status"],"type":"object"},"DeviceplacementPost__436382863a4e":{"properties":{"code":{"description":"status code.\n","example":"SUC-001","format":"const","maxLength":32,"type":"string"},"devicesPlacementResults":{"items":{"properties":{"floor":{"description":"Id of the floor for which the device related information is requested.","example":"fff2bd91-de81-4097-8420-3ca7f87450fd","maxLength":256,"type":"string"},"lpId":{"description":"Device Id incase of Planned devices.\n","example":"qwf2bd91-de81-4097-8420-3ca7f87450fd","format":"const","maxLength":16,"type":"string"},"serial":{"description":"Device serial number incase of real devices\n","example":"AP00000001","format":"const","maxLength":16,"type":"string"},"statusCode":{"description":"Status code for individual  device placement.\n","example":"SUC-001","format":"const","maxLength":128,"type":"string"},"statusMessage":{"description":"Status message for device placement.\n","example":"Device placed successfully","format":"const","maxLength":512,"type":"string"}},"type":"object"},"maxItems":9999,"type":"array"},"message":{"description":"status message.\n","example":"Successfully placed","format":"const","maxLength":512,"type":"string"},"status":{"description":"final status.\n","example":"SUCCESS","format":"const","maxLength":32,"type":"string"}},"required":["devicesPlacementResults"],"type":"object"},"Devices__b8d35392fbec":{"properties":{"conductorSerial":{"description":"Serial number of the conductor (if applicable)","example":null,"type":"string"},"deployment":{"description":"Deployment type of the device","example":"Standalone","type":"string"},"deviceFunction":{"description":"Device Function of the device","example":"Access Switch","type":"string"},"health":{"description":"Health status of the device","example":"Good","type":"string"},"healthReason":{"description":"Reason for the current health status","example":null,"type":"string"},"internet":{"description":"Indicates if the device has internet access","example":false,"type":"boolean"},"ipv4":{"description":"IPv4 address of the device","example":"10.97.64.117","type":"string"},"lastSeen":{"description":"Timestamp of the last time the device was seen","example":0,"format":"float","type":"number"},"mac":{"description":"MAC address of the device","example":"88:3A:30:94:C3:40","type":"string"},"model":{"description":"Model of the device","example":"CX-6300M","type":"string"},"name":{"description":"Name of the device","example":"G-SG99KN3020","type":"string"},"serial":{"description":"Serial number of the device. For unmanaged devices, this value follows the format tpd_<mac>, where the mac address is used without colons","example":"tpd_883a3094c340","type":"string"},"status":{"description":"Current status of the device","example":"ONLINE","type":"string"},"type":{"description":"Type of the device","example":"Switch","type":"string"}},"type":"object"},"DisconnectClientByMacGwRequest__444ca2202914":{"properties":{"clientMacAddress":{"description":"MAC address of the client to disconnect.","type":"string"}},"required":["clientMacAddress"],"title":"GATEWAY DISCONNECT CLIENT BY MAC REQUEST","type":"object"},"DisconnectUserByMacApRequest__f6f569e0e58f":{"properties":{"userMacAddress":{"description":"MAC address of the user to disconnect.","type":"string"}},"required":["userMacAddress"],"title":"AP DISCONNECT USER BY MAC REQUEST","type":"object"},"DisconnectUserByNetworkApRequest__a6e5659453ab":{"properties":{"networkName":{"description":"Name (SSID) of the network from which to disconnect users.","type":"string"}},"required":["networkName"],"title":"AP DISCONNECT USER BY NETWORK REQUEST","type":"object"},"Drops__34350f7e707e":{"description":"Indicates the drop frames percentage.\n","example":"77.44","maxLength":16,"type":"string"},"Duplexgw__988495a6329d":{"description":"The Duplex of the port.\n","enum":["Full","Half","Auto"],"example":"Full","type":"string"},"Email__70734de364b7":{"description":"Specifies the particular user email","examples":["user1@mail.com"],"format":"email","pattern":"^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$","type":"string"},"Emails__70734de364b7":{"description":"Specifies the user emails","examples":[["user1@mail.com","user2@mail.com"]],"items":{"$ref":"#/components/schemas/Email__70734de364b7"},"type":"array"},"EncapsulationType__0f1d40c88b6b":{"description":"The encapsulation type used for the tunnel.","example":"IPSec","format":"const","maxLength":32,"type":"string"},"Encapsulation__2ca376caec3f":{"description":"Specifies the type of encapsulation used for the tunnel configured on the gateway.\n","enum":["IPSec","GRE","vxlan"],"example":"802.1Q","maxLength":5,"type":"string"},"Encryption__2ca376caec3f":{"description":"The encryption method used in the tunnel.\n","enum":["3DES","AES-128","AES-192","AES-256","DES","BLOWFISH","AES-CTR","AES-GCM-128","AES-GCM-256","AES-GMAC","ESP-NULL"],"example":"AES-256","type":"string"},"Encryption__d67ae4720000":{"description":"Specifies the wireless security protocol used by this SSID","enum":["UNSPECIFIED","OPEN","WEP","WPA","WPA2","WPA3"],"examples":["WPA2"],"type":"string"},"EndAt__0052b7c55291":{"description":"End time in epoch for the location analytics trends/insights.","example":"1683284400000","format":"const","type":"string"},"EndQueryTime__000172564380":{"description":"End timestamp in epoch time milliseconds for the query. (Default: current time)","examples":[1698246458000],"format":"int64","maximum":9223372036854776000,"minimum":0,"type":"integer"},"Endpoint__2efde5827a74":{"description":"The URL to which the webhook payloads will be sent.","type":"string"},"EntityCountHealth__edaaa4919013":{"properties":{"count":{"example":125,"type":"integer"},"health":{"$ref":"#/components/schemas/Health__0bffa6fb51f5"}},"type":"object"},"EntityNameHealth__0bffa6fb51f5":{"properties":{"health":{"$ref":"#/components/schemas/Health__0bffa6fb51f5"},"name":{"example":"Switches","type":"string"}},"type":"object"},"Error400__254f45b253d0":{"description":"Error details returned from the server.\n","properties":{"debugId":{"description":"This can be used to help with troubleshooting\n","example":"abc-123-456","format":"const","maxLength":50,"type":"string"},"errorCode":{"description":"Internal error code.\n","example":"HPE_GL_FLOORPLAN_BAD_REQUEST","format":"const","maxLength":32,"type":"string"},"httpStatusCode":{"description":"HTTP status code.\n","example":400,"maximum":400,"minimum":400,"type":"integer"},"message":{"description":"Error message indicating the cause of the failure.\n","example":"Bad request","format":"const","maxLength":512,"type":"string"}},"required":["httpStatusCode","errorCode","message","debugId"],"type":"object"},"Error400__3f58b16772b5":{"description":"Bad request error details","properties":{"debugId":{"$ref":"#/components/schemas/debugIdwifi__000172564380"},"errorCode":{"description":"A unique machine-friendly, but human-readable identifier for the error. It has prefix HPE_GL_.","enum":["HPE_GL_NETWORK_SERVICES_WIFI_CLIENT_LOCATION_INVALID_PAGE_INFO_INPUT","HPE_GL_NETWORK_SERVICES_WIFI_CLIENT_LOCATION_INVALID_QUERY_TIME","HPE_GL_NETWORK_SERVICES_WIFI_CLIENT_LOCATION_DUPLICATE_INPUT_FILTER_FIELDS","HPE_GL_NETWORK_SERVICES_WIFI_CLIENT_LOCATION_INVALID_FIELD_INPUT","HPE_GL_NETWORK_SERVICES_WIFI_CLIENT_LOCATION_SITE_ID_FILTER_NOT_FOUND","HPE_GL_NETWORK_SERVICES_WIFI_CLIENT_LOCATION_INVALID_QUERY_PARAMSD","HPE_GL_NETWORK_SERVICES_WIFI_CLIENT_LOCATION_INVALID_FILTER_INPUT"],"example":"HPE_GL_NETWORK_SERVICES_WIFI_CLIENT_LOCATION_INVALID_PAGE_INFO_INPUT","format":"const","maxLength":128,"type":"string"},"httpStatusCode":{"description":"HTTP status code.","example":400,"maximum":400,"minimum":400,"type":"integer"},"message":{"$ref":"#/components/schemas/message__000172564380"}},"required":["httpStatusCode","errorCode","message","debugId"],"type":"object"},"Error404__0052b7c55291":{"description":"Resource not found error details","properties":{"debugId":{"$ref":"#/components/schemas/debugIdwifi__000172564380"},"errorCode":{"description":"A unique machine-friendly, but human-readable identifier for the error. It has prefix HPE_GL_.","enum":["HPE_GL_NETWORK_SERVICES_WIFI_CLIENT_LOCATION_CLIENT_MAC_NOT_FOUND"],"example":"HPE_GL_NETWORK_SERVICES_WIFI_CLIENT_LOCATION_CLIENT_MAC_NOT_FOUND","format":"const","maxLength":128,"type":"string"},"httpStatusCode":{"description":"HTTP status code.","example":404,"maximum":404,"minimum":404,"type":"integer"},"message":{"$ref":"#/components/schemas/message__000172564380"}},"required":["httpStatusCode","errorCode","message","debugId"],"type":"object"},"Error404__0288a339fc72":{"description":"Error details returned from the server.","properties":{"debugId":{"description":"This can be used to help with troubleshooting","example":"abc-123-456","format":"const","maxLength":50,"type":"string"},"errorCode":{"description":"Internal error code.","example":"HPE_GL_ERROR_NOT_FOUND","format":"const","maxLength":32,"type":"string"},"httpStatusCode":{"description":"HTTP status code.","example":404,"maximum":404,"minimum":404,"type":"integer"},"message":{"description":"Not Found.","example":"Not Found","format":"const","maxLength":512,"type":"string"}},"required":["httpStatusCode","errorCode","message","debugId"],"type":"object"},"Error429__254f45b253d0":{"description":"Error details returned from the server.\n","properties":{"debugId":{"description":"This can be used to help with troubleshooting\n","example":"abc-123-456","format":"const","maxLength":50,"type":"string"},"errorCode":{"description":"Internal error code.\n","example":"HPE_GL_ERROR_TOO_MANY_REQUESTS","format":"const","maxLength":32,"type":"string"},"httpStatusCode":{"description":"HTTP status code.\n","example":429,"maximum":429,"minimum":429,"type":"integer"},"message":{"description":"Rate limit response from the server.\\n\n","example":"Too Many Requests.","format":"const","maxLength":512,"type":"string"}},"required":["httpStatusCode","errorCode","message","debugId"],"type":"object"},"Error500__254f45b253d0":{"description":"Error details returned from the server.","properties":{"debugId":{"description":"This can be used to help with troubleshooting","example":"abc-123-456","format":"const","maxLength":50,"type":"string"},"errorCode":{"description":"Internal error code.","example":"HPE_GL_ERROR_INTERNAL_SERVER_ERROR","format":"const","maxLength":32,"type":"string"},"httpStatusCode":{"description":"HTTP status code.","example":500,"maximum":500,"minimum":500,"type":"integer"},"message":{"description":"Internal Server Error.","example":"Internal Server Error","format":"const","maxLength":512,"type":"string"}},"required":["httpStatusCode","errorCode","message","debugId"],"type":"object"},"ErrorDetails400__0052b7c55291":{"description":"A list of detailed error information for bad requests.","items":{"description":"Details about a specific error.","properties":{"issues":{"description":"A list of issues related to the error.","items":{"description":"Details about a specific issue.","properties":{"description":{"description":"A detailed description of the issue.","example":"The 'name' field is required.","type":"string"},"source":{"description":"The source of the issue.","example":"requestBody","type":"string"},"subject":{"description":"The subject of the issue.","example":"name","type":"string"}},"required":["source","subject"],"type":"object"},"type":"array"},"type":{"description":"The type of the error.","example":"validation_error","type":"string"}},"required":["type","issues"],"type":"object"},"type":"array"},"ErrorMessage__000172564380":{"description":"Error message indicating the cause of the failure.\n","example":"Missing required parameter: start-at","format":"const","maxLength":1024,"type":"string"},"ErrorMessage__0288a339fc72":{"description":"Error message indicating the cause of the failure.\n","examples":["Reason for the error"],"maxLength":512,"type":"string"},"ErrorMessage__66b457073e9b":{"description":"Error message indicating the cause of the failure.\n","examples":["Error message indicating the cause of the failure."],"maxLength":512,"type":"string"},"ErrorMessage__6ff1f6639f14":{"description":"Error message indicating the cause of the failure.\n","example":"Reason for the error","format":"const","maxLength":1024,"type":"string"},"ErrorMessageap__0f1d40c88b6b":{"description":"Error message indicating the cause of the failure.\n","example":"Reason for the error","format":"const","maxLength":512,"type":"string"},"ErrorMessagedevice__039ba698cb40":{"description":"Error message indicating the cause of the failure.","example":"Error Message","format":"const","maxLength":512,"type":"string"},"ErrorResponse__02a6567f3633":{"properties":{"errorCode":{"description":"A unique code identifying the error type.","type":"string"},"message":{"description":"A human-readable description of the error.","type":"string"}},"title":"Error Response","type":"object"},"ErrorResponse__ed65ca41c4fc":{"description":"Standard error response structure","properties":{"debugId":{"description":"A unique identifier for troubleshooting this error","example":"fedcba09-8765-4321-1234-567890abcdef","type":"string"},"errorCode":{"description":"A machine-readable error code","example":"HPE_GL_ERROR_RESOURCE_NOT_FOUND","type":"string"},"httpStatusCode":{"description":"The HTTP status code","example":404,"type":"integer"},"message":{"description":"A human-readable error message","example":"Switch with serial number not found","type":"string"}},"required":["errorCode","message","debugId","httpStatusCode"],"type":"object"},"EventDetails__1335a419f403":{"description":"Detailed information about a specific network event.","properties":{"eventExtraAttributes":{"description":"Additional event attributes as key-value pairs.","items":{"$ref":"#/components/schemas/KeyValuePair__1335a419f403"},"type":"array"}},"required":["eventExtraAttributes"],"type":"object"},"EventFilters__2c64e622674f":{"description":"Available filter options for network events with their respective counts.","properties":{"categories":{"description":"Available event categories with their counts.","items":{"$ref":"#/components/schemas/CategoryFilterItem__2c64e622674f"},"type":"array"},"eventNames":{"description":"Available event names and their corresponding event IDs with their counts.","items":{"$ref":"#/components/schemas/EventNameFilterItem__2c64e622674f"},"type":"array"},"sourceTypes":{"description":"Available source types with their counts.","items":{"$ref":"#/components/schemas/SourceTypeFilterItem__2c64e622674f"},"type":"array"}},"required":["categories","sourceTypes","eventNames"],"type":"object"},"EventList__15b755dc22d8":{"description":"List of network events with pagination information.","properties":{"count":{"description":"Number of events in current response.","example":1,"minimum":0,"type":"integer"},"events":{"description":"Array of network events","items":{"$ref":"#/components/schemas/Event__15b755dc22d8"},"type":"array"},"next":{"$ref":"#/components/schemas/NextResponse__15b755dc22d8"},"total":{"description":"Total number of events matching the query criteria.","example":2,"minimum":0,"type":"integer"}},"required":["events","count","total"],"type":"object"},"EventNameFilterItem__2c64e622674f":{"description":"Event name filter item with count and identifier information.","properties":{"count":{"description":"Number of events with this event name.","example":18,"minimum":0,"type":"integer"},"eventId":{"description":"Unique identifier for the event type.","example":10,"minimum":1,"type":"integer"},"eventName":{"description":"Name of the event.","example":"Client 802.1x Radius Timeout","type":"string"}},"required":["eventName","eventId","count"],"type":"object"},"EventTime__000172564380":{"description":"The timestamp of the signature. RFC 3339 (and ISO 8601) in UTC+0 timezone.","examples":["2023-10-01T12:00:00.000Z"],"format":"date-time","maxLength":24,"type":"string"},"Event__15b755dc22d8":{"description":"Network event details.","properties":{"bssid":{"description":"Basic Service Set Identifier for wireless events.","example":"aa:bb:cc:dd:ee:11","type":"string"},"category":{"description":"Event category.","example":"Connectivity","type":"string"},"clientMacAddress":{"description":"MAC address of the client involved in the event.","example":"aa:bb:cc:dd:ee:ff","type":"string"},"description":{"description":"Detailed description of the event.","example":"Client authentication timeout occurred during 802.1x authentication process","type":"string"},"deviceMacAddress":{"description":"MAC address of the device that generated the event.","example":"11:22:33:44:55:66","type":"string"},"eventId":{"description":"The event type identifier","example":"55","type":"string"},"eventIdentifier":{"description":"Unique identifier for the event.","example":"c0975762-4662-463a-b35a-c0126f6ff052","type":"string"},"eventName":{"description":"Name of the event.","example":"Client 802.1x Radius Timeout","type":"string"},"reason":{"description":"Reason or cause of the event.","example":"Authentication timeout","type":"string"},"serialNumber":{"description":"Device serial number","example":"CNW7DXQ123","type":"string"},"severity":{"description":"Severity level of the event.","enum":["positive","negative","neutral"],"example":"negative","type":"string"},"sourceName":{"description":"Name of the device or client that generated the event.","example":"AP-Floor1-001","type":"string"},"sourceType":{"description":"Type of source that generated the event.","enum":["Access Point","Switch","Gateway","Wireless Client","Wired Client","Bridge"],"example":"Access Point","type":"string"},"stackId":{"description":"Stack identifier for stack-capable devices.","example":"stack-001","type":"string"},"timeAt":{"description":"Timestamp when the event occurred at the source, in RFC 3339 format with milliseconds.","example":"2025-08-06T12:34:56.124Z","format":"date-time","type":"string"}},"required":["eventId","eventIdentifier","timeAt","eventName","category","sourceType","sourceName","reason","description","severity"],"type":"object"},"ExpiringLicensePerMonth__bf1f3740b270":{"properties":{"advancedExpCount":{"description":"Total Advanced tier licenses expiring this month.","examples":[8],"minimum":0,"type":"integer"},"advancedExpCountAp":{"description":"Advanced licenses expiring for Access Points.","examples":[5],"minimum":0,"type":"integer"},"advancedExpCountGw":{"description":"Advanced licenses expiring for Gateways.","examples":[1],"minimum":0,"type":"integer"},"advancedExpCountOt":{"description":"Advanced licenses expiring for Other device types.","examples":[0],"minimum":0,"type":"integer"},"advancedExpCountSw":{"description":"Advanced licenses expiring for Switches.","examples":[2],"minimum":0,"type":"integer"},"foundationExpCount":{"description":"Total Foundation tier licenses expiring this month.","examples":[15],"minimum":0,"type":"integer"},"foundationExpCountAp":{"description":"Foundation licenses expiring for Access Points.","examples":[10],"minimum":0,"type":"integer"},"foundationExpCountGw":{"description":"Foundation licenses expiring for Gateways.","examples":[2],"minimum":0,"type":"integer"},"foundationExpCountOt":{"description":"Foundation licenses expiring for Other device types.","examples":[0],"minimum":0,"type":"integer"},"foundationExpCountSw":{"description":"Foundation licenses expiring for Switches.","examples":[3],"minimum":0,"type":"integer"},"month":{"description":"Month name in uppercase (e.g. FEBRUARY).","examples":["FEBRUARY"],"type":"string"},"monthYear":{"description":"Combined month-year label in uppercase (e.g. FEBRUARY-2026).","examples":["FEBRUARY-2026"],"type":"string"},"otherExpCount":{"description":"Total Other tier licenses expiring this month.","examples":[3],"minimum":0,"type":"integer"},"otherExpCountAp":{"description":"Other tier licenses expiring for Access Points.","examples":[2],"minimum":0,"type":"integer"},"otherExpCountGw":{"description":"Other tier licenses expiring for Gateways.","examples":[0],"minimum":0,"type":"integer"},"otherExpCountOt":{"description":"Other tier licenses expiring for Other device types.","examples":[0],"minimum":0,"type":"integer"},"otherExpCountSw":{"description":"Other tier licenses expiring for Switches.","examples":[1],"minimum":0,"type":"integer"},"sequence":{"description":"Sequence number of the month (1-12).","examples":[1],"maximum":12,"minimum":1,"type":"integer"},"year":{"description":"Year (e.g. 2026).","examples":[2026],"type":"integer"}},"required":["sequence","month","year","monthYear","foundationExpCount","advancedExpCount","otherExpCount","foundationExpCountAp","foundationExpCountSw","foundationExpCountGw","foundationExpCountOt","advancedExpCountAp","advancedExpCountSw","advancedExpCountGw","advancedExpCountOt","otherExpCountAp","otherExpCountSw","otherExpCountGw","otherExpCountOt"],"type":"object"},"ExpiringLicensesSummary__bf1f3740b270":{"properties":{"count":{"description":"Total number of monthly entries returned (always 12).","examples":[12],"type":"integer"},"id":{"description":"Unique identifier for this summary resource (tenant ID).","examples":["tenant-12345"],"type":"string"},"items":{"description":"List of expiring license counts for each of the next 12 months.","items":{"$ref":"#/components/schemas/ExpiringLicensePerMonth__bf1f3740b270"},"maxItems":12,"minItems":12,"type":"array"},"type":{"description":"Resource type identifier.","examples":["network-monitoring/subscription-expiring-summary"],"type":"string"}},"required":["id","type","items","count"],"type":"object"},"ExportDetail__c419fe321fd2":{"properties":{"exportType":{"$ref":"#/components/schemas/ReportFormat__70734de364b7"},"status":{"$ref":"#/components/schemas/ExportStatus__c419fe321fd2"}},"type":"object"},"ExportStatus__c419fe321fd2":{"description":"Specifies the report export status as New, In Progress, Completed, or Failed","enum":["NEW","IN_PROGRESS","COMPLETED","FAILED"],"examples":["COMPLETED"],"type":"string"},"FilterMeta__66b457073e9b":{"properties":{"description":{"examples":["Sites Filter"],"type":"string"},"displayName":{"examples":["Sites"],"type":"string"},"filter":{"examples":["sites"],"type":"string"},"validations":{"items":{"$ref":"#/components/schemas/ReportValidation__66b457073e9b"},"type":"array"}},"type":"object"},"Filter__097c7eac5a23":{"description":"OData Version 4.0 filter string (limited functionality).\n<br> Supports only `eq` and `in` operations (`gt`, `ge`, `lt` and `le` are NOT supported). </br> Supports only `and` conjunction (`or` and `not` are NOT supported).\n<br>Supported __filter__ fields are:  </br>\n* `floorId` \n* `buildingId`  \n* `types` (devicetypes- `in` operator must be used )\n","example":"floorId eq 'dd5ccb1f-9b65-42a8-b50e-faa7842bbcd8'","format":"const","maxLength":256,"type":"string"},"Filter__6a214df6704a":{"description":"OData Version 4.0 filter string (limited functionality).\nSupports only 'eq' operations ('gt', 'ge', 'lt', 'le' and 'in' are NOT supported).\nSupports only 'and' conjunction ('or' and 'not' are NOT supported).\nSupported filter fields are: floorId and buildingId.\n","format":"const","maxLength":256,"type":"string"},"Filter__6ff1f6639f14":{"example":"deviceOwnership in ('MSP')","format":"const","maxLength":256,"type":"string"},"Filter__c34075768619":{"properties":{"filterType":{"type":"string"},"values":{"items":{"type":"string"},"type":"array"}},"required":["filterType","values"],"type":"object"},"Filterasset__acdf4895bcad":{"description":"OData Version 4.0 filter string (limited functionality).\nSupports only 'eq' and 'in' for 'any' operation.","example":"metadata/labels/any(t:t in ('Wheelchair', 'Prenatal'))","format":"const","maxLength":256,"type":"string"},"Filters__c34075768619":{"description":"Report filters","items":{"$ref":"#/components/schemas/Filter__c34075768619"},"type":"array"},"Filterswitch__244c7d3b837e":{"format":"const","maxLength":256,"type":"string"},"FirmwareClassification__c0c1228d8f7d":{"description":"The classification of the firmware version.\n","example":"Bug Fix","format":"const","maxLength":32,"type":"string"},"FirmwareDetailsListResponse__c0c1228d8f7d":{"allOf":[{"properties":{"items":{"items":{"properties":{"deviceName":{"$ref":"#/components/schemas/DeviceName__c0c1228d8f7d"},"deviceType":{"$ref":"#/components/schemas/DeviceTypefirmware__c0c1228d8f7d"},"firmwareClassification":{"$ref":"#/components/schemas/FirmwareClassification__c0c1228d8f7d"},"firmwareVersion":{"$ref":"#/components/schemas/FirmwareVersion__c0c1228d8f7d"},"id":{"$ref":"#/components/schemas/ID__c0c1228d8f7d"},"lastUpgradedTimeAt":{"$ref":"#/components/schemas/LastUpgradedTimeAt__c0c1228d8f7d"},"recommendedVersion":{"$ref":"#/components/schemas/RecommendedVersion__c0c1228d8f7d"},"serialNumber":{"$ref":"#/components/schemas/SerialNumber__c0c1228d8f7d"},"siteId":{"$ref":"#/components/schemas/SiteIDfirmware__c0c1228d8f7d"},"siteName":{"$ref":"#/components/schemas/SiteName__c0c1228d8f7d"},"type":{"$ref":"#/components/schemas/Type__c0c1228d8f7d"},"upgradeStatus":{"$ref":"#/components/schemas/UpgradeStatus__c0c1228d8f7d"}},"required":["serialNumber","deviceName","recommendedVersion","upgradeStatus","firmwareClassification","lastUpgradedTimeAt","deviceType","siteId","siteName","id","type","firmwareVersion"],"type":"object"},"maxItems":1000,"type":"array"}},"required":["items"],"type":"object"},{"$ref":"#/components/schemas/PaginatedResponse__c0c1228d8f7d"}],"example":{"count":1,"items":[{"deviceName":"AP00000001","deviceType":"ACCESS_POINT","firmwareClassification":"","firmwareVersion":"8.5.2.0_59123","id":"AP00000001","lastUpgradedTimeAt":"2024-04-30T06:52:18.712Z","recommendedVersion":"8.6.0.6_77023","serialNumber":"AP00000001","siteId":"1120972196","siteName":"Site1","type":"network-services/firmware-management","upgradeStatus":"Up To Date"}],"next":"2","total":4}},"FirmwareVersion__6b9c5f08b869":{"description":"Firmware version currently running on the device.","example":"8.5.2.0_59123","format":"const","maxLength":32,"type":"string"},"FirmwareVersion__c0c1228d8f7d":{"description":"Firmware version currently running on the device.\n","example":"8.5.2.0_59123","format":"const","maxLength":32,"type":"string"},"FirmwareVersionap__98bb0f033247":{"description":"Firmware version currently running on the access point. \n","example":"8.5.2.0_59123","format":"const","maxLength":32,"type":"string"},"FirmwareVersiongw__3b77411f6985":{"description":"Firmware version currently running on the gateway.\n","example":"8.5.2.0_59123","maxLength":32,"type":"string"},"FirstDetDeviceName__d67ae4720000":{"description":"Name of AP that first detected the monitored AP","examples":["Building-A-Floor-2-AP-001"],"maxLength":128,"type":"string"},"FirstDetDeviceSerial__d67ae4720000":{"description":"Serial of AP that first detected the monitored AP","examples":["QWR124780123"],"maxLength":20,"type":"string"},"FirstSeen__a39bf531822f":{"description":"The first-seen date/time of the tag.","example":"2023-10-01T12:00:00Z","format":"date-time","maxLength":20,"type":"string"},"FirstSeenwids__d67ae4720000":{"description":"The first seen time of the Monitored AP. RFC 3339 (and ISO 8601) in UTC+0 timezone.","examples":["2023-10-01T12:00:00.000Z"],"format":"date-time","maxLength":24,"type":"string"},"FloorId__6a214df6704a":{"description":"Floor ID associated with the device in UUID format.\n","examples":["16a-aad7-4070-8a19-fd6b8e1ff012"],"format":"uuid","maxLength":128,"type":["string"]},"FloorId__6b9c5f08b869":{"description":"Floor ID associated with the device in UUID format. Omitted if no specific floor is associated with the device.","example":"16a-aad7-4070-8a19-fd6b8e1ff012","format":"uuid","maxLength":128,"type":"string"},"FloorIdap__da78704f9a76":{"description":"Floor ID associated with the access point in UUID format. Omitted if no specific floor is associated with the access point.\n","example":"16a0aad7-4070-4a19-8a19-fd6b8e1ff012","format":"uuid","maxLength":128,"type":"string"},"FloorIdasset__a39bf531822f":{"description":"Floor ID associated with the Asset Tag.","examples":["3b5b-0e6c-4b73-9f6e-4e895a080190"],"format":"uuid","maxLength":128,"type":"string"},"FloorIdopen__16fa337a67ef":{"description":"The Floor ID associated with the device in UUID format.\n","examples":["16a-aad7-4070-8a19-fd6b8e1ff012"],"format":"uuid","maxLength":128,"type":"string"},"FloorIdwifi__3f58b16772b5":{"description":"Floor ID associated with the client in UUID format.\n","example":"9f50f534-c117-48f8-9bf8-a6594e1f49a5","format":"uuid","maxLength":36,"type":"string"},"FloorLevel__6a214df6704a":{"description":"If included this field contains a logical representation of the floor level. This value is relevant only in relation to a building; the value is relative to the ground level of the building which is assigned the number 0.\n\nDetermining what floor is at ground level and what constitutes a sub-floor as opposed to a naturally numbered floor is left to local interpretation.\n\nLarger values represent floors that are farther away from floor 0 such that\n* if positive the floor value is farther above the ground floor\n* if negative the floor value is farther below the ground floor\n\nNon-integer values can be used to represent intermediate or sub-floors, such as mezzanine levels.  Example: a mezzanine between floor 1 and floor 2 could be represented as a value of 1.25.  Example: mezzanines between floor 4 and floor 5 could be represented as values of 4.5 and 4.75.\n\nIf the field is absent floor 0 must be assumed.\n","examples":[1],"type":["number"]},"FloorMapInput__a543176a6d36":{"description":"FloorMapInput inputs used to create a floor","properties":{"buildingId":{"description":"Id of the building in which floor will be created\n","example":"a97695c-a119-45f0-b6ea-a30a83931","maxLength":128,"type":"string"},"buildingName":{"description":"Name of the building in which floor will be created.\n","example":"Brooke","maxLength":32,"type":"string"},"ceilingHeight":{"description":"CeilingHeight of the floor.\n","example":"12.2","format":"double","maxLength":128,"type":"number"},"name":{"description":"Name of the floor.\n","example":"Floor 1","format":"string","maxLength":32,"type":"string"},"ordinal":{"description":"FloorNumber.\n","example":"1.1","format":"double","maxLength":32,"type":"number"},"siteId":{"description":"Site under which the floor will be created.\n","example":"16a-aad7-4070-8a19-fd6b8e1ff012","maxLength":128,"type":"string"}},"required":["siteId","ceilingHeight","name","ordinal"],"type":"object"},"FloorMapResponse__232e2ad4eff8":{"description":"FloorMap Response","properties":{"floorId":{"format":"uuid","type":"string"},"id":{"description":"floorId associated with the site commonly in UUID format.\n","example":"3b5b-0e6c-4b73-9f6e-4e895a080190","format":"const","maxLength":20,"type":"string"},"properties":{"properties":{"breadth":{"format":"double","type":"number"},"buildingId":{"format":"uuid","type":"string"},"length":{"format":"double","type":"number"},"name":{"format":"string","type":"string"},"ordinal":{"format":"double","type":"number"},"siteId":{"format":"uuid","type":"string"}},"type":"object"},"tenantId":{"format":"string","type":"string"},"type":{"description":"API type.\n","example":"feature","format":"const","maxLength":512,"type":"string"}},"required":["id","type","floorId","properties"],"type":"object"},"FloorMapScaleInput__e40c06be8034":{"description":"floorMapScale input to update floor scale details","properties":{"anchor1Geometry":{"$ref":"#/components/schemas/AnchorGeometry__e40c06be8034"},"anchor2Geometry":{"$ref":"#/components/schemas/AnchorGeometry__e40c06be8034"},"distance":{"format":"double","type":"number"},"from":{"$ref":"#/components/schemas/Point__e40c06be8034"},"to":{"$ref":"#/components/schemas/Point__e40c06be8034"}},"required":[],"type":"object"},"FloorName__a39bf531822f":{"description":"The name of the floor.","example":"First Floor","type":"string"},"FloorNumber__a39bf531822f":{"description":"The number of the floor.","example":"1.1","format":"float","type":"number"},"FloorSummary__097c7eac5a23":{"properties":{"deviceSummary":{"$ref":"#/components/schemas/DeviceSummary__097c7eac5a23"},"floorId":{"$ref":"#/components/schemas/uuId__08d3c9863d87"}},"type":"object"},"FlowId__7006262f8c4c":{"description":"The flow ID of the threat\n","examples":[12345],"format":"int64","type":"integer"},"ForbiddenErrorDetails__0c2a95c4aa99":{"description":"Error details returned from the server.","properties":{"debugId":{"$ref":"#/components/schemas/DebugId__0c2a95c4aa99"},"errorCode":{"description":"Internal error code.","example":"HPE_GL_NETWORK_NOTIFICATIONS_FORBIDDEN","maxLength":128,"type":"string"},"httpStatusCode":{"description":"HTTP status code.","example":403,"maximum":403,"minimum":403,"type":"integer"},"message":{"description":"Error message indicating the cause of the failure.","example":"Access forbidden.","maxLength":512,"type":"string"}},"required":["httpStatusCode","errorCode","message","debugId"],"type":"object"},"ForbiddenError__02a6567f3633":{"description":"Forbidden error details returned from the server.","properties":{"debugId":{"description":"Debug identifier for troubleshooting.","example":"abc-123-456","maxLength":256,"type":"string"},"errorCode":{"description":"Error code for the specific error.","example":"HPE_GL_ERROR_FORBIDDEN","maxLength":256,"type":"string"},"httpStatusCode":{"description":"HTTP status code.","example":403,"maximum":403,"minimum":403,"type":"integer"},"message":{"description":"Error message describing the issue.","example":"Insufficient permissions to access this resource","maxLength":1024,"type":"string"}},"required":["httpStatusCode","errorCode","message","debugId"],"type":"object"},"ForbiddenError__66b457073e9b":{"description":"Forbidden error details returned from the server.\n","properties":{"debugId":{"$ref":"#/components/schemas/DebugId__0288a339fc72"},"errorCode":{"description":"* A unique machine-friendly, but human-readable identifier for the error. It has prefix HPE_GL_.\n* For more details regarding error please refer to error message\n","examples":["HPE_GL_ERROR_FORBIDDEN"],"maxLength":256,"type":"string"},"httpStatusCode":{"description":"HTTP status code.\n","examples":[403],"maximum":403,"minimum":403,"type":"integer"},"message":{"$ref":"#/components/schemas/ErrorMessage__66b457073e9b"}},"required":["httpStatusCode","errorCode","message","debugId"],"type":"object"},"ForbiddenError__6ff1f6639f14":{"description":"Forbidden error details returned from the server.\n","properties":{"debugId":{"$ref":"#/components/schemas/DebugId__000172564380"},"errorCode":{"description":"* A unique machine-friendly, but human-readable identifier for the error. It has prefix HPE_GL_.\n* For more details regarding error please refer to error message\n","example":"HPE_GL_ERROR_FORBIDDEN","maxLength":256,"type":"string"},"httpStatusCode":{"description":"HTTP status code.\n","example":403,"maximum":403,"minimum":403,"type":"integer"},"message":{"$ref":"#/components/schemas/ErrorMessage__6ff1f6639f14"}},"required":["httpStatusCode","errorCode","message","debugId"],"type":"object"},"ForbiddenRequest__004689200476":{"description":"Forbidden error details returned from the server.","properties":{"debugId":{"$ref":"#/components/schemas/DebugIdtopology__004689200476"},"errorCode":{"description":"* A unique machine-friendly, but human-readable identifier for the error. It has prefix HPE_GL_.* For more details regarding error please refer to error message","example":"HPE_GL_ERROR_FORBIDDEN","maxLength":256,"type":"string"},"httpStatusCode":{"description":"HTTP status code.","example":403,"maximum":403,"minimum":403,"type":"integer"},"message":{"$ref":"#/components/schemas/ErrorMessagedevice__039ba698cb40"}},"required":["httpStatusCode","errorCode","message","debugId"],"type":"object"},"Forbidden__0052b7c55291":{"description":"Forbidden, request not authorized","properties":{"debugId":{"$ref":"#/components/schemas/debugIdwifi__000172564380"},"errorCode":{"description":"* A unique machine-friendly, but human-readable identifier for the error. It has prefix HPE_GL_.\n* For more details regarding error please refer to error message\n","example":"HPE_GL_ERROR_FORBIDDEN","maxLength":256,"type":"string"},"httpStatusCode":{"description":"HTTP status code.\n","example":"403","maximum":403,"minimum":403,"type":"integer"},"message":{"$ref":"#/components/schemas/message__000172564380"}},"required":["httpStatusCode","errorCode","message","debugId"],"type":"object"},"FromChannel__972dd6d46bea":{"description":"Specifies the channel from which the client roamed.","example":"1","type":"string"},"GatewayClusterTunnelListResponse__608b430a0026":{"allOf":[{"properties":{"items":{"items":{"properties":{"destinationIpAddress":{"$ref":"#/components/schemas/DestinationIpAddressgw__2ca376caec3f"},"destinationName":{"$ref":"#/components/schemas/DestinationNamegw__608b430a0026"},"destinationSerial":{"$ref":"#/components/schemas/DestinationSerial__608b430a0026"},"destinationSite":{"$ref":"#/components/schemas/DestinationSite__608b430a0026"},"encapsulation":{"$ref":"#/components/schemas/Encapsulation__2ca376caec3f"},"gateway":{"$ref":"#/components/schemas/Gateway__2ca376caec3f"},"gatewayRole":{"$ref":"#/components/schemas/Rolegw__3b77411f6985"},"health":{"description":"The health status of the tunnel.\n","enum":["Good","Fair","Poor"],"example":"Good","maxLength":4,"type":"string"},"healthReasons":{"items":{"enum":["TUNNEL_STATUS","TUNNEL_ENCAPSULATION","TUNNEL_AUTHENTICATION","TUNNEL_ENCRYPTION"],"example":"TUNNEL_STATUS","type":"string"},"type":"array"},"id":{"$ref":"#/components/schemas/IDgw__1053ccf03958"},"mode":{"$ref":"#/components/schemas/Modegw__2ca376caec3f"},"sourceIpAddress":{"$ref":"#/components/schemas/SourceIpAddressgw__2ca376caec3f"},"ssid":{"$ref":"#/components/schemas/Ssid__608b430a0026"},"status":{"description":"The status of the tunnel.\n","enum":["Up","Down"],"example":"Up","maxLength":2,"type":"string"},"tunnelName":{"$ref":"#/components/schemas/TunnelIdgw__2ca376caec3f"},"type":{"$ref":"#/components/schemas/Typegw__1053ccf03958"},"vni":{"$ref":"#/components/schemas/Vni__2ca376caec3f"}},"required":["tunnelName","id","type"],"type":"object"},"maxItems":100,"type":"array"}},"required":["items"],"type":"object"},{"$ref":"#/components/schemas/PaginatedResponsegw__21874c7bfa12"}],"example":{"count":1,"items":[{"destinationIpAddress":"198.167.10.1","destinationName":"CMZR001874","destinationSerial":"CMZR001874","destinationSite":"12345","encapsulation":"IPSec","gateway":"7010_1","gatewayRole":"Isoleader","health":"Good","healthReasons":[],"id":"ap-ipsecmap-00:01:b2:22:02:1f","mode":"ORCH","sourceIpAddress":"0.0.0.0","ssid":"Chennai-Employee, Chennai-Public","status":"Up","tunnelName":"ap-ipsecmap-00:01:b2:22:02:1f","type":"network-monitoring/gateway-monitoring","uptime":123456789,"vni":null}],"next":null,"total":1},"type":"object"},"GatewayCluster__98bb0f033247":{"description":"Name of the gateway cluster to which the AP tunnel is established. \n","format":"const","maxLength":256,"type":"string"},"GatewayDhcpLeaseListResponse__21874c7bfa12":{"allOf":[{"properties":{"items":{"items":{"properties":{"clientDeviceType":{"description":"The device type of the client device.\n","example":"MSFT 5.0","maxLength":256,"type":"string"},"clientSerial":{"description":"The serial number of the client device.\n","example":"CG0021253","maxLength":64,"type":"string"},"clientSiteId":{"description":"The site ID of the client device.\n","example":"24833497","maxLength":128,"type":"string"},"expirationTime":{"description":"The lease expiration time in seconds. It will be '-' if the lease is reserved.\n","example":172800,"format":"double","type":"number"},"hostName":{"description":"The host name of the client device.\n","example":"pc76","maxLength":256,"type":"string"},"infraType":{"description":"The infrastructure type of the client device.\n","enum":["Access Point","Switch","Gateway"],"example":"Switch","type":"string"},"ipAddress":{"description":"The IP address of the client.","example":"10.27.103.87","format":"ipv4","type":"string"},"macAddress":{"description":"The MAC address of the client.\n","example":"11:22:33:44:55:66","maxLength":18,"type":"string"},"poolName":{"description":"The name of the DHCP pool.\n","example":"pool-1","maxLength":256,"type":"string"},"remainingTime":{"description":"The remaining lease time in seconds. It will be 'Reservation' if the lease is reserved.\n","example":"172800","maxLength":256,"type":"string"},"reservation":{"description":"Indicates if the lease is a reservation.\n","enum":["Yes","No"],"example":"Yes","type":"string"},"startTime":{"description":"The lease start time in seconds. It will be '-' if the lease is reserved.\n","example":86400,"format":"double","type":"number"}},"required":["poolName","ipAddress","macAddress","clientSiteId","clientSerial","infraType","hostName","clientDeviceType","startTime","expirationTime","remainingTime","reservation"],"type":"object"},"maxItems":100,"type":"array"}},"required":["items"],"type":"object"},{"$ref":"#/components/schemas/PaginatedResponsegw__21874c7bfa12"}],"example":{"count":1,"items":[{"clientDeviceType":"MSFT 5.0","clientSerial":"CG0021253","clientSiteId":"12345","expirationTime":1756137138062,"hostName":"pc76","infraType":null,"ipAddress":"192.194.57.4","macAddress":"70:cd:0d:0b:40:d2","poolName":"vlan-pool-193","remainingTime":"172800","reservation":"No","startTime":1756136958062}],"next":null,"total":1}},"GatewayDhcpPoolListResponse__f07d3dc27fa5":{"allOf":[{"properties":{"items":{"items":{"properties":{"availableAddresses":{"description":"The number of available addresses in the pool.\n","example":96,"format":"int64","type":"integer"},"currentLeases":{"description":"The number of currently leased addresses from the pool.\n","example":4,"format":"int64","type":"integer"},"leaseDuration":{"description":"The lease duration of the DHCP pool in seconds.\n","example":90061,"format":"int64","maximum":3155760000,"minimum":0,"type":"integer"},"poolName":{"description":"The name of the DHCP pool.\n","example":"pool-1","maxLength":256,"type":"string"},"poolSize":{"description":"The size of the DHCP pool, i.e., the total number of addresses in the pool.\n","example":100,"format":"int64","type":"integer"},"subnet":{"description":"The subnet of the DHCP pool.\n","example":"192.168.3.0/24","type":"string"},"utilization":{"description":"The percentage of the pool that is currently leased.\n","example":4,"format":"int32","type":"integer"},"vlanId":{"description":"The VLAN ID configured in the pool.\n","example":511,"format":"int64","maximum":4095,"minimum":1,"type":"integer"},"vlanName":{"description":"The name of the VLAN.\n","example":"vlan304","type":"string"}},"required":["poolName","vlanId","vlanName","subnet","leaseDuration","poolSize","currentLeases","utilization","availableAddresses"],"type":"object"},"maxItems":100,"type":"array"}},"required":["items"],"type":"object"},{"$ref":"#/components/schemas/PaginatedResponsegw__21874c7bfa12"}],"example":{"count":1,"items":[{"availableAddresses":96,"currentLeases":4,"leaseDuration":90061,"poolName":"pool-1","poolSize":100,"subnet":"192.168.3.0/24","utilization":4,"vlanId":33,"vlanName":"Client-Vlan 1"}],"next":null,"total":1}},"GatewayListResponse__51d6c5968454":{"allOf":[{"properties":{"items":{"items":{"properties":{"clusterName":{"$ref":"#/components/schemas/ClusterNamegw__3b77411f6985"},"cpuUtilization":{"description":"The latest CPU utilization of the gateway, expressed as a percentage (0–100).\n","example":32,"format":"float","type":"number"},"deviceFunction":{"description":"Device function (Persona identifier) for the gateway.\n","enum":["Unspecified","Mobility Controller","Branch Gateway","VPNC"],"example":"VPNC","maxLength":19,"type":"string"},"deviceName":{"$ref":"#/components/schemas/DeviceNamegw__3b77411f6985"},"firmwareVersion":{"$ref":"#/components/schemas/FirmwareVersiongw__3b77411f6985"},"id":{"$ref":"#/components/schemas/IDgw__1053ccf03958"},"ipAddress":{"$ref":"#/components/schemas/Ipv4Addressgw__3b77411f6985"},"macAddress":{"$ref":"#/components/schemas/MacAddressgw__3b77411f6985"},"macRange":{"description":"The MAC address range allocated to the gateway.\n","example":"20:4c:03:14:03:7c-20:4c:03:14:03:9b","maxLength":256,"type":"string"},"memoryUtilization":{"description":"The latest memory utilization of the gateway, expressed as a percentage (0–100).\n","example":32,"format":"float","type":"number"},"mode":{"$ref":"#/components/schemas/Deploymentgw__3b77411f6985"},"model":{"$ref":"#/components/schemas/Modelgw__3b77411f6985"},"rebootReason":{"description":"The last reboot reason of the gateway.\n","example":"Nanny rebooted machine - low on free memory","maxLength":256,"type":"string"},"role":{"$ref":"#/components/schemas/Rolegw__3b77411f6985"},"serialNumber":{"$ref":"#/components/schemas/SerialNumbergw__1053ccf03958"},"siteId":{"$ref":"#/components/schemas/SiteIDgw__3b77411f6985"},"siteName":{"$ref":"#/components/schemas/SiteNamegw__3b77411f6985"},"status":{"description":"The status of the gateway, either Online or Offline.\n","enum":["Online","Offline"],"example":"Online","maxLength":7,"type":"string"},"type":{"$ref":"#/components/schemas/Typegw__1053ccf03958"},"uptimeInMillis":{"$ref":"#/components/schemas/UptimeInMillisgw__3b77411f6985"}},"required":["serialNumber","macAddress","deviceName","cpuUtilization","memoryUtilization","siteId","firmwareVersion","ipAddress","uptimeInMillis","macRange","rebootReason","deviceFunction","mode","status","role","model","siteName","clusterName","id","type"],"type":"object"},"maxItems":1000,"type":"array"}},"required":["items"],"type":"object"},{"$ref":"#/components/schemas/PaginatedResponsegw__21874c7bfa12"}],"example":{"count":1,"items":[{"clusterName":"gateway-cluster-1","cpuUtilization":32,"deviceFunction":"VPNC","deviceName":"gw_1","firmwareVersion":"8.5.2.0_59123","id":"GW00000001","ipAddress":"198.51.100.42","macAddress":"11:22:33:44:55:66","macRange":"20:4c:03:14:03:7c-20:4c:03:14:03:9b","memoryUtilization":45,"mode":"Cluster","model":"Aruba 7005","rebootReason":"Nanny rebooted machine - low on free memory","role":"Isoleader","serialNumber":"GW00000001","siteId":"24833497","siteName":"site_1","status":"Online","type":"network-monitoring/gateway-monitoring","uptimeInMillis":1702794777}],"next":"2","total":4}},"GatewayPingSweepOutput__8aa6df07e528":{"properties":{"averageRoundTripTimeMilliseconds":{"type":"string"},"destination":{"type":"string"},"maximumRoundTripTimeMilliseconds":{"type":"string"},"minimumRoundTripTimeMilliseconds":{"type":"string"},"receivedPacketsCount":{"type":"string"},"responses":{"items":{"$ref":"#/components/schemas/GatewayPingSweepResponseBucket__8aa6df07e528"},"type":"array"},"successRate":{"type":"string"},"transmittedPacketsCount":{"type":"string"}},"required":["destination","successRate","transmittedPacketsCount","receivedPacketsCount","minimumRoundTripTimeMilliseconds","averageRoundTripTimeMilliseconds","maximumRoundTripTimeMilliseconds","responses"],"title":"GATEWAY PING SWEEP OUTPUT","type":"object"},"GatewayPingSweepReply__8aa6df07e528":{"properties":{"requestId":{"type":"string"},"size":{"description":"Packet size actually used for this probe, as a string.","type":"string"},"timedOut":{"type":"boolean"}},"required":["requestId","size","timedOut"],"title":"GATEWAY PING SWEEP REPLY","type":"object"},"GatewayPingSweepRequest__3fdecb5eb736":{"allOf":[{"not":{"required":["packetSize"]}}],"description":"Run a PingSweep (multiple pings across a range of packet sizes). NOTE: 'packetSize' is not allowed for PingSweep.","properties":{"count":{"default":5,"description":"Number of ping cycles to run for each packet size in the sweep.","minimum":1,"type":"integer"},"destination":{"description":"Target hostname or IP (e.g., 1.1.1.1).","type":"string"},"endPacketSize":{"description":"Final payload size (bytes) for the sweep (must be >= startPacketSize).","minimum":1,"type":"integer"},"startPacketSize":{"description":"Starting payload size (bytes) for the sweep.","minimum":1,"type":"integer"},"sweepInterval":{"description":"Step size (bytes) between successive payload sizes.","minimum":1,"type":"integer"}},"required":["destination","startPacketSize","endPacketSize","sweepInterval"],"title":"GATEWAY PING SWEEP REQUEST","type":"object"},"GatewayPingSweepResponseBucket__8aa6df07e528":{"properties":{"count":{"description":"The cycle index (e.g., '1', '2', ...), represented as a string.","type":"string"},"replies":{"items":{"$ref":"#/components/schemas/GatewayPingSweepReply__8aa6df07e528"},"type":"array"}},"required":["count","replies"],"title":"GATEWAY PING SWEEP RESPONSE BUCKET","type":"object"},"GatewayPingSweepResult__8aa6df07e528":{"allOf":[{"$ref":"#/components/schemas/AsyncOperationResultBase__03efdde95a47"},{"properties":{"output":{"allOf":[{"$ref":"#/components/schemas/GatewayPingSweepOutput__8aa6df07e528"}],"type":["object","null"]}},"type":"object"}],"title":"GATEWAY PING SWEEP RESULT"},"GatewayPortListResponse__b0584996a91f":{"allOf":[{"properties":{"items":{"items":{"properties":{"adminState":{"description":"The administrative state of the port.\n","enum":["Enabled","Disabled"],"example":"Enabled","maxLength":8,"type":"string"},"broadcastPackets":{"description":"The total number of broadcast packets transferred.\n","example":10,"format":"int32","type":"integer"},"collisions":{"description":"The total number of collisions detected.\n","example":1,"format":"int32","type":"integer"},"connectorType":{"$ref":"#/components/schemas/PortType__988495a6329d"},"crcErrors":{"description":"The total number of CRC errors detected.\n","example":0,"format":"int32","type":"integer"},"duplex":{"$ref":"#/components/schemas/Duplexgw__988495a6329d"},"giants":{"description":"The total number of giant packets detected.\n","example":0,"format":"int32","type":"integer"},"health":{"description":"The health status of the wired interface.\n","enum":["Good","Fair","Poor"],"example":"Good","maxLength":4,"type":"string"},"healthReasons":{"items":{"enum":["WIRED_INTERFACE_STATUS"],"example":"WIRED_INTERFACE_STATUS","type":"string"},"type":"array"},"id":{"$ref":"#/components/schemas/IDgw__1053ccf03958"},"macAddress":{"$ref":"#/components/schemas/PortMacAddressgw__988495a6329d"},"mtu":{"$ref":"#/components/schemas/Mtu__2ca376caec3f"},"multicastPackets":{"description":"The total number of multicast packets transferred.\n","example":5,"format":"int32","type":"integer"},"name":{"$ref":"#/components/schemas/Name__988495a6329d"},"operState":{"description":"The operational state of the port.\n","enum":["Up","Down"],"example":"Up","maxLength":4,"type":"string"},"portNumber":{"$ref":"#/components/schemas/PortNumber__988495a6329d"},"portType":{"$ref":"#/components/schemas/VlanModegw__988495a6329d"},"runts":{"description":"The total number of runt packets detected.\n","example":0,"format":"int32","type":"integer"},"speed":{"$ref":"#/components/schemas/Speedgw__988495a6329d"},"throughput":{"description":"Bandwidth usage statistics for the tunnel.\n","properties":{"received":{"description":"bytes per second received by the port.\n","example":1000,"format":"int64","minimum":0,"type":"integer"},"sent":{"description":"bytes per second sent by the port.\n","example":500,"format":"int64","minimum":0,"type":"integer"}},"required":["received","sent"],"type":"object"},"totalPackets":{"description":"The total number of packets transferred.\n","example":100,"format":"int32","type":"integer"},"type":{"$ref":"#/components/schemas/Typegw__1053ccf03958"},"usage":{"description":"Bandwidth usage statistics for the LAN tunnel.\n","properties":{"received":{"description":"Total bytes received by the port.\n","example":1000,"format":"int64","minimum":0,"type":"integer"},"sent":{"description":"Total bytes sent by the port.\n","example":500,"format":"int64","minimum":0,"type":"integer"},"total":{"description":"Total bytes transmitted (sent + received) by the port.\n","example":1500,"format":"int64","minimum":0,"type":"integer"}},"required":["received","sent","total"],"type":"object"},"vlan":{"$ref":"#/components/schemas/Vlan__988495a6329d"}},"required":["name","health","healthReasons","portNumber","duplex","speed","vlan","mtu","usage","throughput","totalPackets","broadcastPackets","multicastPackets","crcErrors","collisions","runts","giants","macAddress","adminState","operState","portType","connectorType","id","type"],"type":"object"},"maxItems":1000,"type":"array"}},"required":["items"],"type":"object"},{"$ref":"#/components/schemas/PaginatedResponsegw__21874c7bfa12"}],"example":{"count":1,"items":[{"adminState":"Disabled","broadcastPackets":50,"collisions":1,"connectorType":"RJ45","crcErrors":0,"duplex":"Full","giants":0,"health":"Good","healthReasons":[],"id":"GW00000001/ports/GE 0/0/1","macAddress":"11:22:33:44:55:66","mtu":1500,"multicastPackets":20,"name":"GE 0/0/1","operState":"Down","portNumber":0,"portType":"Access","runts":0,"speed":"1000","throughput":{"received":1000,"sent":100},"totalPackets":300,"type":"network-monitoring/gateway-monitoring","usage":{"received":10000,"sent":3000,"total":13000},"vlan":"304-310"}],"next":"2","total":4}},"GatewayPortResponse__988495a6329d":{"example":{"adminState":"Disabled","broadcastPackets":50,"collisions":1,"connectorType":"RJ45","crcErrors":0,"duplex":"Full","giants":0,"health":"Good","healthReasons":[],"id":"GW00000001/ports/GE 0/0/1","macAddress":"11:22:33:44:55:66","mtu":1500,"multicastPackets":20,"name":"GE 0/0/1","operState":"Down","portNumber":0,"portType":"Access","runts":0,"speed":"1000","throughput":{"received":1000,"sent":100},"totalPackets":300,"type":"network-monitoring/gateway-monitoring","usage":{"received":10000,"sent":3000,"total":13000},"vlan":"304-310"},"properties":{"adminState":{"description":"The administrative state of the port.\n","enum":["Enabled","Disabled"],"example":"Enabled","maxLength":8,"type":"string"},"broadcastPackets":{"description":"The total number of broadcast packets transferred.\n","example":10,"format":"int32","type":"integer"},"collisions":{"description":"The total number of collisions detected.\n","example":1,"format":"int32","type":"integer"},"connectorType":{"$ref":"#/components/schemas/PortType__988495a6329d"},"crcErrors":{"description":"The total number of CRC errors detected.\n","example":0,"format":"int32","type":"integer"},"duplex":{"$ref":"#/components/schemas/Duplexgw__988495a6329d"},"giants":{"description":"The total number of giant packets detected.\n","example":0,"format":"int32","type":"integer"},"health":{"description":"The health status of the wired interface.\n","enum":["Good","Fair","Poor"],"example":"Good","maxLength":4,"type":"string"},"healthReasons":{"items":{"enum":["WIRED_INTERFACE_STATUS"],"example":"WIRED_INTERFACE_STATUS","type":"string"},"type":"array"},"id":{"$ref":"#/components/schemas/IDgw__1053ccf03958"},"macAddress":{"$ref":"#/components/schemas/PortMacAddressgw__988495a6329d"},"mtu":{"$ref":"#/components/schemas/Mtu__2ca376caec3f"},"multicastPackets":{"description":"The total number of multicast packets transferred.\n","example":5,"format":"int32","type":"integer"},"name":{"$ref":"#/components/schemas/Name__988495a6329d"},"operState":{"description":"The operational state of the port.\n","enum":["Up","Down"],"example":"Up","maxLength":4,"type":"string"},"portNumber":{"$ref":"#/components/schemas/PortNumber__988495a6329d"},"portType":{"$ref":"#/components/schemas/VlanModegw__988495a6329d"},"runts":{"description":"The total number of runt packets detected.\n","example":0,"format":"int32","type":"integer"},"speed":{"$ref":"#/components/schemas/Speedgw__988495a6329d"},"throughput":{"description":"Bandwidth usage statistics for the tunnel.\n","properties":{"received":{"description":"bytes per second received by the port.\n","example":1000,"format":"int64","minimum":0,"type":"integer"},"sent":{"description":"bytes per second sent by the port.\n","example":500,"format":"int64","minimum":0,"type":"integer"}},"required":["received","sent"],"type":"object"},"totalPackets":{"description":"The total number of packets transferred.\n","example":100,"format":"int32","type":"integer"},"type":{"$ref":"#/components/schemas/Typegw__1053ccf03958"},"usage":{"description":"Bandwidth usage statistics for the LAN tunnel.\n","properties":{"received":{"description":"Total bytes received by the port.\n","example":1000,"format":"int64","minimum":0,"type":"integer"},"sent":{"description":"Total bytes sent by the port.\n","example":500,"format":"int64","minimum":0,"type":"integer"},"total":{"description":"Total bytes transmitted (sent + received) by the port.\n","example":1500,"format":"int64","minimum":0,"type":"integer"}},"required":["received","sent","total"],"type":"object"},"vlan":{"$ref":"#/components/schemas/Vlan__988495a6329d"}},"required":["name","health","portNumber","duplex","speed","vlan","mtu","usage","throughput","totalPackets","broadcastPackets","multicastPackets","crcErrors","collisions","runts","giants","macAddress","adminState","operState","portType","connectorType","id","type"],"type":"object"},"GatewayResponse__3b77411f6985":{"example":{"clusterName":"gateway-cluster-1","cpuUtilization":32,"deviceFunction":"VPNC","deviceName":"gw_1","firmwareVersion":"8.5.2.0_59123","id":"GW00000001","ipAddress":"198.51.100.42","macAddress":"11:22:33:44:55:66","macRange":"20:4c:03:14:03:7c-20:4c:03:14:03:9b","memoryUtilization":45,"mode":"Cluster","model":"Aruba 7005","rebootReason":"Nanny rebooted machine - low on free memory","role":"Isoleader","serialNumber":"GW00000001","siteId":"24833497","siteName":"site_1","status":"Online","type":"network-monitoring/gateway-monitoring","uptimeInMillis":1702794777},"properties":{"clusterName":{"$ref":"#/components/schemas/ClusterNamegw__3b77411f6985"},"cpuUtilization":{"description":"The latest CPU utilization of the gateway, expressed as a percentage (0–100).\n","example":32,"format":"float","type":"number"},"deviceFunction":{"description":"Device function (Persona identifier) for the gateway.\n","enum":["Unspecified","Mobility Controller","Branch Gateway","VPNC"],"example":"VPNC","maxLength":19,"type":"string"},"deviceName":{"$ref":"#/components/schemas/DeviceNamegw__3b77411f6985"},"firmwareVersion":{"$ref":"#/components/schemas/FirmwareVersiongw__3b77411f6985"},"id":{"$ref":"#/components/schemas/IDgw__1053ccf03958"},"ipAddress":{"$ref":"#/components/schemas/Ipv4Addressgw__3b77411f6985"},"macAddress":{"$ref":"#/components/schemas/MacAddressgw__3b77411f6985"},"macRange":{"description":"The MAC address range allocated to the gateway.\n","example":"20:4c:03:14:03:7c-20:4c:03:14:03:9b","maxLength":256,"type":"string"},"memoryUtilization":{"description":"The latest memory utilization of the gateway, expressed as a percentage (0–100).\n","example":32,"format":"float","type":"number"},"mode":{"$ref":"#/components/schemas/Deploymentgw__3b77411f6985"},"model":{"$ref":"#/components/schemas/Modelgw__3b77411f6985"},"rebootReason":{"description":"The last reboot reason of the gateway.\n","example":"Nanny rebooted machine - low on free memory","maxLength":256,"type":"string"},"role":{"$ref":"#/components/schemas/Rolegw__3b77411f6985"},"serialNumber":{"$ref":"#/components/schemas/SerialNumbergw__1053ccf03958"},"siteId":{"$ref":"#/components/schemas/SiteIDgw__3b77411f6985"},"siteName":{"$ref":"#/components/schemas/SiteNamegw__3b77411f6985"},"status":{"description":"The status of the gateway, either Online or Offline.\n","enum":["Online","Offline"],"example":"Online","maxLength":7,"type":"string"},"type":{"$ref":"#/components/schemas/Typegw__1053ccf03958"},"uptimeInMillis":{"$ref":"#/components/schemas/UptimeInMillisgw__3b77411f6985"}},"required":["serialNumber","macAddress","deviceName","cpuUtilization","memoryUtilization","siteId","firmwareVersion","ipAddress","uptimeInMillis","macRange","rebootReason","deviceFunction","mode","status","role","model","siteName","clusterName","id","type"],"type":"object"},"GatewayTunnelDetailResponse__2ca376caec3f":{"example":{"authentication":"SHA1","destinationIpAddress":"200.1.1.1","droppedPackets":4,"encapsulation":"VXLAN","encryption":"AES-256","gateway":"GW00000001","greTunnelId":null,"greTunnelIpAddress":null,"health":"Poor","healthReasons":["TUNNEL_STATUS"],"id":"GW00000001/tunnels/data-vpnc1-bocsim-uplink1_inet","inSpi":123456789,"lastConnected":"Mar 02, 2025 16:56","lastDownReason":null,"macAddress":"00:44:55:66:78:4a","mode":"IKE","mtu":"1500","natEnabled":true,"nextReKey":1741093011,"outSpi":987654321,"peerType":"Cloud Gateway","sourceIpAddress":"10.33.1.1","status":"Down","throughput":{"received":200,"sent":100},"tunnelName":"data-vpnc1-bocsim-uplink1_inet","tunnelType":"LAN","type":"network-monitoring/gateway-monitoring","uplinkName":"inet","uptime":"3d","usage":{"received":1000,"sent":500,"total":1500},"vlanId":340,"vni":null},"properties":{"authentication":{"$ref":"#/components/schemas/Authentication__2ca376caec3f"},"destinationIpAddress":{"$ref":"#/components/schemas/DestinationIpAddressgw__2ca376caec3f"},"droppedPackets":{"description":"Number of packets dropped by the LAN tunnel.\n","example":4,"format":"float","minimum":0,"type":"number"},"encapsulation":{"$ref":"#/components/schemas/Encapsulation__2ca376caec3f"},"encryption":{"$ref":"#/components/schemas/Encryption__2ca376caec3f"},"gateway":{"$ref":"#/components/schemas/Gateway__2ca376caec3f"},"greTunnelId":{"description":"GRE tunnel identifier if applicable, null otherwise.\n","example":null,"maxLength":256,"type":"string"},"greTunnelIpAddress":{"description":"IP address of the GRE tunnel if applicable, null otherwise.\n","example":null,"format":"ipv4","maxLength":15,"type":"string"},"health":{"description":"The health status of the LAN tunnel.\n","enum":["Good","Fair","Poor"],"example":"Good","maxLength":4,"type":"string"},"healthReasons":{"description":"Reasons contributing to the current health status of the tunnel.\n","items":{"enum":["GOOD_PERFORMANCE","TUNNEL_STATUS","TUNNEL_ENCAPSULATION","TUNNEL_AUTHENTICATION","TUNNEL_ENCRYPTION"],"type":"string"},"type":"array"},"id":{"description":"Unique identifier for the LAN tunnel.\n","example":"data-vpnc1-bocsim-uplink1_inet","maxLength":512,"type":"string"},"inSpi":{"description":"Inbound Security Parameter Index (SPI) for the tunnel.\n","example":123456789,"format":"int64","minimum":0,"type":"integer"},"lastConnected":{"$ref":"#/components/schemas/LastConnected__2ca376caec3f"},"lastDownReason":{"$ref":"#/components/schemas/LastDownReason__2ca376caec3f"},"macAddress":{"description":"The source gateway MAC address.\n","example":"11:22:33:44:55:66","maxLength":18,"type":"string"},"mode":{"$ref":"#/components/schemas/Modegw__2ca376caec3f"},"mtu":{"$ref":"#/components/schemas/Mtu__2ca376caec3f"},"natEnabled":{"description":"Indicates if NAT is enabled for the tunnel.\n","example":true,"type":"boolean"},"nextReKey":{"description":"Timestamp for the next re-key event.\n","example":1741093011,"format":"int64","minimum":0,"type":"integer"},"outSpi":{"description":"Outbound Security Parameter Index (SPI) for the tunnel.\n","example":987654321,"format":"int64","minimum":0,"type":"integer"},"peerType":{"description":"Type of the tunnel peer.\n","example":"Cloud Gateway","maxLength":64,"type":"string"},"sourceIpAddress":{"$ref":"#/components/schemas/SourceIpAddressgw__2ca376caec3f"},"status":{"description":"The operational status of the LAN tunnel.\n","enum":["Up","Down"],"example":"Up","maxLength":4,"type":"string"},"throughput":{"description":"Current throughput statistics for the LAN tunnel.\n","properties":{"received":{"description":"Current receive throughput in bytes per second.\n","example":200,"format":"int64","minimum":0,"type":"integer"},"sent":{"description":"Current send throughput in bytes per second.\n","example":100,"format":"int64","minimum":0,"type":"integer"}},"required":["received","sent"],"type":"object"},"tunnelName":{"$ref":"#/components/schemas/TunnelIdgw__2ca376caec3f"},"tunnelType":{"description":"The type of the tunnel, either LAN or WAN.\n","enum":["LAN","WAN"],"example":"LAN","maxLength":3,"type":"string"},"type":{"description":"Resource type identifier.\n","example":"network-monitoring/gateway-monitoring","maxLength":64,"type":"string"},"uplinkName":{"description":"Name of the uplink interface associated with the tunnel.\n","example":null,"maxLength":256,"type":"string"},"uptime":{"description":"The uptime duration of the LAN tunnel.\n","example":"7200","maxLength":64,"type":"string"},"usage":{"description":"Bandwidth usage statistics for the LAN tunnel.\n","properties":{"received":{"description":"Total bytes received through the tunnel.\n","example":1000,"format":"int64","minimum":0,"type":"integer"},"sent":{"description":"Total bytes sent through the tunnel.\n","example":500,"format":"int64","minimum":0,"type":"integer"},"total":{"description":"Total bytes transmitted (sent + received) through the tunnel.\n","example":1500,"format":"int64","minimum":0,"type":"integer"}},"required":["received","sent","total"],"type":"object"},"vlanId":{"description":"VLAN ID associated with the LAN tunnel.\n","example":340,"format":"int64","maximum":4095,"minimum":1,"type":"integer"},"vni":{"$ref":"#/components/schemas/Vni__2ca376caec3f"}},"required":["tunnelName","gateway","health","healthReasons","status","encapsulation","sourceIpAddress","destinationIpAddress","mode","vni","uptime","authentication","encryption","mtu","lastConnected","greTunnelId","greTunnelIpAddress","usage","throughput","droppedPackets","uplinkName","vlanId","inSpi","outSpi","macAddress","peerType","natEnabled","nextReKey","lastDownReason","tunnelType","id","type"],"type":"object"},"GatewayTunnelHealthSummaryResponse__7df654afe471":{"example":[{"encapsulation":"GRE","id":"Gw1/tunnels","tunnelHealth":{"fair":0,"good":1,"poor":0},"type":"network-monitoring/gateway-monitoring"},{"encapsulation":"IPSec","id":"Gw1/tunnels","tunnelHealth":{"fair":0,"good":2,"poor":2},"type":"network-monitoring/gateway-monitoring"},{"encapsulation":"vxlan","id":"Gw1/tunnels","tunnelHealth":{"fair":0,"good":1,"poor":0},"type":"network-monitoring/gateway-monitoring"}],"properties":{"encapsulation":{"$ref":"#/components/schemas/Encapsulation__2ca376caec3f"},"id":{"$ref":"#/components/schemas/IDgw__1053ccf03958"},"tunnelHealth":{"description":"Tunnel health summary of gateway.","properties":{"fair":{"description":"The number of tunnels that are of fair health.\n","example":"2","format":"int32","type":"integer"},"good":{"description":"The number of tunnels that are of good health.\n","example":"5","format":"int32","type":"integer"},"poor":{"description":"The number of tunnels that are of poor health.\n","example":"1","format":"int32","type":"integer"}},"type":"object"},"type":{"$ref":"#/components/schemas/Typegw__1053ccf03958"}},"required":["id","type"],"type":"object"},"GatewayTunnelListResponse__d4fec30749ee":{"allOf":[{"properties":{"items":{"items":{"properties":{"authentication":{"$ref":"#/components/schemas/Authentication__2ca376caec3f"},"destinationIpAddress":{"$ref":"#/components/schemas/DestinationIpAddressgw__2ca376caec3f"},"droppedPackets":{"description":"Number of packets dropped by the LAN tunnel.\n","example":4,"format":"float","minimum":0,"type":"number"},"encapsulation":{"$ref":"#/components/schemas/Encapsulation__2ca376caec3f"},"encryption":{"$ref":"#/components/schemas/Encryption__2ca376caec3f"},"gateway":{"$ref":"#/components/schemas/Gateway__2ca376caec3f"},"greTunnelId":{"description":"GRE tunnel identifier if applicable, null otherwise.\n","example":null,"maxLength":256,"type":"string"},"greTunnelIpAddress":{"description":"IP address of the GRE tunnel if applicable, null otherwise.\n","example":null,"format":"ipv4","maxLength":15,"type":"string"},"health":{"description":"The health status of the LAN tunnel.\n","enum":["Good","Fair","Poor"],"example":"Good","maxLength":4,"type":"string"},"healthReasons":{"description":"Reasons contributing to the current health status of the tunnel.\n","items":{"enum":["GOOD_PERFORMANCE","TUNNEL_STATUS","TUNNEL_ENCAPSULATION","TUNNEL_AUTHENTICATION","TUNNEL_ENCRYPTION"],"type":"string"},"type":"array"},"id":{"description":"Unique identifier for the LAN tunnel.\n","example":"data-vpnc1-bocsim-uplink1_inet","maxLength":512,"type":"string"},"inSpi":{"description":"Inbound Security Parameter Index (SPI) for the tunnel.\n","example":123456789,"format":"int64","minimum":0,"type":"integer"},"lastConnected":{"$ref":"#/components/schemas/LastConnected__2ca376caec3f"},"lastDownReason":{"$ref":"#/components/schemas/LastDownReason__2ca376caec3f"},"macAddress":{"description":"The source gateway MAC address.\n","example":"11:22:33:44:55:66","maxLength":18,"type":"string"},"mode":{"$ref":"#/components/schemas/Modegw__2ca376caec3f"},"mtu":{"$ref":"#/components/schemas/Mtu__2ca376caec3f"},"natEnabled":{"description":"Indicates if NAT is enabled for the tunnel.\n","example":true,"type":"boolean"},"nextReKey":{"description":"Timestamp for the next re-key event.\n","example":1741093011,"format":"int64","minimum":0,"type":"integer"},"outSpi":{"description":"Outbound Security Parameter Index (SPI) for the tunnel.\n","example":987654321,"format":"int64","minimum":0,"type":"integer"},"peerType":{"description":"Type of the tunnel peer.\n","example":"Cloud Gateway","maxLength":64,"type":"string"},"sourceIpAddress":{"$ref":"#/components/schemas/SourceIpAddressgw__2ca376caec3f"},"status":{"description":"The operational status of the LAN tunnel.\n","enum":["Up","Down"],"example":"Up","maxLength":4,"type":"string"},"throughput":{"description":"Current throughput statistics for the LAN tunnel.\n","properties":{"received":{"description":"Current receive throughput in bytes per second.\n","example":200,"format":"int64","minimum":0,"type":"integer"},"sent":{"description":"Current send throughput in bytes per second.\n","example":100,"format":"int64","minimum":0,"type":"integer"}},"required":["received","sent"],"type":"object"},"tunnelName":{"$ref":"#/components/schemas/TunnelIdgw__2ca376caec3f"},"tunnelType":{"description":"The type of the tunnel, either LAN or WAN.\n","enum":["LAN","WAN"],"example":"LAN","maxLength":3,"type":"string"},"type":{"description":"Resource type identifier.\n","example":"network-monitoring/gateway-monitoring","maxLength":64,"type":"string"},"uplinkName":{"description":"Name of the uplink interface associated with the tunnel.\n","example":null,"maxLength":256,"type":"string"},"uptime":{"description":"The uptime duration of the LAN tunnel.\n","example":"7200","maxLength":64,"type":"string"},"usage":{"description":"Bandwidth usage statistics for the LAN tunnel.\n","properties":{"received":{"description":"Total bytes received through the tunnel.\n","example":1000,"format":"int64","minimum":0,"type":"integer"},"sent":{"description":"Total bytes sent through the tunnel.\n","example":500,"format":"int64","minimum":0,"type":"integer"},"total":{"description":"Total bytes transmitted (sent + received) through the tunnel.\n","example":1500,"format":"int64","minimum":0,"type":"integer"}},"required":["received","sent","total"],"type":"object"},"vlanId":{"description":"VLAN ID associated with the LAN tunnel.\n","example":340,"format":"int64","maximum":4095,"minimum":1,"type":"integer"},"vni":{"$ref":"#/components/schemas/Vni__2ca376caec3f"}},"required":["tunnelName","gateway","health","healthReasons","status","encapsulation","sourceIpAddress","destinationIpAddress","mode","vni","uptime","authentication","encryption","mtu","lastConnected","greTunnelId","greTunnelIpAddress","usage","throughput","droppedPackets","uplinkName","vlanId","inSpi","outSpi","macAddress","peerType","natEnabled","nextReKey","lastDownReason","tunnelType","id","type"],"type":"object"},"maxItems":1000,"type":"array"}},"required":["items"],"type":"object"},{"$ref":"#/components/schemas/PaginatedResponsegw__21874c7bfa12"}],"example":{"count":1,"items":[{"authentication":"SHA1","destinationIpAddress":"200.1.1.1","droppedPackets":4,"encapsulation":"VXLAN","encryption":"AES-256","gateway":"GW00000001","greTunnelId":null,"greTunnelIpAddress":null,"health":"Poor","healthReasons":["TUNNEL_STATUS"],"id":"GW00000001/tunnels/data-vpnc1-bocsim-uplink1_inet","inSpi":123456789,"lastConnected":"2023-10-01T12:00:00Z","lastDownReason":null,"macAddress":"00:44:55:66:78:4a","mode":"IKE","mtu":"1500","natEnabled":true,"nextReKey":1741093011,"outSpi":987654321,"peerType":"Cloud Gateway","sourceIpAddress":"10.33.1.1","status":"Down","throughput":{"received":200,"sent":100},"tunnelName":"data-vpnc1-bocsim-uplink1_inet","tunnelType":"LAN","type":"network-monitoring/gateway-monitoring","uplinkName":null,"uptime":"123456789","usage":{"received":1000,"sent":500,"total":1500},"vlanId":340,"vni":null}],"next":null,"total":1}},"GatewayUplinkDetailResponse__dff1b4103f68":{"example":{"id":"GW00000001/uplinks/att","isBackupUplink":false,"linkStatus":"Up","linkTag":"att","privateIpAddress":"10.27.103.66","publicIpAddress":"220.227.124.242","status":"Up","throughput":{"received":1000,"sent":500},"type":"network-monitoring/gateway-monitoring","usage":{"received":1000,"sent":500,"total":1500},"vlanId":304,"wanStatus":"Up"},"properties":{"id":{"$ref":"#/components/schemas/IDgw__1053ccf03958"},"isBackupUplink":{"description":"Indicates if this uplink is a backup uplink.\n","example":false,"type":"boolean"},"linkStatus":{"description":"The link status of the uplink.\n","enum":["Up","Down"],"example":"Up","maxLength":4,"type":"string"},"linkTag":{"$ref":"#/components/schemas/LinkTag__9683aa3d9df6"},"privateIpAddress":{"$ref":"#/components/schemas/PrivateIp__9683aa3d9df6"},"publicIpAddress":{"$ref":"#/components/schemas/PublicIp__9683aa3d9df6"},"status":{"description":"The overall status of the uplink.\n","enum":["Up","Down"],"example":"Up","maxLength":4,"type":"string"},"throughput":{"description":"Current throughput statistics for the WAN tunnel.\n","properties":{"received":{"description":"Current receive throughput in bytes per second.\n","example":200,"format":"int64","minimum":0,"type":"integer"},"sent":{"description":"Current send throughput in bytes per second.\n","example":100,"format":"int64","minimum":0,"type":"integer"}},"required":["received","sent"],"type":"object"},"type":{"$ref":"#/components/schemas/Typegw__1053ccf03958"},"usage":{"description":"Bandwidth usage statistics of the uplink.\n","properties":{"received":{"description":"Total bytes received through the uplink.\n","example":1000,"format":"int64","minimum":0,"type":"integer"},"sent":{"description":"Total bytes sent through the uplink.\n","example":500,"format":"int64","minimum":0,"type":"integer"},"total":{"description":"Total bytes transmitted (sent + received) through the uplink.\n","example":1500,"format":"int64","minimum":0,"type":"integer"}},"required":["received","sent","total"],"type":"object"},"vlanId":{"$ref":"#/components/schemas/VlanIdgw__9683aa3d9df6"},"wanStatus":{"description":"The WAN status of the uplink.\n","enum":["Up","Down"],"example":"Up","maxLength":4,"type":"string"}},"required":["linkTag","status","wanStatus","linkStatus","privateIpAddress","publicIpAddress","vlanId","isBackupUplink","usage","throughput","id","type"],"type":"object"},"GatewayUplinkListResponse__9683aa3d9df6":{"allOf":[{"properties":{"items":{"items":{"properties":{"id":{"$ref":"#/components/schemas/IDgw__1053ccf03958"},"isBackupUplink":{"description":"Indicates if this uplink is a backup uplink.\n","example":false,"type":"boolean"},"linkStatus":{"description":"The link status of the uplink.\n","enum":["Up","Down"],"example":"Up","maxLength":4,"type":"string"},"linkTag":{"$ref":"#/components/schemas/LinkTag__9683aa3d9df6"},"privateIpAddress":{"$ref":"#/components/schemas/PrivateIp__9683aa3d9df6"},"publicIpAddress":{"$ref":"#/components/schemas/PublicIp__9683aa3d9df6"},"status":{"description":"The overall status of the uplink.\n","enum":["Up","Down"],"example":"Up","maxLength":4,"type":"string"},"throughput":{"description":"Current throughput statistics for the WAN tunnel.\n","properties":{"received":{"description":"Current receive throughput in bytes per second.\n","example":200,"format":"int64","minimum":0,"type":"integer"},"sent":{"description":"Current send throughput in bytes per second.\n","example":100,"format":"int64","minimum":0,"type":"integer"}},"required":["received","sent"],"type":"object"},"type":{"$ref":"#/components/schemas/Typegw__1053ccf03958"},"usage":{"description":"Bandwidth usage statistics of the uplink.\n","properties":{"received":{"description":"Total bytes received through the uplink.\n","example":1000,"format":"int64","minimum":0,"type":"integer"},"sent":{"description":"Total bytes sent through the uplink.\n","example":500,"format":"int64","minimum":0,"type":"integer"},"total":{"description":"Total bytes transmitted (sent + received) through the uplink.\n","example":1500,"format":"int64","minimum":0,"type":"integer"}},"required":["received","sent","total"],"type":"object"},"vlanId":{"$ref":"#/components/schemas/VlanIdgw__9683aa3d9df6"},"wanStatus":{"description":"The WAN status of the uplink.\n","enum":["Up","Down"],"example":"Up","maxLength":4,"type":"string"}},"required":["linkTag","status","wanStatus","linkStatus","privateIpAddress","publicIpAddress","vlanId","isBackupUplink","usage","throughput","id","type"],"type":"object"},"maxItems":100,"type":"array"}},"required":["items"],"type":"object"},{"$ref":"#/components/schemas/PaginatedResponsegw__21874c7bfa12"}],"example":{"items":[{"id":"GW00000001/uplinks/att","isBackupUplink":false,"linkStatus":"Up","linkTag":"att","privateIpAddress":"10.27.103.66","publicIpAddress":"220.227.124.242","status":"Up","throughput":{"received":1000,"sent":500},"type":"network-monitoring/gateway-monitoring","usage":{"received":1000,"sent":500,"total":1500},"vlanId":304,"wanStatus":"Up"}],"total":1}},"GatewayVlanDetailResponse__c99febaf4556":{"example":{"adminStatus":"Down","id":"1","interfaces":"Unassigned","ipv4":"0.0.0.0","ipv4MaskAddr":"0.0.0.0","ipv4Subnet":null,"ipv6Prefix":null,"name":"Default VLAN","status":"Down","type":"network-monitoring/gateway-monitoring","vlanId":1,"vlanType":"Static","voice":null},"properties":{"adminStatus":{"description":"The admin status of the VLAN.\n","enum":["Up","Down"],"example":"Up","maxLength":4,"type":"string"},"id":{"$ref":"#/components/schemas/IDgw__1053ccf03958"},"interfaces":{"$ref":"#/components/schemas/Interfaces__c99febaf4556"},"ipv4":{"$ref":"#/components/schemas/Ipv4Addressgw__3b77411f6985"},"ipv4MaskAddr":{"$ref":"#/components/schemas/Ipv4MaskAddr__c99febaf4556"},"ipv4Subnet":{"$ref":"#/components/schemas/Ipv4Subnet__c99febaf4556"},"ipv6Prefix":{"$ref":"#/components/schemas/Ipv6Prefix__c99febaf4556"},"name":{"$ref":"#/components/schemas/Name__988495a6329d"},"status":{"description":"The status of the VLAN configured in the gateway.\n","enum":["Up","Down"],"example":"Up","maxLength":4,"type":"string"},"type":{"$ref":"#/components/schemas/Typegw__1053ccf03958"},"vlanId":{"$ref":"#/components/schemas/VlanIdgw__9683aa3d9df6"},"vlanType":{"description":"The type of VLAN configured in the gateway, either Static or Dynamic.\n","enum":["Static","Dynamic"],"example":"Static","maxLength":7,"type":"string"},"voice":{"$ref":"#/components/schemas/Voice__c99febaf4556"}},"required":["vlanId","id","type"],"type":"object"},"GatewayVlanListResponse__d5538d9e1ebf":{"allOf":[{"properties":{"items":{"items":{"properties":{"adminStatus":{"description":"The admin status of the VLAN.\n","enum":["Up","Down"],"example":"Up","maxLength":4,"type":"string"},"id":{"$ref":"#/components/schemas/IDgw__1053ccf03958"},"interfaces":{"$ref":"#/components/schemas/Interfaces__c99febaf4556"},"ipv4":{"$ref":"#/components/schemas/Ipv4Addressgw__3b77411f6985"},"ipv4MaskAddr":{"$ref":"#/components/schemas/Ipv4MaskAddr__c99febaf4556"},"ipv4Subnet":{"$ref":"#/components/schemas/Ipv4Subnet__c99febaf4556"},"name":{"$ref":"#/components/schemas/Name__988495a6329d"},"status":{"description":"The status of the VLAN configured in the gateway.\n","enum":["Up","Down"],"example":"Up","maxLength":4,"type":"string"},"type":{"$ref":"#/components/schemas/Typegw__1053ccf03958"},"vlanId":{"$ref":"#/components/schemas/VlanIdgw__9683aa3d9df6"},"vlanType":{"description":"The type of VLAN configured in the gateway, either Static or Dynamic.\n","enum":["Static","Dynamic"],"example":"Static","maxLength":7,"type":"string"}},"required":["vlanId","id","type"],"type":"object"},"maxItems":100,"type":"array"}},"required":["items"],"type":"object"},{"$ref":"#/components/schemas/PaginatedResponsegw__21874c7bfa12"}],"example":{"count":1,"items":[{"adminStatus":"Up","id":"305","interfaces":"GE 0/0/1","ipv4":"10.27.103.82","ipv4MaskAddr":"255.255.255.240","ipv4Subnet":"10.27.103.82/28","name":"Static - Vlan","status":"Down","type":"network-monitoring/gateway-monitoring","vlanId":305,"vlanType":"Static"}],"next":null,"total":1}},"GatewayWanTunnelHealthSummaryResponse__6ed6e4998ea3":{"example":[{"health":"Poor","healthReasons":"TUNNEL_STATUS","id":"Gw1/tunnels","tunnelHealth":{"fair":4,"good":7,"poor":2},"type":"network-monitoring/gateway-monitoring"}],"properties":{"health":{"description":"The cumulative health of the tunnel.\n","enum":["Good","Fair","Poor"],"example":"Good","maxLength":4,"type":"string"},"healthReasons":{"description":"The reason for the current health of the tunnel.\n","enum":["TUNNEL_STATUS","TUNNEL_ENCAPSULATION","TUNNEL_AUTHENTICATION","TUNNEL_ENCRYPTION"],"example":"TUNNEL_STATUS","type":"string"},"id":{"$ref":"#/components/schemas/IDgw__1053ccf03958"},"tunnelHealth":{"description":"Tunnel health summary of gateway.","properties":{"fair":{"description":"The number of tunnels that are of fair health.\n","example":"2","format":"int32","type":"integer"},"good":{"description":"The number of tunnels that are of good health.\n","example":"5","format":"int32","type":"integer"},"poor":{"description":"The number of tunnels that are of poor health.\n","example":"1","format":"int32","type":"integer"}},"type":"object"},"type":{"$ref":"#/components/schemas/Typegw__1053ccf03958"}},"required":["health","healthReasons","tunnelHealth","id","type"],"type":"object"},"Gateway__2ca376caec3f":{"description":"The name of the gateway to which the tunnel belongs.\n","example":"gw_1","maxLength":256,"type":"string"},"Generation__2efde5827a74":{"description":"Generation number of the webhook.","format":"int32","minimum":1,"type":"integer"},"Generation__7006262f8c4c":{"description":"A monotonically increasing number indicating the number of times the resource has been updated.\n","examples":[1],"format":"int64","type":"integer"},"Generation__7d827151e05e":{"description":"Monotonically increasing update counter for the report / report schedule resource.","examples":[1],"format":"int64","minimum":0,"type":"integer"},"GeoCoordinates__3f58b16772b5":{"description":"The geo-coordinates of a client in both Cartesian and Latitude/Longitude format.\n","properties":{"latitude":{"$ref":"#/components/schemas/Latitudewifi__3f58b16772b5"},"longitude":{"$ref":"#/components/schemas/Longitudewifi__3f58b16772b5"}},"type":["object","null"]},"GeoCoordinatesasset__a39bf531822f":{"description":"The geo-coordinates of Asset Tag in both Cartesian and Latitude/Longitude format.\n","properties":{"latitude":{"$ref":"#/components/schemas/Latitudeasset__a39bf531822f"},"longitude":{"$ref":"#/components/schemas/Longitudeasset__a39bf531822f"}},"type":["object","null"]},"GeoPoint__e40c06be8034":{"description":"geopoint values","properties":{"latitude":{"format":"double","type":"number"},"longitude":{"format":"double","type":"number"}},"type":"object"},"Geo__4ee94b04d313":{"externalDocs":{"url":"http://geojson.org/geojson-spec.html#geometry-objects"},"properties":{"coordinates":{"items":{"format":"int32","maximum":180,"minimum":-180,"type":"integer"},"maxItems":2,"minItems":2,"type":"array"},"type":{"description":"the geometry type","enum":["Point","LineString","Polygon","MultiPoint","MultiLineString","MultiPolygon"],"type":"string"}},"required":["type","coordinates"],"type":"object"},"GetArpTableApArptablerowresult__bb3cf760e22a":{"properties":{"device":{"description":"The device associated with the entry.","type":"string"},"flags":{"description":"The flags associated with the entry.","type":"string"},"hardwareType":{"description":"The hardware type.","type":"string"},"ipAddress":{"description":"The IP address in the ARP table.","type":"string"},"macAddress":{"description":"The MAC address.","type":"string"},"mask":{"description":"The mask associated with the entry.","type":"string"}},"title":"AP ARP TABLE ENTRY","type":"object"},"GetArpTableApParsedOutput__bb3cf760e22a":{"properties":{"entries":{"description":"The entries in the ARP table.","items":{"$ref":"#/components/schemas/GetArpTableApArptablerowresult__bb3cf760e22a"},"type":"array"}},"title":"AP ARP TABLE RESPONSE","type":"object"},"GetArpTableApResult__bb3cf760e22a":{"allOf":[{"$ref":"#/components/schemas/AsyncOperationResultBase__03efdde95a47"},{"properties":{"output":{"allOf":[{"$ref":"#/components/schemas/GetArpTableApParsedOutput__bb3cf760e22a"}],"type":["object","null"]},"rawOutput":{"description":"The raw output of the test.","type":"string"}},"type":"object"}],"title":"AP ARP TABLE RESULT"},"GetArpTableHppcArptablerowresult__6969b1a4b1d4":{"properties":{"entryType":{"description":"The type of the entry.","type":"string"},"ipAddress":{"description":"The IP address in the ARP table.","type":"string"},"macAddress":{"description":"The MAC address.","type":"string"},"port":{"description":"The port associated with the entry.","type":"string"}},"title":"AOS-S ARP TABLE ENTRY","type":"object"},"GetArpTableHppcParsedOutput__6969b1a4b1d4":{"properties":{"entries":{"description":"The entries in the ARP table.","items":{"$ref":"#/components/schemas/GetArpTableHppcArptablerowresult__6969b1a4b1d4"},"type":"array"}},"title":"AOS-S ARP TABLE RESPONSE","type":"object"},"GetArpTableHppcResult__6969b1a4b1d4":{"allOf":[{"$ref":"#/components/schemas/AsyncOperationResultBase__03efdde95a47"},{"properties":{"output":{"allOf":[{"$ref":"#/components/schemas/GetArpTableHppcParsedOutput__6969b1a4b1d4"}],"type":["object","null"]},"rawOutput":{"description":"The raw output of the test.","type":"string"}},"type":"object"}],"title":"AOS-S ARP TABLE RESULT"},"GetArpTableMcArptablerowresult__53834e96d6c4":{"properties":{"address":{"description":"The IP address in the ARP table.","type":"string"},"interfaceAndPort":{"description":"The interface associated with the entry.","type":"string"},"macAddress":{"description":"The MAC address.","type":"string"},"protocol":{"description":"The protocol associated with the entry.","type":"string"}},"title":"GATEWAY ARP TABLE ENTRY","type":"object"},"GetArpTableMcParsedOutput__53834e96d6c4":{"properties":{"entries":{"description":"The entries in the ARP table.","items":{"$ref":"#/components/schemas/GetArpTableMcArptablerowresult__53834e96d6c4"},"type":"array"}},"title":"GATEWAY ARP TABLE RESPONSE","type":"object"},"GetArpTableMcResult__53834e96d6c4":{"allOf":[{"$ref":"#/components/schemas/AsyncOperationResultBase__03efdde95a47"},{"properties":{"output":{"allOf":[{"$ref":"#/components/schemas/GetArpTableMcParsedOutput__53834e96d6c4"}],"type":["object","null"]},"rawOutput":{"description":"The raw output of the test.","type":"string"}},"type":"object"}],"title":"GATEWAY ARP TABLE RESULT"},"GetClientMobilityDetails__972dd6d46bea":{"examples":[],"properties":{"count":{"description":"The number of mobility events after filtering for a client","examples":[1],"type":"integer"},"items":{"description":"A list of mobility details for a client","items":{"$ref":"#/components/schemas/MobilityDetails__972dd6d46bea"},"type":"array"},"next":{"description":"Specifies the pagination cursor for the next page of resources. null if there are no further pages.","examples":[null,"1","2","3"],"type":"string"},"total":{"description":"Total number of events for a client","examples":[1],"type":"integer"}},"required":["items","count"],"type":"object"},"GetClientsTrends__55ca259b8355":{"example":{"id":"4fce1e37-9e48-4fb4-bb62-2c11ee6e3d83","interval":"5 mins","keys":["Wired","Wireless","Remote"],"samples":[{"data":[2,4,1],"ts":"2025-08-29T03:45:00Z"},{"data":[2,4,1],"ts":"2025-08-29T03:50:00Z"}],"type":"network-monitoring/client-monitoring"},"properties":{"id":{"$ref":"#/components/schemas/IDclients__284f33982989"},"interval":{"description":"Interval based on given start-at and end-at.","enum":["5 mins","3 hours"],"type":"string"},"keys":{"description":"List of categories available for a selected filter","example":["Wired","Wireless","Remote"],"items":{"format":"const","type":"string"},"maxItems":30,"type":"array"},"samples":{"description":"List of data samples.","items":{"$ref":"#/components/schemas/DataPoint__55ca259b8355"},"maxItems":2160,"type":"array"},"type":{"$ref":"#/components/schemas/Typeclients__284f33982989"}},"required":["samples","keys","interval","id","type"],"type":"object"},"GetClientsUsage__6bf98218c48a":{"example":{"interval":"5 mins","keys":["txUsage","rxUsage"],"samples":[{"data":[1048576,524288],"ts":"2025-08-19T06:45:00Z"},{"data":[2097152,1048576],"ts":"2025-08-19T06:50:00Z"}],"type":"network-monitoring/client-monitoring"},"properties":{"interval":{"description":"Sampling interval based on the given timestamp filter range.","enum":["5 mins","3 hours"],"type":"string"},"keys":{"description":"Fixed keys representing TX and RX byte usage.","example":["txUsage","rxUsage"],"items":{"format":"const","type":"string"},"maxItems":2,"type":"array"},"samples":{"description":"List of data samples. Each sample contains [txUsage, rxUsage] in bytes.","items":{"$ref":"#/components/schemas/DataPoint__55ca259b8355"},"maxItems":2160,"type":"array"},"type":{"$ref":"#/components/schemas/Typeclients__284f33982989"}},"required":["samples","keys","interval","type"],"type":"object"},"GetTopNClientsByUsageResponse__c21517c4950b":{"description":"Response containing list of top N clients by usage","example":{"count":4,"items":[{"clientConnectionType":"Wireless","clientName":"34:1B:9F:BE:40:01","macAddress":"34:1b:9f:be:40:01","siteId":2778382,"siteName":"Site-1","usage":8339422},{"clientConnectionType":"Wireless","clientName":"D0_94_2A_F8_30_01","macAddress":"d0:94:2a:f8:30:01","siteId":"2778383","siteName":"Site-2","usage":7102255},{"clientConnectionType":"Wired","clientName":"36:6C:11:9D:10:01","macAddress":"36:6c:11:9d:10:01","siteId":2778352,"siteName":"Site-3","usage":6644045},{"clientConnectionType":"Remote","clientName":"A8:2B:D6:4C:50:01","macAddress":"a8:2b:d6:4c:50:01","siteId":2778400,"siteName":"Site-4","usage":5120000}]},"properties":{"count":{"description":"No of clients retrieved","type":"integer"},"items":{"description":"Array of top N clients by usage","items":{"properties":{"clientConnectionType":{"description":"Specifies the type of client","enum":["Wired","Wireless","Remote"],"type":"string"},"clientName":{"description":"Name of the client","type":"string"},"id":{"$ref":"#/components/schemas/IDclients__284f33982989"},"macAddress":{"description":"MAC address of the client","type":"string"},"siteId":{"$ref":"#/components/schemas/SiteIdclients__284f33982989"},"siteName":{"$ref":"#/components/schemas/SiteNameclients__284f33982989"},"type":{"$ref":"#/components/schemas/Typeclients__284f33982989"},"usage":{"description":"Total usage in Bytes","format":"int64","type":"integer"}},"required":["clientName","macAddress","usage","clientConnectionType","id","type","siteName","siteId"],"type":"object"},"type":"array"}},"required":["items","count"],"type":"object"},"Good__a51bf4679e93":{"description":"The number of VLANs that are good in health.\n","example":1,"format":"int32","type":"integer"},"GraphDataPoint__05867e444b37":{"description":"An object containing data points and a corresponding timestamp.","properties":{"data":{"description":"A list of values corresponding to the keys","items":{"format":"double","maximum":10000000000000000,"minimum":-10000000000000000,"type":"number"},"maxItems":10,"type":"array"},"timestamp":{"description":"An RFC 3339 date-time string","example":"2024-03-12T07:20:50.52Z","format":"date-time","maxLength":128,"type":"string"}},"required":["data","timestamp"],"type":"object"},"GroupId__7006262f8c4c":{"description":"The group ID of the Device.\n","examples":["12345"],"maxLength":128,"type":"string"},"GroupName__7006262f8c4c":{"description":"The group name of the device.\n","examples":["group1"],"maxLength":128,"type":"string"},"GroupValue__0bffa6fb51f5":{"properties":{"name":{"example":"Poor","type":"string"},"value":{"example":40,"type":"integer"}},"type":"object"},"GwCPUTrend__51aa0b146279":{"example":{"graph":{"keys":["cpu_utilization"],"samples":[{"data":[10],"timestamp":"2022-07-30T20:00:00Z"}]},"id":"GW00000001","metric":"cpu_utilization","type":"network-monitoring/gateway-monitoring"},"properties":{"graph":{"properties":{"keys":{"description":"List of metrics which help to evaluate the CPU trend of the gateway.\n","example":["cpu_utilization"],"items":{"type":"string"},"maxItems":1,"type":"array"},"samples":{"items":{"$ref":"#/components/schemas/GraphDataPoint__05867e444b37"},"maxItems":10000,"type":"array"}},"required":["keys","samples"],"type":"object"},"id":{"$ref":"#/components/schemas/IDgw__1053ccf03958"},"metric":{"description":"Metric for the CPU utilization trends of gateway.","example":"cpu_utilization","maxLength":128,"type":"string"},"type":{"$ref":"#/components/schemas/Typegw__1053ccf03958"}},"required":["metric","graph","id","type"],"type":"object"},"GwFramesErrorsTrend__ab9c9f33ae99":{"example":{"graph":{"keys":["crc/Fcs","crc/FcsPercentage","collisions","collisionsPercentage","runts","runtsPercentage","giants","giantsPercentage"],"samples":[{"data":[261,0.01,0,0,308,0.01,270,0.01],"timestamp":"2022-07-30T20:00:00Z"}]},"id":"gw1/ports/GE 0/0/1/frames-errors-trends","type":"network-monitoring/gateway-monitoring"},"properties":{"graph":{"properties":{"keys":{"description":"List of metrics which help to evaluate the frames errors trend of a gateway port.\n","example":["crc/Fcs","crc/FcsPercentage","collisions","collisionsPercentage","runts","runtsPercentage","giants","giantsPercentage"],"items":{"type":"string"},"maxItems":8,"type":"array"},"samples":{"items":{"$ref":"#/components/schemas/GraphDataPoint__05867e444b37"},"maxItems":10000,"type":"array"}},"required":["keys","samples"],"type":"object"},"id":{"$ref":"#/components/schemas/IDgw__1053ccf03958"},"type":{"$ref":"#/components/schemas/Typegw__1053ccf03958"}},"required":["graph","id","type"],"type":"object"},"GwFramesPacketsTrend__b5fe37f7cc07":{"example":{"graph":{"keys":["broadcast","broadcastPercentage","multicast","multicastPercentage"],"samples":[{"data":[187,0.03,1815,0.03],"timestamp":"2022-07-30T20:00:00Z"}]},"id":"gw1/ports/GE 0/0/1/frames-packets-trends","type":"network-monitoring/gateway-monitoring"},"properties":{"graph":{"properties":{"keys":{"description":"List of metrics which help to evaluate the frames errors trend of a gateway port.\n","example":["broadcast","broadcastPercentage","multicast","multicastPercentage"],"items":{"type":"string"},"maxItems":4,"type":"array"},"samples":{"items":{"$ref":"#/components/schemas/GraphDataPoint__05867e444b37"},"maxItems":10000,"type":"array"}},"required":["keys","samples"],"type":"object"},"id":{"$ref":"#/components/schemas/IDgw__1053ccf03958"},"type":{"$ref":"#/components/schemas/Typegw__1053ccf03958"}},"required":["graph","id","type"],"type":"object"},"GwFramesTrend__8102176f16c5":{"example":{"graph":{"keys":["broadcastMulticast","broadcastMulticastPercentage","errors","errorsPercentage"],"samples":[{"data":[2002,0.37,108,0.02],"timestamp":"2022-07-30T20:00:00Z"}]},"id":"gw1/ports/GE 0/0/1/frames-trends","type":"network-monitoring/gateway-monitoring"},"properties":{"graph":{"properties":{"keys":{"description":"List of metrics which help to evaluate the frames trend of a gateway port.\n","example":["broadcastMulticast","broadcastMulticastPercentage","errors","errorsPercentage"],"items":{"type":"string"},"maxItems":4,"type":"array"},"samples":{"items":{"$ref":"#/components/schemas/GraphDataPoint__05867e444b37"},"maxItems":10000,"type":"array"}},"required":["keys","samples"],"type":"object"},"id":{"$ref":"#/components/schemas/IDgw__1053ccf03958"},"type":{"$ref":"#/components/schemas/Typegw__1053ccf03958"}},"required":["graph","id","type"],"type":"object"},"GwInterfaceThroughputTrend__b3fc83ccae26":{"example":{"graph":{"keys":["tx","rx"],"samples":[{"data":[10,50],"timestamp":"2022-07-30T20:00:00Z"}]},"id":"GW00000001/ports/1","type":"network-monitoring/gateway-monitoring"},"properties":{"graph":{"properties":{"keys":{"description":"List of metrics which help to evaluate the interface throughput trend of a gateway.\n","example":["tx","rx"],"items":{"type":"string"},"maxItems":2,"type":"array"},"samples":{"items":{"$ref":"#/components/schemas/GraphDataPoint__05867e444b37"},"maxItems":10000,"type":"array"}},"required":["keys","samples"],"type":"object"},"id":{"$ref":"#/components/schemas/IDgw__1053ccf03958"},"type":{"$ref":"#/components/schemas/Typegw__1053ccf03958"}},"required":["graph","id","type"],"type":"object"},"GwLanTunnelStatusTrend__4b0780db8ebd":{"example":{"graph":{"keys":["status","survivability"],"samples":[{"data":[100,50],"timestamp":"2022-07-30T20:00:00Z"}]},"id":"GW00000001/tunnels/ap-ipsecmap-00:44:55:66:79:4a","type":"network-monitoring/gateway-monitoring"},"properties":{"graph":{"properties":{"keys":{"description":"List of metrics which help to evaluate the status trend of a gateway LAN tunnel.\n","example":["status","survivability"],"items":{"type":"string"},"maxItems":2,"type":"array"},"samples":{"items":{"$ref":"#/components/schemas/GraphDataPoint__05867e444b37"},"maxItems":10000,"type":"array"}},"required":["keys","samples"],"type":"object"},"id":{"$ref":"#/components/schemas/IDgw__1053ccf03958"},"type":{"$ref":"#/components/schemas/Typegw__1053ccf03958"}},"required":["graph","id","type"],"type":"object"},"GwLanTunnelThroughputTrend__e0ccaf5b72e7":{"example":{"graph":{"keys":["tx","rx"],"samples":[{"data":[10,50],"timestamp":"2022-07-30T20:00:00Z"}]},"id":"GW00000001/tunnels/ap-ipsecmap-00:44:55:66:79:4a","type":"network-monitoring/gateway-monitoring"},"properties":{"graph":{"properties":{"keys":{"description":"List of metrics which help to evaluate the throughput trend of a gateway LAN tunnel.\n","example":["tx","rx"],"items":{"type":"string"},"maxItems":2,"type":"array"},"samples":{"items":{"$ref":"#/components/schemas/GraphDataPoint__05867e444b37"},"maxItems":10000,"type":"array"}},"required":["keys","samples"],"type":"object"},"id":{"$ref":"#/components/schemas/IDgw__1053ccf03958"},"type":{"$ref":"#/components/schemas/Typegw__1053ccf03958"}},"required":["graph","id","type"],"type":"object"},"GwMemTrend__77dda74866ce":{"example":{"graph":{"keys":["memory_utilization"],"samples":[{"data":[10],"timestamp":"2022-07-30T20:00:00Z"}]},"id":"GW00000001","metric":"memory_utilization","type":"network-monitoring/gateway-monitoring"},"properties":{"graph":{"properties":{"keys":{"description":"List of metrics which help to evaluate the memory trend of the gateway.\n","example":["memory_utilization"],"items":{"type":"string"},"maxItems":1,"type":"array"},"samples":{"items":{"$ref":"#/components/schemas/GraphDataPoint__05867e444b37"},"maxItems":10000,"type":"array"}},"required":["keys","samples"],"type":"object"},"id":{"$ref":"#/components/schemas/IDgw__1053ccf03958"},"metric":{"description":"Metric for the memory utilization trends of gateway.","example":"memory_utilization","maxLength":128,"type":"string"},"type":{"$ref":"#/components/schemas/Typegw__1053ccf03958"}},"required":["metric","graph","id","type"],"type":"object"},"GwModemStats__e46fc9dcc985":{"example":{"arfcn3g":0,"arfcnLte":1615,"cqi":0,"dataBilling":1,"dataLimit":"60 MB","dataUsage":"90 MB","id":"GW00000001","rscp3g":"0 dBm","rsrpLte":"-91 dBm","rsrq":"-13 dBm","rssi":"-61 dBm","signalStrength":9,"type":"network-monitoring/gateway-monitoring"},"properties":{"arfcn3g":{"description":"Absolute Radio Frequency Channel Number for 3G networks.\n","example":0,"format":"int32","type":"integer"},"arfcnLte":{"description":"Absolute Radio Frequency Channel Number for LTE networks.\n","example":1615,"format":"int32","type":"integer"},"cqi":{"description":"Channel Quality Indicator representing the quality of the wireless channel.\n","example":0,"format":"int32","type":"integer"},"dataBilling":{"description":"It indicates the start date of the monthly billing cycle.\n","example":1,"format":"int64","maximum":31,"minimum":1,"type":"integer"},"dataLimit":{"description":"Data limit for the modem connection.\n","example":"60 MB","type":"string"},"dataUsage":{"description":"Data usage for the modem connection.\n","example":"90 MB","type":"string"},"id":{"$ref":"#/components/schemas/IDgw__1053ccf03958"},"rscp3g":{"description":"Received Signal Code Power for 3G networks.\n","example":"0 dBm","type":"string"},"rsrpLte":{"description":"Reference Signal Received Power for LTE networks.\n","example":"-91 dBm","type":"string"},"rsrq":{"description":"Reference Signal Received Quality for LTE networks.\n","example":"-13 dBm","type":"string"},"rssi":{"description":"Received Signal Strength Indicator for the modem connection.\n","example":"-61 dBm","type":"string"},"signalStrength":{"description":"Signal-to-Interference-plus-Noise Ratio for the modem connection.\n","example":9,"format":"int32","type":"integer"},"type":{"$ref":"#/components/schemas/Typegw__1053ccf03958"}},"required":["arfcn3g","arfcnLte","cqi","dataBilling","dataLimit","dataUsage","rscp3g","rsrpLte","rsrq","rssi","signalStrength","id","type"],"type":"object"},"GwProbeList__cded6adac170":{"example":{"id":"GW00000001/uplinks/airtel/probes","items":["8.8.8.8","Health Check"],"type":"network-monitoring/gateway-monitoring"},"properties":{"id":{"$ref":"#/components/schemas/IDgw__1053ccf03958"},"items":{"items":{"type":"string"},"type":"array"},"type":{"$ref":"#/components/schemas/Typegw__1053ccf03958"}},"required":["items","id","type"],"type":"object"},"GwProbePerformanceTrends__3b1a72220c8c":{"example":[{"graph":{"keys":["latency"],"samples":[{"data":[1.3],"timestamp":"2022-07-30T20:00:00Z"}]},"id":"GW00000001/uplinks/airtel/probes/Health-Check","metric":"latency","type":"network-monitoring/gateway-monitoring"},{"graph":{"keys":["jitter"],"samples":[{"data":[0.09],"timestamp":"2022-07-30T20:00:00Z"}]},"id":"GW00000001/uplinks/airtel/probes/Health-Check","metric":"jitter","type":"network-monitoring/gateway-monitoring"},{"graph":{"keys":["packet_loss"],"samples":[{"data":[6.9],"timestamp":"2022-07-30T20:00:00Z"}]},"id":"GW00000001/uplinks/airtel/probes/Health-Check","metric":"packet_loss","type":"network-monitoring/gateway-monitoring"},{"graph":{"keys":["mos"],"samples":[{"data":[3.8],"timestamp":"2022-07-30T20:00:00Z"}]},"id":"GW00000001/uplinks/airtel/probes/Health-Check","metric":"mos","type":"network-monitoring/gateway-monitoring"}],"properties":{"graph":{"properties":{"keys":{"description":"List of metrics which help to evaluate the performance of the uplink.\n","example":["latency","jitter","packet_loss","mos"],"items":{"type":"string"},"maxItems":4,"type":"array"},"samples":{"items":{"$ref":"#/components/schemas/GraphDataPoint__05867e444b37"},"maxItems":10000,"type":"array"}},"required":["keys","samples"],"type":"object"},"id":{"$ref":"#/components/schemas/IDgw__1053ccf03958"},"metric":{"description":"Metric for the uplink performance trend.","example":"latency","maxLength":128,"type":"string"},"type":{"$ref":"#/components/schemas/Typegw__1053ccf03958"}},"required":["metric","graph","id","type"],"type":"object"},"GwTempTrend__4ea249a3349f":{"example":[{"graph":{"keys":["CPU"],"samples":[{"data":[45],"timestamp":"2022-07-30T20:00:00Z"}]},"id":"GW00000001","metric":"temperature","type":"network-monitoring/gateway-monitoring"},{"graph":{"keys":["Ambient"],"samples":[{"data":[40],"timestamp":"2022-07-30T20:00:00Z"}]},"id":"GW00000001","metric":"temperature","type":"network-monitoring/gateway-monitoring"}],"properties":{"graph":{"properties":{"keys":{"description":"List of metrics which help to evaluate the temperature trends of the gateway in Celsius.\n","example":["CPU"],"items":{"type":"string"},"maxItems":1,"type":"array"},"samples":{"items":{"$ref":"#/components/schemas/GraphDataPoint__05867e444b37"},"maxItems":10000,"type":"array"}},"required":["keys","samples"],"type":"object"},"id":{"$ref":"#/components/schemas/IDgw__1053ccf03958"},"metric":{"description":"Metric for the hardware temperature trends of gateway.","example":"temperature","maxLength":128,"type":"string"},"type":{"$ref":"#/components/schemas/Typegw__1053ccf03958"}},"required":["metric","graph","id","type"],"type":"object"},"GwTunnelPacketsTrend__7b41d1172fa8":{"example":{"graph":{"keys":["dropped_packets"],"samples":[{"data":[7.58],"timestamp":"2022-07-30T20:00:00Z"}]},"id":"gw1/tunnels/ap-ipsecmap-00:44:55:66:79:22","type":"network-monitoring/gateway-monitoring"},"properties":{"graph":{"properties":{"keys":{"description":"The metric for dropped packets by the tunnel.\n","example":["dropped_packets"],"items":{"type":"string"},"maxItems":1,"type":"array"},"samples":{"items":{"$ref":"#/components/schemas/GraphDataPoint__05867e444b37"},"maxItems":10000,"type":"array"}},"required":["keys","samples"],"type":"object"},"id":{"$ref":"#/components/schemas/IDgw__1053ccf03958"},"type":{"$ref":"#/components/schemas/Typegw__1053ccf03958"}},"required":["graph","id","type"],"type":"object"},"GwUplVpnAvailTrends__ceaebbdf1a3d":{"example":[{"graph":{"keys":["5.6.7.8"],"samples":[{"data":[100],"timestamp":"2022-07-30T20:00:00Z"}]},"id":"GW00000001/uplinks/airtel/vpn-availability-trends","type":"network-monitoring/gateway-monitoring"}],"properties":{"graph":{"properties":{"keys":{"description":"List of VPNs which help to evaluate the VPN availability of the uplink.\n","example":["8.8.8.8"],"items":{"type":"string"},"type":"array"},"samples":{"items":{"$ref":"#/components/schemas/GraphDataPoint__05867e444b37"},"maxItems":10000,"type":"array"}},"required":["keys","samples"],"type":"object"},"id":{"$ref":"#/components/schemas/IDgw__1053ccf03958"},"type":{"$ref":"#/components/schemas/Typegw__1053ccf03958"}},"required":["graph","id","type"],"type":"object"},"GwUplWanAvailTrends__ed53668aec87":{"example":[{"graph":{"keys":["default_gateway"],"samples":[{"data":[75],"timestamp":"2022-07-30T20:00:00Z"}]},"id":"GW00000001/uplinks/airtel/wan-availability-trends","metric":"default_gateway","type":"network-monitoring/gateway-monitoring"},{"graph":{"keys":["health_check_ip"],"samples":[{"data":[75],"timestamp":"2022-07-30T20:00:00Z"}]},"id":"GW00000001/uplinks/airtel/wan-availability-trends","metric":"health_check_ip","type":"network-monitoring/gateway-monitoring"}],"properties":{"graph":{"properties":{"keys":{"description":"List of metrics which help to evaluate the WAN availability of the uplink.\n","example":["default_gateway"],"items":{"type":"string"},"maxItems":1,"type":"array"},"samples":{"items":{"$ref":"#/components/schemas/GraphDataPoint__05867e444b37"},"maxItems":10000,"type":"array"}},"required":["keys","samples"],"type":"object"},"id":{"$ref":"#/components/schemas/IDgw__1053ccf03958"},"metric":{"description":"Metric to evaluate WAN availability of an uplink.","example":"default_gateway","maxLength":128,"type":"string"},"type":{"$ref":"#/components/schemas/Typegw__1053ccf03958"}},"required":["metric","graph","id","type"],"type":"object"},"GwUplinkThroughputTrend__21365dd4a16e":{"example":{"graph":{"keys":["tx","rx"],"samples":[{"data":[1230,5023],"timestamp":"2022-07-30T20:00:00Z"}]},"id":"GW00000001/uplinks/airtel","type":"network-monitoring/gateway-monitoring"},"properties":{"graph":{"properties":{"keys":{"description":"List of metrics which help to evaluate the gateway uplink interface throughput trends.\n","example":["tx","rx"],"items":{"type":"string"},"maxItems":2,"type":"array"},"samples":{"items":{"$ref":"#/components/schemas/GraphDataPoint__05867e444b37"},"maxItems":10000,"type":"array"}},"required":["keys","samples"],"type":"object"},"id":{"$ref":"#/components/schemas/IDgw__1053ccf03958"},"type":{"$ref":"#/components/schemas/Typegw__1053ccf03958"}},"required":["graph","id","type"],"type":"object"},"GwVpnAvailTrend__997aa0335c83":{"example":{"graph":{"keys":["vpn_availability"],"samples":[{"data":[1],"timestamp":"2022-07-30T20:00:00Z"}]},"id":"gw1","metric":"vpn","type":"network-monitoring/gateway-monitoring"},"properties":{"graph":{"properties":{"keys":{"description":"The VPN availability metric.\n","example":["vpn_availability"],"items":{"type":"string"},"maxItems":1,"type":"array"},"samples":{"items":{"$ref":"#/components/schemas/GraphDataPoint__05867e444b37"},"maxItems":10000,"type":"array"}},"required":["keys","samples"],"type":"object"},"id":{"$ref":"#/components/schemas/IDgw__1053ccf03958"},"metric":{"description":"Metric for the VPN availability trends of gateway.","example":"wan","maxLength":128,"type":"string"},"type":{"$ref":"#/components/schemas/Typegw__1053ccf03958"}},"required":["metric","graph","id","type"],"type":"object"},"GwWanAvailTrend__624829d8bb9e":{"example":{"graph":{"keys":["wan_availability"],"samples":[{"data":[1],"timestamp":"2022-07-30T20:00:00Z"}]},"id":"gw1","metric":"wan","type":"network-monitoring/gateway-monitoring"},"properties":{"graph":{"properties":{"keys":{"description":"The WAN availability metric.\n","example":["wan_availability"],"items":{"type":"string"},"maxItems":1,"type":"array"},"samples":{"items":{"$ref":"#/components/schemas/GraphDataPoint__05867e444b37"},"maxItems":10000,"type":"array"}},"required":["keys","samples"],"type":"object"},"id":{"$ref":"#/components/schemas/IDgw__1053ccf03958"},"metric":{"description":"Metric for the WAN availability trends of gateway.","example":"wan","maxLength":128,"type":"string"},"type":{"$ref":"#/components/schemas/Typegw__1053ccf03958"}},"required":["metric","graph","id","type"],"type":"object"},"GwWanCompressionTrend__1053ccf03958":{"example":{"graph":{"keys":["bandwidth_saved","bandwidth_used"],"samples":[{"data":[123,402],"timestamp":"2022-07-30T20:00:00Z"}]},"id":"GW00000001/uplinks/airtel","type":"network-monitoring/gateway-monitoring"},"properties":{"graph":{"properties":{"keys":{"description":"List of metrics which help to evaluate the gateway WAN compression trends.\n","example":["bandwidth_saved","bandwidth_used"],"items":{"type":"string"},"maxItems":2,"type":"array"},"samples":{"items":{"$ref":"#/components/schemas/GraphDataPoint__05867e444b37"},"maxItems":10000,"type":"array"}},"required":["keys","samples"],"type":"object"},"id":{"$ref":"#/components/schemas/IDgw__1053ccf03958"},"type":{"$ref":"#/components/schemas/Typegw__1053ccf03958"}},"required":["graph","id","type"],"type":"object"},"HardwareCategoryCount__eb47230c21a4":{"properties":{"failedIds":{"description":"List of failed hardwares.","items":{"$ref":"#/components/schemas/HardwareFailedSummary__eb47230c21a4"},"type":"array"},"health":{"description":"Health of the hardware","example":"Good","type":"string"},"totalCount":{"description":"Total count of the hardware","example":"3","type":"integer"},"upCount":{"description":"Up count of the hardware","example":"1","type":"integer"}},"type":"object"},"HardwareCategory__eb47230c21a4":{"properties":{"health":{"description":"Health of the hardware","example":"Good","type":"string"}},"required":["health"],"type":"object"},"HardwareFailedSummary__eb47230c21a4":{"properties":{"ids":{"description":"Failed ids of the hardware for a switch","example":["1","2"],"items":{"type":"string"},"type":"array"},"stackMemberId":{"description":"Member id of the switch","example":"Good","type":"integer"}},"required":["health"],"type":"object"},"HardwareTrendsResponse__5cf5b3c37fbc":{"description":"Response containing hardware trends related to the switch.","properties":{"id":{"description":"identifier.","example":"8","type":"string"},"keys":{"description":"Trends list.","example":["cpuUtilization,memoryUtilization"],"items":{"type":"string"},"type":"array"},"metric":{"description":"Trends name.","example":"SwitchNetworkHardwareTrends","type":"string"},"switchMetrics":{"description":"Samples for the trends.","items":{"$ref":"#/components/schemas/SwitchMetrics__5cf5b3c37fbc"},"type":"array"},"type":{"description":"Device type of monitoring.","example":"network-monitoring/switch-monitoring","type":"string"},"units":{"description":"Units for the trends in the keys list.","example":["Frames,B,Packets"],"items":{"type":"string"},"type":"array"}},"required":["id","type"],"type":"object"},"HashedMacAddress__3f58b16772b5":{"description":"One way hash of the MAC address to anonymize the client.\n","example":"43ddc7ed75eb039db1fec4839c0e33d21bfb21e1","format":"const","maxLength":128,"type":["string","null"]},"HealthReason__0bffa6fb51f5":{"properties":{"data":{"properties":{"count":{"example":5,"type":"integer"}},"type":"object"},"health":{"example":"Poor","type":"string"},"reason":{"example":"CLIENT_HEALTH_POOR","type":"string"}},"type":"object"},"Health__0bffa6fb51f5":{"properties":{"groups":{"items":{"$ref":"#/components/schemas/GroupValue__0bffa6fb51f5"},"type":"array"}},"type":"object"},"Hibernate__98bb0f033247":{"description":"Indicates whether the access point is in hibernate mode.","example":false,"type":"boolean"},"HmacKey__c1c7772865ac":{"description":"The HMAC key used for signing webhook payloads.","maxLength":32,"minLength":1,"type":"string"},"HostName__284f33982989":{"description":"The client's hostname.","example":"13_B3_20_22_B0_04H","type":"string"},"HttpApParsedOutput__78f43680b94b":{"properties":{"downloadBytesInKB":{"description":"The download size in bytes.","type":"string"},"downloadRateInKbps":{"description":"The download rate in Mbps.","type":"string"},"url":{"description":"The URL used for the HTTP test.","type":"string"}},"title":"AP HTTP RESPONSE","type":"object"},"HttpApRequest__c3cbd398bd37":{"properties":{"timeout":{"description":"Timeout in seconds (1-10)","maximum":10,"minimum":1,"type":"integer"},"url":{"description":"Hostname/IP address required","type":"string"}},"required":["url"],"title":"AP HTTP REQUEST","type":"object"},"HttpApResult__78f43680b94b":{"allOf":[{"$ref":"#/components/schemas/AsyncOperationResultBase__03efdde95a47"},{"properties":{"output":{"allOf":[{"$ref":"#/components/schemas/HttpApParsedOutput__78f43680b94b"}],"type":["object","null"]}},"type":"object"}],"title":"AP HTTP RESULT"},"HttpCxHttpstatisticsresult__0f46fc6247ab":{"properties":{"bindError":{"description":"Number of times failed to bind interface or ip address.","type":"integer"},"destinationAddressUnreachableCount":{"description":"The number of times the destination address was unreachable.","type":"integer"},"dhcpFailed":{"description":"Number of times DHCP operation failed","type":"integer"},"dhcpNack":{"description":"Number of times DHCP operation failed due to DHCP-NACK from the server","type":"integer"},"dhcpNoOffer":{"description":"Number of times DHCP operation failed because DHCP-Offer is not received","type":"integer"},"dnsFormatError":{"description":"Number of times DNS resolution failed due to DNS query format error. RFC 1035 RCODE: 1","type":"integer"},"dnsNameExists":{"description":"Number of times DNS resolution failed due to 'Name-Exists when it should not' error. RFC 2136 RCODE: 6","type":"integer"},"dnsNonExistentDomain":{"description":"Number of times DNS resolution failed due to non-existent domain. RFC 1035 RCODE: 3","type":"integer"},"dnsNotAuthoritative":{"description":"Number of times DNS resolution failed due to 'Server Not Authoritative for zone' error. RFC 2136 RCODE: 9","type":"integer"},"dnsNotImplemented":{"description":"Number of times DNS resolution failed due to not implemented error. RFC 1035 RCODE: 4","type":"integer"},"dnsNotZone":{"description":"Number of times DNS resolution failed due to 'Name not contained in zone' error. RFC 2136 RCODE: 10","type":"integer"},"dnsQueryRefused":{"description":"Number of times DNS resolution failed due to query refused error. RFC 1035 RCODE: 5","type":"integer"},"dnsResolutionFailures":{"description":"The number of DNS resolution failures.","type":"integer"},"dnsRrsetExists":{"description":"Number of times DNS resolution failed due to 'RR Set Exists when it should not' error. RFC 2136 RCODE: 7","type":"integer"},"dnsServerFailure":{"description":"Number of times DNS resolution failed due to server failure error. RFC 1035 RCODE: 2","type":"integer"},"probesTimedOut":{"description":"The number of probes that timed out.","type":"integer"},"probesTransmitted":{"description":"The number of probes that were successfully transmitted.","type":"integer"},"socketReceiveError":{"description":"The number of times failed to receive packet.","type":"integer"},"transmissionError":{"description":"The number of transmission errors.","type":"integer"}},"title":"CX HTTP STATISTICS","type":"object"},"HttpCxParsedOutput__0f46fc6247ab":{"properties":{"destination":{"description":"The destination URL for the HTTP test.","type":"string"},"results":{"$ref":"#/components/schemas/HttpCxSlaresult__0f46fc6247ab","description":"The results of the HTTP test."},"statistics":{"$ref":"#/components/schemas/HttpCxHttpstatisticsresult__0f46fc6247ab","description":"The statistics of the HTTP test."}},"title":"CX HTTP RESPONSE","type":"object"},"HttpCxRequest__87b115ffbfa6":{"properties":{"destination":{"description":"Hostname/IP address required","type":"string"},"nameServer":{"description":"IPv4 address of the DNS server to use","type":"string"},"protocol":{"description":"","enum":["HTTP","HTTPS"],"type":"string"},"sourceInterface":{"description":"The source interface to use for sending IP-SLA probes.","type":"string"},"sourcePort":{"description":"The source port to use for the IP-SLA probes (0-65535).","maximum":65535,"minimum":1,"type":"integer"},"vrfName":{"description":"The default value is 'default'","type":"string"}},"required":["destination"],"title":"CX HTTP REQUEST","type":"object"},"HttpCxResult__0f46fc6247ab":{"allOf":[{"$ref":"#/components/schemas/AsyncOperationResultBase__03efdde95a47"},{"properties":{"output":{"allOf":[{"$ref":"#/components/schemas/HttpCxParsedOutput__0f46fc6247ab"}],"type":["object","null"]}},"type":"object"}],"title":"CX HTTP RESULT"},"HttpCxSlaresult__0f46fc6247ab":{"properties":{"averageRttInMilliseconds":{"description":"The average round-trip time in milliseconds.","type":"integer"},"dhcpServerIp":{"description":"The IP address of the DHCP server.","type":"string"},"dnsError":{"description":"The number of DNS error occured during the last DNS query","type":"integer"},"dnsRttInMilliseconds":{"description":"The round-trip time for DNS resolution in milliseconds.","type":"integer"},"httpError":{"description":"The number of  HTTP error occurred during the last HTTP transaction.","type":"integer"},"httpTransactionRttInMilliseconds":{"description":"The round-trip time for the HTTP transaction in milliseconds.","type":"integer"},"maximumRttInMilliseconds":{"description":"The maximum round-trip time in milliseconds.","type":"integer"},"minimumRttInMilliseconds":{"description":"The minimum round-trip time in milliseconds.","type":"integer"},"packetsReceived":{"description":"The number of packets received.","type":"integer"},"packetsTransmitted":{"description":"The number of packets transmitted.","type":"integer"},"resolvedIp":{"description":"The IP address resolved from the latest DNS or DHCP probe.","type":"string"}},"title":"CX HTTP SLA RESULT","type":"object"},"HttpMcHttprowresult__fd2addb716a2":{"properties":{"downloadRate":{"description":"The download rate in bps.","type":"string"},"responseBytes":{"description":"The size of the HTTP response in bytes.","type":"string"},"responseCode":{"description":"The HTTP response code.","type":"string"},"responseNumber":{"description":"The number of the HTTP response.","type":"string"},"responseTimeMilliseconds":{"description":"The time taken to receive the HTTP response in milliseconds.","type":"string"}},"title":"GATEWAY HTTP ROW","type":"object"},"HttpMcParsedOutput__fd2addb716a2":{"properties":{"averageLatencyMilliseconds":{"description":"The average latency in milliseconds.","type":"string"},"maximumLatencyMilliseconds":{"description":"The maximum latency in milliseconds.","type":"string"},"minimumLatencyMilliseconds":{"description":"The minimum latency in milliseconds.","type":"string"},"receivedPacketsCount":{"description":"The number of packets received.","type":"string"},"responses":{"description":"The results of the HTTP test.","items":{"$ref":"#/components/schemas/HttpMcHttprowresult__fd2addb716a2"},"type":"array"},"sentPacketsCount":{"description":"The number of packets sent.","type":"string"},"successRatePercent":{"description":"The success rate of the HTTP test.","type":"string"},"url":{"description":"The URL used for the HTTP test.","type":"string"}},"title":"GATEWAY HTTP RESPONSE","type":"object"},"HttpMcRequest__dbe206175393":{"properties":{"count":{"description":"Number of ping packets to send (1-10)","maximum":10,"minimum":1,"type":"integer"},"includeRawOutput":{"description":"Whether to include raw output in the response.","type":"boolean"},"interval":{"description":"Time between ping packets in seconds (1-10)","maximum":10,"minimum":1,"type":"integer"},"url":{"description":"Hostname/IP address required","type":"string"}},"required":["url"],"title":"GATEWAY HTTP REQUEST","type":"object"},"HttpMcResult__fd2addb716a2":{"allOf":[{"$ref":"#/components/schemas/AsyncOperationResultBase__03efdde95a47"},{"properties":{"output":{"allOf":[{"$ref":"#/components/schemas/HttpMcParsedOutput__fd2addb716a2"}],"type":["object","null"]},"rawOutput":{"description":"The raw output of the test.","type":"string"}},"type":"object"}],"title":"GATEWAY HTTP RESULT"},"HttpsApParsedOutput__cfd56278c765":{"properties":{"downloadBytesInKB":{"description":"The download size in bytes.","type":"string"},"downloadRateInKbps":{"description":"The download rate in Mbps.","type":"string"},"url":{"description":"The URL used for the HTTP test.","type":"string"}},"title":"AP HTTPS RESPONSE","type":"object"},"HttpsApRequest__8348a8a53499":{"properties":{"timeout":{"description":"Timeout in seconds (1-10)","maximum":10,"minimum":1,"type":"integer"},"url":{"description":"Hostname/IP address required","type":"string"}},"required":["url"],"title":"AP HTTPS REQUEST","type":"object"},"HttpsApResult__cfd56278c765":{"allOf":[{"$ref":"#/components/schemas/AsyncOperationResultBase__03efdde95a47"},{"properties":{"output":{"allOf":[{"$ref":"#/components/schemas/HttpsApParsedOutput__cfd56278c765"}],"type":["object","null"]}},"type":"object"}],"title":"AP HTTPS RESULT"},"HttpsMcHttprowresult__98f2735f9f4e":{"properties":{"downloadRate":{"description":"The download rate in bps.","type":"string"},"responseBytes":{"description":"The size of the HTTP response in bytes.","type":"string"},"responseCode":{"description":"The HTTP response code.","type":"string"},"responseNumber":{"description":"The number of the HTTP response.","type":"string"},"responseTimeMilliseconds":{"description":"The time taken to receive the HTTP response in milliseconds.","type":"string"}},"title":"GATEWAY HTTPS ROW","type":"object"},"HttpsMcParsedOutput__98f2735f9f4e":{"properties":{"averageLatencyMilliseconds":{"description":"The average latency in milliseconds.","type":"string"},"maximumLatencyMilliseconds":{"description":"The maximum latency in milliseconds.","type":"string"},"minimumLatencyMilliseconds":{"description":"The minimum latency in milliseconds.","type":"string"},"receivedPacketsCount":{"description":"The number of packets received.","type":"string"},"responses":{"description":"The results of the HTTP test.","items":{"$ref":"#/components/schemas/HttpsMcHttprowresult__98f2735f9f4e"},"type":"array"},"sentPacketsCount":{"description":"The number of packets sent.","type":"string"},"successRatePercent":{"description":"The success rate of the HTTP test.","type":"string"},"url":{"description":"The URL used for the HTTP test.","type":"string"}},"title":"GATEWAY HTTPS RESPONSE","type":"object"},"HttpsMcRequest__1abcb48aae72":{"properties":{"count":{"description":"Number of ping packets to send (1-10)","maximum":10,"minimum":1,"type":"integer"},"includeRawOutput":{"description":"Whether to include raw output in the response.","type":"boolean"},"interval":{"description":"Time between ping packets in seconds (1-10)","maximum":10,"minimum":1,"type":"integer"},"url":{"description":"Hostname/IP address required","type":"string"}},"required":["url"],"title":"GATEWAY HTTPS REQUEST","type":"object"},"HttpsMcResult__98f2735f9f4e":{"allOf":[{"$ref":"#/components/schemas/AsyncOperationResultBase__03efdde95a47"},{"properties":{"output":{"allOf":[{"$ref":"#/components/schemas/HttpsMcParsedOutput__98f2735f9f4e"}],"type":["object","null"]},"rawOutput":{"description":"The raw output of the test.","type":"string"}},"type":"object"}],"title":"GATEWAY HTTPS RESULT"},"ID__c0c1228d8f7d":{"description":"Primary identifier for the resource.\n","example":"AP00000001","format":"const","maxLength":36,"type":"string"},"IDclients__284f33982989":{"description":"Primary identifier for the resource.\n","example":"c8:b5:ad:c3:b2:04","format":"const","maxLength":36,"type":"string"},"IDdevice__6b9c5f08b869":{"description":"Primary identifier for the resource.","example":"AP00000001","format":"const","maxLength":36,"type":"string"},"IDgw__1053ccf03958":{"description":"Primary identifier for the resource.\n","example":"GW00000001","maxLength":36,"type":"string"},"IPV4__284f33982989":{"description":"Specifies the IPv4 address of the client.","example":"129.110.213.218","type":"string"},"IPV6__284f33982989":{"description":"Specifies the IPv6 address of the client.","example":"2001:0db8:85a3:0000:0000:8a2e:0370:7334","type":"string"},"IPv4Address__6b9c5f08b869":{"description":"IPv4 address of the device.","example":"198.51.100.42","format":"ipv4","maxLength":15,"type":"string"},"IPv4Addressap__98bb0f033247":{"description":"IPv4 address of the access point.\n","example":"198.51.100.42","format":"ipv4","maxLength":15,"type":"string"},"IPv6Address__6b9c5f08b869":{"description":"IPv6 address of the device.","example":"2001:0db8:85a3:0000:0000:8a2e:0370:7334","format":"ipv6","maxLength":39,"type":"string"},"IPv6Addressap__98bb0f033247":{"description":"IPv6 address of the access point.\n","example":"2001:0db8:85a3:0000:0000:8a2e:0370:7334","format":"ipv6","maxLength":39,"type":"string"},"Id__7006262f8c4c":{"description":"The unique identifier of the threat.\n","examples":["threat~1732223424345~x~xxxxx-x"],"maxLength":128,"type":"string"},"Idsite__0bffa6fb51f5":{"description":"Primary identifier for the resource.\n","example":"00001","type":"string"},"Idtopology__004689200476":{"description":"Primary identifier for the resource.","example":"00001","type":"string"},"Idwids__000172564380":{"description":"The unique ID identifier for the resource","examples":["3b5b0e6c-4b73-9f6e-4e89-5a080190abcd"],"format":"uuid","maxLength":128,"type":"string"},"Idwifi__3f58b16772b5":{"description":"Resource ID: client MAC address and createdAt.\n","example":"11:22:33:44:55:66-1234567890123","format":"string","maxLength":31,"type":"string"},"Impact__f8f342aecdae":{"description":"The impact of the threat.\n","examples":["Compromised Workstation"],"maxLength":256,"type":"string"},"ImportStatus__68f64a58b106":{"description":"importStatus provides detail information of import","properties":{"error":{"format":"string","type":"string"},"id":{"format":"uuid","maxLength":128,"type":"string"},"state":{"format":"string","type":"string"},"type":{"description":"API type.\n","example":"feature","format":"string","maxLength":128,"type":"string"}},"required":["id","type"],"type":"object"},"InterfacePoeResponse__87866266e647":{"allOf":[{"description":"Response containing interface poe for the switch.","properties":{"count":{"description":"Total number of interface poe.","example":4,"type":"integer"},"items":{"items":{"$ref":"#/components/schemas/SwitchInterfacePoE__87866266e647"},"maxItems":9999,"type":"array"}},"required":["items","count"],"type":"object"},{"$ref":"#/components/schemas/PaginationResponsePropertiesswitch__244c7d3b837e"}]},"InterfaceTrendsResponse__0d6bfd060cf2":{"description":"Response containing interface trends related to the switch.","properties":{"id":{"description":"identifier.","example":"8","type":"string"},"interfaceId":{"description":"Interface name for which the api called.","example":"7","type":"string"},"keys":{"description":"Trends list.","example":["rxBytes,inErrors"],"items":{"type":"string"},"type":"array"},"metric":{"description":"Trends name.","example":"SwitchNetworkInterfaceTrends","type":"string"},"samples":{"description":"Samples for the interface trends in the key list.","items":{"$ref":"#/components/schemas/Sample__0d6bfd060cf2"},"type":"array"},"type":{"description":"Device type of monitoring.","example":"network-monitoring/switch-monitoring","type":"string"},"units":{"description":"Units for the interface trends in the keys list.","example":["Frames,B,Packets"],"items":{"type":"string"},"type":"array"},"uplink":{"description":"To identify uplink interfaces.","example":"false","type":"boolean"}},"required":["id","type"],"type":"object"},"Interfaces__c99febaf4556":{"description":"The interface to which the VLAN is assigned.\n","example":"unassigned","type":"string"},"InternalServerErrorDetails__0c2a95c4aa99":{"description":"Error details returned from the server.","properties":{"debugId":{"$ref":"#/components/schemas/DebugId__0c2a95c4aa99"},"errorCode":{"description":"Internal error code.","example":"HPE_GL_NETWORK_NOTIFICATIONS_INTERNAL_SERVER_ERROR","maxLength":128,"type":"string"},"httpStatusCode":{"description":"HTTP status code.","example":500,"maximum":500,"minimum":500,"type":"integer"},"message":{"description":"Error message indicating the cause of the failure.","example":"Internal Server Error while processing the request.","maxLength":512,"type":"string"}},"required":["httpStatusCode","errorCode","message","debugId"],"type":"object"},"InternalServerError__004689200476":{"description":"Error details returned from the server.","properties":{"debugId":{"$ref":"#/components/schemas/DebugIdtopology__004689200476"},"errorCode":{"description":"* A unique machine-friendly, but human-readable identifier for the error. It has a prefix HPE_GL_.* For more details regarding error, please refer to the error message","enum":["HPE_GL_NETWORK_MONITORING_INTERNAL_SERVER_ERROR"],"example":"HPE_GL_NETWORK_MONITORING_INTERNAL_SERVER_ERROR","format":"const","maxLength":128,"type":"string"},"httpStatusCode":{"description":"HTTP status code.","example":500,"maximum":500,"minimum":500,"type":"integer"},"message":{"$ref":"#/components/schemas/ErrorMessagedevice__039ba698cb40"}},"required":["httpStatusCode","errorCode","message","debugId"],"type":"object"},"InternalServerError__66b457073e9b":{"description":"Internal server error details returned from the server.\n","properties":{"debugId":{"$ref":"#/components/schemas/DebugId__0288a339fc72"},"errorCode":{"description":"* A unique machine-friendly, but human-readable identifier for the error. It has prefix HPE_GL_.\n* For more details regarding error please refer to error message\n","enum":["HPE_GL_NETWORK_REPORTING_INTERNAL_SERVER_ERROR"],"examples":["HPE_GL_NETWORK_REPORTING_INTERNAL_SERVER_ERROR"],"maxLength":128,"type":"string"},"httpStatusCode":{"description":"HTTP status code.","examples":[500],"maximum":500,"minimum":500,"type":"integer"},"message":{"$ref":"#/components/schemas/ErrorMessage__66b457073e9b"}},"required":["httpStatusCode","errorCode","message","debugId"],"type":"object"},"InternalServerError__6ff1f6639f14":{"description":"Internal server error details returned from the server.\n","properties":{"debugId":{"$ref":"#/components/schemas/DebugId__000172564380"},"errorCode":{"description":"* A unique machine-friendly, but human-readable identifier for the error. It has prefix HPE_GL_.\n* For more details regarding error please refer to error message\n","enum":["HPE_GL_NETWORK_MSP_INTERNAL_SERVER_ERROR"],"example":"HPE_GL_NETWORK_MSP_INTERNAL_SERVER_ERROR","format":"const","maxLength":128,"type":"string"},"httpStatusCode":{"description":"HTTP status code.","example":500,"maximum":500,"minimum":500,"type":"integer"},"message":{"$ref":"#/components/schemas/ErrorMessage__6ff1f6639f14"}},"required":["httpStatusCode","errorCode","message","debugId"],"type":"object"},"IntrusionCategory__000172564380":{"description":"Category of the intrusion","enum":["CLIENT","INFRASTRUCTURE"],"examples":["INFRASTRUCTURE"],"type":"string"},"IntrusionData__000172564380":{"description":"Object with Signature details\n","properties":{"category":{"$ref":"#/components/schemas/IntrusionCategory__000172564380"},"createdAt":{"$ref":"#/components/schemas/CreatedAtwids__000172564380"},"description":{"$ref":"#/components/schemas/Descriptionwids__000172564380"},"detectingAp":{"$ref":"#/components/schemas/DetectingAp__000172564380"},"eventTime":{"$ref":"#/components/schemas/EventTime__000172564380"},"eventType":{"$ref":"#/components/schemas/SignatureType__000172564380"},"id":{"$ref":"#/components/schemas/Idwids__000172564380"},"level":{"$ref":"#/components/schemas/IntrusionLevel__000172564380"},"radioBand":{"$ref":"#/components/schemas/RadioBand__000172564380"},"siteId":{"$ref":"#/components/schemas/SiteIdwids__000172564380"},"siteName":{"$ref":"#/components/schemas/SiteNamewids__000172564380"},"stationMac":{"$ref":"#/components/schemas/StationMac__000172564380"},"type":{"description":"Resource type.\n","enum":["network-services/wids-intrusions"],"examples":["network-services/wids-intrusions"],"format":"enum","type":"string"}},"required":["id","type","createdAt","siteId","siteName","detectingAp","category","eventType","level","eventTime","radioBand","description"],"type":"object"},"IntrusionLevel__000172564380":{"description":"Severity level of the intrusion","enum":["LOW","MEDIUM","HIGH"],"examples":["MEDIUM"],"type":"string"},"IntrusionListPage__000172564380":{"allOf":[{"properties":{"items":{"items":{"$ref":"#/components/schemas/IntrusionData__000172564380"},"maxItems":2147483647,"type":"array"}},"required":["items"],"type":"object"},{"$ref":"#/components/schemas/PaginationResponsePropertieswids__000172564380"}]},"IpAddress__13edfa6d725b":{"description":"Source IP Address of the user executed the operation.\n","example":"192.168.1.100","maxLength":64,"type":"string"},"IperfMcIperfrowresult__768b748deb18":{"properties":{"bandwidthInbps":{"description":"The bandwidth in bits per second.","type":"string"},"id":{"description":"The identifier for a single interval per parallel.","type":"string"},"intervalInSeconds":{"description":"The interval of the iperf test.","type":"string"},"transferSizeInBytes":{"description":"The size of the transfer in bytes.","type":"string"}},"title":"GATEWAY IPERF METRIC","type":"object"},"IperfMcParsedOutput__768b748deb18":{"properties":{"iperfServerAddress":{"description":"The server address used for the iperf test.","type":"string"},"metrics":{"description":"The metrics collected during the iperf test.","items":{"$ref":"#/components/schemas/IperfMcIperfrowresult__768b748deb18"},"type":"array"},"receiverBandwidth":{"description":"The bandwidth from the receiver's perspective.","type":"string"},"senderBandwidth":{"description":"The bandwidth from the sender's perspective.","type":"string"},"totalTransferredBytesFromReceiver":{"description":"The number of bytes transferred from the receiver.","type":"string"},"totalTransferredBytesFromSender":{"description":"The number of bytes transferred from the sender.","type":"string"}},"title":"GATEWAY IPERF RESPONSE","type":"object"},"IperfMcRequest__02a6567f3633":{"properties":{"duration":{"description":"Transmission time in seconds (10-120)","maximum":120,"minimum":10,"type":"integer"},"includeRawOutput":{"description":"Whether to include raw output in the response.","type":"boolean"},"includeReverse":{"description":"Include Reverse","type":"boolean"},"iperfServerAddress":{"description":"IP Address Required","type":"string"},"omit":{"description":"","maximum":60,"minimum":1,"type":"integer"},"parallel":{"description":"","maximum":128,"minimum":1,"type":"integer"},"port":{"description":"The TCP port (range: 1-65535)","maximum":65535,"minimum":1,"type":"integer"},"protocol":{"description":"","enum":["tcp","udp"],"type":"string"},"vlanInterface":{"description":"","type":"string"}},"required":["iperfServerAddress"],"title":"GATEWAY IPERF REQUEST","type":"object"},"IperfMcResult__768b748deb18":{"allOf":[{"$ref":"#/components/schemas/AsyncOperationResultBase__03efdde95a47"},{"properties":{"output":{"allOf":[{"$ref":"#/components/schemas/IperfMcParsedOutput__768b748deb18"}],"type":["object","null"]},"rawOutput":{"description":"The raw output of the test.","type":"string"}},"type":"object"}],"title":"GATEWAY IPERF RESULT"},"Ipv4Addressgw__3b77411f6985":{"description":"IP address of the VLAN.\n","example":"172.51.100.42","format":"ipv4","maxLength":15,"type":"string"},"Ipv4MaskAddr__c99febaf4556":{"description":"The masked IP address of the VLAN.\n","example":"255.255.255.0","format":"ipv4","maxLength":15,"type":"string"},"Ipv4Subnet__c99febaf4556":{"description":"IP address of the VLAN's subnet.\n","example":"33.33.33.1/24","format":"ipv4","maxLength":15,"type":"string"},"Ipv6Addressgw__de89a47d9bd8":{"description":"IPv6 address of the gateway.\n","example":"2001:0db8:85a3:0000:0000:8a2e:0370:7334","format":"ipv6","maxLength":39,"type":"string"},"Ipv6Prefix__c99febaf4556":{"description":"The prefix of the IPv6 address.\n","example":"null","type":"string"},"IsProvisioned__cd77b09562fb":{"description":"Indicates the provisioning state of the device. This property specifies whether the device has been successfully provisioned and is ready for use. For example, a value of `YES` indicates that the device has been provisioned, while a value of `NO` indicates that the device has not been provisioned.","example":"YES","format":"const","maxLength":16,"type":"string"},"IsolatedNodes__beb9b17f8005":{"properties":{"id":{"$ref":"#/components/schemas/Idtopology__004689200476"},"isolatedDevices":{"description":"List of isolated devices associated with the site","items":{"properties":{"conductorSerial":{"description":"Serial number of the conductor associated with this device.","example":"CNM8K9W55J","type":"string"},"deployment":{"description":"Deployment mode of the device","example":"Standalone","type":"string"},"deviceFunction":{"description":"Device function of the device","example":"Access Point","type":"string"},"health":{"description":"Health status of the device","example":"Good","type":"string"},"healthReason":{"description":"Reason for the current health status, if applicable.","example":"PORT_FLAPS_POOR","type":"string"},"ipv4":{"description":"IPv4 address of the device","example":"10.97.64.117","type":"string"},"lastSeen":{"description":"Timestamp (epoch) of when the device was last seen.","example":1698796432000,"format":"float","type":"number"},"mac":{"description":"MAC address of the isolated device","example":"88:3A:30:94:C3:40","type":"string"},"model":{"description":"Model of the device","example":"AP-515","type":"string"},"name":{"description":"Name of the isolated device","example":"AP-01","type":"string"},"neighbour":{"description":"Serial number of the neighbour device if applicable","example":"SG99KN3001","type":"string"},"serial":{"description":"Serial number of the isolated device","example":"SG99KN3030","type":"string"},"status":{"description":"Current operational status of the device.","example":"Online","type":"string"},"type":{"description":"Type of the device","example":"Access Point","type":"string"}},"type":"object"},"type":"array"},"type":{"description":"Type of topology or device group","example":"IsolatedNodes","type":"string"}},"required":["id","type"],"type":"object"},"KPIWidgetInput__c34075768619":{"properties":{"columns":{"items":{"description":"Specifies the column required","type":"string"},"type":"array"},"kpiWidget":{"description":"Specifies the KPI Widget","type":"string"},"renderType":{"description":"Specifies the render type. Valid values can be got dynamically via GET /network-reporting/v1/reports-meta.","type":"string"}},"type":"object"},"KPIWidget__66b457073e9b":{"properties":{"allowedRenderTypes":{"examples":["TABLE","DONUT_CHART"],"items":{"description":"Specifies the allowed render type. Valid values can be got dynamically via GET /network-reporting/v1/reports-meta.","type":"string"},"type":"array"},"columns":{"items":{"$ref":"#/components/schemas/Columns__66b457073e9b"},"type":"array"},"description":{"examples":["Vendor Summary"],"type":"string"},"displayName":{"examples":["Vendor Summary"],"type":"string"},"filters":{"items":{"$ref":"#/components/schemas/FilterMeta__66b457073e9b"},"type":"array"},"isTimeSliceEnabled":{"examples":[true],"type":"boolean"},"kpi":{"examples":["vendorSummary"],"type":"string"},"kpiDescription":{"examples":["Vendor Summary"],"type":"string"},"kpiDisplayName":{"examples":["Vendor Summary"],"type":"string"},"kpiWidget":{"examples":["VendorSummary"],"type":"string"},"reportCategory":{"examples":["infrastructure"],"type":"string"},"reportName":{"examples":["Inventory"],"type":"string"},"reportType":{"examples":["inventory"],"type":"string"}},"required":["kpiWidget","allowedRenderTypes"],"type":"object"},"KeyManagement__284f33982989":{"description":"Security mode used by the client.","example":"WPA2_PSK","type":"string"},"KeyValuePair__1335a419f403":{"description":"Key-value pair for additional event attributes.","properties":{"label":{"description":"Label or key for the attribute.","example":"New EIRP","type":"string"},"value":{"description":"Value of the attribute.","example":"90 dBm","type":"string"}},"required":["label","value"],"type":"object"},"LCIUncertainty__6a214df6704a":{"description":"Uncertainty ellipse centered on the latitude and longitude of the \"center\" field of the parent object.\n\nThe axes of this ellipse are parallel to north-south and east-west directions.\n","properties":{"confidenceLevel":{"description":"Represents the probability that the location of the device lies within the area of the ellipse.\n\nThe value 0 is reserved to indicate that the confidence level is unknown.\n","examples":[0],"maximum":100,"minimum":0,"type":["number"]},"latitudeUncertainty":{"description":"The latitude uncertainty in degrees.\n\nThe latitudeUncertainty is added to the latitude value in the center field of the associated Location to determine the maximum value in the uncertainty range; similarly, the uncertainty is subtracted from the base value to determine the minimum value.\n\nIf the maximum or minimum latitude values derived from applying uncertainty are outside the range of -90 to +90 then these values are trimmed to within this range.\n\nThe value 0 is reserved to indicate that the latitude uncertainty is unknown.\n","examples":[0],"maximum":90,"minimum":-90,"type":["number"]},"longitudeUncertainty":{"description":"The longitude uncertainty in degrees.\n\nThe longitudeUncertainty is added to the base longitude value in the center field of the associated Location to determine the maximum value in the uncertainty range; similarly, the uncertainty is subtracted from the base value to determine the minimum value.\n\nIf the maximum or minimum longitude values derived from applying uncertainty are outside the range of -180 to +180 then these values are normalized to this range by adding or subtracting 360 as necessary.\n\nThe value 0 is reserved to indicate that the longitude uncertainty is unknown.\n","examples":[0],"maximum":180,"minimum":-180,"type":["number"]}},"required":["longitudeUncertainty","latitudeUncertainty"],"type":"object"},"LaSitesInsightsForAPI__f20300aab7a0":{"description":"An object containing the insights for a particular site.","properties":{"id":{"description":"Site ID.","example":"1514288277","format":"const","type":"string"},"newVisitorCount":{"description":"The number of new visitors for the site in the given time range.","example":15,"format":"int64","type":"integer"},"passerbyCount":{"description":"The number of passerby for the site in the given time range.","example":60,"format":"int64","type":"integer"},"recurringVisitorCount":{"description":"The number of recurring visitors for the site in the given time range.","example":25,"format":"int64","type":"integer"},"siteId":{"description":"Site ID.","example":"1514288277","format":"const","type":"string"},"siteName":{"description":"Name of the site.","example":"test-la-site-1","format":"const","type":"string"},"totalVisitorCount":{"description":"The number of total visitors for the site in the given time range.","example":40,"format":"int64","type":"integer"},"type":{"description":"Type of the analytics.","example":"/networking-services/location-analytics/sites/insights","format":"const","type":"string"},"visitDuration":{"description":"The average visit duration (in minutes) for the site in the given time range.","example":300,"format":"int64","type":"integer"}},"required":["id","type"],"type":"object"},"LaSitesInsightsResponseForAPI__f20300aab7a0":{"description":"Location Analytics Insights Response that contains the insights for each Site.","example":{"count":2,"items":[{"id":"125424","newVisitorCount":15,"passerbyCount":60,"recurringVisitorCount":25,"siteId":"125424","siteName":"test-la-site-1","totalVisitorCount":40,"type":"/networking-services/location-analytics/sites/insights","visitDuration":120},{"id":"783260","newVisitorCount":15,"passerbyCount":60,"recurringVisitorCount":25,"siteId":"783260","siteName":"test-la-site-2","totalVisitorCount":40,"type":"/networking-services/location-analytics/sites/insights","visitDuration":120}],"offset":0,"total":2},"properties":{"count":{"description":"The number of objects returned in the current response.","example":100,"format":"int32","type":"integer"},"items":{"items":{"$ref":"#/components/schemas/LaSitesInsightsForAPI__f20300aab7a0"},"type":"array"},"offset":{"description":"Specifies the offset of the returned page.","example":0,"format":"int32","type":"integer"},"total":{"description":"The total number of objects contained in the database.","example":200,"format":"int64","type":"integer"}},"type":"object"},"LaTrendsResponseForAPI__0052b7c55291":{"description":"Location Analytics Trends Response that contains the trends for Visitors and Passerby.","example":{"id":"1e2e0d38371f11ee82539ae66a6c36a2","keys":["newVisitors","recurringVisitors","totalVisitors","passerby","visitDuration"],"samples":[{"data":[30,20,50,70,200],"timestamp":"1683284400000"},{"data":[12,45,57,90,500],"timestamp":"1683284400000"}],"type":"/networking-services/location-analytics/trends","units":["count","count","count","count","minutes"]},"properties":{"id":{"description":"Tenant ID or site ID.","example":"1e2e0d38371f11ee82539ae66a6c36a2","format":"const","type":"string"},"keys":{"description":"List of the trends.","example":["newVisitors","recurringVisitors","totalVisitors","passerby","visitDuration"],"items":{"format":"const","type":"string"},"type":"array"},"samples":{"items":{"$ref":"#/components/schemas/Samples__0052b7c55291"},"type":"array"},"type":{"description":"Type of the analytics.","example":"/networking-services/location-analytics/trends","format":"const","type":"string"},"units":{"description":"Units for the corresponding keys.","example":["count","count","count","count","minutes"],"items":{"format":"const","type":"string"},"type":"array"}},"required":["id","type"],"type":"object"},"LastConnectClientMacAddress__3f58b16772b5":{"description":"MAC address for the client\n","example":"11:22:33:44:55:66","format":"mac","maxLength":17,"minLength":17,"type":"string"},"LastConnected__2ca376caec3f":{"description":"The last time the tunnel was connected.\n","example":1234567890,"format":"float","type":"number"},"LastDetDeviceName__d67ae4720000":{"description":"Name of AP that last detected the monitored AP","examples":["Building-A-Floor-2-AP-001"],"type":"string"},"LastDetDeviceSerial__d67ae4720000":{"description":"Serial of AP that last detected the monitored AP","examples":["QWR124780123"],"maxLength":20,"type":"string"},"LastDownReason__2ca376caec3f":{"description":"The reason for the last time the tunnel was down.\n","enum":["SA expired","Tunnel not established","Uplink load balance configuration changed","Tunnel configuration removed by Administrator","DPD failure","Delete initiated by peer","Administrator cleared IPSEC SA","New tunnel to the same peer has been created","Unable to find IKE SA for IPSEC SA"],"example":"SA expired","type":"string"},"LastModifiedAt__7d827151e05e":{"deprecated":true,"description":"Specifies the report modified timestamp in UTC+0 timezone (RFC 3339 format).","examples":["2019-10-12T07:20:50Z"],"format":"date-time","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z$","type":"string"},"LastModifiedBy__7d827151e05e":{"deprecated":true,"description":"The user who modified the report / report schedule.","examples":["user1@mail.com"],"type":"string"},"LastRebootReason__da78704f9a76":{"description":"Last reboot reason description:\n* UNKNOWN:  'Unknown'\n* AP_RELOAD: 'Reload'\n* USER_REBOOT: 'User reboot'\n* WRITE_ERASE_REBOOT: 'Write erase reboot'\n* WRITE_ERASE_ALL_REBOOT: 'Write erase all reboot'\n* IMAGE_SYNC_FAILED: 'Image sync failed'\n* IMAGE_SYNC_SUCCESSFUL: 'Image sync successful'\n* IMAGE_UPGRADE: 'Image upgrade successful'\n* IMAGE_DOWNLOAD_FAILURE: 'Image download failure'\n* OUT_OF_MEMORY: 'Reboot caused by out of memory'\n* DOWN_UPLINK: 'Current uplink down, no useable uplink.'\n* CONDUCTOR_TO_LOCAL: 'Conductor transitioned to local'\n* NETWORK_DISCONNECT_USB_RESET: 'Internet connection lost, reset usb modem'\n* NETWORK_DISCONNECT: 'Internet connection lost'\n* UNREACHABLE_GATEWAY: 'Gateway unreachable'\n* FATAL_EXCEPTION: 'Reboot caused by kernel panic: fatal exception'\n* FATAL_EXCEPTION_IN_INTERRUPT: 'Reboot caused by kernel panic: fatal exception in interrupt'\n* SOFTLOCKUP: 'Reboot caused by kernel panic: softlockup: hung tasks'\n* NTP_SYNC: 'System clock is too far ahead of ntp sync result'\n* BAD_MESH_LINK: 'Mesh link bad. Rebooting mesh point by sapd'\n* MESH_TO_PORTAL: 'Mesh point transitioned to portal'\n* REBOOT_BY_AIRWAVE: 'Reboot by Airwave'\n* AMP_COMMAND: 'Amp'\n* VC_COMMAND: 'VC'\n* REBOOTED_BY_CENTRAL: 'Reboot by Central'\n* CLOUD_MANAGEMENT_COMMAND: 'Cloud management'\n* CLI_COMMAND: 'CLI'\n* CONDUCTOR_IP_FAILURE: 'Failed to get conductor-ip'\n* NON_FIPS: 'Non-fips --> fips'\n* FIPS: 'Fips --> non-fips'\n* TOPOLOGY_CHANGE: 'Rebooting AP due to topology change: hierarchy to flat'\n* AP_DISCONNECTED: 'AP disconnected from Aruba Central'\n* VC_DISCONNECTED: 'Virtual controller disconnected from Aruba Central'\n* COLD_HW_RESET: 'AP reboot caused by cold hw reset(power loss)'\n* POWER_LOSS: 'AP rebooted due to loss power'\n* THERMAL_MODE: 'Reboot due to trigger the cooldown event'\n* OVERHEAT_EVENT: 'Reboot due to trigger the overheat event'\n* PREEMPTED_BY_CONDUCTOR: 'Preempted by provisioned conductor'\n","example":"AP_RELOAD","format":"const","maxLength":256,"type":"string"},"LastRunStatus__7d827151e05e":{"description":"Specifies the run status as New, Active, Paused, Stopped, Completed, or Error","enum":["NEW","ACTIVE","PAUSED","STOPPED","COMPLETED","ERROR"],"examples":["COMPLETED"],"type":"string"},"LastRunTs__7d827151e05e":{"description":"Specifies the timestamp of the last report run in UTC+0 timezone (RFC 3339 format).","examples":["2019-10-12T07:20:50Z"],"format":"date-time","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z$","type":"string"},"LastSeenAt__6b9c5f08b869":{"description":"An RFC 3339 date-time indicating the last detected time of the device in the system. If the device is online, this value will be null.","example":"2024-03-12T07:20:50.52Z","format":"date-time","maxLength":128,"type":"string"},"LastSeenAtap__98bb0f033247":{"description":"An RFC 3339 date-time indicating the last detected time of the access point in the system. If the access point is online, this value will be null.\n","example":"2024-03-12T07:20:50.52Z","format":"date-time","maxLength":128,"type":"string"},"LastSeenAtclients__284f33982989":{"description":"The date and time when the client was last detected in the system. If the client is online, this value will be 0.","example":0,"format":"date-time","type":"string"},"LastSeenAtgw__de89a47d9bd8":{"description":"An RFC 3339 date-time indicating the last detected time of the gateway in the system. If the gateway is online, this value will be null.\n","example":"2024-03-12T07:20:50.52Z","format":"date-time","maxLength":128,"type":"string"},"LastSeen__a39bf531822f":{"description":"The last-seen date/time of the Asset Tag.","example":"2023-10-01T12:00:00Z","format":"date-time","maxLength":20,"type":"string"},"LastSeenwids__d67ae4720000":{"description":"The last seen time of the Monitored AP. RFC 3339 (and ISO 8601) in UTC+0 timezone.","examples":["2023-10-01T12:00:00.000Z"],"format":"date-time","maxLength":24,"type":"string"},"LastUpgradedTimeAt__c0c1228d8f7d":{"description":"The timestamp of the last firmware upgrade on the device.\n","example":"2023-10-10T10:10:10Z","format":"date-time","maxLength":32,"type":"string"},"LatestLocationPerClient__3f58b16772b5":{"description":"The number of latest locations per client.\n","example":1,"format":"int32","maximum":1,"minimum":1,"type":"integer"},"Latitude__6a214df6704a":{"description":"Latitude of the device location in decimal degrees with 6 decimal places of precision.\n\nThe allowed range is from -90 to +90. Positive values represent latitudes north of the equator; negative values south of the equator.\n\nThe value shall be relative to the WGS 84 datum.\n","examples":[45.687416],"maximum":90,"minimum":-90,"type":["number"]},"Latitudeasset__a39bf531822f":{"description":"Latitude of the Asset Tag location in decimal degrees with 6 decimal places of precision.\n\nThe allowed range is from -90 to +90. Positive values represent latitudes north of the equator; negative values south of the equator.\n\nThe value shall be relative to the WGS 84 datum.\n","example":45.687416,"maximum":90,"minimum":-90,"type":"number"},"Latitudewifi__3f58b16772b5":{"description":"Latitude of the client location in decimal degrees with 6 decimal places of precision.\n\nThe allowed range is from -90 to +90. Positive values represent latitudes north of the equator; negative values south of the equator.\n\nThe value shall be relative to the WGS 84 datum.\n","example":45.687416,"maximum":90,"minimum":-90,"type":"number"},"LeaseDurationInSecs__36b9a7c1ff51":{"description":"Duration of the DHCP lease in seconds.","example":86400,"format":"int64","minimum":0,"type":"integer"},"LimitParam__306cd00aed2d":{"default":1000,"description":"Specifies the number of results to be returned.\n","examples":[100],"format":"int32","maximum":1000,"minimum":1,"type":"integer"},"LimitParam__4d16a4598b40":{"default":20,"description":"Specifies the number of results to be returned. (Default: 20)","example":10,"format":"int32","maximum":20,"minimum":1,"type":"integer"},"LimitParam__4ee94b04d313":{"default":100,"description":"Specifies the number of results to be returned. (Default: 100)\n","example":100,"format":"int32","maximum":2147483647,"minimum":1,"type":"integer"},"LimitParamswitch__244c7d3b837e":{"default":1000,"examples":[100],"format":"int32","maximum":1000,"minimum":0,"type":"integer"},"Limit__4689c9697989":{"default":1000,"description":"The maximum number of items to return per page.\n","format":"int32","maximum":1000,"minimum":0,"type":"integer"},"Limit__6ff1f6639f14":{"default":10,"example":10,"format":"int32","maximum":100,"type":"integer"},"Limit__f20300aab7a0":{"default":20,"example":20,"format":"int32","type":"integer"},"Limitasset__acdf4895bcad":{"default":100,"description":"Specifies the number of results to be returned. (Default: 100)\n","example":20,"format":"int32","maximum":1000,"minimum":0,"type":"integer"},"Limitdevice__cd77b09562fb":{"default":20,"description":"Specifies the number of results to be returned","example":20,"format":"int32","maximum":1000,"type":"integer"},"Limitdeviceloc__6a214df6704a":{"default":100,"description":"Denotes the maximum number of devices returned in the response. (Default: 100)\n","examples":[100],"format":"int32","maximum":1000,"minimum":0,"type":"integer"},"Limitfco__09b903e67f2b":{"default":100,"description":"The maximum number of items to return.","format":"int32","maximum":1000,"minimum":0,"type":"integer"},"Limitfirmware__c0c1228d8f7d":{"default":20,"description":"Specifies the number of results to be returned.\n","example":20,"format":"int32","maximum":1000,"type":"integer"},"Limitsite__7f65987649fe":{"default":100,"description":"Specifies the number of sites to be returned per request. Maximum limit per request is 1000.","example":10,"format":"int32","maximum":1000,"type":"integer"},"Limitwids__000172564380":{"default":100,"description":"Specifies the number of results to be returned. (Default: 100)\n","examples":[20],"format":"int32","maximum":1000,"minimum":0,"type":"integer"},"LinkTag__9683aa3d9df6":{"example":"Airtel","maxLength":256,"type":"string"},"Links__b8d35392fbec":{"properties":{"edgeType":{"description":"Type of link between the devices","example":"ETHERNET","type":"string"},"from":{"description":"Source device serial or identifier","example":"SG99KN3020","type":"string"},"fromPortList":{"description":"List of ports on the source device involved in this edge","items":{"$ref":"#/components/schemas/TopologyPort__b8d35392fbec"},"type":"array"},"health":{"description":"Health status of the edge","example":"Good","type":"string"},"healthReason":{"description":"Reason for edge health status","example":null,"type":"string"},"isSibling":{"description":"Indicates if the edge connects sibling devices","example":false,"type":"boolean"},"speed":{"description":"Speed of the connection in Gbps","example":10,"format":"float","type":"number"},"stpState":{"description":"STP (Spanning Tree Protocol) state of the edge","example":"FORWARDING","type":"string"},"to":{"description":"Destination device serial or identifier","example":"SG99KN4020","type":"string"},"toPortList":{"description":"List of ports on the destination device involved in this edge","items":{"$ref":"#/components/schemas/TopologyPort__b8d35392fbec"},"type":"array"}},"type":"object"},"ListApRangingScanStatus__306cd00aed2d":{"description":"A list of ftm scan details.","properties":{"count":{"description":"The number of objects returned in the current list (maximum will be the page size).\n","examples":[1],"format":"uint32","maximum":2147483647,"minimum":1,"type":"integer"},"items":{"items":{"$ref":"#/components/schemas/ApRangingScanStatus__306cd00aed2d"},"maxItems":2147483647,"type":"array"},"next":{"description":"An opaque cursor which could be passed in the next query to fetch the next page.\nSet to null when no more pages remain.\n","examples":[null],"format":"const","maxLength":128,"type":"string"},"total":{"description":"The total number of objects contained in the datastore.\n","examples":[1],"format":"uint64","maximum":9223372036854776000,"minimum":0,"type":"integer"}},"required":["items","count","total"],"type":"object"},"ListClientLocationsForAPI__3f58b16772b5":{"allOf":[{"properties":{"items":{"items":{"$ref":"#/components/schemas/ClientLocation__3f58b16772b5"},"maxItems":2147483647,"type":"array"}},"required":["items"],"type":"object"},{"$ref":"#/components/schemas/PaginationResponseProperties__3f58b16772b5"}]},"ListClients__b58ef4da0e1a":{"examples":[],"properties":{"count":{"description":"The number of clients after filtering","examples":[1,10,100],"type":"integer"},"items":{"description":"A list of network clients","items":{"$ref":"#/components/schemas/Client__b58ef4da0e1a"},"type":"array"},"next":{"description":"Specifies the pagination cursor for the next page of resources. null if there are no further pages.","examples":[null,"1","2","3"],"type":"string"},"total":{"description":"Total number of clients","examples":[1,10,100],"type":"integer"}},"required":["items","count"],"type":"object"},"ListDeviceLocationSummary__6a214df6704a":{"description":"List of devices with their consolidated location.","properties":{"count":{"description":"The number of objects returned in the current list (maximum will be the page size).\n","examples":[1],"format":"int32","maximum":2147483647,"minimum":1,"type":"integer"},"items":{"items":{"$ref":"#/components/schemas/DeviceLocationSummary__6a214df6704a"},"maxItems":2147483647,"type":"array"},"next":{"description":"An opaque cursor which could be passed in the next query to fetch the next page.\nSet to null when no more pages remain.\n","examples":[null],"format":"const","maxLength":128,"type":"string"},"total":{"description":"The total number of objects contained in the datastore.\n","examples":[1],"format":"int64","maximum":9223372036854776000,"minimum":0,"type":"integer"}},"required":["items","count","total"],"type":"object"},"ListReportRuns__c419fe321fd2":{"description":"List of report runs response.","properties":{"count":{"description":"The number of report runs","examples":[1,10,100],"type":"integer"},"items":{"description":"List of report run objects.","items":{"$ref":"#/components/schemas/ReportRun__c419fe321fd2"},"type":"array"},"next":{"description":"Specifies the pagination cursor for the next page of resources. null if there are no further pages.","examples":["1","2","3"],"type":"string"},"report":{"$ref":"#/components/schemas/Report__7d827151e05e"},"total":{"description":"The total number of report runs.","examples":[1,10,100],"type":"integer"}},"required":["items","count","next"],"type":"object"},"ListReports__7d827151e05e":{"description":"List of reports response.","examples":[],"properties":{"count":{"description":"The number of reports after filtering.","examples":[1,10,100],"type":"integer"},"items":{"description":"List of report objects.","items":{"$ref":"#/components/schemas/Report__7d827151e05e"},"type":"array"},"next":{"description":"Specifies the pagination cursor for the next page of resources. null if there are no further pages.","examples":["1","2","3"],"type":"string"},"total":{"description":"The total number of reports.","examples":[1,10,100],"type":"integer"}},"required":["items","count","next"],"type":"object"},"ListTenantsResponse__6ff1f6639f14":{"description":"List of all the tenants for an MSP. It includes details like tenant name, tenant CID, sites count, devices count with health status, alerts count, etc.","example":{"count":10,"items":[{"alerts":{"critical":8,"major":10,"minor":40,"total":58},"createdTime":1633036806,"degradedSites":1,"deviceHealthStatus":{"fair":15,"good":130,"poor":5,"total":150},"deviceOwnership":"MSP","lastUpdatedTime":1732320000,"tenantId":"fa451230e38a11ef8a28061d9656","tenantName":"Tenant A","totalSites":12}],"next":"2","total":100},"properties":{"count":{"description":"The number of objects returned in the current response.","example":10,"format":"int32","type":"integer"},"items":{"items":{"$ref":"#/components/schemas/MSPTenant__6ff1f6639f14"},"type":"array"},"next":{"description":"Specifies the pagination cursor for the next page of resources.","example":"2","format":"const","type":"string"},"total":{"description":"The total number of objects contained in the database.","example":200,"format":"int64","type":"integer"}},"type":"object"},"LocationDeleteResponse__8bd44b0ed12d":{"description":"Service response to a DELETE of a device location.\n","properties":{"data":{"properties":{"deleteDeviceAdminLocation":{"properties":{"result":{"description":"The descriptive text on the outcome of the operation.\n","examples":["Device location deletion accepted."],"format":"const","maxLength":512,"type":["string"]}},"type":"object"}},"type":"object"}},"type":"object"},"LocationHeader__a3b548d8bd3f":{"description":"URI to query modified Asset Tag metadata.\n","example":"network-services/v1/asset-tags/e5b61232-83c8-401a-8e14-a4c75b4fb745","format":"const","maxLength":512,"type":"string"},"LocationId__6a214df6704a":{"description":"Uniquely generated ID for a device location.\n","examples":["5064db8d-599b-480e-84c7-32980144d91a"],"format":"const","maxLength":128,"type":"string"},"LocationLevelType__a39bf531822f":{"description":"Location resource type.\n","example":"/network-services/v1/asset-tags/location","format":"const","maxLength":40,"type":"string"},"LocationUpdateResponse__df5276e7183b":{"description":"Service response to a POST of a device location.\n","properties":{"data":{"properties":{"setDeviceAdminLocation":{"properties":{"result":{"description":"The descriptive text on the outcome of the operation.\n","examples":["Device location modification accepted."],"format":"const","maxLength":512,"type":["string"]},"serialNumber":{"$ref":"#/components/schemas/DeviceSerial__6a214df6704a"},"siteId":{"$ref":"#/components/schemas/SiteIddeviceloc__6a214df6704a"}},"type":"object"}},"type":"object"}},"type":"object"},"Location__6a214df6704a":{"description":"Longitude, latitude, altitude and floor position.\n\nThe system can return location uncertainty in two formats.\n\nThe **LCIUncertainty** field is a similar ellipse but with a fixed orientation such that its axes are parallel to the north-south and east-west geographic directions.\n\nThe system will return both uncertainty representations if they are available.  Note that for a given data set the uncertaintyEllipse will always describe an area equal to or smaller than the LCIUncertainty.\n","properties":{"altitude":{"$ref":"#/components/schemas/Altitude__6a214df6704a"},"cartesianCoordinates":{"$ref":"#/components/schemas/CartesianCoordinates__6a214df6704a"},"center":{"$ref":"#/components/schemas/Center__6a214df6704a"},"lciUncertainty":{"$ref":"#/components/schemas/LCIUncertainty__6a214df6704a"},"source":{"description":"Source of the device coordinates.\n* 'ADMIN_SPECIFIED' - The device location was administratively entered.\n* 'SYSTEM_GENERATED' - The location automatically determined by the system.\n","enum":["ADMIN_SPECIFIED","SYSTEM_GENERATED"],"examples":["SYSTEM_GENERATED"],"type":["string"]},"timestamp":{"$ref":"#/components/schemas/Timestamp__306cd00aed2d"}},"required":["source","timestamp","center"],"type":"object"},"LogMessage__4774edd10512":{"description":"A log message entry.\n","properties":{"message":{"description":"The log message content.\n","example":"Alert cleared successfully","type":"string"},"timestamp":{"description":"Timestamp when the log message was recorded.\n","example":"2026-02-23T10:30:30Z","format":"date-time","type":"string"}},"type":"object"},"Longitude__6a214df6704a":{"description":"Longitude of the device location in decimal degrees with 6 decimal places of precision.\n\nThe allowed range is from -180 to +180. Positive values represent longitudes east of the prime meridian; negative values west of the prime meridian.\n\nThe value shall be relative to the WGS 84 datum.\n","examples":[-73.622016],"maximum":180,"minimum":-180,"type":["number"]},"Longitudeasset__a39bf531822f":{"description":"Longitude of the Asset Tag location in decimal degrees with 6 decimal places of precision.\n\nThe allowed range is from -180 to +180. Positive values represent longitudes east of the prime meridian; negative values west of the prime meridian.\n\nThe value shall be relative to the WGS 84 datum.\n","example":-73.622016,"maximum":180,"minimum":-180,"type":"number"},"Longitudewifi__3f58b16772b5":{"description":"Longitude of the client location in decimal degrees with 6 decimal places of precision.\n\nThe allowed range is from -180 to +180. Positive values represent longitudes east of the prime meridian; negative values west of the prime meridian.\n\nThe value shall be relative to the WGS 84 datum.\n","example":-73.622016,"maximum":180,"minimum":-180,"type":"number"},"MSPTenant__6ff1f6639f14":{"description":"An object containing details of a tenant under MSP.","properties":{"alerts":{"description":"An object containing alerts count from all sites of a tenant.","properties":{"critical":{"description":"The total number of critical alerts.","example":8,"format":"int32","type":"integer"},"major":{"description":"The total number of major alerts.","example":10,"format":"int32","type":"integer"},"minor":{"description":"The total number of minor alerts.","example":40,"format":"int32","type":"integer"},"total":{"description":"The total number of alerts.","example":58,"format":"int32","type":"integer"}},"type":"object"},"createdTime":{"description":"Timestamp in seconds indicating creation time of a tenant.","example":1633036806,"format":"int64","type":"integer"},"degradedSites":{"description":"The total number of sites belonging to the tenant where at least one device health is poor.","example":3,"format":"int32","type":"integer"},"deviceHealthStatus":{"description":"An object containing health status of all device types.","properties":{"fair":{"description":"The total number of devices with health status fair.","example":15,"format":"int32","type":"integer"},"good":{"description":"The total number of devices with health status good.","example":130,"format":"int32","type":"integer"},"poor":{"description":"The total number of devices with health status poor.","example":5,"format":"int32","type":"integer"},"total":{"description":"The total number of devices.","example":150,"format":"int32","type":"integer"}},"type":"object"},"deviceOwnership":{"description":"Indicates devices ownership by MSP or tenant","enum":["MSP","TENANT"],"example":"MSP","format":"const","maxLength":128,"type":"string"},"lastUpdatedTime":{"description":"Timestamp in seconds indicating last update of a tenant details.","example":1732320000,"format":"int64","type":"integer"},"tenantId":{"description":"Application CID of the tenant.","example":"fa451230e38a11ef8a28061d9656","format":"const","type":"string"},"tenantName":{"description":"Name of the tenant.","example":"Tenant A","format":"const","type":"string"},"totalSites":{"description":"The total number of sites belonging to the tenant.","example":8,"format":"int32","type":"integer"}},"type":"object"},"MacAddress__3f58b16772b5":{"description":"MAC address for the client.\n","example":"11:22:33:44:55:66","format":"mac","maxLength":17,"minLength":17,"type":["string","null"]},"MacAddress__6b9c5f08b869":{"description":"The device MAC address.","example":"11:22:33:44:55:66","format":"const","maxLength":18,"type":"string"},"MacAddressap__54309c5cca60":{"description":"The access point MAC address.\n","example":"11:22:33:44:55:66","format":"const","maxLength":18,"type":"string"},"MacAddressasset__a39bf531822f":{"description":"MAC address of the Asset Tag.","example":"11:22:33:44:55:66","format":"mac","maxLength":17,"minLength":17,"type":["string"]},"MacAddressclients__284f33982989":{"description":"Specifies the MAC address of the client.","example":"05:50:35:a1:a0:01","type":"string"},"MacAddressgw__3b77411f6985":{"description":"The gateway MAC address.\n","example":"11:22:33:44:55:66","maxLength":18,"type":"string"},"MacVendor__d67ae4720000":{"description":"Mac Vendor of monitored AP","examples":["ProCurve Networking by HP"],"maxLength":128,"type":"string"},"Mac__004689200476":{"description":"The device mac address.","example":"a1:b2:c3:d4:e5:f6","format":"const","maxLength":17,"type":"string"},"MalwareFamily__7006262f8c4c":{"description":"The family that the malware belongs to.\n","examples":["Android_SmsThief"],"maxLength":128,"type":"string"},"MeshRole__98bb0f033247":{"description":"Mesh role of the access point when mesh is configured.\n","example":"PORTAL","maxLength":32,"type":"string"},"MessageFormat__715550e8d02e":{"description":"The message payload format used for webhook delivery.","enum":["JSON","SLACK"],"type":"string"},"Messagewebhooks__c1c7772865ac":{"description":"A message providing additional information about the operation.","type":"string"},"MetadataLevelType__a39bf531822f":{"description":"Metadata resource type.\n","example":"/network-services/v1/asset-tags/metadata","format":"const","maxLength":40,"type":"string"},"MitreTags__f8f342aecdae":{"description":"The MITRE tags associated with the threat.\n","properties":{"mitreTacticName":{"description":"Mitre Tactic Name\n","examples":["Initial_Access"],"maxLength":256,"type":"string"},"mitreTechniqueName":{"description":"Mitre Technique Name\n","examples":["Exploit_Public_Facing_Application"],"maxLength":256,"type":"string"}},"required":["mitreTacticName","mitreTechniqueName"],"type":"object"},"MloOperMode__284f33982989":{"description":"Specifies the Multi-Link Operation (MLO) mode used by the client for Wi-Fi 7 connectivity.","example":"MLO Disabled","type":"string"},"MobilityDetails__972dd6d46bea":{"properties":{"destinationAp":{"$ref":"#/components/schemas/DestinationAp__972dd6d46bea"},"fromBssid":{"$ref":"#/components/schemas/fromBssid__972dd6d46bea"},"fromChannel":{"$ref":"#/components/schemas/FromChannel__972dd6d46bea"},"id":{"$ref":"#/components/schemas/IDclients__284f33982989"},"occurredAt":{"$ref":"#/components/schemas/OccurredAt__972dd6d46bea"},"radioBand":{"$ref":"#/components/schemas/RadioBand__972dd6d46bea"},"roamProtocol":{"$ref":"#/components/schemas/RoamProtocol__972dd6d46bea"},"roamTime":{"$ref":"#/components/schemas/RoamTime__972dd6d46bea"},"rssi":{"$ref":"#/components/schemas/rssi__972dd6d46bea"},"sourceAp":{"$ref":"#/components/schemas/SourceAp__972dd6d46bea"},"toBssid":{"$ref":"#/components/schemas/toBssid__972dd6d46bea"},"toChannel":{"$ref":"#/components/schemas/ToChannel__972dd6d46bea"},"type":{"$ref":"#/components/schemas/Typeclients__284f33982989"},"wlanName":{"$ref":"#/components/schemas/WlanNameclients__284f33982989"}},"required":["type","id"],"type":"object"},"Mode__34350f7e707e":{"description":"Describes the operational mode of the radio.\n","example":"Client Access","maxLength":32,"type":"string"},"Modegw__2ca376caec3f":{"description":"The mode of the tunnel.\n","enum":["Orchestrated","Orchestrated-IKE","Orchestrated-Survivability","IKE"],"example":"active","maxLength":10,"type":"string"},"Model__6b9c5f08b869":{"description":"Hardware model of the device.","example":"AP-275","format":"const","maxLength":32,"type":"string"},"Modelap__98bb0f033247":{"description":"Hardware model of the access point.\n","example":"AP-275","format":"const","maxLength":32,"type":"string"},"Modelgw__3b77411f6985":{"description":"The gateway model.\n","example":"Aruba-9004","maxLength":256,"type":"string"},"MonitoredApData__d67ae4720000":{"description":"Object with Monitored AP details\n","properties":{"bssid":{"$ref":"#/components/schemas/Bssid__d67ae4720000"},"classification":{"$ref":"#/components/schemas/Classification__d67ae4720000"},"classificationMethod":{"$ref":"#/components/schemas/ClassificationMethod__d67ae4720000"},"classificationRule":{"$ref":"#/components/schemas/ClassificationRule__d67ae4720000"},"containmentStatus":{"$ref":"#/components/schemas/ContainmentStatus__d67ae4720000"},"createdAt":{"$ref":"#/components/schemas/CreatedAtwids__000172564380"},"encryption":{"$ref":"#/components/schemas/Encryption__d67ae4720000"},"firstDetDeviceName":{"$ref":"#/components/schemas/FirstDetDeviceName__d67ae4720000"},"firstDetDeviceSerial":{"$ref":"#/components/schemas/FirstDetDeviceSerial__d67ae4720000"},"firstSeen":{"$ref":"#/components/schemas/FirstSeenwids__d67ae4720000"},"id":{"$ref":"#/components/schemas/Idwids__000172564380"},"lastDetDeviceName":{"$ref":"#/components/schemas/LastDetDeviceName__d67ae4720000"},"lastDetDeviceSerial":{"$ref":"#/components/schemas/LastDetDeviceSerial__d67ae4720000"},"lastSeen":{"$ref":"#/components/schemas/LastSeenwids__d67ae4720000"},"macVendor":{"$ref":"#/components/schemas/MacVendor__d67ae4720000"},"name":{"$ref":"#/components/schemas/Namewids__d67ae4720000"},"portData":{"$ref":"#/components/schemas/PortData__d67ae4720000"},"signal":{"$ref":"#/components/schemas/Signal__d67ae4720000"},"siteId":{"$ref":"#/components/schemas/SiteIdwids__000172564380"},"siteName":{"$ref":"#/components/schemas/SiteNamewids__000172564380"},"ssid":{"$ref":"#/components/schemas/Ssid__d67ae4720000"},"type":{"description":"Resource type.\n","enum":["network-services/wids-monitored-aps"],"examples":["network-services/wids-monitored-aps"],"format":"enum","type":"string"}},"required":["id","type","createdAt","bssid","siteId","siteName","classification","classificationMethod","firstSeen","firstDetDeviceSerial","firstDetDeviceName","lastSeen","lastDetDeviceSerial","lastDetDeviceName","encryption"],"type":"object"},"MonitoredApListPage__d67ae4720000":{"allOf":[{"properties":{"items":{"items":{"$ref":"#/components/schemas/MonitoredApData__d67ae4720000"},"maxItems":2147483647,"type":"array"}},"required":["items"],"type":"object"},{"$ref":"#/components/schemas/PaginationResponsePropertieswids__000172564380"}]},"Mtu__2ca376caec3f":{"description":"The MTU value of the port.\n","example":1500,"format":"int32","type":"integer"},"Name__2efde5827a74":{"description":"Name of the webhook. Must be unique per customer.","maxLength":64,"type":"string"},"Name__70734de364b7":{"description":"Specifies the name of report or widgets","examples":["Inventory Report"],"type":"string"},"Name__988495a6329d":{"example":"GE 0/0/2","maxLength":16,"type":"string"},"Namewids__d67ae4720000":{"description":"Name of the monitored AP","examples":["Procurve Net-A5:E3:A1"],"maxLength":128,"type":"string"},"Neighbours__f6c586a7da1c":{"properties":{"id":{"$ref":"#/components/schemas/Idtopology__004689200476"},"neighbours":{"description":"List of neighbouring devices linked to the given device","items":{"properties":{"health":{"description":"Health status of the neighbour","example":"Good","type":"string"},"localPort":{"description":"Port on the local device connected to the neighbour","example":"1/1/23","type":"string"},"memberSerial":{"description":"Serial number of the member device","example":"SG90KMX08R","type":"string"},"name":{"description":"Name of the neighbouring device","example":"DISTR-2-VSX-Primary","type":"string"},"serial":{"description":"Serial number of the neighbouring device. For unmanaged devices, this value follows the format tpd_<mac>, where the mac address is used without colons","example":"TW8AK7206R","type":"string"},"siteId":{"$ref":"#/components/schemas/SiteIdtopology__004689200476","description":"Site id of the neighbour device. This value will be null for unmanaged neighbours.","example":"965498321","nullable":true},"siteName":{"$ref":"#/components/schemas/SiteNametopology__f6c586a7da1c","description":"Site name of the neighbour device. This value will be null for unmanaged neighbours.","example":"Site1","nullable":true},"toPort":{"description":"Port of the neighbour device connected to the local device","example":"1/1/46","type":"string"},"type":{"description":"Type of neighbouring device","example":"Switch","type":"string"}},"type":"object"},"type":"array"},"type":{"description":"Type of topology or connection data","example":"Neighbours","type":"string"}},"required":["id","type"],"type":"object"},"NextParam__306cd00aed2d":{"description":"Specifies the pagination cursor for the next page of resources.\n","examples":[1],"format":"const","maxLength":10,"type":"string"},"NextParam__4ee94b04d313":{"description":"Specifies the pagination cursor for the next page of resources.\n","example":1,"format":"const","maxLength":10,"type":"string"},"NextResponse__15b755dc22d8":{"default":"1","description":"Specifies the pagination cursor for the next page of resources.","example":"2","minimum":1,"type":"string"},"NextRunTs__7d827151e05e":{"description":"Specifies the report period next run timestamp in UTC+0 timezone (RFC 3339 format).","examples":["2019-10-12T07:20:50Z"],"format":"date-time","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z$","type":"string"},"Next__15b755dc22d8":{"default":"1","description":"Specifies the pagination cursor for the next page of resources.","example":"1","minimum":1,"type":"string"},"Next__21874c7bfa12":{"description":"Specifies the pagination cursor for the next page of resources.","example":"2","type":"string"},"Next__6a214df6704a":{"description":"Specifies the pagination cursor for the next page of resources.\n","example":"2","format":"int32","type":"string"},"Next__6ff1f6639f14":{"description":"Specifies the pagination cursor for the next page of resources.","example":"2","format":"const","type":"string"},"NoiseFloor__34350f7e707e":{"description":"Represents the noise floor level measured by the radio.\n","example":-50,"maxLength":16,"type":"string"},"NonWifiInterference__34350f7e707e":{"description":"Indicates the level of non-WiFi interference affecting the radio.\n","example":3,"maxLength":16,"type":"string"},"NotFoundErrorDetails__0c2a95c4aa99":{"description":"Not Found error details returned from the server.","properties":{"debugId":{"$ref":"#/components/schemas/DebugId__0c2a95c4aa99"},"errorCode":{"description":"Internal error code.","example":"HPE_GL_NETWORK_NOTIFICATIONS_NOT_FOUND","maxLength":256,"type":"string"},"httpStatusCode":{"description":"HTTP status code.","example":404,"maximum":404,"minimum":404,"type":"integer"},"message":{"description":"Error message indicating the cause of the failure.","example":"Notification rule not found.","maxLength":512,"type":"string"}},"required":["httpStatusCode","errorCode","message","debugId"],"type":"object"},"NotFoundError__0d6bfd060cf2":{"description":"Not Found error details returned from the server.\n","properties":{"debugId":{"$ref":"#/components/schemas/DebugId__000172564380"},"errorCode":{"description":"* A unique machine-friendly, but human-readable identifier for the error. It has prefix HPE_GL_.\n* For more details regarding error please refer to error message\n","enum":["HPE_GL_ERROR_NOT_FOUND"],"example":"HPE_GL_ERROR_NOT_FOUND","format":"const","maxLength":256,"type":"string"},"httpStatusCode":{"description":"HTTP status code.\n","example":404,"maximum":404,"minimum":404,"type":"integer"},"message":{"$ref":"#/components/schemas/ErrorMessageap__0f1d40c88b6b"}},"required":["httpStatusCode","errorCode","message","debugId"],"type":"object"},"NotFoundError__1335a419f403":{"description":"Not Found error details returned from the server.","properties":{"code":{"description":"Internal service error code.","example":"DOWNSTREAM_SERVICE_ERROR","maxLength":256,"type":"string"},"debugId":{"description":"Debug identifier for troubleshooting.","example":"abc-123-456","maxLength":256,"type":"string"},"errorCode":{"description":"Error code for the specific error.","example":"HPE_GL_NETWORK_EVENTS_NOT_FOUND","maxLength":256,"type":"string"},"errorType":{"description":"Classification of the error type.","example":"NOT_FOUND","maxLength":256,"type":"string"},"httpStatusCode":{"description":"HTTP status code.","example":404,"maximum":404,"minimum":404,"type":"integer"},"message":{"description":"Error message describing the issue.","example":"Resource not found","maxLength":1024,"type":"string"},"serviceName":{"description":"The name of the service where the error originated.","example":"Events","maxLength":256,"type":"string"}},"required":["httpStatusCode","errorCode","message","debugId"],"type":"object"},"NotFoundError__66b457073e9b":{"description":"Not Found error details returned from the server.\n","properties":{"debugId":{"$ref":"#/components/schemas/DebugId__0288a339fc72"},"errorCode":{"description":"* A unique machine-friendly, but human-readable identifier for the error. It has prefix HPE_GL_.\n* For more details regarding error please refer to error message\n","enum":["HPE_GL_NETWORK_REPORTING_NOT_FOUND"],"examples":["HPE_GL_NETWORK_REPORTING_NOT_FOUND"],"maxLength":256,"type":"string"},"httpStatusCode":{"description":"HTTP status code.\n","examples":[404],"maximum":404,"minimum":404,"type":"integer"},"message":{"$ref":"#/components/schemas/ErrorMessage__66b457073e9b"}},"required":["httpStatusCode","errorCode","message","debugId"],"type":"object"},"NotFoundError__6ff1f6639f14":{"description":"Not Found error details returned from the server.\n","properties":{"debugId":{"$ref":"#/components/schemas/DebugId__000172564380"},"errorCode":{"description":"* A unique machine-friendly, but human-readable identifier for the error. It has prefix HPE_GL_.\n* For more details regarding error please refer to error message\n","enum":["HPE_GL_ERROR_NOT_FOUND"],"example":"HPE_GL_ERROR_NOT_FOUND","format":"const","maxLength":256,"type":"string"},"httpStatusCode":{"description":"HTTP status code.\n","example":404,"maximum":404,"minimum":404,"type":"integer"},"message":{"$ref":"#/components/schemas/ErrorMessage__6ff1f6639f14"}},"required":["httpStatusCode","errorCode","message","debugId"],"type":"object"},"NotesOperationResults__0288a339fc72":{"description":"Per-device results of the notes update operation.","properties":{"failed":{"description":"Devices whose notes update failed.","items":{"$ref":"#/components/schemas/DeviceNotesFailedResult__0288a339fc72"},"type":"array"},"succeeded":{"description":"Devices whose notes were updated successfully.","items":{"$ref":"#/components/schemas/DeviceNotesSucceededResult__0288a339fc72"},"type":"array"}},"type":"object"},"Notes__6b9c5f08b869":{"description":"Notes for the device.","example":"Device is located in Building A, Floor 2","format":"const","maxLength":256,"type":"string"},"NotificationRuleConfigInput__4e865062885b":{"description":"Notification rule config input details.","properties":{"description":{"description":"Description of the notification rule.","example":"Notification rule for email alerts.","maxLength":512,"type":"string"},"destination":{"$ref":"#/components/schemas/NotificationRuleDestinationInput__4e865062885b"},"enabled":{"description":"Indicates whether the notification rule is enabled.","example":true,"type":"boolean"},"name":{"description":"Name of the notification rule.","example":"email-rule","maxLength":128,"type":"string"},"source":{"$ref":"#/components/schemas/NotificationRuleSourceInput__4e865062885b"},"sourceTypes":{"description":"List of source types for the notification rule.","items":{"enum":["ALERTS"],"type":"string"},"type":"array"}},"required":["name"],"type":"object"},"NotificationRuleDestinationEmailInput__4e865062885b":{"description":"Email destination details for the notification rule.","properties":{"emailIds":{"description":"List of email addresses for the notification rule. \nNOTE: The contents of this field are ignored if email destination is not enabled.","items":{"example":"admin@domain.com","format":"email","maxLength":256,"type":"string"},"type":"array"},"enabled":{"description":"Indicates whether the email destination is enabled.","example":true,"type":"boolean"}},"required":["enabled"],"type":"object"},"NotificationRuleDestinationEmail__4d16a4598b40":{"description":"Email destination details for the notification rule.","properties":{"emailIds":{"description":"List of email addresses for the notification rule.","items":{"example":"admin@domain.com","format":"email","maxLength":256,"type":"string"},"type":"array"},"enabled":{"description":"Indicates whether the email destination is enabled.","example":true,"type":"boolean"}},"type":"object"},"NotificationRuleDestinationInput__4e865062885b":{"description":"Notification destination details for the notification rule.\nNOTE: At least one of the destination types (email, webhook or syslog) should be enabled to create or update a notification rule.","properties":{"email":{"$ref":"#/components/schemas/NotificationRuleDestinationEmailInput__4e865062885b"},"syslog":{"$ref":"#/components/schemas/NotificationRuleDestinationSyslogInput__4e865062885b"},"webhook":{"$ref":"#/components/schemas/NotificationRuleDestinationWebhookInput__4e865062885b"}},"type":"object"},"NotificationRuleDestinationSyslogInput__4e865062885b":{"description":"Syslog destination details for the notification rule.\nNOTE: Syslog destination is only supported in the Central On-Premise environment.","properties":{"enabled":{"description":"Indicates whether the syslog destination is enabled.","example":true,"type":"boolean"},"serverIds":{"description":"List of syslog servers UUIDs for the notification rule.\nNOTE: The contents of this field are ignored if syslog destination is not enabled.","items":{"example":"4d113fgh-abcd-ef","format":"uuid","maxLength":256,"type":"string"},"type":"array"}},"required":["enabled"],"type":"object"},"NotificationRuleDestinationSyslog__4d16a4598b40":{"description":"Syslog destination details for the notification rule.\nNOTE: Syslog destination is only supported in the Central On-Premise environment.","properties":{"enabled":{"description":"Indicates whether the syslog destination is enabled.","example":true,"type":"boolean"},"serverIds":{"description":"List of syslog server UUIDs for the notification rule.","items":{"example":"4d113fgh-abcd-ef","format":"uuid","maxLength":256,"type":"string"},"type":"array"}},"type":"object"},"NotificationRuleDestinationWebhookInput__4e865062885b":{"description":"Webhook destination details for the notification rule.","properties":{"enabled":{"description":"Indicates whether the webhook destination is enabled.","example":true,"type":"boolean"},"webhookIds":{"description":"List of webhook subscription UUIDs for the notification rule.\n  The contents of this field are ignored if webhook destination is not enabled.\nNOTE: Check the Webhook API details for fetching the list of supported webhook subscription details.","items":{"example":"4d113fgh-abcd-ef","format":"uuid","maxLength":512,"type":"string"},"type":"array"}},"required":["enabled"],"type":"object"},"NotificationRuleDestinationWebhook__4d16a4598b40":{"description":"Webhook destination details for the notification rule.","properties":{"enabled":{"description":"Indicates whether the webhook destination is enabled.","example":true,"type":"boolean"},"webhookIds":{"description":"List of webhook subscription UUIDs for the notification rule.","items":{"example":"4d113fgh-abcd-ef","format":"uuid","maxLength":512,"type":"string"},"type":"array"}},"type":"object"},"NotificationRuleDestination__4d16a4598b40":{"description":"Notification destination details for the notification rule.","properties":{"email":{"$ref":"#/components/schemas/NotificationRuleDestinationEmail__4d16a4598b40"},"syslog":{"$ref":"#/components/schemas/NotificationRuleDestinationSyslog__4d16a4598b40"},"webhook":{"$ref":"#/components/schemas/NotificationRuleDestinationWebhook__4d16a4598b40"}},"type":"object"},"NotificationRuleSourceAlertsInput__4e865062885b":{"description":"Alert source details for the notification rule.","properties":{"alertNames":{"description":"List of alert names for the notification rule.\nNOTE: Check the Alerts configuration API details for fetching the list of supported alerts.","items":{"example":"AP CPU Utilization","maxLength":256,"type":"string"},"type":"array"},"enabled":{"description":"Indicates whether the alert source is enabled. \nNOTE: This field should be true to use alert source type. \n If this field is false, the notification rule will not be created.","example":true,"type":"boolean"},"minAlertSeverity":{"description":"Minimum alert severity for the notification rule.","enum":["CRITICAL","MAJOR","MINOR","INFO"],"type":"string"}},"required":["enabled","alertNames"],"type":"object"},"NotificationRuleSourceAlertsSummary__4d16a4598b40":{"description":"Alert source details for the notification rule.","properties":{"alertCount":{"description":"Count of alert names configured for the notification rule.","example":10,"format":"int32","maximum":300,"minimum":1,"type":"integer"},"enabled":{"description":"Indicates whether the alert source is enabled.","example":true,"type":"boolean"},"minAlertSeverity":{"description":"Minimum alert severity for the notification rule.","enum":["CRITICAL","MAJOR","MINOR","INFO"],"type":"string"}},"type":"object"},"NotificationRuleSourceAlerts__4e865062885b":{"description":"Alert source details for the notification rule.","properties":{"alertNames":{"description":"List of alert names for the notification rule.","items":{"example":"AP CPU Utilization","maxLength":256,"type":"string"},"type":"array"},"enabled":{"description":"Indicates whether the alert source is enabled.","example":true,"type":"boolean"},"minAlertSeverity":{"description":"Minimum alert severity for the notification rule.","enum":["CRITICAL","MAJOR","MINOR","INFO"],"type":"string"}},"type":"object"},"NotificationRuleSourceInput__4e865062885b":{"description":"Data source details for the notification rule.","properties":{"alerts":{"$ref":"#/components/schemas/NotificationRuleSourceAlertsInput__4e865062885b"}},"type":"object"},"NotificationRuleSourceSummary__4d16a4598b40":{"description":"Data source details for the notification rule.","properties":{"alerts":{"$ref":"#/components/schemas/NotificationRuleSourceAlertsSummary__4d16a4598b40"}},"type":"object"},"NotificationRuleSource__4e865062885b":{"description":"Data source details for the notification rule.","properties":{"alerts":{"$ref":"#/components/schemas/NotificationRuleSourceAlerts__4e865062885b"}},"type":"object"},"NotificationRuleSummary__4d16a4598b40":{"description":"Notification rule details.","properties":{"description":{"description":"Description of the notification rule.","example":"Notification rule for email alerts.","maxLength":512,"type":"string"},"destination":{"$ref":"#/components/schemas/NotificationRuleDestination__4d16a4598b40"},"enabled":{"description":"Indicates whether the notification rule is enabled.","example":true,"type":"boolean"},"id":{"description":"Unique identifier of the notification rule.","example":"3f96ffea-73fe-4a9b-b253-ddc58c76fe25","maxLength":128,"type":"string"},"name":{"description":"Name of the notification rule.","example":"email-rule","maxLength":128,"type":"string"},"source":{"$ref":"#/components/schemas/NotificationRuleSourceSummary__4d16a4598b40"},"sourceTypes":{"description":"List of source types for the notification rule.","items":{"enum":["ALERTS"],"type":"string"},"type":"array"},"type":{"const":"network-notifications/notification-rule","description":"Type identifier for the notification rule.","type":"string"}},"required":["id","type","name"],"type":"object"},"NotificationRuleUpdateInput__76e43b06d0ba":{"description":"Notification rule config input details for Update operation.","properties":{"description":{"description":"Description of the notification rule.","example":"Notification rule for email alerts.","maxLength":512,"type":"string"},"destination":{"$ref":"#/components/schemas/NotificationRuleDestinationInput__4e865062885b"},"enabled":{"description":"Indicates whether the notification rule is enabled.","example":true,"type":"boolean"},"source":{"$ref":"#/components/schemas/NotificationRuleSourceInput__4e865062885b"},"sourceTypes":{"description":"List of source types for the notification rule.","items":{"enum":["ALERTS"],"type":"string"},"type":"array"}},"type":"object"},"NotificationRule__4e865062885b":{"description":"Notification rule details.","properties":{"description":{"description":"Description of the notification rule.","example":"Notification rule for email alerts.","maxLength":512,"type":"string"},"destination":{"$ref":"#/components/schemas/NotificationRuleDestination__4d16a4598b40"},"enabled":{"description":"Indicates whether the notification rule is enabled.","example":true,"type":"boolean"},"id":{"description":"Unique identifier of the notification rule.","example":"3f96ffea-73fe-4a9b-b253-ddc58c76fe25","maxLength":128,"type":"string"},"name":{"description":"Name of the notification rule.","example":"email-rule","maxLength":128,"type":"string"},"source":{"$ref":"#/components/schemas/NotificationRuleSource__4e865062885b"},"sourceTypes":{"description":"List of source types for the notification rule.","items":{"enum":["ALERTS"],"type":"string"},"type":"array"},"type":{"const":"network-notifications/notification-rule","description":"Type identifier for the notification rule.","type":"string"}},"required":["id","type","name"],"type":"object"},"NotificationRules__4d16a4598b40":{"allOf":[{"description":"Notification rule details","properties":{"items":{"description":"List of notification rules.","items":{"$ref":"#/components/schemas/NotificationRuleSummary__4d16a4598b40"},"type":"array"}},"required":["items"],"type":"object"},{"$ref":"#/components/schemas/PaginationResponseProperties__4d16a4598b40"}]},"NslookupApParsedOutput__f35d32c913eb":{"properties":{"dnsServer":{"description":"The DNS server used for the lookup.","type":"string"},"hostName":{"description":"The host name that was looked up.","type":"string"},"resolvedAddresses":{"description":"The list of resolved IP addresses.","items":{"type":"string"},"type":"array"}},"title":"AP NSLOOKUP RESPONSE","type":"object"},"NslookupApRequest__b4a33e98130d":{"properties":{"dnsServer":{"description":"Optional DNS server to use for the lookup","type":"string"},"host":{"description":"Hostname to lookup Required","type":"string"}},"required":["host"],"title":"AP NSLOOKUP REQUEST","type":"object"},"NslookupApResult__f35d32c913eb":{"allOf":[{"$ref":"#/components/schemas/AsyncOperationResultBase__03efdde95a47"},{"properties":{"output":{"allOf":[{"$ref":"#/components/schemas/NslookupApParsedOutput__f35d32c913eb"}],"type":["object","null"]}},"type":"object"}],"title":"AP NSLOOKUP RESULT"},"NumOfReportingAPs__3f58b16772b5":{"description":"Number of APs that heard this client and were used to calculate the location.\n","example":3,"format":"int32","maximum":255,"minimum":1,"type":"integer"},"OccurredAt__972dd6d46bea":{"description":"Specifies the transition time of the client.","example":"2025-07-10T08:09:17.419Z","type":"string"},"OffsetParam__244c7d3b837e":{"default":0,"examples":[0],"format":"int32","type":"integer"},"OffsetParam__4d16a4598b40":{"default":0,"description":"Specifies the zero-based resource offset from which to start the response.","example":10,"format":"int32","maximum":19,"minimum":0,"type":"integer"},"Offset__7006262f8c4c":{"description":"Specifies the offset of the first item in the response.\n","examples":[10],"format":"int64","type":"integer"},"Offset__f20300aab7a0":{"default":0,"example":0,"format":"int32","type":"integer"},"Offsetapp__7c5b5fe9ca66":{"description":"The offset of the first item in the response.\n","example":0,"format":"int32","minimum":0,"type":"integer"},"Offsetasset__acdf4895bcad":{"description":"Specifies the zero-based resource offset to start the response from. (Default: 0)\n","example":1,"format":"int32","maximum":2147483647,"minimum":0,"type":"integer"},"Offsetfco__09b903e67f2b":{"default":0,"description":"The offset of the first item in the collection to return.","format":"int32","maximum":2147483647,"minimum":0,"type":"integer"},"Offsetsite__7f65987649fe":{"default":0,"description":"Defines the starting point for the set of sites to be returned. Number of sites to skip before starting to collect the result set.","example":0,"format":"int32","type":"integer"},"Offsetwids__000172564380":{"default":0,"description":"Specifies the zero-based resource offset to start the response from. (Default: 0)\n","examples":[1],"format":"int32","maximum":2147483647,"minimum":0,"type":"integer"},"OidcDetailsRequest__c1c7772865ac":{"description":"Details for OIDC authentication.","properties":{"clientId":{"description":"The client ID for OIDC authentication.","maxLength":512,"minLength":1,"type":"string"},"clientSecret":{"description":"The client secret for OIDC authentication.","maxLength":512,"minLength":1,"type":"string"},"wellKnownUrl":{"description":"The well-known URL for OIDC discovery.","maxLength":512,"minLength":1,"type":"string"}},"title":"OIDC Details Request","type":"object"},"OidcDetails__715550e8d02e":{"description":"Details for OIDC authentication.","properties":{"clientId":{"description":"The client ID for OIDC authentication.","maxLength":512,"minLength":1,"type":"string"},"clientSecret":{"description":"The client secret for OIDC authentication.","maxLength":512,"minLength":1,"type":"string"},"wellKnownUrl":{"description":"The well-known URL for OIDC discovery.","maxLength":512,"minLength":1,"type":"string"}},"title":"OIDC Details","type":"object"},"OnboardingCountData__edc7bc848e84":{"properties":{"count":{"description":"Occurrence count for the grouped value.","example":42,"type":"integer"},"field":{"description":"Requested grouping field key.","enum":["topclients","topaccessdevices","band","topwlans","topreasons","topservers"],"type":"string"},"stage":{"enum":["assoc","auth","dhcp","dns"],"example":"auth","type":"string"},"type":{"description":"Computed type in `<FIELD>_<STATUS>_COUNT` form.","example":"TOPCLIENTS_FAILED_COUNT","type":"string"},"value":{"description":"Top grouped value; for example client MAC, AP MAC, band, WLAN, reason, or server IP.","example":"AA:AA:AA:AA:AA:AA","type":"string"}},"required":["type","value","field","count","stage"],"type":"object"},"OnboardingCountItem__edc7bc848e84":{"properties":{"data":{"items":{"$ref":"#/components/schemas/OnboardingCountData__edc7bc848e84"},"type":"array"},"type":{"description":"Stage key.","example":"auth","type":"string"}},"required":["type","data"],"type":"object"},"OnboardingCountResult__edc7bc848e84":{"properties":{"count":{"example":4,"type":"integer"},"id":{"type":"string"},"items":{"items":{"$ref":"#/components/schemas/OnboardingCountItem__edc7bc848e84"},"type":"array"},"type":{"description":"Top count response type based on status.","example":"TOP_FAILED_COUNT","type":"string"}},"required":["id","type","items","count"],"type":"object"},"OnboardingReasonsItem__ec4a680d09ad":{"properties":{"reasons":{"description":"Top reason values (up to 5) for the stage and status.","items":{"type":"string"},"type":"array"},"type":{"description":"Stage name in uppercase.","example":"AUTH","type":"string"}},"required":["type","reasons"],"type":"object"},"OnboardingReasonsResult__ec4a680d09ad":{"properties":{"count":{"example":4,"type":"integer"},"id":{"type":"string"},"items":{"items":{"$ref":"#/components/schemas/OnboardingReasonsItem__ec4a680d09ad"},"type":"array"},"type":{"description":"Top reason response type based on status.","example":"TOP_FAILED_REASONS","type":"string"}},"required":["id","type","items","count"],"type":"object"},"OnboardingScoreResult__540f40c96fc2":{"properties":{"count":{"description":"The number of stages returned in `items`.","example":4,"type":"integer"},"id":{"description":"A unique identifier for this onboarding score response.","example":"onboarding-score","type":"string"},"items":{"description":"The per-stage onboarding scores.","items":{"$ref":"#/components/schemas/OnboardingStageScore__540f40c96fc2"},"type":"array"},"overallScore":{"description":"Overall score as average of valid stage scores; `-1` when no valid stage score is available.","example":"51.62","oneOf":[{"type":"string"},{"type":"null"}]},"type":{"description":"The resource type for onboarding score response.","example":"onboarding-score","type":"string"}},"required":["id","type","items","count"],"type":"object"},"OnboardingStageExportData__5359db3f2927":{"properties":{"accessDevice":{"items":{"type":"string"},"type":"array"},"attempts":{"description":"Total attempts for the stage.","type":"string"},"authTopServers":{"items":{"type":"string"},"type":"array"},"band":{"items":{"type":"string"},"type":"array"},"clients":{"items":{"type":"string"},"type":"array"},"delays":{"description":"Total delayed attempts for the stage.","type":"string"},"dhcpTopServers":{"items":{"type":"string"},"type":"array"},"dnsTopServers":{"items":{"type":"string"},"type":"array"},"failures":{"description":"Total failed attempts for the stage.","type":"string"},"success":{"description":"Total successful attempts for the stage.","type":"string"},"topReasons":{"items":{"type":"string"},"type":"array"},"type":{"description":"Bucket type for export details.","enum":["SUMMARY","DELAY","FAILED"],"example":"SUMMARY","type":"string"},"wlans":{"items":{"type":"string"},"type":"array"}},"type":"object"},"OnboardingStageExportItem__5359db3f2927":{"properties":{"data":{"items":{"$ref":"#/components/schemas/OnboardingStageExportData__5359db3f2927"},"type":"array"},"type":{"description":"Onboarding stage key.","enum":["assoc","auth","dhcp","dns"],"example":"auth","type":"string"}},"required":["type","data"],"type":"object"},"OnboardingStageExportResult__5359db3f2927":{"properties":{"count":{"description":"Number of stages returned in items.","example":4,"type":"integer"},"id":{"description":"Unique identifier for this stage export response.","type":"string"},"items":{"items":{"$ref":"#/components/schemas/OnboardingStageExportItem__5359db3f2927"},"type":"array"},"overallSuccessScore":{"description":"Overall success score across selected scope; `-1` when attempts are unavailable.","example":"77.92","type":"string"},"type":{"description":"The response resource type.","example":"CLIENT_CONNECTIVITY","type":"string"}},"required":["id","type","items","count"],"type":"object"},"OnboardingStageScore__540f40c96fc2":{"properties":{"score":{"description":"The stage score as a percentage number string; `-1` when unavailable.","example":"77.90","type":"string"},"scorePercentage":{"description":"The stage score percentage display value.","example":"77.90%","type":"string"},"stage":{"description":"The onboarding stage.","example":"assoc","type":"string"}},"required":["stage","score","scorePercentage"],"type":"object"},"OverlayResponse__45e55a7a2612":{"properties":{"code":{"description":"status codes.","example":"create-success","format":"const","maxLength":128,"type":"string"},"status":{"enum":["SUCCESS","INVALID_OPERATION","NOT_FOUND","FAILURE","PARTIAL_SUCCESS"],"type":"string"}},"type":"object"},"PaginatedResponseV1__6b9c5f08b869":{"properties":{"count":{"$ref":"#/components/schemas/Countdevice__6b9c5f08b869"},"next":{"description":"Indicates the next page number, null if there are no further pages.","example":"2","format":"int32","type":"string"},"total":{"$ref":"#/components/schemas/Totaldevice__6b9c5f08b869"}},"required":["count","next"],"type":"object"},"PaginatedResponse__7006262f8c4c":{"properties":{"count":{"$ref":"#/components/schemas/Count__7006262f8c4c"},"offset":{"$ref":"#/components/schemas/Offset__7006262f8c4c"},"total":{"$ref":"#/components/schemas/Total__7006262f8c4c"}},"required":["count","total","offset"],"type":"object"},"PaginatedResponse__c0c1228d8f7d":{"properties":{"count":{"$ref":"#/components/schemas/Count__c0c1228d8f7d"},"next":{"description":"Indicate the next page number, null if there are no further pages.\n","example":"2","format":"int32","type":"string"},"total":{"$ref":"#/components/schemas/Total__c0c1228d8f7d"}},"required":["count","next"],"type":"object"},"PaginatedResponseap__2dcf9a625ef5":{"properties":{"count":{"$ref":"#/components/schemas/Count__c0c1228d8f7d"},"next":{"description":"Indicates the next page number, null if there are no further pages.","example":"2","format":"int32","type":"string"},"total":{"$ref":"#/components/schemas/Total__c0c1228d8f7d"}},"required":["count","next"],"type":"object"},"PaginatedResponsegw__21874c7bfa12":{"properties":{"count":{"$ref":"#/components/schemas/Countgw__21874c7bfa12"},"next":{"description":"Indicates the next page number, or null if there are no further pages.","example":"2","format":"int32","type":"string"},"total":{"$ref":"#/components/schemas/Total__c0c1228d8f7d"}},"required":["count","next"],"type":"object"},"PaginationResponseProperties__3f58b16772b5":{"description":"Fields appended to a list to facilitate paging.\n","properties":{"count":{"description":"The number of objects returned in the current list.\n","example":100,"format":"int32","maximum":2147483647,"minimum":0,"type":"integer"},"offset":{"description":"Specifies the offset of the returned page.\n","example":0,"format":"int32","maximum":2147483647,"minimum":0,"type":"integer"},"total":{"description":"The total number of objects contained in the datastore.\n","example":200,"format":"int64","maximum":9223372036854776000,"minimum":0,"type":"integer"}},"required":["count"],"type":"object"},"PaginationResponseProperties__4d16a4598b40":{"description":"Fields appended to a list to facilitate paging.","properties":{"count":{"description":"The number of objects returned in the current list.","example":1,"format":"int32","maximum":20,"minimum":0,"type":"integer"},"offset":{"description":"The offset index to start returning results from in offset-based pagination. Set to null when no more pages remain.","example":1,"format":"int32","maximum":19,"minimum":0,"type":"integer"},"total":{"description":"The total number of objects contained in the datastore.","example":1,"format":"int32","maximum":20,"minimum":0,"type":"integer"}},"required":["count","total","offset"],"type":"object"},"PaginationResponseProperties__4ee94b04d313":{"description":"Fields appended to a list to facilitate paging.\n","properties":{"count":{"description":"The number of objects returned in the current list.\n","example":1,"format":"int32","maximum":2147483647,"minimum":1,"type":"integer"},"next":{"description":"An opaque cursor which could be passed in the next query to fetch the next page.\nSet to null when no more pages remain.\n","example":1,"format":"const","maxLength":128,"type":"string"},"total":{"description":"The total number of objects contained in the datastore.\n","example":1,"format":"int64","maximum":9223372036854776000,"minimum":0,"type":"integer"}},"required":["count","total","next"],"type":"object"},"PaginationResponsePropertiesasset__acdf4895bcad":{"description":"Fields appended to a list to facilitate paging.","properties":{"count":{"description":"The number of objects returned in the current list.\n","example":100,"format":"int32","maximum":2147483647,"minimum":0,"type":"integer"},"offset":{"description":"Specifies the offset of the returned page.\n","example":0,"format":"int32","maximum":2147483647,"minimum":0,"type":"integer"},"total":{"description":"The total number of objects contained in the datastore.\n","example":200,"format":"int64","maximum":9223372036854776000,"minimum":0,"type":"integer"}},"required":["count"],"type":"object"},"PaginationResponsePropertiesswitch__244c7d3b837e":{"description":"Fields appended to a list to facilitate paging.\n","properties":{"count":{"description":"The number of objects returned in the current list.\n","example":1,"format":"int32","type":"integer"},"offset":{"description":"An offset which could be passed in the next query to fetch the next page.\nSet to null when no more pages remain.\n","examples":[null],"format":"const","maxLength":128,"type":"string"},"total":{"description":"The total number of objects contained in the datastore.\n","example":1,"format":"int64","type":"integer"}},"required":["count","total","offset"],"type":"object"},"PaginationResponsePropertieswids__000172564380":{"description":"Fields appended to a list to facilitate paging.\n","properties":{"count":{"description":"The number of objects returned in the current list.\n","examples":[1],"format":"int32","maximum":2147483647,"minimum":0,"type":"integer"},"offset":{"description":"Specifies the offset of the returned page.\n","examples":[0],"format":"int32","maximum":2147483647,"minimum":0,"type":"integer"},"total":{"description":"The total number of objects contained in the datastore.\n","examples":[1],"format":"int64","maximum":9223372036854776000,"minimum":0,"type":"integer"}},"required":["count","offset"],"type":"object"},"PartNumber__6b9c5f08b869":{"description":"The part number of the device.","example":"JX973A","format":"const","maxLength":12,"type":"string"},"PartNumberap__da78704f9a76":{"description":"The part number of the access point\n","example":"JX973A","format":"const","maxLength":12,"type":"string"},"PartNumbergw__de89a47d9bd8":{"description":"The part number of the gateway.\n","example":"JX973A","maxLength":12,"type":"string"},"PhyType__284f33982989":{"description":"Specifies the IEEE 802.11 physical layer standard used for the client's current connection.","example":"802.11a","type":"string"},"PingApParsedOutput__d63f315f0dff":{"properties":{"averageRoundTripTimeMilliseconds":{"description":"Average round trip time in milliseconds","type":"string"},"destination":{"description":"The destination host name or IP address provided for the ping command.","type":"string"},"maximumRoundTripTimeMilliseconds":{"description":"Maximum round-trip time in milliseconds.","type":"string"},"minimumRoundTripTimeMilliseconds":{"description":"Minimum round-trip time in milliseconds.","type":"string"},"packetLossPercent":{"description":"Percentage of packet loss.","type":"string"},"receivedPacketsCount":{"description":"Number of packets received.","type":"string"},"replies":{"description":"Details for a single ping packet reply.","items":{"$ref":"#/components/schemas/PingApPingrowresult__d63f315f0dff"},"type":"array"},"resolvedIp":{"description":"The IP address resolved from the destination host.","type":"string"},"transmittedPacketsCount":{"description":"Number of packets transmitted.","type":"string"}},"title":"AP PING RESPONSE","type":"object"},"PingApPingrowresult__d63f315f0dff":{"properties":{"sentPacketAddress":{"description":"IP address of the sent packet.","type":"string"},"sentPacketIcmpSequenceNumber":{"description":"ICMP sequence number of the sent packet.","type":"string"},"sentPacketSizeBytes":{"description":"Size of the sent packet.","type":"string"},"sentPacketTimeMilliseconds":{"description":"Time taken for the sent packet.","type":"string"},"sentPacketTimeToLive":{"description":"Time to live of the sent packet.","type":"string"}},"title":"AP PING REPLY","type":"object"},"PingApRequest__11bfc6a440f0":{"properties":{"count":{"description":"Number of probes to send (1-100)","maximum":100,"minimum":1,"type":"integer"},"destination":{"description":"Hostname/IP address required","type":"string"},"includeRawOutput":{"description":"Whether to include raw output in the response.","type":"boolean"},"interfacePort":{"description":"","type":"string"},"packetSize":{"description":"The packet size in bytes (10-2000)","maximum":2000,"minimum":10,"type":"integer"},"role":{"description":"","type":"string"},"vlan":{"description":"","maximum":4095,"minimum":1,"type":"integer"}},"required":["destination"],"title":"AP PING REQUEST","type":"object"},"PingApResult__d63f315f0dff":{"allOf":[{"$ref":"#/components/schemas/AsyncOperationResultBase__03efdde95a47"},{"properties":{"output":{"allOf":[{"$ref":"#/components/schemas/PingApParsedOutput__d63f315f0dff"}],"type":["object","null"]},"rawOutput":{"description":"The raw output of the test.","type":"string"}},"type":"object"}],"title":"AP PING RESULT"},"PingCxParsedOutput__8e49265a363a":{"properties":{"averageRoundTripTimeMilliseconds":{"description":"Average round trip time in milliseconds","type":"string"},"destination":{"description":"The destination host name or IP address provided for the ping command.","type":"string"},"maximumRoundTripTimeMilliseconds":{"description":"Maximum round-trip time in milliseconds.","type":"string"},"minimumRoundTripTimeMilliseconds":{"description":"Minimum round-trip time in milliseconds.","type":"string"},"packetLossPercent":{"description":"Percentage of packet loss.","type":"string"},"receivedPacketsCount":{"description":"Number of packets received.","type":"string"},"replies":{"description":"Details for a single ping packet reply.","items":{"$ref":"#/components/schemas/PingCxPingrowresult__8e49265a363a"},"type":"array"},"resolvedIp":{"description":"The IP address resolved from the destination host.","type":"string"},"standardDeviationRoundTripTimeMilliseconds":{"description":"Standard deviation of round-trip times.","type":"string"},"totalRoundTripTimeMilliseconds":{"description":"Total time taken for the ping sequence.","type":"string"},"transmittedPacketsCount":{"description":"Number of packets transmitted.","type":"string"}},"title":"CX PING RESPONSE","type":"object"},"PingCxPingrowresult__8e49265a363a":{"properties":{"sentPacketAddress":{"description":"IP address of the sent packet.","type":"string"},"sentPacketIcmpSequenceNumber":{"description":"ICMP sequence number of the sent packet.","type":"string"},"sentPacketSizeBytes":{"description":"Size of the sent packet.","type":"string"},"sentPacketTimeMilliseconds":{"description":"Time taken for the sent packet.","type":"string"},"sentPacketTimeToLive":{"description":"Time to live of the sent packet.","type":"string"}},"title":"CX PING REPLY","type":"object"},"PingCxRequest__b6689a53ee20":{"properties":{"count":{"description":"Number of probes to send (1-100)","maximum":100,"minimum":1,"type":"integer"},"destination":{"description":"Hostname/IP address required","type":"string"},"includeRawOutput":{"description":"Whether to include raw output in the response.","type":"boolean"},"packetSize":{"description":"The packet size in bytes (10-2000)","maximum":2000,"minimum":10,"type":"integer"},"useIpv6":{"description":"Use IPv6","type":"boolean"},"useManagementInterface":{"description":"Use management interface","type":"boolean"},"vrfName":{"description":"The default value is 'default'","type":"string"}},"required":["destination"],"title":"CX PING REQUEST","type":"object"},"PingCxResult__8e49265a363a":{"allOf":[{"$ref":"#/components/schemas/AsyncOperationResultBase__03efdde95a47"},{"properties":{"output":{"allOf":[{"$ref":"#/components/schemas/PingCxParsedOutput__8e49265a363a"}],"type":["object","null"]},"rawOutput":{"description":"The raw output of the test.","type":"string"}},"type":"object"}],"title":"CX PING RESULT"},"PingHppcParsedOutput__41907dccf1b5":{"properties":{"averageRoundTripTimeMilliseconds":{"description":"Average round trip time","type":"string"},"maximumRoundTripTimeMilliseconds":{"description":"Maximum round-trip time.","type":"string"},"minimumRoundTripTimeMilliseconds":{"description":"Minimum round-trip time.","type":"string"},"packetLossPercent":{"description":"Percentage of packet loss.","type":"string"},"receivedPacketsCount":{"description":"Number of packets received.","type":"string"},"replies":{"description":"Details for a single ping packet reply.","items":{"$ref":"#/components/schemas/PingHppcPingrowresult__41907dccf1b5"},"type":"array"},"transmittedPacketsCount":{"description":"Number of packets transmitted.","type":"string"}},"title":"AOS-S PING RESPONSE","type":"object"},"PingHppcPingrowresult__41907dccf1b5":{"properties":{"sentPacketAddress":{"description":"IP address of the sent packet.","type":"string"},"sentPacketIcmpSequenceNumber":{"description":"ICMP sequence number of the sent packet.","type":"string"},"sentPacketTimeMilliseconds":{"description":"Time taken for the sent packet.","type":"string"}},"title":"AOS-S PING REPLY","type":"object"},"PingHppcRequest__eb91b21dda1e":{"properties":{"count":{"description":"Number of probes to send (1-100)","maximum":100,"minimum":1,"type":"integer"},"destination":{"description":"Hostname/IP address required","type":"string"},"includeRawOutput":{"description":"Whether to include raw output in the response.","type":"boolean"},"ipAddress":{"description":"","type":"string"},"loopbackPort":{"description":"","type":"integer"},"packetSize":{"description":"The packet size in bytes (10-2000)","maximum":2000,"minimum":10,"type":"integer"},"useIpv6":{"description":"Use IPv6","type":"boolean"},"vlan":{"description":"","type":"integer"}},"required":["destination"],"title":"AOS-S PING REQUEST","type":"object"},"PingHppcResult__41907dccf1b5":{"allOf":[{"$ref":"#/components/schemas/AsyncOperationResultBase__03efdde95a47"},{"properties":{"output":{"allOf":[{"$ref":"#/components/schemas/PingHppcParsedOutput__41907dccf1b5"}],"type":["object","null"]},"rawOutput":{"description":"The raw output of the test.","type":"string"}},"type":"object"}],"title":"AOS-S PING RESULT"},"PingMcParsedOutput__f7a0d49cd9fa":{"properties":{"averageLatencyMilliseconds":{"description":"The average latency calculated from all received ping responses, measured in milliseconds.","type":"string"},"destination":{"description":"The destination host name or IP address for the ping command.","type":"string"},"maximumLatencyMilliseconds":{"description":"The highest latency recorded across all successful ping attempts, measured in milliseconds.","type":"string"},"minimumLatencyMilliseconds":{"description":"The lowest latency recorded across all successful ping attempts, measured in milliseconds.","type":"string"},"packetSizeBytes":{"description":"The size of each packet sent during the ping test, measured in bytes.","type":"string"},"receivedPacketsCount":{"description":"The total number of ping packets received successfully.","type":"string"},"sentPacketsCount":{"description":"The total number of ping packets sent.","type":"string"},"successRatePercent":{"description":"The percentage of ping packets successfully received compared to the total number sent.","type":"string"},"timeoutSeconds":{"description":"The maximum duration in seconds to wait for a response before considering an individual ping attempt as lost.","type":"string"}},"title":"GATEWAY PING RESPONSE","type":"object"},"PingMcRequest__fe5c44d623cd":{"properties":{"count":{"description":"Number of probes to send (1-100)","maximum":100,"minimum":1,"type":"integer"},"destination":{"description":"Hostname/IP address required","type":"string"},"dontFragmentFlag":{"description":"Don't Fragment Flag","type":"boolean"},"dscp":{"description":"DSCP packet header value between 0 and 63","maximum":63,"minimum":0,"type":"integer"},"includeRawOutput":{"description":"Whether to include raw output in the response.","type":"boolean"},"packetSize":{"description":"The packet size in bytes (10-2000)","maximum":2000,"minimum":10,"type":"integer"},"sourceInterface":{"description":"","enum":["loopback","mgmt-interface","vlan-interface"],"type":"string"},"ttl":{"description":"Time To Live for IP datagram (1-255)","maximum":255,"minimum":1,"type":"integer"},"useIpv6":{"description":"Use IPv6","type":"boolean"},"vlan":{"description":"","maximum":4095,"minimum":1,"type":"number"}},"required":["destination"],"title":"GATEWAY PING REQUEST","type":"object"},"PingMcResult__f7a0d49cd9fa":{"allOf":[{"$ref":"#/components/schemas/AsyncOperationResultBase__03efdde95a47"},{"properties":{"output":{"allOf":[{"$ref":"#/components/schemas/PingMcParsedOutput__f7a0d49cd9fa"}],"type":["object","null"]},"rawOutput":{"description":"The raw output of the test.","type":"string"}},"type":"object"}],"title":"GATEWAY PING RESULT"},"PlacedDeviceResponseObject__4ee94b04d313":{"allOf":[{"properties":{"items":{"items":{"properties":{"accesspointProperties":{"properties":{"floorId":{"$ref":"#/components/schemas/uuId__08d3c9863d87"},"isAnchor":{"example":true,"format":"const","maxLength":12,"type":"string"},"macAddress":{"example":"11:22:33:44:55:66","format":"const","maxLength":18,"type":"string"},"model":{"example":"AP-635","format":"const","maxLength":32,"type":"string"},"partNumber":{"description":"device part number\n","example":"JX973A","format":"const","maxLength":12,"type":"string"},"radios":{"items":{"properties":{"band":{"description":"Band\n","example":"5 GHz","format":"const","maxLength":16,"type":"string"},"channel":{"description":"channel\n","example":"5 GHz","format":"const","maxLength":16,"type":"string"},"macAddress":{"example":"11:22:33:44:55:66","format":"const","maxLength":18,"type":"string"},"number":{"description":"Radio interface number\n","example":1,"format":"int32","maximum":10,"minimum":0,"type":"integer"},"power":{"description":"Tx power\n","example":"18 Dbm","format":"const","maxLength":16,"type":"string"},"serial":{"description":"Device serial number\n","example":"AP00000001","format":"const","maxLength":16,"type":"string"}},"type":"object"},"maxItems":9999,"type":"array"},"serialNumber":{"description":"Device serial number.\n","example":"AP00000001","format":"const","maxLength":16,"type":"string"},"siteId":{"description":"Site ID associated with the device commonly in UUID format.\n","example":"3b5b-0e6c-4b73-9f6e-4e895a080190","maxLength":128,"type":"string"},"state":{"description":"ASSIGNED or DEPLOYED.\n","example":"DEPLOYED","format":"const","maxLength":12,"type":"string"},"status":{"example":"ONLINE","format":"const","maxLength":12,"type":"string"}},"type":"object"},"deviceName":{"description":"device name\n","example":"AP 001","format":"const","maxLength":128,"type":"string"},"deviceType":{"enum":["ACCESSPOINT","SWITCH","GATEWAY","ALL"],"type":"string"},"geometry":{"$ref":"#/components/schemas/Geo__4ee94b04d313"},"geometryRelative":{"items":{"format":"double","maximum":180,"minimum":-180,"type":"number"},"maxItems":2,"minItems":2,"type":"array"},"id":{"description":"serial.\n","example":"AP00000021","format":"const","maxLength":20,"type":"string"},"lpFeatureType":{"description":"Feature type\n","example":"POINT","format":"const","maxLength":128,"type":"string"},"lpId":{"description":"serial.\n","example":"AP00000021","format":"const","maxLength":20,"type":"string"},"type":{"description":"device type.\n","example":"Access Point","format":"const","maxLength":512,"type":"string"}},"required":["id","type","deviceName","geometry","geometryRelative","accesspointProperties"],"type":"object"},"maxItems":9999,"type":"array"},"response":{"$ref":"#/components/schemas/response__4ee94b04d313"}},"required":["items"],"type":"object"},{"$ref":"#/components/schemas/PaginationResponseProperties__4ee94b04d313"}]},"PlannedDeviceResponseObject__ad445ad7c86c":{"allOf":[{"properties":{"items":{"items":{"properties":{"accesspointProperties":{"properties":{"model":{"example":"AP-635","format":"const","maxLength":32,"type":"string"},"partNumber":{"description":"device part number\n","example":"JX973A","format":"const","maxLength":12,"type":"string"},"radios":{"items":{"properties":{"band":{"description":"Band\n","example":"5 GHz","format":"const","maxLength":16,"type":"string"},"channel":{"description":"channel\n","example":"5 GHz","format":"const","maxLength":16,"type":"string"},"number":{"description":"Radio interface number\n","example":1,"format":"int32","maximum":10,"minimum":0,"type":"integer"},"txPower":{"description":"Tx power\n","example":"18 Dbm","format":"const","maxLength":16,"type":"string"}},"type":"object"},"maxItems":9999,"type":"array"}},"type":"object"},"deviceName":{"description":"device name\n","example":"AP 001","format":"const","maxLength":128,"type":"string"},"deviceType":{"enum":["ACCESSPOINT","SWITCH","GATEWAY","ALL"],"type":"string"},"geometryRelative":{"items":{"format":"double","maximum":180,"minimum":-180,"type":"number"},"maxItems":2,"minItems":2,"type":"array"},"id":{"description":"Id of a planned device.\n","example":"AP00000021","format":"const","maxLength":20,"type":"string"},"lpFeatureType":{"description":"Feature type\n","example":"POINT","format":"const","maxLength":128,"type":"string"},"type":{"description":"device type.\n","example":"Access Point","format":"const","maxLength":512,"type":"string"}},"required":["id","type","deviceName","geometryRelative","accesspointProperties"],"type":"object"},"maxItems":9999,"type":"array"},"response":{"$ref":"#/components/schemas/response__4ee94b04d313"}},"required":["items"],"type":"object"},{"$ref":"#/components/schemas/PaginationResponseProperties__4ee94b04d313"}]},"PoeBounceCxParsedOutput__e9e3ce3e7e7a":{"properties":{"ports":{"description":"The list of ports that were bounced.","type":"string"},"results":{"description":"The results of each port bounce operation.","items":{"$ref":"#/components/schemas/PoeBounceCxPoebouncerowresult__e9e3ce3e7e7a"},"type":"array"}},"title":"CX POE BOUNCE RESPONSE","type":"object"},"PoeBounceCxPoebouncerowresult__e9e3ce3e7e7a":{"properties":{"port":{"description":"The port number.","type":"string"},"status":{"description":"The status of the port after the bounce operation.","type":"string"}},"title":"CX POE BOUNCE ROW","type":"object"},"PoeBounceCxRequest__d4399c486239":{"properties":{"ports":{"description":"Port Number Required","type":"array"}},"required":["ports"],"title":"CX POE BOUNCE REQUEST","type":"object"},"PoeBounceCxResult__e9e3ce3e7e7a":{"allOf":[{"$ref":"#/components/schemas/AsyncOperationResultBase__03efdde95a47"},{"properties":{"output":{"allOf":[{"$ref":"#/components/schemas/PoeBounceCxParsedOutput__e9e3ce3e7e7a"}],"type":["object","null"]}},"type":"object"}],"title":"CX POE BOUNCE RESULT"},"PoeBounceHppcParsedOutput__18cb9bf0b651":{"properties":{"ports":{"description":"The list of ports that were bounced.","type":"string"},"results":{"description":"The results of each port bounce operation.","items":{"$ref":"#/components/schemas/PoeBounceHppcPoebouncerowresult__18cb9bf0b651"},"type":"array"}},"title":"AOS-S POE BOUNCE RESPONSE","type":"object"},"PoeBounceHppcPoebouncerowresult__18cb9bf0b651":{"properties":{"port":{"description":"The port number.","type":"string"},"status":{"description":"The status of the port after the bounce operation.","type":"string"}},"title":"AOS-S POE BOUNCE ROW","type":"object"},"PoeBounceHppcRequest__70acd77dd00b":{"properties":{"ports":{"description":"Port Number Required","type":"array"}},"required":["ports"],"title":"AOS-S POE BOUNCE REQUEST","type":"object"},"PoeBounceHppcResult__18cb9bf0b651":{"allOf":[{"$ref":"#/components/schemas/AsyncOperationResultBase__03efdde95a47"},{"properties":{"output":{"allOf":[{"$ref":"#/components/schemas/PoeBounceHppcParsedOutput__18cb9bf0b651"}],"type":["object","null"]}},"type":"object"}],"title":"AOS-S POE BOUNCE RESULT"},"PoeBounceMcParsedOutput__bc60235bc5bf":{"properties":{"ports":{"description":"The list of ports that were bounced.","type":"string"},"results":{"description":"The results of each port bounce operation.","items":{"$ref":"#/components/schemas/PoeBounceMcPoebouncerowresult__bc60235bc5bf"},"type":"array"}},"title":"GATEWAY POE BOUNCE RESPONSE","type":"object"},"PoeBounceMcPoebouncerowresult__bc60235bc5bf":{"properties":{"port":{"description":"The port number.","type":"string"},"status":{"description":"The status of the port after the bounce operation.","type":"string"}},"title":"GATEWAY POE BOUNCE ROW","type":"object"},"PoeBounceMcRequest__a8fc1c0cd247":{"properties":{"ports":{"description":"","type":"array"}},"required":["ports"],"title":"GATEWAY POE BOUNCE REQUEST","type":"object"},"PoeBounceMcResult__bc60235bc5bf":{"allOf":[{"$ref":"#/components/schemas/AsyncOperationResultBase__03efdde95a47"},{"properties":{"output":{"allOf":[{"$ref":"#/components/schemas/PoeBounceMcParsedOutput__bc60235bc5bf"}],"type":["object","null"]}},"type":"object"}],"title":"GATEWAY POE BOUNCE RESULT"},"Point__e40c06be8034":{"description":"point values","properties":{"x":{"format":"double","type":"number"},"y":{"format":"double","type":"number"}},"type":"object"},"Poor__a51bf4679e93":{"description":"The number of VLANs that are configured improperly.\n","example":1,"format":"int32","type":"integer"},"PortBounceCxParsedOutput__bb628fb1cc10":{"properties":{"ports":{"description":"The list of ports that were bounced.","type":"string"},"results":{"description":"The results of each port bounce operation.","items":{"$ref":"#/components/schemas/PortBounceCxPortbouncerowresult__bb628fb1cc10"},"type":"array"}},"title":"CX PORT BOUNCE RESPONSE","type":"object"},"PortBounceCxPortbouncerowresult__bb628fb1cc10":{"properties":{"port":{"description":"The port number.","type":"string"},"status":{"description":"The status of the port after the bounce operation.","type":"string"}},"title":"CX PORT BOUNCE ROW","type":"object"},"PortBounceCxRequest__320ac740feba":{"properties":{"ports":{"description":"Port Number Required","type":"array"}},"required":["ports"],"title":"CX PORT BOUNCE REQUEST","type":"object"},"PortBounceCxResult__bb628fb1cc10":{"allOf":[{"$ref":"#/components/schemas/AsyncOperationResultBase__03efdde95a47"},{"properties":{"output":{"allOf":[{"$ref":"#/components/schemas/PortBounceCxParsedOutput__bb628fb1cc10"}],"type":["object","null"]}},"type":"object"}],"title":"CX PORT BOUNCE RESULT"},"PortBounceHppcParsedOutput__75a5db3c309d":{"properties":{"ports":{"description":"The list of ports that were bounced.","type":"string"},"results":{"description":"The results of each port bounce operation.","items":{"$ref":"#/components/schemas/PortBounceHppcPortbouncerowresult__75a5db3c309d"},"type":"array"}},"title":"AOS-S PORT BOUNCE RESPONSE","type":"object"},"PortBounceHppcPortbouncerowresult__75a5db3c309d":{"properties":{"port":{"description":"The port number.","type":"string"},"status":{"description":"The status of the port after the bounce operation.","type":"string"}},"title":"AOS-S PORT BOUNCE ROW","type":"object"},"PortBounceHppcRequest__2c7cfaa27566":{"properties":{"ports":{"description":"Port Number Required","type":"array"}},"required":["ports"],"title":"AOS-S PORT BOUNCE REQUEST","type":"object"},"PortBounceHppcResult__75a5db3c309d":{"allOf":[{"$ref":"#/components/schemas/AsyncOperationResultBase__03efdde95a47"},{"properties":{"output":{"allOf":[{"$ref":"#/components/schemas/PortBounceHppcParsedOutput__75a5db3c309d"}],"type":["object","null"]}},"type":"object"}],"title":"AOS-S PORT BOUNCE RESULT"},"PortBounceMcParsedOutput__835ad6fe2d5c":{"properties":{"ports":{"description":"The list of ports that were bounced.","type":"string"},"results":{"description":"The results of each port bounce operation.","items":{"$ref":"#/components/schemas/PortBounceMcPortbouncerowresult__835ad6fe2d5c"},"type":"array"}},"title":"GATEWAY PORT BOUNCE RESPONSE","type":"object"},"PortBounceMcPortbouncerowresult__835ad6fe2d5c":{"properties":{"port":{"description":"The port number.","type":"string"},"status":{"description":"The status of the port after the bounce operation.","type":"string"}},"title":"GATEWAY PORT BOUNCE ROW","type":"object"},"PortBounceMcRequest__15ee60ab88b2":{"properties":{"ports":{"description":"","type":"array"}},"required":["ports"],"title":"GATEWAY PORT BOUNCE REQUEST","type":"object"},"PortBounceMcResult__835ad6fe2d5c":{"allOf":[{"$ref":"#/components/schemas/AsyncOperationResultBase__03efdde95a47"},{"properties":{"output":{"allOf":[{"$ref":"#/components/schemas/PortBounceMcParsedOutput__835ad6fe2d5c"}],"type":["object","null"]}},"type":"object"}],"title":"GATEWAY PORT BOUNCE RESULT"},"PortCollisionsTrend__fcccfb2a0f94":{"example":{"graph":{"keys":["collision","collision_percentage"],"samples":[{"data":[1,50],"timestamp":"2022-07-30T20:00:00Z"}],"samplingIntervalInMinutes":5},"id":"AP00000001/ports/0","metric":"collision","type":"network-monitoring/access-point-monitoring"},"properties":{"graph":{"properties":{"keys":{"description":"List of metrics which helps to evaluate the Collisions trends of a port.","example":["collision","collision_percentage"],"items":{"format":"const","type":"string"},"maxItems":10,"type":"array"},"samples":{"items":{"$ref":"#/components/schemas/GraphDataPoint__05867e444b37"},"maxItems":10000,"type":"array"},"samplingIntervalInMinutes":{"$ref":"#/components/schemas/SamplingIntervalInMinutes__05867e444b37"}},"required":["keys","samples","samplingIntervalInMinutes"],"type":"object"},"id":{"$ref":"#/components/schemas/PortIdentifier__05867e444b37"},"metric":{"description":"Metric for the Collisions trends of an access point port.","example":"collision","format":"const","maxLength":128,"type":"string"},"type":{"$ref":"#/components/schemas/Typeap__05867e444b37"}},"required":["metric","graph","id","type"],"type":"object"},"PortCrcTrend__f5cda28c0fa4":{"example":{"graph":{"keys":["crc","crc_percentage"],"samples":[{"data":[1,50],"timestamp":"2022-07-30T20:00:00Z"}],"samplingIntervalInMinutes":5},"id":"AP00000001/ports/0","metric":"crc","type":"network-monitoring/access-point-monitoring"},"properties":{"graph":{"properties":{"keys":{"description":"List of metrics which helps to evaluate the CRC trends of a port.","example":["crc","crc_percentage"],"items":{"format":"const","type":"string"},"maxItems":10,"type":"array"},"samples":{"items":{"$ref":"#/components/schemas/GraphDataPoint__05867e444b37"},"maxItems":10000,"type":"array"},"samplingIntervalInMinutes":{"$ref":"#/components/schemas/SamplingIntervalInMinutes__05867e444b37"}},"required":["keys","samples","samplingIntervalInMinutes"],"type":"object"},"id":{"$ref":"#/components/schemas/PortIdentifier__05867e444b37"},"metric":{"description":"Metric for the Crc trends of an access point port.","example":"crc","format":"const","maxLength":128,"type":"string"},"type":{"$ref":"#/components/schemas/Typeap__05867e444b37"}},"required":["metric","graph","id","type"],"type":"object"},"PortData__d67ae4720000":{"description":"Switch port information where the monitored AP is connected","examples":["Switch-1 name - 1/1/6"],"maxLength":128,"minLength":3,"type":"string"},"PortFramesTrend__951d038e6e20":{"example":{"graph":{"keys":["errors","drops","error_percentage","drop_percentage"],"samples":[{"data":[0,1,0,20],"timestamp":"2022-07-30T20:00:00Z"}],"samplingIntervalInMinutes":5},"id":"AP00000001/ports/0","metric":"frames","type":"network-monitoring/access-point-monitoring"},"properties":{"graph":{"properties":{"keys":{"description":"List of metrics which helps to evaluate the frames trends of a port.","example":["errors","drops","error_percentage","drop_percentage"],"items":{"format":"const","type":"string"},"maxItems":10,"type":"array"},"samples":{"items":{"$ref":"#/components/schemas/GraphDataPoint__05867e444b37"},"maxItems":10000,"type":"array"},"samplingIntervalInMinutes":{"$ref":"#/components/schemas/SamplingIntervalInMinutes__05867e444b37"}},"required":["keys","samples","samplingIntervalInMinutes"],"type":"object"},"id":{"$ref":"#/components/schemas/PortIdentifier__05867e444b37"},"metric":{"description":"Metric for the frames trends of an access point port.","example":"frames","format":"const","maxLength":128,"type":"string"},"type":{"$ref":"#/components/schemas/Typeap__05867e444b37"}},"required":["metric","graph","id","type"],"type":"object"},"PortIdentifier__05867e444b37":{"description":"Primary identifier of a port under an access point.\n","example":"AP00000001/ports/0","format":"const","maxLength":36,"type":"string"},"PortIndex__951d038e6e20":{"description":"The access point port number.\n","example":"1","format":"const","maxLength":1,"type":"string"},"PortListResponseV1__3db2e3f4369e":{"allOf":[{"properties":{"items":{"items":{"properties":{"accessVlan":{"$ref":"#/components/schemas/accessVlan__3db2e3f4369e"},"allowedVlan":{"$ref":"#/components/schemas/allowedVlan__3db2e3f4369e"},"connector":{"$ref":"#/components/schemas/connector__3db2e3f4369e"},"duplex":{"$ref":"#/components/schemas/duplex__3db2e3f4369e"},"id":{"$ref":"#/components/schemas/RadioIdentifier__2226a59a3aaf"},"isUplink":{"$ref":"#/components/schemas/isUplink__3db2e3f4369e"},"macAddress":{"$ref":"#/components/schemas/portMacAddress__3db2e3f4369e"},"name":{"$ref":"#/components/schemas/portName__3db2e3f4369e"},"nativeVlan":{"$ref":"#/components/schemas/nativeVlan__3db2e3f4369e"},"porStatus":{"$ref":"#/components/schemas/portStatus__3db2e3f4369e"},"portIndex":{"$ref":"#/components/schemas/PortIndex__951d038e6e20"},"speed":{"$ref":"#/components/schemas/speed__3db2e3f4369e"},"type":{"$ref":"#/components/schemas/Typeap__05867e444b37"},"vlanMode":{"$ref":"#/components/schemas/vlanMode__3db2e3f4369e"}},"required":["macAddress","name","portIndex","status","id","type"],"type":"object"},"maxItems":100,"type":"array"}},"required":["items"],"type":"object"},{"$ref":"#/components/schemas/PaginatedResponseap__2dcf9a625ef5"}],"example":{"count":1,"items":[{"accessVlan":"-","allowedVlan":"all","connector":"RJ45","duplex":"Full","id":"AP00000001/ports/0","isUplink":false,"macAddress":"80:76:8e:a5:10:00","name":"eth0","nativeVlan":"1","portIndex":0,"speed":"5000","status":"UP","type":"network-monitoring/access-point-monitoring","vlanMode":"-"}],"next":null,"total":1}},"PortMacAddressgw__988495a6329d":{"description":"The gateway port MAC address.\n","example":"11:22:33:44:55:66","maxLength":18,"type":"string"},"PortNumber__988495a6329d":{"description":"The port number.\n","example":1,"format":"int32","type":"integer"},"PortThroughputTrend__05867e444b37":{"example":{"graph":{"keys":["tx","rx"],"samples":[{"data":[10,12],"timestamp":"2022-07-30T20:00:00Z"}],"samplingIntervalInMinutes":5},"id":"AP00000001/ports/0","metric":"port_throughput","type":"network-monitoring/access-point-monitoring"},"properties":{"graph":{"properties":{"keys":{"description":"List of metrics which helps to evaluate the throughput trend of an access point port.\n","example":["tx","rx"],"items":{"format":"const","type":"string"},"maxItems":2,"type":"array"},"samples":{"items":{"$ref":"#/components/schemas/GraphDataPoint__05867e444b37"},"maxItems":10000,"type":"array"},"samplingIntervalInMinutes":{"$ref":"#/components/schemas/SamplingIntervalInMinutes__05867e444b37"}},"required":["keys","samples","samplingIntervalInMinutes"],"type":"object"},"id":{"$ref":"#/components/schemas/PortIdentifier__05867e444b37"},"metric":{"description":"Metric for the throughput trend of an access point port.","example":"port_throughput","format":"const","maxLength":128,"type":"string"},"type":{"$ref":"#/components/schemas/Typeap__05867e444b37"}},"required":["metric","graph","id","type"],"type":"object"},"PortType__988495a6329d":{"description":"The type of the port.\n","enum":["RJ45","SFP"],"example":"RJ45","type":"string"},"Port__284f33982989":{"description":"Specifies the port to which the client is connected, or null if not applicable.","example":null,"type":"string"},"PowerChangeCount__34350f7e707e":{"description":"The number of times the power has been changed in last 3 hours.\n","example":6,"format":"int32","minimum":0,"type":"integer"},"Power__34350f7e707e":{"description":"Specifies the power level in dBm at which the radio is operating.\n","example":13,"maxLength":16,"type":"string"},"PrivateIp__9683aa3d9df6":{"description":"Private IP of the uplink connected to the gateway.\n","example":"172.51.100.42","format":"ipv4","maxLength":15,"type":"string"},"Proto__7006262f8c4c":{"description":"The protocol of the threat.\n","examples":["TCP"],"maxLength":64,"type":"string"},"PublicIpAddress__a3f300af1174":{"description":"Public IP address of the swarm.","example":"104.36.250.13","format":"ipv4","maxLength":15,"type":"string"},"PublicIp__9683aa3d9df6":{"description":"IP address logged when the uplink is connected to the gateway.\n","example":"172.51.100.42","format":"ipv4","maxLength":15,"type":"string"},"RFChannelQualityTrend__ea71ed8f910a":{"example":{"graph":{"keys":["channel_quality"],"samples":[{"data":[92],"timestamp":"2022-07-30T20:00:00Z"}],"samplingIntervalInMinutes":5},"id":"AP00000001/radios/0","metric":"channel_quality","type":"network-monitoring/access-point-monitoring"},"properties":{"graph":{"properties":{"keys":{"description":"List of metrics which helps to evaluate the channel quality trends of a radio.","example":["channel_quality"],"items":{"format":"const","type":"string"},"maxItems":30,"type":"array"},"samples":{"items":{"$ref":"#/components/schemas/GraphDataPoint__05867e444b37"},"maxItems":36,"type":"array"},"samplingIntervalInMinutes":{"$ref":"#/components/schemas/SamplingIntervalInMinutes__05867e444b37"}},"required":["keys","samples","samplingIntervalInMinutes"],"type":"object"},"id":{"$ref":"#/components/schemas/RadioIdentifier__2226a59a3aaf"},"metric":{"description":"Performance metric for the channel quality of an access point radio.","example":"channel_quality","format":"const","maxLength":128,"type":"string"},"type":{"$ref":"#/components/schemas/Typeap__05867e444b37"}},"required":["metric","graph","id","type"],"type":"object"},"RFChannelUtilizationTrend__2226a59a3aaf":{"example":{"graph":{"keys":["tx","rx","non_wifi_interference"],"samples":[{"data":[4,35,40],"timestamp":"2022-07-30T20:00:00Z"}],"samplingIntervalInMinutes":5},"id":"AP00000001/radios/0","metric":"channel_utilization","type":"network-monitoring/access-point-monitoring"},"properties":{"graph":{"properties":{"keys":{"description":"List of metrics which helps to evaluate the channel utilization trends of a radio.","example":["tx","rx","non_wifi_interference"],"items":{"format":"const","type":"string"},"maxItems":30,"type":"array"},"samples":{"items":{"$ref":"#/components/schemas/GraphDataPoint__05867e444b37"},"maxItems":36,"type":"array"},"samplingIntervalInMinutes":{"$ref":"#/components/schemas/SamplingIntervalInMinutes__05867e444b37"}},"required":["keys","samples","samplingIntervalInMinutes"],"type":"object"},"id":{"$ref":"#/components/schemas/RadioIdentifier__2226a59a3aaf"},"metric":{"description":"Performance metric for the channel utilization of an access point radio.","example":"channel_utilization","format":"const","maxLength":128,"type":"string"},"type":{"$ref":"#/components/schemas/Typeap__05867e444b37"}},"required":["metric","graph","id","type"],"type":"object"},"RFFramesTrend__fc5c7ee1666d":{"example":{"graph":{"keys":["drops","retries"],"samples":[{"data":[2,2],"timestamp":"2022-07-30T20:00:00Z"}],"samplingIntervalInMinutes":5},"id":"AP00000001/radios/0","metric":"frames","type":"network-monitoring/access-point-monitoring"},"properties":{"graph":{"properties":{"keys":{"description":"List of metrics which helps to evaluate the frames trends of a radio.","example":["drops","retries"],"items":{"format":"const","type":"string"},"maxItems":10,"type":"array"},"samples":{"items":{"$ref":"#/components/schemas/GraphDataPoint__05867e444b37"},"maxItems":10000,"type":"array"},"samplingIntervalInMinutes":{"$ref":"#/components/schemas/SamplingIntervalInMinutes__05867e444b37"}},"required":["keys","samples","samplingIntervalInMinutes"],"type":"object"},"id":{"$ref":"#/components/schemas/RadioIdentifier__2226a59a3aaf"},"metric":{"description":"Metric for the frames trends of an access point radio.","example":"frames","format":"const","maxLength":128,"type":"string"},"type":{"$ref":"#/components/schemas/Typeap__05867e444b37"}},"required":["metric","graph","id","type"],"type":"object"},"RFNoiseFloorTrend__9d04c74d9734":{"example":{"graph":{"keys":["noise_floor"],"samples":[{"data":[-78],"timestamp":"2022-07-30T20:00:00Z"}],"samplingIntervalInMinutes":5},"id":"AP00000001/radios/0","metric":"noise_floor","type":"network-monitoring/access-point-monitoring"},"properties":{"graph":{"properties":{"keys":{"description":"List of metrics which helps to evaluate the noise floor trends of a radio.","example":["noise_floor"],"items":{"format":"const","type":"string"},"maxItems":10,"type":"array"},"samples":{"items":{"$ref":"#/components/schemas/GraphDataPoint__05867e444b37"},"maxItems":10000,"type":"array"},"samplingIntervalInMinutes":{"$ref":"#/components/schemas/SamplingIntervalInMinutes__05867e444b37"}},"required":["keys","samples","samplingIntervalInMinutes"],"type":"object"},"id":{"$ref":"#/components/schemas/RadioIdentifier__2226a59a3aaf"},"metric":{"description":"Metric for the noise floor trends of an access point radio.","example":"noise_floor","format":"const","maxLength":128,"type":"string"},"type":{"$ref":"#/components/schemas/Typeap__05867e444b37"}},"required":["metric","graph","id","type"],"type":"object"},"RadioBand__000172564380":{"description":"Radio band on which the signature was detected","enum":["UNSPECIFIED","BAND_2_4GHZ","BAND_5GHZ","BAND_6GHZ"],"examples":["BAND_2_4GHZ"],"type":"string"},"RadioBand__972dd6d46bea":{"description":"Specifies the radio band to which the client roamed.","example":"5 GHz","type":"string"},"RadioIdentifier__2226a59a3aaf":{"description":"Primary identifier for a radio under an access point.\n","example":"AP00000001/radios/0","format":"const","maxLength":36,"type":"string"},"RadioListResponseV1__34350f7e707e":{"allOf":[{"properties":{"items":{"items":{"properties":{"antenna":{"$ref":"#/components/schemas/Antenna__34350f7e707e"},"band":{"$ref":"#/components/schemas/Band__34350f7e707e"},"bandRange":{"$ref":"#/components/schemas/BandRange__34350f7e707e"},"bandwidth":{"$ref":"#/components/schemas/Bandwidth__34350f7e707e"},"channel":{"$ref":"#/components/schemas/Channel__34350f7e707e"},"channelChangeCount":{"$ref":"#/components/schemas/ChannelChangeCount__34350f7e707e"},"channelQuality":{"$ref":"#/components/schemas/ChannelQuality__34350f7e707e"},"channelUtilization":{"$ref":"#/components/schemas/ChannelUtilization__34350f7e707e"},"clientCount":{"$ref":"#/components/schemas/clientCount__2dcf9a625ef5","description":"The number of wireless clients associated to a radio. This field is supported on firmware versions 8.12.x.x and later, as well as 10.6.x.x and later."},"deviceName":{"$ref":"#/components/schemas/DeviceNameap__1ff3457b62c0"},"drops":{"$ref":"#/components/schemas/Drops__34350f7e707e"},"id":{"$ref":"#/components/schemas/RadioIdentifier__2226a59a3aaf"},"macAddress":{"description":"The radio MAC address.\n","example":"11:22:33:44:55:66","format":"const","maxLength":18,"type":"string"},"mode":{"$ref":"#/components/schemas/Mode__34350f7e707e"},"noiseFloor":{"$ref":"#/components/schemas/NoiseFloor__34350f7e707e"},"nonWifiInterference":{"$ref":"#/components/schemas/NonWifiInterference__34350f7e707e"},"power":{"$ref":"#/components/schemas/Power__34350f7e707e"},"powerChangeCount":{"$ref":"#/components/schemas/PowerChangeCount__34350f7e707e"},"radioNumber":{"$ref":"#/components/schemas/RadioNumber__34350f7e707e"},"radioType":{"$ref":"#/components/schemas/RadioType__34350f7e707e"},"retries":{"$ref":"#/components/schemas/Retries__34350f7e707e"},"rxUtilization":{"$ref":"#/components/schemas/RxUtilization__34350f7e707e"},"serialNumber":{"$ref":"#/components/schemas/SerialNumberap__1ff3457b62c0"},"siteId":{"$ref":"#/components/schemas/SiteIDap__34350f7e707e"},"siteName":{"$ref":"#/components/schemas/SiteNameap__34350f7e707e"},"spatialStream":{"$ref":"#/components/schemas/SpatialStream__34350f7e707e"},"status":{"description":"Represents the operational status of the radio.\n","enum":["UP","DOWN","DISABLED"],"example":"UP","maxLength":10,"type":"string"},"txUtilization":{"$ref":"#/components/schemas/TxUtilization__34350f7e707e"},"type":{"$ref":"#/components/schemas/Typeap__05867e444b37"}},"required":["serialNumber","macAddress","radioNumber","deviceName","status","band","siteId","id","type"],"type":"object"},"maxItems":1000,"type":"array"}},"required":["items"],"type":"object"},{"$ref":"#/components/schemas/PaginatedResponseap__2dcf9a625ef5"}],"example":{"count":1,"items":[{"antenna":"Internal","band":"2.4 GHz","bandRange":"","bandwidth":"20 MHz","channel":"8","channelChangeCount":9,"channelQuality":"99","channelUtilization":"87","clientCount":4,"deviceName":"ap_1","drops":"14.44","id":"AP00000001/radios/1","macAddress":"11:22:33:44:55:66","mode":"Client Access","noiseFloor":"-50","nonWifiInterference":"3","power":13,"powerChangeCount":6,"radioNumber":1,"radioType":"802.11n","retries":"0","rxUtilization":"41","serialNumber":"AP00000001","siteId":"6658275","siteName":"site1","spatialStream":"4x4:4","status":"UP","txUtilization":"21","type":"network-monitoring/access-point-monitoring"}],"next":"2","total":4}},"RadioMacAddress__54309c5cca60":{"description":"The MAC address of the radio.\n","example":"11:22:33:44:55:77","format":"const","maxLength":18,"type":"string"},"RadioMacAddressclients__284f33982989":{"description":"The radio MAC address to which the client is connected on the device.","example":"b8:3a:5a:46:ed:30","type":"string"},"RadioNumber__34350f7e707e":{"description":"The radio number within an access point\n","format":"int32","maximum":10,"minimum":0,"type":"integer"},"RadioThroughputTrend__cbb2c3e96d46":{"example":{"graph":{"keys":["tx","rx"],"samples":[{"data":[10,12],"timestamp":"2022-07-30T20:00:00Z"}],"samplingIntervalInMinutes":5},"id":"AP00000001/radios/0","metric":"radio_throughput","type":"network-monitoring/access-point-monitoring"},"properties":{"graph":{"properties":{"keys":{"description":"List of metrics which helps to evaluate the throughput trend of an access point radio.\n","example":["tx","rx"],"items":{"format":"const","type":"string"},"maxItems":2,"type":"array"},"samples":{"items":{"$ref":"#/components/schemas/GraphDataPoint__05867e444b37"},"maxItems":10000,"type":"array"},"samplingIntervalInMinutes":{"$ref":"#/components/schemas/SamplingIntervalInMinutes__05867e444b37"}},"required":["keys","samples","samplingIntervalInMinutes"],"type":"object"},"id":{"$ref":"#/components/schemas/RadioIdentifier__2226a59a3aaf"},"metric":{"description":"Metric for the throughput trend of an access point radio.","example":"radio_throughput","format":"const","maxLength":128,"type":"string"},"type":{"$ref":"#/components/schemas/Typeap__05867e444b37"}},"required":["metric","graph","id","type"],"type":"object"},"RadioType__34350f7e707e":{"description":"The type of wireless LAN used for the radios.\n","example":"802.11n","maxLength":16,"minimum":0,"type":"string"},"RecommendedVersion__c0c1228d8f7d":{"description":"The recommended firmware version for the device.\n","example":"8.5.2.0_59123","format":"const","maxLength":32,"type":"string"},"RemoveDeviceResponse__ac6b96ba4dce":{"properties":{"code":{"description":"status code.\n","example":"SUC-001","format":"const","maxLength":32,"type":"string"},"deviceRemoveResults":{"properties":{"code":{"description":"status code.\n","example":"SUC-001","format":"const","maxLength":32,"type":"string"},"failedDevices":{"items":{"description":"Device serial number or Planned device Id.\n","example":"AP00000002","format":"const","maxLength":16,"type":"string"},"maxItems":9999,"type":"array"},"message":{"description":"status message.\n","example":"Success","format":"const","maxLength":512,"type":"string"},"status":{"description":"final status.\n","example":"SUCCESS","format":"const","maxLength":32,"type":"string"},"successDevices":{"items":{"description":"Device serial number or Planned device Id\n","example":"AP00000001","format":"const","maxLength":16,"type":"string"},"maxItems":9999,"type":"array"}},"type":"object"},"message":{"description":"status message.\n","example":"Success","format":"const","maxLength":512,"type":"string"},"status":{"description":"final status.\n","example":"SUCCESS","format":"const","maxLength":32,"type":"string"}},"required":["data"],"type":"object"},"ReportFormat__70734de364b7":{"description":"Specifies the Export Type","enum":["CSV","PDF"],"examples":["CSV"],"type":"string"},"ReportFormats__70734de364b7":{"description":"Specifies the Export Preferences","examples":[["CSV","PDF"]],"items":{"$ref":"#/components/schemas/ReportFormat__70734de364b7"},"type":"array"},"ReportID__7d827151e05e":{"examples":["24833497"],"type":"string"},"ReportPeriodInput__c34075768619":{"properties":{"from":{"description":"Specifies the report period `from` date timestamp in UTC+0 timezone (RFC 3339 format).","examples":["2019-10-12T07:20:50Z"],"format":"date-time","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z$","type":"string"},"sliceDays":{"items":{"enum":["MON","TUE","WED","THU","FRI","SAT","SUN"],"type":"string"},"type":"array"},"sliceTime":{"properties":{"from":{"description":"Specifies the `from` slice time timestamp in UTC+0 timezone (RFC 3339 format).","examples":["2:50"],"format":"time","pattern":"^([01]?[0-9]|2[0-3]):([0-5]?[0-9])$","type":"string"},"to":{"description":"Specifies the `to` slice time timestamp in UTC+0 timezone (RFC 3339 format).","examples":["20:50"],"format":"time","pattern":"^([01]?[0-9]|2[0-3]):([0-5]?[0-9])$","type":"string"}},"type":"object"},"to":{"description":"Specifies the report period `to` date timestamp in UTC+0 timezone (RFC 3339 format).","examples":["2019-10-12T07:20:50Z"],"format":"date-time","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z$","type":"string"},"type":{"enum":["SNAPSHOT","LAST_DAY","LAST_WEEK","LAST_MONTH","CUSTOM_RANGE"],"type":"string"}},"required":["type"],"type":"object"},"ReportRun__c419fe321fd2":{"properties":{"createdAt":{"$ref":"#/components/schemas/CreatedAt__7d827151e05e"},"createdBy":{"$ref":"#/components/schemas/CreatedBy__7d827151e05e"},"exportDetails":{"description":"Specifies the Export Details","items":{"$ref":"#/components/schemas/ExportDetail__c419fe321fd2"},"type":"array"},"fromTs":{"description":"Specifies the report run start timestamp in UTC+0 timezone (RFC 3339 format).","examples":["2019-10-12T07:20:50Z"],"format":"date-time","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z$","type":"string"},"generation":{"$ref":"#/components/schemas/Generation__7d827151e05e"},"id":{"$ref":"#/components/schemas/ReportID__7d827151e05e"},"modifiedAt":{"deprecated":true,"description":"Specifies the report run modified timestamp in UTC+0 timezone (RFC 3339 format).","examples":["2019-10-12T07:20:50Z"],"format":"date-time","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z$","type":"string"},"status":{"$ref":"#/components/schemas/runStatus__c419fe321fd2"},"toTs":{"description":"Specifies the report run end timestamp in UTC+0 timezone (RFC 3339 format).","examples":["2019-10-12T07:20:50Z"],"format":"date-time","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z$","type":"string"},"type":{"description":"Type of the resource.","examples":["network-reporting/report-run"],"type":"string"},"updatedAt":{"$ref":"#/components/schemas/UpdatedAt__7d827151e05e"},"updatedBy":{"$ref":"#/components/schemas/UpdatedBy__7d827151e05e"}},"required":["id","type","generation","createdAt","updatedAt"],"type":"object"},"ReportScheduleInput__c34075768619":{"properties":{"endDate":{"description":"Specifies the `end` date timestamp in UTC+0 timezone (RFC 3339 format).","examples":["2019-10-12T07:20:50Z"],"format":"date-time","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z$","type":"string"},"recurrenceType":{"enum":["EVERY_MONTH","EVERY_WEEK","EVERY_DAY","ONE_TIME"],"type":"string"},"startDate":{"description":"Specifies the `start` date timestamp in UTC+0 timezone (RFC 3339 format).","examples":["2019-10-12T07:20:50Z"],"format":"date-time","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z$","type":"string"}},"required":["recurrenceType"],"type":"object"},"ReportSchedule__7d827151e05e":{"description":"Specifies the report Schedule","properties":{"completedRuns":{"description":"Total number of completed runs for the report schedule.","examples":[91],"type":"integer"},"lastRunStatus":{"$ref":"#/components/schemas/LastRunStatus__7d827151e05e"},"lastRunTs":{"$ref":"#/components/schemas/LastRunTs__7d827151e05e"},"nextRunTs":{"$ref":"#/components/schemas/NextRunTs__7d827151e05e"},"scheduleEnd":{"$ref":"#/components/schemas/ScheduleEnd__7d827151e05e"},"scheduleType":{"$ref":"#/components/schemas/ScheduleType__7d827151e05e"},"totalRuns":{"description":"Total number of runs that the report schedule has executed.","examples":[181],"type":"integer"}},"type":"object"},"ReportScope__7d827151e05e":{"description":"Specifies the scope type and target values for the report","properties":{"scopeType":{"examples":["sites","global"],"type":"string"},"values":{"examples":[["1234567","7554321"],["7554321"]],"type":"array"}},"type":"object"},"ReportType__7d827151e05e":{"description":"Specifies the particular report type (lowerCamelCase or lowercase). Valid values: appAnalytics, capacityPlanning, clientInventory, clientSession, custom, deviceUptime, licenses, mspcustomer, mspinventory, msplicense, mspsubscription, networkUsage, resourceUtilization, rfHealth, securityCompliance, visitor, wids. Refer to the Create Report operation documentation for complete details on supported types and their associated filters.","examples":["inventory","appAnalytics","clientInventory","custom"],"pattern":"^[a-z][a-zA-Z0-9]*$","type":"string"},"ReportValidation__66b457073e9b":{"properties":{"description":{"examples":["Minimum Value"],"type":"string"},"type":{"examples":["MIN"],"type":"string"},"values":{"items":{"examples":["60"],"type":"string"},"type":"array"}},"type":"object"},"Report__7d827151e05e":{"properties":{"createdAt":{"$ref":"#/components/schemas/CreatedAt__7d827151e05e"},"createdBy":{"$ref":"#/components/schemas/CreatedBy__7d827151e05e"},"generation":{"$ref":"#/components/schemas/Generation__7d827151e05e"},"id":{"$ref":"#/components/schemas/ReportID__7d827151e05e"},"lastModifiedAt":{"$ref":"#/components/schemas/LastModifiedAt__7d827151e05e"},"lastModifiedBy":{"$ref":"#/components/schemas/LastModifiedBy__7d827151e05e"},"name":{"$ref":"#/components/schemas/Name__70734de364b7"},"reportSchedule":{"$ref":"#/components/schemas/ReportSchedule__7d827151e05e"},"reportScope":{"$ref":"#/components/schemas/ReportScope__7d827151e05e"},"reportType":{"$ref":"#/components/schemas/ReportType__7d827151e05e"},"type":{"description":"Type of the resource.","examples":["network-reporting/report"],"type":"string"},"updatedAt":{"$ref":"#/components/schemas/UpdatedAt__7d827151e05e"},"updatedBy":{"$ref":"#/components/schemas/UpdatedBy__7d827151e05e"}},"required":["id","type","generation","createdAt","updatedAt"],"type":"object"},"ReportsMetadata__66b457073e9b":{"properties":{"createdAt":{"description":"Timestamp when the resource was created (RFC 3339 UTC).","examples":["2024-01-15T08:00:00.000Z"],"format":"date-time","readOnly":true,"type":"string"},"generation":{"description":"Monotonically increasing update counter.","examples":[1],"format":"int64","minimum":0,"type":"integer"},"id":{"description":"Unique identifier for the reports metadata resource.","examples":["123e4567-e89b-12d3-a456-426614174000"],"readOnly":true,"type":"string"},"kpiWidgets":{"items":{"$ref":"#/components/schemas/KPIWidget__66b457073e9b"},"type":"array"},"type":{"description":"Resource type identifier.","examples":["network-reporting/reports-meta"],"readOnly":true,"type":"string"},"updatedAt":{"description":"Timestamp when the resource was last updated (RFC 3339 UTC).","examples":["2024-01-15T08:00:00.000Z"],"format":"date-time","readOnly":true,"type":"string"}},"required":["id","type","generation","createdAt","updatedAt"],"type":"object"},"Responsesite__0bffa6fb51f5":{"properties":{"code":{"example":"SITE-HEALTH-SUCCESS-001","type":"string"},"message":{"description":"A message providing details about the result of the API request.\n","example":"Sites details fetched successfully","type":"string"},"status":{"description":"The status of the API response, indicating success or failure.","example":"SUCCESS","type":"string"}},"type":"object"},"Retries__34350f7e707e":{"description":"Indicates the retry frames percentage.\n","example":"11","maxLength":16,"type":"string"},"Risk__daca0a87b085":{"description":"A single risk level and its application count.\n","properties":{"count":{"description":"Number of applications at this risk level.\n","example":3,"format":"int32","minimum":0,"type":"integer"},"createdAt":{"description":"Creation timestamp in RFC 3339 format.\n","example":"2024-11-20T14:14:33Z","format":"date-time","type":"string"},"displayName":{"description":"Human-readable risk level name.\n","example":"High","format":"const","maxLength":64,"type":"string"},"generation":{"description":"Monotonically increasing update counter.\n","example":1,"format":"int64","minimum":0,"type":"integer"},"id":{"description":"Risk level identifier.\n","enum":["HIGH","MEDIUM","LOW"],"example":"HIGH","type":"string"},"type":{"description":"Resource type.\n","example":"network-monitoring/security-risk","format":"const","maxLength":64,"type":"string"},"updatedAt":{"description":"Last update timestamp in RFC 3339 format.\n","example":"2024-11-20T14:14:33Z","format":"date-time","type":"string"}},"required":["id","type","generation","createdAt","updatedAt","displayName","count"],"type":"object"},"RoamProtocol__972dd6d46bea":{"description":"Specifies the type of roam that has happened.","enum":["11r","okc","802.11"],"example":"11r","type":"string"},"RoamTime__972dd6d46bea":{"description":"Specifies the roaming latency in milliseconds.","example":"168","type":"string"},"Role__6b9c5f08b869":{"description":"Role of the device in the network-topology.","example":"Conductor","format":"const","maxLength":16,"type":"string"},"Roleap__98bb0f033247":{"description":"Role of the access point in the network-topology.\n","example":"Conductor","format":"const","maxLength":16,"type":"string"},"Roleclients__284f33982989":{"description":"Specifies the role of the client.","example":"wireless","type":"string"},"Rolegw__3b77411f6985":{"description":"Role of the gateway in the gateway cluster.\n","enum":["Isoleader","Leader","Member"],"example":"Isoleader","maxLength":9,"type":"string"},"RootLevelType__a39bf531822f":{"description":"Resource type.\n","example":"/network-services/v1/asset-tags","format":"const","maxLength":40,"type":"string"},"RxUtilization__34350f7e707e":{"description":"Represents the percentage of reception utilization by the radio.\n","example":41,"maxLength":16,"type":"string"},"Sample__0d6bfd060cf2":{"description":"Sample list for the trends.","properties":{"data":{"description":"Samples list.","example":["27.0,36.0"],"items":{"format":"float","type":"number"},"type":"array"},"timestamp":{"description":"Timestamp for the samples.","example":"1764592073958","type":"number"}},"type":"object"},"Samples__0052b7c55291":{"description":"An object containing data points for the corresponding timestamp.","properties":{"data":{"description":"A list of values corresponding to the keys.","items":{"format":"int64","type":"number"},"type":"array"},"timestamp":{"description":"Timestamp in epoch corresponding to the data values.","example":"1683284400000","format":"const","type":"string"}},"required":["data","timestamp"],"type":"object"},"SamplingIntervalInMinutes__05867e444b37":{"description":"**Sampling interval for trend data points (in minutes)**\n\nDetermined automatically by requested time range:\n\n| Time Range      | Interval |\n|-----------------|----------|\n| ≤ 24 hours      | 5 min    |\n| > 24 hours      | 180 min  |","example":5,"format":"int32","type":"integer"},"ScanStatus__306cd00aed2d":{"description":"The current scan state.\n\nPENDING - Scan request was accepted and awaiting scheduling by the system.\nABORTED - Scan request was delayed and could not be scheduled before the calculated start time\nCANCELLED - Scan request was cancelled by the user\nSCHEDULED - Scan request has been scheduled by the system and is awaiting the scan start time\nSCANNING - Scan is currently running (wifi network connectivity is currently unavailable)\nCOMPLETE - Scan has completed\n","enum":["PENDING","ABORTED","CANCELLED","SCHEDULED","SCANNING","COMPLETE"],"examples":["PENDING"],"format":"enum","type":"string"},"ScheduleEnd__7d827151e05e":{"description":"Specifies the scheduled end timestamp in UTC+0 timezone (RFC 3339 format).","examples":["2019-10-12T07:20:50Z"],"format":"date-time","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z$","type":"string"},"ScheduleType__7d827151e05e":{"description":"Specifies the Schedule types Once, Every Day, Every Week, Every Month etc.","enum":["ONE_TIME","EVERY_DAY","EVERY_WEEK","EVERY_MONTH"],"examples":["ONE_TIME"],"type":"string"},"ScopeId__cd77b09562fb":{"description":"Scope ID represents the unique identifier for the asset scope associated with the device. This identifier is used to categorize and manage assets within a specific scope, allowing for better organization and tracking of devices.","example":1296571332,"format":"const","maxLength":16,"type":"string"},"SecurityRiskInfoResponse__daca0a87b085":{"description":"Security risk breakdown for applications in the requested scope.\n","example":{"count":3,"items":[{"count":3,"createdAt":"2024-11-20T14:14:33Z","displayName":"High","generation":1,"id":"HIGH","type":"network-monitoring/security-risk","updatedAt":"2024-11-20T14:14:33Z"},{"count":12,"createdAt":"2024-11-20T14:14:33Z","displayName":"Medium","generation":1,"id":"MEDIUM","type":"network-monitoring/security-risk","updatedAt":"2024-11-20T14:14:33Z"},{"count":27,"createdAt":"2024-11-20T14:14:33Z","displayName":"Low","generation":1,"id":"LOW","type":"network-monitoring/security-risk","updatedAt":"2024-11-20T14:14:33Z"}],"offset":0,"total":3},"properties":{"count":{"description":"Number of risk level entries returned.\n","example":3,"format":"int32","minimum":0,"type":"integer"},"items":{"description":"List of risk level entries.\n","items":{"$ref":"#/components/schemas/Risk__daca0a87b085"},"type":"array"},"offset":{"$ref":"#/components/schemas/Offsetapp__7c5b5fe9ca66"},"total":{"$ref":"#/components/schemas/Totalapp__7c5b5fe9ca66"}},"required":["items","count","total","offset"],"type":"object"},"SerialNumber__05867e444b37":{"description":"The device serial number.","example":"AP00000001","format":"const","maxLength":16,"type":"string"},"SerialNumber__c0c1228d8f7d":{"description":"The device serial number.\n","example":"AP00000001","format":"const","maxLength":16,"type":"string"},"SerialNumberap__1ff3457b62c0":{"description":"The access point serial number.\n","example":"AP00000001","format":"const","maxLength":16,"type":"string"},"SerialNumbergw__1053ccf03958":{"description":"The gateway serial number.\n","example":"GW00000001","maxLength":16,"type":"string"},"SerialNumberopen__306cd00aed2d":{"description":"A device serial number.\n","examples":["AP00000001"],"format":"const","maxLength":16,"type":"string"},"SerialNumberswitch__134f5ffbb7f8":{"example":"AP00000001","format":"const","type":"string"},"ServiceUnavailableErrorDetails__4689c9697989":{"description":"Error details.\n","properties":{"debugId":{"description":"Used for troubleshooting.\n","example":"abc-123-456","format":"const","maxLength":128,"type":"string"},"errorCode":{"description":"An internal error code.\n","example":"HPE_GL_ERROR_SERVICE_UNAVAILABLE","format":"const","maxLength":128,"type":"string"},"httpStatusCode":{"description":"The HTTP status code.\n","example":503,"maximum":600,"minimum":400,"type":"integer"},"message":{"description":"Error message indicating the cause of the failure.\n","example":"Service unavailable","format":"const","maxLength":512,"type":"string"}},"required":["httpStatusCode","errorCode","message","debugId"],"type":"object"},"ServiceUnavailableError__0288a339fc72":{"description":"Service unavailable error details returned from the server.\n","properties":{"debugId":{"$ref":"#/components/schemas/DebugId__0288a339fc72"},"errorCode":{"description":"* A unique machine-friendly, but human-readable identifier for the error. It has prefix HPE_GL_.\n* For more details regarding error please refer to error message\n","enum":["HPE_GL_ERROR_SERVICE_UNAVAILABLE"],"examples":["HPE_GL_ERROR_SERVICE_UNAVAILABLE"],"maxLength":128,"type":"string"},"httpStatusCode":{"description":"HTTP status code.","examples":[503],"maximum":503,"minimum":503,"type":"integer"},"message":{"$ref":"#/components/schemas/ErrorMessage__0288a339fc72"}},"required":["httpStatusCode","errorCode","message","debugId"],"type":"object"},"ServiceUnavailableError__0a8a2717a0c0":{"description":"Service unavailable error details returned from the server.","properties":{"debugId":{"description":"Internal debug id.","format":"const","maxLength":128,"type":"string"},"errorCode":{"description":"Internal error code.","enum":["HPE_GL_NETWORK_SERVICES_SERVICE_UNAVAILABLE"],"maxLength":64,"type":"string"},"httpStatusCode":{"description":"HTTP status code.","maximum":503,"minimum":503,"type":"integer"},"message":{"description":"Error message indicating the cause of the failure.","format":"const","maxLength":512,"type":"string"}},"required":["errorCode","message","debugId","httpStatusCode"],"type":"object"},"SessionId__16fa337a67ef":{"description":"A unique system generated identifier for an ftm scan. This is a string representation of a uint64.\n","examples":[10737459117813731000],"format":"const","maxLength":128,"type":"string"},"SessionItems__8523b012636f":{"description":"This object gives details about the firewall session log.\n","example":{"applicationCategories":["Streaming"],"applicationName":"Netflix","blockedSessionReason":"Web Classification","certificateExpiryDate":1907231844072,"clientConnectionType":"wireless","clientMac":"b8:27:eb:61:34:f0","clientRole":"guest","clientUsername":"aruba-test@hpe.com","destinationIp":"13.107.42.14","destinationLocation":"United States","deviceType":"DEVICE_TYPE_AP","id":"1699550427000-10.53.110.142-b8:27:eb:61:34:f0-13.107.42.14","rxBytes":572522496,"serialNumber":"CN00000000","sessionType":"blocked","sourceIp":"10.53.110.142","ssidName":"guestWifi","timestamp":"1699551447000","tlsServerVersion":"tls_v1.2","tunneledTraffic":false,"txBytes":5433,"type":"network-monitoring/site-firewall-sessions","vlanId":12,"webCategories":"Streaming Media","webReputation":"Trustworthy","webUrl":"netflix.com"},"properties":{"applicationCategories":{"description":"List of categories that applications belong to.\n","example":["Streaming"],"items":{"format":"const","maxLength":256,"type":"string"},"maxItems":2147483647,"type":"array"},"applicationName":{"description":"The application that the client was accessing.\n","example":"Spotify","format":"const","maxLength":256,"type":"string"},"blockedSessionReason":{"description":"A string representing the reason of a blocked/denied session.\n","example":"Web Classification","format":"const","maxLength":256,"type":"string"},"certificateExpiryDate":{"description":"A string representing the timestamp of the certificate expiry date.\n","example":1907231844072,"format":"const","maxLength":256,"type":"string"},"clientConnectionType":{"description":"This represents whether the client is wireless or wired.\n","example":"wireless","format":"const","maxLength":10,"type":"string"},"clientHostname":{"description":"A string representing the source client hostname.\n","example":"host1","format":"const","maxLength":256,"type":"string"},"clientMac":{"description":"The MAC address of the client.\n","example":"b8:27:eb:61:34:f0","format":"const","maxLength":17,"type":"string"},"clientRole":{"description":"The role assigned to the client.\n","example":"guest","format":"const","maxLength":256,"type":"string"},"clientUsername":{"description":"The logged in username of the client.\n","example":"aruba-test@hpe.com","format":"const","maxLength":256,"type":"string"},"destinationIp":{"description":"The IP address of the destination.\n","example":"13.107.42.14","format":"ipv4","maxLength":15,"type":"string"},"destinationLocation":{"description":"The country name of the destination.\n","example":"United States","format":"const","maxLength":256,"type":"string"},"deviceType":{"description":"A string representing the device type that pertains to the current entry.\n","example":"DEVICE_TYPE_AP","format":"const","maxLength":256,"type":"string"},"id":{"description":"Resource ID: session_timestamp-src_ip-client_mac-dest_ip.\n","example":"1699550427000-10.53.110.142-b8:27:eb:61:34:f0-13.107.42.14","format":"string","maxLength":50,"type":"string"},"rxBytes":{"description":"The received bytes.\n","example":123456789,"format":"int64","maximum":9223372036854776000,"minimum":0,"type":"integer"},"serialNumber":{"description":"The serial number of the device reporting the session.\n","example":"CN00000000","format":"const","maxLength":20,"type":"string"},"sessionCount":{"description":"The number of blocked sessions.\n","example":100,"format":"int32","maxLength":256,"type":"integer"},"sessionType":{"description":"String representing whether the session was permitted or denied.\n","example":"allowed","format":"const","maxLength":7,"type":"string"},"sourceIp":{"description":"The IP address of the client.\n","example":"10.53.110.142","format":"ipv4","maxLength":15,"type":"string"},"ssidName":{"description":"The SSID that the client was connected to.\n","example":"guestWifi","format":"const","maxLength":256,"type":"string"},"timestamp":{"description":"The timestamp of the session in epoch milliseconds.\n","example":"1699550427000","format":"const","maxLength":13,"type":"string"},"tlsServerVersion":{"description":"A string representing the TLS version.\n","example":"tls_v1.2","format":"const","maxLength":256,"type":"string"},"tunneledTraffic":{"description":"Boolean value indicating whether the client traffic was tunneled to the gateway or not.\n","example":"false","format":"const","type":"boolean"},"txBytes":{"description":"The transmitted bytes.\n","example":123456789,"format":"int64","maximum":9223372036854776000,"minimum":0,"type":"integer"},"type":{"description":"Resource type.\n","example":"network-monitoring/site-firewall-sessions","format":"const","maxLength":13,"type":"string"},"vlanId":{"description":"The client VLAN.\n","example":"12","format":"int32","maximum":10000,"minimum":0,"type":"integer"},"webCategories":{"description":"The category that the web URL belongs to.\n","example":"Web","format":"const","maxLength":256,"type":"string"},"webReputation":{"description":"Value representing the risk level of the web URL.\n","example":"Trustworthy","format":"const","maxLength":256,"type":"string"},"webUrl":{"description":"The URL of the application that was accessed by the client.\n","example":"netflix.com","format":"const","maxLength":256,"type":"string"}},"required":["type","id"],"type":"object"},"SessionLogResponse__8523b012636f":{"description":"List of firewall session logs.\n","example":{"count":1,"items":[{"applicationCategories":["Streaming"],"applicationName":"Netflix","blockedSessionReason":"Web Classification","certificateExpiryDate":1907231844072,"clientConnectionType":"wireless","clientMac":"b8:27:eb:61:34:f0","clientRole":"guest","clientUsername":"aruba-test@hpe.com","destinationIp":"13.107.42.14","destinationLocation":"United States","deviceType":"DEVICE_TYPE_AP","id":"1699550427000-10.53.110.142-b8:27:eb:61:34:f0-13.107.42.14","rxBytes":572522496,"serialNumber":"CN00000000","sessionType":"blocked","sourceIp":"10.53.110.142","ssidName":"guestWifi","timestamp":"1699551447000","tlsServerVersion":"tls_v1.2","tunneledTraffic":false,"txBytes":5433,"type":"network-monitoring/site-firewall-sessions","vlanId":12,"webCategories":"Streaming Media","webReputation":"Trustworthy","webUrl":"netflix.com"}],"next":"NyBErRdk6czGUyDAX5Cp","total":101},"maxItems":1000,"properties":{"count":{"$ref":"#/components/schemas/Countapp__7dced1181a4d"},"items":{"items":{"$ref":"#/components/schemas/SessionItems__8523b012636f"},"type":"array"},"next":{"$ref":"#/components/schemas/Next__21874c7bfa12"},"offset":{"$ref":"#/components/schemas/Offsetapp__7c5b5fe9ca66"},"total":{"$ref":"#/components/schemas/Totalfirewall__4689c9697989"}},"required":["items","next","count","total"],"type":"object"},"SetActiveAlertsRequest__1aced8f63fe1":{"description":"Request body for setting alerts to active status.\n","properties":{"keys":{"description":"List of alert keys to set to active.\n","example":["22071893000:47765082406","22071893000:47764775046"],"items":{"type":"string"},"type":"array"}},"required":["keys"],"type":"object"},"SetPriorityAlertsRequest__6c8ef7be4c48":{"description":"Request body for setting alert priority.\n","properties":{"keys":{"description":"List of alert keys to update priority.\n","example":["ad4c9f5b-25d2-37f9-a4ed-fc0e6b0f5825","bd5c9f5b-35d2-47f9-b4ed-fc0e6b0f5826"],"items":{"type":"string"},"type":"array"},"priority":{"description":"The priority level to set for the alerts.\n","enum":["Very High","High","Medium","Low","Very Low"],"example":"High","type":"string"}},"required":["keys","priority"],"type":"object"},"Severity__7006262f8c4c":{"description":"The severity of the threat.\n","examples":["Informational"],"maxLength":64,"type":"string"},"ShowCommandOutput__8cc1ef82c4a3":{"properties":{"commands":{"description":"The original commands sent by the user in order.","items":{"type":"string"},"type":"array"},"results":{"description":"Command outputs in the same order as the commands array.","items":{"$ref":"#/components/schemas/ShowCommandResultItem__8cc1ef82c4a3"},"type":"array"}},"required":["commands","results"],"title":"RUN SHOW COMMANDS OUTPUT","type":"object"},"ShowCommandRequest__1070839fcc3b":{"properties":{"commands":{"description":"List of CLI commands to run; each MUST start with 'show '.","items":{"description":"A device CLI command that begins with 'show '.","pattern":"^\\s*show\\b.+","type":"string"},"maxItems":20,"type":"array"}},"required":["commands"],"title":"RUN SHOW COMMANDS REQUEST","type":"object"},"ShowCommandResultItem__8cc1ef82c4a3":{"properties":{"command":{"description":"The original command sent by the user.","type":"string"},"output":{"description":"The raw text response returned by the device for the given command.","type":"string"}},"required":["output","command"],"title":"RUN SHOW COMMAND RESULT ITEM","type":"object"},"ShowCommandResult__8cc1ef82c4a3":{"allOf":[{"$ref":"#/components/schemas/AsyncOperationResultBase__03efdde95a47"},{"properties":{"output":{"allOf":[{"$ref":"#/components/schemas/ShowCommandOutput__8cc1ef82c4a3"}],"type":["object","null"]}},"type":"object"}],"title":"RUN SHOW COMMAND RESULT"},"ShowCommandsCategory__3ba348bd5d1e":{"properties":{"categoryName":{"description":"A logical category/group name for the commands.","type":"string"},"commands":{"description":"Commands under this category.","items":{"$ref":"#/components/schemas/ShowCommandsCommand__3ba348bd5d1e"},"type":"array"},"count":{"description":"Number of commands under this category.","type":"integer"}},"required":["categoryName","count","commands"],"title":"SHOW COMMANDS CATEGORY","type":"object"},"ShowCommandsCommand__3ba348bd5d1e":{"properties":{"command":{"description":"A device CLI command that begins with 'show '.","type":"string"}},"required":["command"],"title":"SHOW COMMAND","type":"object"},"ShowCommandsResponse__3ba348bd5d1e":{"items":{"$ref":"#/components/schemas/ShowCommandsCategory__3ba348bd5d1e"},"title":"SHOW COMMANDS LIST","type":"array"},"Signal__d67ae4720000":{"description":"RSSI Signal Strength of the Rogue AP (in dBm)","examples":[-75],"exclusiveMaximum":0,"type":"number"},"SignatureId__7006262f8c4c":{"description":"The signature ID of the threat.\n","examples":[2016141],"format":"int64","type":"integer"},"SignatureName__7006262f8c4c":{"description":"The signature name of the threat.\n","examples":["12345"],"maxLength":256,"type":"string"},"SignatureType__000172564380":{"description":"Type of signature","enum":["EVENT_ID_IMPERSONATION_ATTACK","EVENT_ID_ANOMALY_AP","EVENT_ID_ASSOC_RESP_FLOOD","EVENT_ID_DEAUTH_DISASSOC_FLOOD","EVENT_ID_ANOMALY_STA","EVENT_ID_POT_ANOMALIES","AP_SPOOFING","WINDOWS_BRIDGE_AP","WINDOWS_BRIDGE_STA","ADHOC_BRIDGE_AP","ADHOC_BRIDGE_STA","MITM_DETECT","ADHOC_USING_VALID_SSID","MALFORMED_LARGE_DURATION","ADHOC_NETWORK","VALID_SSID_VIOLATION","WIRELESS_BRIDGE","HT_40MHZ_INTOLERANCE_AP","HT_40MHZ_INTOLERANCE_STA","HT_GREENFIELD_SUPPORTED","FAKE_AP_FLOOD","FAKE_CLIENT_FLOOD","BAD_WEP","BAD_WEP_WEAK_KEY","CTS_RATE_ANOMALY","RTS_RATE_ANOMALY","INVALID_ADDRESS_COMBINATION","MALFORMED_HTIE","MALFORMED_ASSOC_REQ","MALFORMED_AUTH_FRAME","OVERFLOW_IE","OVERFLOW_EAPOL_KEY","BEACON_WRONG_CHANNEL","INVALID_MAC_OUI_AP","INVALID_MAC_OUI_STA","GHOSTTUNNEL_SERVER","OMERTA_ATTACK","FATA_JACK","BLOCK_ACK","HOTSPOTTER","VALID_CLIENT_UNENCRYPTED","POWER_SAVE_DOS","EAP_RATE_ANOMALY","CHOPCHOP","TKIP_REPLAY","WPA_FT_ATTACK","GHOSTTUNNEL_CLIENT","VALID_STA_MISASSOCIATION","CHANNEL_RATE_ANOMALY","VALID_STA_VIOLATION","CHANNEL_MISCONFIGURATION","OUI_MISCONFIGURATION","SSID_MISCONFIGURATION","WEP_MISCONFIGURATION","STA_WEAK_WEP_VIOLATION","AP_INTERFERENCE_DETECTED","AP_INTERFERENCE_CLEARED","STA_INTERFERENCE_DETECTED","STA_INTERFERENCE_CLEARED","FRAME_RECEIVE_ERROR_RATE_EXCEEDED","FRAME_RETRY_RATE_EXCEEDED","FRAME_FRAGMENTATION_RATE_EXCEEDED","FRAME_LOW_SPEED_RATE_EXCEEDED","FRAME_BANDWIDTH_RATE_EXCEEDED","FRAME_NONUNICAST_RATE_EXCEEDED","WPA_MISCONFIGURATION","SIGNATURE_MATCH","STA_ASSOC_TO_UAP","STA_UNASSOC_FROM_UAP","CHANNEL_FRAME_RETRY_RATE_EXCEEDED","CHANNEL_FRAME_ERROR_RATE_EXCEEDED","CHANNEL_FRAME_FRAGMENTATION_RATE_EXCEEDED","AP_DEAUTH_CONTAINMENT","AP_WIRED_CONTAINMENT","STA_WIRED_CONTAINMENT","AP_TAGGED_WIRED_CONTAINMENT","STA_TAGGED_WIRED_CONTAINMENT","TARPIT_CONTAINMENT","WIRELESS_HOSTED_NETWORK","CLIENT_ASSOC_HOSTED_NETWORK","WIRELESS_NETWORK_HOST_CONTAINMENT","ENHANCE_ADHOC_NETWORK","IBSS_USING_VALID_SSID","PHONY_BSSID_DETECTED","PEER_ASSOC_TO_WIFI","PEER_ASSOC_TO_WIFI_CONTAINMENT","STA_REPEAT_WEP_VIOLATION","SIGN_NETSTUMBLER","SIGN_ASLEAP","SIGN_NULL_PROBE_RESP","SIGN_AIRJACK","SIGN_DEAUTH_BCAST","SIGN_DISASSOC_BCAST","SIGN_WELLENREITER","CLIENT_ASSOC_WRONG_CHANNEL","CLIENT_DEAUTH_CONTAINMENT","WIRELESS_HOSTED_NETWORK_CONTAINMENT"],"examples":["WPA_FT_ATTACK"],"type":"string"},"SiteHealthType__0bffa6fb51f5":{"description":"The type of the resource.\n","example":"network-monitoring/site-health","type":"string"},"SiteHealth__0bffa6fb51f5":{"properties":{"clientTypes":{"items":{"$ref":"#/components/schemas/ClientEntityNameHealth__0bffa6fb51f5"},"type":"array"},"compute":{"items":{"$ref":"#/components/schemas/ComputeEntityNameHealth__0bffa6fb51f5"},"type":"array"},"deviceTypes":{"items":{"$ref":"#/components/schemas/EntityNameHealth__0bffa6fb51f5"},"type":"array"},"health":{"$ref":"#/components/schemas/Health__0bffa6fb51f5"},"id":{"$ref":"#/components/schemas/Idsite__0bffa6fb51f5"},"reasons":{"items":{"$ref":"#/components/schemas/HealthReason__0bffa6fb51f5"},"type":"array"},"response":{"$ref":"#/components/schemas/Responsesite__0bffa6fb51f5"},"type":{"$ref":"#/components/schemas/SiteHealthType__0bffa6fb51f5"}},"required":["id","type","response","reasons","health","deviceTypes","clientTypes","compute"],"type":"object"},"SiteID__05867e444b37":{"description":"The site ID to which the device belongs.\n","examples":["12345"],"maxLength":128,"type":"string"},"SiteIDap__34350f7e707e":{"description":"The unique identifier of the site to which the access point has been assigned.","example":"24833497","format":"const","maxLength":128,"type":"string"},"SiteIDdevice__6b9c5f08b869":{"description":"ID of the site in which the device is present.","example":"24833497","format":"const","maxLength":128,"type":"string"},"SiteIDfirmware__c0c1228d8f7d":{"description":"ID of the Site in which the device is present.\n","example":"24833497","format":"const","maxLength":128,"type":"string"},"SiteIDgw__3b77411f6985":{"example":"24833497","maxLength":128,"type":"string"},"SiteId__0052b7c55291":{"example":"123682","format":"const","maxLength":128,"type":"string"},"SiteIdasset__a39bf531822f":{"description":"Site ID associated with the Asset Tag.","examples":["3b5b-0e6c-4b73-9f6e-4e895a080190"],"format":"uuid","maxLength":128,"type":"string"},"SiteIdclients__284f33982989":{"description":"A unique identifier for the site where the client is located.","example":2778382,"type":"string"},"SiteIddeviceloc__6a214df6704a":{"description":"Site ID associated with the device commonly in UUID format.\n","examples":["3b5b-0e6c-4b73-9f6e-4e895a080190"],"format":"uuid","maxLength":128,"type":"string"},"SiteIdopen__16fa337a67ef":{"description":"The Site ID associated with the device commonly in UUID format.\n","examples":["3b5b-0e6c-4b73-9f6e-4e895a080190"],"format":"uuid","maxLength":128,"type":"string"},"SiteIdsite__0bffa6fb51f5":{"description":"Identifier of the Site for which site information is requested.","example":"00001","format":"uuid","maxLength":128,"type":"string"},"SiteIdswitch__134f5ffbb7f8":{"example":"24833497","format":"const","maxLength":128,"type":"string"},"SiteIdtopology__004689200476":{"description":"Id of a site where devices are associated.","example":"24833497","format":"uuid","maxLength":16,"type":"string"},"SiteIdwids__000172564380":{"description":"Site ID associated with the SSID.\n","examples":["82479680478"],"maxLength":128,"type":"string"},"SiteIdwifi__3f58b16772b5":{"description":"Site ID associated with the client.\n","example":"1033566193","format":"const","maxLength":36,"type":"string"},"SiteInfo__dfe680474bd8":{"description":"Site information with ID and name","properties":{"scopeId":{"description":"Unique identifier for the site","example":"12345678","maxLength":16,"type":"string"},"scopeName":{"description":"Name of the site","example":"HPE India","maxLength":256,"type":"string"}},"required":["scopeId"],"type":"object"},"SiteName__05867e444b37":{"description":"The site name to which the device belongs.\n","examples":["site1"],"maxLength":128,"type":"string"},"SiteName__c0c1228d8f7d":{"description":"Name of the Site in which the device is present.\n","example":"Site1","format":"const","maxLength":256,"type":"string"},"SiteNameap__34350f7e707e":{"description":"SiteName represents the name of the site where the device is located. This name is used to identify and manage devices based on their physical location, allowing for better organization and tracking.","example":"site1","format":"const","maxLength":256,"type":"string"},"SiteNameasset__a39bf531822f":{"description":"The name of the site.","example":"Main Campus","type":"string"},"SiteNameclients__284f33982989":{"description":"The name of the site where the client is located.","example":"Site-1","type":"string"},"SiteNamedevice__6b9c5f08b869":{"description":"Site name represents the name of the site where the device is located. This name is used to identify and manage devices based on their physical location, allowing for better organization and tracking.","example":"site_test_new","format":"const","maxLength":256,"type":"string"},"SiteNamegw__3b77411f6985":{"description":"The site to which the gateway is assigned.\n","example":"site_1","maxLength":256,"type":"string"},"SiteNamesite__7f65987649fe":{"description":"Name of the Site.\n","example":"12345678","type":"string"},"SiteNametopology__f6c586a7da1c":{"description":"Name of the site where the device is located.","example":"Site1","format":"const","maxLength":256,"type":"string"},"SiteNamewids__000172564380":{"description":"The name of the site.","examples":["Main Campus"],"maxLength":128,"type":"string"},"SiteSummary__097c7eac5a23":{"properties":{"deviceSummary":{"$ref":"#/components/schemas/DeviceSummary__097c7eac5a23"},"floorsSummary":{"items":{"$ref":"#/components/schemas/FloorSummary__097c7eac5a23"},"maxItems":9999,"type":"array"},"id":{"description":"siteId associated with the device commonly in UUID format.\n","example":"3b5b-0e6c-4b73-9f6e-4e895a080190","format":"const","maxLength":20,"type":"string"},"siteId":{"description":"Site ID associated with the device commonly in UUID format.\n","example":"3b5b-0e6c-4b73-9f6e-4e895a080190","format":"const","maxLength":128,"type":"string"},"type":{"description":"API type.\n","example":"network-monitoring/sitemap-summary","format":"const","maxLength":512,"type":"string"}},"required":["id","type","deviceSummary"],"type":"object"},"SitesClientHealthType__7f65987649fe":{"description":"The type of the resource.\n","example":"network-monitoring/sites-client-health","type":"string"},"SitesClientHealth__7f65987649fe":{"allOf":[{"properties":{"count":{"$ref":"#/components/schemas/Count__c0c1228d8f7d"},"items":{"items":{"properties":{"clientTypes":{"items":{"$ref":"#/components/schemas/ClientTypesHealth__7f65987649fe"},"type":"array"},"id":{"$ref":"#/components/schemas/Idsite__0bffa6fb51f5"},"siteName":{"$ref":"#/components/schemas/SiteNamesite__7f65987649fe"},"type":{"$ref":"#/components/schemas/SitesClientHealthType__7f65987649fe"}},"required":["id","type","siteName","clientTypes"],"type":"object"},"type":"array"},"offset":{"$ref":"#/components/schemas/Offsetsite__7f65987649fe"},"response":{"$ref":"#/components/schemas/Responsesite__0bffa6fb51f5"},"total":{"$ref":"#/components/schemas/Totalsite__7f65987649fe"}},"required":["items","count","total","response","offset"],"type":"object"}]},"SitesDeviceHealthType__ac50e32cc892":{"description":"The type of the resource.\n","example":"network-monitoring/sites-device-health","type":"string"},"SitesDeviceHealth__ac50e32cc892":{"allOf":[{"properties":{"count":{"$ref":"#/components/schemas/Count__c0c1228d8f7d"},"items":{"items":{"properties":{"deviceTypes":{"items":{"$ref":"#/components/schemas/DeviceTypesHealth__ac50e32cc892"},"type":"array"},"id":{"$ref":"#/components/schemas/Idsite__0bffa6fb51f5"},"siteName":{"$ref":"#/components/schemas/SiteNamesite__7f65987649fe"},"type":{"$ref":"#/components/schemas/SitesDeviceHealthType__ac50e32cc892"}},"required":["id","type","siteName","deviceTypes"],"type":"object"},"type":"array"},"offset":{"$ref":"#/components/schemas/Offsetsite__7f65987649fe"},"response":{"$ref":"#/components/schemas/Responsesite__0bffa6fb51f5"},"total":{"$ref":"#/components/schemas/Totalsite__7f65987649fe"}},"required":["items","count","total","response","offset"],"type":"object"}]},"SitesHealthType__edaaa4919013":{"description":"The type of the resource.\n","example":"network-monitoring/sites-health","type":"string"},"SitesHealth__edaaa4919013":{"allOf":[{"properties":{"count":{"$ref":"#/components/schemas/Count__c0c1228d8f7d"},"items":{"items":{"properties":{"address":{"$ref":"#/components/schemas/Address__edaaa4919013"},"alerts":{"properties":{"groups":{"items":{"$ref":"#/components/schemas/AlertGroup__edaaa4919013"},"type":"array"},"totalCount":{"example":15,"type":"integer"}},"type":"object"},"clients":{"$ref":"#/components/schemas/EntityCountHealth__edaaa4919013"},"devices":{"$ref":"#/components/schemas/EntityCountHealth__edaaa4919013"},"health":{"$ref":"#/components/schemas/Health__0bffa6fb51f5"},"id":{"$ref":"#/components/schemas/Idsite__0bffa6fb51f5"},"reasons":{"items":{"$ref":"#/components/schemas/HealthReason__0bffa6fb51f5"},"type":"array"},"siteName":{"$ref":"#/components/schemas/SiteNamesite__7f65987649fe"},"type":{"$ref":"#/components/schemas/SitesHealthType__edaaa4919013"}},"required":["id","type","siteName","address","alerts","reasons","health","devices","clients"],"type":"object"},"type":"array"},"offset":{"$ref":"#/components/schemas/Offsetsite__7f65987649fe"},"response":{"$ref":"#/components/schemas/Responsesite__0bffa6fb51f5"},"total":{"$ref":"#/components/schemas/Totalsite__7f65987649fe"}},"required":["items","count","total","response","offset"],"type":"object"}]},"SitesSummaryResponse__dfe680474bd8":{"description":"Response containing summary of sites","properties":{"count":{"description":"Number of sites returned in this page (respects limit and offset parameters)","example":10,"format":"int32","maximum":10000,"minimum":0,"type":"integer"},"items":{"items":{"$ref":"#/components/schemas/SiteInfo__dfe680474bd8"},"type":"array"},"offset":{"default":0,"description":"Specifies the number of results to skip before returning results. (Default: 0)","example":0,"format":"int32","maximum":10000,"minimum":0,"type":"integer"},"total":{"description":"Total number of sites matching the filter (unaffected by limit and offset)","example":10,"format":"int32","maximum":10000,"minimum":0,"type":"integer"}},"type":"object"},"Snr__284f33982989":{"description":"Specifies the signal-to-noise ratio (SNR) of the client's wireless connection. Higher values indicate better signal quality.","example":42,"type":"integer"},"SortV1__c0c1228d8f7d":{"example":"deviceType,upgradeStatus desc","format":"const","maxLength":256,"type":"string"},"Sort__6b9c5f08b869":{"example":"deviceName,deployment desc","format":"const","maxLength":256,"type":"string"},"Sort__6ff1f6639f14":{"default":"alerts DESC","format":"const","maxLength":256,"type":"string"},"Sort__f20300aab7a0":{"default":"totalVisitorCount DESC","example":"totalVisitorCount ASC","format":"const","type":"string"},"SourceAp__972dd6d46bea":{"description":"Specifies the AP name from which the client roamed.","example":"QNRR000002","type":"string"},"SourceIpAddress__0f1d40c88b6b":{"description":"The source IP address of the tunnel.","example":"10.0.0.1","format":"const","maxLength":64,"type":"string"},"SourceIpAddressgw__2ca376caec3f":{"description":"IP address from which the tunnel originates.\n","example":"172.51.100.42","format":"ipv4","maxLength":15,"type":"string"},"SourceTypeFilterItem__2c64e622674f":{"description":"Source type filter item with count information.","properties":{"count":{"description":"Number of events from this source type.","example":32,"minimum":0,"type":"integer"},"sourceType":{"description":"Source type that generated the events.","enum":["Access Point","Switch","Gateway","Wireless Client","Wired Client","Bridge"],"example":"Access Point","type":"string"}},"required":["sourceType","count"],"type":"object"},"Source__13edfa6d725b":{"description":"Email ID of the user executed the operation.\n","example":"System","maxLength":256,"type":"string"},"SpatialStream__34350f7e707e":{"description":"Number of spatial data streams supported by the radio.\n","example":"4x4:4","maxLength":16,"minimum":0,"type":"string"},"Speedgw__988495a6329d":{"description":"The data transmission rate of the port in Mbps.\n","example":1000,"format":"int32","type":"integer"},"SpeedtestApParsedOutput__fddb7d22dcc0":{"properties":{"downstreamBandwidthInMbps":{"description":"The downstream bandwidth in Mbps.","type":"string"},"downstreamBytes":{"description":"The downstream speed in bytes.","type":"string"},"downstreamDatagrams":{"description":"The number of downstream datagrams.","type":"string"},"downstreamJitter":{"description":"The jitter for downstream.","type":"string"},"downstreamLostPackets":{"description":"Lost packets count for downstream.","type":"string"},"downstreamRetries":{"description":"The number of retries for downstream.","type":"string"},"intervalInSeconds":{"description":"The interval of the speed test.","type":"string"},"iperfServerAddress":{"description":"The server address used for the speed test.","type":"string"},"protocol":{"description":"The protocol used for the speed test.","type":"string"},"serverPort":{"description":"The server port used for the speed test.","type":"string"},"upstreamBandwidthInMbps":{"description":"The upstream bandwidth in Mbps.","type":"string"},"upstreamBytes":{"description":"The upstream speed in bytes.","type":"string"},"upstreamDatagrams":{"description":"The number of upstream datagrams.","type":"string"},"upstreamJitter":{"description":"The jitter for upstream.","type":"string"},"upstreamLostPackets":{"description":"Lost packets count for upstream.","type":"string"},"upstreamRetries":{"description":"The number of retries for upstream.","type":"string"}},"title":"AP SPEEDTEST RESPONSE","type":"object"},"SpeedtestApRequest__6778d358380c":{"properties":{"bandwidth":{"description":"Configures the bandwidth length in Kbps","type":"integer"},"includeReverse":{"description":"Reverse","type":"boolean"},"iperfServerAddress":{"description":"IP Address Required","type":"string"},"omit":{"description":"Enter the number of initial seconds to omit.","maximum":5,"minimum":1,"type":"integer"},"parallel":{"description":"","maximum":30,"minimum":1,"type":"integer"},"protocol":{"description":"","enum":["tcp","udp"],"type":"string"},"secondsToMeasure":{"description":"Configures a time duration (in seconds) to run the speed test","maximum":20,"minimum":0,"type":"integer"},"serverPort":{"description":"Enter number between (0-65535)","maximum":65535,"minimum":0,"type":"integer"},"windowSize":{"description":"Window size (in kb) sent to the server while running speed test","maximum":1638,"minimum":64,"type":"integer"}},"required":["iperfServerAddress"],"title":"AP SPEEDTEST REQUEST","type":"object"},"SpeedtestApResult__fddb7d22dcc0":{"allOf":[{"$ref":"#/components/schemas/AsyncOperationResultBase__03efdde95a47"},{"properties":{"output":{"allOf":[{"$ref":"#/components/schemas/SpeedtestApParsedOutput__fddb7d22dcc0"}],"type":["object","null"]}},"type":"object"}],"title":"AP SPEEDTEST RESULT"},"SrcCity__7006262f8c4c":{"description":"The source city of the threat.\n","examples":["San Jose"],"maxLength":128,"type":"string"},"SrcCountry__7006262f8c4c":{"description":"The source country of the threat.\n","examples":["US"],"maxLength":128,"type":"string"},"SrcIp__7006262f8c4c":{"description":"The source IP address of the threat.\n","examples":["192.168.x.x"],"maxLength":128,"type":"string"},"SrcPort__7006262f8c4c":{"description":"The source port of the threat.\n","examples":[80],"format":"int64","type":"integer"},"Ssid__608b430a0026":{"description":"The name of the SSID configured in the tunnel.\n","example":"SSID_1","maxLength":256,"type":"string"},"Ssid__d67ae4720000":{"description":"The SSID of the monitored AP","examples":["NR_01_HP-425"],"maxLength":128,"type":"string"},"StackId__cd77b09562fb":{"description":"Stack ID represents the unique identifier for the stack to which the device belongs.","example":"07009020-c27d1b2","format":"const","maxLength":16,"type":"string"},"StackMemberResponse__cfefefc40ef4":{"description":"Response containing a list of stack members and the total count.","properties":{"count":{"description":"Total number of stack members.","example":5,"type":"integer"},"items":{"description":"List of stack members.","items":{"$ref":"#/components/schemas/Stack__cfefefc40ef4"},"type":"array"}},"required":["items","count"],"type":"object"},"StackPortLinks__cfefefc40ef4":{"description":"Details of the stack port links for a switch.","example":{"links":[{"adminStatus":"Up","alias":"GE1","allowedVlanIds":[10,20],"allowedVlans":["VLAN10","VLAN20"],"connector":"RJ45","description":"Uplink to Core Switch","duplex":"Full","errorReason":null,"index":1,"ipv4":"10.1.1.1","isMultipleNeighbourClients":false,"lag":null,"module":"1","mtu":1500,"name":"GigabitEthernet1/0/1","nativeVlan":1,"neighbour":"CoreSwitch","neighbourFamily":"Aruba","neighbourFunction":"Core","neighbourHealth":"Good","neighbourPort":"GigabitEthernet1/0/24","neighbourRole":"Core Switch","neighbourSerial":"CN32HKZ0DN","neighbourType":"Switch","operStatus":"Up","peerMemberId":2,"peerPort":"GigabitEthernet1/0/24","poeClass":"Class4","poeStatus":"Enabled","portAlignment":"Aligned","portError":[],"serialNumber":"CN31HKZ0CN","speed":1000,"status":"Up","stpInstanceId":0,"stpInstanceType":"RSTP","stpPortInconsistent":"None","stpPortRole":"Root","stpPortState":"Forwarding","transceiverModel":"SFP-1G-LX","transceiverProductNumber":"J4859C","transceiverSerial":"SFP123456","transceiverStatus":"Good","transceiverType":"SFP","type":"GigabitEthernet","uplink":true,"vlanMode":"Access"}],"serialNumber":"CN31HKZ0CN"},"properties":{"links":{"description":"List of switch interfaces.","items":{"$ref":"#/components/schemas/SwitchInterface__3b087684a285"},"type":"array"},"serialNumber":{"description":"Serial number of the switch.","example":"CN31HKZ0CN","type":"string"}},"required":["serialNumber","links"],"type":"object"},"StackResponse__cfefefc40ef4":{"description":"Switch response that contains switch attributes\n","example":{"configStatus":"Synchronized","contact":"","deployment":"Standalone","deviceName":"Aruba-2930F-8G-PoEP-2SFPP","firmwareBackupVersion":null,"firmwareRecommendedVersion":null,"firmwareStatus":null,"firmwareUpdatedTs":null,"firmwareVersion":"WC.16.11.0001","health":"Poor","healthReasons":{"fairReasons":{},"poorReasons":["DEVICE_OFFLINE"],"primaryReason":{"reasonEnum":"None","totalReasons":0,"typeId":"None"}},"id":"CN31HKZ0CN","ipv4":"10.21.78.3","ipv6":null,"jNumber":"JL258A","lastConfigChange":1707907296000,"lastRestartReason":null,"lastSeenAt":1707919492646,"location":"","macAddress":"ec:50:aa:0d:99:30","managementVlan":null,"manufacturer":"Aruba","model":"AS-2930F","nativeVlan":null,"publicIp":"59.144.73.163","rebootTs":null,"recommendation":null,"serialNumber":"CN31HKZ0CN","siteId":"749988555","stackId":null,"stackMemberId":2,"stackMemberPriority":null,"stackMemberStatus":null,"status":"Offline","stpEnable":false,"stpMode":null,"switchLinkType":"BPS","switchRole":"Standalone","switchType":"pvos","type":"switch","uptimeInMillis":null},"properties":{"configStatus":{"description":"Configuration status of the switch","example":"Pending","type":"string"},"contact":{"description":"Contact person or email for the switch","example":"admin@company.com","type":"string"},"deployment":{"description":"Deployment mode of the switch","example":"Standalone","type":"string"},"deviceName":{"description":"Name of the switch","example":"Switch-01","type":"string"},"firmwareBackupVersion":{"description":"Backup firmware version of the switch","example":"8.5.0.0","type":"string"},"firmwareRecommendedVersion":{"description":"Recommended firmware version for the switch","example":"8.6.1.0","type":"string"},"firmwareStatus":{"description":"Status of the firmware","example":"Updated","type":"string"},"firmwareUpdatedTs":{"description":"Timestamp of the last firmware update","example":1627873200,"format":"float","type":"number"},"firmwareVersion":{"description":"Current firmware version of the switch","example":"8.6.0.0","type":"string"},"health":{"description":"Health status of the switch","example":"Poor","type":"string"},"healthReasons":{"$ref":"#/components/schemas/SwitchHealthReasons__134f5ffbb7f8"},"id":{"description":"Serial of the switch.\n","example":"CN31HKZ0CN","format":"const","type":"string"},"ipv4":{"description":"The switch IP address in IPv4 format","example":"10.21.78.3","type":"string"},"ipv6":{"description":"The switch IP address in IPv6 format","example":"2001:0db8:85a3:0000:0000:8a2e:0370:7334","type":"string"},"jNumber":{"description":"Job number or identifier","example":"J123456","type":"string"},"lastConfigChange":{"description":"Timestamp of the last configuration change","example":1627873200,"format":"float","type":"number"},"lastRestartReason":{"description":"Reason for the last restart","example":"Software upgrade","type":"string"},"lastSeenAt":{"description":"Timestamp when the switch was last seen online","example":1627873200,"format":"float","type":"number"},"location":{"description":"Physical location of the switch","example":"Data Center 1","type":"string"},"macAddress":{"description":"The MAC address of the switch","example":"11:22:33:44:66:60","type":"string"},"managementVlan":{"description":"Management VLAN ID","example":1,"type":"integer"},"manufacturer":{"description":"Manufacturer of the switch","example":"Aruba","type":"string"},"model":{"description":"Model of the switch","example":"AS-2930M","type":"string"},"nativeVlan":{"description":"Native VLAN ID","example":10,"type":"integer"},"publicIp":{"description":"Public IP address of the switch","example":"59.144.73.163","type":"string"},"rebootTs":{"description":"Timestamp of the last reboot","example":1627873200,"format":"float","type":"number"},"recommendation":{"description":"Recommended actions for the switch","example":["Update firmware","Check connection stability"],"type":"array"},"serialNumber":{"$ref":"#/components/schemas/SerialNumberswitch__134f5ffbb7f8"},"siteId":{"$ref":"#/components/schemas/SiteIdswitch__134f5ffbb7f8"},"stackId":{"description":"Stack ID of the device","example":"01000c97-5f80e1c0","type":"string"},"stackMemberId":{"description":"Member ID of the switch in a stack configuration","example":1,"type":"integer"},"stackMemberPriority":{"description":"Priority of the switch within the stack","example":15,"type":"integer"},"stackMemberStatus":{"description":"Status of the switch within the stack","example":"Active","type":"string"},"status":{"description":"The status of the switch","example":"Online","type":"string"},"stpEnable":{"description":"Indicates if STP (Spanning Tree Protocol) is enabled","example":true,"type":"boolean"},"stpMode":{"description":"Mode of the Spanning Tree Protocol","example":"RSTP","type":"string"},"switchLinkType":{"description":"Link type for switch","example":"BPS","type":"string"},"switchRole":{"description":"Role of the switch in the network","example":"Core","type":"string"},"switchType":{"description":"Type of the switch, e.g., pvos or cx","example":"pvos","type":"string"},"type":{"description":"API type.\n","example":"switch","format":"const","maxLength":512,"type":"string"},"uptimeInMillis":{"$ref":"#/components/schemas/UptimeInMillisswitch__134f5ffbb7f8"}},"required":["id","type"],"type":"object"},"Stack__cfefefc40ef4":{"description":"Details of a stack.","properties":{"id":{"description":"Unique identifier for the stack.","example":"stack-12345","type":"string"},"members":{"description":"List of switches that are members of the stack.","items":{"$ref":"#/components/schemas/StackResponse__cfefefc40ef4"},"type":"array"},"portLinks":{"description":"Port links within the stack.","items":{"$ref":"#/components/schemas/StackPortLinks__cfefefc40ef4"},"type":"array"},"stackType":{"description":"Type of the stack configuration.","example":"Virtual","type":"string"},"topology":{"description":"Topology of the stack.","example":"Ring","type":"string"},"type":{"description":"Type of the stack.","example":"stack-members","type":"string"}},"required":["id","type"],"type":"object"},"StartApRangingScanResponse__cb302d396c40":{"description":"The result for the ftm scan start request.","properties":{"errorMessage":{"description":"Error details in the case that a scan could not be started.","examples":[null],"format":"const","maxLength":256,"type":"string"},"estimatedCompletionTime":{"$ref":"#/components/schemas/Timestamp__306cd00aed2d","description":"Estimated scan completion time"},"id":{"$ref":"#/components/schemas/SessionId__16fa337a67ef"},"result":{"description":"The start scan request outcome.\nSUCCESS - Scan was successfully created and is now PENDING\nSCAN_ALREADY_ACTIVE - Scan already active on the given floor-id. Only one scan is allowed per floor at any given time. Scan cannot be started.\nNOT_ENOUGH_APS - There were not enough ftm-monitor enabled APs on the given floor-id. Scan cannot be started.\nREGULATORY_DOMAIN_MISMATCH - Not all APs are configured with the same country code. Scan cannot be started.\nNO_VALID_CHANNELS - Based on the user configured country code and channel selections, there are no available channels to run the ftm scan on. Scan cannot be started.\nERROR - There was an error starting the scan (see errorMessage for details of the error).\n","enum":["SUCCESS","SCAN_ALREADY_ACTIVE","NOT_ENOUGH_APS","REGULATORY_DOMAIN_MISMATCH","NO_VALID_CHANNELS","ERROR","DRY_RUN"],"examples":["SUCCESS"],"format":"enum","type":"string"},"scanStartTime":{"$ref":"#/components/schemas/Timestamp__306cd00aed2d","description":"Estimated scan start time"},"serialNumbers":{"description":"List of serial numbers of the APs that will be performing the scan.\n","items":{"$ref":"#/components/schemas/SerialNumberopen__306cd00aed2d"},"maxItems":2147483647,"type":"array"}},"required":["result"],"type":"object"},"StartAt__0052b7c55291":{"description":"Start time in epoch for the location analytics trends/insights.","example":"1683284400000","format":"const","type":"string"},"StartQueryTime__000172564380":{"description":"Start timestamp in epoch time milliseconds for the query. (Default: 3 hours ago)","examples":[1698246458000],"format":"int64","maximum":9223372036854776000,"minimum":0,"type":"integer"},"StationMac__000172564380":{"description":"MAC address of the station the attack is targeting\n","examples":["11:22:33:44:55:66"],"format":"mac","maxLength":17,"minLength":17,"type":"string"},"Status__6b9c5f08b869":{"description":"Status of the device, which can be either ONLINE or OFFLINE.","enum":["ONLINE","OFFLINE"],"example":"ONLINE","type":"string"},"Statusap__98bb0f033247":{"description":"Status of the access point, which can be either ONLINE or OFFLINE.\n","enum":["ONLINE","OFFLINE"],"example":"ONLINE","type":"string"},"Statusclients__284f33982989":{"description":"Specifies the status of the client.","enum":["Connected","Failed","Connecting","Disconnected","Blocked"],"example":"Connected","type":"string"},"Statusgw__de89a47d9bd8":{"description":"The status of the gateway, either Online or Offline.\n","enum":["ONLINE","OFFLINE"],"example":"ONLINE","maxLength":7,"type":"string"},"Strategy__7006262f8c4c":{"description":"The strategy of the threat.\n","examples":["IPS_STRICT"],"maxLength":128,"type":"string"},"SubCategory__13edfa6d725b":{"description":"Sub-category of the executed action.\n","example":"Configuration","maxLength":256,"type":"string"},"SubnetMask__98bb0f033247":{"description":"Subnet mask assigned to the access point IPv4 interface.\n","example":"255.255.255.0","format":"ipv4","maxLength":15,"type":"string"},"SubscriptionKey__cd77b09562fb":{"description":"Subscription license key associated with the device.","example":"ET45ENIPPEADN9FQ","format":"const","maxLength":32,"type":"string"},"Success__c1c7772865ac":{"description":"Indicates whether the operation was successful.","type":"boolean"},"Summary__f8f342aecdae":{"description":"The summary of the threat.\n","examples":["This alert is triggered when traffic matching a known Command and Control pattern is observed.\n"],"maxLength":1024,"type":"string"},"SwarmInfo__a3f300af1174":{"example":{"clusterId":"1j4ehold0qj06kpbuy1a89dy5c69xe82ob27givar6mnbq135u","clusterName":"Cluster1","conductorDeviceName":"ArubaAP","conductorSerialNumber":"AP00000001","firmwareVersion":"8.9.0.0-8.9.0.0_81161","id":"1j4ehold0qj06kpbuy1a89dy5c69xe82ob27givar6mnbq135u","ipv4":"10.2.3.5","ipv6":"2001:0db8:85a3:0000:0000:8a2e:0370:7334","membersCount":1,"publicIpAddress":"104.36.250.13","siteId":"24833497","type":"network-monitoring/access-point-monitoring"},"properties":{"clusterId":{"$ref":"#/components/schemas/ClusterId__54309c5cca60"},"clusterName":{"$ref":"#/components/schemas/ClusterName__3a50015484e1"},"conductorDeviceName":{"$ref":"#/components/schemas/ConductorDeviceName__a3f300af1174"},"conductorSerialNumber":{"$ref":"#/components/schemas/ConductorSerialNumber__a3f300af1174"},"firmwareVersion":{"$ref":"#/components/schemas/FirmwareVersionap__98bb0f033247"},"id":{"$ref":"#/components/schemas/ID__c0c1228d8f7d"},"ipv4":{"$ref":"#/components/schemas/IPv4Addressap__98bb0f033247"},"ipv6":{"$ref":"#/components/schemas/IPv6Addressap__98bb0f033247"},"membersCount":{"$ref":"#/components/schemas/membersCount__a3f300af1174"},"publicIpAddress":{"$ref":"#/components/schemas/PublicIpAddress__a3f300af1174"},"siteId":{"$ref":"#/components/schemas/SiteIDap__34350f7e707e"},"type":{"$ref":"#/components/schemas/Typeap__05867e444b37"}},"required":["clusterId","id","type"],"type":"object"},"SwarmListInfo__eb0984f2beb1":{"example":{"clusterId":"1j4ehold0qj06kpbuy1a89dy5c69xe82ob27givar6mnbq135u","clusterName":"Cluster1","conductorDeviceName":"ArubaAP","conductorSerialNumber":"AP00000001","firmwareVersion":"8.9.0.0-8.9.0.0_81161","id":"1j4ehold0qj06kpbuy1a89dy5c69xe82ob27givar6mnbq135u","ipv4":"10.2.3.5","ipv6":"2001:0db8:85a3:0000:0000:8a2e:0370:7334","publicIpAddress":"104.36.250.13","siteId":"24833497","siteName":"site1","type":"network-monitoring/access-point-monitoring"},"properties":{"clusterId":{"$ref":"#/components/schemas/ClusterId__54309c5cca60"},"clusterName":{"$ref":"#/components/schemas/ClusterName__3a50015484e1"},"conductorDeviceName":{"$ref":"#/components/schemas/ConductorDeviceName__a3f300af1174"},"conductorSerialNumber":{"$ref":"#/components/schemas/ConductorSerialNumber__a3f300af1174"},"firmwareVersion":{"$ref":"#/components/schemas/FirmwareVersionap__98bb0f033247"},"id":{"$ref":"#/components/schemas/ID__c0c1228d8f7d"},"ipv4":{"$ref":"#/components/schemas/IPv4Addressap__98bb0f033247"},"ipv6":{"$ref":"#/components/schemas/IPv6Addressap__98bb0f033247"},"publicIpAddress":{"$ref":"#/components/schemas/PublicIpAddress__a3f300af1174"},"siteId":{"$ref":"#/components/schemas/SiteIDap__34350f7e707e"},"siteName":{"$ref":"#/components/schemas/SiteNameap__34350f7e707e"},"type":{"$ref":"#/components/schemas/Typeap__05867e444b37"}},"required":["clusterId","id","type"],"type":"object"},"SwarmListResponse__eb0984f2beb1":{"allOf":[{"properties":{"items":{"items":{"$ref":"#/components/schemas/SwarmListInfo__eb0984f2beb1"},"maxItems":1000,"type":"array"}},"required":["items"],"type":"object"},{"$ref":"#/components/schemas/PaginatedResponseap__2dcf9a625ef5"}],"example":{"count":1,"items":[{"clusterId":"1j4ehold0qj06kpbuy1a89dy5c69xe82ob27givar6mnbq135u","clusterName":"Cluster1","conductorDeviceName":"ArubaAP","conductorSerialNumber":"AP00000001","firmwareVersion":"8.9.0.0-8.9.0.0_81161","id":"1j4ehold0qj06kpbuy1a89dy5c69xe82ob27givar6mnbq135u","ipv4":"10.2.3.5","ipv6":"2001:0db8:85a3:0000:0000:8a2e:0370:7334","publicIpAddress":"104.36.250.13","siteId":"24833497","siteName":"site1","type":"network-monitoring/access-point-monitoring"}],"next":"2","total":6}},"SwarmNotFoundError__a3f300af1174":{"description":"Swarm not found error details that are returned from the server.\n","properties":{"debugId":{"$ref":"#/components/schemas/DebugId__000172564380"},"errorCode":{"description":"* A unique, machine-friendly, but human-readable identifier for the error. It has the prefix HPE_GL_.\n* For more details regarding the error please refer to the error message\n","enum":["HPE_GL_NETWORK_MONITORING_SWARM_NOT_FOUND"],"example":"HPE_GL_NETWORK_MONITORING_SWARM_NOT_FOUND","format":"const","maxLength":256,"type":"string"},"httpStatusCode":{"description":"The HTTP status code.\n","example":404,"maximum":404,"minimum":404,"type":"integer"},"message":{"$ref":"#/components/schemas/ErrorMessageap__0f1d40c88b6b"}},"required":["httpStatusCode","errorCode","message","debugId"],"type":"object"},"SwitchHardwareResponse__eb47230c21a4":{"description":"Response containing hardware details and the switch count.","properties":{"count":{"description":"Total number of switches.","example":4,"type":"integer"},"items":{"description":"List of switch hardware details.","items":{"$ref":"#/components/schemas/SwitchHardware__eb47230c21a4"},"type":"array"}},"required":["items","count"],"type":"object"},"SwitchHardware__eb47230c21a4":{"description":"Hardware detail for the switch","properties":{"cpu":{"$ref":"#/components/schemas/HardwareCategory__eb47230c21a4"},"fans":{"$ref":"#/components/schemas/HardwareCategoryCount__eb47230c21a4"},"id":{"description":"Serial of the switch.\n","example":"CN31HKZ0CN","type":"string"},"memory":{"$ref":"#/components/schemas/HardwareCategory__eb47230c21a4"},"model":{"description":"Model of the switch.","example":"AS-2930M","type":"string"},"poeSlots":{"$ref":"#/components/schemas/HardwareCategoryCount__eb47230c21a4"},"powerSupplies":{"$ref":"#/components/schemas/HardwareCategoryCount__eb47230c21a4"},"role":{"description":"Role of the switch.","example":"Standby","type":"string"},"serialNumber":{"description":"Serial of the switch.\n","example":"CN31HKZ0CN","type":"string"},"stackMemberId":{"description":"Member id of the switch.","example":"2","type":"integer"},"status":{"description":"Status of the switch.","example":"online","type":"string"},"temperature":{"$ref":"#/components/schemas/HardwareCategory__eb47230c21a4"},"type":{"description":"Type of the hardware.","example":"switch-hardware","type":"string"}},"required":["id","type"],"type":"object"},"SwitchHealthPrimaryReason__134f5ffbb7f8":{"properties":{"reasonEnum":{"description":"Health Primary Reason Enum.","example":"None","type":"string"},"totalReasons":{"description":"Total health reasons.","example":"1","type":"integer"},"typeId":{"description":"Health Primary Reason TypeId.","example":"None","type":"string"}},"type":"object"},"SwitchHealthReasons__134f5ffbb7f8":{"properties":{"fairReasons":{"description":"List of reasons why the switch health is considered fair","example":["Moderate latency","Occasional errors"],"items":{"type":"string"},"type":"array"},"poorReasons":{"description":"List of reasons why the switch health is considered poor","example":["High packet loss","Frequent disconnections"],"items":{"type":"string"},"type":"array"},"primaryReason":{"$ref":"#/components/schemas/SwitchHealthPrimaryReason__134f5ffbb7f8"}},"required":["poorReasons","fairReasons","primaryReason"],"type":"object"},"SwitchInterfacePoE__87866266e647":{"description":"Object containing interface poe for the switch.","properties":{"id":{"description":"identifier.","example":"1","type":"string"},"name":{"description":"interface name.","example":"7","type":"string"},"powerDeniedCount":{"description":"Power denied count for the switch.","example":"5.0","format":"float","type":"number"},"powerDrawnInWatts":{"description":"Power drawn in watts for the switch.","example":"5.0","format":"float","type":"number"},"serialNumber":{"description":"Serial of the switch.","example":"CN31HKZ0CN","type":"string"},"siteId":{"$ref":"#/components/schemas/SiteIdswitch__134f5ffbb7f8"},"tenantId":{"description":"Tenant id.","example":"0972444909e64fcd945dfd6e8261e26f","type":"string"},"timestamp":{"description":"Timestamp for the interface poe.","example":"1764592073958","type":"number"},"type":{"description":"Type of the response.","example":"Static","type":"string"}},"required":["id","type"],"type":"object"},"SwitchInterfaceResponse__3b087684a285":{"allOf":[{"description":"List of interfaces with their attributes.","properties":{"items":{"items":{"$ref":"#/components/schemas/SwitchInterface__3b087684a285"},"maxItems":9999,"type":"array"}},"required":["items"],"type":"object"},{"$ref":"#/components/schemas/PaginationResponsePropertiesswitch__244c7d3b837e"}]},"SwitchInterface__3b087684a285":{"description":"Details of a switch interface.","example":{"adminStatus":"Up","alias":"GE1","allowedVlanIds":[10,20],"allowedVlans":["VLAN10","VLAN20"],"connector":"RJ45","description":"Uplink to Core Switch","duplex":"Full","errorReason":null,"id":"GigabitEthernet1/0/1","index":1,"ipv4":"10.1.1.1","isMultipleNeighbourClients":false,"lag":null,"module":"1","mtu":1500,"name":"GigabitEthernet1/0/1","nativeVlan":1,"neighbour":"CoreSwitch","neighbourFamily":"Aruba","neighbourFunction":"Core","neighbourHealth":"Good","neighbourPort":"GigabitEthernet1/0/24","neighbourRole":"Core Switch","neighbourSerial":"CN32HKZ0DN","neighbourType":"Switch","operStatus":"Up","peerMemberId":2,"peerPort":"GigabitEthernet1/0/24","poeClass":"Class4","poeStatus":"Enabled","portAlignment":"Aligned","portError":[],"serialNumber":"CN31HKZ0CN","speed":1000,"status":"Up","stpInstanceId":0,"stpInstanceType":"RSTP","stpPortInconsistent":"None","stpPortRole":"Root","stpPortState":"Forwarding","transceiverModel":"SFP-1G-LX","transceiverProductNumber":"J4859C","transceiverSerial":"SFP123456","transceiverStatus":"Good","transceiverType":"SFP","type":"GigabitEthernet","uplink":true,"vlanMode":"Access"},"properties":{"adminStatus":{"description":"Administrative status of the interface.","example":"Up","type":"string"},"alias":{"description":"Alias name for the interface.","example":"GE1","type":"string"},"allowedVlanIds":{"description":"List of allowed VLAN IDs on the interface.","example":[10,20],"items":{"type":"integer"},"type":"array"},"allowedVlans":{"description":"List of allowed VLAN names on the interface.","example":["VLAN10","VLAN20"],"items":{"type":"string"},"type":"array"},"connector":{"description":"Type of connector used by the interface.","example":"RJ45","type":"string"},"description":{"description":"Description of the interface.","example":"Uplink to Core Switch","type":"string"},"duplex":{"description":"Duplex mode of the interface.","example":"Full","type":"string"},"errorReason":{"description":"Reason for any error on the interface.","example":"None","type":"string"},"id":{"description":"Interface name.","example":"7","type":"string"},"index":{"description":"Index of the switch interface.","example":1,"type":"integer"},"ipv4":{"description":"IPv4 address assigned to the interface.","example":"10.1.1.1","type":"string"},"isMultipleNeighbourClients":{"description":"Indicates if the port is connected to multiple clients on the neighbouring device.","example":false,"type":"boolean"},"lag":{"description":"Link Aggregation Group (LAG) associated with the interface.","example":"LAG1","type":"string"},"module":{"description":"Module number of the interface.","example":"1","type":"string"},"mtu":{"description":"MTU size of the interface.","example":1500,"type":"integer"},"name":{"description":"Name of the switch interface.","example":"GigabitEthernet1/0/1","type":"string"},"nativeVlan":{"description":"Native VLAN ID of the interface.","example":1,"type":"integer"},"neighbour":{"description":"Name of the neighbouring device connected to this interface.","example":"CoreSwitch","type":"string"},"neighbourFamily":{"description":"Family of the neighbouring device.","example":"Aruba","type":"string"},"neighbourFunction":{"description":"Function of the neighbouring device.","example":"Core","type":"string"},"neighbourHealth":{"description":"Health status of the neighbouring device.","example":"Good","type":"string"},"neighbourPort":{"description":"Port on the neighbouring device connected to this interface.","example":"GigabitEthernet1/0/24","type":"string"},"neighbourRole":{"description":"Role of the neighbouring device.","example":"Core Switch","type":"string"},"neighbourSerial":{"description":"Serial number of the neighbouring device.","example":"CN32HKZ0DN","type":"string"},"neighbourType":{"description":"Type of the neighbouring device.","example":"Switch","type":"string"},"operStatus":{"description":"Operational status of the interface.","example":"Up","type":"string"},"peerMemberId":{"description":"Member ID of the peer device.","example":2,"type":"integer"},"peerPort":{"description":"Name of the peer port connected to this interface.","example":"GigabitEthernet1/0/24","type":"string"},"poeClass":{"description":"PoE class of the interface.","example":"Class4","type":"string"},"poeStatus":{"description":"PoE (Power over Ethernet) status of the interface.","example":"Enabled","type":"string"},"portAlignment":{"description":"Alignment status of the port.","example":"Aligned","type":"string"},"portError":{"description":"List of errors associated with the port.","example":[],"items":{"type":"string"},"type":"array"},"serialNumber":{"description":"Serial number associated with the interface.","example":"CN31HKZ0CN","type":"string"},"speed":{"description":"Speed of the interface in Mbps.","example":1000,"format":"float","type":"number"},"status":{"description":"Operational status of the interface.","example":"Up","type":"string"},"stpInstanceId":{"description":"Identifier of the STP instance.","example":0,"type":"integer"},"stpInstanceType":{"description":"Type of Spanning Tree Protocol (STP) instance.","example":"RSTP","type":"string"},"stpPortInconsistent":{"description":"Indicates if there is any inconsistency in the STP port.","example":"None","type":"string"},"stpPortRole":{"description":"Role of the port within the STP instance.","example":"Root","type":"string"},"stpPortState":{"description":"State of the port within the STP instance.","example":"Forwarding","type":"string"},"transceiverModel":{"description":"Model of the transceiver.","example":"SFP-1G-LX","type":"string"},"transceiverProductNumber":{"description":"Product number of the transceiver.","example":"J4859C","type":"string"},"transceiverSerial":{"description":"Serial number of the transceiver.","example":"SFP123456","type":"string"},"transceiverStatus":{"description":"Status of the transceiver.","example":"Good","type":"string"},"transceiverType":{"description":"Type of transceiver used in the interface.","example":"SFP","type":"string"},"type":{"description":"Type of the interface.","example":"GigabitEthernet","type":"string"},"uplink":{"description":"Indicates if the interface is an uplink port.","example":true,"type":"boolean"},"vlanMode":{"description":"VLAN mode of the interface.","example":"Access","type":"string"}},"required":["id","type","name","index","status","adminStatus","operStatus"],"type":"object"},"SwitchLagSummaryResponse__e3b5991a5b2b":{"description":"Response containing a lag summary and the total count.","properties":{"count":{"description":"Total number of lags.","example":4,"type":"integer"},"items":{"description":"List of lag summary.","items":{"$ref":"#/components/schemas/SwitchLagSummary__e3b5991a5b2b"},"type":"array"}},"required":["items","count"],"type":"object"},"SwitchLagSummary__e3b5991a5b2b":{"description":"Lag Summary for the switch","properties":{"count":{"description":"Count of the interfaces with lag.","example":"2","type":"integer"},"id":{"description":"Lag name.","example":"Trk13","type":"string"},"name":{"description":"Lag name.","example":"Trk13","type":"string"},"ports":{"description":"Names of the switch interface.","example":["2/1","1/10"],"items":{"type":"string"},"type":"array"},"type":{"description":"Type of the switch.","example":"ISL","type":"string"}},"required":["id","type"],"type":"object"},"SwitchListResponse__c64bceb851d6":{"allOf":[{"properties":{"items":{"items":{"properties":{"deployment":{"description":"Deployment mode of the switch","example":"Standalone","type":"string"},"deviceFunction":{"description":"Device Function (Persona identifier) for the switch.\n","example":"Instant","type":"string"},"deviceName":{"description":"Name of the switch","example":"Switch-01","type":"string"},"firmwareVersion":{"description":"Current firmware version of the switch","example":"8.6.0.0","type":"string"},"id":{"description":"Serial of the switch.\n","example":"CN31HKZ0CN","format":"const","type":"string"},"ipv4":{"description":"The switch IP address in IPv4 format","example":"10.21.78.3","type":"string"},"ipv6":{"description":"The switch IP address in IPv6 format","example":"2001:0db8:85a3:0000:0000:8a2e:0370:7334","type":"string"},"lastSeenAt":{"description":"Timestamp when the switch was last seen online","example":1627873200,"format":"float","type":"number"},"macAddress":{"description":"The MAC address of the switch","example":"11:22:33:44:66:60","type":"string"},"model":{"description":"Model of the switch","example":"AS-2930M","type":"string"},"partNumber":{"description":"Part number of the switch\n","example":"JX973A","type":"string"},"serialNumber":{"$ref":"#/components/schemas/SerialNumberswitch__134f5ffbb7f8"},"siteId":{"$ref":"#/components/schemas/SiteIdswitch__134f5ffbb7f8"},"siteName":{"description":"SiteName","example":"StackTest","type":"string"},"stackId":{"description":"StackId of the switch in the network","example":"140064e8-81c15bc0","type":"string"},"status":{"description":"The status of the switch","example":"Online","type":"string"},"switchTrends":{"$ref":"#/components/schemas/SwitchTrends__134f5ffbb7f8"},"switchType":{"description":"StackId of the switch in the network","example":"140064e8-81c15bc0","type":"string"},"type":{"description":"API type.\n","example":"switch","format":"const","maxLength":512,"type":"string"},"uptimeInMillis":{"$ref":"#/components/schemas/UptimeInMillisswitch__134f5ffbb7f8"}},"required":["serialNumber","macAddress","deviceName","siteId","id","type"],"type":"object"},"maxItems":100,"type":"array"}},"required":["items"],"type":"object"},{"$ref":"#/components/schemas/SwitchPaginationResponseProperties__c64bceb851d6"}],"description":"Switch List response that contains switch attributes\n","example":{"count":1,"items":[{"deployment":"Stack","deviceFunction":"None","deviceName":"Aruba-VSF-2930F","firmwareVersion":"WC.16.11.0021","id":"CN35HKZ1YX","ipv4":"10.97.64.183","ipv6":null,"lastSeenAt":"2025-12-02T08:52:14.738Z","macAddress":"ec:50:aa:0f:5d:14","model":"AS-2930F","partNumber":"JL258A","publicIp":"61.246.230.194","serialNumber":"CN35HKZ1YX","siteId":"33453933085143040","siteName":"PVOS_MON_Troubleshooting","stackId":"090064e8-818ee000","stackMemberId":2,"status":"OFFLINE","switchRole":"Conductor","switchTrends":[{"cpuUtilization":2,"memoryUtilization":31,"poeAvailable":136,"poeConsumption":0,"powerConsumption":0,"serial":"CN05HKZ1BW","switchRole":null,"systemTemperature":0,"totalPowerConsumption":0,"upLinkPorts":"1/8","usage":14345}],"switchType":"pvos","type":"network-monitoring/switch-monitoring","uptimeInMillis":0}],"next":"2","total":4},"type":"object"},"SwitchMetrics__5cf5b3c37fbc":{"description":"Sample list for the trends.","properties":{"samples":{"description":"Samples for the interface trends in the key list.","items":{"$ref":"#/components/schemas/Sample__0d6bfd060cf2"},"type":"array"},"serialNumber":{"description":"Serial of the switch.","example":"CN31HKZ0CN","type":"string"},"switchRole":{"description":"Role of the switch.","example":"Member","type":"string"}},"type":"object"},"SwitchPaginationResponseProperties__c64bceb851d6":{"description":"Fields appended to a list to facilitate paging.\n","properties":{"count":{"description":"The number of objects returned in the current list.\n","example":1,"format":"int32","type":"integer"},"next":{"description":"Indicate the next page number, null if there are no further pages.","example":"2","format":"int32","type":"string"},"total":{"description":"The total number of objects contained in the datastore.\n","example":1,"format":"int64","type":"integer"}},"required":["count","total","next"],"type":"object"},"SwitchResponse__134f5ffbb7f8":{"description":"Switch response that contains switch attributes\n","example":{"configStatus":"Synchronized","contact":"","deployment":"Standalone","deviceName":"Aruba-2930F-8G-PoEP-2SFPP","firmwareVersion":"WC.16.11.0001","health":"Poor","healthReasons":{"fairReasons":{},"poorReasons":["DEVICE_OFFLINE"]},"id":"CN31HKZ0CN","ipv4":"10.21.78.4","ipv6":null,"jNumber":"JL258A","lastConfigChange":1707907296000,"lastRestartReason":null,"lastSeenAt":1707919492646,"macAddress":"ec:50:aa:0d:99:30","manufacturer":"Aruba","model":"AS-2930F","publicIp":"59.144.73.163","serialNumber":"CN31HKZ0CN","siteId":"749988555","siteName":"PVOS_MON_Troubleshooting","status":"Offline","switchLinkType":"BPS","switchRole":"Standalone","switchTrends":[{"cpuUtilization":10,"memoryUtilization":36,"poeAvailable":370,"powerConsumption":0,"serialNumber":"CN09HKW38R","switchRole":"Conductor","systemTemperature":70,"upLinkPorts":"1/8","usage":14345.45}],"switchType":"pvos","type":"switch","uptimeInMillis":null},"properties":{"deployment":{"description":"Deployment mode of the switch","example":"Standalone","type":"string"},"deviceName":{"description":"Name of the switch","example":"Switch-01","type":"string"},"firmwareVersion":{"description":"Current firmware version of the switch","example":"8.6.0.0","type":"string"},"health":{"description":"Health status of the switch","example":"Poor","type":"string"},"healthReasons":{"$ref":"#/components/schemas/SwitchHealthReasons__134f5ffbb7f8"},"id":{"description":"Serial of the switch.\n","example":"CN31HKZ0CN","format":"const","type":"string"},"ipv4":{"description":"The switch IP address in IPv4 format","example":"10.21.78.3","type":"string"},"ipv6":{"description":"The switch IP address in IPv6 format","example":"2001:0db8:85a3:0000:0000:8a2e:0370:7334","type":"string"},"jNumber":{"description":"Job number or identifier","example":"J123456","type":"string"},"lastConfigChange":{"description":"Timestamp of the last configuration change","example":1627873200,"format":"float","type":"number"},"lastRestartReason":{"description":"Reason for the last restart","example":"Software upgrade","type":"string"},"lastSeenAt":{"description":"Timestamp when the switch was last seen online","example":1627873200,"format":"float","type":"number"},"macAddress":{"description":"The MAC address of the switch","example":"11:22:33:44:66:60","type":"string"},"manufacturer":{"description":"Manufacturer of the switch","example":"Aruba","type":"string"},"model":{"description":"Model of the switch","example":"AS-2930M","type":"string"},"publicIp":{"description":"Public IP address of the switch","example":"59.144.73.163","type":"string"},"serialNumber":{"$ref":"#/components/schemas/SerialNumberswitch__134f5ffbb7f8"},"siteId":{"$ref":"#/components/schemas/SiteIdswitch__134f5ffbb7f8"},"siteName":{"description":"SiteName","example":"StackTest","type":"string"},"status":{"description":"The status of the switch","example":"Online","type":"string"},"switchLinkType":{"description":"Link type for switch","example":"BPS","type":"string"},"switchRole":{"description":"Role of the switch in the network","example":"Core","type":"string"},"switchTrends":{"$ref":"#/components/schemas/SwitchTrends__134f5ffbb7f8"},"switchType":{"description":"Type of the switch, e.g., pvos or cx","example":"pvos","type":"string"},"type":{"description":"API type.\n","example":"switch","format":"const","maxLength":512,"type":"string"},"uptimeInMillis":{"$ref":"#/components/schemas/UptimeInMillisswitch__134f5ffbb7f8"}},"required":["id","type"],"type":"object"},"SwitchTrends__134f5ffbb7f8":{"properties":{"cpuUtilization":{"description":"CPU Utilization of the switch, expressed as a percentage (0–100).","example":"20","type":"number"},"memoryUtilization":{"description":"Memory Utilization of the switch, expressed as a percentage (0–100).","example":"20","type":"number"},"poeAvailable":{"description":"Total Poe available, expressed as watts (W).","example":"136","type":"number"},"poeConsumption":{"description":"Poe drawn, expressed as watts (W).","example":"20","type":"number"},"powerConsumption":{"description":"Total power available, expressed as watts (W).","example":"300","type":"number"},"serialNumber":{"$ref":"#/components/schemas/SerialNumberswitch__134f5ffbb7f8"},"switchRole":{"description":"Role of the switch.","example":"Conductor","type":"string"},"systemTemperature":{"description":"Temperature of the switch, expressed in degrees Celsius (°C).","example":"2","type":"number"},"totalPowerConsumption":{"description":"Total power consumed, expressed as watts (W).","example":"20","type":"number"},"upLinkPorts":{"description":"Uplink ports for the switch.","example":"['1/8','2/1']","type":"string"},"usage":{"description":"Total sum of the inrate and outrate for the switch.","example":"8237.78","type":"number"}},"type":"object"},"SwitchVlanResponse__244c7d3b837e":{"allOf":[{"description":"List of vlans with their attributes.","properties":{"count":{"description":"Total number of vlans.","example":2,"type":"integer"},"items":{"items":{"$ref":"#/components/schemas/SwitchVlan__244c7d3b837e"},"maxItems":9999,"type":"array"}},"required":["items","count"],"type":"object"},{"$ref":"#/components/schemas/PaginationResponsePropertiesswitch__244c7d3b837e"}]},"SwitchVlan__244c7d3b837e":{"description":"Vlans list for the switch.","properties":{"id":{"description":"identifier.","example":"1","type":"string"},"interfaces":{"description":"interfaces list.","example":["1-24"],"items":{"type":"string"},"type":"array"},"ipv4":{"description":"ipv4.","example":"11.12.82.122/27","type":"string"},"name":{"description":"vlan name.","example":"DEFAULT_VLAN","type":"string"},"status":{"description":"vlan status.","example":"Up","type":"string"},"type":{"description":"Type of the vlan.","example":"Static","type":"string"},"voice":{"description":"voice.","example":"Disabled","type":"string"}},"required":["id","type"],"type":"object"},"TagDataPage__acdf4895bcad":{"allOf":[{"properties":{"items":{"items":{"$ref":"#/components/schemas/TagData__a39bf531822f"},"maxItems":2147483647,"type":"array"}},"required":["items"],"type":"object"},{"$ref":"#/components/schemas/PaginationResponsePropertiesasset__acdf4895bcad"}]},"TagDataUpdateResponse__a3b548d8bd3f":{"description":"Response to POST or PUT Asset Tag metadata","properties":{"data":{"properties":{"tagMutationGenericResponse":{"properties":{"assetTagId":{"$ref":"#/components/schemas/DeviceId__8de6ce4ea240"},"result":{"description":"Descriptive text on the outcome of the operation.\n","example":"Metadata update for assetTagId {} accepted","format":"const","maxLength":512,"type":["string"]}},"type":"object"}},"type":"object"}},"type":"object"},"TagData__a39bf531822f":{"description":"Object with Asset Tag details.","properties":{"createdAt":{"$ref":"#/components/schemas/CreatedAtasset__a39bf531822f"},"deviceClassifications":{"$ref":"#/components/schemas/DeviceClassification__a39bf531822f"},"firstSeen":{"$ref":"#/components/schemas/FirstSeen__a39bf531822f"},"id":{"$ref":"#/components/schemas/DeviceId__8de6ce4ea240"},"imagePresent":{"description":"Indicates whether an image is currently associated with the tag. `true` when an image has been uploaded via the image PUT endpoint and has not been removed via the image DELETE endpoint; `false` otherwise.","type":"boolean"},"lastKnownLocation":{"$ref":"#/components/schemas/TagLastKnownLocation__a39bf531822f"},"macAddress":{"$ref":"#/components/schemas/MacAddressasset__a39bf531822f"},"metadata":{"$ref":"#/components/schemas/TagMetadata__a39bf531822f"},"type":{"$ref":"#/components/schemas/RootLevelType__a39bf531822f"}},"required":["id","type","macAddress","createdAt","deviceClassifications","firstSeen","metadata","lastKnownLocation","imagePresent"],"type":"object"},"TagLabels__a39bf531822f":{"description":"Labels associated with the Asset Tag.","example":["Label1","Label2"],"items":{"maxLength":100,"type":"string"},"type":"array"},"TagLastKnownLocation__a39bf531822f":{"description":"The last-known location of the tag.","properties":{"batteryLevel":{"$ref":"#/components/schemas/BatteryLevel__a39bf531822f"},"buildingId":{"$ref":"#/components/schemas/BuildingIdasset__a39bf531822f"},"buildingName":{"$ref":"#/components/schemas/BuildingName__a39bf531822f"},"coordinates":{"$ref":"#/components/schemas/Coordinates__a39bf531822f"},"createdAt":{"$ref":"#/components/schemas/CreatedAtasset__a39bf531822f"},"floorId":{"$ref":"#/components/schemas/FloorIdasset__a39bf531822f"},"floorName":{"$ref":"#/components/schemas/FloorName__a39bf531822f"},"floorNumber":{"$ref":"#/components/schemas/FloorNumber__a39bf531822f"},"id":{"$ref":"#/components/schemas/DeviceId__8de6ce4ea240"},"lastSeen":{"$ref":"#/components/schemas/LastSeen__a39bf531822f"},"siteId":{"$ref":"#/components/schemas/SiteIdasset__a39bf531822f"},"siteName":{"$ref":"#/components/schemas/SiteNameasset__a39bf531822f"},"type":{"$ref":"#/components/schemas/LocationLevelType__a39bf531822f"}},"required":["id","type","createdAt","siteId","floorId","siteName","floorName","floorNumber","lastSeen","tagCoordinates"],"type":"object"},"TagMetadataDeleteResponse__faeb43aeab4d":{"description":"Response to DELETE Asset Tag metadata","properties":{"data":{"properties":{"deleteAssetTagMetadata":{"properties":{"assetTagId":{"$ref":"#/components/schemas/DeviceId__8de6ce4ea240"},"result":{"description":"Descriptive text on the outcome of the operation.\n","example":"Metadata delete for assetTagId {} accepted","format":"const","maxLength":512,"type":["string"]}},"type":"object"}},"type":"object"}},"type":"object"},"TagMetadata__a39bf531822f":{"description":"Object with Asset Tag metadata.","properties":{"createdAt":{"$ref":"#/components/schemas/CreatedAtasset__a39bf531822f"},"customId":{"$ref":"#/components/schemas/CustomId__a39bf531822f"},"id":{"$ref":"#/components/schemas/DeviceId__8de6ce4ea240"},"labels":{"$ref":"#/components/schemas/TagLabels__a39bf531822f"},"name":{"$ref":"#/components/schemas/TagName__a39bf531822f"},"notes":{"$ref":"#/components/schemas/TagNotes__a39bf531822f"},"type":{"$ref":"#/components/schemas/MetadataLevelType__a39bf531822f"},"updatedAt":{"$ref":"#/components/schemas/UpdatedAt__2efde5827a74"}},"required":["id","type"],"type":"object"},"TagName__a39bf531822f":{"description":"Name of the Asset Tag.","example":"Tag1","format":"string","maxLength":100,"type":["string","null"]},"TagNotes__a39bf531822f":{"description":"Notes for the Asset Tag","example":"Sample notes for the tag.","maxLength":500,"type":["string","null"]},"TaskListEntry__3c2901e6fd8d":{"properties":{"locations":{"description":"A list of one or more active/recent task locations for this test type.","items":{"description":"A list of relative URL paths to query the status of individual task instances.","format":"uri-reference","type":"string"},"type":"array"},"testName":{"description":"The name of the test or command (e.g., 'ping', 'showCommands').","type":"string"}},"required":["testName","locations"],"title":"Task List Entry","type":"object"},"TaskListResponse__3c2901e6fd8d":{"example":[{"locations":["/network-troubleshooting/v1/aps/CNMJKZ203A/showCommands/async-operations/34f851ed-5142-44e3-a387-1f57e098e7c6"],"testName":"showCommands"},{"locations":["/network-troubleshooting/v1/aps/CNMJKZ203A/ping/async-operations/03b02a6f-ba7e-47de-8763-161c7ab17ad1"],"testName":"ping"},{"locations":["/network-troubleshooting/v1/aps/CNMJKZ203A/getArpTable/async-operations/2cb150ca-a6b5-4603-9135-563697f1f4b9","/network-troubleshooting/v1/aps/CNMJKZ203A/getArpTable/async-operations/9728dc97-8a81-45b7-91ab-676faaf7de0e"],"testName":"getArpTable"}],"items":{"$ref":"#/components/schemas/TaskListEntry__3c2901e6fd8d"},"title":"Task List Response","type":"array"},"TcpApParsedOutput__a1a5a1487152":{"properties":{"connectionTimeInMilliseconds":{"description":"The time taken to establish the TCP connection.","type":"string"},"host":{"description":"The host name or IP address for the TCP connection.","type":"string"}},"title":"AP TCP RESPONSE","type":"object"},"TcpApRequest__07d6ba732ff6":{"properties":{"host":{"description":"Hostname/IP address required","type":"string"},"port":{"description":"The TCP port (range: 1-65535)","maximum":65535,"minimum":1,"type":"integer"},"timeout":{"description":"Timeout in seconds (1-10)","maximum":10,"minimum":1,"type":"integer"}},"required":["host","port"],"title":"AP TCP REQUEST","type":"object"},"TcpApResult__a1a5a1487152":{"allOf":[{"$ref":"#/components/schemas/AsyncOperationResultBase__03efdde95a47"},{"properties":{"output":{"allOf":[{"$ref":"#/components/schemas/TcpApParsedOutput__a1a5a1487152"}],"type":["object","null"]}},"type":"object"}],"title":"AP TCP RESULT"},"TenantClientHealthType__a586e9b21225":{"description":"The type of the resource.","example":"network-monitoring/tenant-client-health","type":"string"},"TenantClientHealth__a586e9b21225":{"properties":{"clientTypes":{"items":{"$ref":"#/components/schemas/ClientTypesHealth__7f65987649fe"},"type":"array"},"id":{"$ref":"#/components/schemas/Idsite__0bffa6fb51f5"},"type":{"$ref":"#/components/schemas/TenantClientHealthType__a586e9b21225"}},"required":["id","type","clientTypes"],"type":"object"},"TenantDeviceHealthType__911671808d98":{"description":"The type of the resource.","example":"network-monitoring/tenant-device-health","type":"string"},"TenantDeviceHealth__911671808d98":{"properties":{"deviceTypes":{"items":{"$ref":"#/components/schemas/EntityNameHealth__0bffa6fb51f5"},"type":"array"},"id":{"$ref":"#/components/schemas/Idsite__0bffa6fb51f5"},"type":{"$ref":"#/components/schemas/TenantDeviceHealthType__911671808d98"}},"required":["id","type","deviceTypes"],"type":"object"},"TenantWlanListResponseV1__bfa0034decee":{"allOf":[{"properties":{"items":{"items":{"$ref":"#/components/schemas/WlanInfoWithClientCount__2dcf9a625ef5"},"maxItems":1000,"type":"array"}},"required":["items"],"type":"object"},{"$ref":"#/components/schemas/PaginatedResponseap__2dcf9a625ef5"}],"example":{"count":1,"items":[{"band":"2.4 GHz, 5 GHz","clientCount":15,"id":"wlans/wlan1","security":"Enhanced Open","securityLevel":"Personal","status":"ENABLED","type":"network-monitoring/access-point-monitoring","vlan":"1","wlanName":"wlan1"}],"next":null,"total":1}},"ThreatDetailResponse__f8f342aecdae":{"examples":[{"affectedProducts":"Android","attackTarget":"Client_Endpoint","category":"MOBILE_MALWARE","createdAt":"2024-11-10T00:01:43.000Z","cveReference":"CVE-2007-0015","description":"Android Mobile Malware is software that is used specifically to compromise the Android operating system","destCity":"New York","deviceMac":"20:4c:03:d3:2b:58","deviceType":"GATEWAY","generation":1,"id":"threat~1734212641997~0~29310-7","impact":"Compromised Workstation","malwareFamily":"Android_SmsThief","mitreTags":[{"mitreTacticName":"Initial_Access","mitreTechniqueName":"Exploit_Public_Facing_Application"},{"mitreTacticName":"Lateral_Movement","mitreTechniqueName":"Exploitation_Of_Remote_Services"}],"severity":"Critical","signatureId":2826904,"signatureName":"Trojan-Spy.AndroidOS.SmsThief.fe SMS/Contact Exfil via SMTP","siteId":"9902688897","siteName":"CN-BROOKE-IDPS","srcCity":"Belfast","srcIp":"80.0.0.11","summary":"This alert is triggered when traffic matching a known Command and Control pattern is observed","type":"network-monitoring/idps","updatedAt":"2024-11-10T00:01:43.000Z","userName":"user1"}],"properties":{"affectedProducts":{"$ref":"#/components/schemas/AffectedProducts__f8f342aecdae"},"attackTarget":{"$ref":"#/components/schemas/AttackTarget__f8f342aecdae"},"category":{"$ref":"#/components/schemas/Category__f8f342aecdae"},"createdAt":{"$ref":"#/components/schemas/CreatedAt__7006262f8c4c"},"cveReference":{"$ref":"#/components/schemas/CveReference__7006262f8c4c"},"description":{"$ref":"#/components/schemas/Description__7006262f8c4c"},"destCity":{"$ref":"#/components/schemas/DestCity__7006262f8c4c"},"deviceMac":{"$ref":"#/components/schemas/DeviceMac__f8f342aecdae"},"deviceType":{"$ref":"#/components/schemas/DeviceType__f8f342aecdae"},"generation":{"$ref":"#/components/schemas/Generation__7006262f8c4c"},"id":{"$ref":"#/components/schemas/Id__7006262f8c4c"},"impact":{"$ref":"#/components/schemas/Impact__f8f342aecdae"},"malwareFamily":{"$ref":"#/components/schemas/MalwareFamily__7006262f8c4c"},"mitreTags":{"description":"The MITRE tags associated with the threat.\n","items":{"$ref":"#/components/schemas/MitreTags__f8f342aecdae"},"type":"array"},"severity":{"$ref":"#/components/schemas/Severity__7006262f8c4c"},"signatureId":{"$ref":"#/components/schemas/SignatureId__7006262f8c4c"},"signatureName":{"$ref":"#/components/schemas/SignatureName__7006262f8c4c"},"siteId":{"$ref":"#/components/schemas/SiteID__05867e444b37"},"siteName":{"$ref":"#/components/schemas/SiteName__05867e444b37"},"srcCity":{"$ref":"#/components/schemas/SrcCity__7006262f8c4c"},"srcIp":{"$ref":"#/components/schemas/SrcIp__7006262f8c4c"},"summary":{"$ref":"#/components/schemas/Summary__f8f342aecdae"},"type":{"$ref":"#/components/schemas/Type__7006262f8c4c"},"updatedAt":{"$ref":"#/components/schemas/UpdatedAt__7006262f8c4c"},"userName":{"$ref":"#/components/schemas/UserName__7006262f8c4c"}},"required":["affectedProducts","attackTarget","category","cveReference","description","destCity","deviceMac","deviceType","id","impact","malwareFamily","mitreTags","severity","signatureId","signatureName","siteId","siteName","srcCity","srcIp","summary","type","userName","generation","createdAt","updatedAt"],"type":"object"},"ThreatListResponse__7006262f8c4c":{"allOf":[{"properties":{"items":{"items":{"properties":{"action":{"$ref":"#/components/schemas/Action__7006262f8c4c"},"appProto":{"$ref":"#/components/schemas/AppProto__7006262f8c4c"},"clientMacaddr":{"$ref":"#/components/schemas/ClientMacaddr__7006262f8c4c"},"createdAt":{"$ref":"#/components/schemas/CreatedAt__7006262f8c4c"},"customerId":{"$ref":"#/components/schemas/CustomerId__7006262f8c4c"},"cveReference":{"$ref":"#/components/schemas/CveReference__7006262f8c4c"},"description":{"$ref":"#/components/schemas/Description__7006262f8c4c"},"destCity":{"$ref":"#/components/schemas/DestCity__7006262f8c4c"},"destCountry":{"$ref":"#/components/schemas/DestCountry__7006262f8c4c"},"destIp":{"$ref":"#/components/schemas/DestIp__7006262f8c4c"},"destPort":{"$ref":"#/components/schemas/DestPort__7006262f8c4c"},"deviceIp":{"$ref":"#/components/schemas/DeviceIp__7006262f8c4c"},"deviceModel":{"$ref":"#/components/schemas/DeviceModel__7006262f8c4c"},"deviceName":{"$ref":"#/components/schemas/DeviceName__7006262f8c4c"},"deviceSerialNum":{"$ref":"#/components/schemas/DeviceSerialNum__7006262f8c4c"},"flowId":{"$ref":"#/components/schemas/FlowId__7006262f8c4c"},"generation":{"$ref":"#/components/schemas/Generation__7006262f8c4c"},"groupId":{"$ref":"#/components/schemas/GroupId__7006262f8c4c"},"groupName":{"$ref":"#/components/schemas/GroupName__7006262f8c4c"},"id":{"$ref":"#/components/schemas/Id__7006262f8c4c"},"malwareFamily":{"$ref":"#/components/schemas/MalwareFamily__7006262f8c4c"},"occurredAt":{"$ref":"#/components/schemas/Timestamp__7006262f8c4c"},"proto":{"$ref":"#/components/schemas/Proto__7006262f8c4c"},"severity":{"$ref":"#/components/schemas/Severity__7006262f8c4c"},"signatureId":{"$ref":"#/components/schemas/SignatureId__7006262f8c4c"},"signatureName":{"$ref":"#/components/schemas/SignatureName__7006262f8c4c"},"siteId":{"$ref":"#/components/schemas/SiteID__05867e444b37"},"siteName":{"$ref":"#/components/schemas/SiteName__05867e444b37"},"srcCity":{"$ref":"#/components/schemas/SrcCity__7006262f8c4c"},"srcCountry":{"$ref":"#/components/schemas/SrcCountry__7006262f8c4c"},"srcIp":{"$ref":"#/components/schemas/SrcIp__7006262f8c4c"},"srcPort":{"$ref":"#/components/schemas/SrcPort__7006262f8c4c"},"strategy":{"$ref":"#/components/schemas/Strategy__7006262f8c4c"},"type":{"$ref":"#/components/schemas/Type__7006262f8c4c"},"updatedAt":{"$ref":"#/components/schemas/UpdatedAt__7006262f8c4c"},"userName":{"$ref":"#/components/schemas/UserName__7006262f8c4c"},"userRole":{"$ref":"#/components/schemas/UserRole__7006262f8c4c"}},"required":["action","appProto","clientMacaddr","customerId","cveReference","description","destCity","destCountry","destIp","destPort","deviceIp","deviceModel","deviceName","deviceSerialNum","flowId","groupId","groupName","id","malwareFamily","proto","severity","signatureId","signatureName","siteId","siteName","srcCity","srcCountry","srcIp","srcPort","strategy","occurredAt","type","userName","userRole","generation","createdAt","updatedAt"],"type":"object"},"maxItems":1000,"type":"array"}},"required":["items"],"type":"object"},{"$ref":"#/components/schemas/PaginatedResponse__7006262f8c4c"}],"examples":[{"count":1,"items":[{"action":"ALLOWED","appProto":"APP_SMTP","clientMacaddr":"00:1A:2B:3C:4D:5E","createdAt":"2024-11-10T00:01:43.000Z","customerId":"fc0cafa0853011efae90929e7bxxxxxx","cveReference":"CVE-2007-0015","description":"WEB_CLIENT signatures are designed to alert on attacks against web client software","destCity":"New York","destCountry":"USA","destIp":"192.168.1.1","destPort":90,"deviceIp":"192.168.1.2","deviceModel":"ModelX","deviceName":"DeviceX","deviceSerialNum":"SN123456","flowId":123456,"generation":1,"groupId":"group123","groupName":"GroupName","id":"id123","malwareFamily":null,"occurredAt":"2024-11-10T00:01:43.009Z","proto":"TCP","severity":"high","signatureId":2000007,"signatureName":"Catalyst SSH protocol mismatch","siteId":"site123","siteName":"SiteName","srcCity":"Los Angeles","srcCountry":"USA","srcIp":"192.168.1.3","srcPort":8080,"strategy":"strategyX","type":"network-monitoring/idps","updatedAt":"2024-11-10T00:01:43.000Z","userName":"user123","userRole":"admin"}],"offset":11,"total":103}]},"Tier__cd77b09562fb":{"description":"Tier represents the license tier associated with the device. This tier indicates the level of features and capabilities that are available for the device based on the license.","example":"ADVANCED_SWITCH_6300","format":"const","maxLength":32,"type":"string"},"Timestamp__306cd00aed2d":{"description":"Timestamp in ISO 8601 format with a precision of seconds. \nThe time is in the UTC timezone.\n\nFormat: [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss]\n","examples":["2023-02-14T12:23:00.000Z"],"format":"const","maxLength":128,"type":["string"]},"Timestamp__7006262f8c4c":{"description":"The timestamp (RFC 3339 UTC+0) at which the threat occurred.\n","examples":["2024-11-10T00:01:43.345Z"],"format":"date-time","type":"string"},"ToChannel__972dd6d46bea":{"description":"Specifies the channel to which the client roamed.","example":"50","type":"string"},"TooManyRequest__004689200476":{"description":"Too many requests error details returned from the server.","properties":{"debugId":{"$ref":"#/components/schemas/DebugIdtopology__004689200476"},"errorCode":{"description":"* A unique machine-friendly, but human-readable identifier for the error. It has prefix HPE_GL_.* For more details regarding error please refer to error message","example":"HPE_GL_ERROR_TOO_MANY_REQUESTS","maxLength":256,"type":"string"},"httpStatusCode":{"description":"HTTP status code.","example":429,"maximum":429,"minimum":429,"type":"integer"},"message":{"$ref":"#/components/schemas/ErrorMessagedevice__039ba698cb40"}},"required":["httpStatusCode","errorCode","message","debugId"],"type":"object"},"TooManyRequestsErrorDetails__0c2a95c4aa99":{"description":"Error details returned from the server.","properties":{"debugId":{"$ref":"#/components/schemas/DebugId__0c2a95c4aa99"},"errorCode":{"description":"Internal error code.","example":"HPE_GL_NETWORK_NOTIFICATIONS_TOO_MANY_REQUESTS","maxLength":128,"type":"string"},"httpStatusCode":{"description":"HTTP status code.","example":429,"maximum":429,"minimum":429,"type":"integer"},"message":{"description":"Error message indicating the cause of the failure.","example":"Too Many Requests. Rate limit exceeded.","maxLength":512,"type":"string"}},"required":["httpStatusCode","errorCode","message","debugId"],"type":"object"},"TooManyRequestsError__66b457073e9b":{"description":"Too many requests error details returned from the server.\n","properties":{"debugId":{"$ref":"#/components/schemas/DebugId__0288a339fc72"},"errorCode":{"description":"* A unique machine-friendly, but human-readable identifier for the error. It has prefix HPE_GL_.\n* For more details regarding error please refer to error message\n","examples":["HPE_GL_ERROR_TOO_MANY_REQUESTS"],"maxLength":256,"type":"string"},"httpStatusCode":{"description":"HTTP status code.\n","examples":[429],"maximum":429,"minimum":429,"type":"integer"},"message":{"$ref":"#/components/schemas/ErrorMessage__66b457073e9b"}},"required":["httpStatusCode","errorCode","message","debugId"],"type":"object"},"TooManyRequestsError__6ff1f6639f14":{"description":"Too many requests error details returned from the server.\n","properties":{"debugId":{"$ref":"#/components/schemas/DebugId__000172564380"},"errorCode":{"description":"* A unique machine-friendly, but human-readable identifier for the error. It has prefix HPE_GL_.\n* For more details regarding error please refer to error message\n","example":"HPE_GL_ERROR_TOO_MANY_REQUESTS","maxLength":256,"type":"string"},"httpStatusCode":{"description":"HTTP status code.\n","example":429,"maximum":429,"minimum":429,"type":"integer"},"message":{"$ref":"#/components/schemas/ErrorMessage__6ff1f6639f14"}},"required":["httpStatusCode","errorCode","message","debugId"],"type":"object"},"TooManyRequests__000172564380":{"description":"Too many requests based on rate limit","properties":{"debugId":{"$ref":"#/components/schemas/debugIdwifi__000172564380"},"errorCode":{"description":"* A unique machine-friendly, but human-readable identifier for the error. It has prefix HPE_GL_.\n* For more details regarding error please refer to error message\n","example":"HPE_GL_ERROR_TOO_MANY_REQUESTS","maxLength":256,"type":"string"},"httpStatusCode":{"description":"HTTP status code.\n","example":"429","maximum":429,"minimum":429,"type":"integer"},"message":{"$ref":"#/components/schemas/message__000172564380"}},"required":["httpStatusCode","errorCode","message","debugId"],"type":"object"},"TopAPsLimit__1ff3457b62c0":{"default":10,"example":20,"format":"int64","maximum":25,"minimum":0,"type":"integer"},"TopAccessPoint__1ff3457b62c0":{"properties":{"deviceName":{"$ref":"#/components/schemas/DeviceNameap__1ff3457b62c0"},"id":{"$ref":"#/components/schemas/ID__c0c1228d8f7d"},"serialNumber":{"$ref":"#/components/schemas/SerialNumberap__1ff3457b62c0"},"totalValue":{"description":"The overall amount of bandwidth used by the access point\n","example":118800.6,"format":"double","maximum":9223372036854776000,"minimum":0,"type":"number"},"type":{"$ref":"#/components/schemas/Typeap__05867e444b37"},"units":{"description":"The unit for measuring bandwidth usage value is set to Bytes by default.\n","enum":["Bytes"],"example":"Bytes","maxLength":10,"type":"string"}},"required":["serialNumber","deviceName","totalValue","units","id","type"],"type":"object"},"TopAccessPointsResponse__1ff3457b62c0":{"example":{"count":1,"items":[{"deviceName":"ap_1","id":"AP00000001","serialNumber":"AP00000001","totalValue":118800.6,"type":"network-monitoring/access-point-monitoring","units":"Bytes"}]},"properties":{"count":{"description":"Number of items in the response","example":1,"type":"integer"},"items":{"description":"The list of access points bandwidth usage","items":{"$ref":"#/components/schemas/TopAccessPoint__1ff3457b62c0"},"maxItems":100,"type":"array"}},"required":["items","count"],"type":"object"},"TopnInterfaceTrendsResponse__f1560a40cf92":{"description":"Response containing interface trends related to the switches.","properties":{"count":{"description":"Total number of switches.","example":2,"type":"integer"},"items":{"description":"Object containing interface trends related to the switches.","items":{"$ref":"#/components/schemas/TopnInterfaceTrends__f1560a40cf92"},"type":"array"}},"required":["items","count"],"type":"object"},"TopnInterfaceTrends__f1560a40cf92":{"description":"Response containing interface trends related to the switch.","properties":{"id":{"description":"tenant id.","example":"720f147c3de211ef99bca6b05da42930","type":"string"},"name":{"description":"Hostname of the switch","example":"HP2530-24G-PoEP Switch","type":"string"},"rxBytes":{"description":"rxbytes of the switch","example":788724,"format":"int64","type":"integer"},"serial":{"description":"Serial number of switch","example":"CN95367H9C","type":"string"},"siteId":{"description":"Site-id of the switch","example":"22966851366752256","type":"string"},"txBytes":{"description":"txBytes of the switch","example":758346,"format":"int64","type":"integer"},"type":{"description":"Device type of monitoring.","example":"network-monitoring/switch-monitoring","type":"string"}},"required":["id","type"],"type":"object"},"TopologyPort__b8d35392fbec":{"properties":{"health":{"description":"The health status of the port","example":"Good","type":"string"},"healthReason":{"description":"The health reason of the port","example":null,"type":"string"},"index":{"description":"The index of the port","example":1,"type":"integer"},"lag":{"description":"LAG (Link Aggregation Group) name if applicable","example":"lag1","type":"string"},"name":{"description":"The name of the port","example":"1/1/48","type":"string"}},"type":"object"},"Topology__b8d35392fbec":{"description":"Topology details for a given site","properties":{"devices":{"$ref":"#/components/schemas/Devices__b8d35392fbec"},"id":{"$ref":"#/components/schemas/Idtopology__004689200476"},"isolatedDevicesCount":{"description":"The number of isolated devices in the topology.","example":3,"type":"integer"},"isolatedHealth":{"description":"Overall health status of isolated devices.","example":"Poor","maxLength":32,"type":"string"},"links":{"$ref":"#/components/schemas/Links__b8d35392fbec"},"type":{"description":"API type.","example":"Topology","format":"const","maxLength":16,"type":"string"}},"required":["id","type"],"type":"object"},"Total__7006262f8c4c":{"description":"Specifies the total number of items available for a given filter query.\n","examples":[100],"format":"int64","type":"integer"},"Total__c0c1228d8f7d":{"description":"Specifies the total number of items available for a given filter query.\n","example":10,"format":"int64","type":"integer"},"Totalapp__7c5b5fe9ca66":{"description":"Total count of items that meet the API request parameters.\n","example":0,"format":"int64","type":"integer"},"Totaldevice__6b9c5f08b869":{"description":"Specifies the total number of items available for a given filter query.","example":10,"format":"int64","type":"integer"},"Totalfirewall__4689c9697989":{"description":"The total number of items that meet the API request parameters.\n","example":0,"format":"int64","type":"integer"},"Totalsite__7f65987649fe":{"description":"Specifies the total number of sites available for a given customer.\n","example":10,"format":"int64","type":"integer"},"TracerouteApParsedOutput__03efdde95a47":{"properties":{"destination":{"description":"The destination host name or IP address for the traceroute command.","type":"string"},"hops":{"description":"Details for a single traceroute hop.","items":{"$ref":"#/components/schemas/TracerouteApTracerouterowresult__03efdde95a47"},"type":"array"},"resolvedIp":{"description":"The IP address resolved from the destination host.","type":"string"}},"title":"AP TRACEROUTE RESPONSE","type":"object"},"TracerouteApRequest__40b936d0123d":{"properties":{"destination":{"description":"Hostname/IP address required","type":"string"},"includeRawOutput":{"description":"Whether to include raw output in the response.","type":"boolean"},"sourceInterface":{"description":"","type":"string"}},"required":["destination"],"title":"AP TRACEROUTE REQUEST","type":"object"},"TracerouteApResult__03efdde95a47":{"allOf":[{"$ref":"#/components/schemas/AsyncOperationResultBase__03efdde95a47"},{"properties":{"output":{"allOf":[{"$ref":"#/components/schemas/TracerouteApParsedOutput__03efdde95a47"}],"type":["object","null"]},"rawOutput":{"description":"The raw output of the test.","type":"string"}},"type":"object"}],"title":"AP TRACEROUTE RESULT"},"TracerouteApTracerouteproberesult__03efdde95a47":{"properties":{"ipAddress":{"description":"The IP address of the probe.","type":"string"},"responseTimeMilliseconds":{"description":"The response time of the probe in milliseconds.","type":"string"},"reverseDnsResolution":{"description":"The reverse DNS resolution of the probe.","type":"string"}},"title":"AP TRACEROUTE PROBE","type":"object"},"TracerouteApTracerouterowresult__03efdde95a47":{"properties":{"hop":{"description":"The hop number in the traceroute.","type":"string"},"probes":{"description":"Details of the probes used in the traceroute.","items":{"$ref":"#/components/schemas/TracerouteApTracerouteproberesult__03efdde95a47"},"type":"array"}},"title":"AP TRACEROUTE ROW","type":"object"},"TracerouteCxParsedOutput__8e9868fc7ec0":{"properties":{"destination":{"description":"The destination host name or IP address for the traceroute command.","type":"string"},"hops":{"description":"Details for a single traceroute hop.","items":{"$ref":"#/components/schemas/TracerouteCxTracerouterowresult__8e9868fc7ec0"},"type":"array"},"resolvedIp":{"description":"The IP address resolved from the destination host.","type":"string"}},"title":"CX TRACEROUTE RESPONSE","type":"object"},"TracerouteCxRequest__8c88e69cb498":{"properties":{"destination":{"description":"Hostname/IP address required","type":"string"},"includeRawOutput":{"description":"Whether to include raw output in the response.","type":"boolean"},"useIpv6":{"description":"Use IPv6","type":"boolean"},"useManagementInterface":{"description":"Use management interface","type":"boolean"},"vrfName":{"description":"The default value is 'default'","type":"string"}},"required":["destination"],"title":"CX TRACEROUTE REQUEST","type":"object"},"TracerouteCxResult__8e9868fc7ec0":{"allOf":[{"$ref":"#/components/schemas/AsyncOperationResultBase__03efdde95a47"},{"properties":{"output":{"allOf":[{"$ref":"#/components/schemas/TracerouteCxParsedOutput__8e9868fc7ec0"}],"type":["object","null"]},"rawOutput":{"description":"The raw output of the test.","type":"string"}},"type":"object"}],"title":"CX TRACEROUTE RESULT"},"TracerouteCxTracerouteproberesult__8e9868fc7ec0":{"properties":{"ipAddress":{"description":"The IP address of the probe.","type":"string"},"responseTimeMilliseconds":{"description":"The response time of the probe in milliseconds.","type":"string"},"reverseDnsResolution":{"description":"The reverse DNS resolution of the probe.","type":"string"}},"title":"CX TRACEROUTE PROBE","type":"object"},"TracerouteCxTracerouterowresult__8e9868fc7ec0":{"properties":{"hop":{"description":"The hop number in the traceroute.","type":"string"},"probes":{"description":"Details of the probes used in the traceroute.","items":{"$ref":"#/components/schemas/TracerouteCxTracerouteproberesult__8e9868fc7ec0"},"type":"array"}},"title":"CX TRACEROUTE ROW","type":"object"},"TracerouteHppcParsedOutput__c1b1032af793":{"properties":{"destination":{"description":"The destination host name or IP address for the traceroute command.","type":"string"},"hops":{"description":"Details for a single traceroute hop.","items":{"$ref":"#/components/schemas/TracerouteHppcTracerouterowresult__c1b1032af793"},"type":"array"}},"title":"AOS-S TRACEROUTE RESPONSE","type":"object"},"TracerouteHppcRequest__91e04df244b6":{"properties":{"destination":{"description":"Hostname/IP address required","type":"string"},"includeRawOutput":{"description":"Whether to include raw output in the response.","type":"boolean"},"ipAddress":{"description":"","type":"string"},"loopbackPort":{"description":"","type":"integer"},"sourceInterface":{"description":"","enum":["loopback","vlan-interface","ip-address"],"type":"string"},"vlan":{"description":"","type":"integer"}},"required":["destination"],"title":"AOS-S TRACEROUTE REQUEST","type":"object"},"TracerouteHppcResult__c1b1032af793":{"allOf":[{"$ref":"#/components/schemas/AsyncOperationResultBase__03efdde95a47"},{"properties":{"output":{"allOf":[{"$ref":"#/components/schemas/TracerouteHppcParsedOutput__c1b1032af793"}],"type":["object","null"]},"rawOutput":{"description":"The raw output of the test.","type":"string"}},"type":"object"}],"title":"AOS-S TRACEROUTE RESULT"},"TracerouteHppcTracerouteproberesult__c1b1032af793":{"properties":{"ipAddress":{"description":"The IP address of the probe.","type":"string"},"responseTimeMilliseconds":{"description":"The response time of the probe in milliseconds.","type":"string"},"reverseDnsResolution":{"description":"The reverse DNS resolution of the probe.","type":"string"}},"title":"AOS-S TRACEROUTE PROBE","type":"object"},"TracerouteHppcTracerouterowresult__c1b1032af793":{"properties":{"hop":{"description":"The hop number in the traceroute.","type":"string"},"probes":{"description":"Details of the probes used in the traceroute.","items":{"$ref":"#/components/schemas/TracerouteHppcTracerouteproberesult__c1b1032af793"},"type":"array"}},"title":"AOS-S TRACEROUTE ROW","type":"object"},"TracerouteMcParsedOutput__a85855bba103":{"properties":{"destination":{"description":"The destination host name or IP address for the traceroute command.","type":"string"},"hops":{"description":"Details for a single traceroute hop.","items":{"$ref":"#/components/schemas/TracerouteMcTracerouterowresult__a85855bba103"},"type":"array"}},"title":"GATEWAY TRACEROUTE RESPONSE","type":"object"},"TracerouteMcRequest__ad10a58c7624":{"properties":{"destination":{"description":"Hostname/IP address required","type":"string"},"includeRawOutput":{"description":"Whether to include raw output in the response.","type":"boolean"},"vlanIp":{"description":"","type":"string"}},"required":["destination"],"title":"GATEWAY TRACEROUTE REQUEST","type":"object"},"TracerouteMcResult__a85855bba103":{"allOf":[{"$ref":"#/components/schemas/AsyncOperationResultBase__03efdde95a47"},{"properties":{"output":{"allOf":[{"$ref":"#/components/schemas/TracerouteMcParsedOutput__a85855bba103"}],"type":["object","null"]},"rawOutput":{"description":"The raw output of the test.","type":"string"}},"type":"object"}],"title":"GATEWAY TRACEROUTE RESULT"},"TracerouteMcTracerouteproberesult__a85855bba103":{"properties":{"ipAddress":{"description":"The IP address of the probe.","type":"string"},"responseTimeMilliseconds":{"description":"The response time of the probe in milliseconds.","type":"string"},"reverseDnsResolution":{"description":"The reverse DNS resolution of the probe.","type":"string"}},"title":"GATEWAY TRACEROUTE PROBE","type":"object"},"TracerouteMcTracerouterowresult__a85855bba103":{"properties":{"hop":{"description":"The hop number in the traceroute.","type":"string"},"probes":{"description":"Details of the probes used in the traceroute.","items":{"$ref":"#/components/schemas/TracerouteMcTracerouteproberesult__a85855bba103"},"type":"array"}},"title":"GATEWAY TRACEROUTE ROW","type":"object"},"TunnelActive__0f1d40c88b6b":{"description":"Indicates whether the tunnel is active.","example":true,"type":"boolean"},"TunnelId__0f1d40c88b6b":{"description":"Tunnel ID of an access point tunnel","example":"gw-ipsecmap.11.22.33.44~Primary","format":"const","maxLength":256,"type":"string"},"TunnelIdclients__284f33982989":{"description":"Specifies the tunnel ID associated with the client.","example":0,"type":"integer"},"TunnelIdentifier__0f1d40c88b6b":{"description":"Identifier for the resource.","example":"AP00000001/tunnels/c2c_tunnel_01~Primary","format":"const","maxLength":36,"type":"string"},"TunnelIdgw__2ca376caec3f":{"description":"The name of the tunnel configured in the gateway.\n","example":"Tunnel_1","maxLength":256,"type":"string"},"TunnelIndex__0f1d40c88b6b":{"description":"The index of the tunnel","example":"Primary","format":"const","maxLength":32,"type":"string"},"TunnelLastChangeReason__0f1d40c88b6b":{"description":"The reason for the last status change of the tunnel.","example":"Uplink Deleted","format":"const","maxLength":128,"type":"string"},"TunnelName__0f1d40c88b6b":{"description":"The name of the tunnel.","example":"c2c_tunnel_01","format":"const","maxLength":256,"type":"string"},"TunnelNotFoundError__0f1d40c88b6b":{"description":"Tunnel not found error details returned from the server.\n","properties":{"debugId":{"$ref":"#/components/schemas/DebugId__000172564380"},"errorCode":{"description":"* A unique, machine-friendly, but human-readable identifier for the error. It has the prefix HPE_GL_.\n* For more details regarding the error please refer to the error message\n","enum":["HPE_GL_NETWORK_MONITORING_TUNNEL_NOT_FOUND"],"example":"HPE_GL_NETWORK_MONITORING_TUNNEL_NOT_FOUND","format":"const","maxLength":256,"type":"string"},"httpStatusCode":{"description":"The HTTP status code.\n","example":404,"maximum":404,"minimum":404,"type":"integer"},"message":{"$ref":"#/components/schemas/ErrorMessageap__0f1d40c88b6b"}},"required":["httpStatusCode","errorCode","message","debugId"],"type":"object"},"TunnelStatus__0f1d40c88b6b":{"description":"The current status of the tunnel.","example":"Up","format":"const","maxLength":16,"type":"string"},"TunnelThroughputTrend__ed3aa0a73a3f":{"example":{"graph":{"keys":["tx","rx"],"samples":[{"data":[10,12],"timestamp":"2022-07-30T20:00:00Z"}],"samplingIntervalInMinutes":5},"id":"AP00000001/tunnels/Tunnel1~Primary","metric":"tunnel_throughput","type":"network-monitoring/access-point-monitoring"},"properties":{"graph":{"properties":{"keys":{"description":"List of metrics which helps to evaluate the throughput trend of an access point tunnel.\n","example":["tx","rx"],"items":{"format":"const","type":"string"},"maxItems":2,"type":"array"},"samples":{"items":{"$ref":"#/components/schemas/GraphDataPoint__05867e444b37"},"maxItems":10000,"type":"array"},"samplingIntervalInMinutes":{"$ref":"#/components/schemas/SamplingIntervalInMinutes__05867e444b37"}},"required":["keys","samples","samplingIntervalInMinutes"],"type":"object"},"id":{"$ref":"#/components/schemas/ID__c0c1228d8f7d"},"metric":{"description":"Metric for the throughput trend of an access point tunnel.","example":"tunnel_throughput","format":"const","maxLength":128,"type":"string"},"type":{"$ref":"#/components/schemas/Typeap__05867e444b37"}},"required":["metric","graph","id","type"],"type":"object"},"TunnelType__284f33982989":{"description":"Specifies the tunnel type associated with the client. Possible values are \"Port-based\", \"User-based\", \"Overlay\", and \"None\". \"None\" indicates no tunnel.","example":"Overlay","type":"string"},"TunnelUptimeInMillis__0f1d40c88b6b":{"description":"The uptime of the tunnel in milliseconds.","example":3600000,"format":"int64","type":"integer"},"TxUtilization__34350f7e707e":{"description":"Represents the percentage of transmission utilization by the radio.\n","example":21,"maxLength":16,"type":"string"},"Type__7006262f8c4c":{"description":"The type of the resource.\n","examples":["network-monitoring/idps"],"maxLength":64,"type":"string"},"Type__c0c1228d8f7d":{"description":"The type of the resource.\n","example":"network-services/firmware-management","format":"const","maxLength":36,"type":"string"},"Type__c34075768619":{"description":"Specifies the report type. Valid values can be got dynamically via GET /network-reporting/v1/reports-meta.","examples":["inventory"],"type":"string"},"Typeap__05867e444b37":{"description":"The type of the resource.\n","example":"network-monitoring/access-point-monitoring","format":"const","maxLength":36,"type":"string"},"Typeclients__284f33982989":{"description":"The type of the resource.\n","example":"network-monitoring/client-monitoring","format":"const","maxLength":36,"type":"string"},"Typedevice__0288a339fc72":{"description":"The type of the resource.","example":"network-monitoring/device-monitoring","format":"const","maxLength":36,"type":"string"},"Typegw__1053ccf03958":{"description":"The type of the resource.\n","example":"network-monitoring/gateway-monitoring","maxLength":36,"type":"string"},"Typewebhooks__715550e8d02e":{"description":"The API group of the resource.\n","example":"network-services","format":"const","maxLength":36,"type":"string"},"Typewifi__3f58b16772b5":{"description":"Resource type.\n","example":"network-services/wifi-client-locations","format":"const","maxLength":40,"type":"string"},"UnauthorizedErrorDetails__0c2a95c4aa99":{"description":"Error details returned from the server.","properties":{"debugId":{"$ref":"#/components/schemas/DebugId__0c2a95c4aa99"},"errorCode":{"description":"Internal error code.","example":"HPE_GL_NETWORK_NOTIFICATIONS_UNAUTHORIZED","maxLength":128,"type":"string"},"httpStatusCode":{"description":"HTTP status code.","example":401,"maximum":401,"minimum":401,"type":"integer"},"message":{"description":"Error message indicating the cause of the failure.","example":"Unauthorized request.","maxLength":512,"type":"string"}},"required":["httpStatusCode","errorCode","message","debugId"],"type":"object"},"UnauthorizedError__66b457073e9b":{"description":"Unauthorized error details returned from the server.\n","properties":{"debugId":{"$ref":"#/components/schemas/DebugId__0288a339fc72"},"errorCode":{"description":"* A unique machine-friendly, but human-readable identifier for the error. It has prefix HPE_GL_.\n* For more details regarding error please refer to error message\n","examples":["HPE_GL_ERROR_UNAUTHORIZED"],"maxLength":256,"type":"string"},"httpStatusCode":{"description":"HTTP status code.\n","examples":[401],"maximum":401,"minimum":401,"type":"integer"},"message":{"$ref":"#/components/schemas/ErrorMessage__66b457073e9b"}},"required":["httpStatusCode","errorCode","message","debugId"],"type":"object"},"UnauthorizedError__6ff1f6639f14":{"description":"Unauthorized error details returned from the server.\n","properties":{"debugId":{"$ref":"#/components/schemas/DebugId__000172564380"},"errorCode":{"description":"* A unique machine-friendly, but human-readable identifier for the error. It has prefix HPE_GL_.\n* For more details regarding error please refer to error message\n","example":"HPE_GL_ERROR_UNAUTHORIZED","maxLength":256,"type":"string"},"httpStatusCode":{"description":"HTTP status code.\n","example":401,"maximum":401,"minimum":401,"type":"integer"},"message":{"$ref":"#/components/schemas/ErrorMessage__6ff1f6639f14"}},"required":["httpStatusCode","errorCode","message","debugId"],"type":"object"},"Unauthorized__000172564380":{"description":"Missing authorization in request","properties":{"debugId":{"$ref":"#/components/schemas/debugIdwifi__000172564380"},"errorCode":{"description":"* A unique machine-friendly, but human-readable identifier for the error. It has prefix HPE_GL_.\n* For more details regarding error please refer to error message\n","example":"HPE_GL_ERROR_UNAUTHORIZED","maxLength":256,"type":"string"},"httpStatusCode":{"description":"HTTP status code.\n","example":"401","maximum":401,"minimum":401,"type":"integer"},"message":{"$ref":"#/components/schemas/message__000172564380"}},"required":["httpStatusCode","errorCode","message","debugId"],"type":"object"},"Unauthorized__004689200476":{"description":"Unauthorized error details returned from the server.","properties":{"debugId":{"$ref":"#/components/schemas/DebugIdtopology__004689200476"},"errorCode":{"description":"* A unique machine-friendly, but human-readable identifier for the error. It has prefix HPE_GL_.* For more details regarding error please refer to error message","example":"HPE_GL_ERROR_UNAUTHORIZED","maxLength":256,"type":"string"},"httpStatusCode":{"description":"HTTP status code.","example":401,"maximum":401,"minimum":401,"type":"integer"},"message":{"$ref":"#/components/schemas/ErrorMessagedevice__039ba698cb40"}},"required":["httpStatusCode","errorCode","message","debugId"],"type":"object"},"UnmanagedDevice__004689200476":{"description":"Unmanaged device details for a given site","properties":{"description":{"description":"Additional description or notes about the device","example":"Connected unmanaged edge switch","type":"string"},"enabledCapability":{"description":"Capabilities currently enabled on the device.","example":"L2, PoE","type":"string"},"id":{"$ref":"#/components/schemas/Idtopology__004689200476"},"mac":{"description":"MAC address of the device","example":"00:1A:2B:3C:4D:5E","type":"string"},"name":{"description":"Name of the unmanaged device","example":"Unmanaged-Switch-01","type":"string"},"serial":{"description":"This value follows the format tpd_<mac>, where the mac address is used without colons","example":"tpd_883a3094c340","type":"string"},"status":{"description":"Operational status of the device","example":"Active","type":"string"},"supportedCapability":{"description":"Capabilities supported by the device","example":"L2, L3, PoE","type":"string"},"type":{"description":"Device type, e.g., Switch, Router, Access Point","example":"Switch","type":"string"},"vendor":{"description":"Vendor or manufacturer of the device","example":"Cisco","type":"string"}},"required":["id","type"],"type":"object"},"UnprocessableEntityErrorDetails__4e865062885b":{"description":"Error details returned when semantic validation fails (e.g., invalid email format, unknown alertName).","properties":{"debugId":{"$ref":"#/components/schemas/DebugId__0c2a95c4aa99"},"errorCode":{"description":"Internal error code.","example":"HPE_GL_NETWORK_NOTIFICATIONS_UNPROCESSABLE_ENTITY","maxLength":128,"type":"string"},"httpStatusCode":{"description":"HTTP status code.","example":422,"maximum":422,"minimum":422,"type":"integer"},"message":{"description":"Error message indicating the cause of the failure.","example":"Unprocessable Entity. The request was well-formed but failed semantic validation.","maxLength":512,"type":"string"}},"required":["httpStatusCode","errorCode","message","debugId"],"type":"object"},"UnsupportedMediaTypeError__039ba698cb40":{"description":"Unsupported media type error details returned from the server.","properties":{"debugId":{"$ref":"#/components/schemas/DebugIddevice__039ba698cb40"},"errorCode":{"description":"* A unique, machine-friendly, but human-readable identifier for the error. It has the prefix HPE_GL_.\n* For more details regarding the error please refer to the error message.","enum":["HPE_GL_NETWORK_MONITORING_UNSUPPORTED_MEDIA_TYPE"],"example":"HPE_GL_NETWORK_MONITORING_UNSUPPORTED_MEDIA_TYPE","maxLength":256,"type":"string"},"httpStatusCode":{"description":"The HTTP status code.","example":415,"maximum":415,"minimum":415,"type":"integer"},"message":{"$ref":"#/components/schemas/ErrorMessagedevice__039ba698cb40"}},"required":["httpStatusCode","errorCode","message","debugId"],"type":"object"},"UpdateDeviceNotesData__2d2b84f6c2b4":{"example":{"notes":"Device is located in Building A, Floor 2"},"properties":{"notes":{"description":"Updated notes for the device.","example":"Device is located in Building A, Floor 2","maxLength":2048,"type":"string"}},"required":["notes"],"type":"object"},"UpdateDeviceNotesRequestV1__2d2b84f6c2b4":{"properties":{"notes":{"description":"Notes to be updated for the device. This field contains user-provided notes.","example":"Device is located in Building A, Floor 2","maxLength":256,"type":"string"}},"required":["notes"],"type":"object"},"UpdateNotesAsyncRequest__039ba698cb40":{"properties":{"devices":{"description":"List of devices with notes to update. Maximum 1000 items.","items":{"$ref":"#/components/schemas/DeviceNotesInput__039ba698cb40"},"maxItems":1000,"minItems":1,"type":"array"}},"required":["devices"],"type":"object"},"UpdatedAt__2efde5827a74":{"description":"Time when the resource was last updated.","example":"2023-10-01T12:00:00Z","format":"date-time","maxLength":20,"type":["string","null"]},"UpdatedAt__7006262f8c4c":{"description":"The date-time (RFC 3339 UTC+0) at which the resource was last updated.\n","examples":["2024-11-10T00:01:43.000Z"],"format":"date-time","type":"string"},"UpdatedAt__7d827151e05e":{"description":"Specifies the report modified timestamp in UTC+0 timezone (RFC 3339 format).","examples":["2019-10-12T07:20:50Z"],"format":"date-time","pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z$","type":"string"},"UpdatedAtwebhooks__715550e8d02e":{"description":"The last update timestamp of the webhook in RFC 3339 format.","format":"date-time","type":"string"},"UpdatedBy__7d827151e05e":{"description":"The user who modified the report / report schedule.","examples":["user1@mail.com"],"type":"string"},"UpgradeStatus__c0c1228d8f7d":{"description":"The current upgrade status of the device.\n","example":"Up To Date","format":"const","maxLength":32,"type":"string"},"UptimeInMillis__6b9c5f08b869":{"description":"Elapsed time in milliseconds since the device's last boot. This value will be null if the device is offline.","example":1702794777,"format":"double","maximum":9223372036854776000,"minimum":0,"type":"number"},"UptimeInMillisap__98bb0f033247":{"description":"Elapsed time in milliseconds since the access point's last boot. This value will be null if the access point is offline.\n","example":1702794777,"format":"double","maximum":9223372036854776000,"minimum":0,"type":"number"},"UptimeInMillisgw__3b77411f6985":{"description":"Elapsed time in milliseconds since the gateway's last boot. This value will be null if the gateway is offline.\n","example":1702794777,"format":"double","maximum":9223372036854776000,"minimum":0,"type":"number"},"UptimeInMillisswitch__134f5ffbb7f8":{"description":"The elapsed time in milliseconds since the last boot.\n","example":1702794777,"format":"float","maximum":9223372036854776000,"minimum":0,"type":"number"},"UserName__7006262f8c4c":{"description":"The name of the user.\n","examples":["user1"],"maxLength":128,"type":"string"},"UserNameclients__284f33982989":{"description":"The client's username.","example":"user","type":"string"},"UserRole__7006262f8c4c":{"description":"The role of the user.\n","examples":["admin"],"maxLength":128,"type":"string"},"VlanId__284f33982989":{"description":"Specifies the VLAN ID associated with the client.","example":"100","type":"string"},"VlanIdgw__9683aa3d9df6":{"description":"The VLAN ID configured in the gateway.\n","example":511,"format":"int64","maximum":4095,"minimum":1,"type":"integer"},"VlanModegw__988495a6329d":{"description":"The VLAN mode of the port.\n","enum":["Access","Trunk"],"example":"Access","type":"string"},"VlanName__284f33982989":{"description":"Specifies the VLAN name associated with the client.","example":"100","type":"string"},"Vlan__988495a6329d":{"description":"The VLAN ID assigned to the port.\n","example":1,"type":"string"},"Vni__2ca376caec3f":{"description":"Encoded value used to uniquely identify the Layer 2 segment in a VXLAN network. It is null for tunnels other than VXLAN.\n","example":67882,"format":"int32","type":"integer"},"Voice__c99febaf4556":{"description":"The voice traffic of the VLAN.\n","example":"null","type":"string"},"VsxHealth__ed65ca41c4fc":{"description":"Health information for VSX components","properties":{"health":{"description":"Overall health status","enum":["ok","warning","critical","unknown"],"example":"ok","type":"string"},"healthDescription":{"description":"Detailed description of the health status","example":"All VSX components are healthy","type":"string"}},"type":"object"},"VsxResponse__ed65ca41c4fc":{"description":"VSX configuration and operational details for a switch","properties":{"configHealth":{"description":"Overall health status of the configuration","enum":["ok","warning","error","unknown"],"example":"ok","type":"string"},"configSyncDisable":{"description":"Indicates if configuration synchronization is disabled. Defaults to false when not reported by the device.","example":false,"type":"boolean"},"configSyncStateValue":{"description":"State of configuration synchronization","enum":["synchronized","out-of-sync","in-progress","failed","disabled"],"example":"synchronized","type":"string"},"httpsServerStateValue":{"description":"HTTPS server state for VSX","enum":["running","stopped","unknown"],"example":"running","type":"string"},"islMgmtStateValue":{"description":"State of the ISL management connection","enum":["up","down","unknown"],"example":"up","type":"string"},"islPort":{"description":"The Inter-Switch Link port on this device","example":"1/1/49","type":"string"},"islpDeviceStateValue":{"description":"ISL protocol device state","enum":["active","inactive","unknown"],"example":"active","type":"string"},"keepaliveHealth":{"description":"The health status of the keepalive connection","enum":["healthy","unhealthy","unknown"],"example":"healthy","type":"string"},"keepalivePeerIp":{"description":"The peer IP address for keepalive messages","example":"192.168.1.2","pattern":"^(?:[0-9]{1,3}\\.){3}[0-9]{1,3}$","type":"string"},"keepalivePort":{"description":"The port number used for keepalive communication","example":"7678","type":"string"},"keepaliveSourceIp":{"description":"The source IP address used for keepalive messages","example":"192.168.1.1","pattern":"^(?:[0-9]{1,3}\\.){3}[0-9]{1,3}$","type":"string"},"keepaliveStatus":{"description":"The status of the VSX keepalive connection","enum":["established","failed","not-configured","unknown"],"example":"established","type":"string"},"lastSyncTimestamp":{"description":"Timestamp of the last successful synchronization (epoch milliseconds). This field may be null if VSX synchronization has not occurred yet or if the device does not report this information.","example":"1707919492646","type":["string","null"]},"mac":{"description":"MAC address of this device","example":"aa:bb:cc:dd:ee:ff","pattern":"^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$","type":"string"},"naeStateValue":{"description":"Network Analytics Engine state","enum":["enabled","disabled","unknown"],"example":"enabled","type":"string"},"peerIslPort":{"description":"The Inter-Switch Link port on the peer device","example":"1/1/50","type":"string"},"peerMac":{"description":"MAC address of the VSX peer device","example":"11:22:33:44:55:66","pattern":"^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$","type":"string"},"peerRole":{"description":"The role of the VSX peer device","enum":["primary","secondary"],"example":"secondary","type":"string"},"role":{"description":"The role of this device in the VSX pair (primary or secondary)","enum":["primary","secondary"],"example":"primary","type":"string"},"vsxHealth":{"$ref":"#/components/schemas/VsxHealth__ed65ca41c4fc"},"vsxPeerName":{"description":"Hostname or name of the VSX peer device","example":"switch-secondary","type":"string"},"vsxPeerSerial":{"description":"Serial number of the VSX peer device","example":"SNSECONDARY123","type":"string"},"vsxPeerSiteId":{"description":"Site ID where the VSX peer is located","example":"site-456","type":"string"}},"type":"object"},"WLANIdentifier__2dcf9a625ef5":{"description":"Primary identifier of a WLAN.\n","example":"wlans/wlan1","format":"const","maxLength":36,"type":"string"},"WLANThroughputTrend__cf469a65323a":{"example":{"graph":{"keys":["tx","rx"],"samples":[{"data":[10,12],"timestamp":"2022-07-30T20:00:00Z"}],"samplingIntervalInMinutes":5},"id":"wlans/wlan1","metric":"wlan_throughput","type":"network-monitoring/access-point-monitoring"},"properties":{"graph":{"properties":{"keys":{"description":"List of metrics which helps to evaluate the throughput trend of a WLAN.\n","example":["tx","rx"],"items":{"format":"const","type":"string"},"maxItems":2,"type":"array"},"samples":{"items":{"$ref":"#/components/schemas/GraphDataPoint__05867e444b37"},"maxItems":10000,"type":"array"},"samplingIntervalInMinutes":{"$ref":"#/components/schemas/SamplingIntervalInMinutes__05867e444b37"}},"required":["keys","samples","samplingIntervalInMinutes"],"type":"object"},"id":{"$ref":"#/components/schemas/WLANIdentifier__2dcf9a625ef5"},"metric":{"description":"Metric for the throughput trend of a WLAN.","example":"wlan_throughput","format":"const","maxLength":128,"type":"string"},"type":{"$ref":"#/components/schemas/Typeap__05867e444b37"}},"required":["metric","graph","id","type"],"type":"object"},"WallTypes__254f45b253d0":{"properties":{"count":{"description":"The number of objects returned in the current list.","example":1,"format":"int32","maximum":2147483647,"minimum":1,"type":"integer"},"defaultWallTypeId":{"description":"Default walltype Id.","example":"dry-wall","format":"const","maxLength":16,"type":"string"},"items":{"items":{"properties":{"attenuation":{"description":"attenuation associated with the walltypes.","example":"dry-wall","format":"double","maximum":100,"minimum":0,"type":"number"},"code":{"description":"code associated with the walltypes in readable format.","example":"dry-wall","format":"const","maxLength":128,"type":"string"},"id":{"description":"walltype ID associated with the customer in UUID format.","example":"16a-aad7-4070-8a19-fd6b8e1ff012","maxLength":128,"type":"string"},"name":{"description":"walltype name associated with the customer in readable format.","example":"dry-wall","format":"const","maxLength":128,"type":"string"},"type":{"enum":["STANDARD","CUSTOM"],"type":"string"}},"required":["id","type"],"type":"object"},"maxItems":100,"type":"array"}},"required":["items","count"],"type":"object"},"Walls__ecef64a817a1":{"properties":{"count":{"description":"The number of objects returned in the current list.","example":1,"format":"int32","maximum":2147483647,"minimum":1,"type":"integer"},"items":{"items":{"properties":{"featureType":{"description":"feature type.","example":"wall","format":"const","maxLength":128,"type":"string"},"geometryRelative":{"items":{"items":{"description":"cartesian coordinates on FloorMap","format":"double","maximum":9223372036854776000,"minimum":0,"type":"number"},"maxItems":200,"type":"array"},"maxItems":200,"type":"array"},"id":{"description":"walltype ID associated with the customer in UUID format.","example":"16a-aad7-4070-8a19-fd6b8e1ff012","maxLength":128,"type":"string"},"properties":{"properties":{"floorId":{"description":"floorId associated with the walls.","example":"16a-aad7-4070-8a19-fd6b8e1ff012","maxLength":128,"type":"string"},"wallTypeId":{"description":"walltype ID associated with the wall.","example":"16a-aad7-4070-8a19-fd6b8e1ff012","maxLength":128,"type":"string"}},"type":"object"},"type":{"description":"feature.","example":"Feature","format":"const","maxLength":16,"type":"string"}},"required":["id","type"],"type":"object"},"maxItems":1000,"type":"array"},"type":{"description":"Default walltype Id.","example":"FeatureCollections","format":"const","maxLength":16,"type":"string"}},"required":["items","count"],"type":"object"},"WebhookApiKeyAuthRequest__c1c7772865ac":{"allOf":[{"$ref":"#/components/schemas/WebhookRequestBase__c1c7772865ac"},{"not":{"required":["oidcDetails"]},"properties":{"apiKey":{"$ref":"#/components/schemas/ApiKey__715550e8d02e"}},"required":["apiKey"],"type":"object"}],"title":"API_KEY Authentication"},"WebhookCreateInput__c1c7772865ac":{"description":"Wrapper for webhook create request input","properties":{"input":{"$ref":"#/components/schemas/WebhookRequestPayload__c1c7772865ac"}},"required":["input"],"type":"object"},"WebhookCreateResponse__c1c7772865ac":{"example":{"items":{"createdAt":"2025-08-12T01:50:03Z","generation":1,"hmacKey":"5e175c081f53ca19894cbb6d541560f5c5e9a0754ae69639ef4d56b774b4e04e","id":"26dd26c8-8a6a-4d","message":"Webhook registered!","messageFormat":"JSON","name":"webhook-1","success":true,"type":"network-services","updatedAt":"2025-08-12T01:50:03Z"}},"properties":{"items":{"properties":{"createdAt":{"$ref":"#/components/schemas/CreatedAtwebhooks__715550e8d02e"},"generation":{"$ref":"#/components/schemas/Generation__2efde5827a74"},"hmacKey":{"$ref":"#/components/schemas/HmacKey__c1c7772865ac"},"id":{"$ref":"#/components/schemas/idwebhooks__715550e8d02e"},"message":{"$ref":"#/components/schemas/Messagewebhooks__c1c7772865ac"},"messageFormat":{"$ref":"#/components/schemas/MessageFormat__715550e8d02e"},"name":{"$ref":"#/components/schemas/Name__2efde5827a74"},"success":{"$ref":"#/components/schemas/Success__c1c7772865ac"},"type":{"$ref":"#/components/schemas/Typewebhooks__715550e8d02e"},"updatedAt":{"$ref":"#/components/schemas/UpdatedAtwebhooks__715550e8d02e"}},"required":["id","type","generation","createdAt","updatedAt","success","message","hmacKey"],"type":"object"}},"type":"object"},"WebhookDetailsApiKeyAuth__715550e8d02e":{"allOf":[{"$ref":"#/components/schemas/WebhookDetailsBase__715550e8d02e"},{"not":{"required":["oidcDetails"]},"properties":{"apiKey":{"$ref":"#/components/schemas/ApiKey__715550e8d02e"},"authMechanism":{"enum":["API_KEY"],"type":"string"}},"required":["apiKey"],"type":"object"}],"title":"API Key Authentication"},"WebhookDetailsBase__715550e8d02e":{"description":"Details of a single webhook.","properties":{"authMechanism":{"$ref":"#/components/schemas/AuthMechanism__2efde5827a74"},"createdAt":{"$ref":"#/components/schemas/CreatedAtwebhooks__715550e8d02e"},"endpoint":{"$ref":"#/components/schemas/Endpoint__2efde5827a74"},"generation":{"$ref":"#/components/schemas/Generation__2efde5827a74"},"id":{"$ref":"#/components/schemas/idwebhooks__715550e8d02e"},"messageFormat":{"$ref":"#/components/schemas/MessageFormat__715550e8d02e"},"name":{"$ref":"#/components/schemas/Name__2efde5827a74"},"type":{"$ref":"#/components/schemas/Typewebhooks__715550e8d02e"},"updatedAt":{"$ref":"#/components/schemas/UpdatedAtwebhooks__715550e8d02e"}},"required":["id","name","endpoint","authMechanism","createdAt","type"],"type":"object"},"WebhookDetailsOidcAuth__715550e8d02e":{"allOf":[{"$ref":"#/components/schemas/WebhookDetailsBase__715550e8d02e"},{"not":{"required":["apiKey"]},"properties":{"authMechanism":{"enum":["OIDC"],"type":"string"},"oidcDetails":{"$ref":"#/components/schemas/OidcDetails__715550e8d02e"}},"required":["oidcDetails"],"type":"object"}],"title":"OIDC Authentication"},"WebhookDetails__715550e8d02e":{"discriminator":{"mapping":{"API_KEY":"#/components/schemas/WebhookDetailsApiKeyAuth__715550e8d02e","OIDC":"#/components/schemas/WebhookDetailsOidcAuth__715550e8d02e","WebhookDetailsApiKeyAuth":"#/components/schemas/WebhookDetailsApiKeyAuth__715550e8d02e","WebhookDetailsOidcAuth":"#/components/schemas/WebhookDetailsOidcAuth__715550e8d02e"},"propertyName":"authMechanism"},"oneOf":[{"$ref":"#/components/schemas/WebhookDetailsOidcAuth__715550e8d02e"},{"$ref":"#/components/schemas/WebhookDetailsApiKeyAuth__715550e8d02e"}]},"WebhookOidcAuthRequest__c1c7772865ac":{"allOf":[{"$ref":"#/components/schemas/WebhookRequestBase__c1c7772865ac"},{"not":{"required":["apiKey"]},"properties":{"oidcDetails":{"$ref":"#/components/schemas/OidcDetailsRequest__c1c7772865ac"}},"required":["oidcDetails"],"type":"object"}],"title":"OIDC Authentication"},"WebhookPatchInput__fa99fffcc525":{"description":"Wrapper for webhook patch request input","properties":{"input":{"$ref":"#/components/schemas/WebhookPatchPayload__fa99fffcc525"}},"required":["input"],"type":"object"},"WebhookPatchPayload__fa99fffcc525":{"anyOf":[{"$ref":"#/components/schemas/WebhookPatchRequestItemGeneric__fa99fffcc525"},{"$ref":"#/components/schemas/WebhookPatchRequestItemAuthUpdate__fa99fffcc525"}],"description":"Payload for webhook patch requests."},"WebhookPatchRequestItemApiKeyAuth__fa99fffcc525":{"not":{"required":["oidcDetails"]},"properties":{"apiKey":{"$ref":"#/components/schemas/ApiKey__715550e8d02e"},"authMechanism":{"default":"API_KEY","description":"Predefined authentication mechanism for this payload type.","example":"API_KEY","type":"string"},"endpoint":{"$ref":"#/components/schemas/Endpoint__2efde5827a74"},"name":{"$ref":"#/components/schemas/Name__2efde5827a74"}},"required":["authMechanism","apiKey"],"title":"API Key Authentication","type":"object","x-discriminator-value":"API_KEY"},"WebhookPatchRequestItemAuthUpdate__fa99fffcc525":{"oneOf":[{"$ref":"#/components/schemas/WebhookPatchRequestItemOidcAuth__fa99fffcc525"},{"$ref":"#/components/schemas/WebhookPatchRequestItemApiKeyAuth__fa99fffcc525"}],"title":"Authentication Update"},"WebhookPatchRequestItemGeneric__fa99fffcc525":{"not":{"anyOf":[{"required":["id"]},{"required":["authMechanism"]},{"required":["apiKey"]},{"required":["oidcDetails"]}]},"properties":{"endpoint":{"$ref":"#/components/schemas/Endpoint__2efde5827a74"},"messageFormat":{"$ref":"#/components/schemas/MessageFormat__715550e8d02e"},"name":{"$ref":"#/components/schemas/Name__2efde5827a74"}},"title":"Payload","type":"object"},"WebhookPatchRequestItemOidcAuth__fa99fffcc525":{"not":{"required":["apiKey"]},"properties":{"authMechanism":{"default":"OIDC","description":"Predefined authentication mechanism for this payload type.","example":"OIDC","type":"string"},"endpoint":{"$ref":"#/components/schemas/Endpoint__2efde5827a74"},"name":{"$ref":"#/components/schemas/Name__2efde5827a74"},"oidcDetails":{"$ref":"#/components/schemas/OidcDetailsRequest__c1c7772865ac"}},"required":["authMechanism","oidcDetails"],"title":"OIDC Authentication","type":"object","x-discriminator-value":"OIDC"},"WebhookPatch__fa99fffcc525":{"example":{"items":{"createdAt":"2025-10-10T07:20:28Z","generation":4,"id":"a1234567-89b9-01","message":"Webhook patched successfully!","messageFormat":"JSON","name":"webhooktest2","success":true,"type":"network-services","updatedAt":"2025-10-14T15:00:25Z"}},"properties":{"items":{"properties":{"createdAt":{"$ref":"#/components/schemas/CreatedAtwebhooks__715550e8d02e"},"generation":{"$ref":"#/components/schemas/Generation__2efde5827a74"},"id":{"$ref":"#/components/schemas/idwebhooks__715550e8d02e"},"message":{"$ref":"#/components/schemas/Messagewebhooks__c1c7772865ac"},"messageFormat":{"$ref":"#/components/schemas/MessageFormat__715550e8d02e"},"name":{"$ref":"#/components/schemas/Name__2efde5827a74"},"success":{"$ref":"#/components/schemas/Success__c1c7772865ac"},"type":{"$ref":"#/components/schemas/Typewebhooks__715550e8d02e"},"updatedAt":{"$ref":"#/components/schemas/UpdatedAtwebhooks__715550e8d02e"}},"required":["name","id","type","generation","createdAt","updatedAt","success","message"],"type":"object"}},"type":"object"},"WebhookRequestBase__c1c7772865ac":{"properties":{"authMechanism":{"$ref":"#/components/schemas/AuthMechanismRequest__c1c7772865ac"},"endpoint":{"$ref":"#/components/schemas/Endpoint__2efde5827a74"},"messageFormat":{"$ref":"#/components/schemas/MessageFormat__715550e8d02e","default":"JSON"},"name":{"$ref":"#/components/schemas/Name__2efde5827a74"}},"required":["name","endpoint","authMechanism"],"type":"object"},"WebhookRequestPayload__c1c7772865ac":{"description":"Payload for webhook create and update requests.","discriminator":{"mapping":{"API_KEY":"#/components/schemas/WebhookApiKeyAuthRequest__c1c7772865ac","OIDC":"#/components/schemas/WebhookOidcAuthRequest__c1c7772865ac","WebhookApiKeyAuthRequest":"#/components/schemas/WebhookApiKeyAuthRequest__c1c7772865ac","WebhookOidcAuthRequest":"#/components/schemas/WebhookOidcAuthRequest__c1c7772865ac"},"propertyName":"authMechanism"},"oneOf":[{"$ref":"#/components/schemas/WebhookOidcAuthRequest__c1c7772865ac"},{"$ref":"#/components/schemas/WebhookApiKeyAuthRequest__c1c7772865ac"}]},"WebhookRotateHmacKey__d05e666c56bb":{"example":{"items":{"hmacKey":"2067774a07afcf4bc7815c8ff04aa1a71b4c18a6274bf7c6ddb651227a6af796","id":"a1234567-89b9-01","message":"HMAC key rotated successfully!","success":true}},"properties":{"items":{"properties":{"hmacKey":{"$ref":"#/components/schemas/HmacKey__c1c7772865ac"},"id":{"$ref":"#/components/schemas/idwebhooks__715550e8d02e"},"message":{"$ref":"#/components/schemas/Messagewebhooks__c1c7772865ac"},"success":{"$ref":"#/components/schemas/Success__c1c7772865ac"}},"required":["id","hmacKey","success","message"],"type":"object"}},"type":"object"},"WebhookUpdateInput__d01d12c7fb0d":{"description":"Wrapper for webhook update request input","properties":{"input":{"$ref":"#/components/schemas/WebhookRequestPayload__c1c7772865ac"}},"required":["input"],"type":"object"},"WebhookUpdate__d01d12c7fb0d":{"example":{"items":{"createdAt":"2025-10-10T07:20:28Z","generation":3,"hmacKey":"b27e63985fce36484959fd03118821e8641028bd9f0e0baa564fb3389c1e0219","id":"a1234567-89b9-01","message":"Webhook updated!","messageFormat":"JSON","name":"webhooktest1","success":true,"type":"network-services","updatedAt":"2025-10-14T14:47:21Z"}},"properties":{"items":{"properties":{"createdAt":{"$ref":"#/components/schemas/CreatedAtwebhooks__715550e8d02e"},"generation":{"$ref":"#/components/schemas/Generation__2efde5827a74"},"hmacKey":{"$ref":"#/components/schemas/HmacKey__c1c7772865ac"},"id":{"$ref":"#/components/schemas/idwebhooks__715550e8d02e"},"message":{"$ref":"#/components/schemas/Messagewebhooks__c1c7772865ac"},"messageFormat":{"$ref":"#/components/schemas/MessageFormat__715550e8d02e"},"name":{"$ref":"#/components/schemas/Name__2efde5827a74"},"success":{"$ref":"#/components/schemas/Success__c1c7772865ac"},"type":{"$ref":"#/components/schemas/Typewebhooks__715550e8d02e"},"updatedAt":{"$ref":"#/components/schemas/UpdatedAtwebhooks__715550e8d02e"}},"required":["id","name","type","generation","createdAt","updatedAt","success","message","hmacKey"],"type":"object"}},"type":"object"},"WebsiteCategoryUsageItem__d76081fde092":{"description":"Usage statistics for a single website category.\n","properties":{"createdAt":{"description":"Creation timestamp in RFC 3339 format.\n","example":"2024-11-20T14:14:33Z","format":"date-time","type":"string"},"displayName":{"description":"Human-readable website category name.\n","example":"News","format":"const","maxLength":256,"type":"string"},"generation":{"description":"Monotonically increasing update counter.\n","example":1,"format":"int64","minimum":0,"type":"integer"},"id":{"description":"The unique identifier of the website category.\n","example":"news","format":"const","maxLength":256,"type":"string"},"rxBytes":{"description":"Bytes received by clients for this category.\n","example":5242880,"format":"double","minimum":0,"type":"number"},"txBytes":{"description":"Bytes transmitted from clients for this category.\n","example":1048576,"format":"double","minimum":0,"type":"number"},"type":{"description":"Resource type.\n","example":"network-monitoring/website-category","format":"const","maxLength":64,"type":"string"},"updatedAt":{"description":"Last update timestamp in RFC 3339 format.\n","example":"2024-11-20T14:14:33Z","format":"date-time","type":"string"}},"required":["id","type","generation","createdAt","updatedAt","displayName","txBytes","rxBytes"],"type":"object"},"WebsiteCategoryUsageList__d76081fde092":{"description":"Ordered list of website categories by usage.\n","example":{"count":2,"items":[{"createdAt":"2024-11-20T14:14:33Z","displayName":"News","generation":1,"id":"news","rxBytes":5242880,"txBytes":1048576,"type":"network-monitoring/website-category","updatedAt":"2024-11-20T14:14:33Z"},{"createdAt":"2024-11-20T14:14:33Z","displayName":"Social Media","generation":1,"id":"social","rxBytes":2097152,"txBytes":524288,"type":"network-monitoring/website-category","updatedAt":"2024-11-20T14:14:33Z"}],"offset":0,"total":10},"properties":{"count":{"description":"Number of category entries returned.\n","example":2,"format":"int32","minimum":0,"type":"integer"},"items":{"description":"List of website category usage entries.\n","items":{"$ref":"#/components/schemas/WebsiteCategoryUsageItem__d76081fde092"},"maxItems":500,"type":"array"},"offset":{"$ref":"#/components/schemas/Offsetapp__7c5b5fe9ca66"},"total":{"$ref":"#/components/schemas/Totalapp__7c5b5fe9ca66"}},"required":["items","count","total","offset"],"type":"object"},"WirelessBand__284f33982989":{"description":"Wireless frequency band used by the client.","example":"5GHZ","type":"string"},"WirelessChannel__284f33982989":{"description":"The wireless channel number on which the client is operating.","example":52,"type":"string"},"WirelessSecurity__284f33982989":{"description":"Specifies the wireless security protocol used by the client.","example":"WPA2-Enterprise","type":"string"},"WlanInfoWithClientCount__2dcf9a625ef5":{"example":{"band":"2.4 GHz, 5 GHz","clientCount":15,"id":"wlans/wlan1","security":"Enhanced Open","securityLevel":"Personal","status":"ENABLED","type":"network-monitoring/access-point-monitoring","vlan":"1","wlanName":"wlan1"},"properties":{"band":{"$ref":"#/components/schemas/wlanBand__2dcf9a625ef5"},"clientCount":{"$ref":"#/components/schemas/clientCount__2dcf9a625ef5"},"id":{"$ref":"#/components/schemas/WLANIdentifier__2dcf9a625ef5"},"security":{"$ref":"#/components/schemas/security__2dcf9a625ef5"},"securityLevel":{"$ref":"#/components/schemas/securityLevel__2dcf9a625ef5"},"status":{"$ref":"#/components/schemas/wlanStatus__2dcf9a625ef5"},"type":{"$ref":"#/components/schemas/Typeap__05867e444b37"},"vlan":{"$ref":"#/components/schemas/wlanVlan__2dcf9a625ef5"},"wlanName":{"$ref":"#/components/schemas/WlanName__54309c5cca60","description":"The name of the WLAN."}},"required":["wlanName","securityLevel","id","type"],"type":"object"},"WlanInfo__98bb0f033247":{"example":{"band":"2.4 GHz, 5 GHz","id":"wlans/wlan1","security":"Enhanced Open","securityLevel":"Personal","status":"ENABLED","type":"network-monitoring/access-point-monitoring","vlan":"1","wlanName":"wlan1"},"properties":{"band":{"$ref":"#/components/schemas/wlanBand__2dcf9a625ef5"},"id":{"$ref":"#/components/schemas/WLANIdentifier__2dcf9a625ef5"},"security":{"$ref":"#/components/schemas/security__2dcf9a625ef5"},"securityLevel":{"$ref":"#/components/schemas/securityLevel__2dcf9a625ef5"},"status":{"$ref":"#/components/schemas/wlanStatus__2dcf9a625ef5"},"type":{"$ref":"#/components/schemas/Typeap__05867e444b37"},"vlan":{"$ref":"#/components/schemas/wlanVlan__2dcf9a625ef5"},"wlanName":{"$ref":"#/components/schemas/WlanName__54309c5cca60","description":"The name of the WLAN."}},"required":["wlanName","securityLevel","id","type"],"type":"object"},"WlanListResponse__2dcf9a625ef5":{"allOf":[{"properties":{"items":{"items":{"$ref":"#/components/schemas/WlanInfoWithClientCount__2dcf9a625ef5"},"maxItems":100,"type":"array"}},"required":["items"],"type":"object"},{"$ref":"#/components/schemas/PaginatedResponseap__2dcf9a625ef5"}],"example":{"count":1,"items":[{"band":"2.4 GHz, 5 GHz","clientCount":15,"id":"AP00000001/wlans/wlan1","security":"Enhanced Open","securityLevel":"Personal","status":"ENABLED","type":"network-monitoring/access-point-monitoring","vlan":"1","wlanName":"wlan1"}],"next":null,"total":1}},"WlanName__54309c5cca60":{"description":"The name of the WLAN.\n","example":"wlan1","format":"const","maxLength":32,"type":"string"},"WlanNameclients__284f33982989":{"description":"Specifies the network identifier.","example":"wlan-00001","type":"string"},"WlanNotFoundError__5247473e8f2a":{"description":"WLAN not found error details returned from the server.\n","properties":{"debugId":{"$ref":"#/components/schemas/DebugId__000172564380"},"errorCode":{"description":"* A unique, machine-friendly, but human-readable identifier for the error. It has the prefix HPE_GL_.\n* For more details regarding the error please refer to the error message\n","enum":["HPE_GL_NETWORK_MONITORING_WLAN_NOT_FOUND"],"example":"HPE_GL_NETWORK_MONITORING_WLAN_NOT_FOUND","format":"const","maxLength":256,"type":"string"},"httpStatusCode":{"description":"The HTTP status code.\n","example":404,"maximum":404,"minimum":404,"type":"integer"},"message":{"$ref":"#/components/schemas/ErrorMessageap__0f1d40c88b6b"}},"required":["httpStatusCode","errorCode","message","debugId"],"type":"object"},"X-RateLimit-Limit__01cfa36ad727":{"description":"Request limit per hour.","format":"int64","maximum":9223372036854776000,"minimum":0,"type":"integer"},"X-RateLimit-Remaining__01cfa36ad727":{"description":"The number of requests remaining in the current rate limit window.","example":750,"type":"integer"},"X-RateLimit-Remainingasset__8de6ce4ea240":{"description":"The number of requests left for the time window.","format":"int64","maximum":9223372036854776000,"minimum":0,"type":"integer"},"X-RateLimit-Remainingfco__09b903e67f2b":{"format":"int64","maximum":9223372036854776000,"minimum":0,"type":"integer"},"X-RateLimit-Reset__01cfa36ad727":{"description":"The time at which the current rate limit window resets in UTC epoch seconds.","example":1733124000,"type":"integer"},"X-RateLimit-Resetasset__8de6ce4ea240":{"description":"The UTC date/time at which the current rate limit window resets.","format":"date-time","maxLength":20,"type":"string"},"X-RateLimit-Resetfco__09b903e67f2b":{"format":"date-time","maxLength":20,"type":"string"},"Zones__51cfa110bfe9":{"properties":{"count":{"description":"The number of objects returned in the current list.","example":1,"format":"int32","maximum":2147483647,"minimum":1,"type":"integer"},"items":{"items":{"properties":{"featureType":{"description":"feature type.","example":"wall","format":"const","maxLength":128,"type":"string"},"geometryRelative":{"items":{"items":{"description":"cartesian coordinates on FloorMap","format":"double","maximum":9223372036854776000,"minimum":0,"type":"number"},"maxItems":200,"type":"array"},"maxItems":200,"type":"array"},"id":{"description":"walltype ID associated with the customer in UUID format.","example":"16a-aad7-4070-8a19-fd6b8e1ff012","maxLength":128,"type":"string"},"properties":{"properties":{"floorId":{"description":"floorId associated with the walls.","example":"16a-aad7-4070-8a19-fd6b8e1ff012","maxLength":128,"type":"string"},"zoneName":{"description":"name given for a zone.","example":"hall","format":"constant","maxLength":128,"type":"string"},"zoneType":{"enum":["INCLUSION","EXCLUSION"],"type":"string"}},"type":"object"},"type":{"description":"feature.","example":"Feature","format":"const","maxLength":16,"type":"string"}},"required":["id","type"],"type":"object"},"maxItems":1000,"type":"array"},"type":{"description":"Default walltype Id.","example":"FeatureCollections","format":"const","maxLength":16,"type":"string"}},"required":["items","count"],"type":"object"},"accessVlan__3db2e3f4369e":{"description":"Access VLAN ID.\n","example":"1","format":"const","maxLength":16,"type":"string"},"allowedVlan__3db2e3f4369e":{"description":"Allowed VLAN.\n","example":"all","format":"const","maxLength":16,"type":"string"},"ap_coverage_plan__0605cf9c5e30":{"description":"AP coverage plan document","properties":{"apOpmode":{"type":"string"},"apSerial":{"type":"string"},"docCount":{"type":"integer"},"effectiveTimestamp":{"format":"int64","type":"integer"},"feasibleOpmodeSnapshotTimestamp":{"format":"int64","type":"integer"},"id":{"type":"string"},"requestId":{"type":"string"},"siteId":{"type":"string"},"tenantId":{"type":"string"},"type":{"type":"string"},"updateTimestamp":{"format":"int64","type":"integer"}},"required":["id","type"],"type":"object"},"ap_coverage_plan_all__0605cf9c5e30":{"description":"Paginated list response for AP coverage plan documents.","properties":{"count":{"type":"integer"},"id":{"type":"string"},"items":{"items":{"$ref":"#/components/schemas/ap_coverage_plan__0605cf9c5e30"},"type":"array"},"type":{"type":"string"}},"required":["id","type","count","items"],"type":"object"},"ap_info__3ad71c0ba798":{"description":"AP document from aps collection","properties":{"apCurrentOpmode":{"type":"string"},"apEthMac":{"pattern":"^([0-9A-Fa-f]{2}[:]){5}([0-9A-Fa-f]{2})$","type":"string"},"apGreenStateUpdtime":{"type":"string"},"apInGreenState":{"enum":["true","false"],"type":"string"},"apModel":{"type":"string"},"apName":{"type":"string"},"apSerial":{"type":"string"},"apTimestamp":{"format":"int64","type":"integer"},"apTimezone":{"type":"string"},"apUptime":{"type":"string"},"customerMode":{"type":"string"},"id":{"type":"string"},"ipAddr":{"type":"string"},"ipAddr6":{"type":"string"},"isApDown":{"enum":["true","false"],"type":"string"},"siteId":{"type":"string"},"type":{"type":"string"},"updateTimestamp":{"format":"int64","type":"integer"},"updatedTs":{"format":"int64","type":"integer"}},"required":["id","type"],"type":"object"},"ap_info_all__3ad71c0ba798":{"description":"Paginated list response for AP documents.","properties":{"count":{"type":"integer"},"id":{"type":"string"},"items":{"items":{"$ref":"#/components/schemas/ap_info__3ad71c0ba798"},"type":"array"},"type":{"type":"string"}},"required":["id","type","count","items"],"type":"object"},"ap_neighbor_list__05ea522bb3f0":{"description":"AP neighbor list document","properties":{"apSerial":{"type":"string"},"band":{"type":"string"},"id":{"type":"string"},"neighborList":{"type":"string"},"radioMac":{"pattern":"^([0-9A-Fa-f]{2}[:]){5}([0-9A-Fa-f]{2})$","type":"string"},"siteId":{"type":"string"},"tenantId":{"type":"string"},"type":{"type":"string"},"updateTimestamp":{"format":"int64","type":"integer"}},"required":["id","type"],"type":"object"},"ap_radio_relations__1fd78b473a9f":{"description":"AP to radio relation document","properties":{"apSerial":{"type":"string"},"from":{"type":"string"},"id":{"type":"string"},"purgeAfter":{"format":"int64","type":"integer"},"radioMac":{"pattern":"^([0-9A-Fa-f]{2}[:]){5}([0-9A-Fa-f]{2})$","type":"string"},"tenantId":{"type":"string"},"to":{"type":"string"},"type":{"type":"string"}},"required":["id","type"],"type":"object"},"board_limit__bdffbcf1590c":{"description":"Board limit document","properties":{"apModel":{"type":"string"},"band":{"type":"string"},"bandwidth":{"type":"string"},"id":{"type":"string"},"maxEirp":{"type":"integer"},"maxEirpDbm":{"format":"float","type":"number"},"type":{"type":"string"}},"required":["id","type"],"type":"object"},"clientCount__2dcf9a625ef5":{"example":20,"format":"int64","minimum":0,"type":"integer"},"config_id__a5d2a68229f0":{"description":"Global configuration identifier document","properties":{"globalId":{"type":"string"},"id":{"type":"string"},"tenantId":{"type":"string"},"type":{"type":"string"}},"required":["id","type"],"type":"object"},"connector__3db2e3f4369e":{"description":"The port type.\n","enum":["USB","RJ45"],"example":"RJ45","format":"const","maxLength":16,"type":"string"},"debugIdwifi__000172564380":{"description":"Debug id of the failed request. This can be used to help with troubleshooting.","example":"a53ea9f0efeb99b2a9a52ef9c7e3093b","format":"const","maxLength":1024,"type":"string"},"device_config__c0214e3e4937":{"description":"Device configuration document","properties":{"activeAtMigrationTime":{"type":"boolean"},"apSerial":{"type":"string"},"bootstrapReqTs":{"format":"int64","type":"integer"},"country":{"type":"string"},"deviceMac":{"pattern":"^([0-9A-Fa-f]{2}[:]){5}([0-9A-Fa-f]{2})$","type":"string"},"flexDualBand":{"type":"string"},"flexTriBand":{"type":"string"},"id":{"type":"string"},"isActiveAtMigrationTime":{"type":"boolean"},"isMigration":{"type":"boolean"},"isStaticOpmode":{"type":"boolean"},"migration":{"type":"boolean"},"migrationSource":{"type":"string"},"mismatchedConfigRadio":{"type":"string"},"mismatchedConfigSystem":{"type":"string"},"opmodes":{"items":{"type":"string"},"type":"array"},"purgeAfter":{"format":"int64","type":"integer"},"r0ExternalAntGain":{"type":"integer"},"r0StaticChan":{"type":"integer"},"r0StaticChanBw":{"type":"string"},"r0StaticPwr":{"type":"integer"},"r0StaticSecondaryChan":{"type":"integer"},"r1ExternalAntGain":{"type":"integer"},"r1StaticChan":{"type":"integer"},"r1StaticChanBw":{"type":"string"},"r1StaticPwr":{"type":"integer"},"r1StaticSecondaryChan":{"type":"integer"},"r2ExternalAntGain":{"type":"integer"},"r2StaticChan":{"type":"integer"},"r2StaticChanBw":{"type":"string"},"r2StaticPwr":{"type":"integer"},"r2StaticSecondaryChan":{"type":"integer"},"radios":{"properties":{"cfgBand2Ghz":{"properties":{"allowedChannels":{"properties":{"cbw160":{"items":{"type":"integer"},"type":"array"},"cbw20":{"items":{"type":"integer"},"type":"array"},"cbw3201":{"items":{"type":"integer"},"type":"array"},"cbw3202":{"items":{"type":"integer"},"type":"array"},"cbw40":{"items":{"type":"integer"},"type":"array"},"cbw80":{"items":{"type":"integer"},"type":"array"}},"type":"object"},"chanBw":{"items":{"type":"integer"},"type":"array"},"eirpRange":{"items":{"type":"integer"},"type":"array"},"externalAntGain":{"type":"integer"},"heEnabled":{"type":"boolean"},"htEnabled":{"type":"boolean"},"nonPscStatus":{"type":"boolean"},"staticChan":{"type":"integer"},"staticChanBw":{"type":"string"},"staticPwr":{"type":"integer"},"staticSecondaryChan":{"type":"integer"},"vhtEnabled":{"type":"boolean"}},"type":"object"},"cfgBand5Ghz":{"properties":{"allowedChannels":{"properties":{"cbw160":{"items":{"type":"integer"},"type":"array"},"cbw20":{"items":{"type":"integer"},"type":"array"},"cbw3201":{"items":{"type":"integer"},"type":"array"},"cbw3202":{"items":{"type":"integer"},"type":"array"},"cbw40":{"items":{"type":"integer"},"type":"array"},"cbw80":{"items":{"type":"integer"},"type":"array"}},"type":"object"},"chanBw":{"items":{"type":"integer"},"type":"array"},"eirpRange":{"items":{"type":"integer"},"type":"array"},"externalAntGain":{"type":"integer"},"heEnabled":{"type":"boolean"},"htEnabled":{"type":"boolean"},"nonPscStatus":{"type":"boolean"},"staticChan":{"type":"integer"},"staticChanBw":{"type":"string"},"staticPwr":{"type":"integer"},"staticSecondaryChan":{"type":"integer"},"vhtEnabled":{"type":"boolean"}},"type":"object"},"cfgBand6Ghz":{"properties":{"allowedChannels":{"properties":{"cbw160":{"items":{"type":"integer"},"type":"array"},"cbw20":{"items":{"type":"integer"},"type":"array"},"cbw3201":{"items":{"type":"integer"},"type":"array"},"cbw3202":{"items":{"type":"integer"},"type":"array"},"cbw40":{"items":{"type":"integer"},"type":"array"},"cbw80":{"items":{"type":"integer"},"type":"array"}},"type":"object"},"chanBw":{"items":{"type":"integer"},"type":"array"},"eirpRange":{"items":{"type":"integer"},"type":"array"},"externalAntGain":{"type":"integer"},"heEnabled":{"type":"boolean"},"htEnabled":{"type":"boolean"},"nonPscStatus":{"type":"boolean"},"staticChan":{"type":"integer"},"staticChanBw":{"type":"string"},"staticPwr":{"type":"integer"},"staticSecondaryChan":{"type":"integer"},"vhtEnabled":{"type":"boolean"}},"type":"object"}},"type":"object"},"shardAttr":{"type":"string"},"staticOpmode":{"type":"boolean"},"tenantId":{"type":"string"},"type":{"type":"string"},"updateTimestamp":{"format":"int64","type":"integer"},"utbChanSpace":{"type":"integer"},"utbFilterBlock":{"type":"string"}},"required":["id","type"],"type":"object"},"duplex__3db2e3f4369e":{"description":"This field indicates whether the network has a full-duplex, half-duplex or Auto communication.\n","example":"Auto","format":"const","maxLength":64,"type":"string"},"fco_resp_info__09b903e67f2b":{"properties":{"afcExpiryTimestamp":{"description":"The timestamp indicating when the Automated Frequency Coordination response expires","type":"integer"},"afcReqTimestamp":{"description":"The timestamp of the Automated Frequency Coordination request","type":"integer"},"afcRespTimestamp":{"description":"The timestamp of the Automated Frequency Coordination response","type":"integer"},"chanList160MHz":{"description":"160MHz Automated Frequency Coordination response channel list","items":{"type":"integer"},"type":"array"},"chanList20MHz":{"description":"20MHz Automated Frequency Coordination response channel list","items":{"type":"integer"},"type":"array"},"chanList320MHz1":{"description":"320MHz1 Automated Frequency Coordination response channel list","items":{"type":"integer"},"type":"array"},"chanList320MHz2":{"description":"320MHz2 Automated Frequency Coordination response channel list","items":{"type":"integer"},"type":"array"},"chanList40MHz":{"description":"40MHz Automated Frequency Coordination response channel list","items":{"type":"integer"},"type":"array"},"chanList80MHz":{"description":"80MHz Automated Frequency Coordination response channel list","items":{"type":"integer"},"type":"array"},"chanListPsd":{"description":"PSD Automated Frequency Coordination response channel list","items":{"type":"integer"},"type":"array"},"eirpList160MHz":{"description":"160MHz Automated Frequency Coordination response EIRP list","items":{"format":"float","type":"number"},"type":"array"},"eirpList20MHz":{"description":"20MHz Automated Frequency Coordination response EIRP list","items":{"format":"float","type":"number"},"type":"array"},"eirpList320MHz1":{"description":"320MHz1 Automated Frequency Coordination response EIRP list","items":{"format":"float","type":"number"},"type":"array"},"eirpList320MHz2":{"description":"320MHz2 Automated Frequency Coordination response EIRP list","items":{"format":"float","type":"number"},"type":"array"},"eirpList40MHz":{"description":"40MHz Automated Frequency Coordination response EIRP list","items":{"format":"float","type":"number"},"type":"array"},"eirpList80MHz":{"description":"80MHz Automated Frequency Coordination response EIRP list","items":{"format":"float","type":"number"},"type":"array"},"eirpListPsd":{"description":"PSD Automated Frequency Coordination EIRP response list","items":{"format":"float","type":"number"},"type":"array"},"id":{"description":"The serial number of the access point for which Automated Frequency Coordination channel data has been fetched.","type":"string"},"serialNumber":{"description":"The serial number of the access point for which Automated Frequency Coordination channel data has been fetched.","type":"string"},"tenantId":{"description":"The tenant ID of the access point for which Automated Frequency Coordination channel data has been fetched.","type":"string"},"type":{"description":"The type of device for which Automated Frequency Coordination channel data has been fetched.","type":"string"}},"required":["id","type"],"type":"object"},"fco_resp_info_all__09b903e67f2b":{"description":"Automated Frequency Coordination channel data of all access points belonging to the tenant.","properties":{"count":{"description":"The number of objects returned in the list. Maximum will be page size.","example":1,"format":"int32","maximum":2147483647,"minimum":1,"type":"integer"},"items":{"items":{"$ref":"#/components/schemas/fco_resp_info__09b903e67f2b"},"maxItems":2147483647,"type":"array"},"offset":{"description":"Specifies the offset of the returned page.","example":0,"format":"int32","type":"integer"},"total":{"description":"The total number of objects contained in the database.","example":200,"format":"int64","type":"integer"}},"required":["items","count"],"type":"object"},"fromBssid__972dd6d46bea":{"description":"Specifies the BSSID MAC address from which the client roamed.","example":"32:44:3a:31:44:3a","type":"string"},"hasFloorFilter__dfe680474bd8":{"description":"OData 4.0 filter string for hasFloors boolean field.","example":"hasFloors eq true","format":"const","maxLength":20,"type":"string"},"history__e5ceeb20c3e5":{"description":"Radio history document","properties":{"band":{"type":"string"},"computed":{"properties":{"band":{"type":"string"},"bandwidth":{"type":"string"},"isApm":{"type":"boolean"},"solverChannel":{"type":"integer"},"solverEirp":{"type":"integer"},"solverEirpDbm":{"type":"number"}},"type":"object"},"computedApOpmode":{"type":"string"},"currentApOpmode":{"type":"string"},"dbTimestamp":{"format":"int64","type":"integer"},"deployed":{"properties":{"band":{"type":"string"},"bandwidth":{"type":"string"},"isApm":{"type":"boolean"},"solverChannel":{"type":"integer"},"solverEirp":{"type":"integer"},"solverEirpDbm":{"type":"number"}},"type":"object"},"id":{"type":"string"},"new":{"properties":{"bandwidth":{"type":"string"},"channel":{"type":"integer"},"eirp":{"type":"integer"},"eirpDbm":{"type":"number"},"isApm":{"type":"boolean"},"secondaryChannel":{"type":"integer"}},"type":"object"},"old":{"properties":{"bandwidth":{"type":"string"},"channel":{"type":"integer"},"eirp":{"type":"integer"},"eirpDbm":{"type":"number"},"isApm":{"type":"boolean"},"secondaryChannel":{"type":"integer"}},"type":"object"},"overrideReason":{"type":"string"},"radioMac":{"pattern":"^([0-9A-Fa-f]{2}[:]){5}([0-9A-Fa-f]{2})$","type":"string"},"reason":{"type":"string"},"siteId":{"type":"string"},"tenantId":{"type":"string"},"type":{"type":"string"},"updateTimestamp":{"format":"int64","type":"integer"}},"required":["id","type"],"type":"object"},"idwebhooks__715550e8d02e":{"description":"Unique identifier for the webhook.","format":"uuid","maxLength":64,"type":"string"},"isUplink__3db2e3f4369e":{"description":"Indicates whether the port is currently used as an uplink.","example":false,"type":"boolean"},"limitlocation__dfe680474bd8":{"default":20,"description":"Specifies the number of results to be returned. (Default: 20)\n","example":100,"format":"int32","maximum":10000,"minimum":1,"type":"integer"},"membersCount__a3f300af1174":{"description":"The number of members in the swarm. This field is only available in the swarm detail API, not in the list API.","example":1,"format":"int32","minimum":0,"type":"integer"},"message__000172564380":{"description":"Error message indicating the cause of the failure.","example":"Error message","format":"const","maxLength":1024,"type":"string"},"nativeVlan__3db2e3f4369e":{"description":"Native VLAN ID.\n","example":"1","format":"const","maxLength":16,"type":"string"},"non_friends__07e2669e8e8d":{"description":"Non-friends document","properties":{"apSerial":{"type":"string"},"band":{"type":"string"},"id":{"type":"string"},"nonfriendsList":{"type":"string"},"radioMac":{"pattern":"^([0-9A-Fa-f]{2}[:]){5}([0-9A-Fa-f]{2})$","type":"string"},"siteId":{"type":"string"},"tenantId":{"type":"string"},"timestamp":{"format":"int64","type":"integer"},"type":{"type":"string"}},"required":["id","type"],"type":"object"},"occurredOn__13edfa6d725b":{"description":"RFC 3339 UTC timestamp of when the operation executed.\n","example":"2019-10-12T07:20:50Z","maxLength":64,"type":"string"},"offsetlocation__dfe680474bd8":{"default":0,"description":"Specifies the number of results to skip before returning results. (Default: 0)","example":0,"format":"int32","maximum":10000,"minimum":0,"type":"integer"},"partition__728e89309681":{"description":"RF partition document","properties":{"apCoveragePlanTimestamp":{"type":"string"},"apSerial":{"type":"string"},"band":{"type":"string"},"docCount":{"type":"integer"},"id":{"type":"string"},"radioMac":{"pattern":"^([0-9A-Fa-f]{2}[:]){5}([0-9A-Fa-f]{2})$","type":"string"},"requestId":{"type":"string"},"rfDomainId":{"type":"string"},"rfPartitionId":{"type":"string"},"rfPartitionTimestamp":{"type":"string"},"rfPartitionType":{"type":"string"},"shardAttr":{"type":"string"},"siteId":{"type":"string"},"tenantId":{"type":"string"},"type":{"type":"string"},"updateTimestamp":{"format":"int64","type":"integer"}},"required":["id","type"],"type":"object"},"partition_response__2220d719af62":{"description":"Response payload for partition request submission.","properties":{"id":{"type":"string"},"message":{"type":"string"},"type":{"type":"string"}},"required":["id","type"],"type":"object"},"pathloss__a0ec6e901581":{"description":"Pathloss document","properties":{"band":{"type":"string"},"bandwidth":{"type":"string"},"channel":{"type":"integer"},"id":{"type":"string"},"nbrMac":{"pattern":"^([0-9A-Fa-f]{2}[:]){5}([0-9A-Fa-f]{2})$","type":"string"},"pathloss":{"type":"integer"},"pathlossAvg":{"type":"integer"},"reportingMac":{"pattern":"^([0-9A-Fa-f]{2}[:]){5}([0-9A-Fa-f]{2})$","type":"string"},"secondaryChannel":{"type":"integer"},"tenantId":{"type":"string"},"timestamp":{"format":"int64","type":"integer"},"type":{"type":"string"}},"required":["id","type"],"type":"object"},"portMacAddress__3db2e3f4369e":{"description":"Interface MAC address.\n","example":"11:22:33:44:66:60","format":"const","maxLength":18,"type":"string"},"portName__3db2e3f4369e":{"description":"The port name.\n","example":"eth0","format":"const","maxLength":16,"type":"string"},"portStatus__3db2e3f4369e":{"description":"The port status.\n","enum":["UP","DOWN","DISABLED"],"example":"UP","format":"const","maxLength":16,"type":"string"},"prio_rf_events__97082ceeaaf5":{"description":"Priority RF event document","properties":{"apSerial":{"type":"string"},"band":{"type":"string"},"eirpResolution":{"type":"string"},"eventTimestamp":{"type":"string"},"eventType":{"type":"string"},"id":{"type":"string"},"newBandwidth":{"type":"string"},"newChannel":{"type":"string"},"newEirp":{"type":"string"},"newSecondaryChannel":{"type":"string"},"oldBandwidth":{"type":"string"},"oldChannel":{"type":"string"},"oldEirp":{"type":"string"},"oldSecondaryChannel":{"type":"string"},"radioMac":{"pattern":"^([0-9A-Fa-f]{2}[:]){5}([0-9A-Fa-f]{2})$","type":"string"},"siteId":{"type":"string"},"tenantId":{"type":"string"},"type":{"type":"string"},"updateTimestamp":{"format":"int64","type":"integer"}},"required":["id","type"],"type":"object"},"prio_rf_events_all__f6f6dfb73ea1":{"description":"Paginated list response for priority RF event documents.","properties":{"count":{"type":"integer"},"id":{"type":"string"},"items":{"items":{"$ref":"#/components/schemas/prio_rf_events__97082ceeaaf5"},"type":"array"},"type":{"type":"string"}},"required":["id","type","count","items"],"type":"object"},"radio_feasibility__3c7026e76daa":{"description":"Radio feasibility document","properties":{"apSerial":{"type":"string"},"feasibility":{"type":"string"},"id":{"type":"string"},"radioMac":{"pattern":"^([0-9A-Fa-f]{2}[:]){5}([0-9A-Fa-f]{2})$","type":"string"},"siteId":{"type":"string"},"tenantId":{"type":"string"},"type":{"type":"string"},"updateTimestamp":{"format":"int64","type":"integer"}},"required":["id","type"],"type":"object"},"radio_feasibility_all__caa30c68a06b":{"description":"Paginated list response for radio feasibility documents.","properties":{"count":{"type":"integer"},"id":{"type":"string"},"items":{"items":{"$ref":"#/components/schemas/radio_feasibility__3c7026e76daa"},"type":"array"},"type":{"type":"string"}},"required":["id","type","count","items"],"type":"object"},"radio_info__02f79da05c85":{"description":"Radio document from radios collection","properties":{"apEthMac":{"pattern":"^([0-9A-Fa-f]{2}[:]){5}([0-9A-Fa-f]{2})$","type":"string"},"apSerial":{"type":"string"},"band":{"type":"string"},"bandRange":{"type":"string"},"bandwidth":{"type":"string"},"chanReason":{"type":"string"},"chanTimestamp":{"type":"string"},"channel":{"type":"string"},"customerMode":{"type":"string"},"eirp":{"type":"string"},"eirpDbm":{"type":"string"},"eirpReason":{"type":"string"},"eirpTimestamp":{"type":"string"},"id":{"type":"string"},"isRadioActive":{"enum":["true","false"],"type":"string"},"isStaticChan":{"enum":["true","false"],"type":"string"},"isStaticEirp":{"enum":["true","false"],"type":"string"},"lteBlockedChan2g":{"type":"string"},"mode":{"type":"string"},"nonPscStatus":{"enum":["true","false"],"type":"string"},"provBand":{"type":"string"},"provBandwidth":{"type":"string"},"provEirp":{"type":"string"},"provPriChan":{"type":"string"},"provSecChan":{"type":"string"},"provTimestamp":{"type":"string"},"radioMac":{"pattern":"^([0-9A-Fa-f]{2}[:]){5}([0-9A-Fa-f]{2})$","type":"string"},"radioNum":{"type":"string"},"radioStatus":{"enum":["true","false"],"type":"string"},"radioTimestamp":{"type":"string"},"secondaryChannel":{"type":"string"},"siteId":{"type":"string"},"type":{"type":"string"},"updateTimestamp":{"format":"int64","type":"integer"},"updatedTs":{"format":"int64","type":"integer"}},"required":["id","type"],"type":"object"},"radio_info_all__a52d23f02a0b":{"description":"Paginated list response for radio documents.","properties":{"count":{"type":"integer"},"id":{"type":"string"},"items":{"items":{"$ref":"#/components/schemas/radio_info__02f79da05c85"},"type":"array"},"type":{"type":"string"}},"required":["id","type","count","items"],"type":"object"},"radio_partition__992133fe494f":{"description":"Radio partition document","properties":{"band":{"type":"string"},"id":{"type":"string"},"rfDomainId":{"type":"string"},"rfPartitionId":{"type":"string"},"type":{"type":"string"},"updateTimestamp":{"format":"int64","type":"integer"}},"required":["id","type"],"type":"object"},"response__4ee94b04d313":{"properties":{"code":{"description":"status code.\n","example":"SUC-001","format":"const","maxLength":32,"type":"string"},"message":{"description":"Descriptive text on the outcome of the operation.\n","example":"success.","format":"const","maxLength":512,"type":"string"},"status":{"description":"Final status of operation.\n","example":"SUCCESS","format":"const","maxLength":20,"type":"string"}},"required":["code","status","message"],"type":"object"},"rf_events__01cfa36ad727":{"description":"RF event document","properties":{"band":{"type":"string"},"dbTimestamp":{"format":"int64","type":"integer"},"id":{"type":"string"},"new":{"properties":{"bandwidth":{"type":"string"},"channel":{"type":"integer"},"eirp":{"type":"integer"},"eirpDbm":{"format":"float","type":"number"},"isApm":{"type":"boolean"},"secondaryChannel":{"type":"integer"}},"type":"object"},"old":{"properties":{"bandwidth":{"type":"string"},"channel":{"type":"integer"},"eirp":{"type":"integer"},"eirpDbm":{"format":"float","type":"number"},"isApm":{"type":"boolean"},"secondaryChannel":{"type":"integer"}},"type":"object"},"radioMac":{"pattern":"^([0-9A-Fa-f]{2}[:]){5}([0-9A-Fa-f]{2})$","type":"string"},"reason":{"type":"string"},"siteId":{"type":"string"},"tenantId":{"type":"string"},"type":{"type":"string"},"updateTimestamp":{"format":"int64","type":"integer"}},"required":["id","type"],"type":"object"},"rf_events_all__de6c202caff6":{"description":"Paginated list response for RF event documents.","properties":{"count":{"type":"integer"},"id":{"type":"string"},"items":{"items":{"$ref":"#/components/schemas/rf_events__01cfa36ad727"},"type":"array"},"type":{"type":"string"}},"required":["id","type","count","items"],"type":"object"},"rssi__972dd6d46bea":{"description":"Specifies the RSSI value after the client roamed.","example":"-42","type":"string"},"runStatus__c419fe321fd2":{"description":"Specifies the report export status as New, In Progress, Completed, or Failed","enum":["RUNNING","EXPORTING","COMPLETED","FAILED","EXPORT_FAILED"],"examples":["COMPLETED"],"type":"string"},"runnow_delay__96a2be0ca8b8":{"default":0,"description":"Delay the deployment of solution in minutes.","example":0,"maximum":360,"minimum":0,"type":"integer"},"runnow_response__96a2be0ca8b8":{"description":"Runnow API request response document","properties":{"id":{"type":"string"},"message":{"type":"string"},"type":{"type":"string"}},"required":["id","type"],"type":"object"},"runnow_window__96a2be0ca8b8":{"default":120,"description":"Deployment window in minutes.","example":120,"maximum":360,"minimum":0,"type":"integer"},"securityLevel__2dcf9a625ef5":{"description":"Type of the WLAN.\n","enum":["Enterprise","Personal","Open","Captive Portal"],"example":"Captive Portal","maxLength":32,"type":"string"},"security__2dcf9a625ef5":{"description":"Security type of the WLAN.","example":"Enhanced Open","type":"string"},"service_config__5cbafbf3f32c":{"description":"Service configuration document","properties":{"deployHour":{"type":"string"},"deployWindow":{"type":"string"},"enable":{"enum":["true","false"],"type":"string"},"globalId":{"type":"string"},"id":{"type":"string"},"qualityThreshold2Ghz":{"type":"string"},"qualityThreshold5Ghz":{"type":"string"},"qualityThreshold6Ghz":{"type":"string"},"scopeId":{"type":"string"},"tenantId":{"type":"string"},"type":{"type":"string"},"updateTimestamp":{"format":"int64","type":"integer"}},"required":["id","type"],"type":"object"},"siteIdlocation__08d3c9863d87":{"example":"16a-aad7-4070-8a19-fd6b8e1ff012","format":"const","maxLength":128,"type":"string"},"solution__28b1232a6d05":{"description":"Solution/plan document for radio optimization","properties":{"apEthMac":{"pattern":"^([0-9A-Fa-f]{2}[:]){5}([0-9A-Fa-f]{2})$","type":"string"},"apOpmodeComputed":{"type":"string"},"apSerial":{"type":"string"},"band":{"type":"string"},"bandwidth":{"type":"string"},"cbwFrozen":{"type":"boolean"},"chanFrozen":{"type":"boolean"},"computedApOpmode":{"type":"string"},"currentApOpmode":{"type":"string"},"dbTimestamp":{"format":"int64","type":"integer"},"deployEnd":{"format":"int64","type":"integer"},"deployStart":{"format":"int64","type":"integer"},"deployStatus":{"type":"string"},"deployedChannelReason":{"type":"string"},"deployedEirpReason":{"type":"string"},"deployedOpmodeReason":{"type":"string"},"eirpFrozen":{"type":"boolean"},"eirpTruncated":{"type":"boolean"},"estimateDuration":{"type":"number"},"eventChannels":{"type":"string"},"id":{"type":"string"},"optimizationEnd":{"format":"int64","type":"integer"},"optimizationInfo":{"type":"string"},"optimizationStart":{"format":"int64","type":"integer"},"radioMac":{"pattern":"^([0-9A-Fa-f]{2}[:]){5}([0-9A-Fa-f]{2})$","type":"string"},"requestId":{"type":"string"},"rfDomainId":{"type":"integer"},"rfPartitionId":{"type":"integer"},"runnowType":{"type":"integer"},"siteId":{"type":"string"},"solverChannel":{"type":"integer"},"solverEirp":{"type":"integer"},"solverEirpDbm":{"type":"integer"},"solverFeasList":{"properties":{"bwList":{"items":{"type":"string"},"type":"array"},"chanList":{"additionalProperties":{"items":{"type":"integer"},"type":"array"},"type":"object"}},"type":"object"},"tenantId":{"type":"string"},"type":{"type":"string"}},"required":["id","type"],"type":"object"},"solution_all__28b1232a6d05":{"description":"Paginated list response for solution documents.","properties":{"count":{"type":"integer"},"id":{"type":"string"},"items":{"items":{"$ref":"#/components/schemas/solution__28b1232a6d05"},"type":"array"},"type":{"type":"string"}},"required":["id","type","count","items"],"type":"object"},"speed__3db2e3f4369e":{"description":"The speed of the port is measured in Mbps. Possible values include 10 Mbps, 100 Mbps, 1 Gbps, 2.5 Gbps, 5 Gbps or Auto.\n","example":"5 Gbps","format":"const","maxLength":16,"type":"string"},"toBssid__972dd6d46bea":{"description":"Specifies the BSSID MAC address to which the client roamed.","example":"dc:0b:8e:d5:d0:00","type":"string"},"uuId__08d3c9863d87":{"example":"fff2bd91-de81-4097-8420-3ca7f87450fd","maxLength":36,"type":"string"},"vlanMode__3db2e3f4369e":{"description":"The port VLAN mode. Access, trunk, and '-' are possible values for VLAN mode.\n","example":"Trunk","format":"const","maxLength":16,"type":"string"},"wlanBand__2dcf9a625ef5":{"description":"Specifies the bands supported by WLAN. Possible values include '2.4 GHz', '5 GHz', '6 GHz', or combinations like '2.4 GHz, 5 GHz'.","example":"2.4 GHz, 5 GHz","type":"string"},"wlanCount__da78704f9a76":{"example":4,"format":"int64","minimum":0,"type":"integer"},"wlanStatus__2dcf9a625ef5":{"description":"The operational status of the WLAN.","enum":["ENABLED","DISABLED"],"example":"ENABLED","type":"string"},"wlanVlan__2dcf9a625ef5":{"description":"WLAN VLAN ID.","example":"1","type":"string"}},"securitySchemes":{"OAuth2__000172564380":{"description":"OAuth 2.0 authentication with client credentials flow. You can also use your own access token.","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"https://sso.common.cloud.hpe.com/as/token.oauth2"}},"type":"oauth2"}}},"info":{"description":"Generated from HPE Aruba Networking Central API documentation. Source metadata is retained on operations; this is an independent export. Deprecated alpha operations are omitted when the source explicitly identifies a matching non-deprecated stable successor. Other alpha operations remain included.","title":"HPE Aruba Networking Central — Monitoring","version":"0bd38d9332ef7f5a"},"openapi":"3.1.0","paths":{"/as/token.oauth2":{"post":{"description":"This endpoint generates an access token for new Central. The provided API client credentials must be for Central application on the HPE GreenLake Platform. The generated token is valid for 2 hours.","operationId":"MRT_generate-access-token","parameters":[{"example":"application/x-www-form-urlencoded","in":"header","name":"Content-Type","schema":{"type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"client_id":{"description":"API Client ID","example":"<API-Client-ID>","type":"string"},"client_secret":{"description":"API Client Secret","example":"<API-Client-Secret>","type":"string"},"grant_type":{"default":"client_credentials","enum":["client_credentials"],"type":"string"}},"required":["grant_type","client_id","client_secret"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"access_token":{"description":"The token you can use to make API calls to new Central","example":"<access_token>","type":"string"},"expires_in":{"description":"The duration (in seconds) for which the token is valid","example":7200,"type":"integer"},"token_type":{"description":"Indicates the type of token issued","example":"Bearer","type":"string"}},"type":"object"}}},"description":"Successful response"}},"security":[],"servers":[{"url":"https://sso.common.cloud.hpe.com"}],"summary":"Generate Access Token","tags":["Authentication"],"x-source-document":{"file":"MRT/generate-access-token.json","metadata":{"info":{"title":"Authorization","version":"1.0.0"},"openapi":"3.1.0","x-readme":{"explorer-enabled":true,"proxy-enabled":true}},"pathMetadata":{},"sha256":"28a556be2c49778c611b852e82525a7c078ee847b485a9b6dccb2ccbd3fc7246"}}},"/network-monitoring/v1/application-categories":{"get":{"description":"This API endpoint returns the top N application categories ranked by usage (tx + rx bytes) for the requested scope. The maximum time range is 7 days. If the range between start-at and end-at exceeds 7 days, start-at is automatically adjusted to be 7 days before end-at. This is intentional behavior; no error is returned.\n","operationId":"listApplicationCategoriesV1","parameters":[{"description":"The start time in RFC 3339 Format or epoch milliseconds (must be within 7 days of end-at).\n","in":"query","name":"start-at","required":true,"schema":{"example":"2024-11-20T14:14:33Z","format":"date-time","maxLength":27,"type":"string"}},{"description":"The end time in RFC 3339 Format or epoch milliseconds (must be greater than start-at).\n","in":"query","name":"end-at","required":true,"schema":{"example":"2024-11-21T14:14:33Z","format":"date-time","maxLength":27,"type":"string"}},{"description":"Filter by site identifier.\n","in":"query","name":"site-id","required":false,"schema":{"example":"2778382","format":"const","maxLength":20,"type":"string"}},{"description":"Filter by client MAC address. Forces use of the main data table (not aggregated).\n","in":"query","name":"client-id","required":false,"schema":{"example":"00:00:00:00:00:00","format":"const","maxLength":17,"type":"string"}},{"description":"Filter by device serial number. Forces use of the main data table (not aggregated).\n","in":"query","name":"serial-number","required":false,"schema":{"example":"CN12345678","format":"const","maxLength":64,"type":"string"}},{"description":"Maximum number of items to return per page (1–500). Default: 100.\n","in":"query","name":"limit","required":false,"schema":{"default":100,"example":10,"format":"int32","maximum":500,"minimum":1,"type":"integer"}},{"description":"Filter by SSID name.\n","in":"query","name":"ssid","required":false,"schema":{"example":"CorpWiFi","format":"const","maxLength":256,"type":"string"}},{"description":"Filter by user role.\n","in":"query","name":"user-role","required":false,"schema":{"example":"admin","format":"const","maxLength":256,"type":"string"}},{"description":"Zero-based index of the first item to return. Default: 0.\n","in":"query","name":"offset","required":false,"schema":{"default":0,"example":0,"format":"int32","minimum":0,"type":"integer"}},{"description":"Maximum number of top-ranked application categories to return in total across all pages (1–500). Default: 100.\n","in":"query","name":"top","required":false,"schema":{"default":100,"example":10,"format":"int32","maximum":500,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationCategoryUsageList__7c5b5fe9ca66"}}},"description":"Successful operation.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/XRateLimitLimitHeaderapp__7c5b5fe9ca66"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/XRateLimitRemainingHeaderapp__7c5b5fe9ca66"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"},"503":{"$ref":"#/components/responses/ServiceUnavailableapp__7c5b5fe9ca66"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get top application categories by usage\n","tags":["Application Visibility"],"x-source-document":{"file":"MRT/listapplicationcategoriesv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Application Visibility APIs provide details about applications accessed in a site or by a client.","name":"Application Visibility"}]},"pathMetadata":{},"sha256":"0c7ebc8d2fcbf0e514c82383d1ddd5ec95ded69abd52cfd89d0f114214e93334"}}},"/network-monitoring/v1/applications":{"get":{"description":"This API endpoint retrieves applications accessed in a site by all clients or by a specific client.\n","operationId":"listApplicationsV1","parameters":[{"description":"The ID of the site from which applications will be retrieved.\n","in":"query","name":"site-id","required":true,"schema":{"example":"2778382","format":"const","maxLength":20,"type":"string"}},{"description":"The client MAC of the source device.\n","in":"query","name":"client-id","required":false,"schema":{"example":"00:00:00:00:00:00","format":"const","maxLength":17,"type":"string"}},{"description":"The start time in RFC 3339 Format (must be within 7 days of end-at).\n","in":"query","name":"start-at","required":true,"schema":{"example":"2024-11-20T14:14:33Z","format":"date-time","maxLength":27,"type":"string"}},{"description":"The end time in RFC 3339 Format (must be greater than start-at)","in":"query","name":"end-at","required":true,"schema":{"example":"2024-11-20T14:14:33Z","format":"date-time","maxLength":27,"type":"string"}},{"in":"query","name":"limit","required":true,"schema":{"default":1000,"description":"The maximum number of items to return per page.\n","format":"int32","maximum":1000,"minimum":0,"type":"integer"}},{"description":"Cursor for the next page of results. Use the value returned in the `next` response field to retrieve the next page. Providing both `next` and `offset` in the same request returns `400 Bad Request`.\n","in":"query","name":"next","required":false,"schema":{"example":"NyBErRdk6czGUyDAX5Cp","type":"string"}},{"description":"The offset of the item at which to begin the response. Providing both `offset` and `next` in the same request returns `400 Bad Request`.\n","in":"query","name":"offset","required":false,"schema":{"example":0,"format":"int32","minimum":0,"type":"integer"}},{"description":"OData Version 4.0 filter string (limited functionality). Supports only 'and', 'eq', and 'in' conjunction ('or' and 'not' are NOT supported). Supported fields and operators are in the table below. Multiple filters are supported.\n| Field   | Operators | Required | Type    | Default Value | Summary                                                           |\n|---------|-----------|----------|---------|----------------|-------------------------------------------------------------------|\n| `field` | `eq`      | No       | String  | N/A            | Format is a string from a specified enum list given below         |\n| `terms` | `in`      | No       | String  | N/A            | Format is a list of strings                                       |\n\n**The operators are implemented as follows:**\n\n* `eq`: Only values exactly matching the given value are returned.\n* `in`: Only values present in the given list are returned.\n\n**List of applicable filters for field and terms**\n\n| Field                    | Applicable Terms                                                                  | Summary                                                |\n|--------------------------|-------------------------------------------------------------------------------------|--------------------------------------------------------|\n| APP_CAT                  | Refer to list below. Example: [\"Antivirus\", \"Web\"]                                | Returns applications based on application categories   |\n| STATE                    | [\"allowed\", \"partial\", \"blocked\"]                                                | Returns applications by assigned permissions           |\n| RISK                     | [\"Low\", \"High\", \"Suspicious\", \"Moderate\", \"Trustworthy\", \"Not Evaluated\"]         | Returns applications based on risk level               |\n| TLS_VERSION              | [\"TLS 1.1\", \"TLS 1.2\"] (examples)                                                 | Returns applications by TLS version                    |\n| APPLICATION_HOST_TYPE    | [\"Hybrid\", \"Private\", \"Public\"]                                                    | Returns applications by host type                      |\n| COUNTRY                  | Depends on app server location (use country code, e.g., \"IN\")                      | Returns applications by server location                |\n| ROLE                     | Depends on roles assigned to the user                                              | Returns applications by assigned roles                 |\n\nList of application categories available:\n* Antivirus\n* Business and Economy\n* Computer and Internet Info\n* Computer and Internet Security\n* Encrypted\n* Internet Communications\n* Network Service\n* Office365 SAAS\n* Standard\n* Web\n\nIf no filter is passed as the query param, default behavior returns both active and inactive applications.\n","example":"('field' eq 'INCLUDE_INACTIVE_APP' and 'terms' in ('True')) and ('field' eq 'LIST_VIEW_TAB' and 'terms' in ('APPLICATIONS'))","in":"query","name":"filter","required":false,"schema":{"format":"const","type":"string"}},{"description":"Sort field followed by direction indicator (asc/desc). Supported fields: NAME, CATEGORY, EXPERIENCE, RISK, USAGE, STATE, LASTUSEDTIME, TLSVERSION, CERTIFICATEEXPIRYDATE, APPLICATIONHOSTTYPE, COUNTRY.\n","in":"query","name":"sort","required":false,"schema":{"example":"NAME desc","format":"const","maxLength":256,"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationsResponse__7dced1181a4d"}}},"description":"Successful operation.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/XRateLimitLimitHeaderapp__7c5b5fe9ca66"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/XRateLimitRemainingHeaderapp__7c5b5fe9ca66"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"},"503":{"$ref":"#/components/responses/ServiceUnavailableapp__7c5b5fe9ca66"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get applications accessed in a site\n","tags":["Application Visibility"],"x-source-document":{"file":"MRT/listapplicationsv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Application Visibility APIs provide details about applications accessed in a site or by a client.","name":"Application Visibility"}]},"pathMetadata":{},"sha256":"7c2a882740ea6dd7cd872f6a832b61d8322d69648deea743c5eb8b8495caf407"}}},"/network-monitoring/v1/aps":{"get":{"description":"This API endpoint retrieves a list of access points associated to a customer, based on the query parameters provided. Each access point in the returned list includes comprehensive details like serial number, name, MAC address, siteId, status and with latest stats. The query parameters allow you to narrow down the results to access points that meet specific criteria, ensuring you receive only the relevant data.\n","operationId":"getAccessPointsV1","parameters":[{"description":"OData Version 4.0 filter string (limited functionality). Supports only 'and' conjunction; ('or' and 'not' are NOT supported). Supported fields and operators are in the below given table.\n\n| Field | Operators |\n| --------- | -------- |\n| `siteId` | `eq` and `in` |\n| `siteName` | `eq` and `in` |\n| `serialNumber` | `eq` and `in` |\n| `deviceName` | `eq` and `in` |\n| `status` | `eq` and `in` |\n| `model` | `eq` and `in` |\n| `firmwareVersion` | `eq` and `in` |\n| `deployment` | `eq` and `in` |\n| `clusterId` | `eq` and `in` |\n| `clusterName` | `eq` and `in` |\n| `hibernate` | `eq` |\n\n**The operators are implemented as follows:**\n\n* `eq`: Only values exactly matching the given value are returned. For the `hibernate` field, values `true` and `false` are case-insensitive.\n\n* `in`: Only values present in the given list are returned.\n\n","example":"siteId eq '12345' and deployment in ('Standalone', 'Virtual Controller') and hibernate eq true","in":"query","name":"filter","required":false,"schema":{"format":"const","maxLength":256,"type":"string"}},{"description":"A comma-separated list of sort expressions. Each sort expression is a property name optionally followed by a direction indicator: asc (ascending) or desc (descending).\n\nThe first sort expression in the list defines the primary sort order, the second defines the secondary sort order, and so on. If a direction indicator is omitted, then the default direction is ascending.\n\nSupported fields are `siteId`, `serialNumber`, `deviceName`, `model`, `status`, and `deployment`.\n","in":"query","name":"sort","required":false,"schema":{"example":"deviceName,deployment desc","format":"const","maxLength":256,"type":"string"}},{"description":"Specifies the maximum number of access points returned in the response.\n","in":"query","name":"limit","required":false,"schema":{"default":20,"example":20,"format":"int64","maximum":1000,"minimum":0,"type":"integer"}},{"description":"Specifies the pagination cursor for the next page of resources.\n\nThe minimum value: 1\n","in":"query","name":"next","required":false,"schema":{"$ref":"#/components/schemas/Next__21874c7bfa12"}}],"responses":{"200":{"$ref":"#/components/responses/AccessPointListResponse__da78704f9a76"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get a list of Access Points","tags":["Access Points"],"x-source-document":{"file":"MRT/getaccesspointsv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Access Point Monitoring APIs to get Access Point details and its metrics","name":"Access Points"}]},"pathMetadata":{},"sha256":"d3cf120863713030d343b17104994b99f94e626d4f610d24da9e572c6f8fd05c"}}},"/network-monitoring/v1/aps/{serial-number}":{"get":{"description":"This API retrieves detailed information about a specific access point linked to a particular site. It provides access point-related details such as MAC address, name, status, radios, ports, modem, and WLANs based on the access point's serial number associated with the site.\n","operationId":"getAccessPointDetailsV1","parameters":[{"$ref":"#/components/parameters/SerialNumberap__05867e444b37"}],"responses":{"200":{"$ref":"#/components/responses/AccessPointResponse__98bb0f033247"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get an Access Point details","tags":["Access Points"],"x-source-document":{"file":"MRT/getaccesspointdetailsv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Access Point Monitoring APIs to get Access Point details and its metrics","name":"Access Points"}]},"pathMetadata":{},"sha256":"99be2fe7f56d3b478f9a54b3959dedc5eb44c516fcc3fd561d78f6e7d49e5dd4"}}},"/network-monitoring/v1/aps/{serial-number}/cpu-utilization-trends":{"get":{"description":"The API retrieves CPU utilization trends data in percentage for a specified access point. The data will be fetched based on the timestamp range provided in the filter. If no timestamp range is specified in the filter, data for the last 3 hours will be returned by default.\n","operationId":"getAccessPointCPUUtilizationV1","parameters":[{"$ref":"#/components/parameters/SerialNumberap__05867e444b37"},{"$ref":"#/components/parameters/TrendsFilter__05867e444b37"},{"$ref":"#/components/parameters/SiteIdOptional__05867e444b37"},{"$ref":"#/components/parameters/SiteNameOptional__05867e444b37"}],"responses":{"200":{"$ref":"#/components/responses/AccessPointCPUUtilizationResponse__d7f5998ad833"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get CPU utilization information for an Access Point","tags":["Access Points"],"x-source-document":{"file":"MRT/getaccesspointcpuutilizationv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Access Point Monitoring APIs to get Access Point details and its metrics","name":"Access Points"}]},"pathMetadata":{},"sha256":"9590c1621099f92ed8740b86fc39a510d89bd12c2a6f62a95c88ae52378d0307"}}},"/network-monitoring/v1/aps/{serial-number}/dhcp-pools":{"get":{"description":"This API endpoint retrieves a list of DHCP pools associated with a specific access point. Each DHCP pool in the returned list includes details like pool name, VLAN, subnet, lease duration in seconds, available addresses, pool size, and utilization.\n","operationId":"getAccessPointDHCPPoolListV1","parameters":[{"$ref":"#/components/parameters/SerialNumberap__05867e444b37"},{"description":"OData Version 4.0 filter string (limited functionality). Supports only 'and' conjunction ('or' and 'not' are NOT supported). Supported fields and operators are in the below given table.\n\n| Field | Operators |\n| --------- | -------- |\n| `poolName` | `eq` and `in` |\n| `vlan` | `eq` and `in` |\n| `subnet` | `eq` and `in` |\n\n**The operators are implemented as follows:**\n\n* `eq`: Only values exactly matching the given value are returned.\n\n* `in`: Only values present in the given list are returned.\n\n","example":"poolName eq 'Pool-Alpha'","in":"query","name":"filter","required":false,"schema":{"format":"const","maxLength":256,"type":"string"}},{"description":"Comma separated list of sort expressions. Each sort expression is a property name optionally followed by a direction indicator asc (ascending) or desc (descending).\n\nThe first sort expression in the list defines the primary sort order, the second defines the secondary sort order, and so on. If a direction indicator is omitted the default direction is ascending.\n\nSupported fields are `poolName`, `vlan`, `subnet`, `leaseDurationInSecs`, `availableAddresses`, `poolSize`, and `utilization`.\n","in":"query","name":"sort","required":false,"schema":{"example":"poolName asc,leaseDurationInSecs desc","format":"const","maxLength":256,"type":"string"}},{"description":"Denotes the maximum number of DHCP pools returned in the response.\n","in":"query","name":"limit","required":false,"schema":{"default":20,"example":20,"format":"int64","maximum":1000,"minimum":0,"type":"integer"}},{"description":"Specifies the pagination cursor for the next page of resources.\n\nMinimum value: 1\n","in":"query","name":"next","required":false,"schema":{"$ref":"#/components/schemas/Next__21874c7bfa12"}}],"responses":{"200":{"$ref":"#/components/responses/AccessPointDHCPPoolListResponseV1__36b9a7c1ff51"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get a list of AP DHCP Pools","tags":["Access Points"],"x-source-document":{"file":"MRT/getaccesspointdhcppoollistv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Access Point Monitoring APIs to get Access Point details and its metrics","name":"Access Points"}]},"pathMetadata":{},"sha256":"b3af39f3e507744d23dc5ba889b83f91d4c47c04505bf2c97812fec22a97cf37"}}},"/network-monitoring/v1/aps/{serial-number}/memory-utilization-trends":{"get":{"description":"The API retrieves memory utilization trend data in percentage for a specified access point. The data will be fetched based on the timestamp range provided in the filter. If no timestamp range is specified in the filter, data for the last 3 hours will be returned by default.\n","operationId":"getAccessPointMemoryUtilizationV1","parameters":[{"$ref":"#/components/parameters/SerialNumberap__05867e444b37"},{"$ref":"#/components/parameters/TrendsFilter__05867e444b37"},{"$ref":"#/components/parameters/SiteIdOptional__05867e444b37"},{"$ref":"#/components/parameters/SiteNameOptional__05867e444b37"}],"responses":{"200":{"$ref":"#/components/responses/AccessPointMemoryUtilizationResponse__9b696b333a10"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get memory utilization information for an Access Point","tags":["Access Points"],"x-source-document":{"file":"MRT/getaccesspointmemoryutilizationv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Access Point Monitoring APIs to get Access Point details and its metrics","name":"Access Points"}]},"pathMetadata":{},"sha256":"5d429f2ec744adf6732f401d312ef7c5bef4a37c935b80369fc19be227bec0b3"}}},"/network-monitoring/v1/aps/{serial-number}/ports":{"get":{"description":"This API endpoint retrieves a list of ports associated to an access point. Each port in the returned list includes comprehensive details like MAC address, port index and status.\n","operationId":"getAccessPointPortListV1","parameters":[{"$ref":"#/components/parameters/SerialNumberap__05867e444b37"},{"description":"Specifies the maximum number of ports returned in the response.\n","in":"query","name":"limit","required":false,"schema":{"default":20,"examples":[20],"format":"int64","maximum":1000,"minimum":1,"type":"integer"}},{"description":"Specifies the pagination cursor for the next page of resources.\n","in":"query","name":"next","required":false,"schema":{"$ref":"#/components/schemas/Next__21874c7bfa12"}}],"responses":{"200":{"$ref":"#/components/responses/PortListResponseV1__3db2e3f4369e"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get a list of Access Point ports","tags":["Access Points"],"x-source-document":{"file":"MRT/getaccesspointportlistv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Access Point Monitoring APIs to get Access Point details and its metrics","name":"Access Points"}]},"pathMetadata":{},"sha256":"52c62f8d868ee9d7fa9bbd61f6b95d75c0267b714ca4801b4b76d6a0fff6c697"}}},"/network-monitoring/v1/aps/{serial-number}/ports/{port-index}/collisions-trends":{"get":{"description":"This API retrieves detailed information about a specific port frame trends of an access point linked to a particular site. It provides key metrics such as Collision Errors and Percentage for a given port index.\n","operationId":"getAccessPointPortCollisionsPerformanceV1","parameters":[{"$ref":"#/components/parameters/SerialNumberap__05867e444b37"},{"$ref":"#/components/parameters/PortIndex__951d038e6e20"},{"$ref":"#/components/parameters/TrendsFilter__05867e444b37"},{"$ref":"#/components/parameters/SiteIdOptional__05867e444b37"},{"$ref":"#/components/parameters/SiteNameOptional__05867e444b37"}],"responses":{"200":{"$ref":"#/components/responses/PortCollisionsTrendResponse__fcccfb2a0f94"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get Access Point Port Collision Error","tags":["Access Points"],"x-source-document":{"file":"MRT/getaccesspointportcollisionsperformancev1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Access Point Monitoring APIs to get Access Point details and its metrics","name":"Access Points"}]},"pathMetadata":{},"sha256":"9c8b4f8529a3fe53847a0435b45dc3fa766442e1aa77e433cb871259a9bbb490"}}},"/network-monitoring/v1/aps/{serial-number}/ports/{port-index}/crc-trends":{"get":{"description":"This API retrieves detailed information about a specific port frame trends of an access point linked to a particular site. It provides key metrics such as CRC Errors and Percentage for a given port index.\n","operationId":"getAccessPointPortCrcPerformanceV1","parameters":[{"$ref":"#/components/parameters/SerialNumberap__05867e444b37"},{"$ref":"#/components/parameters/PortIndex__951d038e6e20"},{"$ref":"#/components/parameters/TrendsFilter__05867e444b37"},{"$ref":"#/components/parameters/SiteIdOptional__05867e444b37"},{"$ref":"#/components/parameters/SiteNameOptional__05867e444b37"}],"responses":{"200":{"$ref":"#/components/responses/PortCrcTrendResponse__f5cda28c0fa4"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get Access Point Port CRC Errors","tags":["Access Points"],"x-source-document":{"file":"MRT/getaccesspointportcrcperformancev1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Access Point Monitoring APIs to get Access Point details and its metrics","name":"Access Points"}]},"pathMetadata":{},"sha256":"7c08a3d9a5df4d3b6c9f10112af26df2c372c51e4167c78ad509a90068d0c7cf"}}},"/network-monitoring/v1/aps/{serial-number}/ports/{port-index}/frames-trends":{"get":{"description":"This API retrieves detailed information about a specific port frame trends of an access point linked to a particular site. It provides key metrics such as Errors, Drops, Error Percentage and Drop Percentage, for a given port index.\n","operationId":"getAccessPointPortFramesPerformanceV1","parameters":[{"$ref":"#/components/parameters/SerialNumberap__05867e444b37"},{"$ref":"#/components/parameters/PortIndex__951d038e6e20"},{"$ref":"#/components/parameters/TrendsFilter__05867e444b37"},{"$ref":"#/components/parameters/SiteIdOptional__05867e444b37"},{"$ref":"#/components/parameters/SiteNameOptional__05867e444b37"}],"responses":{"200":{"$ref":"#/components/responses/PortFramesTrendResponse__951d038e6e20"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get Access Point Port Frame Trends","tags":["Access Points"],"x-source-document":{"file":"MRT/getaccesspointportframesperformancev1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Access Point Monitoring APIs to get Access Point details and its metrics","name":"Access Points"}]},"pathMetadata":{},"sha256":"9c8e2d51f9fc1a2d08d78136837c96119280a011a07b40561d4029b3b3bec976"}}},"/network-monitoring/v1/aps/{serial-number}/ports/{port-index}/throughput-trends":{"get":{"description":"The API retrieves throughput trend data for a specific port of an access point, including transmitted(tx) and received(rx) data in bits per second. If no timestamp range is specified in the filter, data for the last 3 hours will be returned by default.\n","operationId":"getAccessPointPortThroughputV1","parameters":[{"$ref":"#/components/parameters/SerialNumberap__05867e444b37"},{"$ref":"#/components/parameters/TrendsFilter__05867e444b37"},{"$ref":"#/components/parameters/SiteIdOptional__05867e444b37"},{"$ref":"#/components/parameters/SiteNameOptional__05867e444b37"},{"description":"Port index of an access point, to filter the transmitted and received data for a specific port. The value can range from 0 to 6.\n","example":"0","in":"path","name":"port-index","required":true,"schema":{"type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/PortThroughputTrendsResponse__05867e444b37"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get Access Point Port throughput trend.","tags":["Access Points"],"x-source-document":{"file":"MRT/getaccesspointportthroughputv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Access Point Monitoring APIs to get Access Point details and its metrics","name":"Access Points"}]},"pathMetadata":{},"sha256":"ea14a7a26c026156d8699605e3e1996a8cf0150077d3270b9954772944983866"}}},"/network-monitoring/v1/aps/{serial-number}/power-consumption-trends":{"get":{"description":"The API retrieves power consumption trend data in watts for a specified access point. The data will be fetched based on the timestamp range provided in the filter. If no timestamp range is specified in the filter, data for the last 3 hours will be returned by default.\n","operationId":"getAccessPointPowerConsumptionV1","parameters":[{"$ref":"#/components/parameters/SerialNumberap__05867e444b37"},{"$ref":"#/components/parameters/TrendsFilter__05867e444b37"},{"$ref":"#/components/parameters/SiteIdOptional__05867e444b37"},{"$ref":"#/components/parameters/SiteNameOptional__05867e444b37"}],"responses":{"200":{"$ref":"#/components/responses/AccessPointPowerConsumptionResponse__75dfc6cfa00f"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get power consumption information for an Access Point","tags":["Access Points"],"x-source-document":{"file":"MRT/getaccesspointpowerconsumptionv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Access Point Monitoring APIs to get Access Point details and its metrics","name":"Access Points"}]},"pathMetadata":{},"sha256":"a4a9357c526d44310b6b17e2c5fc3319e16583313919a49a811fee6ad49a0fe5"}}},"/network-monitoring/v1/aps/{serial-number}/radios":{"get":{"description":"This API endpoint retrieves a list of radios associated to an access point. Each radio in the returned list includes comprehensive details like MAC address, band, status and its current statistics.\n","operationId":"getAccessPointRadioListV1","parameters":[{"$ref":"#/components/parameters/SerialNumberap__05867e444b37"},{"description":"Specifies the maximum number of radios returned in the response.\n","in":"query","name":"limit","required":false,"schema":{"default":20,"examples":[20],"format":"int64","maximum":1000,"minimum":1,"type":"integer"}},{"description":"Specifies the pagination cursor for the next page of resources.\n","in":"query","name":"next","required":false,"schema":{"$ref":"#/components/schemas/Next__21874c7bfa12"}}],"responses":{"200":{"$ref":"#/components/responses/AccessPointRadioListResponseV1__8b147ff96285"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get a list of Access Point radios","tags":["Access Points"],"x-source-document":{"file":"MRT/getaccesspointradiolistv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Access Point Monitoring APIs to get Access Point details and its metrics","name":"Access Points"}]},"pathMetadata":{},"sha256":"225f0d5454f3f51e3eaecc5fe60d7c842871f94428cca79e50270d7d1a561e03"}}},"/network-monitoring/v1/aps/{serial-number}/radios/{radio-number}/channel-quality-trends":{"get":{"description":"The API retrieves radio channel quality data in percentage for a specified radio of an access point. The data will be fetched based on the timestamp range provided in the filter. If no timestamp range is specified in the filter, data for the last 3 hours will be returned by default.\n","operationId":"getAPRFChannelQualityPerformanceV1","parameters":[{"$ref":"#/components/parameters/SerialNumberap__05867e444b37"},{"$ref":"#/components/parameters/RadioNumber__2226a59a3aaf"},{"$ref":"#/components/parameters/TrendsFilter__05867e444b37"},{"$ref":"#/components/parameters/SiteIdOptional__05867e444b37"},{"$ref":"#/components/parameters/SiteNameOptional__05867e444b37"}],"responses":{"200":{"$ref":"#/components/responses/RFChannelQualityTrendResponse__ea71ed8f910a"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get channel quality information for a radio","tags":["Access Points"],"x-source-document":{"file":"MRT/getaprfchannelqualityperformancev1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Access Point Monitoring APIs to get Access Point details and its metrics","name":"Access Points"}]},"pathMetadata":{},"sha256":"49efb0eb2983f7bda7c5a70ca2ff8482666db1d056fbf469679f5d1417ee7151"}}},"/network-monitoring/v1/aps/{serial-number}/radios/{radio-number}/channel-utilization-trends":{"get":{"description":"The API retrieves radio channel utilization data for a specified radio of an access point, including percentages for Transmitting (tx), Receiving (rx), and Non-Wi-Fi interference. It provides insights into how effectively radio channels are being utilized. The data will be fetched based on the timestamp range provided in the filter. If no timestamp range is specified in the filter, data for the last 3 hours will be returned by default.\n","operationId":"getAPRFChannelUtilizationPerformanceV1","parameters":[{"$ref":"#/components/parameters/SerialNumberap__05867e444b37"},{"$ref":"#/components/parameters/RadioNumber__2226a59a3aaf"},{"$ref":"#/components/parameters/TrendsFilter__05867e444b37"},{"$ref":"#/components/parameters/SiteIdOptional__05867e444b37"},{"$ref":"#/components/parameters/SiteNameOptional__05867e444b37"}],"responses":{"200":{"$ref":"#/components/responses/RFChannelUtilizationTrendResponse__2226a59a3aaf"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get channel utilization information for a radio","tags":["Access Points"],"x-source-document":{"file":"MRT/getaprfchannelutilizationperformancev1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Access Point Monitoring APIs to get Access Point details and its metrics","name":"Access Points"}]},"pathMetadata":{},"sha256":"67da9db56e0349d64457605b3877643bbb622d8bc82e439689801562fb0676af"}}},"/network-monitoring/v1/aps/{serial-number}/radios/{radio-number}/frames-trends":{"get":{"description":"The API retrieves transmission trend data for Drops and Retries frames, expressed as percentages for a radio of an access point. The data will be fetched based on the timestamp range provided in the filter. If no timestamp range is specified in the filter, data for the last 3 hours will be returned by default.\n","operationId":"getAPRFFramesPerformanceV1","parameters":[{"$ref":"#/components/parameters/SerialNumberap__05867e444b37"},{"$ref":"#/components/parameters/RadioNumber__2226a59a3aaf"},{"$ref":"#/components/parameters/TrendsFilter__05867e444b37"},{"$ref":"#/components/parameters/SiteIdOptional__05867e444b37"},{"$ref":"#/components/parameters/SiteNameOptional__05867e444b37"}],"responses":{"200":{"$ref":"#/components/responses/RFFramesTrendResponse__fc5c7ee1666d"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get transmission information for a radio","tags":["Access Points"],"x-source-document":{"file":"MRT/getaprfframesperformancev1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Access Point Monitoring APIs to get Access Point details and its metrics","name":"Access Points"}]},"pathMetadata":{},"sha256":"e62d759bf8f5d34c8005aae3328b0f93c0a872e95dfcbffdd97728ff218fd09e"}}},"/network-monitoring/v1/aps/{serial-number}/radios/{radio-number}/noise-floor-trends":{"get":{"description":"The API retrieves noise floor data in dBm for a specified radio of an access point. The data will be fetched based on the timestamp range provided in the filter. If no timestamp range is specified in the filter, data for the last 3 hours will be returned by default.\n","operationId":"getAPRFNoiseFloorPerformanceV1","parameters":[{"$ref":"#/components/parameters/SerialNumberap__05867e444b37"},{"$ref":"#/components/parameters/RadioNumber__2226a59a3aaf"},{"$ref":"#/components/parameters/TrendsFilter__05867e444b37"},{"$ref":"#/components/parameters/SiteIdOptional__05867e444b37"},{"$ref":"#/components/parameters/SiteNameOptional__05867e444b37"}],"responses":{"200":{"$ref":"#/components/responses/RFNoiseFloorTrendResponse__9d04c74d9734"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get noise floor information for a radio","tags":["Access Points"],"x-source-document":{"file":"MRT/getaprfnoisefloorperformancev1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Access Point Monitoring APIs to get Access Point details and its metrics","name":"Access Points"}]},"pathMetadata":{},"sha256":"a4844e7ad8f92209238fe9683109397c69f7bb6ed10e20926eac1c398e0f8de2"}}},"/network-monitoring/v1/aps/{serial-number}/radios/{radio-number}/throughput-trends":{"get":{"description":"The API retrieves throughput trend data for a specific radio of an access point, including transmitted(tx) and received(rx) data in bits per second. If no timestamp range is specified in the filter, data for the last 3 hours will be returned by default.\n","operationId":"getAccessPointRadioThroughputV1","parameters":[{"$ref":"#/components/parameters/SerialNumberap__05867e444b37"},{"$ref":"#/components/parameters/TrendsFilter__05867e444b37"},{"$ref":"#/components/parameters/SiteIdOptional__05867e444b37"},{"$ref":"#/components/parameters/SiteNameOptional__05867e444b37"},{"description":"Radio number of an access point, to filter the transmitted and received data for a specific radio. The value can range from 0 to 2.\n","example":"0","in":"path","name":"radio-number","required":true,"schema":{"type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/RadioThroughputTrendsResponse__cbb2c3e96d46"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get Access Point Radio throughput trend.","tags":["Access Points"],"x-source-document":{"file":"MRT/getaccesspointradiothroughputv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Access Point Monitoring APIs to get Access Point details and its metrics","name":"Access Points"}]},"pathMetadata":{},"sha256":"e98f7ed35ff44d5fe14bfd01adf56c2dc92edd96d9b54df2aa1b17cea50c47a5"}}},"/network-monitoring/v1/aps/{serial-number}/throughput-trends":{"get":{"description":"The API retrieves throughput trend data of an access point, including transmitted(tx) and received(rx) data in bits per second. If no timestamp range is specified in the filter, data for the last 3 hours will be returned by default.\n\n***Usage Notes:***\n\n* Provide **interface-type** of **WIRELESS** to retrieve aggregated throughput data for radios.\n\n* Provide **interface-type** of **WIRED** to retrieve aggregated throughput data for a wired interface.\n\n* Provide **interface-type** of **LTE** to retrieve throughput data of modem.\n","operationId":"getAccessPointThroughputV1","parameters":[{"$ref":"#/components/parameters/SerialNumberap__05867e444b37"},{"$ref":"#/components/parameters/TrendsFilter__05867e444b37"},{"$ref":"#/components/parameters/SiteIdOptional__05867e444b37"},{"$ref":"#/components/parameters/SiteNameOptional__05867e444b37"},{"description":"Interface type of an access point for which the data being requested.","example":"WIRELESS","in":"query","name":"interface-type","required":true,"schema":{"default":"WIRELESS","enum":["WIRED","WIRELESS","LTE"],"type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/APThroughputTrendsResponse__0931747ce8ba"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get throughput trend of an Access Point.","tags":["Access Points"],"x-source-document":{"file":"MRT/getaccesspointthroughputv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Access Point Monitoring APIs to get Access Point details and its metrics","name":"Access Points"}]},"pathMetadata":{},"sha256":"63f641ca70a3caa16b847c5c8ba7ba8ca5b63592a0e425e7ef05c0d891b7b041"}}},"/network-monitoring/v1/aps/{serial-number}/tunnels":{"get":{"description":"This API endpoint retrieves a list of tunnels associated with a specific access point, based on the query parameters provided. Each tunnel in the returned list includes comprehensive details like tunnel name, status, encapsulation, source and destination IP etc. The query parameters allow you to narrow down the results to tunnel that meet specific criteria, ensuring you receive only the relevant data.\n","operationId":"getAccessPointTunnelListV1","parameters":[{"$ref":"#/components/parameters/SerialNumberap__05867e444b37"},{"description":"ID of the Site for which access point tunnel information is requested\n","in":"query","name":"site-id","required":false,"schema":{"$ref":"#/components/schemas/SiteIDap__34350f7e707e"}},{"description":"OData Version 4.0 filter string (limited functionality). Supports only 'and' conjunction ('or' and 'not' are NOT supported). Supported fields and operators are in the below given table.\n\n| Field | Operators |\n| --------- | -------- |\n| `status` | `eq` and `in` |\n| `encapsulationType` | `eq` and `in` |\n\n**The operators are implemented as follows:**\n\n* `eq`: Only values exactly matching the given value are returned.\n\n* `in`: Only values present in the given list are returned.\n\n","example":"status eq 'Up' and encapsulationType eq 'IPSec'","in":"query","name":"filter","required":false,"schema":{"format":"const","maxLength":256,"type":"string"}},{"description":"A comma-separated list of sort expressions. Each sort expression is a property name optionally followed by a direction indicator asc (ascending) or desc (descending).\n\nThe first sort expression in the list defines the primary sort order, the second defines the secondary sort order, and so on. If a direction indicator is omitted the default direction is ascending. By default, the response is sorted in ascending order by tunnel status.\n\nSupported fields are `tunnelName`, `encapsulationType`, `sourceIpAddress`, `destinationName`, `destinationIpAddress`, `uptimeInMillis`.\n","in":"query","name":"sort","required":false,"schema":{"example":"tunnelName asc,encapsulationType desc,sourceIpAddress asc,destinationName asc,destinationIpAddress asc,uptimeInMillis desc","format":"const","maxLength":256,"type":"string"}},{"description":"Specifies the maximum number of tunnels returned in the response.\n","in":"query","name":"limit","required":false,"schema":{"default":20,"example":20,"format":"int64","maximum":1000,"minimum":0,"type":"integer"}},{"description":"Specifies the pagination cursor for the next page of resources.\n\nThe minimum value: 1\n","in":"query","name":"next","required":false,"schema":{"$ref":"#/components/schemas/Next__21874c7bfa12"}}],"responses":{"200":{"$ref":"#/components/responses/AccessPointTunnelListResponseV1__d231f2b75fda"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get a list of Access Point Tunnels","tags":["Access Points"],"x-source-document":{"file":"MRT/getaccesspointtunnellistv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Access Point Monitoring APIs to get Access Point details and its metrics","name":"Access Points"}]},"pathMetadata":{},"sha256":"6d6c0fc05ba198b02deffbabb25db212d168c41861d61d8c35908b9bd7e671ac"}}},"/network-monitoring/v1/aps/{serial-number}/tunnels/{tunnel-id}":{"get":{"description":"This API retrieves detailed information about tunnels associated with a specific access point. It provides tunnel related details such as name, status, encapsulation type, source and destination information based on the access point's serial number.\n","operationId":"getAccessPointTunnelDetailV1","parameters":[{"$ref":"#/components/parameters/SerialNumberap__05867e444b37"},{"$ref":"#/components/parameters/TunnelId__0f1d40c88b6b"}],"responses":{"200":{"$ref":"#/components/responses/AccessPointTunnelDetailResponseV1__0f1d40c88b6b"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/TunnelNotFoundError__0f1d40c88b6b"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get an Access Point Tunnel details","tags":["Access Points"],"x-source-document":{"file":"MRT/getaccesspointtunneldetailv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Access Point Monitoring APIs to get Access Point details and its metrics","name":"Access Points"}]},"pathMetadata":{},"sha256":"7e1a5b06a532f96217360ab29021f0bdd913065cb7c87a66b0e96cf854501d05"}}},"/network-monitoring/v1/aps/{serial-number}/tunnels/{tunnel-id}/jitter-trends":{"get":{"description":"The API retrieves jitter trend data in milliseconds for a specific tunnel of an access point. If no timestamp range is specified in the filter, data for the last 3 hours will be returned by default.\n","operationId":"getAccessPointProbeJitterTrendV1","parameters":[{"$ref":"#/components/parameters/SerialNumberap__05867e444b37"},{"$ref":"#/components/parameters/TrendsFilter__05867e444b37"},{"$ref":"#/components/parameters/SiteIdOptional__05867e444b37"},{"$ref":"#/components/parameters/SiteNameOptional__05867e444b37"},{"$ref":"#/components/parameters/TunnelId__0f1d40c88b6b"}],"responses":{"200":{"$ref":"#/components/responses/APProbeTrendsResponse__24d76b0b1476"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get jitter trend of an Access Point Tunnel.","tags":["Access Points"],"x-source-document":{"file":"MRT/getaccesspointprobejittertrendv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Access Point Monitoring APIs to get Access Point details and its metrics","name":"Access Points"}]},"pathMetadata":{},"sha256":"824221d51d68cc7ebe56ffd5c38cf08d120eb58b1a4ff46e767057ecf4c5672e"}}},"/network-monitoring/v1/aps/{serial-number}/tunnels/{tunnel-id}/latency-trends":{"get":{"description":"The API retrieves latency trend data in milliseconds for a specific tunnel of an access point. If no timestamp range is specified in the filter, data for the last 3 hours will be returned by default.\n","operationId":"getAccessPointProbeLatencyTrendV1","parameters":[{"$ref":"#/components/parameters/SerialNumberap__05867e444b37"},{"$ref":"#/components/parameters/TrendsFilter__05867e444b37"},{"$ref":"#/components/parameters/SiteIdOptional__05867e444b37"},{"$ref":"#/components/parameters/SiteNameOptional__05867e444b37"},{"$ref":"#/components/parameters/TunnelId__0f1d40c88b6b"}],"responses":{"200":{"$ref":"#/components/responses/APProbeTrendsResponse__24d76b0b1476"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get latency trend of an Access Point Tunnel.","tags":["Access Points"],"x-source-document":{"file":"MRT/getaccesspointprobelatencytrendv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Access Point Monitoring APIs to get Access Point details and its metrics","name":"Access Points"}]},"pathMetadata":{},"sha256":"26c6f3a3b9bb91770a264dfbe7ac8103e43609a6542198c6788da51b6fbeade0"}}},"/network-monitoring/v1/aps/{serial-number}/tunnels/{tunnel-id}/mos-trends":{"get":{"description":"The API retrieves MOS score trend data for a specific tunnel of an access point. If no timestamp range is specified in the filter, data for the last 3 hours will be returned by default.\n","operationId":"getAccessPointProbeMosTrendV1","parameters":[{"$ref":"#/components/parameters/SerialNumberap__05867e444b37"},{"$ref":"#/components/parameters/TrendsFilter__05867e444b37"},{"$ref":"#/components/parameters/SiteIdOptional__05867e444b37"},{"$ref":"#/components/parameters/SiteNameOptional__05867e444b37"},{"$ref":"#/components/parameters/TunnelId__0f1d40c88b6b"}],"responses":{"200":{"$ref":"#/components/responses/APProbeTrendsResponse__24d76b0b1476"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get MOS score trend of an Access Point Tunnel.","tags":["Access Points"],"x-source-document":{"file":"MRT/getaccesspointprobemostrendv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Access Point Monitoring APIs to get Access Point details and its metrics","name":"Access Points"}]},"pathMetadata":{},"sha256":"6aec9e83a232576833e61aff3eb3dcc36eb43035dff14b921e65343cc24aab8d"}}},"/network-monitoring/v1/aps/{serial-number}/tunnels/{tunnel-id}/packet-loss-trends":{"get":{"description":"The API retrieves packet loss trend data in percentage for a specific tunnel of an access point. If no timestamp range is specified in the filter, data for the last 3 hours will be returned by default.\n","operationId":"getAccessPointProbeLossTrendV1","parameters":[{"$ref":"#/components/parameters/SerialNumberap__05867e444b37"},{"$ref":"#/components/parameters/TrendsFilter__05867e444b37"},{"$ref":"#/components/parameters/SiteIdOptional__05867e444b37"},{"$ref":"#/components/parameters/SiteNameOptional__05867e444b37"},{"$ref":"#/components/parameters/TunnelId__0f1d40c88b6b"}],"responses":{"200":{"$ref":"#/components/responses/APProbeTrendsResponse__24d76b0b1476"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get packet loss trend of an Access Point Tunnel.","tags":["Access Points"],"x-source-document":{"file":"MRT/getaccesspointprobelosstrendv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Access Point Monitoring APIs to get Access Point details and its metrics","name":"Access Points"}]},"pathMetadata":{},"sha256":"13c131b0d1fa47b600178dea0e8d84fe7d7699f92923ff333315e3bb3399ed86"}}},"/network-monitoring/v1/aps/{serial-number}/tunnels/{tunnel-id}/throughput-trends":{"get":{"description":"The API retrieves throughput trend data for a specific tunnel of an access point, including transmitted(tx) and received(rx) data in bits per second. If no timestamp range is specified in the filter, data for the last 3 hours will be returned by default.\n","operationId":"getAccessPointTunnelThroughputV1","parameters":[{"$ref":"#/components/parameters/SerialNumberap__05867e444b37"},{"$ref":"#/components/parameters/TrendsFilter__05867e444b37"},{"$ref":"#/components/parameters/SiteIdOptional__05867e444b37"},{"$ref":"#/components/parameters/SiteNameOptional__05867e444b37"},{"$ref":"#/components/parameters/TunnelId__0f1d40c88b6b"}],"responses":{"200":{"$ref":"#/components/responses/TunnelThroughputTrendsResponse__ed3aa0a73a3f"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get throughput trend of an Access Point Tunnel.","tags":["Access Points"],"x-source-document":{"file":"MRT/getaccesspointtunnelthroughputv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Access Point Monitoring APIs to get Access Point details and its metrics","name":"Access Points"}]},"pathMetadata":{},"sha256":"49184a8ecfd881b8d1dc8146856a7d1145d5d6abf1b7b455f940094ba9cf79d3"}}},"/network-monitoring/v1/aps/{serial-number}/wlans":{"get":{"description":"This API endpoint retrieves a list of WLANs associated to an access point. Each WLAN in the returned list includes WLAN name and security type.\n","operationId":"getAccessPointWlanListV1","parameters":[{"$ref":"#/components/parameters/SerialNumberap__05867e444b37"},{"description":"Specifies the maximum number of WLANs returned in the response.\n","in":"query","name":"limit","required":false,"schema":{"default":20,"examples":[20],"format":"int64","maximum":1000,"minimum":1,"type":"integer"}},{"description":"Specifies the pagination cursor for the next page of resources.\n","in":"query","name":"next","required":false,"schema":{"$ref":"#/components/schemas/Next__21874c7bfa12"}}],"responses":{"200":{"$ref":"#/components/responses/WlanListResponse__2dcf9a625ef5"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get a list of Access Point WLANs","tags":["Access Points"],"x-source-document":{"file":"MRT/getaccesspointwlanlistv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Access Point Monitoring APIs to get Access Point details and its metrics","name":"Access Points"}]},"pathMetadata":{},"sha256":"e472c3dd46697796ab82b6ca8554dbeebf5e78b939adbe75109208fdce046b5b"}}},"/network-monitoring/v1/aps/{serial-number}/wlans/{wlan-name}/throughput-trends":{"get":{"description":"The API retrieves throughput trend data for a specific WLAN of an access point, including transmitted(tx) and received(rx) data in bits per second. If no timestamp range is specified in the filter, data for the last 3 hours will be returned by default.\n","operationId":"getAccessPointWlanThroughputV1","parameters":[{"$ref":"#/components/parameters/SerialNumberap__05867e444b37"},{"$ref":"#/components/parameters/TrendsFilter__05867e444b37"},{"$ref":"#/components/parameters/SiteIdOptional__05867e444b37"},{"$ref":"#/components/parameters/SiteNameOptional__05867e444b37"},{"description":"Provide WLAN name to get transmitted and received data for the specific network.\n","example":"wlan-00006","in":"path","name":"wlan-name","required":true,"schema":{"format":"const","maxLength":128,"type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/AccessPointWLANThroughputTrendsResponse__91253e313aa9"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get the throughput trend for a WLAN of an Access Point.","tags":["Access Points"],"x-source-document":{"file":"MRT/getaccesspointwlanthroughputv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Access Point Monitoring APIs to get Access Point details and its metrics","name":"Access Points"}]},"pathMetadata":{},"sha256":"c5f42c39eb9d89d32dae7d526b709a59674d5d93a1faec492fec35b6ef5cc8c8"}}},"/network-monitoring/v1/bssids":{"get":{"description":"This API endpoint retrieves a list of BSSIDs associated with a customer, based on the query parameters provided. Each BSSID in the returned list includes details like serial number, device name, MAC address, radio number, radio MAC address, BSSID, WLAN name, band, and site information. The query parameters allow you to narrow down the results to BSSIDs that meet specific criteria.\n","operationId":"getBssidsV1","parameters":[{"description":"OData Version 4.0 filter string (limited functionality). Supports only 'and' conjunction ('or' and 'not' are NOT supported). Supported fields and operators are in the below given table.\n\n| Field | Operators |\n| --------- | -------- |\n| `siteId` | `eq` and `in` |\n| `siteName` | `eq` and `in` |\n| `serialNumber` | `eq` and `in` |\n| `macAddress` | `eq` and `in` |\n| `radioMacAddress` | `eq` and `in` |\n\n**The operators are implemented as follows:**\n\n* `eq`: Only values exactly matching the given value are returned.\n\n* `in`: Only values present in the given list are returned.\n\n","example":"serialNumber eq 'AP00000001' and siteId in ('site1', 'site2')","in":"query","name":"filter","required":false,"schema":{"format":"const","maxLength":256,"type":"string"}},{"description":"A comma-separated list of sort expressions. Each sort expression is a property name optionally followed by a direction indicator asc (ascending) or desc (descending).\n\nThe first sort expression in the list defines the primary sort order, the second defines the secondary sort order, and so on. If a direction indicator is omitted the default direction is ascending.\nBy default, the response is sorted in ascending order by deviceName.\nSupported fields are `siteId`, `siteName`, `serialNumber`, `deviceName`, and `wlanName`.\n","in":"query","name":"sort","required":false,"schema":{"example":"deviceName,wlanName desc","format":"const","maxLength":256,"type":"string"}},{"description":"Specifies the maximum number of BSSIDs returned in the response.\n","in":"query","name":"limit","required":false,"schema":{"default":20,"example":20,"format":"int64","maximum":1000,"minimum":0,"type":"integer"}},{"description":"Specifies the pagination cursor for the next page of resources.\nThe minimum value is 1\n","in":"query","name":"next","required":false,"schema":{"$ref":"#/components/schemas/Next__21874c7bfa12"}}],"responses":{"200":{"$ref":"#/components/responses/BssidListResponse__54309c5cca60"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get a list of BSSIDs","tags":["Access Points"],"x-source-document":{"file":"MRT/getbssidsv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Access Point Monitoring APIs to get Access Point details and its metrics","name":"Access Points"}]},"pathMetadata":{},"sha256":"66ff92339c96dd886be35e75528b3144bc3ec7eb94814a857946bcb4a16f1cf2"}}},"/network-monitoring/v1/catalogue-aps":{"get":{"description":"Returns a list of  device (AP) specification  for planning.","operationId":"getCatalogueV1","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CatalogueAps__2a40a211350c"}}},"description":"Returns a list of device with their specification.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Retrieves  device specification for all models","tags":["FloorPlan"],"x-source-document":{"file":"MRT/getcataloguev1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"FloorPlan Manager APIs to get details about FloorMap and entities placed on FloorMap","name":"FloorPlan"}]},"pathMetadata":{},"sha256":"80509e350e5d3c53b1b3a1c4008ddfce91b679126e8c404cd09058bfbfe92621"}}},"/network-monitoring/v1/client-firewall-sessions":{"get":{"description":"This API endpoint retrieves sessions logs from access points, CX switches and gateways in a site based on the given client MAC and the filter.\n","operationId":"listClientFirewallSessionLogsV1","parameters":[{"description":"The ID of the site from which to retrieve the firewall session logs.\n","in":"query","name":"site-id","required":true,"schema":{"example":"2778382","format":"const","maxLength":20,"type":"string"}},{"description":"The start time for the query in RFC 3339 format, must be less than end-at.\n","in":"query","name":"start-at","required":true,"schema":{"example":"2024-11-20T14:14:33Z","format":"date-time","maxLength":27,"type":"string"}},{"description":"The end time for the query in RFC 3339 format, must be greater than start-at.\n","in":"query","name":"end-at","required":true,"schema":{"example":"2024-11-20T14:14:33Z","format":"date-time","maxLength":27,"type":"string"}},{"description":"The client MAC of the source device.\n","in":"query","name":"client-mac","required":true,"schema":{"example":"00:00:00:00:00:00","format":"const","maxLength":17,"type":"string"}},{"description":"OData Version 4.0 filter string (limited functionality). Supports only 'and' conjunction ('or' and 'not' are NOT supported). Supported fields and operators are in the below given table.\n\n| Field | Operators | Required | Type | Default Value | Summary |\n| --------- | -------- | -------- | -------- | -------- | -------- |\n| `applicationCategory` | `eq` | `Yes` | `String` | `N\\A` | `Format is string. Only applicationCategory or webCategory must be set but not both. Also cannot have both applicationCategory and webCategory empty.`|\n| `webCategory` | `eq` | `Yes` | `String` | `N\\A` | `Format is string. Only applicationCategory or webCategory must be set but not both. Also cannot have both applicationCategory and webCategory empty.`| \n| `deviceType` | `eq` and `in` | `No` | `String` | `('DEVICE_TYPE_AP','DEVICE_TYPE_GATEWAY','DEVICE_TYPE_SWITCH'`) | `Format is a tuple that contains string. Example: ('DEVICE_TYPE_AP','DEVICE_TYPE_GATEWAY','DEVICE_TYPE_SWITCH')` | \n| `deduplication` | `eq` | `No` | `String` | `true` | `Format is string but should only contain values true or false. Returns unique session logs if set to true` |\n\n**The operators are implemented as follows:**\n\n* `eq`: Only values exactly matching the given value are returned.\n\n* `in`: Only values present in the given list are returned.\n\n","example":"'applicationCategory' eq 'Web' and 'deviceType' in ('DEVICE_TYPE_AP','DEVICE_TYPE_GATEWAY','DEVICE_TYPE_SWITCH') and 'deduplication' eq 'true'","in":"query","name":"filter","required":true,"schema":{"format":"const","type":"string"}},{"description":"The maximum number of items to return.\n","in":"query","name":"limit","required":false,"schema":{"$ref":"#/components/schemas/Limit__4689c9697989","format":"int32","type":"integer"}},{"description":"Cursor for the next page of results. Use the value returned in the `next` response field to retrieve the next page. Providing both `next` and `offset` in the same request returns `400 Bad Request`.\n","in":"query","name":"next","required":false,"schema":{"example":"NyBErRdk6czGUyDAX5Cp","type":"string"}},{"description":"The offset of the item at which to begin the response. Providing both `offset` and `next` in the same request returns `400 Bad Request`.\n","in":"query","name":"offset","required":false,"schema":{"example":0,"format":"int32","minimum":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientSessionLogResponse__85be29963a81"}}},"description":"Successful operation","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/XRateLimitLimitHeader__0288a339fc72"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/XRateLimitRemainingHeader__0288a339fc72"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"},"503":{"$ref":"#/components/responses/ServiceUnavailableapp__7c5b5fe9ca66"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get client firewall session logs\n","tags":["Firewall Session"],"x-source-document":{"file":"MRT/listclientfirewallsessionlogsv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Firewall Session Monitoring APIs to retrieve firewall session logs from a site.","name":"Firewall Session"}]},"pathMetadata":{},"sha256":"bed598d807737ad618d989fecc53cc22e313011d07131d47054da63d414c3172"}}},"/network-monitoring/v1/client-onboarding-score":{"get":{"description":"Retrieves an onboarding score by stage and overall score for a given time range. If `stage` is not provided, scores are returned for default stages: `assoc`, `auth`, `dhcp`, and `dns`. If `site-id` is omitted tenant-level score is returned.","operationId":"getClientOnboardingScoreV1","parameters":[{"description":"Start timestamp (ISO date format). Must be earlier than end-at. If start-at and end-at are not provided, the default time range is 3 hours.","in":"query","name":"start-at","required":false,"schema":{"example":"2026-04-27T14:30:00Z","format":"const","type":"string"}},{"description":"End timestamp (ISO date format). Must be later than start-at. If start-at and end-at are not provided, the default time range is 3 hours.","in":"query","name":"end-at","required":false,"schema":{"example":"2026-04-29T14:30:00Z","format":"const","type":"string"}},{"description":"Optional site identifier. If omitted, tenant-level score is returned.","in":"query","name":"site-id","required":false,"schema":{"example":"6985764272","format":"const","type":"string"}},{"description":"Optional onboarding stage. Supported values: `assoc`, `auth`, `dhcp`, `dns`. Omit to get all supported stages.","in":"query","name":"stage","required":false,"schema":{"example":"assoc","format":"const","type":"string"}},{"description":"Optional onboarding events version. If not provided or non-numeric, the service uses a default version.","in":"query","name":"version","required":false,"schema":{"example":"1","format":"const","type":"string"}},{"description":"view-type supports DEFAULT, BY_CLIENT and BY_ATTEMPTS view. DEFAULT view gives consolidated metrics based on every single client onboarding attempt in given time period. BY_CLIENT gives consolidated metrics for all distinct client based on the single connection attempt made most recently or latest connection attempt in the given time period. BY_ATTEMPTS view gives the consolidated metrics by extracting latest or most recent connection attempt made per session from the client.","in":"query","name":"view-type","required":false,"schema":{"enum":["DEFAULT","BY_CLIENT","BY_ATTEMPTS"],"example":"BY_CLIENT","type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/OnboardingScoreResponse__540f40c96fc2"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get onboarding score","tags":["Client Onboarding"],"x-source-document":{"file":"MRT/getclientonboardingscorev1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"APIs to retrieve onboarding stage scores, stage export summaries, top reasons, and top grouped counts.","name":"Client Onboarding"}]},"pathMetadata":{},"sha256":"e88188e69676fa107d4ada7d16ebcd0745fd5f5401ccf136124280165b3bfb06"}}},"/network-monitoring/v1/client-onboarding-stage/count":{"get":{"description":"Retrieves top grouped counts for onboarding by stage and status. Query params supports kebab-case","operationId":"getClientOnboardingStageCountV1","parameters":[{"description":"Start timestamp (ISO date format). Must be earlier than end-at. If start-at and end-at are not provided, the default time range is 3 hours.","in":"query","name":"start-at","required":true,"schema":{"example":"2026-04-27T14:30:00Z","type":"string"}},{"description":"End timestamp (ISO date format). Must be later than start-at. If start-at and end-at are not provided, the default time range is 3 hours.","in":"query","name":"end-at","required":true,"schema":{"example":"2026-04-29T14:30:00Z","type":"string"}},{"description":"Optional site identifier. If omitted, tenant-level aggregation is returned.","in":"query","name":"site-id","required":false,"schema":{"example":"6985764272","type":"string"}},{"description":"Grouping field key. Supported values and meanings: `topclients` (client MAC), `topaccessdevices` (AP MAC), `band` (radio band), `topwlans` (ESSID), `topreasons` (onboarding failure reason), `topservers` (auth server if stage is auth, dhcp server if stage is dhcp, dns server if stage is dns). Defaults to `topclients` in resolver when omitted.","in":"query","name":"field","required":false,"schema":{"enum":["topclients","topaccessdevices","band","topwlans","topreasons","topservers"],"example":"topclients","type":"string"}},{"description":"Optional status selector. Supported values: `FAILED` (stage failed), `DELAY` (successful with latency above threshold), `SUCCESS` (successful onboarding). Defaults to `FAILED`.","in":"query","name":"status","required":false,"schema":{"enum":["FAILED","DELAY","SUCCESS"],"example":"FAILED","type":"string"}},{"description":"Optional onboarding stage selector. Omit to get all supported stages.","in":"query","name":"stage","required":false,"schema":{"enum":["assoc","auth","dhcp","dns"],"example":"assoc","type":"string"}},{"description":"Optional onboarding events version. If missing or non-numeric, default version is used.","in":"query","name":"version","required":false,"schema":{"example":"1","type":"string"}},{"description":"view-type supports DEFAULT, BY_CLIENT and BY_ATTEMPTS view. DEFAULT view gives consolidated metrics based on every single client onboarding attempt in given time period. BY_CLIENT gives consolidated metrics for all distinct client based on the single connection attempt made most recently or latest connection attempt in the given time period. BY_ATTEMPTS view gives the consolidated metrics by extracting latest or most recent connection attempt made per session from the client.","in":"query","name":"view-type","required":false,"schema":{"enum":["DEFAULT","BY_CLIENT","BY_ATTEMPTS"],"example":"BY_CLIENT","type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/OnboardingCountResponse__edc7bc848e84"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get top onboarding counts by stage and status for a specific field","tags":["Client Onboarding"],"x-source-document":{"file":"MRT/getclientonboardingstagecountv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"APIs to retrieve onboarding stage scores, stage export summaries, top reasons, and top grouped counts.","name":"Client Onboarding"}]},"pathMetadata":{},"sha256":"8033a5dffb7e54927d24b687031ac9ab61f9c7ee834d3aa106af27c280cf81ff"}}},"/network-monitoring/v1/client-onboarding-stage/export":{"get":{"description":"Retrieves per-stage onboarding export data with summary totals and top five delayed/failed dimensions. Query params arsupportse kebab-case","operationId":"getClientOnboardingStageExportV1","parameters":[{"description":"Start timestamp (ISO date format). Must be earlier than end-at. If start-at and end-at are not provided, the default time range is 3 hours.","in":"query","name":"start-at","required":true,"schema":{"example":"2026-04-27T14:30:00Z","type":"string"}},{"description":"End timestamp (ISO date format). Must be later than start-at. If start-at and end-at are not provided, the default time range is 3 hours.","in":"query","name":"end-at","required":true,"schema":{"example":"2026-04-29T14:30:00Z","type":"string"}},{"description":"Optional site identifier. If omitted, tenant-level aggregation is returned.","in":"query","name":"site-id","required":false,"schema":{"example":"6985764272","type":"string"}},{"description":"Optional onboarding stage selector. Omit to get all supported stages.","in":"query","name":"stage","required":false,"schema":{"enum":["assoc","auth","dhcp","dns"],"example":"assoc","type":"string"}},{"description":"Optional onboarding events version. If missing or non-numeric, default version is used.","in":"query","name":"version","required":false,"schema":{"example":"1","type":"string"}},{"description":"view-type supports DEFAULT, BY_CLIENT and BY_ATTEMPTS view. DEFAULT view gives consolidated metrics based on every single client onboarding attempt in given time period. BY_CLIENT gives consolidated metrics for all distinct client based on the single connection attempt made most recently or latest connection attempt in the given time period. BY_ATTEMPTS view gives the consolidated metrics by extracting latest or most recent connection attempt made per session from the client.","in":"query","name":"view-type","required":false,"schema":{"enum":["DEFAULT","BY_CLIENT","BY_ATTEMPTS"],"example":"BY_CLIENT","type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/OnboardingStageExportResponse__5359db3f2927"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get onboarding stage export data","tags":["Client Onboarding"],"x-source-document":{"file":"MRT/getclientonboardingstageexportv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"APIs to retrieve onboarding stage scores, stage export summaries, top reasons, and top grouped counts.","name":"Client Onboarding"}]},"pathMetadata":{},"sha256":"3340fd2c9bf9da67a79c6e77ed270bdf4fe66b75573159f4cfbd395f1e924e7f"}}},"/network-monitoring/v1/client-onboarding-stage/reasons":{"get":{"description":"Retrieves top reasons by onboarding stage for a status. Query params supports kebab-case.","operationId":"getClientOnboardingStageReasonsV1","parameters":[{"description":"Start timestamp (ISO date format). Must be earlier than end-at. If start-at and end-at are not provided, the default time range is 3 hours.","in":"query","name":"start-at","required":true,"schema":{"example":"2026-04-27T14:30:00Z","type":"string"}},{"description":"End timestamp (ISO date format). Must be later than start-at. If start-at and end-at are not provided, the default time range is 3 hours.","in":"query","name":"end-at","required":true,"schema":{"example":"2026-04-29T14:30:00Z","type":"string"}},{"description":"Optional site identifier. If omitted, tenant-level aggregation is returned.","in":"query","name":"site-id","required":false,"schema":{"example":"6985764272","type":"string"}},{"description":"Optional status selector. Supported values: `FAILED` (stage failed), `DELAY` (successful with latency above threshold). Defaults to `FAILED`.","in":"query","name":"status","required":false,"schema":{"enum":["FAILED","DELAY","SUCCESS"],"example":"FAILED","type":"string"}},{"description":"Optional onboarding stage selector. omit stage to get all supported stages.","in":"query","name":"stage","required":false,"schema":{"enum":["assoc","auth","dhcp","dns"],"example":"assoc","type":"string"}},{"description":"Optional onboarding events version. If missing or non-numeric, default version is used.","in":"query","name":"version","required":false,"schema":{"example":"1","type":"string"}},{"description":"view-type supports DEFAULT, BY_CLIENT and BY_ATTEMPTS view. DEFAULT view gives consolidated metrics based on every single client onboarding attempt in given time period. BY_CLIENT gives consolidated metrics for all distinct client based on the single connection attempt made most recently or latest connection attempt in the given time period. BY_ATTEMPTS view gives the consolidated metrics by extracting latest or most recent connection attempt made per session from the client.","in":"query","name":"view-type","required":false,"schema":{"enum":["DEFAULT","BY_CLIENT","BY_ATTEMPTS"],"example":"BY_CLIENT","type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/OnboardingReasonsResponse__ec4a680d09ad"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get top onboarding reasons by stage","tags":["Client Onboarding"],"x-source-document":{"file":"MRT/getclientonboardingstagereasonsv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"APIs to retrieve onboarding stage scores, stage export summaries, top reasons, and top grouped counts.","name":"Client Onboarding"}]},"pathMetadata":{},"sha256":"55be552cd18aade33e9f55d9163adb88e721f860cba9b9251ac8d6b7d2946a25"}}},"/network-monitoring/v1/clients":{"get":{"description":"This API endpoint retrieves a list of Clients, based on the query parameters provided. Clients list includes details like clientName, status, clientConnectionType, etc., The query parameters allow you to narrow down the results that meet specific criteria, ensuring you receive only the relevant data.","operationId":"listUnifiedClients","parameters":[{"description":"The ID of the site from which the clients are to be retrieved.\n","in":"query","name":"site-id","required":false,"schema":{"example":"12345367","format":"const","type":"string"}},{"description":"The name of the site from which the clients are to be retrieved.\n","in":"query","name":"site-name","required":false,"schema":{"example":"site_name1","format":"const","type":"string"}},{"description":"Specifies the device identifier.","in":"query","name":"serial-number","schema":{"example":"QWR124780123","format":"const","type":"string"}},{"description":"Start timestamp in RFC 3339 date-time string. Must be less than end-at. For global-level queries, the interval between start-at and end-at must be ≤ 7 days. For site-level queries, the interval must be ≤ 1 month. Default is end-at - 3 hours. The query parameters start-at and end-at only impacts failed clients.\n","in":"query","name":"start-at","schema":{"example":"2025-07-10T08:09:17.419Z","format":"const","type":"string"}},{"description":"End timestamp in RFC 3339 date-time format. Must be later than start-at. For global-level queries, the interval between start-at and end-at must be ≤ 7 days. For site-level queries, it must be ≤ 1 month. Default is the current timestamp.","in":"query","name":"end-at","schema":{"example":"2025-07-10T08:11:17.419Z","format":"const","type":"string"}},{"description":"OData Version 4.0 filter string (limited functionality). Supports only 'and' conjunction ('or' and 'not' are NOT supported). By default, `status eq 'Connected'` filter is applied. To retrieve clients with a different status, explicitly specify the status in the filter. If other filters are provided without status, the default connected status filter is still applied. Supported fields and operators are in the below given table.\n\n| Field | Operators |\n| --------- | --------  |\n| `clientConnectionType` | `eq` and `in` |\n| `status` | `eq` and `in` |\n| `wlanName` | `eq` and `in` |\n| `vlanId` | `eq` and `in` |\n| `tunnelType` | `eq` and `in` |\n| `role` | `eq` and `in` |\n\n**The operators are implemented as follows:**\n\n* `eq`: Only values exactly matching the given value are returned.\n* `in`: Only values present in the given list are returned.\n\n**List of applicable filters for field and terms:**\n\n| Field | Applicable Terms |\n| --------- | -------- |\n| clientConnectionType | `[\"Wired\", \"Wireless\", \"Remote\"]`  |\n| status | `[\"Connected\", \"Failed\"]` |\n| wlanName | `string` |\n| vlanId | `string` |\n| tunnelType | `[\"Port-based\", \"User-based\", \"Overlay\"]` |\n| role | `string` |\n\n","example":"tunnelType in ('Port-based', 'Overlay') and clientConnectionType eq 'Wired'","in":"query","name":"filter","schema":{"default":"status eq 'Connected'","type":"string"}},{"description":"Sort field followed by a direction indicator ASC (ascending) or DESC (descending). Supported fields are clientName,status,clientConnectionType,macAddress,ipv4,ipv6,connectedDeviceSerial,connectedTo,lastSeenAt,port,role,wlanName,vlanId,tunnelType,tunnelId,connectedAt\n","in":"query","name":"sort","schema":{"example":"clientName asc","format":"const","maxLength":256,"type":"string"}},{"description":"Specifies the pagination cursor for the next page of resources. Minimum value is 1","example":"1","in":"query","name":"next","schema":{"default":"1","minimum":1,"type":"string"}},{"description":"Maximum number of clients to be retrieved. Allowed range is 1 to 1000.","in":"query","name":"limit","schema":{"default":100,"maximum":1000,"minimum":1,"type":"integer"}}],"responses":{"200":{"$ref":"#/components/responses/ListClientsResponse__b58ef4da0e1a"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"List Unified Clients","tags":["Clients"],"x-source-document":{"file":"MRT/listunifiedclients.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"APIs for managing network clients.","name":"Clients"}]},"pathMetadata":{},"sha256":"635723eca8a2414320ab0b060c4fcfe83373f3401eb81b724b6ceaa33834e82f"}}},"/network-monitoring/v1/clients-topn-usage":{"get":{"description":"Retrieves top N client by usage in reverse sorted order across a time range.","operationId":"GetTopNClientsByUsage","parameters":[{"description":"The ID of the site from which the clients are to be retrieved.","in":"query","name":"site-id","required":false,"schema":{"example":"2778382","format":"const","type":"string"}},{"description":"The name of the site from which the clients are to be retrieved.\n","in":"query","name":"site-name","required":false,"schema":{"example":"site_name1","format":"const","type":"string"}},{"description":"Start timestamp in RFC 3339 date-time string. Must be less than end-at. For global-level queries, the interval between start-at and end-at must be ≤ 7 days. For site-level queries, the interval must be ≤ 1 month. The interval between start-at and end-at must be **≤ 1 month**. Default is end-at - 3 hours.\n","in":"query","name":"start-at","schema":{"example":"2025-07-10T08:09:17.419Z","format":"const","type":"string"}},{"description":"End timestamp in RFC 3339 date-time string. Must be greater than start-at. For global-level queries, the interval between start-at and end-at must be ≤ 7 days. For site-level queries, it must be ≤ 1 month.  Default is current timestamp.","in":"query","name":"end-at","schema":{"example":"2025-07-10T08:11:17.419Z","format":"const","type":"string"}},{"description":"Specifies the device identifier.","in":"query","name":"serial-number","schema":{"example":"QWR124780123","format":"const","type":"string"}},{"description":"Maximum number of clients to be retrieved. Allowed range is 1 to 100.","in":"query","name":"limit","schema":{"default":5,"maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"$ref":"#/components/responses/TopNClientsUsageResponse__c21517c4950b"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get Top N Clients By Usage","tags":["Clients"],"x-source-document":{"file":"MRT/gettopnclientsbyusage.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"APIs for managing network clients.","name":"Clients"}]},"pathMetadata":{},"sha256":"63fbeb51de4b6ea0046ac26fe7f82db391ff491a915a61846a9b56f83ab4032d"}}},"/network-monitoring/v1/clients-trend":{"get":{"description":"Retrieves the clients trend based on the specified group-by field and type category across a time range.","operationId":"GetClientsTrends","parameters":[{"description":"The ID of the site for which clients trend are to be retrieved.","in":"query","name":"site-id","required":false,"schema":{"example":"2778382","format":"const","type":"string"}},{"description":"The name of the site for which clients trend are to be retrieved.\n","in":"query","name":"site-name","required":false,"schema":{"example":"site_name1","format":"const","type":"string"}},{"description":"Start timestamp in RFC 3339 date-time string. Must be less than end-at. For global-level queries, the interval between start-at and end-at must be ≤ 7 days. For site-level queries, the interval must be ≤ 1 month. \n Interval between sample data points is based on the time difference:\n  * Less than or equal to 1 day → 5 min  \n  * Greater than 1 day and less than or equal to 1 month → 3 hours \n","in":"query","name":"start-at","schema":{"example":"2025-08-19T06:45:00Z","format":"const","type":"string"}},{"description":"End timestamp in RFC 3339 date-time string. Must be greater than start-at. For global-level queries, the interval between start-at and end-at must be ≤ 7 days. For site-level queries, it must be ≤ 1 month.  Default is current timestamp.","in":"query","name":"end-at","schema":{"example":"2025-08-19T09:45:00Z","format":"const","type":"string"}},{"description":"Groups results by the specified field. If grouping by role, vlan, or wlan gives more than 5 unique names, then returns top 4 by client count and folds remaining under 'Others' name. wlan, radio, security, protocol supported for wireless clients only.","in":"query","name":"group-by","schema":{"default":"TYPE","enum":["TYPE","ROLE","VLAN","WLAN","RADIO","SECURITY","PROTOCOL"],"type":"string"}},{"description":"Category of clients where group-by field should be applied.","in":"query","name":"type","schema":{"default":"ALL","enum":["ALL","WIRELESS","WIRED","REMOTE"],"type":"string"}},{"description":"Specifies the device identifier.","in":"query","name":"serial-number","schema":{"example":"QWR124780123","format":"const","type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/ClientsTrendResponse__55ca259b8355"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get Clients Trend","tags":["Clients"],"x-source-document":{"file":"MRT/getclientstrends.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"APIs for managing network clients.","name":"Clients"}]},"pathMetadata":{},"sha256":"5093e799ec99eced420ab882fca75d8f9430c544cc69e5752024b279abe2abf8"}}},"/network-monitoring/v1/clients-usage":{"get":{"description":"Retrieves the TX and RX usage trend (sum of bytes) for clients over a time range. Supports filtering through the `filter` query parameter using `timestamp`, `macAddress`, `serialNumber`, `siteId`, and `siteName`. When `macAddress` is provided, returns usage trend for that specific client. When `serialNumber` is provided, returns aggregated usage for all clients on that device. When `siteId` or `siteName` is provided, returns aggregated usage for all clients at that site. When no filter is provided, returns tenant-level aggregated usage.\n\nSampling interval is determined by the time range:\n* ≤ 1 day → 5 min\n* > 1 day and ≤ 1 month → 3 hours","operationId":"GetClientsUsage","parameters":[{"description":"OData Version 4.0 filter string (limited functionality). Supports only 'and' conjunction ('or' and 'not' are NOT supported). Supported fields, operators and value format are in the below given table.\n\n| Field | Operators | Format |\n| --------- | -------- | -------- |\n| `timestamp` | `gt` and `lt` | **Date-time (RFC 3339 timestamp in UTC+0) string** |\n| `siteId` | `eq` | string |\n| `siteName` | `eq` | string |\n| `macAddress` | `eq` | string |\n| `serialNumber` | `eq` | string |\n\n**The operators are implemented as follows:**\n\n* `gt`: Used to indicate the start of the timestamp range. If `timestamp gt` is omitted, it defaults to 3 hours before the `timestamp lt` value. If both `timestamp gt` and `timestamp lt` are omitted, the effective start defaults to 3 hours before the current timestamp.\n\n* `lt`: Used to indicate the end of the timestamp range. If `timestamp lt` is omitted, it defaults to the current timestamp.\n\n* For global-level queries, the interval between `timestamp gt` and `timestamp lt` must be less than or equal to 7 days. For site-level queries, the interval must be less than or equal to 1 month.\n\n* `eq`: Only values exactly matching the given value are returned.\n\n","example":"timestamp gt 2025-08-19T06:45:00Z and timestamp lt 2025-08-19T09:45:00Z and siteId eq '2778382'","in":"query","name":"filter","required":false,"schema":{"format":"const","maxLength":256,"type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/ClientsUsageResponse__6bf98218c48a"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get Clients Usage","tags":["Clients"],"x-source-document":{"file":"MRT/getclientsusage.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"APIs for managing network clients.","name":"Clients"}]},"pathMetadata":{},"sha256":"62a9b33389ad052e97727fa1e839206fc641a17048e45c61dfdceb370ee95aa8"}}},"/network-monitoring/v1/clients/{mac-address}":{"get":{"description":"This API endpoint retrieves detail of Client, based on the query parameters provided. Client detail includes clientName, status, ipv4, etc.","operationId":"getClientDetails","parameters":[{"description":"MAC address of the Wireless/Wired/Remote Client to be queried","in":"path","name":"mac-address","required":true,"schema":{"example":"05:50:35:a1:a0:01","format":"const","type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/getClientDetailsResponse__284f33982989"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get Client Details","tags":["Clients"],"x-source-document":{"file":"MRT/getclientdetails.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"APIs for managing network clients.","name":"Clients"}]},"pathMetadata":{},"sha256":"8566dd0dfbdb7f17aebd8cd238cb22488e2fb96bce3b4e0bd5ea3a70965c35c3"}}},"/network-monitoring/v1/clients/{mac-address}/mobility-trail":{"get":{"description":"This API endpoint retrieves wireless client mobility details.","operationId":"GetClientMobilityDetails","parameters":[{"description":"The ID of the site from which the client mobility details are to be retrieved.\n","in":"query","name":"site-id","required":false,"schema":{"example":"12345678","format":"const","type":"string"}},{"description":"The name of the site from which the clients mobility details are to be retrieved.\n","in":"query","name":"site-name","required":false,"schema":{"example":"site_name1","format":"const","type":"string"}},{"description":"MAC address of the Wireless Client to be queried","in":"path","name":"mac-address","required":true,"schema":{"example":"c8:b5:ad:c3:b2:04","format":"const","type":"string"}},{"description":"Start timestamp in RFC 3339 date-time string. Must be less than end-at. The interval between start-at and end-at must be **≤ 1 month**. Default is end-at - 3 hours.\n","in":"query","name":"start-at","schema":{"example":"2025-07-10T08:09:17.419Z","type":"string"}},{"description":"End timestamp in RFC 3339 date-time string. Must be greater than start-at, and the interval between start and end must be <= 1 month. Default is current timestamp.","in":"query","name":"end-at","schema":{"example":"2025-07-10T08:11:17.419Z","type":"string"}},{"description":"OData Version 4.0 filter string (limited functionality). Supports only 'and' conjunction ('or' and 'not' are NOT supported). Supported fields and operators are in the below given table.\n\n| Field | Operators |\n| --------- | -------- |\n| `wlanName` | `eq` and `in` |\n| `radioBand` | `eq` and `in` |\n\n**The operators are implemented as follows:**\n\n* `eq`: Only values exactly matching the given value are returned.\n* `in`: Only values present in the given list are returned.\n\n**List of applicable filters for field and terms:**\n\n| Field | Applicable Terms |\n| --------- | -------- |\n| wlanName | `string` |\n| radioBand | `[\"2.4 GHz\", \"5 GHz\", \"6 GHz\"]` |\n","example":"wlanName in ('wlan-00001') and radioBand eq '5 GHz'","in":"query","name":"filter","schema":{"type":"string"}},{"description":"Sort field followed by a direction indicator ASC (ascending) or DESC (descending). Supported field is occurredAt. Default sorting for occurredAt is DESC.","in":"query","name":"sort","schema":{"example":"occurredAt ASC","format":"const","maxLength":256,"type":"string"}},{"description":"Specifies the pagination cursor for the next page of resources. Minimum value is 1","example":"1","in":"query","name":"next","schema":{"default":"1","minimum":1,"type":"string"}},{"description":"Maximum number of client mobility details to be retrieved. Allowed range is 1 to 100.","in":"query","name":"limit","schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"$ref":"#/components/responses/GetClientMobilityDetailsResponse__972dd6d46bea"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get Wireless Client Mobility Details","tags":["Clients"],"x-source-document":{"file":"MRT/getclientmobilitydetails.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"APIs for managing network clients.","name":"Clients"}]},"pathMetadata":{},"sha256":"df06aaf622ba2924ebd1be1259ac34c7f030ad2adb63690095ff08eecd968cb2"}}},"/network-monitoring/v1/clusters/{cluster-name}/capacity-trends":{"get":{"description":"Retrieves client and device capacity trend data for a gateway cluster based on specified timestamp range.\n","operationId":"getClusterCapacityTrendV1","parameters":[{"$ref":"#/components/parameters/ClusterName__3a50015484e1"},{"$ref":"#/components/parameters/TrendsFiltergw__1053ccf03958"}],"responses":{"200":{"$ref":"#/components/responses/ClusterCapacityTrendResponse__7201244eb725"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get cluster capacity trend","tags":["Gateways"],"x-source-document":{"file":"MRT/getclustercapacitytrendv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Gateway Monitoring APIs to get gateway details and their metrics","name":"Gateways"}]},"pathMetadata":{},"sha256":"60ef252d5686a1148dcd13ac780337f77bc52bb859ff2ed18351ef42eea328a4"}}},"/network-monitoring/v1/clusters/{cluster-name}/capacity-trends/{serial-number}":{"get":{"description":"Retrieves client and device capacity trend data for a specific gateway in a gateway cluster based on specified timestamp range.\n","operationId":"getClusterMemberCapacityTrendV1","parameters":[{"$ref":"#/components/parameters/ClusterName__3a50015484e1"},{"$ref":"#/components/parameters/TrendsFiltergw__1053ccf03958"},{"$ref":"#/components/parameters/SerialNumbergw__1053ccf03958"}],"responses":{"200":{"$ref":"#/components/responses/ClusterMemberCapacityTrendResponse__3a50015484e1"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get cluster member capacity trend","tags":["Gateways"],"x-source-document":{"file":"MRT/getclustermembercapacitytrendv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Gateway Monitoring APIs to get gateway details and their metrics","name":"Gateways"}]},"pathMetadata":{},"sha256":"8cc5e249973b4d838ffcfadaf999413a9858798a947d2631c1711442e23dde71"}}},"/network-monitoring/v1/clusters/{cluster-name}/connectivity-graph":{"get":{"description":"Retrieves information about gateways in a gateway-cluster, including their peers and their VLAN mismatches.\n","operationId":"getGatewayClusterConnectivityGraphV1","parameters":[{"$ref":"#/components/parameters/ClusterName__3a50015484e1"}],"responses":{"200":{"$ref":"#/components/responses/ClusterConnectivityGraphResponse__facf932e9683"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Gateway cluster connectivity graph information","tags":["Gateways"],"x-source-document":{"file":"MRT/getgatewayclusterconnectivitygraphv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Gateway Monitoring APIs to get gateway details and their metrics","name":"Gateways"}]},"pathMetadata":{},"sha256":"6cb4d4a40ff5cbfc19f04dc98b7cc4fd7ef2d47f5421e5d26cb4f0f5a520c5b5"}}},"/network-monitoring/v1/clusters/{cluster-name}/members":{"get":{"description":"Retrieves a list of gateways present in a cluster with comprehensive details.\n","operationId":"getGatewayClusterMemberListV1","parameters":[{"$ref":"#/components/parameters/ClusterName__3a50015484e1"},{"description":"OData Version 4.0 filter string (limited functionality). Supports only 'and' conjunction ('or' and 'not' are NOT supported). Supported fields and operators are in the below given table.\n\n| Field | Operators |\n| --------- | -------- |\n| `status` | `eq` and `in` |\n| `role` | `eq` and `in` |\n| `model` | `eq` and `in` |\n| `softwareVersion` | `eq` and `in` |\n| `firmwareVersion` | `eq` and `in` |\n| `siteName` | `eq` and `in` |\n\n**The operators are implemented as follows:**\n\n* `eq`: Only values exactly matching the given value are returned.\n\n* `in`: Only values present in the given list are returned.\n\n","example":"siteId eq '12345' and deployment in ('Standalone')","in":"query","name":"filter","required":false,"schema":{"maxLength":256,"type":"string"}},{"description":"A comma-separated list of sort expressions. Each sort expression is a property name optionally followed by a direction indicator asc (ascending) or desc (descending).\n\nThe first sort expression in the list defines the primary sort order, the second defines the secondary sort order, and so on. If a direction indicator is omitted the default direction is ascending.\n\nSupported fields are `status`, `role`, `model`, `ipv4`, `softwareVersion`, `firmwareVersion`, `siteName` and `macAddress`.\n","in":"query","name":"sort","required":false,"schema":{"example":"siteName desc","maxLength":256,"type":"string"}},{"description":"Denotes the maximum number of gateways returned in the response.\n","in":"query","name":"limit","required":false,"schema":{"default":20,"example":20,"format":"int64","maximum":100,"minimum":0,"type":"integer"}},{"description":"Specifies the pagination cursor for the next page of resources.\n\nMinimum value: 1\n","in":"query","name":"next","required":false,"schema":{"$ref":"#/components/schemas/Next__21874c7bfa12"}}],"responses":{"200":{"$ref":"#/components/responses/ClusterMemberListResponse__de89a47d9bd8"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"List Gateway Cluster members","tags":["Gateways"],"x-source-document":{"file":"MRT/getgatewayclustermemberlistv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Gateway Monitoring APIs to get gateway details and their metrics","name":"Gateways"}]},"pathMetadata":{},"sha256":"a88d9e8645aaca53264d6e945d5dab2110a7f3339d35631b53b46dbe5ed0a1bd"}}},"/network-monitoring/v1/clusters/{cluster-name}/tunnels":{"get":{"description":"Retrieves a list of tunnels present in a gateway-cluster with details like tunnel name, gateway, encapsulation, health and more.\n","operationId":"getGatewayClusterTunnelListV1","parameters":[{"$ref":"#/components/parameters/ClusterName__3a50015484e1"},{"description":"OData Version 4.0 filter string (limited functionality). Supports only 'and' conjunction ('or' and 'not' are NOT supported). Supported fields and operators are in the below given table.\n\n| Field | Operators |\n| --------- | -------- |\n| `tunnelName` | `eq` and `in` |\n| `health` | `eq` and `in` |\n| `status` | `eq` and `in` |\n| `gateway` | `eq` and `in` |\n| `encapsulation` | `eq` and `in` |\n| `mode` | `eq` and `in` |\n\n**The operators are implemented as follows:**\n\n* `eq`: Only values exactly matching the given value are returned.\n\n* `in`: Only values present in the given list are returned.\n\n","example":"encapsulation eq 'GRE' and status eq 'Connected'","in":"query","name":"filter","required":false,"schema":{"maxLength":256,"type":"string"}},{"description":"A comma-separated list of sort expressions. Each sort expression is a property name optionally followed by a direction indicator asc (ascending) or desc (descending).\n\nThe first sort expression in the list defines the primary sort order, the second defines the secondary sort order, and so on. If a direction indicator is omitted the default direction is ascending.\n\nSupported fields are `tunnelName`, `gateway`, `encapsulation`, `destinationIpAddress`, `sourceIpAddress`, `mode`, `uptime` and `vni`.\n","in":"query","name":"sort","required":false,"schema":{"example":"encapsulation desc","maxLength":256,"type":"string"}},{"description":"Denotes the maximum number of tunnels returned in the response.\n","in":"query","name":"limit","required":false,"schema":{"default":20,"example":20,"format":"int64","maximum":100,"minimum":0,"type":"integer"}},{"description":"Specifies the pagination cursor for the next page of resources.\n\nMinimum value: 1\n","in":"query","name":"next","required":false,"schema":{"$ref":"#/components/schemas/Next__21874c7bfa12"}}],"responses":{"200":{"$ref":"#/components/responses/GatewayClusterTunnelListResponse__608b430a0026"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"List Gateway Cluster tunnels","tags":["Gateways"],"x-source-document":{"file":"MRT/getgatewayclustertunnellistv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Gateway Monitoring APIs to get gateway details and their metrics","name":"Gateways"}]},"pathMetadata":{},"sha256":"e5b15c7fd5e56ca330f0952af0099c09e402b4f2a4b07ee8fef443d48abf2e07"}}},"/network-monitoring/v1/clusters/{cluster-name}/tunnels-health-summary":{"get":{"description":"Retrieves health summary of tunnels in a gateway-cluster.\n","operationId":"getGatewayClusterTunnelHealthV1","parameters":[{"$ref":"#/components/parameters/ClusterName__3a50015484e1"}],"responses":{"200":{"$ref":"#/components/responses/ClusterTunnelHealthSummaryResponse__49fb391231f9"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get summary of cluster tunnel health","tags":["Gateways"],"x-source-document":{"file":"MRT/getgatewayclustertunnelhealthv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Gateway Monitoring APIs to get gateway details and their metrics","name":"Gateways"}]},"pathMetadata":{},"sha256":"1f2aed376398162a0f9b5a27cee0e0463c530e905e933d0ec36e9c386c8ec05f"}}},"/network-monitoring/v1/clusters/{cluster-name}/tunnels-status-summary":{"get":{"description":"Retrieves the count of inter-gateway tunnels (tunnels in-between gateways in a cluster) that are Up and Down in a gateway-cluster.\n","operationId":"getGatewayClusterTunnelsStatusSummaryV1","parameters":[{"$ref":"#/components/parameters/ClusterName__3a50015484e1"}],"responses":{"200":{"$ref":"#/components/responses/ClusterTunnelStatusSummaryResponse__eca6a91fa313"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get summary of cluster tunnel status","tags":["Gateways"],"x-source-document":{"file":"MRT/getgatewayclustertunnelsstatussummaryv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Gateway Monitoring APIs to get gateway details and their metrics","name":"Gateways"}]},"pathMetadata":{},"sha256":"fb155f3c4b4f1a1b74e5bf030a22426fc1aeef8a59fe74574e2165f6bbba7665"}}},"/network-monitoring/v1/clusters/{cluster-name}/vlan-mismatch":{"get":{"description":"Retrieves VLAN mismatch information categorized as good or poor for the entire gateway-cluster or individual gateways within the gateway-cluster.\n","operationId":"getGatewayClusterVlanMismatchSummaryV1","parameters":[{"$ref":"#/components/parameters/ClusterName__3a50015484e1"},{"description":"OData Version 4.0 filter string (limited functionality). Supported fields and operators are in the below given table.\n\n| Field | Operators |\n| --------- | -------- |\n| `serialNumber` | `eq` |\n\n **The operators are implemented as follows:**\n\n* `eq`: Only values exactly matching the given value are returned.\n","example":"serialNumber eq 'GW00001'","in":"query","name":"filter","required":false,"schema":{"maxLength":256,"type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/ClusterVlanMismatchResponse__a51bf4679e93"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Gateway cluster VLAN mismatch summary","tags":["Gateways"],"x-source-document":{"file":"MRT/getgatewayclustervlanmismatchsummaryv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Gateway Monitoring APIs to get gateway details and their metrics","name":"Gateways"}]},"pathMetadata":{},"sha256":"2987a52c84c12b387f2c9588b7c41fa33e3b6e526145f07eafb7e34a955aad6d"}}},"/network-monitoring/v1/device-inventory":{"get":{"description":"This API endpoint retrieves a list of network devices that are present in inventory, such as access points, switches, and gateways. The API includes devices yet to be on-boarded, as well as those already on-boarded and currently being monitored by the system. Each device in the returned list includes details like serial number, device name, part number, deployment, device function, scope ID, device group ID, whether the device is provisioned, etc. The query parameters allow you to narrow down the results to devices that meet specific criteria, ensuring you receive only the relevant data.\n","operationId":"getDeviceInventoryV1","parameters":[{"$ref":"#/components/parameters/FilterDeviceInventory__cd77b09562fb"},{"$ref":"#/components/parameters/SortDeviceInventory__cd77b09562fb"},{"$ref":"#/components/parameters/SiteAssigned__cd77b09562fb"},{"description":"Specifies the maximum number of devices returned in the response. Maximum value is 1000.","in":"query","name":"limit","required":false,"schema":{"$ref":"#/components/schemas/Limitdevice__cd77b09562fb"}},{"description":"Specifies the pagination cursor for the next page of resources.\nThe minimum value is 1.","in":"query","name":"next","required":false,"schema":{"$ref":"#/components/schemas/Next__21874c7bfa12"}}],"responses":{"200":{"$ref":"#/components/responses/DeviceInventoryResponseV1__cd77b09562fb"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get a device inventory list","tags":["Devices"],"x-source-document":{"file":"MRT/getdeviceinventoryv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Device monitoring APIs to get device details and its metrics","name":"Devices"}]},"pathMetadata":{},"sha256":"b7acf97b51d5a8f7bc3b1a823379b48e664b4ab858ca525f0edea3e907c720b0"}}},"/network-monitoring/v1/device-notes":{"post":{"description":"Initiates an asynchronous bulk update of device notes. Returns a task ID that can be used to poll for operation status. Maximum 1000 devices per request. Only one async operation per tenant is allowed at a time. To delete the notes, set the notes to an empty string.\n\n**Note:**\n- For stack switch devices, either the member or conductor serial number can be used.\n- This operation overwrites any previously set notes for the specified devices.","operationId":"createDeviceNotesAsyncV1","parameters":[],"requestBody":{"content":{"application/json":{"examples":{"update_notes":{"summary":"Update notes for two devices","value":{"devices":[{"notes":"Device is in Building A, Floor 2","serialNumber":"AP00000001"},{"notes":"Replacement scheduled","serialNumber":"AP00000002"}]}}},"schema":{"$ref":"#/components/schemas/UpdateNotesAsyncRequest__039ba698cb40"}}},"description":"List of devices with their notes to update.","required":true},"responses":{"202":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Accepted. The asynchronous operation has been successfully initiated. Use the URI in the `Location` header to track the operation status.","headers":{"Location":{"description":"The relative URI to query the status and result of the asynchronous operation.","schema":{"example":"/network-monitoring/v1/device-notes-async-operations/550e8400-e29b-41d4-a716-446655440000","format":"uri-reference","type":"string"}},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"409":{"$ref":"#/components/responses/NotesConflict__039ba698cb40"},"415":{"$ref":"#/components/responses/UnsupportedMediaType__039ba698cb40"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"},"503":{"$ref":"#/components/responses/ServiceUnavailabledevice__0288a339fc72"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Update notes for multiple devices","tags":["Devices"],"x-source-document":{"file":"MRT/createdevicenotesasyncv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Device monitoring APIs to get device details and its metrics","name":"Devices"}]},"pathMetadata":{},"sha256":"86ae5c5bdc319c5fd03a3819acfd5b4001bbc6850099abe1e1b5195510ae9bde"}}},"/network-monitoring/v1/device-notes-async-operations/{id}":{"get":{"description":"This API endpoint retrieves the status and results of a previously initiated asynchronous notes update operation. Use the task ID from the `Location` header returned by `POST /network-monitoring/v1/device-notes`.","operationId":"getDeviceNotesOperationV1","parameters":[{"$ref":"#/components/parameters/Iddevice__0288a339fc72"}],"responses":{"200":{"content":{"application/json":{"examples":{"running":{"summary":"Operation in progress","value":{"endedAt":null,"error":null,"failed":0,"logMessages":[{"message":"Notes update initiated","timestamp":"2026-03-25T10:30:00Z"},{"message":"Processing started","timestamp":"2026-03-25T10:30:00Z"}],"progressPercent":33,"results":{"failed":[],"succeeded":[{"id":"AP00000001","notes":"Device is in Building A","serialNumber":"AP00000001","type":"network-monitoring/device-monitoring"}]},"sourceResourceUri":"/network-monitoring/v1/device-notes","startedAt":"2026-03-25T10:30:00Z","state":"RUNNING","succeeded":1,"total":3}},"succeeded":{"summary":"Operation completed successfully","value":{"endedAt":"2026-03-25T10:30:05Z","error":null,"failed":1,"logMessages":[{"message":"Notes update initiated","timestamp":"2026-03-25T10:30:00Z"},{"message":"Processing started","timestamp":"2026-03-25T10:30:00Z"},{"message":"Processing completed successfully","timestamp":"2026-03-25T10:30:05Z"}],"progressPercent":100,"results":{"failed":[{"errorCode":"HPE_GL_NETWORK_MONITORING_DEVICE_NOT_FOUND","errorMessage":"Device not found","id":"AP00000004","notes":null,"serialNumber":"AP00000004","type":"network-monitoring/device-monitoring"}],"succeeded":[{"id":"AP00000001","notes":"Device is in Building A","serialNumber":"AP00000001","type":"network-monitoring/device-monitoring"},{"id":"AP00000003","notes":"Replacement scheduled","serialNumber":"AP00000003","type":"network-monitoring/device-monitoring"}]},"sourceResourceUri":"/network-monitoring/v1/device-notes","startedAt":"2026-03-25T10:30:00Z","state":"SUCCEEDED","succeeded":2,"total":3}},"timed_out":{"summary":"Operation timed out","value":{"endedAt":"2026-03-25T10:40:00Z","error":null,"failed":1,"logMessages":[{"message":"Notes update initiated","timestamp":"2026-03-25T10:30:00Z"},{"message":"Processing started","timestamp":"2026-03-25T10:30:00Z"},{"message":"Operation timed out before all devices were processed","timestamp":"2026-03-25T10:40:00Z"}],"progressPercent":66,"results":{"failed":[{"errorCode":"HPE_GL_NETWORK_MONITORING_DEVICE_NOT_FOUND","errorMessage":"Device not found","id":"AP00000004","notes":null,"serialNumber":"AP00000004","type":"network-monitoring/device-monitoring"}],"succeeded":[{"id":"AP00000001","notes":"Device is in Building A","serialNumber":"AP00000001","type":"network-monitoring/device-monitoring"}]},"sourceResourceUri":"/network-monitoring/v1/device-notes","startedAt":"2026-03-25T10:30:00Z","state":"TIMEDOUT","succeeded":1,"total":3}}},"schema":{"$ref":"#/components/schemas/AsyncNotesResult__0288a339fc72"}}},"description":"OK. Returns the current status and results of the asynchronous notes operation.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"},"503":{"$ref":"#/components/responses/ServiceUnavailabledevice__0288a339fc72"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get notes async operation status and results","tags":["Devices"],"x-source-document":{"file":"MRT/getdevicenotesoperationv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Device monitoring APIs to get device details and its metrics","name":"Devices"}]},"pathMetadata":{},"sha256":"0f224fc9e44de439a5f06df72875d76c8211e2e3929083a58dbada8b7cc88aa7"}}},"/network-monitoring/v1/devices":{"get":{"description":"This API endpoint retrieves a list of network devices that are on-boarded and currently being monitored, such as access points, switches, and gateways, based on the query parameters provided. Each device in the returned list includes details like serial number, MAC address, device name, device type, IP address, status, etc. The query parameters allow you to narrow down the results to devices that meet specific criteria, ensuring you receive only the relevant data.\n\nNotes: The notes field in the response will have a value only when the request is filtered by the site ID or serialNumber.","operationId":"getDevicesV1","parameters":[{"$ref":"#/components/parameters/FilterDevices__6b9c5f08b869"},{"$ref":"#/components/parameters/SortDevices__6b9c5f08b869"},{"$ref":"#/components/parameters/Limit__6b9c5f08b869"},{"$ref":"#/components/parameters/Next__6b9c5f08b869"}],"responses":{"200":{"$ref":"#/components/responses/DeviceListResponseV1__6b9c5f08b869"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get a list of devices","tags":["Devices"],"x-source-document":{"file":"MRT/getdevicesv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Device monitoring APIs to get device details and its metrics","name":"Devices"}]},"pathMetadata":{},"sha256":"36d5b78e0b70cf96ce59ce98eadab4697276778fa19b8711403b66e980088938"}}},"/network-monitoring/v1/devices/{serial-number}":{"delete":{"description":"This API endpoint deletes a network device based on the provided serial number.","operationId":"deleteUnifiedDeviceV1","parameters":[{"$ref":"#/components/parameters/SerialNumber__2d2b84f6c2b4"}],"responses":{"204":{"$ref":"#/components/responses/DeletedDeviceResponseV1__7d94a4e82655"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Delete a device by serial number","tags":["Devices"],"x-source-document":{"file":"MRT/deleteunifieddevicev1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Device monitoring APIs to get device details and its metrics","name":"Devices"}]},"pathMetadata":{},"sha256":"b140ac44459cb6180754f919e6f507236975a329959c24e659e9dde40b02bb8b"}},"patch":{"description":"This API endpoint updates the notes for a network device based on the provided serial number. To delete the notes, set the notes to an empty string.\n\n**Note:**\n- For stack switch devices, either the member or conductor serial number can be used.\n- This operation overwrites any previously set notes for the device.","operationId":"updateDeviceNotesV1","parameters":[{"$ref":"#/components/parameters/SerialNumber__2d2b84f6c2b4"}],"requestBody":{"content":{"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/UpdateDeviceNotesRequestV1__2d2b84f6c2b4"}}},"description":"Request body containing the notes to update for the device.","required":true},"responses":{"200":{"$ref":"#/components/responses/UpdateDeviceNotesResponseV1__2d2b84f6c2b4"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Update device notes by serial number","tags":["Devices"],"x-source-document":{"file":"MRT/updatedevicenotesv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Device monitoring APIs to get device details and its metrics","name":"Devices"}]},"pathMetadata":{},"sha256":"333f65ee2c0ff1ff39afc6c01d07a23553681af62f4a5ebb5befba272807b67b"}}},"/network-monitoring/v1/firewall-clients":{"get":{"description":"This API endpoint retrieves the list of clients from access points, CX switches, and/or gateways in a site based on the filter given.\n","operationId":"listFirewallClientsV1","parameters":[{"description":"The ID of the site from which to retrieve the firewall session logs.\n","in":"query","name":"site-id","required":true,"schema":{"example":"2778382","format":"const","maxLength":20,"type":"string"}},{"description":"The start time for the query in RFC 3339 format, must be less than end-at.\n","in":"query","name":"start-at","required":true,"schema":{"example":"2024-11-20T14:14:33Z","format":"date-time","maxLength":27,"type":"string"}},{"description":"The end time for the query in RFC 3339 format, must be greater than start-at.\n","in":"query","name":"end-at","required":true,"schema":{"example":"2024-11-20T14:14:33Z","format":"date-time","maxLength":27,"type":"string"}},{"description":"OData Version 4.0 filter string (limited functionality). Supports only 'and' conjunction ('or' and 'not' are NOT supported). Supported fields and operators are in the below given table.\n\n| Field | Operators | Required | Type | Default Value | Summary |\n| --------- | -------- | -------- | -------- | -------- | -------- |\n| `applicationCategory` | `eq` | `Yes` | `String` | `N\\A` | `Format is string. Only applicationCategory or webCategory must be set but not both. Also cannot have both applicationCategory and webCategory empty.` |\n| `webCategory` | `eq` | `Yes` | `String` | `N\\A` | `Format is string. Only applicationCategory or webCategory must be set but not both. Also cannot have both applicationCategory and webCategory empty.` |\n| `deviceType` | `eq` and `in`  | `No` | `String` | `('DEVICE_TYPE_AP','DEVICE_TYPE_GATEWAY','DEVICE_TYPE_SWITCH')` | `Format is a tuple that contains string. Example: ('DEVICE_TYPE_AP','DEVICE_TYPE_GATEWAY','DEVICE_TYPE_SWITCH')` |\n\n**The operators are implemented as follows:**\n\n* `eq`: Only values exactly matching the given value are returned.\n\n* `in`: Only values present in the given list are returned.\n\n","example":"'applicationCategory' eq 'Web' and 'deviceType' in ('DEVICE_TYPE_AP','DEVICE_TYPE_GATEWAY','DEVICE_TYPE_SWITCH') and 'deduplication' eq 'true'","in":"query","name":"filter","required":true,"schema":{"format":"const","type":"string"}},{"description":"The maximum number of items to return.\n","in":"query","name":"limit","required":false,"schema":{"$ref":"#/components/schemas/Limit__4689c9697989","format":"int32","type":"integer"}},{"description":"Cursor for the next page of results. Use the value returned in the `next` response field to retrieve the next page. Providing both `next` and `offset` in the same request returns `400 Bad Request`.\n","in":"query","name":"next","required":false,"schema":{"example":"NyBErRdk6czGUyDAX5Cp","type":"string"}},{"description":"The offset of the item at which to begin the response. Providing both `offset` and `next` in the same request returns `400 Bad Request`.\n","in":"query","name":"offset","required":false,"schema":{"example":0,"format":"int32","minimum":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientResponse__4689c9697989"}}},"description":"Successful operation","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/XRateLimitLimitHeader__0288a339fc72"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/XRateLimitRemainingHeader__0288a339fc72"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"},"503":{"$ref":"#/components/responses/ServiceUnavailableapp__7c5b5fe9ca66"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get clients list\n","tags":["Firewall Session"],"x-source-document":{"file":"MRT/listfirewallclientsv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Firewall Session Monitoring APIs to retrieve firewall session logs from a site.","name":"Firewall Session"}]},"pathMetadata":{},"sha256":"321342416a60df5b40def039f986dda253cfbc5a094f2317bc1dd2722ef1f3ca"}}},"/network-monitoring/v1/gateways":{"get":{"description":"Retrieves a list of gateways with details like serialNumber, deviceName, macAddress, siteId, status and more. The query parameters allow you to narrow down the results to gateways that meet specific criteria, ensuring you receive only the relevant data.\n","operationId":"getGatewaysV1","parameters":[{"description":"OData Version 4.0 filter string (limited functionality). Supports only 'and' conjunction ('or' and 'not' are NOT supported). Supported fields and operators are in the below given table.\n\n| Field | Operators |\n| --------- | -------- |\n| `siteId` | `eq` and `in` |\n| `model` | `eq` and `in` |\n| `status` | `eq` and `in` |\n| `deployment` | `eq` and `in` |\n| `macAddress` | `eq` and `in` |\n| `siteName` | `eq` and `in` |\n| `deviceName` | `eq` and `in` |\n| `firmwareVersion` | `eq` and `in` |\n| `serialNumber` | `eq` and `in` |\n| `clusterName` | `eq` and `in` |\n\n**The operators are implemented as follows:**\n\n* `eq`: Only values exactly matching the given value are returned.\n\n* `in`: Only values present in the given list are returned.\n\n","example":"siteId eq '12345' and deployment in ('Standalone')","in":"query","name":"filter","required":false,"schema":{"maxLength":256,"type":"string"}},{"description":"A comma-separated list of sort expressions. Each sort expression is a property name optionally followed by a direction indicator asc (ascending) or desc (descending).\n\nThe first sort expression in the list defines the primary sort order, the second defines the secondary sort order, and so on. If a direction indicator is omitted the default direction is ascending.\n\nSupported fields are `siteId`, `model`, `status`, `deployment`, `serialNumber`, `deviceName`, `macAddress`, `siteName` and `firmwareVersion`.\n","example":"deviceName,deployment desc","in":"query","name":"sort","required":false,"schema":{"maxLength":256,"type":"string"}},{"description":"Denotes the maximum number of gateways returned in the response.\n","in":"query","name":"limit","required":false,"schema":{"default":20,"example":20,"format":"int64","maximum":1000,"minimum":0,"type":"integer"}},{"description":"Specifies the pagination cursor for the next page of resources.\n\nMinimum value: 1\n","in":"query","name":"next","required":false,"schema":{"$ref":"#/components/schemas/Next__21874c7bfa12"}}],"responses":{"200":{"$ref":"#/components/responses/GatewayListResponse__51d6c5968454"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"List Gateways","tags":["Gateways"],"x-source-document":{"file":"MRT/getgatewaysv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Gateway Monitoring APIs to get gateway details and their metrics","name":"Gateways"}]},"pathMetadata":{},"sha256":"75ea58efe1704cdf496a5515c3b2ae37acaad774bbbb1c317f9b9d5ae6595c19"}}},"/network-monitoring/v1/gateways/{serial-number}":{"get":{"description":"Retrieves detailed information about a specific gateway including macAddress, deviceName, status and more.\n","operationId":"getGatewayDetailV1","parameters":[{"$ref":"#/components/parameters/SerialNumbergw__1053ccf03958"}],"responses":{"200":{"$ref":"#/components/responses/GatewayResponse__3b77411f6985"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Gateway Details","tags":["Gateways"],"x-source-document":{"file":"MRT/getgatewaydetailv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Gateway Monitoring APIs to get gateway details and their metrics","name":"Gateways"}]},"pathMetadata":{},"sha256":"268a3f03377ff13b4fd9fdf7001432783bdc98c89bb65cf3e047717357821e55"}}},"/network-monitoring/v1/gateways/{serial-number}/cpu-utilization-trends":{"get":{"description":"Retrieves CPU utilization trend data for the gateway based on specified timestamp range.\n","operationId":"getGatewayHardwareCPUUtilizationV1","parameters":[{"$ref":"#/components/parameters/SerialNumbergw__1053ccf03958"},{"$ref":"#/components/parameters/TrendsFiltergw__1053ccf03958"},{"$ref":"#/components/parameters/SiteIdgw__1053ccf03958"}],"responses":{"200":{"$ref":"#/components/responses/GatewayCPUTrendResponse__51aa0b146279"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get gateway CPU utilization trend","tags":["Gateways"],"x-source-document":{"file":"MRT/getgatewayhardwarecpuutilizationv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Gateway Monitoring APIs to get gateway details and their metrics","name":"Gateways"}]},"pathMetadata":{},"sha256":"b1801d5dbe711f7e506763f95928c69b8219d5893d10b18cf150df699b6f9410"}}},"/network-monitoring/v1/gateways/{serial-number}/dhcp-clients":{"get":{"description":"Retrieves DHCP leases that are configured in the gateway.\n","operationId":"getGatewayDhcpLeaseListV1","parameters":[{"$ref":"#/components/parameters/SerialNumbergw__1053ccf03958"},{"description":"OData Version 4.0 filter string (limited functionality). Supports only 'and' conjunction ('or' and 'not' are NOT supported). Supported fields and operators are in the below given table.\n\n| Field | Operators |\n| --------- | -------- |\n| `reservation` | `eq` and `in` |\n| `poolName` | `eq` and `in` |\n\n**The operators are implemented as follows:**\n\n* `eq`: Only values exactly matching the given value are returned.\n\n* `in`: Only values present in the given list are returned.\n\n","example":"reservation eq 'Yes'","in":"query","name":"filter","required":false,"schema":{"maxLength":256,"type":"string"}},{"description":"A comma-separated list of sort expressions. Each sort expression is a property name optionally followed by a direction indicator asc (ascending) or desc (descending).\n\nThe first sort expression in the list defines the primary sort order, the second defines the secondary sort order, and so on. If a direction indicator is omitted the default direction is ascending.\n\nSupported fields are `ipAddress`, `macAddress`, `hostName`, `clientDeviceType`, `startTime`, `expirationTime` and `reservation`.\n","in":"query","name":"sort","required":false,"schema":{"example":"startTime desc","maxLength":256,"type":"string"}},{"description":"Denotes the maximum number of DHCP clients returned in the response.\n","in":"query","name":"limit","required":false,"schema":{"default":20,"example":20,"format":"int64","maximum":100,"minimum":0,"type":"integer"}},{"description":"Specifies the pagination cursor for the next page of resources.\n\nMinimum value: 1\n","in":"query","name":"next","required":false,"schema":{"$ref":"#/components/schemas/Next__21874c7bfa12"}}],"responses":{"200":{"$ref":"#/components/responses/GatewayDhcpLeaseListResponse__21874c7bfa12"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get DHCP leases present in the DHCP pool","tags":["Gateways"],"x-source-document":{"file":"MRT/getgatewaydhcpleaselistv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Gateway Monitoring APIs to get gateway details and their metrics","name":"Gateways"}]},"pathMetadata":{},"sha256":"ce2dcb77b22a7e60fe2b92b5b09204386af48f86ba6360ef15feec8c91466c66"}}},"/network-monitoring/v1/gateways/{serial-number}/dhcp-pools":{"get":{"description":"Retrieves DHCP pools that are configured in the gateway.\n","operationId":"getGatewayDhcpPoolListV1","parameters":[{"$ref":"#/components/parameters/SerialNumbergw__1053ccf03958"},{"description":"A comma-separated list of sort expressions. Each sort expression is a property name optionally followed by a direction indicator asc (ascending) or desc (descending).\n\nThe first sort expression in the list defines the primary sort order, the second defines the secondary sort order, and so on. If a direction indicator is omitted the default direction is ascending.\n\nSupported fields are `poolName`, `vlanId`, `subnet`, `leaseDuration`, `poolSize`, `utilization` and `availableAddresses`.\n","in":"query","name":"sort","required":false,"schema":{"example":"mode desc","maxLength":256,"type":"string"}},{"description":"Denotes the maximum number of DHCP pools returned in the response.\n","in":"query","name":"limit","required":false,"schema":{"default":20,"example":20,"format":"int64","maximum":100,"minimum":0,"type":"integer"}},{"description":"Specifies the pagination cursor for the next page of resources.\n\nMinimum value: 1\n","in":"query","name":"next","required":false,"schema":{"$ref":"#/components/schemas/Next__21874c7bfa12"}}],"responses":{"200":{"$ref":"#/components/responses/GatewayDhcpPoolListResponse__f07d3dc27fa5"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get DHCP pools configured on the gateway","tags":["Gateways"],"x-source-document":{"file":"MRT/getgatewaydhcppoollistv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Gateway Monitoring APIs to get gateway details and their metrics","name":"Gateways"}]},"pathMetadata":{},"sha256":"41752f74cc8df79a3451df69b5827a57d591b4b8f890fc1d70a3a74c4c9fe71c"}}},"/network-monitoring/v1/gateways/{serial-number}/hardware-temperature-trends":{"get":{"description":"Retrieves hardware temperature trend data for the gateway based on specified timestamp range.\n","operationId":"getGatewayHardwareTemperatureV1","parameters":[{"$ref":"#/components/parameters/SerialNumbergw__1053ccf03958"},{"$ref":"#/components/parameters/TrendsFiltergw__1053ccf03958"},{"$ref":"#/components/parameters/SiteIdgw__1053ccf03958"}],"responses":{"200":{"$ref":"#/components/responses/GatewayTempTrendResponse__4ea249a3349f"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get gateway hardware temperature trends","tags":["Gateways"],"x-source-document":{"file":"MRT/getgatewayhardwaretemperaturev1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Gateway Monitoring APIs to get gateway details and their metrics","name":"Gateways"}]},"pathMetadata":{},"sha256":"e0d196783a5ff730e7a76f159e583b8c79bc5b798db2fc33e9ca5b361039c2a7"}}},"/network-monitoring/v1/gateways/{serial-number}/lan-tunnels-health-summary":{"get":{"description":"Retrieves health summary of LAN tunnels present in the gateway.\n","operationId":"getGatewayLanTunnelHealthV1","parameters":[{"$ref":"#/components/parameters/SerialNumbergw__1053ccf03958"}],"responses":{"200":{"$ref":"#/components/responses/GatewayTunnelHealthSummaryResponse__7df654afe471"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get summary of gateway LAN tunnels health","tags":["Gateways"],"x-source-document":{"file":"MRT/getgatewaylantunnelhealthv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Gateway Monitoring APIs to get gateway details and their metrics","name":"Gateways"}]},"pathMetadata":{},"sha256":"564e6a3f2b73cf30ce41b9c98c76cfa36fa5e85844c25f7b880fd139ecd26d2b"}}},"/network-monitoring/v1/gateways/{serial-number}/memory-utilization-trends":{"get":{"description":"Retrieves memory utilization trend data for the gateway based on specified timestamp range.\n","operationId":"getGatewayHardwareMemoryUtilizationV1","parameters":[{"$ref":"#/components/parameters/SerialNumbergw__1053ccf03958"},{"$ref":"#/components/parameters/TrendsFiltergw__1053ccf03958"},{"$ref":"#/components/parameters/SiteIdgw__1053ccf03958"}],"responses":{"200":{"$ref":"#/components/responses/GatewayMemTrendResponse__77dda74866ce"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get gateway memory utilization trend","tags":["Gateways"],"x-source-document":{"file":"MRT/getgatewayhardwarememoryutilizationv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Gateway Monitoring APIs to get gateway details and their metrics","name":"Gateways"}]},"pathMetadata":{},"sha256":"6252a5e85cddc8eeeab10dcfe2cdb8fb2a17eb69a2ea3780525952fd327c8386"}}},"/network-monitoring/v1/gateways/{serial-number}/modem-stat":{"get":{"description":"Retrieves modem statistics data for the specified gateway.\n","operationId":"getGatewayModemStatsV1","parameters":[{"$ref":"#/components/parameters/SerialNumbergw__1053ccf03958"},{"$ref":"#/components/parameters/SiteIdgw__1053ccf03958"}],"responses":{"200":{"$ref":"#/components/responses/GatewayModemStatsResponse__e46fc9dcc985"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get gateway uplink modem stats","tags":["Gateways"],"x-source-document":{"file":"MRT/getgatewaymodemstatsv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Gateway Monitoring APIs to get gateway details and their metrics","name":"Gateways"}]},"pathMetadata":{},"sha256":"e3ad04a7207d5b5fa32fe390b2f7dd9d613a244092e29b074f0cb4d5be678438"}}},"/network-monitoring/v1/gateways/{serial-number}/ports":{"get":{"description":"Retrieves a list of ports present in the gateway with details like speed, name, MAC address, MTU, status and more.\n","operationId":"getGatewayPortsListV1","parameters":[{"$ref":"#/components/parameters/SerialNumbergw__1053ccf03958"},{"description":"OData Version 4.0 filter string (limited functionality). Supports only 'and' conjunction ('or' and 'not' are NOT supported). Supported fields and operators are in the below given table.\n\n| Field | Operators |\n| --------- | -------- |\n| `speed` | `eq` and `in` |\n| `duplex` | `eq` and `in` |\n| `vlan` | `eq` and `in` |\n| `macAddress` | `eq` and `in` |\n| `portType` | `eq` and `in` |\n\n**The operators are implemented as follows:**\n\n* `eq`: Only values exactly matching the given value are returned.\n\n* `in`: Only values present in the given list are returned.\n\n","example":"speed eq '1000'","in":"query","name":"filter","required":false,"schema":{"maxLength":256,"type":"string"}},{"description":"A comma-separated list of sort expressions. Each sort expression is a property name optionally followed by a direction indicator asc (ascending) or desc (descending).\n\nThe first sort expression in the list defines the primary sort order, the second defines the secondary sort order, and so on. If a direction indicator is omitted the default direction is ascending.\n\nSupported fields are `mtu`, `speed`, `duplex` and `vlan`.\n","example":"speed desc","in":"query","name":"sort","required":false,"schema":{"maxLength":256,"type":"string"}},{"description":"Denotes the maximum number of ports returned in the response.\n","in":"query","name":"limit","required":false,"schema":{"default":20,"example":20,"format":"int64","maximum":1000,"minimum":0,"type":"integer"}},{"description":"Specifies the pagination cursor for the next page of resources.\n\nMinimum value: 1\n","in":"query","name":"next","required":false,"schema":{"$ref":"#/components/schemas/Next__21874c7bfa12"}}],"responses":{"200":{"$ref":"#/components/responses/GatewayPortListResponse__b0584996a91f"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"List Gateway ports","tags":["Gateways"],"x-source-document":{"file":"MRT/getgatewayportslistv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Gateway Monitoring APIs to get gateway details and their metrics","name":"Gateways"}]},"pathMetadata":{},"sha256":"5665e489a6d6020fd07a02edb5ea9511b0ffb661b57d85b702cc2aff1b8e10ca"}}},"/network-monitoring/v1/gateways/{serial-number}/ports/{port-number}":{"get":{"description":"Retrieves information about a specific port with details like speed, name, MAC address, MTU, status and more.\n","operationId":"getGatewayPortDetailV1","parameters":[{"$ref":"#/components/parameters/SerialNumbergw__1053ccf03958"},{"$ref":"#/components/parameters/PortNumber__8102176f16c5"},{"$ref":"#/components/parameters/StartAt__2ca376caec3f"},{"$ref":"#/components/parameters/EndAt__2ca376caec3f"}],"responses":{"200":{"$ref":"#/components/responses/GatewayPortResponse__988495a6329d"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Gateway port detail","tags":["Gateways"],"x-source-document":{"file":"MRT/getgatewayportdetailv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Gateway Monitoring APIs to get gateway details and their metrics","name":"Gateways"}]},"pathMetadata":{},"sha256":"00f09fb18c3cfcad84b66f59f37e2da5d05f26fe4744e556b62ea6f12d84b4a2"}}},"/network-monitoring/v1/gateways/{serial-number}/ports/{port-number}/frames-errors-trends":{"get":{"description":"Retrieves gateway port frame errors trend data for the specified port based on timestamp range.\n","operationId":"getGatewayFramesErrorsTrendV1","parameters":[{"$ref":"#/components/parameters/SerialNumbergw__1053ccf03958"},{"$ref":"#/components/parameters/TrendsFiltergw__1053ccf03958"},{"$ref":"#/components/parameters/SiteIdgw__1053ccf03958"},{"$ref":"#/components/parameters/PortNumber__8102176f16c5"}],"responses":{"200":{"$ref":"#/components/responses/GatewayFramesErrorsTrendResponse__ab9c9f33ae99"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get gateway port frames errors trend","tags":["Gateways"],"x-source-document":{"file":"MRT/getgatewayframeserrorstrendv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Gateway Monitoring APIs to get gateway details and their metrics","name":"Gateways"}]},"pathMetadata":{},"sha256":"fe3c0d8bb2a1cf35e670de50a8fe24e75b765dd0c1ab93c7c6961085c3f78057"}}},"/network-monitoring/v1/gateways/{serial-number}/ports/{port-number}/frames-packets-trends":{"get":{"description":"Retrieves gateway port frame packets trend data for the specified port based on timestamp range.\n","operationId":"getGatewayFramesPacketsTrendV1","parameters":[{"$ref":"#/components/parameters/SerialNumbergw__1053ccf03958"},{"$ref":"#/components/parameters/TrendsFiltergw__1053ccf03958"},{"$ref":"#/components/parameters/SiteIdgw__1053ccf03958"},{"$ref":"#/components/parameters/PortNumber__8102176f16c5"}],"responses":{"200":{"$ref":"#/components/responses/GatewayFramesPacketsTrendResponse__b5fe37f7cc07"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get gateway port frames packets trend","tags":["Gateways"],"x-source-document":{"file":"MRT/getgatewayframespacketstrendv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Gateway Monitoring APIs to get gateway details and their metrics","name":"Gateways"}]},"pathMetadata":{},"sha256":"0528773a17da422b1a3dd1179243d0e4cce3689f161305d6c59bdddee9c3330d"}}},"/network-monitoring/v1/gateways/{serial-number}/ports/{port-number}/frames-trends":{"get":{"description":"Retrieves gateway port frames trend data for the specified port based on timestamp range.\n","operationId":"getGatewayFramesTrendV1","parameters":[{"$ref":"#/components/parameters/SerialNumbergw__1053ccf03958"},{"$ref":"#/components/parameters/TrendsFiltergw__1053ccf03958"},{"$ref":"#/components/parameters/SiteIdgw__1053ccf03958"},{"$ref":"#/components/parameters/PortNumber__8102176f16c5"}],"responses":{"200":{"$ref":"#/components/responses/GatewayFramesTrendResponse__8102176f16c5"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get gateway port frames trend","tags":["Gateways"],"x-source-document":{"file":"MRT/getgatewayframestrendv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Gateway Monitoring APIs to get gateway details and their metrics","name":"Gateways"}]},"pathMetadata":{},"sha256":"9c622ec4fe6fc65de101dfc0df8ed11bfeb82aa4ca02be9b7f5e1d05ba22f473"}}},"/network-monitoring/v1/gateways/{serial-number}/ports/{port-number}/throughput-trends":{"get":{"description":"Retrieves throughput trend data for a gateway port based on specified timestamp range.\n","operationId":"getGatewayPortThroughputTrendV1","parameters":[{"$ref":"#/components/parameters/SerialNumbergw__1053ccf03958"},{"$ref":"#/components/parameters/TrendsFiltergw__1053ccf03958"},{"$ref":"#/components/parameters/SiteIdgw__1053ccf03958"},{"$ref":"#/components/parameters/PortNumber__8102176f16c5"}],"responses":{"200":{"$ref":"#/components/responses/GatewayInterfaceThroughputTrendResponse__b3fc83ccae26"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get gateway port throughput trend","tags":["Gateways"],"x-source-document":{"file":"MRT/getgatewayportthroughputtrendv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Gateway Monitoring APIs to get gateway details and their metrics","name":"Gateways"}]},"pathMetadata":{},"sha256":"e3d91c11d52f2c580149c88d928291ac227d5e4f5fa55325fbde7e0109e5b756"}}},"/network-monitoring/v1/gateways/{serial-number}/tunnels":{"get":{"description":"Retrieves a list of tunnels present in a gateway with details like tunnelName, status, usage, encapsulation, etc.\n","operationId":"getGatewayTunnelListV1","parameters":[{"$ref":"#/components/parameters/SerialNumbergw__1053ccf03958"},{"description":"OData Version 4.0 filter string (limited functionality). Supports only 'and' conjunction ('or' and 'not' are NOT supported). Supported fields and operators are in the below given table.\n\n| Field | Operators |\n| --------- | -------- |\n| `tunnelName` | `eq` and `in` |\n| `status` | `eq` and `in` |\n| `mode` | `eq` and `in` |\n| `encapsulation` | `eq` and `in` |\n| `tunnelType` | `eq` and `in` |\n\n**The operators are implemented as follows:**\n\n* `eq`: Only values exactly matching the given value are returned.\n\n* `in`: Only values present in the given list are returned.\n\n","example":"encapsulation eq 'GRE'","in":"query","name":"filter","required":false,"schema":{"maxLength":256,"type":"string"}},{"description":"A comma-separated list of sort expressions. Each sort expression is a property name optionally followed by a direction indicator asc (ascending) or desc (descending).\n\nThe first sort expression in the list defines the primary sort order, the second defines the secondary sort order, and so on. If a direction indicator is omitted the default direction is ascending.\n\nSupported fields are `tunnelName`, `destinationIpAddress`, `sourceIpAddress`, `mode`, `vni` and `encapsulation`.\n","example":"tunnelName desc","in":"query","name":"sort","required":false,"schema":{"maxLength":256,"type":"string"}},{"description":"Denotes the maximum number of tunnels returned in the response.\n","in":"query","name":"limit","required":false,"schema":{"default":20,"example":20,"format":"int64","maximum":1000,"minimum":0,"type":"integer"}},{"description":"Specifies the pagination cursor for the next page of resources.\n\nMinimum value: 1\n","in":"query","name":"next","required":false,"schema":{"$ref":"#/components/schemas/Next__21874c7bfa12"}}],"responses":{"200":{"$ref":"#/components/responses/GatewayTunnelListResponse__d4fec30749ee"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"List Gateway tunnels","tags":["Gateways"],"x-source-document":{"file":"MRT/getgatewaytunnellistv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Gateway Monitoring APIs to get gateway details and their metrics","name":"Gateways"}]},"pathMetadata":{},"sha256":"482774ad9ac0ccb7f89be540a734205c4dd91d663c0cbae36331148b8404a6f0"}}},"/network-monitoring/v1/gateways/{serial-number}/tunnels/{tunnel-name}":{"get":{"description":"Retrieves information about a specific tunnel configured in the gateway.\n","operationId":"getGatewayTunnelDetailV1","parameters":[{"$ref":"#/components/parameters/SerialNumbergw__1053ccf03958"},{"$ref":"#/components/parameters/TunnelName__2ca376caec3f"},{"$ref":"#/components/parameters/StartAt__2ca376caec3f"},{"$ref":"#/components/parameters/EndAt__2ca376caec3f"}],"responses":{"200":{"$ref":"#/components/responses/GatewayTunnelDetailResponse__2ca376caec3f"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Gateway tunnel detail","tags":["Gateways"],"x-source-document":{"file":"MRT/getgatewaytunneldetailv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Gateway Monitoring APIs to get gateway details and their metrics","name":"Gateways"}]},"pathMetadata":{},"sha256":"53198fd43d17e9ddc28c8b7f8a6c1ef385ebb5fbc73685fc08f1cf7c47dc2582"}}},"/network-monitoring/v1/gateways/{serial-number}/tunnels/{tunnel-name}/dropped-packet-trends":{"get":{"description":"Retrieves gateway tunnel dropped packet trends for the specified tunnel based on timestamp range.\n","operationId":"getGatewayTunnelDroppedPacketsTrendV1","parameters":[{"$ref":"#/components/parameters/SerialNumbergw__1053ccf03958"},{"$ref":"#/components/parameters/TrendsFiltergw__1053ccf03958"},{"$ref":"#/components/parameters/SiteIdgw__1053ccf03958"},{"$ref":"#/components/parameters/TunnelName__2ca376caec3f"}],"responses":{"200":{"$ref":"#/components/responses/GatewayTunnelPacketsTrendResponse__7b41d1172fa8"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get gateway tunnel dropped packets trend","tags":["Gateways"],"x-source-document":{"file":"MRT/getgatewaytunneldroppedpacketstrendv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Gateway Monitoring APIs to get gateway details and their metrics","name":"Gateways"}]},"pathMetadata":{},"sha256":"965ec4d57c02abe2a6ca60b0c6de2c19853baf77e3ffee0f631f31142cd1a2f1"}}},"/network-monitoring/v1/gateways/{serial-number}/tunnels/{tunnel-name}/status-trends":{"get":{"description":"Retrieves status trend data for a gateway tunnel based on specified timestamp range.\n","operationId":"getGatewayTunnelStatusTrendV1","parameters":[{"$ref":"#/components/parameters/SerialNumbergw__1053ccf03958"},{"$ref":"#/components/parameters/TrendsFiltergw__1053ccf03958"},{"$ref":"#/components/parameters/SiteIdgw__1053ccf03958"},{"$ref":"#/components/parameters/TunnelName__2ca376caec3f"}],"responses":{"200":{"$ref":"#/components/responses/GatewayTunnelStatusTrendResponse__4b0780db8ebd"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get gateway tunnel status trend","tags":["Gateways"],"x-source-document":{"file":"MRT/getgatewaytunnelstatustrendv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Gateway Monitoring APIs to get gateway details and their metrics","name":"Gateways"}]},"pathMetadata":{},"sha256":"d2939beb34e27971c17f0b509083c579c2e4a9c9c834b9b19717a4df39993081"}}},"/network-monitoring/v1/gateways/{serial-number}/tunnels/{tunnel-name}/throughput-trends":{"get":{"description":"Retrieves throughput trend data for a gateway tunnel based on specified timestamp range.\n","operationId":"getGatewayTunnelThroughputTrendV1","parameters":[{"$ref":"#/components/parameters/SerialNumbergw__1053ccf03958"},{"$ref":"#/components/parameters/TrendsFiltergw__1053ccf03958"},{"$ref":"#/components/parameters/SiteIdgw__1053ccf03958"},{"$ref":"#/components/parameters/TunnelName__2ca376caec3f"}],"responses":{"200":{"$ref":"#/components/responses/GatewayTunnelThroughputTrendResponse__e0ccaf5b72e7"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get gateway tunnel throughput trend","tags":["Gateways"],"x-source-document":{"file":"MRT/getgatewaytunnelthroughputtrendv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Gateway Monitoring APIs to get gateway details and their metrics","name":"Gateways"}]},"pathMetadata":{},"sha256":"3d73a5c231596ce549de1530087ea8c8e119c2b2e5ac88bceedb831e60fdf581"}}},"/network-monitoring/v1/gateways/{serial-number}/uplinks":{"get":{"description":"Retrieves a list of uplinks present in a gateway with details like link tag, status, public IP address etc.\n","operationId":"getGatewayUplinkListV1","parameters":[{"$ref":"#/components/parameters/SerialNumbergw__1053ccf03958"},{"description":"Comma separated list of sort expressions. Each sort expression is a property name optionally followed by a direction indicator asc (ascending) or desc (descending).\n\nThe first sort expression in the list defines the primary sort order, the second defines the secondary sort order, and so on. If a direction indicator is omitted the default direction is ascending.\n\nSupported fields are `linkTag` and `status`.\n","example":"linkTag desc","in":"query","name":"sort","required":false,"schema":{"maxLength":256,"type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/GatewayUplinkListResponse__9683aa3d9df6"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"List Gateway uplinks","tags":["Gateways"],"x-source-document":{"file":"MRT/getgatewayuplinklistv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Gateway Monitoring APIs to get gateway details and their metrics","name":"Gateways"}]},"pathMetadata":{},"sha256":"5b38c07059515b939185a7336a035a44d8284ce2228781af3f44783a68d6c42b"}}},"/network-monitoring/v1/gateways/{serial-number}/uplinks/{link-tag}":{"get":{"description":"Retrieves details of the uplink connected to the gateway.\n","operationId":"getGatewayWanInterfaceDetailV1","parameters":[{"$ref":"#/components/parameters/SerialNumbergw__1053ccf03958"},{"$ref":"#/components/parameters/LinkTag__1053ccf03958"},{"$ref":"#/components/parameters/StartAt__2ca376caec3f"},{"$ref":"#/components/parameters/EndAt__2ca376caec3f"}],"responses":{"200":{"$ref":"#/components/responses/GatewayUplinkDetailResponse__dff1b4103f68"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get details of gateway uplink","tags":["Gateways"],"x-source-document":{"file":"MRT/getgatewaywaninterfacedetailv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Gateway Monitoring APIs to get gateway details and their metrics","name":"Gateways"}]},"pathMetadata":{},"sha256":"4cbaad56631ab09d6d806558028d88c519bef750ca17cd201b6bdb3073787626"}}},"/network-monitoring/v1/gateways/{serial-number}/uplinks/{link-tag}/probes":{"get":{"description":"Retrieves a list of gateway uplink probes based on specified timestamp range.\n","operationId":"getGatewayUplinkProbeListV1","parameters":[{"$ref":"#/components/parameters/SerialNumbergw__1053ccf03958"},{"$ref":"#/components/parameters/TrendsFiltergw__1053ccf03958"},{"$ref":"#/components/parameters/SiteIdgw__1053ccf03958"},{"$ref":"#/components/parameters/LinkTag__1053ccf03958"}],"responses":{"200":{"$ref":"#/components/responses/GatewayProbeListResponse__cded6adac170"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"List gateway uplink probes","tags":["Gateways"],"x-source-document":{"file":"MRT/getgatewayuplinkprobelistv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Gateway Monitoring APIs to get gateway details and their metrics","name":"Gateways"}]},"pathMetadata":{},"sha256":"bd75d0dd39b9d9b1800705b8685284347110cf49e24fcd566547decb497c6264"}}},"/network-monitoring/v1/gateways/{serial-number}/uplinks/{link-tag}/probes/{probe}/performance-trends":{"get":{"description":"Retrieves gateway uplink performance trends for the selected probe based on timestamp range.\n","operationId":"getGatewayUplinkPerformanceTrendsV1","parameters":[{"$ref":"#/components/parameters/SerialNumbergw__1053ccf03958"},{"$ref":"#/components/parameters/TrendsFiltergw__1053ccf03958"},{"$ref":"#/components/parameters/SiteIdgw__1053ccf03958"},{"$ref":"#/components/parameters/LinkTag__1053ccf03958"},{"description":"The host IP of the probe. For health check probe, provide the input as 'Health-Check'.\n","example":"Health-Check","in":"path","name":"probe","required":true,"schema":{"format":"const","maxLength":256,"type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/GatewayProbePerformanceResponse__3b1a72220c8c"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get uplink probe performance trends","tags":["Gateways"],"x-source-document":{"file":"MRT/getgatewayuplinkperformancetrendsv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Gateway Monitoring APIs to get gateway details and their metrics","name":"Gateways"}]},"pathMetadata":{},"sha256":"998a836a66b197581a900a23f24dd2cfa80b88227b1d5d25d7aff231f202d51f"}}},"/network-monitoring/v1/gateways/{serial-number}/uplinks/{link-tag}/throughput-trends":{"get":{"description":"Retrieves throughput trend data for a gateway uplink based on specified timestamp range.\n","operationId":"getGatewayUplinkThroughputTrendsV1","parameters":[{"$ref":"#/components/parameters/SerialNumbergw__1053ccf03958"},{"$ref":"#/components/parameters/TrendsFiltergw__1053ccf03958"},{"$ref":"#/components/parameters/SiteIdgw__1053ccf03958"},{"$ref":"#/components/parameters/LinkTag__1053ccf03958"}],"responses":{"200":{"$ref":"#/components/responses/GatewayUplinkThroughputTrendResponse__21365dd4a16e"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get gateway uplink throughput trend","tags":["Gateways"],"x-source-document":{"file":"MRT/getgatewayuplinkthroughputtrendsv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Gateway Monitoring APIs to get gateway details and their metrics","name":"Gateways"}]},"pathMetadata":{},"sha256":"a4bbd1e3dac06f8c6e35ee65c22ebaa690e4a6301a1163b9bd065402a178a462"}}},"/network-monitoring/v1/gateways/{serial-number}/uplinks/{link-tag}/wan-availability-trends":{"get":{"description":"Retrieves WAN availability trends for the specified gateway uplink based on timestamp range.\n","operationId":"getGatewayUplinkWanAvailabilityTrendsV1","parameters":[{"$ref":"#/components/parameters/SerialNumbergw__1053ccf03958"},{"$ref":"#/components/parameters/SiteIdgw__1053ccf03958"},{"$ref":"#/components/parameters/LinkTag__1053ccf03958"},{"$ref":"#/components/parameters/TrendsFiltergw__1053ccf03958"}],"responses":{"200":{"$ref":"#/components/responses/GatewayUplWanAvailResponse__ed53668aec87"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get WAN availability trends of gateway uplink","tags":["Gateways"],"x-source-document":{"file":"MRT/getgatewayuplinkwanavailabilitytrendsv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Gateway Monitoring APIs to get gateway details and their metrics","name":"Gateways"}]},"pathMetadata":{},"sha256":"1a746a5443ba4f20ab786968875d9c1c086c91541ffdf9d36e9c353d5c9cd231"}}},"/network-monitoring/v1/gateways/{serial-number}/uplinks/{link-tag}/wan-compression-trends":{"get":{"description":"Retrieves WAN compression trend data for a gateway uplink based on specified timestamp range.\n","operationId":"getGatewayWanCompressionTrendsV1","parameters":[{"$ref":"#/components/parameters/SerialNumbergw__1053ccf03958"},{"$ref":"#/components/parameters/TrendsFiltergw__1053ccf03958"},{"$ref":"#/components/parameters/SiteIdgw__1053ccf03958"},{"$ref":"#/components/parameters/LinkTag__1053ccf03958"}],"responses":{"200":{"$ref":"#/components/responses/GatewayWanCompressionTrendResponse__1053ccf03958"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get gateway WAN compression trends for an uplink","tags":["Gateways"],"x-source-document":{"file":"MRT/getgatewaywancompressiontrendsv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Gateway Monitoring APIs to get gateway details and their metrics","name":"Gateways"}]},"pathMetadata":{},"sha256":"4449dd11550a462c774c201e260d8584363ea8b50dee51ceefb9ddb9b998e976"}}},"/network-monitoring/v1/gateways/{serial-number}/uplinks/{vlan-id}/vpn-availability-trends":{"get":{"description":"Retrieves VPN availability trends for the specified gateway uplink based on timestamp range.\n","operationId":"getGatewayUplinkVpnAvailabilityTrendsV1","parameters":[{"$ref":"#/components/parameters/SerialNumbergw__1053ccf03958"},{"$ref":"#/components/parameters/SiteIdgw__1053ccf03958"},{"$ref":"#/components/parameters/VlanId__c99febaf4556"},{"$ref":"#/components/parameters/TrendsFiltergw__1053ccf03958"}],"responses":{"200":{"$ref":"#/components/responses/GatewayUplVpnAvailResponse__ceaebbdf1a3d"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get VPN availability trends of gateway uplink","tags":["Gateways"],"x-source-document":{"file":"MRT/getgatewayuplinkvpnavailabilitytrendsv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Gateway Monitoring APIs to get gateway details and their metrics","name":"Gateways"}]},"pathMetadata":{},"sha256":"de704f2e5211205975df2df99c8b9accfb64260cecbd40c0d803698580144292"}}},"/network-monitoring/v1/gateways/{serial-number}/vlans":{"get":{"description":"Retrieves a list of VLANs present in the gateway with details like name, VLAN type, status and more.\n","operationId":"getGatewayVlanListV1","parameters":[{"$ref":"#/components/parameters/SerialNumbergw__1053ccf03958"},{"description":"OData Version 4.0 filter string (limited functionality). Supports only 'and' conjunction ('or' and 'not' are NOT supported). Supported fields and operators are in the below given table.\n\n| Field | Operators |\n| --------- | -------- |\n| `status` | `eq` and `in` |\n| `vlanType` | `eq` and `in` |\n\n**The operators are implemented as follows:**\n\n* `eq`: Only values exactly matching the given value are returned.\n\n* `in`: Only values present in the given list are returned.\n\n","example":"encapsulation eq 'GRE' and status eq 'Connected'","in":"query","name":"filter","required":false,"schema":{"maxLength":256,"type":"string"}},{"description":"A comma-separated list of sort expressions. Each sort expression is a property name optionally followed by a direction indicator asc (ascending) or desc (descending).\n\nThe first sort expression in the list defines the primary sort order, the second defines the secondary sort order, and so on. If a direction indicator is omitted the default direction is ascending.\n\nSupported fields are `vlanId`, `name`, `status`, `ipv4Subnet` and `vlanType`.\n","in":"query","name":"sort","required":false,"schema":{"example":"vlanId desc","maxLength":256,"type":"string"}},{"description":"Denotes the maximum number of VLANs returned in the response.\n","in":"query","name":"limit","required":false,"schema":{"default":20,"example":20,"format":"int64","maximum":100,"minimum":0,"type":"integer"}},{"description":"Specifies the pagination cursor for the next page of resources.\n\nMinimum value: 1\n","in":"query","name":"next","required":false,"schema":{"$ref":"#/components/schemas/Next__21874c7bfa12"}}],"responses":{"200":{"$ref":"#/components/responses/GatewayVlanListResponse__d5538d9e1ebf"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"List Gateway VLANs","tags":["Gateways"],"x-source-document":{"file":"MRT/getgatewayvlanlistv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Gateway Monitoring APIs to get gateway details and their metrics","name":"Gateways"}]},"pathMetadata":{},"sha256":"767d756f17f1165753bc05c4d90bd22197b318b6547084924c1188a80f821f85"}}},"/network-monitoring/v1/gateways/{serial-number}/vlans/{vlan-id}":{"get":{"description":"Retrieves information about a specific VLAN that is configured in the gateway.\n","operationId":"getGatewayVlanDetailV1","parameters":[{"$ref":"#/components/parameters/SerialNumbergw__1053ccf03958"},{"$ref":"#/components/parameters/VlanId__c99febaf4556"}],"responses":{"200":{"$ref":"#/components/responses/GatewayVlanDetailResponse__c99febaf4556"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Gateway VLAN detail","tags":["Gateways"],"x-source-document":{"file":"MRT/getgatewayvlandetailv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Gateway Monitoring APIs to get gateway details and their metrics","name":"Gateways"}]},"pathMetadata":{},"sha256":"aa64da3939d7362391fcb9c65ea74f49de56728f98d95e5a768a1a0259e8104c"}}},"/network-monitoring/v1/gateways/{serial-number}/vpn-availability-trends":{"get":{"description":"Retrieves VPN availability trend data for the specified gateway based on timestamp range.\n","operationId":"getGatewayVpnAvailabilityTrendsV1","parameters":[{"$ref":"#/components/parameters/SerialNumbergw__1053ccf03958"},{"$ref":"#/components/parameters/TrendsFiltergw__1053ccf03958"},{"$ref":"#/components/parameters/SiteIdgw__1053ccf03958"}],"responses":{"200":{"$ref":"#/components/responses/GatewayVpnAvailabilityTrendResponse__997aa0335c83"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get gateway VPN availability trend","tags":["Gateways"],"x-source-document":{"file":"MRT/getgatewayvpnavailabilitytrendsv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Gateway Monitoring APIs to get gateway details and their metrics","name":"Gateways"}]},"pathMetadata":{},"sha256":"7d16a0eb225f193d5a4f736bbe711fcae7c2cce2fdf55a04e45ca9f0aeb218a1"}}},"/network-monitoring/v1/gateways/{serial-number}/wan-availability-trends":{"get":{"description":"Retrieves WAN availability trend data for the specified gateway based on timestamp range.\n","operationId":"getGatewayWanAvailabilityTrendsV1","parameters":[{"$ref":"#/components/parameters/SerialNumbergw__1053ccf03958"},{"$ref":"#/components/parameters/TrendsFiltergw__1053ccf03958"},{"$ref":"#/components/parameters/SiteIdgw__1053ccf03958"}],"responses":{"200":{"$ref":"#/components/responses/GatewayWanAvailabilityTrendResponse__624829d8bb9e"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get gateway WAN availability trend","tags":["Gateways"],"x-source-document":{"file":"MRT/getgatewaywanavailabilitytrendsv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Gateway Monitoring APIs to get gateway details and their metrics","name":"Gateways"}]},"pathMetadata":{},"sha256":"1b15a7694efbc987b077429dfa32b08d9ddd2f123c440367d522ddffa3e302eb"}}},"/network-monitoring/v1/gateways/{serial-number}/wan-tunnels-health-summary":{"get":{"description":"Retrieves health summary of WAN tunnels present in the gateway.\n","operationId":"getGatewayWanTunnelHealthV1","parameters":[{"$ref":"#/components/parameters/SerialNumbergw__1053ccf03958"}],"responses":{"200":{"$ref":"#/components/responses/GatewayWanTunnelHealthSummaryResponse__6ed6e4998ea3"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get summary of gateway WAN tunnel health","tags":["Gateways"],"x-source-document":{"file":"MRT/getgatewaywantunnelhealthv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Gateway Monitoring APIs to get gateway details and their metrics","name":"Gateways"}]},"pathMetadata":{},"sha256":"3dc75923098fe455dee0c9073b068e5a1228c3f38d7aa089895683430308b8bd"}}},"/network-monitoring/v1/isolated-devices/{site-id}":{"get":{"description":"This API provides isolated devices for a specific site","operationId":"getIsolatedNodes","parameters":[{"description":"ID of the site for which details of isolated devices are requested.","example":"2345678","in":"path","name":"site-id","required":true,"schema":{"$ref":"#/components/schemas/SiteIdtopology__004689200476"}}],"responses":{"200":{"$ref":"#/components/responses/IsolatedDevicesResponse__beb9b17f8005"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Returns isolated devices for the given site.","tags":["Topology"],"x-source-document":{"file":"MRT/getisolatednodes.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Topology APIs to get Topology and device relationship information","name":"Topology"}]},"pathMetadata":{},"sha256":"5bc26cb9e89532a575b1cbef4fc167da43165abde624e3836a8a039c54e76b38"}}},"/network-monitoring/v1/neighbours/{serial-number}":{"get":{"description":"This API provides details of neighbor devices for a specific device serial number","operationId":"getNeighbours","parameters":[{"description":"Device serial number for which details are requested.","example":"SG99KN003F","in":"path","name":"serial-number","required":true,"schema":{"$ref":"#/components/schemas/SerialNumber__05867e444b37"}}],"responses":{"200":{"$ref":"#/components/responses/NeighboursResponse__f6c586a7da1c"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Returns details of neighbor devices for a given serial number.","tags":["Topology"],"x-source-document":{"file":"MRT/getneighbours.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Topology APIs to get Topology and device relationship information","name":"Topology"}]},"pathMetadata":{},"sha256":"09e050038b9a0323a8b02cc79f7e776efc5ea03f2506b4eb988706b95ec38e03"}}},"/network-monitoring/v1/radios":{"get":{"description":"This API endpoint retrieves a list of radios associated to a customer, based on the query parameters provided. Each radio in the returned list includes comprehensive details like serial number, device name, MAC address, band, status and its current statistics . The query parameters allow you to narrow down the results to radios that meet specific criteria, ensuring you receive only the relevant data.\n","operationId":"getRadioListV1","parameters":[{"description":"OData Version 4.0 filter string (limited functionality). Supports only 'and' conjunction ('or' and 'not' are NOT supported). Supported fields and operators are in the below given table.\n\n| Field | Operators |\n| --------- | -------- |\n| `siteId` | `eq` and `in` |\n| `siteName` | `eq` and `in` |\n| `serialNumber` | `eq` and `in` |\n| `deviceName` | `eq` and `in` |\n| `band` | `eq` and `in` |\n| `bandwidth` | `eq` and `in` |\n| `status` | `eq` and `in` |\n\n**The operators are implemented as follows:**\n\n* `eq`: Only values exactly matching the given value are returned.\n\n* `in`: Only values present in the given list are returned.\n\n","example":"deviceName eq 'ap_1' and band in ('2.4 GHz', '6 GHz')","in":"query","name":"filter","required":false,"schema":{"format":"const","maxLength":256,"type":"string"}},{"description":"A comma-separated list of sort expressions. Each sort expression is a property name optionally followed by a direction indicator asc (ascending) or desc (descending).\n\nThe first sort expression in the list defines the primary sort order, the second defines the secondary sort order, and so on. If a direction indicator is omitted the default direction is ascending.\nBy default, the response is sorted in ascending order by deviceName and descending order by band.\n Supported fields are `deviceName`, `serialNumber`, and `band`.\n","in":"query","name":"sort","required":false,"schema":{"example":"deviceName,band desc","format":"const","maxLength":256,"type":"string"}},{"description":"Specifies the maximum number of radios returned in the response.\n","in":"query","name":"limit","required":false,"schema":{"default":20,"example":20,"format":"int64","maximum":1000,"minimum":0,"type":"integer"}},{"description":"Specifies the pagination cursor for the next page of resources.\nThe minimum value is 1\n","in":"query","name":"next","required":false,"schema":{"$ref":"#/components/schemas/Next__21874c7bfa12"}}],"responses":{"200":{"$ref":"#/components/responses/RadioListResponseV1__34350f7e707e"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get a list of Radios","tags":["Access Points"],"x-source-document":{"file":"MRT/getradiolistv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Access Point Monitoring APIs to get Access Point details and its metrics","name":"Access Points"}]},"pathMetadata":{},"sha256":"1f54151d96e769764ac074bd97a5a4bc398a103c3aeef86a68b079b942664bc7"}}},"/network-monitoring/v1/security-risks":{"get":{"description":"This API endpoint returns a breakdown of application security risks (High / Medium / Low) for the requested scope. The maximum time range is 7 days. If the range between start-at and end-at exceeds 7 days, start-at is automatically adjusted to be 7 days before end-at. This is intentional behavior; no error is returned.\n","operationId":"listSecurityRisksV1","parameters":[{"description":"The start time in RFC 3339 Format or epoch milliseconds (must be within 7 days of end-at).\n","in":"query","name":"start-at","required":true,"schema":{"example":"2024-11-20T14:14:33Z","format":"date-time","maxLength":27,"type":"string"}},{"description":"The end time in RFC 3339 Format or epoch milliseconds (must be greater than start-at).\n","in":"query","name":"end-at","required":true,"schema":{"example":"2024-11-21T14:14:33Z","format":"date-time","maxLength":27,"type":"string"}},{"description":"Filter by site identifier.\n","in":"query","name":"site-id","required":false,"schema":{"example":"2778382","format":"const","maxLength":20,"type":"string"}},{"description":"Filter by client MAC address. Forces use of the main data table (not aggregated).\n","in":"query","name":"client-id","required":false,"schema":{"example":"00:00:00:00:00:00","format":"const","maxLength":17,"type":"string"}},{"description":"Filter by device serial number. Forces use of the main data table (not aggregated).\n","in":"query","name":"serial-number","required":false,"schema":{"example":"CN12345678","format":"const","maxLength":64,"type":"string"}},{"description":"Filter by SSID name.\n","in":"query","name":"ssid","required":false,"schema":{"example":"CorpWiFi","format":"const","maxLength":256,"type":"string"}},{"description":"Filter by user role.\n","in":"query","name":"user-role","required":false,"schema":{"example":"admin","format":"const","maxLength":256,"type":"string"}},{"description":"Zero-based index of the first item to return. Default: 0.\n","in":"query","name":"offset","required":false,"schema":{"default":0,"example":0,"format":"int32","minimum":0,"type":"integer"}},{"description":"Maximum number of risk level entries to return (1-100). Default: 100.\n","in":"query","name":"limit","required":false,"schema":{"default":100,"example":100,"format":"int32","maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecurityRiskInfoResponse__daca0a87b085"}}},"description":"Successful operation.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/XRateLimitLimitHeaderapp__7c5b5fe9ca66"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/XRateLimitRemainingHeaderapp__7c5b5fe9ca66"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"},"503":{"$ref":"#/components/responses/ServiceUnavailableapp__7c5b5fe9ca66"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get security risk info for applications\n","tags":["Application Visibility"],"x-source-document":{"file":"MRT/listsecurityrisksv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Application Visibility APIs provide details about applications accessed in a site or by a client.","name":"Application Visibility"}]},"pathMetadata":{},"sha256":"e1be4a15c7bbf9ecd89d0169a5afe16952a488377daf90fb12d87c876a2a4fe6"}}},"/network-monitoring/v1/site-firewall-sessions":{"get":{"description":"This API endpoint retrieves blocked/denied sessions logs from access points, CX switches, gateways in a site.\n","operationId":"listSiteFirewallSessionLogsV1","parameters":[{"description":"The ID of the site from which to retrieve the firewall session logs.\n","in":"query","name":"site-id","required":true,"schema":{"example":"2778382","format":"const","maxLength":20,"type":"string"}},{"description":"The start time for the query in RFC 3339 format, must be less than end-at.\n","in":"query","name":"start-at","required":true,"schema":{"example":"2024-11-20T14:14:33Z","format":"date-time","maxLength":27,"type":"string"}},{"description":"The end time for the query in RFC 3339 format, must be greater than start-at.\n","in":"query","name":"end-at","required":true,"schema":{"example":"2024-11-20T14:14:33Z","format":"date-time","maxLength":27,"type":"string"}},{"description":"OData Version 4.0 filter string (limited functionality). Supports only 'and' conjunction ('or' and 'not' are NOT supported). Supported fields and operators are in the below given table.\n\n| Field | Operators | Required | Type | Default Value | Summary |\n| --------- | -------- | -------- | -------- | -------- | -------- |\n| `deviceType` | `eq` and `in` | `No` | `String` | `('DEVICE_TYPE_AP','DEVICE_TYPE_GATEWAY','DEVICE_TYPE_SWITCH')` | `Format is a tuple that contains string. Example: ('DEVICE_TYPE_AP','DEVICE_TYPE_GATEWAY')` |\n| `deduplication` | `eq` | `No` | `String` | `true` | `Format is string but should only contain values true or false. Returns unique session logs if set to true` | \n\n**The operators are implemented as follows:**\n\n* `eq`: Only values exactly matching the given value are returned.\n\n* `in`: Only values present in the given list are returned.\n\n","example":"'deviceType' in ('DEVICE_TYPE_AP','DEVICE_TYPE_GATEWAY','DEVICE_TYPE_SWITCH') and 'deduplication' eq 'true'","in":"query","name":"filter","required":false,"schema":{"format":"const","type":"string"}},{"description":"The maximum number of items to return.\n","in":"query","name":"limit","required":false,"schema":{"$ref":"#/components/schemas/Limit__4689c9697989","format":"int32","type":"integer"}},{"description":"Cursor for the next page of results. Use the value returned in the `next` response field to retrieve the next page. Providing both `next` and `offset` in the same request returns `400 Bad Request`.\n","in":"query","name":"next","required":false,"schema":{"example":"NyBErRdk6czGUyDAX5Cp","type":"string"}},{"description":"The offset of the item at which to begin the response. Providing both `offset` and `next` in the same request returns `400 Bad Request`.\n","in":"query","name":"offset","required":false,"schema":{"example":0,"format":"int32","minimum":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessionLogResponse__8523b012636f"}}},"description":"Successful operation","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/XRateLimitLimitHeader__0288a339fc72"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/XRateLimitRemainingHeader__0288a339fc72"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"},"503":{"$ref":"#/components/responses/ServiceUnavailableapp__7c5b5fe9ca66"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get blocked firewall session logs\n","tags":["Firewall Session"],"x-source-document":{"file":"MRT/listsitefirewallsessionlogsv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Firewall Session Monitoring APIs to retrieve firewall session logs from a site.","name":"Firewall Session"}]},"pathMetadata":{},"sha256":"563d7857be32bc8f5d829ca4e2f03170fa302610712a7083a01c8312b6a66878"}}},"/network-monitoring/v1/site-health/{site-id}":{"get":{"description":"This API endpoint provides the detailed health information for the requested site, including site Id, health of the site, and poor health reasons for the site. The response includes the count of devices, clients, VMs, and hosts categorized by performance as poor, fair or good.\n\n**Note:** To retrieve the `siteId` for a known site name, use the `GET /network-monitoring/v1/sites-health` endpoint with `filter=siteName eq 'my-site'`.","operationId":"getSiteHealthV1","parameters":[{"description":"Identifier of the Site for which site information is requested.\n","in":"path","name":"site-id","required":true,"schema":{"$ref":"#/components/schemas/SiteIdsite__0bffa6fb51f5"}}],"responses":{"200":{"$ref":"#/components/responses/SiteHealthResponse__0bffa6fb51f5"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Site information","tags":["Site Health"],"x-source-document":{"file":"MRT/getsitehealthv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Site Health APIs to get site details with health, devices, clients, alerts information.","name":"Site Health"}]},"pathMetadata":{},"sha256":"9305aa93d1e30ca03aab4f14e79b1b6dd37eb95d87493c1422e4416cb0d09967"}}},"/network-monitoring/v1/sitemaps-summary/{site-id}":{"get":{"description":"This API provides a list of non-associated and non-deployed APs for a site. The summary for the site and a specific floor can also be obtained by passing the floor ID of that specific floor.","operationId":"getSummaryV1","parameters":[{"description":"The ID of the site for which the device-related information is requested.","in":"path","name":"site-id","required":true,"schema":{"$ref":"#/components/schemas/siteIdlocation__08d3c9863d87"}},{"description":"An OData 4.0 filter can be provided with `floorId` (`in` operator must be used ).\n","in":"query","name":"filter","required":true,"schema":{"$ref":"#/components/schemas/Filter__097c7eac5a23"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteSummary__097c7eac5a23"}}},"description":"Returns summary of devices associated with the site.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Site devices summary","tags":["FloorPlan"],"x-source-document":{"file":"MRT/getsummaryv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"FloorPlan Manager APIs to get details about FloorMap and entities placed on FloorMap","name":"FloorPlan"}]},"pathMetadata":{},"sha256":"61ae39319a5c338616e82d63b3b766053f311dd1d5e326d3829821bd091fe864"}}},"/network-monitoring/v1/sitemaps/sites":{"get":{"description":"This API provides a list of sites that have floors configured or sites that do not have any floors configured.","operationId":"listSitemapSitesV1","parameters":[{"description":"An OData 4.0 filter can be provided with `hasFloors` (use `eq` operator, e.g. `hasFloors eq false`). Default value is `true`. When `hasFloors eq true`, returns sites that have floors. When `hasFloors eq false`, returns sites without floors.\n","in":"query","name":"filter","required":false,"schema":{"$ref":"#/components/schemas/hasFloorFilter__dfe680474bd8"}},{"in":"query","name":"limit","required":false,"schema":{"$ref":"#/components/schemas/limitlocation__dfe680474bd8"}},{"in":"query","name":"offset","required":false,"schema":{"$ref":"#/components/schemas/offsetlocation__dfe680474bd8"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SitesSummaryResponse__dfe680474bd8"}}},"description":"Returns List of Sites with or without floor information.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Retrieve sites with or without floor configuration","tags":["FloorPlan"],"x-source-document":{"file":"MRT/listsitemapsitesv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"FloorPlan Manager APIs to get details about FloorMap and entities placed on FloorMap","name":"FloorPlan"}]},"pathMetadata":{},"sha256":"70935daf0aa7cebb123ebffc5a8f18f15504b3418828f36371c3b1489e598846"}}},"/network-monitoring/v1/sitemaps/{site-id}/buildings":{"get":{"description":"This API provides building and floor information created under a given site.","operationId":"getBuildingsV1","parameters":[{"description":"Id of the site for which the building related information is requested.","in":"path","name":"site-id","required":true,"schema":{"$ref":"#/components/schemas/siteIdlocation__08d3c9863d87"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuildingWithFloorsResponse__b1ad4f23f337"}}},"description":"Returns the Building information","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Retrieve building information","tags":["FloorPlan"],"x-source-document":{"file":"MRT/getbuildingsv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"FloorPlan Manager APIs to get details about FloorMap and entities placed on FloorMap","name":"FloorPlan"}]},"pathMetadata":{},"sha256":"272a04acbffaf951f7e722d336c365a97333f4b50f20c9205f567d7fe36a6da1"}}},"/network-monitoring/v1/sitemaps/{site-id}/buildings/{building-id}":{"delete":{"description":"This API is used to remove a building and floors under this building. This action also removes floor entities such as devices, walls, region, boundary","operationId":"removeBuildingV1","parameters":[{"description":"Id of the site where device/FloorPlan is present.","in":"path","name":"site-id","required":true,"schema":{"$ref":"#/components/schemas/siteIdlocation__08d3c9863d87"}},{"description":"Id of the building for which the map related information is requested.","in":"path","name":"building-id","required":true,"schema":{"$ref":"#/components/schemas/uuId__08d3c9863d87"}}],"responses":{"204":{"description":"Building successfully deleted","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Remove Building","tags":["FloorPlan"],"x-source-document":{"file":"MRT/removebuildingv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"FloorPlan Manager APIs to get details about FloorMap and entities placed on FloorMap","name":"FloorPlan"}]},"pathMetadata":{},"sha256":"8871765801775d36a12195ebf5ec9d4e689ca82ce1b79aeedfd3159f4746663e"}},"put":{"description":"This API is used to update name of a building","operationId":"updateBuildingV1","parameters":[{"description":"Id of the site where device/FloorPlan is present.","in":"path","name":"site-id","required":true,"schema":{"$ref":"#/components/schemas/siteIdlocation__08d3c9863d87"}},{"description":"Id of the building for which the map related information is requested.","in":"path","name":"building-id","required":true,"schema":{"$ref":"#/components/schemas/uuId__08d3c9863d87"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"buildingInput":{"$ref":"#/components/schemas/BuildingInput__de49ac93aa56"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BuildingResponse__de49ac93aa56"}}},"description":"Building successfully updated.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Update Building","tags":["FloorPlan"],"x-source-document":{"file":"MRT/updatebuildingv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"FloorPlan Manager APIs to get details about FloorMap and entities placed on FloorMap","name":"FloorPlan"}]},"pathMetadata":{},"sha256":"b274ceccc96740bb452ae0eebba82628ac470622f6d372c21d1e48273bf15ebd"}}},"/network-monitoring/v1/sitemaps/{site-id}/floors":{"post":{"description":"This API is Used to create a new floor with `FloorMapInput` information. Optionally, pass `buildingId` to create a floor under a specific building. <br> Use the `scale` API to scale the floor after creation","operationId":"createFloorV1","parameters":[{"description":"Id of the site where device/FloorPlan is present.","in":"path","name":"site-id","required":true,"schema":{"$ref":"#/components/schemas/siteIdlocation__08d3c9863d87"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"buildingAddress":{"description":"Complete address of the building.\n","properties":{"address":{"description":"Address of the building in which floor will be created.\n","example":"123 Main St","maxLength":128,"type":"string"},"city":{"description":"City of the building in which floor will be created.\n","example":"New York","maxLength":32,"type":"string"},"country":{"description":"Country of the building in which floor will be created.\n","example":"USA","maxLength":32,"type":"string"},"state":{"description":"State of the building in which floor will be created.\n","example":"NY","maxLength":32,"type":"string"},"zipcode":{"description":"Zipcode of the building in which floor will be created.\n","example":"641034","maxLength":8,"type":"string"}},"type":"object"},"buildingCoordinates":{"description":"Coordinates of the building: [longitude, latitude].","example":[-73.9813448917468,40.75249839381482],"items":{"format":"double","type":"number"},"maxItems":2,"minItems":2,"type":"array"},"buildingId":{"description":"Id of the building in which floor will be created\n","example":"a97695c-a119-45f0-b6ea-a30a83931","maxLength":128,"type":"string"},"buildingName":{"description":"Name of the building in which floor will be created.\n","example":"Brooke","maxLength":32,"type":"string"},"buildingType":{"description":"Type of the building in which floor will be created.\n","enum":["WAREHOUSE","OFFICE","PUBLIC_SPACE"],"example":"OFFICE","type":"string"},"ceilingHeight":{"description":"CeilingHeight of the floor.\n","example":"12.2","format":"double","maxLength":128,"type":"number"},"file":{"description":"select png jpg pdf bmp gif file to create a floor","format":"binary","type":"string"},"name":{"description":"Name of the floor.\n","example":"Floor 1","format":"string","maxLength":32,"type":"string"},"ordinal":{"description":"FloorNumber.\n","example":"1.1","format":"double","maxLength":32,"type":"number"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FloorMapResponse__232e2ad4eff8"}}},"description":"Success response for FloorMap creation with FloorMap information.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Create New Floor","tags":["FloorPlan"],"x-source-document":{"file":"MRT/createfloorv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"FloorPlan Manager APIs to get details about FloorMap and entities placed on FloorMap","name":"FloorPlan"}]},"pathMetadata":{},"sha256":"c1ad3105950ff12bc66f3c107ed0856b99afd379c00b46f4b9f6d8e2b90408be"}}},"/network-monitoring/v1/sitemaps/{site-id}/floors/{floor-id}":{"delete":{"description":"This API is used to remove a floor from a building using `floorId`.After removing a floor, if building has no floors building also will be removed from site","operationId":"removefloorV1","parameters":[{"description":"Id of the site where device/FloorPlan is present.","in":"path","name":"site-id","required":true,"schema":{"$ref":"#/components/schemas/siteIdlocation__08d3c9863d87"}},{"description":"Id of the floor for which the map related information is requested.","in":"path","name":"floor-id","required":true,"schema":{"$ref":"#/components/schemas/uuId__08d3c9863d87"}}],"responses":{"204":{"description":"Successfully deleted","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Remove floor from a building","tags":["FloorPlan"],"x-source-document":{"file":"MRT/removefloorv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"FloorPlan Manager APIs to get details about FloorMap and entities placed on FloorMap","name":"FloorPlan"}]},"pathMetadata":{},"sha256":"91be95ef7a0a520ca79cf9f23c3beb07e915cfc1e8cf7ec374037329d42ac9b3"}},"get":{"description":"This API provides FloorMap information which includes floorImage as well","operationId":"getFloorMapV1","parameters":[{"description":"Id of the site where device/FloorPlan is present.","in":"path","name":"site-id","required":true,"schema":{"$ref":"#/components/schemas/siteIdlocation__08d3c9863d87"}},{"description":"Id of the floor for which the map related information is requested.","in":"path","name":"floor-id","required":true,"schema":{"$ref":"#/components/schemas/uuId__08d3c9863d87"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FloorMapResponse__232e2ad4eff8"}}},"description":"Returns the FloorMap information.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Retrieve FloorMap information","tags":["FloorPlan"],"x-source-document":{"file":"MRT/getfloormapv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"FloorPlan Manager APIs to get details about FloorMap and entities placed on FloorMap","name":"FloorPlan"}]},"pathMetadata":{},"sha256":"73fbde6edc0f3d851f731896dbe5ce71c645ec4007942740cd656a54266bd3c5"}},"put":{"description":"This API is used to update FloorMap information. It also supports moving a floor from one building to another","operationId":"updateFloormapV1","parameters":[{"description":"Id of the site where device/FloorPlan is present.","in":"path","name":"site-id","required":true,"schema":{"$ref":"#/components/schemas/siteIdlocation__08d3c9863d87"}},{"description":"Id of the floor for which the map related information is requested.","in":"path","name":"floor-id","required":true,"schema":{"$ref":"#/components/schemas/uuId__08d3c9863d87"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"floorMapInput":{"$ref":"#/components/schemas/FloorMapInput__a543176a6d36"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FloorMapResponse__232e2ad4eff8"}}},"description":"FloorMap information updated successfully.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Update FloorMap","tags":["FloorPlan"],"x-source-document":{"file":"MRT/updatefloormapv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"FloorPlan Manager APIs to get details about FloorMap and entities placed on FloorMap","name":"FloorPlan"}]},"pathMetadata":{},"sha256":"abc492d6e0142fe5dd70fda513c05ea684f02be3a9af2f1d1ab36802db87371e"}}},"/network-monitoring/v1/sitemaps/{site-id}/floors/{floor-id}/image":{"get":{"description":"Retrieves the background image associated with a specific floor within a site.\n\nThe image is returned as a **binary stream**. Callers must inspect the `Content-Type` response header to determine the exact image format before processing or displaying the image.\n\n### Supported Output Formats\n\n- **`image/png` (Binary)** — Always returned when `raster=true`; also returned when the original upload was a PNG file\n- **`image/jpeg` (Binary)** — Returned when `raster=false` and the original upload was a JPEG file  \n- **`image/svg+xml` (UTF-8 XML)** — Returned when `raster=false` and the original upload was an SVG file","operationId":"getFloorMapImageV1","parameters":[{"description":"Id of the site where device/FloorPlan is present.","in":"path","name":"site-id","required":true,"schema":{"$ref":"#/components/schemas/siteIdlocation__08d3c9863d87"}},{"description":"Id of the floor for which the map related information is requested.","in":"path","name":"floor-id","required":true,"schema":{"$ref":"#/components/schemas/uuId__08d3c9863d87"}},{"description":"Controls which image variant is returned.\n\n- `true` — Returns a **raster (bitmap) rendering** of the floor map **always as PNG** (`Content-Type: image/png`), regardless of the original upload format. \n- `false` — Returns the **original uploaded file** in its native format. Check the `Content-Type` header, which will be one of: `image/png`, `image/jpeg`, or `image/svg+xml`.","in":"query","name":"raster","required":true,"schema":{"example":true,"type":"boolean"}}],"responses":{"200":{"content":{"image/jpeg":{"schema":{"description":"Raw JPEG image bytes.","format":"binary","type":"string"}},"image/png":{"schema":{"description":"Raw PNG image bytes.","format":"binary","type":"string"}},"image/svg+xml":{"example":"<?xml version=\"1.0\" encoding=\"UTF-8\"?><svg xmlns=\"http://www.w3.org/2000/svg\" width=\"800\" height=\"600\" viewBox=\"0 0 800 600\"><rect x=\"0\" y=\"0\" width=\"800\" height=\"600\" fill=\"#f0f0f0\"/><path d=\"M 100 100 L 700 100 L 700 500 L 100 500 Z\" stroke=\"black\" fill=\"none\"/></svg>","schema":{"description":"UTF-8 encoded SVG XML text document representing the floor map. SVG preserves full vector fidelity and can be scaled without quality loss.","type":"string"}}},"description":"Floor map image has been fetched for a given floor.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Retrieve Floor Map Image","tags":["FloorPlan"],"x-source-document":{"file":"MRT/getfloormapimagev1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"FloorPlan Manager APIs to get details about FloorMap and entities placed on FloorMap","name":"FloorPlan"}]},"pathMetadata":{},"sha256":"6e758c7f72af66c130892c5731b59e0ffb1741033daf3f59d61388c40f927900"}},"put":{"description":"This API is used to update floor background image. After calling this API, you must also call 'scale' API to update floor measurement with respect to the new image","operationId":"replaceimageV1","parameters":[{"description":"Id of the site where device/FloorPlan is present.","in":"path","name":"site-id","required":true,"schema":{"$ref":"#/components/schemas/siteIdlocation__08d3c9863d87"}},{"description":"Id of the floor for which the map related information is requested.","in":"path","name":"floor-id","required":true,"schema":{"$ref":"#/components/schemas/uuId__08d3c9863d87"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"file":{"description":"select png jpg pdf bmp gif file to replace a floor image","format":"binary","type":"string"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FloorMapResponse__232e2ad4eff8"}}},"description":"Image has been replaced for a given FloorMap.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Update Floor Image","tags":["FloorPlan"],"x-source-document":{"file":"MRT/replaceimagev1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"FloorPlan Manager APIs to get details about FloorMap and entities placed on FloorMap","name":"FloorPlan"}]},"pathMetadata":{},"sha256":"cd9b8663d72589404be9bc183904d7478c00368bf86b3e09df7f4c39d8963f13"}}},"/network-monitoring/v1/sitemaps/{site-id}/floors/{floor-id}/scale":{"post":{"description":"This API is used to scale FloorMap. There are 2 ways. Using `AnchorGeometry` is one way, and using `from` , 'to' and `distance` is another way to scale floor. At least one of input must be present","operationId":"scaleFloorMapV1","parameters":[{"description":"Id of the site where device/FloorPlan is present.","in":"path","name":"site-id","required":true,"schema":{"$ref":"#/components/schemas/siteIdlocation__08d3c9863d87"}},{"description":"Id of the floor for which the map related information is requested.","in":"path","name":"floor-id","required":true,"schema":{"$ref":"#/components/schemas/uuId__08d3c9863d87"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"floorMapScaleInput":{"$ref":"#/components/schemas/FloorMapScaleInput__e40c06be8034"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FloorMapResponse__232e2ad4eff8"}}},"description":"FloorMap has been successfully scaled.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Scale FloorMap","tags":["FloorPlan"],"x-source-document":{"file":"MRT/scalefloormapv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"FloorPlan Manager APIs to get details about FloorMap and entities placed on FloorMap","name":"FloorPlan"}]},"pathMetadata":{},"sha256":"341f31de9ce01e58698d304b75614f08783a32620c77cc848287106c21aa6443"}}},"/network-monitoring/v1/sitemaps/{site-id}/floors/{floor-id}/walls":{"delete":{"description":"This API is used to delete walls for a floor. Returns a response indicating the success or failure of the operation.","operationId":"deleteWallsV1","parameters":[{"description":"Id of a site where walls are associated","in":"path","name":"site-id","required":true,"schema":{"$ref":"#/components/schemas/siteIdlocation__08d3c9863d87"}},{"description":"Id of a floor where walls are associated","in":"path","name":"floor-id","required":true,"schema":{"$ref":"#/components/schemas/uuId__08d3c9863d87"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"items":{"items":{"$ref":"#/components/schemas/uuId__08d3c9863d87"},"maxItems":100,"type":"array"}},"type":"object"}}},"required":true},"responses":{"204":{"description":"Successfully deleted walls","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Delete Walls.","tags":["FloorPlan"],"x-source-document":{"file":"MRT/deletewallsv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"FloorPlan Manager APIs to get details about FloorMap and entities placed on FloorMap","name":"FloorPlan"}]},"pathMetadata":{},"sha256":"99430848dea41021db5a71d5b07e14532789b42062514ed6b7d815999857e6f1"}},"get":{"description":"This API is used to return all the walls which are drawn on the floor","operationId":"getWallsV1","parameters":[{"description":"Id of a site where walls are associated","in":"path","name":"site-id","required":true,"schema":{"$ref":"#/components/schemas/siteIdlocation__08d3c9863d87"}},{"description":"Id of a floor where walls are associated","in":"path","name":"floor-id","required":true,"schema":{"$ref":"#/components/schemas/uuId__08d3c9863d87"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Walls__ecef64a817a1"}}},"description":"Returns list of walls drawn on the FloorMap.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Retrieve Walls","tags":["FloorPlan"],"x-source-document":{"file":"MRT/getwallsv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"FloorPlan Manager APIs to get details about FloorMap and entities placed on FloorMap","name":"FloorPlan"}]},"pathMetadata":{},"sha256":"2f582ca34d7b3d57723576b1b31827262ef6c505c6ffca325210372752093db8"}},"post":{"description":"This API is used to create walls on the floor","operationId":"createWallsV1","parameters":[{"description":"Id of a site where walls are associated","in":"path","name":"site-id","required":true,"schema":{"$ref":"#/components/schemas/siteIdlocation__08d3c9863d87"}},{"description":"Id of a floor where walls are associated","in":"path","name":"floor-id","required":true,"schema":{"$ref":"#/components/schemas/uuId__08d3c9863d87"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"items":{"items":{"properties":{"geometryRelative":{"items":{"items":{"description":"cartesian coordinates on FloorMap","format":"double","maximum":9223372036854776000,"minimum":0,"type":"number"},"maxItems":200,"type":"array"},"maxItems":200,"type":"array"},"id":{"description":"wall id associated with the floor in UUID format.","example":"16a-aad7-4070-8a19-fd6b8e1ff012","maxLength":128,"type":"string"},"wallTypeId":{"description":"walltype Id associated with the customer in readable format.","example":"dry-wall","format":"const","maxLength":128,"type":"string"}},"type":"object"},"maxItems":100,"type":"array"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OverlayResponse__45e55a7a2612"}}},"description":"Created wall types successfully.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Create Wall","tags":["FloorPlan"],"x-source-document":{"file":"MRT/createwallsv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"FloorPlan Manager APIs to get details about FloorMap and entities placed on FloorMap","name":"FloorPlan"}]},"pathMetadata":{},"sha256":"74e23e34afc5f523cd6172aabbda8df999ac8facd4daff9cc039ef459ffcd0da"}},"put":{"description":"This API is used to update walls for a floor. returns a response indicating the success or failure of the operation.","operationId":"updateWallsV1","parameters":[{"description":"Id of a site where walls are associated","in":"path","name":"site-id","required":true,"schema":{"$ref":"#/components/schemas/siteIdlocation__08d3c9863d87"}},{"description":"Id of a floor where walls are associated","in":"path","name":"floor-id","required":true,"schema":{"$ref":"#/components/schemas/uuId__08d3c9863d87"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"items":{"items":{"properties":{"geometryRelative":{"items":{"items":{"description":"cartesian coordinates on FloorMap","format":"double","maximum":9223372036854776000,"minimum":0,"type":"number"},"maxItems":200,"type":"array"},"maxItems":200,"type":"array"},"id":{"description":"wall id associated with the floor in UUID format.","example":"16a-aad7-4070-8a19-fd6b8e1ff012","maxLength":128,"type":"string"},"wallTypeId":{"description":"wall type id associated with the customer in readable format.","example":"dry-wall","format":"const","maxLength":128,"type":"string"}},"type":"object"},"maxItems":100,"type":"array"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OverlayResponse__45e55a7a2612"}}},"description":"Updated walls successfully.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Update Walls.","tags":["FloorPlan"],"x-source-document":{"file":"MRT/updatewallsv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"FloorPlan Manager APIs to get details about FloorMap and entities placed on FloorMap","name":"FloorPlan"}]},"pathMetadata":{},"sha256":"36e0b274caba72d62108fd0909fe80d3efcba93ea911217c122ee78b50ebb7bb"}}},"/network-monitoring/v1/sitemaps/{site-id}/floors/{floor-id}/zones":{"delete":{"description":"Delete zones for a given floor. Returns a response indicating the success or failure of the operation.","operationId":"deleteZonesV1","parameters":[{"description":"Id of a site where walls are associated","in":"path","name":"site-id","required":true,"schema":{"$ref":"#/components/schemas/siteIdlocation__08d3c9863d87"}},{"description":"Id of a floor where walls are associated","in":"path","name":"floor-id","required":true,"schema":{"$ref":"#/components/schemas/uuId__08d3c9863d87"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"items":{"items":{"$ref":"#/components/schemas/uuId__08d3c9863d87"},"maxItems":100,"type":"array"}},"type":"object"}}},"required":true},"responses":{"204":{"description":"Successfully deleted zones","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Delete zones","tags":["FloorPlan"],"x-source-document":{"file":"MRT/deletezonesv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"FloorPlan Manager APIs to get details about FloorMap and entities placed on FloorMap","name":"FloorPlan"}]},"pathMetadata":{},"sha256":"4dc43a4a49de37db4376cee52d5d45f58b26ccf3903f020cbf258e2afc831bb0"}},"get":{"description":"This API is used to retrieve list of zones for a floor.","operationId":"getZonesV1","parameters":[{"description":"Id of a site where zones are associated","in":"path","name":"site-id","required":true,"schema":{"$ref":"#/components/schemas/siteIdlocation__08d3c9863d87"}},{"description":"Id of a floor where zones are associated","in":"path","name":"floor-id","required":true,"schema":{"$ref":"#/components/schemas/uuId__08d3c9863d87"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Zones__51cfa110bfe9"}}},"description":"Returns zones based on the provided site id and floor id.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Retrieves Zones","tags":["FloorPlan"],"x-source-document":{"file":"MRT/getzonesv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"FloorPlan Manager APIs to get details about FloorMap and entities placed on FloorMap","name":"FloorPlan"}]},"pathMetadata":{},"sha256":"7362e86b9cda349a3c46362ff0c0d450669d01cbfc1d529be5385fa3a3a65902"}},"post":{"description":"Create zones on the floor, returns a response indicating the success or failure of the operation.","operationId":"createZonesV1","parameters":[{"description":"Id of a site where zones are associated.","in":"path","name":"site-id","required":true,"schema":{"$ref":"#/components/schemas/siteIdlocation__08d3c9863d87"}},{"description":"Id of a floor where zones are associated","in":"path","name":"floor-id","required":true,"schema":{"$ref":"#/components/schemas/uuId__08d3c9863d87"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"items":{"items":{"properties":{"geometryRelative":{"items":{"items":{"description":"cartesian coordinates on FloorMap","format":"double","maximum":9223372036854776000,"minimum":0,"type":"number"},"maxItems":200,"type":"array"},"maxItems":200,"type":"array"},"id":{"description":"zone ID associated with the floor in UUID format.","example":"16a-aad7-4070-8a19-fd6b8e1ff012","maxLength":128,"type":"string"},"zoneName":{"description":"zone name associated with the zone in readable format.","example":"hall","format":"const","maxLength":128,"type":"string"},"zoneType":{"enum":["INCLUSION","EXCLUSION"],"type":"string"}},"type":"object"},"maxItems":100,"type":"array"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OverlayResponse__45e55a7a2612"}}},"description":"Created zones successfully","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Create zone","tags":["FloorPlan"],"x-source-document":{"file":"MRT/createzonesv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"FloorPlan Manager APIs to get details about FloorMap and entities placed on FloorMap","name":"FloorPlan"}]},"pathMetadata":{},"sha256":"607c020ee286c3487515efba2c93a09d8bfd84e1018a55b36bd204beb141518b"}},"put":{"description":"Update zones for a given floor and list of walls points. returns a response indicating the success or failure of the operation.","operationId":"updateZonesV1","parameters":[{"description":"Id of a site where walls are associated","in":"path","name":"site-id","required":true,"schema":{"$ref":"#/components/schemas/siteIdlocation__08d3c9863d87"}},{"description":"Id of a floor where walls are associated","in":"path","name":"floor-id","required":true,"schema":{"$ref":"#/components/schemas/uuId__08d3c9863d87"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"items":{"items":{"properties":{"geometryRelative":{"items":{"items":{"description":"cartesian coordinates on FloorMap","format":"double","maximum":9223372036854776000,"minimum":0,"type":"number"},"maxItems":200,"type":"array"},"maxItems":200,"type":"array"},"id":{"description":"zone ID associated with the floor in UUID format.","example":"16a-aad7-4070-8a19-fd6b8e1ff012","maxLength":128,"type":"string"},"zoneName":{"description":"zone name associated with the zone in readable format.","example":"hall","format":"const","maxLength":128,"type":"string"},"zoneType":{"enum":["INCLUSION","EXCLUSION"],"type":"string"}},"type":"object"},"maxItems":100,"type":"array"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OverlayResponse__45e55a7a2612"}}},"description":"Updated zones successfully.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Update zones","tags":["FloorPlan"],"x-source-document":{"file":"MRT/updatezonesv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"FloorPlan Manager APIs to get details about FloorMap and entities placed on FloorMap","name":"FloorPlan"}]},"pathMetadata":{},"sha256":"4c44b200699eae5a9dbb17fcc405c0233ffd23015d188de4544cd30339287389"}}},"/network-monitoring/v1/sitemaps/{site-id}/import":{"post":{"description":"This API is used to import floors using third-party / central / airwave files (supported files are zip and .esx)","operationId":"importfloorsV1","parameters":[{"description":"Id of the site where device/FloorPlan is present.","in":"path","name":"site-id","required":true,"schema":{"$ref":"#/components/schemas/siteIdlocation__08d3c9863d87"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"file":{"description":"select zip or esx file to begin import","format":"binary","type":"string"},"importLevel":{"enum":["SITE","BUILDING","FLOOR"],"type":"string"},"siteName":{"description":"name of the site in which import will be triggered","format":"string","type":"string"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportStatus__68f64a58b106"}}},"description":"Import request has been accepted for a given site.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Import FloorPlans using zip file","tags":["FloorPlan"],"x-source-document":{"file":"MRT/importfloorsv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"FloorPlan Manager APIs to get details about FloorMap and entities placed on FloorMap","name":"FloorPlan"}]},"pathMetadata":{},"sha256":"ea38d4a3e048ebd8b0c78231235f832c39c460a3c49c46c200a7c45bc4162757"}}},"/network-monitoring/v1/sitemaps/{site-id}/import/{id}":{"get":{"description":"This API provides import status for a given site","operationId":"getImportStatusV1","parameters":[{"description":"Id of the site where device/FloorPlan is present.","in":"path","name":"site-id","required":true,"schema":{"$ref":"#/components/schemas/siteIdlocation__08d3c9863d87"}},{"description":"Id of the import for which the import related information is requested.","in":"path","name":"id","required":true,"schema":{"$ref":"#/components/schemas/uuId__08d3c9863d87"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportStatus__68f64a58b106"}}},"description":"Returns the import status information for a given site.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Retrieve Import Status","tags":["FloorPlan"],"x-source-document":{"file":"MRT/getimportstatusv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"FloorPlan Manager APIs to get details about FloorMap and entities placed on FloorMap","name":"FloorPlan"}]},"pathMetadata":{},"sha256":"cdea7dd2a86ad815eabf837b735fba5330012a65ba70a0bb0d5c2566464916bb"}}},"/network-monitoring/v1/sitemaps/{site-id}/network-devices-assigned":{"get":{"description":"Devices that have been assigned to the floor are returned. Devices that have been placed on the floor are not included in the result","operationId":"getAssociatedDevicesV1","parameters":[{"description":"The ID of the site where the device/FloorPlan is present.","in":"path","name":"site-id","required":true,"schema":{"$ref":"#/components/schemas/siteIdlocation__08d3c9863d87"}},{"description":"An OData 4.0 filter must be provided with at least `floorId`. Other supported fields are  `types` (`in` operator must be used ), `mac`, `serial`, `name`\n","in":"query","name":"filter","required":true,"schema":{"$ref":"#/components/schemas/Filter__097c7eac5a23"}},{"in":"query","name":"limit","required":false,"schema":{"$ref":"#/components/schemas/LimitParam__4ee94b04d313"}},{"in":"query","name":"next","required":false,"schema":{"$ref":"#/components/schemas/NextParam__4ee94b04d313"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssignedAps__8ac069ee99d0"}}},"description":"Returns the assigned devices for the FloorMap.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Retrieves assigned devices","tags":["FloorPlan"],"x-source-document":{"file":"MRT/getassociateddevicesv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"FloorPlan Manager APIs to get details about FloorMap and entities placed on FloorMap","name":"FloorPlan"}]},"pathMetadata":{},"sha256":"26b0c306c4cffa4a710d9b9b218f37d679ecdb04fa1d4f0048c130bf9fdfe109"}},"post":{"description":"This API is used to assign/unassign devices to the FloorPlan. Only devices that are in the unassigned state are eligible for assignment","operationId":"changeDeviceAssignmentV1","parameters":[{"description":"The ID of the site where the device/FloorPlan is present.","in":"path","name":"site-id","required":true,"schema":{"$ref":"#/components/schemas/siteIdlocation__08d3c9863d87"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"deviceAssignment":{"properties":{"assignSerials":{"items":{"description":"Device serial number.\n","example":"AP00000001","format":"const","maxLength":16,"type":"string"},"maxItems":9999,"type":"array"},"floorId":{"$ref":"#/components/schemas/uuId__08d3c9863d87"},"unassignSerials":{"items":{"description":"Device serial number.\n","example":"AP00000001","format":"const","maxLength":16,"type":"string"},"maxItems":9999,"type":"array"}},"type":"object"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceassignmentPost__3879aac47dc4"}}},"description":"Devices assigned/unassigned from the FloorMap.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Assign/Unassign devices to the FloorPlan","tags":["FloorPlan"],"x-source-document":{"file":"MRT/changedeviceassignmentv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"FloorPlan Manager APIs to get details about FloorMap and entities placed on FloorMap","name":"FloorPlan"}]},"pathMetadata":{},"sha256":"beebb3245fc2c072141826c35174634854db435031a5c195235f6d62a2aa9b31"}}},"/network-monitoring/v1/sitemaps/{site-id}/network-devices-deployed":{"get":{"description":"A list of placed devices on the FloorMap is returned. Currently, geoMetry is not supported; only x and y are returned in meters in geometryRelative.","operationId":"getPlacedDevicesV1","parameters":[{"description":"The ID of the site where the device/FloorPlan is present.","in":"path","name":"site-id","required":true,"schema":{"$ref":"#/components/schemas/siteIdlocation__08d3c9863d87"}},{"description":"An OData 4.0 filter must be provided with at least `floorId` or `buildingId`. Other supported fields are ``types` (`in` operator must be used ), `name`, `model` and `serial`.\n","in":"query","name":"filter","required":true,"schema":{"$ref":"#/components/schemas/Filter__097c7eac5a23"}},{"in":"query","name":"limit","required":false,"schema":{"$ref":"#/components/schemas/LimitParam__4ee94b04d313"}},{"in":"query","name":"next","required":false,"schema":{"$ref":"#/components/schemas/NextParam__4ee94b04d313"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlacedDeviceResponseObject__4ee94b04d313"}}},"description":"Returns a list of placed devices on the FloorMap.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Retrieves placed devices over the FloorMap","tags":["FloorPlan"],"x-source-document":{"file":"MRT/getplaceddevicesv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"FloorPlan Manager APIs to get details about FloorMap and entities placed on FloorMap","name":"FloorPlan"}]},"pathMetadata":{},"sha256":"ef4608c8f90b2bcbcd7aaa30142c39d5331a9a106654464fa547197b97358416"}},"post":{"description":"This API is utilized to position the devices on a **FloorMap** for a specific floor ID. <br>The devices are required to be assigned to the floor before being placed. GeometryRelative should be in meters in this version.","operationId":"placeDevicesOnFloorV1","parameters":[{"description":"The ID of the site where the device/FloorPlan is present.","in":"path","name":"site-id","required":true,"schema":{"$ref":"#/components/schemas/siteIdlocation__08d3c9863d87"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"devicesOnFloor":{"items":{"properties":{"devices":{"items":{"properties":{"deviceType":{"enum":["ACCESSPOINT","SWITCH","GATEWAY","ALL"],"type":"string"},"geometryRelative":{"description":"A list of x and y in the same order.\n","items":{"format":"double","maximum":2000,"minimum":0,"type":"number"},"maxItems":2,"minItems":2,"type":"array"},"isAnchor":{"example":true,"format":"const","maxLength":16,"type":"boolean"},"locationSource":{"enum":["MANUAL","AUTOLOCATE","UNKNOWN"],"type":"string"},"serial":{"description":"The device serial number.\n","example":"AP00000001","format":"const","maxLength":16,"type":"string"}},"type":"object"},"maxItems":9999,"type":"array"},"floorId":{"description":"Floor Id associated with the device in UUID format.\n","example":"16a-aad7-4070-8a19-fd6b8e1ff012","maxLength":128,"type":"string"}},"type":"object"},"maxItems":9999,"type":"array"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceplacementPost__436382863a4e"}}},"description":"Placed the devices over the FloorMap successfully.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Place devices over the FloorMap","tags":["FloorPlan"],"x-source-document":{"file":"MRT/placedevicesonfloorv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"FloorPlan Manager APIs to get details about FloorMap and entities placed on FloorMap","name":"FloorPlan"}]},"pathMetadata":{},"sha256":"0fd5bac4d6d8f2ba007f1853aee22e50f1dfc1085c5bf17baf455f707b8c7536"}}},"/network-monitoring/v1/sitemaps/{site-id}/network-devices-planned":{"delete":{"description":"This API is to remove planned devices on the FloorMap.","operationId":"removePlannedDevicesOnFloorV1","parameters":[{"description":"Id of the site where device/FloorPlan is present.","in":"path","name":"site-id","required":true,"schema":{"$ref":"#/components/schemas/siteIdlocation__08d3c9863d87"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"removeDevices":{"maxItems":9999,"properties":{"devices":{"items":{"description":"Planned device Id.\n","example":"16a-aad7-4070-8a19-fd6b8e1ff012","format":"const","maxLength":128},"maxItems":9999,"type":"array"},"floorId":{"description":"Floor Id associated with the device in UUID format.\n","example":"16a-aad7-4070-8a19-fd6b8e1ff012","format":"string","maxLength":128}},"type":"object"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoveDeviceResponse__ac6b96ba4dce"}}},"description":"Successfully deleted","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Remove planned devices on the FloorMap","tags":["FloorPlan"],"x-source-document":{"file":"MRT/removeplanneddevicesonfloorv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"FloorPlan Manager APIs to get details about FloorMap and entities placed on FloorMap","name":"FloorPlan"}]},"pathMetadata":{},"sha256":"81f19e0ba5551e4bddafb30712b48a31490aaf042b3136339e6e1635a1396123"}},"get":{"description":"Returns list of placed (planned) devices on the FloorMap. Devices which are placed on the floor has location coordinates (x,y). those x and y are returned in meters in the response","operationId":"getPlacedPlannedDevicesV1","parameters":[{"description":"The ID of the site where the device/FloorPlan is present.","in":"path","name":"site-id","required":true,"schema":{"$ref":"#/components/schemas/siteIdlocation__08d3c9863d87"}},{"description":"OData 4.0 filter must be provided with at least `floorId`.\n","in":"query","name":"filter","required":true,"schema":{"$ref":"#/components/schemas/Filter__097c7eac5a23"}},{"in":"query","name":"limit","required":false,"schema":{"$ref":"#/components/schemas/LimitParam__4ee94b04d313"}},{"in":"query","name":"next","required":false,"schema":{"$ref":"#/components/schemas/NextParam__4ee94b04d313"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlannedDeviceResponseObject__ad445ad7c86c"}}},"description":"Returns list of placed planned devices on the FloorMap.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Retrieves placed (planned) devices","tags":["FloorPlan"],"x-source-document":{"file":"MRT/getplacedplanneddevicesv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"FloorPlan Manager APIs to get details about FloorMap and entities placed on FloorMap","name":"FloorPlan"}]},"pathMetadata":{},"sha256":"f391838686754fb4b975b57e0304e3ba9557faf61878d93c6c8302cb7e199875"}},"post":{"description":"The planned devices are to be placed on the FloorMap for a specific floorId, with geometryRelative specified in meters.","operationId":"placePlannedDevicesOnFloorV1","parameters":[{"description":"The ID of the site where the device/FloorPlan is present.","in":"path","name":"site-id","required":true,"schema":{"$ref":"#/components/schemas/siteIdlocation__08d3c9863d87"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"devicesOnFloor":{"items":{"properties":{"devices":{"items":{"properties":{"deviceStatus":{"enum":["PLANNED"],"type":"string"},"deviceType":{"enum":["ACCESSPOINT"],"type":"string"},"geometryRelative":{"description":"A list of x and y in the same order.\n","items":{"format":"double","maximum":2000,"minimum":0,"type":"number"},"maxItems":2,"minItems":2,"type":"array"},"id":{"description":"Planned Device identification number.\n","example":"16a-aad7-4070-8a19-fd6b8e1ff012","format":"const","maxLength":16,"type":"string"},"locationSource":{"enum":["MANUAL","AUTOLOCATE","UNKNOWN"],"type":"string"},"properties":{"properties":{"model":{"description":"Planned Device Model.\n","example":"AP-635","format":"const","maxLength":16,"type":"string"},"name":{"description":"Planned Device name.\n","example":"FirstFloor Ap 650","format":"const","maxLength":16,"type":"string"}},"type":"object"}},"type":"object"},"maxItems":9999,"type":"array"},"floorId":{"description":"Floor Id associated with the device in UUID format.\n","example":"16a-aad7-4070-8a19-fd6b8e1ff012","maxLength":128,"type":"string"}},"type":"object"},"maxItems":9999,"type":"array"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceplacementPost__436382863a4e"}}},"description":"Placed planned devices over the FloorMap successfully.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Place planned devices","tags":["FloorPlan"],"x-source-document":{"file":"MRT/placeplanneddevicesonfloorv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"FloorPlan Manager APIs to get details about FloorMap and entities placed on FloorMap","name":"FloorPlan"}]},"pathMetadata":{},"sha256":"49f5f89aba0c0b4cc26debba87871771df8bd90900f81e84e36d9c48c1775266"}}},"/network-monitoring/v1/sitemaps/{site-id}/network-devices-undeploy":{"post":{"description":"This API removes devices from the FloorMap without disassociating them from the floor.","operationId":"removeDevicesOnFloorV1","parameters":[{"description":"The ID of the site where the device/FloorPlan is present.","in":"path","name":"site-id","required":true,"schema":{"$ref":"#/components/schemas/siteIdlocation__08d3c9863d87"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"removeDevices":{"maxItems":9999,"properties":{"devices":{"items":{"description":"Device serial number.\n","example":"AP00000001","format":"const","maxLength":16},"maxItems":9999,"type":"array"},"floorId":{"description":"Floor Id associated with the device in UUID format.\n","example":"16a-aad7-4070-8a19-fd6b8e1ff012","format":"string","maxLength":128}},"type":"object"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoveDeviceResponse__ac6b96ba4dce"}}},"description":"Removed the device location from the FloorMap. The assignment status will be maintained.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Remove devices from the FloorMap","tags":["FloorPlan"],"x-source-document":{"file":"MRT/removedevicesonfloorv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"FloorPlan Manager APIs to get details about FloorMap and entities placed on FloorMap","name":"FloorPlan"}]},"pathMetadata":{},"sha256":"ab3bf343bae13a9b97739969c848ea2db2440127721d52320f53ae79adb1fde0"}}},"/network-monitoring/v1/sites-client-health":{"get":{"description":"This API returns a list of sites with the number of poor, fair and good health clients, categorized as wired and wireless for each site.","operationId":"listSitesClientHealthV1","parameters":[{"description":"Specifies the number of sites to be returned per request. Maximum limit per request is 1000.","in":"query","name":"limit","required":false,"schema":{"$ref":"#/components/schemas/Limitsite__7f65987649fe"}},{"description":"Defines the starting point for the set of sites to be returned. Number of sites to skip before starting to collect the result set.","in":"query","name":"offset","required":false,"schema":{"$ref":"#/components/schemas/Offsetsite__7f65987649fe"}},{"description":"OData Version 4.0 filter string (limited functionality). Supports only 'and' conjunction; ('or' and 'not' are NOT supported). Supported fields and operators are in the below given table.\n\n| Field | Operators |\n| --------- | -------- |\n| `siteId` | `eq` and `in` |\n| `siteName` | `eq` and `in` |\n\n**The operators are implemented as follows:**\n\n* `eq`: Only values exactly matching the given value are returned.\n\n* `in`: Only values present in the given list are returned.\n\n","in":"query","name":"filter","required":false,"schema":{"example":"siteName in ('site1', 'site2')","format":"const","maxLength":256,"type":"string"}},{"description":"Sort field followed by a direction indicator ASC (ascending) or DESC (descending). Supported fields are siteName, clientHealth, wirelessClientHealth, wiredClientHealth\n","in":"query","name":"sort","required":false,"schema":{"default":"siteName ASC","example":"wirelessClientHealth ASC","format":"const","maxLength":256,"type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/SitesClientHealthResponse__7f65987649fe"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"List of sites with client health","tags":["Site Health"],"x-source-document":{"file":"MRT/listsitesclienthealthv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Site Health APIs to get site details with health, devices, clients, alerts information.","name":"Site Health"}]},"pathMetadata":{},"sha256":"d1b10b58370c06aae0280d94d1e843c70eef3c502e7dfc7031502ca9e1a3ae2c"}}},"/network-monitoring/v1/sites-device-health":{"get":{"description":"This API returns a list of sites with the number of poor, fair, and good performing devices for each site.","operationId":"listSitesDeviceHealthV1","parameters":[{"description":"Specifies the number of sites to be returned per request. Maximum limit per request is 1000.","in":"query","name":"limit","required":false,"schema":{"$ref":"#/components/schemas/Limitsite__7f65987649fe"}},{"description":"Defines the starting point for the set of sites to be returned. Number of sites to skip before starting to collect the result set.","in":"query","name":"offset","required":false,"schema":{"$ref":"#/components/schemas/Offsetsite__7f65987649fe"}},{"description":"OData Version 4.0 filter string (limited functionality). Supports only 'and' conjunction; ('or' and 'not' are NOT supported). Supported fields and operators are in the below given table.\n\n| Field | Operators |\n| --------- | -------- |\n| `siteId` | `eq` and `in` |\n| `siteName` | `eq` and `in` |\n\n**The operators are implemented as follows:**\n\n* `eq`: Only values exactly matching the given value are returned.\n\n* `in`: Only values present in the given list are returned.\n\n","in":"query","name":"filter","required":false,"schema":{"example":"siteName in ('site1', 'site2')","format":"const","maxLength":256,"type":"string"}},{"description":"Sort field followed by a direction indicator ASC (ascending) or DESC (descending). Supported fields are siteName, deviceHealth, apHealth, switchHealth, gatewayHealth, bridgeHealth\n","in":"query","name":"sort","required":false,"schema":{"default":"siteName ASC","example":"apHealth ASC","format":"const","maxLength":256,"type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/SitesDeviceHealthResponse__ac50e32cc892"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"List of sites with device health","tags":["Site Health"],"x-source-document":{"file":"MRT/listsitesdevicehealthv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Site Health APIs to get site details with health, devices, clients, alerts information.","name":"Site Health"}]},"pathMetadata":{},"sha256":"219fbb3c9c41575aa5eebe5aeac7ae4866dab60ec008ebe74e2da27df7161151"}}},"/network-monitoring/v1/sites-health":{"get":{"description":"This API endpoint provides a list of health information for each site, including devices, clients, critical alerts with count, along with their respective health and health reasons.\n\n**Tip:** To retrieve the `siteId` for a known site name, use the `filter` query parameter (e.g., `filter=siteName eq 'my-site'`) to look up the `siteId`.","operationId":"listSitesHealthV1","parameters":[{"description":"Specifies the number of sites to be returned per request. Maximum limit per request is 1000.","in":"query","name":"limit","required":false,"schema":{"$ref":"#/components/schemas/Limitsite__7f65987649fe"}},{"description":"Defines the starting point for the set of sites to be returned. Number of sites to skip before starting to collect the result set.","in":"query","name":"offset","required":false,"schema":{"$ref":"#/components/schemas/Offsetsite__7f65987649fe"}},{"description":"OData Version 4.0 filter string (limited functionality). Supports only 'and' conjunction; ('or' and 'not' are NOT supported). Supported fields and operators are in the below given table.\n\n| Field | Operators |\n| --------- | -------- |\n| `siteId` | `eq` and `in` |\n| `siteName` | `eq` and `in` |\n\n**The operators are implemented as follows:**\n\n* `eq`: Only values exactly matching the given value are returned.\n\n* `in`: Only values present in the given list are returned.\n\n","in":"query","name":"filter","required":false,"schema":{"example":"siteName in ('site1', 'site2')","format":"const","maxLength":256,"type":"string"}},{"description":"Sort field followed by a direction indicator ASC (ascending) or DESC (descending). Supported fields are siteName, siteHealth, deviceHealth, clientHealth\n","in":"query","name":"sort","required":false,"schema":{"default":"siteName ASC","example":"siteHealth ASC","format":"const","maxLength":256,"type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/SitesHealthResponse__edaaa4919013"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"List of sites with health overview","tags":["Site Health"],"x-source-document":{"file":"MRT/listsiteshealthv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Site Health APIs to get site details with health, devices, clients, alerts information.","name":"Site Health"}]},"pathMetadata":{},"sha256":"d87a6d1ead12755ccd9eff83b598541604ff3d21264cac8f282ef87c2092487d"}}},"/network-monitoring/v1/stack/{serial-number}/members":{"get":{"description":"This API retrieves current stack member details for the specified stack-id or conductor serial.","operationId":"listStackMembersV1","parameters":[{"$ref":"#/components/parameters/serial-number__0d6bfd060cf2"}],"responses":{"200":{"$ref":"#/components/responses/StackMemberResponse__cfefefc40ef4"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/SwitchNotFoundResponse__0d6bfd060cf2"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get a list of Stack Members","tags":["Switch"],"x-source-document":{"file":"MRT/liststackmembersv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Switch Monitoring APIs to get details about Switch and related info","name":"Switch"}]},"pathMetadata":{},"sha256":"c673689cf1c3855d94d36e5143e82f6f70bbb1cb5f3eec48022c9aebe0696a16"}}},"/network-monitoring/v1/subscription-expiring-summary":{"get":{"description":"This API endpoint returns a month-by-month breakdown of expiring licenses for the next twelve months, broken down by license tier (Foundation, Advanced, Other) and device type (AP, Switch, Gateway, Other). The response contains an items array of exactly 12 monthly entries along with a count (always 12) and offset (always 0).","operationId":"getExpiringLicensesSummaryV1","responses":{"200":{"$ref":"#/components/responses/ExpiringLicensesSummaryResponse__bf1f3740b270"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"},"503":{"$ref":"#/components/responses/ServiceUnavailabledles__bf1f3740b270"},"default":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get expiring licenses summary for the next 12 months","tags":["Subscriptions"],"x-source-document":{"file":"MRT/getexpiringlicensessummaryv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"APIs to retrieve subscription and license information.","name":"Subscriptions"}]},"pathMetadata":{},"sha256":"507538afc13dbaac03ee645e6a625c8f03ec58fccbaf018a0d7d6cb4ce149db9"}}},"/network-monitoring/v1/swarms":{"get":{"description":"This API endpoint retrieves a list of swarms (clusters) associated to a customer, based on the query parameters provided. Each swarm in the returned list includes comprehensive details like cluster ID, cluster name, site ID, conductor information, IP addresses, and software version. The query parameters allow you to narrow down the results to swarms that meet specific criteria, ensuring you receive only the relevant data.\n","operationId":"getSwarmsV1","parameters":[{"description":"OData Version 4.0 filter string (limited functionality). Supports only 'and' conjunction ('or' and 'not' are NOT supported). Supported fields and operators are in the below given table.\n\n| Field | Operators |\n| --------- | -------- |\n| `siteId` | `eq` and `in` |\n| `siteName` | `eq` and `in` |\n| `clusterId` | `eq` and `in` |\n| `clusterName` | `eq` and `in` |\n| `conductorSerialNumber` | `eq` and `in` |\n| `conductorDeviceName` | `eq` and `in` |\n| `firmwareVersion` | `eq` and `in` |\n\n**The operators are implemented as follows:**\n\n* `eq`: Only values exactly matching the given value are returned.\n\n* `in`: Only values present in the given list are returned.\n\n","example":"clusterName eq 'Cluster1' and clusterId eq '1j4ehold0qj06kpbuy1a89dy5c69xe82ob27givar6mnbq135u'","in":"query","name":"filter","required":false,"schema":{"format":"const","maxLength":256,"type":"string"}},{"description":"A comma-separated list of sort expressions. Each sort expression is a property name optionally followed by a direction indicator asc (ascending) or desc (descending).\n\nThe first sort expression in the list defines the primary sort order, the second defines the secondary sort order, and so on. If a direction indicator is omitted the default direction is ascending.\n\nSupported fields are `clusterId`, `clusterName`, `conductorDeviceName`, and `conductorSerialNumber`.\n","in":"query","name":"sort","required":false,"schema":{"example":"clusterName,conductorDeviceName desc","format":"const","maxLength":256,"type":"string"}},{"description":"Specifies the maximum number of swarms returned in the response.\n","in":"query","name":"limit","required":false,"schema":{"default":20,"example":20,"format":"int64","maximum":1000,"minimum":0,"type":"integer"}},{"description":"Specifies the pagination cursor for the next page of resources.\n\nThe minimum value: 1\n","in":"query","name":"next","required":false,"schema":{"$ref":"#/components/schemas/Next__21874c7bfa12"}}],"responses":{"200":{"$ref":"#/components/responses/SwarmListResponse__eb0984f2beb1"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get a list of Swarms","tags":["Access Points"],"x-source-document":{"file":"MRT/getswarmsv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Access Point Monitoring APIs to get Access Point details and its metrics","name":"Access Points"}]},"pathMetadata":{},"sha256":"5e26be84e0127952f80f1d3ddd392e5c869b79ce89d3c3d9e13b3cf1d2e15027"}}},"/network-monitoring/v1/swarms/{cluster-id}":{"get":{"description":"This API retrieves detailed information about a specific swarm (cluster). It provides comprehensive swarm-related details such as cluster name, conductor information, IP addresses, member count, and software version based on the swarm's cluster ID.\n","operationId":"getSwarmV1","parameters":[{"$ref":"#/components/parameters/ClusterId__a3f300af1174"},{"$ref":"#/components/parameters/SiteIdOptional__05867e444b37"}],"responses":{"200":{"$ref":"#/components/responses/SwarmResponse__a3f300af1174"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/SwarmNotFoundError__a3f300af1174"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get a Swarm details","tags":["Access Points"],"x-source-document":{"file":"MRT/getswarmv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Access Point Monitoring APIs to get Access Point details and its metrics","name":"Access Points"}]},"pathMetadata":{},"sha256":"dcc9f1f1b99c626d52c98493555b440bb9a638e7da2aa1f16eca56a6075fb139"}}},"/network-monitoring/v1/switches":{"get":{"description":"This API endpoint retrieves a list of switches associated to a customer, based on the query parameters provided. Each switch in the returned list includes comprehensive details like serial number, name, MAC address, siteId, status etc.","operationId":"getSwitchesV1","parameters":[{"description":"Denotes the maximum number of switches returned in the response.\n","in":"query","name":"limit","required":false,"schema":{"default":1000,"example":20,"format":"int64","maximum":1000,"minimum":0,"type":"integer"}},{"description":"Specifies the pagination cursor for the next page of resources.\n\nMinimum value: 1\n","in":"query","name":"next","required":false,"schema":{"description":"Specifies the pagination cursor for the next page of resources.","example":"2","format":"int32","type":"string"}},{"description":"OData Version 4.0 filter string (limited functionality). Supports only 'and' conjunction ('or' and 'not' are NOT supported). Supported fields and operators are in the below given table.\n\n| Field | Operators |\n| --------- | -------- |\n| `siteId` | `eq` and `in` |\n| `siteName` | `eq` and `in` |\n| `model` | `eq` and `in` |\n| `status` | `eq` and `in` |\n| `deployment` | `eq` and `in` |\n\n**The operators are implemented as follows:**\n\n* `eq`: Only values exactly matching the given value are returned.\n\n* `in`: Only values present in the given list are returned.\n\n","example":"siteId eq '12345' and deployment in ('Standalone', 'Stack')","in":"query","name":"filter","required":false,"schema":{"format":"const","maxLength":256,"type":"string"}},{"description":"Comma separated list of sort expressions. Each sort expression is a property name optionally followed by a direction indicator asc (ascending) or desc (descending).\n\nThe first sort expression in the list defines the primary sort order, the second defines the secondary sort order, and so on. If a direction indicator is omitted, then the default direction is ascending.\n\nSupported fields are `siteId`, `model`, `status`, `deployment`, `serialNumber`, and `deviceName`.\n","in":"query","name":"sort","required":false,"schema":{"example":"deviceName,deployment desc","format":"const","maxLength":256,"type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/SwitchListResponse__c64bceb851d6"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get a list of Switches","tags":["Switch"],"x-source-document":{"file":"MRT/getswitchesv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Switch Monitoring APIs to get details about Switch and related info","name":"Switch"}]},"pathMetadata":{},"sha256":"30e5525512d31d2236dd066afc63e5830e8f78ab34fe551d3c117b87b599c375"}}},"/network-monitoring/v1/switches/topn-interface-trends":{"get":{"description":"Get top N Switches interface trends, rx bytes, tx bytes over a given time period","operationId":"getTopnSwitchConnectivityTrendsV1","parameters":[{"$ref":"#/components/parameters/site-id__0d6bfd060cf2"},{"$ref":"#/components/parameters/trendsFilterswitch__0d6bfd060cf2"}],"responses":{"200":{"$ref":"#/components/responses/TopnInterfaceTrendsResponse__f1560a40cf92"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get Top-N Switch interface trends","tags":["Switch"],"x-source-document":{"file":"MRT/gettopnswitchconnectivitytrendsv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Switch Monitoring APIs to get details about Switch and related info","name":"Switch"}]},"pathMetadata":{},"sha256":"ea2867eeae18753387e6ba0d78df07582d2cbbe9f7e20fac354e1a4e1af8ec48"}}},"/network-monitoring/v1/switches/{serial-number}":{"get":{"description":"This API retrieves current switch information for the specified serial number or stack id. Conductor serial may also be used instead of a stack id. In the case of stacked switches, logical switch details and trend data are also provided. Member-level information can be obtained using the listStackMember API.","operationId":"getSwitchV1","parameters":[{"$ref":"#/components/parameters/serial-number__0d6bfd060cf2"}],"responses":{"200":{"$ref":"#/components/responses/SwitchResponse__134f5ffbb7f8"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/SwitchNotFoundResponse__0d6bfd060cf2"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get Switch details","tags":["Switch"],"x-source-document":{"file":"MRT/getswitchv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Switch Monitoring APIs to get details about Switch and related info","name":"Switch"}]},"pathMetadata":{},"sha256":"10d747ef7e4bec5c1b409533078b67389dbd90c69b6bc176f7296e84e7245b89"}}},"/network-monitoring/v1/switches/{serial-number}/hardware-categories":{"get":{"description":"This API retrieves detailed hardware information associated with the specified serial number or stack id. Conductor serial may also be used instead of a stack id.","operationId":"listHardwareCategoriesV1","parameters":[{"$ref":"#/components/parameters/serial-number__0d6bfd060cf2"}],"responses":{"200":{"$ref":"#/components/responses/SwitchHardwareResponse__eb47230c21a4"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/SwitchNotFoundResponse__0d6bfd060cf2"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get hardware categories for a Switch","tags":["Switch"],"x-source-document":{"file":"MRT/listhardwarecategoriesv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Switch Monitoring APIs to get details about Switch and related info","name":"Switch"}]},"pathMetadata":{},"sha256":"850853619e7dc90d25b41ff9430af0c6e8c3c0a1497b8c4c8b01b8183c673c25"}}},"/network-monitoring/v1/switches/{serial-number}/hardware-trends":{"get":{"description":"This API provides hardware trend data for a given site based on a serial number or stack id. When a stack id or conductor serial is provided, the trends are aggregated across for each member of the stack. When a member serial is provided, the trends are aggregated for that specific member. By default, data is aggregated over the last three hours from the current timestamp. Available metrics include CPU utilization, memory utilization, PoE available, PoE consumption, and total power available.","operationId":"getSwitchHardwareTrendsV1","parameters":[{"$ref":"#/components/parameters/serial-number__0d6bfd060cf2"},{"$ref":"#/components/parameters/site-id__0d6bfd060cf2"},{"$ref":"#/components/parameters/trendsFilterswitch__0d6bfd060cf2"}],"responses":{"200":{"$ref":"#/components/responses/HardwareTrendsResponse__5cf5b3c37fbc"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/SwitchNotFoundResponse__0d6bfd060cf2"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get hardware trends for a Switch","tags":["Switch"],"x-source-document":{"file":"MRT/getswitchhardwaretrendsv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Switch Monitoring APIs to get details about Switch and related info","name":"Switch"}]},"pathMetadata":{},"sha256":"e6ea79838be5a908f1af889baaa864a4855b3eb16b6b72a15589d9afdf2dee5d"}}},"/network-monitoring/v1/switches/{serial-number}/interface-poe":{"get":{"description":"This API provides interface poe detail for a serial or stack id for a specific site. Conductor serial may also be used instead of a stack id","operationId":"getSwitchInterfacePoeV1","parameters":[{"$ref":"#/components/parameters/serial-number__0d6bfd060cf2"}],"responses":{"200":{"$ref":"#/components/responses/InterfacePoeResponse__87866266e647"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/SwitchNotFoundResponse__0d6bfd060cf2"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get interface PoE for a Switch","tags":["Switch"],"x-source-document":{"file":"MRT/getswitchinterfacepoev1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Switch Monitoring APIs to get details about Switch and related info","name":"Switch"}]},"pathMetadata":{},"sha256":"c6cc5ca292e3f20d5acfed18648a2427c32d01835c9d0b93ebe7d955080d9af3"}}},"/network-monitoring/v1/switches/{serial-number}/interface-trends":{"get":{"description":"This API provides interface trend data for a given site based on a serial number or stack id. When a stack id or conductor serial is provided, the trends are aggregated across the entire stack. When a member serial is provided, the trends are aggregated for that specific member. Supported metrics include RX bytes, TX bytes, discards, giants, errors, runts, and collisions.","operationId":"getSwitchConnectivityrendsV1","parameters":[{"$ref":"#/components/parameters/serial-number__0d6bfd060cf2"},{"$ref":"#/components/parameters/site-id__0d6bfd060cf2"},{"$ref":"#/components/parameters/interface-id__0d6bfd060cf2"},{"$ref":"#/components/parameters/uplink__0d6bfd060cf2"},{"$ref":"#/components/parameters/trendsFilterswitch__0d6bfd060cf2"}],"responses":{"200":{"$ref":"#/components/responses/InterfaceTrendsResponse__0d6bfd060cf2"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/SwitchNotFoundResponse__0d6bfd060cf2"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get interface trends for a Switch","tags":["Switch"],"x-source-document":{"file":"MRT/getswitchconnectivityrendsv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Switch Monitoring APIs to get details about Switch and related info","name":"Switch"}]},"pathMetadata":{},"sha256":"b10de23c8a2fb7430df412362330ca8a1b4237260be057308a946874def3378c"}}},"/network-monitoring/v1/switches/{serial-number}/interfaces":{"get":{"description":"This API returns a list of interfaces for the specified serial number or stack id. Conductor serial may also be used instead of a stack id","operationId":"listInterfacesV1","parameters":[{"$ref":"#/components/parameters/serial-number__0d6bfd060cf2"},{"description":"Denotes the number of interfaces that needs to be fetched. Fetches all by default.","example":"100","in":"query","name":"limit","required":false,"schema":{"$ref":"#/components/schemas/LimitParamswitch__244c7d3b837e"}},{"description":"Denotes the offset from where the interfaces need to be fetched or the number of interfaces to skip.","example":"0","in":"query","name":"offset","required":false,"schema":{"$ref":"#/components/schemas/OffsetParam__244c7d3b837e"}},{"description":"OData Version 4.0 filter string (limited functionality). Supports only 'and' conjunction ('or' and 'not' are NOT supported). Supported fields and operators are in the below given table.\n\n| Field | Operators |\n| --------- | -------- |\n| `name` | `eq` and `in` |\n| `speed` | `eq` and `in` |\n| `status` | `eq` and `in` |\n| `connector` | `eq` and `in` |\n| `duplex` | `eq` and `in` |\n| `lag` | `eq` and `in` |\n| `vlanmode` | `eq` and `in` |\n| `neighbourFamily` | `eq` and `in` |\n| `neighbourFunction` | `eq` and `in` |\n| `poeClass` | `eq` and `in` |\n| `poeStatus` | `eq` and `in` |\n| `operStatus` | `eq` and `in` |\n\n**The operators are implemented as follows:**\n\n* `eq`: Only values exactly matching the given value are returned.\n\n* `in`: Only values present in the given list are returned.\n\n","example":"speed eq '100000' and duplex in ('Full', 'Half')","in":"query","name":"filter","required":false,"schema":{"$ref":"#/components/schemas/Filterswitch__244c7d3b837e"}},{"$ref":"#/components/parameters/search__244c7d3b837e"},{"description":"Comma separated list of sort expressions. Each sort expression is a property name optionally followed by a direction indicator asc (ascending) or desc (descending).\n\nThe first sort expression in the list defines the primary sort order, the second defines the secondary sort order, and so on. If a direction indicator is omitted the default direction is ascending.\n\nSupported fields are port, speed, neighbour, neighbourFamily, nativeVlan, neighbourRole, alias, connector, lag, vlanMode, poeClass, ipv4 and mtu. Default sort by name.\n","example":"lag ASC","in":"query","name":"sort","required":false,"schema":{"$ref":"#/components/schemas/Filterswitch__244c7d3b837e"}}],"responses":{"200":{"$ref":"#/components/responses/SwitchInterfaceResponse__3b087684a285"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/SwitchNotFoundResponse__0d6bfd060cf2"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get a list of Switch interfaces","tags":["Switch"],"x-source-document":{"file":"MRT/listinterfacesv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Switch Monitoring APIs to get details about Switch and related info","name":"Switch"}]},"pathMetadata":{},"sha256":"8a0975f643f58057a1111269340f8ce8846e33be6071b9fcc144b91c4744ea87"}}},"/network-monitoring/v1/switches/{serial-number}/lag":{"get":{"description":"This API provides a summary of link aggregation group (LAG) details for the specified serial number or stack id. Conductor serial may also be used instead of a stack id","operationId":"getLagSummaryV1","parameters":[{"$ref":"#/components/parameters/serial-number__0d6bfd060cf2"}],"responses":{"200":{"$ref":"#/components/responses/SwitchLagSummaryResponse__e3b5991a5b2b"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/SwitchNotFoundResponse__0d6bfd060cf2"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get LAG summary for a Switch","tags":["Switch"],"x-source-document":{"file":"MRT/getlagsummaryv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Switch Monitoring APIs to get details about Switch and related info","name":"Switch"}]},"pathMetadata":{},"sha256":"8d565a31cd4ccbb5864e464894fc7bb642039104733a81b98396eec982c30503"}}},"/network-monitoring/v1/switches/{serial-number}/vlans":{"get":{"description":"This API returns a list of VLANs for the specified serial number or stack id. Conductor serial may also be used instead of a stack id","operationId":"listVlansV1","parameters":[{"$ref":"#/components/parameters/serial-number__0d6bfd060cf2"},{"description":"Denotes the number of vlans that needs to be fetched. Fetches all by default.","example":"100","in":"query","name":"limit","required":false,"schema":{"$ref":"#/components/schemas/LimitParamswitch__244c7d3b837e"}},{"description":"Denotes the offset from where the vlans need to be fetched or the number of vlans to skip.","example":"0","in":"query","name":"offset","required":false,"schema":{"$ref":"#/components/schemas/OffsetParam__244c7d3b837e"}},{"description":"OData Version 4.0 filter string (limited functionality). Supports only 'and' conjunction ('or' and 'not' are NOT supported). Supported fields and operators are in the below given table.\n\n| Field | Operators |\n| --------- | -------- |\n| `status` | `eq` and `in` |\n| `voice` | `eq` and `in` |\n| `type` | `eq` and `in` |\n\n**The operators are implemented as follows:**\n\n* `eq`: Only values exactly matching the given value are returned.\n\n* `in`: Only values present in the given list are returned.\n\n","example":"status in ('Up') and voice in ('Disabled')","in":"query","name":"filter","required":false,"schema":{"$ref":"#/components/schemas/Filterswitch__244c7d3b837e"}},{"$ref":"#/components/parameters/search__244c7d3b837e"},{"description":"Comma separated list of sort expressions. Each sort expression is a property name optionally followed by a direction indicator asc (ascending) or desc (descending).\n\nThe first sort expression in the list defines the primary sort order, the second defines the secondary sort order, and so on. If a direction indicator is omitted the default direction is ascending.\n\nSupported fields are name, id, status, type, ipv4. Default sort by id.\n","example":"status ASC","in":"query","name":"sort","required":false,"schema":{"$ref":"#/components/schemas/Filterswitch__244c7d3b837e"}}],"responses":{"200":{"$ref":"#/components/responses/SwitchVlanResponse__244c7d3b837e"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/SwitchNotFoundResponse__0d6bfd060cf2"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get a list of Switch VLANs","tags":["Switch"],"x-source-document":{"file":"MRT/listvlansv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Switch Monitoring APIs to get details about Switch and related info","name":"Switch"}]},"pathMetadata":{},"sha256":"e1fe8cba8dfe71630694158a33efc3156beb52305c5ad7b78e0e1b78af34bf42"}}},"/network-monitoring/v1/switches/{serial-number}/vsx":{"get":{"description":"This API provides Virtual Switching Extension (VSX) configuration and operational details for a specific switch identified by its serial number. If the switch does not support VSX or VSX is not configured, the API returns a 200 response with an empty VSX object (all fields null).","operationId":"getVsxV1","parameters":[{"$ref":"#/components/parameters/serial-numbervsx__ed65ca41c4fc"}],"responses":{"200":{"content":{"application/json":{"examples":{"vsxConfigured":{"description":"Response when VSX is configured and operational on the switch.","summary":"VSX configured and operational","value":{"configHealth":"ok","configSyncDisable":false,"configSyncStateValue":"synchronized","httpsServerStateValue":"running","islMgmtStateValue":"up","islPort":"1/1/49","islpDeviceStateValue":"active","keepaliveHealth":"healthy","keepalivePeerIp":"192.168.1.2","keepalivePort":"7678","keepaliveSourceIp":"192.168.1.1","keepaliveStatus":"established","lastSyncTimestamp":"1707919492646","mac":"aa:bb:cc:dd:ee:ff","naeStateValue":"enabled","peerIslPort":"1/1/50","peerMac":"11:22:33:44:55:66","peerRole":"secondary","role":"primary","vsxHealth":{"health":"ok","healthDescription":"All VSX components are healthy"},"vsxPeerName":"switch-secondary","vsxPeerSerial":"SNSECONDARY123","vsxPeerSiteId":"site-456"}},"vsxNotConfigured":{"description":"Response when the switch does not support VSX (e.g., 6200F platform) or VSX is not configured on the switch. An empty VSX object is returned with no fields populated.","summary":"VSX not configured or not supported","value":{}}},"schema":{"$ref":"#/components/schemas/VsxResponse__ed65ca41c4fc"}}},"description":"Object containing VSX information. If the switch does not support VSX or VSX is not configured, an empty VSX object is returned with all fields set to null.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"400":{"content":{"application/json":{"examples":{"invalidSerialFormat":{"description":"Returned when the serial number does not match the expected alphanumeric pattern.","summary":"Invalid serial number format","value":{"debugId":"75d40213-6776-40ff-a959-89a7514ef7fc","errorCode":"HPE_GL_ERROR_BAD_REQUEST","httpStatusCode":400,"message":"Invalid serial number format"}},"missingSerial":{"description":"Returned when the serial number parameter is not provided or is empty.","summary":"Missing serial number","value":{"debugId":"a2b3c4d5-6e7f-8a9b-0c1d-2e3f4a5b6c7d","errorCode":"HPE_GL_ERROR_BAD_REQUEST","httpStatusCode":400,"message":"Bad request. Invalid values supplied in request."}}},"schema":{"$ref":"#/components/schemas/ErrorResponse__ed65ca41c4fc"}}},"description":"Bad request: invalid or missing serial number","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"401":{"content":{"application/json":{"example":{"debugId":"a1b2c3d4-5e6f-7g8h-9i0j-k1l2m3n4o5p6","errorCode":"HPE_GL_ERROR_UNAUTHORIZED","httpStatusCode":401,"message":"Invalid or missing access token"},"schema":{"$ref":"#/components/schemas/ErrorResponse__ed65ca41c4fc"}}},"description":"Unauthorized request","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"403":{"content":{"application/json":{"example":{"debugId":"12345678-90ab-cdef-1234-567890abcdef","errorCode":"HPE_GL_ERROR_FORBIDDEN","httpStatusCode":403,"message":"User does not have permission to access this resource"},"schema":{"$ref":"#/components/schemas/ErrorResponse__ed65ca41c4fc"}}},"description":"Forbidden: insufficient permissions","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"404":{"content":{"application/json":{"examples":{"deviceOffline":{"description":"Returned when the switch exists but is currently disconnected from Central.","summary":"Device is offline","value":{"debugId":"abcdef01-2345-6789-abcd-ef0123456789","errorCode":"HPE_GL_ERROR_RESOURCE_NOT_FOUND","httpStatusCode":404,"message":"Device is offline"}},"switchNotFound":{"description":"Returned when no switch with the given serial number is onboarded to the platform.","summary":"Switch not found","value":{"debugId":"fedcba09-8765-4321-1234-567890abcdef","errorCode":"HPE_GL_ERROR_RESOURCE_NOT_FOUND","httpStatusCode":404,"message":"Switch with serial number SG9ZKN5018 not found"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse__ed65ca41c4fc"}}},"description":"Switch not found or device offline","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"429":{"content":{"application/json":{"example":{"debugId":"a1a2a3a4-b5b6-c7c8-d9d0-e1e2e3e4e5e6","errorCode":"HPE_GL_ERROR_RATE_LIMIT_EXCEEDED","httpStatusCode":429,"message":"Rate limit exceeded. Please try again later."},"schema":{"$ref":"#/components/schemas/ErrorResponse__ed65ca41c4fc"}}},"description":"Too many requests","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"500":{"content":{"application/json":{"example":{"debugId":"99887766-5544-3322-1100-ffeeddccbbaa","errorCode":"HPE_GL_ERROR_INTERNAL_ERROR","httpStatusCode":500,"message":"An internal error occurred while processing the request"},"schema":{"$ref":"#/components/schemas/ErrorResponse__ed65ca41c4fc"}}},"description":"Internal server error","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Returns VSX details for a specified switch serial number.","tags":["Switch"],"x-source-document":{"file":"MRT/getvsxv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Switch Monitoring APIs to get details about Switch and related info","name":"Switch"}]},"pathMetadata":{},"sha256":"2b28f59b0797e6e207ac0d65549457ba3552d8b2c74758c857a8ad3177fd612a"}}},"/network-monitoring/v1/tenant-client-health":{"get":{"description":"This API endpoint provides a health overview of connected clients - categorized as poor, fair or good performing, for each client type (e.g. Wired, Wireless) under the customer.","operationId":"tenantClientHealthV1","responses":{"200":{"$ref":"#/components/responses/TenantClientHealthResponse__a586e9b21225"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Client health overview","tags":["Site Health"],"x-source-document":{"file":"MRT/tenantclienthealthv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Site Health APIs to get site details with health, devices, clients, alerts information.","name":"Site Health"}]},"pathMetadata":{},"sha256":"c9e00f463436f55ec8f38c82e4e5f1d050dc5c1e550dfb05eda4a59c02b10acd"}}},"/network-monitoring/v1/tenant-device-health":{"get":{"description":"This API endpoint provides a health overview of devices categorized as poor, fair or good performing, for each device type (e.g. Switches, Gateways, Access Points) under the customer.","operationId":"tenantDeviceHealthV1","responses":{"200":{"$ref":"#/components/responses/TenantDeviceHealthResponse__911671808d98"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Device health overview","tags":["Site Health"],"x-source-document":{"file":"MRT/tenantdevicehealthv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Site Health APIs to get site details with health, devices, clients, alerts information.","name":"Site Health"}]},"pathMetadata":{},"sha256":"13852c8845e31b883ceeb3fcf3f05d1b13ae474e995442a8cc972662eaaba228"}}},"/network-monitoring/v1/threats":{"get":{"description":"Retrieves a list of IDPS threats detected by the Suricata engine in the Gateways.\n","operationId":"getThreatsV1","parameters":[{"description":"Specifies the start time (RFC 3339 UTC+0) from which the threats should be listed.\n","in":"query","name":"start-at","required":true,"schema":{"examples":["2024-11-10T00:00:00.000Z"],"format":"date-time","type":"string"}},{"description":"Specifies the end time (RFC 3339 UTC+0) up to which the threats should be listed.\n","in":"query","name":"end-at","required":false,"schema":{"examples":["2024-11-10T01:00:00.000Z"],"format":"date-time","type":"string"}},{"description":"OData Version 4.0 filter string (limited functionality). Supports only 'and' conjunction ('or' and 'not' are NOT supported). The only supported operator is 'eq' ('in' is NOT supported). Supported fields are: `action`, `appProto`, `clientMacaddr`, `customerId`, `destCity`, `destCountry`, `destIp`, `destPort`, `deviceIp`, `deviceModel`, `deviceName`, `deviceSerialNum`, `flowId`, `groupId`, `groupName`, `proto`, `signatureId`, `siteId`, `siteName`, `severity`, `srcCity`, `srcCountry`, `srcIp`, `srcPort`, `strategy`, `id`, `occurredAt`, `userName` and `userRole`.\n","in":"query","name":"filter","required":false,"schema":{"examples":["action eq 'ALLOWED' and id eq 'id123' and siteId eq 'site123'"],"maxLength":1024,"type":"string"}},{"description":"Comma separated list of sort expressions. Each sort expression is a property name optionally followed by a direction indicator asc (ascending) or desc (descending).\n\nThe first sort expression in the list defines the primary sort order, the second defines the secondary sort order, and so on. If a direction indicator is omitted the default direction is ascending.\n\nSupported fields are `action`, `appProto`, `clientMacaddr`, `customerId`, `destIp`, `destPort`, `destCity`, `destCountry`, `deviceIp`, `deviceModel`, `deviceName`, `deviceSerialNum`, `flowId`, `groupId`, `groupName`, `id`, `proto`, `signatureId`, `siteId`, `siteName`, `srcCity`, `srcCountry`, `srcIp`, `srcPort`, `strategy`, `occurredAt`, `userName` and `userRole`.\n","in":"query","name":"sort","required":false,"schema":{"examples":["signatureId desc, destPort, occurredAt asc"],"maxLength":1024,"type":"string"}},{"description":"Specifies the maximum number of threats returned in the response threat list.\n","in":"query","name":"limit","required":false,"schema":{"default":20,"examples":[20],"format":"int32","maximum":1000,"minimum":0,"type":"integer"}},{"description":"Specifies the offset in the threat list at which to begin the response.\n","in":"query","name":"offset","required":false,"schema":{"default":0,"examples":[123],"format":"int64","maximum":2147483647,"minimum":0,"type":"integer"}}],"responses":{"200":{"$ref":"#/components/responses/ThreatListResponse__7006262f8c4c"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"},"503":{"$ref":"#/components/responses/ServiceUnavailable__7006262f8c4c"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get a list of IDPS threats.\n","tags":["IDPS"],"x-source-document":{"file":"MRT/getthreatsv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"IDPS(Intrusion Detection and Prevention System) Monitoring APIs to retrieve threat list and a particular threat details","name":"IDPS"}]},"pathMetadata":{},"sha256":"154f36922bef9d3616731a2a2fdd9beba5c94a385d5daaf4fe34bcb591c606b5"}}},"/network-monitoring/v1/threats/{id}":{"get":{"description":"Retrieves the details of a specific IDPS threat based on the threat ID provided.\n","operationId":"getThreatDetailV1","parameters":[{"$ref":"#/components/parameters/Id__f8f342aecdae"},{"$ref":"#/components/parameters/SiteId__f8f342aecdae"},{"$ref":"#/components/parameters/Timestamp__f8f342aecdae"}],"responses":{"200":{"$ref":"#/components/responses/ThreatDetailResponse__f8f342aecdae"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"},"503":{"$ref":"#/components/responses/ServiceUnavailable__7006262f8c4c"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get an IDPS threat's details\n","tags":["IDPS"],"x-source-document":{"file":"MRT/getthreatdetailv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"IDPS(Intrusion Detection and Prevention System) Monitoring APIs to retrieve threat list and a particular threat details","name":"IDPS"}]},"pathMetadata":{},"sha256":"6340325261c9f256fb72ee1a8585e5fb708d9dab972f648dda76f8d7e6c6e796"}}},"/network-monitoring/v1/top-aps-by-usage":{"get":{"description":"The API will retrieve a list of the top access points ranked by their combined bandwidth usage of wired & wireless, sorted in descending order, for a specified site and time period.\n","operationId":"getTopAccessPointsByUsageV1","parameters":[{"$ref":"#/components/parameters/SiteIdOptional__05867e444b37"},{"$ref":"#/components/parameters/SiteNameOptional__05867e444b37"},{"description":"Specifies the maximum number of top access points returned in the response. The default value is 10.\n","in":"query","name":"limit","required":false,"schema":{"$ref":"#/components/schemas/TopAPsLimit__1ff3457b62c0"}},{"description":"Data that is required starting from this timestamp, provided in RFC 3339 (and ISO 8601) format in the \nUTC+0 timezone. The difference between *end-at* and *start-at* should be less than 30 days.\n","in":"query","name":"start-at","required":false,"schema":{"$ref":"#/components/schemas/DateTime__1ff3457b62c0"}},{"description":"Data that is required up to this timestamp, provided in RFC 3339 (and ISO 8601) format in the \nUTC+0 timezone. The timestamp must be earlier than the current time and later than the start time.It should be earlier than the current time and later than the *start-at*.\n","in":"query","name":"end-at","required":false,"schema":{"$ref":"#/components/schemas/DateTime__1ff3457b62c0"}}],"responses":{"200":{"$ref":"#/components/responses/TopAccessPointsByUsageResponse__1ff3457b62c0"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get high total bandwidth usage Access Points","tags":["Access Points"],"x-source-document":{"file":"MRT/gettopaccesspointsbyusagev1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Access Point Monitoring APIs to get Access Point details and its metrics","name":"Access Points"}]},"pathMetadata":{},"sha256":"12a1fa71fe105516706ac84044285577201e5470956933b363a0b09596b0850a"}}},"/network-monitoring/v1/top-aps-by-wired-usage":{"get":{"description":"The API will retrieve a list of the top access points ranked by their wired bandwidth usage, sorted in descending order, for a specified site and time period.\n","operationId":"getTopAccessPointsByWiredUsageV1","parameters":[{"$ref":"#/components/parameters/SiteIdOptional__05867e444b37"},{"$ref":"#/components/parameters/SiteNameOptional__05867e444b37"},{"description":"Specifies the maximum number of top access points returned in the response. The default value is 10.\n","in":"query","name":"limit","required":false,"schema":{"$ref":"#/components/schemas/TopAPsLimit__1ff3457b62c0"}},{"description":"Data that is required starting from this timestamp, provided in RFC 3339 (and ISO 8601) format in the \nUTC+0 timezone. The difference between *end-at* and *start-at* should be less than 30 days.\n","in":"query","name":"start-at","required":false,"schema":{"$ref":"#/components/schemas/DateTime__1ff3457b62c0"}},{"description":"Data that is required up to this timestamp, provided in RFC 3339 (and ISO 8601) format in the \nUTC+0 timezone. The timestamp must be earlier than the current time and later than the start time.It should be earlier than the current time and later than the *start-at*.\n","in":"query","name":"end-at","required":false,"schema":{"$ref":"#/components/schemas/DateTime__1ff3457b62c0"}}],"responses":{"200":{"$ref":"#/components/responses/TopAccessPointsByUsageResponse__1ff3457b62c0"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get high wired bandwidth usage Access Points","tags":["Access Points"],"x-source-document":{"file":"MRT/gettopaccesspointsbywiredusagev1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Access Point Monitoring APIs to get Access Point details and its metrics","name":"Access Points"}]},"pathMetadata":{},"sha256":"43f8381185839e6a870cd033673ecb77a7cdb58c9eacec44578d52969d953b71"}}},"/network-monitoring/v1/top-aps-by-wireless-usage":{"get":{"description":"The API will retrieve a list of the top access points ranked by their wireless bandwidth usage, sorted in descending order, for a specified site and time period.\n","operationId":"getTopAccessPointsByWirelessUsageV1","parameters":[{"$ref":"#/components/parameters/SiteIdOptional__05867e444b37"},{"$ref":"#/components/parameters/SiteNameOptional__05867e444b37"},{"description":"Specifies the maximum number of top access points returned in the response. The default value is 10.\n","in":"query","name":"limit","required":false,"schema":{"$ref":"#/components/schemas/TopAPsLimit__1ff3457b62c0"}},{"description":"Data that is required starting from this timestamp, provided in RFC 3339 (and ISO 8601) format in the \nUTC+0 timezone. The difference between *end-at* and *start-at* should be less than 30 days.\n","in":"query","name":"start-at","required":false,"schema":{"$ref":"#/components/schemas/DateTime__1ff3457b62c0"}},{"description":"Data that is required up to this timestamp, provided in RFC 3339 (and ISO 8601) format in the \nUTC+0 timezone. The timestamp must be earlier than the current time and later than the start time.It should be earlier than the current time and later than the *start-at*.\n","in":"query","name":"end-at","required":false,"schema":{"$ref":"#/components/schemas/DateTime__1ff3457b62c0"}}],"responses":{"200":{"$ref":"#/components/responses/TopAccessPointsByUsageResponse__1ff3457b62c0"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get high wireless bandwidth usage Access Points","tags":["Access Points"],"x-source-document":{"file":"MRT/gettopaccesspointsbywirelessusagev1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Access Point Monitoring APIs to get Access Point details and its metrics","name":"Access Points"}]},"pathMetadata":{},"sha256":"502960e74a6cab423678c3e13cdafad1d4486aa3329a185cd4c920bbc420f586"}}},"/network-monitoring/v1/topology/{site-id}":{"get":{"description":"This API provides topology for a specific site","operationId":"getLinkTopology","parameters":[{"description":"ID of the site for which topology details are requested.","example":"2345678","in":"path","name":"site-id","required":true,"schema":{"$ref":"#/components/schemas/SiteIdtopology__004689200476"}}],"responses":{"200":{"$ref":"#/components/responses/TopologyResponse__b8d35392fbec"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Returns topology details for the given site.","tags":["Topology"],"x-source-document":{"file":"MRT/getlinktopology.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Topology APIs to get Topology and device relationship information","name":"Topology"}]},"pathMetadata":{},"sha256":"059f81bca05783dd822831470804c55f050f22ee1a73dabfaa652933d0e9a193"}}},"/network-monitoring/v1/unmanaged-device/{mac-address}":{"get":{"description":"This API provides unmanaged device details for a specific site and device mac","operationId":"getUnmanagedDevice","parameters":[{"description":"ID of the site for which unmanaged device details are requested.","example":"2345678","in":"query","name":"site-id","required":true,"schema":{"$ref":"#/components/schemas/SiteIdtopology__004689200476"}},{"description":"Device MAC for which details are requested.","example":"a1:b2:c3:d4:e5:f6","in":"path","name":"mac-address","required":true,"schema":{"$ref":"#/components/schemas/Mac__004689200476"}}],"responses":{"200":{"$ref":"#/components/responses/UnmanagedDeviceResponse__004689200476"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Returns details for an unmanaged device of a given site.","tags":["Topology"],"x-source-document":{"file":"MRT/getunmanageddevice.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Topology APIs to get Topology and device relationship information","name":"Topology"}]},"pathMetadata":{},"sha256":"dbedfddec67d90dd2d89e79334f43416f71a9729e204ffbf30d6bb93b147b2f8"}}},"/network-monitoring/v1/wall-types":{"delete":{"description":"Delete wall types based on the provided inputs and returns a response indicating the success or failure of the operation.","operationId":"deleteWallTypesV1","requestBody":{"content":{"application/json":{"schema":{"properties":{"items":{"items":{"$ref":"#/components/schemas/uuId__08d3c9863d87"},"maxItems":100,"type":"array"}},"type":"object"}}},"required":true},"responses":{"204":{"description":"Successfully deleted","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Delete Wall Types.","tags":["FloorPlan"],"x-source-document":{"file":"MRT/deletewalltypesv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"FloorPlan Manager APIs to get details about FloorMap and entities placed on FloorMap","name":"FloorPlan"}]},"pathMetadata":{},"sha256":"eda5104cbae72ec0202f18b530d3f24938825918b7ef5c7b3a1b65c0e56b63fd"}},"get":{"description":"Returns a list of wall types, including both standard walls and custom walls.","operationId":"getWallTypesV1","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WallTypes__254f45b253d0"}}},"description":"Returns a list of wall types for a given tenant, including both standard walls and custom walls.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error400__254f45b253d0"}}},"description":"Bad request.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"401":{"content":{"application/json":{"examples":{"unauthorized":{"summary":"Unauthorized","value":{"debugId":"75d40213-6776-40ff-a959-89a7514ef7fc","errorCode":"HPE_GL_ERROR_FORBIDDEN","httpStatusCode":401,"message":"Invalid JWT token in Request"}}}}},"description":"Unauthorized request.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error404__0288a339fc72"}}},"description":"Not found error.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"429":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error429__254f45b253d0"}}},"description":"Too many requests.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error500__254f45b253d0"}}},"description":"Internal server error.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Retrieve Wall Types","tags":["FloorPlan"],"x-source-document":{"file":"MRT/getwalltypesv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"FloorPlan Manager APIs to get details about FloorMap and entities placed on FloorMap","name":"FloorPlan"}]},"pathMetadata":{},"sha256":"792052307d9b7198239f76a478b49aca4d7a265863343e02d5912f9bb67a998b"}},"post":{"description":"Create wall types based on the provided inputs and returns a response indicating the success or failure of the operation. brick, concrete, glass are some of the wall types","operationId":"createWallTypesV1","requestBody":{"content":{"application/json":{"schema":{"properties":{"items":{"items":{"properties":{"attenuation":{"description":"attenuation associated with the wall type.","format":"double","maximum":100,"minimum":0,"type":"number"},"id":{"description":"wall type id associated with the tenant in UUID format.","example":"16a-aad7-4070-8a19-fd6b8e1ff012","maxLength":128,"type":"string"},"name":{"description":"wall type name associated with the tenant in readable format.","example":"default_drywall","format":"const","maxLength":128,"type":"string"}},"type":"object"},"maxItems":100,"type":"array"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OverlayResponse__45e55a7a2612"}}},"description":"Created walltypes successfully.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Create Wall Types","tags":["FloorPlan"],"x-source-document":{"file":"MRT/createwalltypesv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"FloorPlan Manager APIs to get details about FloorMap and entities placed on FloorMap","name":"FloorPlan"}]},"pathMetadata":{},"sha256":"a9535ac6b33c4ae6d29f8ad6a521e492b6902632ad7b48594c1e945c036797d4"}},"put":{"description":"Update wall types based on the provided inputs and returns a response indicating the success or failure of the operation.","operationId":"updateWallTypesV1","requestBody":{"content":{"application/json":{"schema":{"properties":{"items":{"items":{"properties":{"attenuation":{"description":"attenuation associated with the wall type.","format":"double","maximum":100,"minimum":0,"type":"number"},"id":{"description":"wall type id associated with the customer in UUID format.","example":"16a-aad7-4070-8a19-fd6b8e1ff012","maxLength":128,"type":"string"},"name":{"description":"wall type name associated with the customer in readable format.","example":"dry-wall","format":"const","maxLength":128,"type":"string"}},"type":"object"},"maxItems":100,"type":"array"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OverlayResponse__45e55a7a2612"}}},"description":"Updated wall types successfully.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Update Wall Types","tags":["FloorPlan"],"x-source-document":{"file":"MRT/updatewalltypesv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"FloorPlan Manager APIs to get details about FloorMap and entities placed on FloorMap","name":"FloorPlan"}]},"pathMetadata":{},"sha256":"9063d241e85faa96b35233f691dcd73b4cf3687dccb36e5503321fc839f691ec"}}},"/network-monitoring/v1/website-categories":{"get":{"description":"This API endpoint returns the top N website categories ranked by usage (tx + rx bytes) for the requested scope. The maximum time range is 7 days. If the range between start-at and end-at exceeds 7 days, start-at is automatically adjusted to be 7 days before end-at. This is intentional behavior; no error is returned.\n","operationId":"listWebsiteCategoriesV1","parameters":[{"description":"The start time in RFC 3339 Format or epoch milliseconds (must be within 7 days of end-at).\n","in":"query","name":"start-at","required":true,"schema":{"example":"2024-11-20T14:14:33Z","format":"date-time","maxLength":27,"type":"string"}},{"description":"The end time in RFC 3339 Format or epoch milliseconds (must be greater than start-at).\n","in":"query","name":"end-at","required":true,"schema":{"example":"2024-11-21T14:14:33Z","format":"date-time","maxLength":27,"type":"string"}},{"description":"Filter by site identifier.\n","in":"query","name":"site-id","required":false,"schema":{"example":"2778382","format":"const","maxLength":20,"type":"string"}},{"description":"Filter by client MAC address. Forces use of the main data table (not aggregated).\n","in":"query","name":"client-id","required":false,"schema":{"example":"00:00:00:00:00:00","format":"const","maxLength":17,"type":"string"}},{"description":"Filter by device serial number. Forces use of the main data table (not aggregated).\n","in":"query","name":"serial-number","required":false,"schema":{"example":"CN12345678","format":"const","maxLength":64,"type":"string"}},{"description":"Maximum number of items to return per page (1–500). Default: 100.\n","in":"query","name":"limit","required":false,"schema":{"default":100,"example":20,"format":"int32","maximum":500,"minimum":1,"type":"integer"}},{"description":"Filter by SSID name.\n","in":"query","name":"ssid","required":false,"schema":{"example":"CorpWiFi","format":"const","maxLength":256,"type":"string"}},{"description":"Filter by user role.\n","in":"query","name":"user-role","required":false,"schema":{"example":"admin","format":"const","maxLength":256,"type":"string"}},{"description":"Zero-based index of the first item to return. Default: 0.\n","in":"query","name":"offset","required":false,"schema":{"default":0,"example":0,"format":"int32","minimum":0,"type":"integer"}},{"description":"Maximum number of top-ranked website categories to return in total across all pages (1–500). Default: 100.\n","in":"query","name":"top","required":false,"schema":{"default":100,"example":10,"format":"int32","maximum":500,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebsiteCategoryUsageList__d76081fde092"}}},"description":"Successful operation.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/XRateLimitLimitHeaderapp__7c5b5fe9ca66"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/XRateLimitRemainingHeaderapp__7c5b5fe9ca66"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/NotFoundError__0288a339fc72"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"},"503":{"$ref":"#/components/responses/ServiceUnavailableapp__7c5b5fe9ca66"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get top website categories by usage\n","tags":["Application Visibility"],"x-source-document":{"file":"MRT/listwebsitecategoriesv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Application Visibility APIs provide details about applications accessed in a site or by a client.","name":"Application Visibility"}]},"pathMetadata":{},"sha256":"4d6ca54b32aec8816474570671501b3440e4b3efbadf479f6113489502dfd0a8"}}},"/network-monitoring/v1/wlans":{"get":{"description":"This API endpoint retrieves a list of WLANs associated to a customer, based on the query parameters provided. Each WLAN in the returned list includes comprehensive details like name, security level, band, status, and VLAN configuration. The query parameters allow you to narrow down the results to WLANs that meet specific criteria, ensuring you receive only the relevant data.\n","operationId":"getWlanListV1","parameters":[{"$ref":"#/components/parameters/SiteIdOptional__05867e444b37"},{"$ref":"#/components/parameters/SerialNumberQueryOptional__5247473e8f2a"},{"$ref":"#/components/parameters/WlanFilter__bfa0034decee"},{"description":"A comma-separated list of sort expressions. Each sort expression is a property name optionally followed by a direction indicator asc (ascending) or desc (descending).\n\nThe first sort expression in the list defines the primary sort order, the second defines the secondary sort order, and so on. If a direction indicator is omitted the default direction is ascending. By default, the response is sorted in ascending order by WLAN name.\n\nSupported fields are `wlanName`, `band`, `status`, `securityLevel`, `security`, and `vlan`.\n","in":"query","name":"sort","required":false,"schema":{"example":"wlanName,status desc","format":"const","maxLength":256,"type":"string"}},{"description":"Specifies the maximum number of WLANs returned in the response.\n","in":"query","name":"limit","required":false,"schema":{"default":20,"example":20,"format":"int64","maximum":1000,"minimum":0,"type":"integer"}},{"description":"Specifies the pagination cursor for the next page of resources.\n\nThe minimum value: 1\n","in":"query","name":"next","required":false,"schema":{"$ref":"#/components/schemas/Next__21874c7bfa12"}}],"responses":{"200":{"$ref":"#/components/responses/TenantWlanListResponseV1__bfa0034decee"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get a list of WLANs","tags":["Access Points"],"x-source-document":{"file":"MRT/getwlanlistv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Access Point Monitoring APIs to get Access Point details and its metrics","name":"Access Points"}]},"pathMetadata":{},"sha256":"5bf7e8f7cd8f62e0f4a36b7aea245d29f5c21e7324b1d6a88aa357a16c1fc139"}}},"/network-monitoring/v1/wlans/{wlan-name}":{"get":{"description":"This API retrieves detailed information about a specific WLAN.\n","operationId":"getWlanV1","parameters":[{"$ref":"#/components/parameters/WlanNameMandatory__5247473e8f2a"},{"$ref":"#/components/parameters/SiteIdOptional__05867e444b37"},{"$ref":"#/components/parameters/SerialNumberQueryOptional__5247473e8f2a"}],"responses":{"200":{"$ref":"#/components/responses/WlanInfoResponse__5247473e8f2a"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"404":{"$ref":"#/components/responses/WlanNotFoundError__5247473e8f2a"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get a specific WLAN by name","tags":["Access Points"],"x-source-document":{"file":"MRT/getwlanv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Access Point Monitoring APIs to get Access Point details and its metrics","name":"Access Points"}]},"pathMetadata":{},"sha256":"2c46e9b7445420a4d4534f4a46aef5d42dfa5293af158b047de73b011257e3ec"}}},"/network-monitoring/v1/wlans/{wlan-name}/throughput-trends":{"get":{"description":"The API retrieves throughput trend data for a specific WLAN, including transmitted(tx) and received(rx) data in bits per second. If no timestamp range is specified in the filter, data for the last 3 hours will be returned by default.\n","operationId":"getWlanThroughputTrendV1","parameters":[{"$ref":"#/components/parameters/TrendsFilter__05867e444b37"},{"$ref":"#/components/parameters/SiteIdOptional__05867e444b37"},{"$ref":"#/components/parameters/SiteNameOptional__05867e444b37"},{"description":"Provide WLAN name to get transmitted and received data for the specific network.\n","example":"wlan-00006","in":"path","name":"wlan-name","required":true,"schema":{"format":"const","maxLength":128,"type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/WLANThroughputTrendsResponse__cf469a65323a"},"400":{"$ref":"#/components/responses/BadRequestError__004689200476"},"401":{"$ref":"#/components/responses/Unauthorized__004689200476"},"403":{"$ref":"#/components/responses/Forbidden__004689200476"},"429":{"$ref":"#/components/responses/TooManyRequests__004689200476"},"500":{"$ref":"#/components/responses/InternalServerError__004689200476"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get the throughput trend for a WLAN.","tags":["Access Points"],"x-source-document":{"file":"MRT/getwlanthroughputtrendv1.json","metadata":{"info":{"description":"API to retrieve VSX (Virtual Switching Extension) information for switches.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Monitoring","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"Access Point Monitoring APIs to get Access Point details and its metrics","name":"Access Points"}]},"pathMetadata":{},"sha256":"e53a82c5ff484e2d83599021e89431356195c99a786bc2e6e0dbd2dcb80232a9"}}},"/network-msp/v1/list-tenants":{"get":{"description":"This API provides the list of tenants for an MSP. Tenants list includes details like tenant name, tenant CID, sites count, devices count with health status, alerts count, etc. The query parameters allow you to narrow down the results that meet specific criteria, ensuring you receive only the relevant data.","operationId":"listTenantsV1","parameters":[{"$ref":"#/components/parameters/Filter__6ff1f6639f14"},{"$ref":"#/components/parameters/Sort__6ff1f6639f14"},{"$ref":"#/components/parameters/Limit__6ff1f6639f14"},{"$ref":"#/components/parameters/Next__6ff1f6639f14"}],"responses":{"200":{"$ref":"#/components/responses/ListTenantsResponse__6ff1f6639f14"},"400":{"$ref":"#/components/responses/BadRequestError__6ff1f6639f14"},"401":{"$ref":"#/components/responses/Unauthorized__6ff1f6639f14"},"403":{"$ref":"#/components/responses/Forbidden__6ff1f6639f14"},"404":{"$ref":"#/components/responses/NotFoundError__6ff1f6639f14"},"429":{"$ref":"#/components/responses/TooManyRequests__6ff1f6639f14"},"500":{"$ref":"#/components/responses/InternalServerError__6ff1f6639f14"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get all MSP tenants information.","tags":["MSP"],"x-source-document":{"file":"MRT/listtenantsv1.json","metadata":{"info":{"description":"`Managed Service Provider (MSP)` APIs.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"MSP","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"MSP APIs to get and manage tenants related information.","name":"MSP"}]},"pathMetadata":{},"sha256":"7528099aed7d38ff61a3e914997cffb5b4d52a1a19bbf1dffc7bbcd39f274548"}}},"/network-notifications/v1/alert-config":{"get":{"description":"Retrieves alert configurations for a given scope. Each configuration defines the threshold rules, severity mappings, and settings for a specific alert type. Configurations may be locally defined or inherited from a parent scope.\n\n**Scope types:**\n\n| Value | Description |\n|-------|-------------|\n| `GLOBAL` | Tenant-level scope (default) |\n| `SITE` | Site-level scope |\n| `DEVICE` | Device-level scope |\n\n**Pagination:**\n\nUse `limit` and `next` together to page through large result sets. When `limit` is supplied the response includes `total` (total available configurations) and `offset` (zero-based index of the first item returned), enabling clients to determine whether additional pages exist.\n","operationId":"getAlertConfigs","parameters":[{"description":"The scope identifier for which alert configurations are retrieved.\n","in":"query","name":"scope-id","required":true,"schema":{"example":"1021882040","type":"string"}},{"description":"The scope type. Determines the level at which the configuration applies.\n\n| Value | Description |\n|-------|-------------|\n| `GLOBAL` | Tenant-level scope (default) |\n| `SITE` | Site-level scope |\n| `DEVICE` | Device-level scope |\n","in":"query","name":"scope-type","required":false,"schema":{"default":"GLOBAL","enum":["GLOBAL","SITE","DEVICE"],"example":"SITE","type":"string"}},{"description":"Maximum number of alert configurations to return per page. Defaults to `20` when not specified.\n","in":"query","name":"limit","required":false,"schema":{"default":20,"example":20,"maximum":100,"minimum":1,"type":"integer"}},{"description":"Zero-based offset of the first alert configuration to return. Use together with `limit` to paginate through results. Defaults to `0` when not specified.\n","in":"query","name":"next","required":false,"schema":{"default":0,"example":0,"minimum":0,"type":"integer"}}],"responses":{"200":{"$ref":"#/components/responses/AlertConfigListResponse__1f9b401b0047"},"400":{"$ref":"#/components/responses/BadRequestError__0c2a95c4aa99"},"401":{"$ref":"#/components/responses/Unauthorized__0c2a95c4aa99"},"403":{"$ref":"#/components/responses/Forbidden__0c2a95c4aa99"},"404":{"$ref":"#/components/responses/NotFoundError__0c2a95c4aa99"},"429":{"$ref":"#/components/responses/TooManyRequests__0c2a95c4aa99"},"500":{"$ref":"#/components/responses/InternalServerError__0c2a95c4aa99"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"List alert configurations","tags":["Alert Configurations"],"x-source-document":{"file":"MRT/getalertconfigs.json","metadata":{"info":{"description":"This is a v1 release of the Notification platform APIs.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Notifications","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"APIs for managing alert configurations — retrieve threshold rules and severity settings per alert type and scope.","name":"Alert Configurations"}]},"pathMetadata":{},"sha256":"19edf8d84ba8b38665105e2696edeae8b561780df273b33100e2d9774f692499"}}},"/network-notifications/v1/alerts":{"get":{"description":"This API endpoint retrieves the list of Alerts based on the query parameters provided. The alerts list includes details such as name, type, category, severity, status, etc. The query parameters allow you to filter results that meet specific criteria, ensuring you receive only relevant data.\n","operationId":"getAlertListV1","parameters":[{"description":"OData Version 4.0 filter string (limited functionality). Supports only 'and' conjunction ('or' and 'not' are NOT supported). Supported fields and operators are in the table below. \n\n| Field | Operators |\n| --------- | -------- |\n| `siteId` | `eq` and `in` |\n| `status` | `eq` and `in` |\n| `category` | `eq` and `in` |\n| `deviceType` | `eq` and `in`|\n\n**The operators are implemented as follows:**\n\n* `eq`: Only values exactly matching the given value are returned.\n* `in`: Only values present in the given list are returned.\n\n**List of applicable filters for field and terms:**\n\n| Field | Applicable Terms |\n| --------- | -------- |\n|  `siteId` | `string` |\n| `status` | `[\"Active\", \"Deferred\", \"Cleared\"]` |\n| `deviceType` | `[\"Access Point\", \"Gateway\", \"Switch\", \"Bridge\"]` |\n| `category` | `[\"Clients\", \"System\", \"LAN\", \"WLAN\", \"WAN\", \"Cluster\", \"Routing\", \"Security\"]` |\n\n","in":"query","name":"filter","schema":{"example":"deviceType in ('Access Point', 'Switch') and siteId eq '1234567'","type":"string"}},{"description":"Sort field followed by a direction indicator ASC (ascending) or DESC (descending). Supported fields are `createdAt`,`severity`,`status`,`name`,`priority`. `createdAt` field is used by default. \n","in":"query","name":"sort","schema":{"example":"status asc","format":"const","maxLength":256,"type":"string"}},{"description":"Specifies the pagination cursor for the next page of resources. Minimum value is 1.\n","in":"query","name":"next","schema":{"default":"1","example":"1","minimum":1,"type":"string"}},{"description":"Maximum number of alerts to be retrieved. Allowed range is 1 to 100.\n","in":"query","name":"limit","schema":{"default":20,"maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"$ref":"#/components/responses/AlertListResponse__78d118144c60"},"400":{"$ref":"#/components/responses/BadRequestError__0c2a95c4aa99"},"401":{"$ref":"#/components/responses/Unauthorized__0c2a95c4aa99"},"403":{"$ref":"#/components/responses/Forbidden__0c2a95c4aa99"},"404":{"$ref":"#/components/responses/NotFoundError__0c2a95c4aa99"},"429":{"$ref":"#/components/responses/TooManyRequests__0c2a95c4aa99"},"500":{"$ref":"#/components/responses/InternalServerError__0c2a95c4aa99"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"List all alerts","tags":["Alerts"],"x-source-document":{"file":"MRT/getalertlistv1.json","metadata":{"info":{"description":"This is a v1 release of the Notification platform APIs.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Notifications","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"APIs for managing alerts.","name":"Alerts"}]},"pathMetadata":{},"sha256":"19118dbdd3574571771bcb92d43d166117e9d672c8144b46dc5eed15cd207627"}}},"/network-notifications/v1/alerts/active":{"post":{"description":"This API endpoint sets the specified alerts to active status. This can be used to reactivate deferred alerts.\n","operationId":"setActiveAlerts","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetActiveAlertsRequest__1aced8f63fe1"}}},"required":true},"responses":{"202":{"$ref":"#/components/responses/AlertActionResponse__0c2a95c4aa99"},"400":{"$ref":"#/components/responses/BadRequestError__0c2a95c4aa99"},"401":{"$ref":"#/components/responses/Unauthorized__0c2a95c4aa99"},"403":{"$ref":"#/components/responses/Forbidden__0c2a95c4aa99"},"404":{"$ref":"#/components/responses/NotFoundError__0c2a95c4aa99"},"429":{"$ref":"#/components/responses/TooManyRequests__0c2a95c4aa99"},"500":{"$ref":"#/components/responses/InternalServerError__0c2a95c4aa99"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Set alerts to active","tags":["Alerts"],"x-source-document":{"file":"MRT/setactivealerts.json","metadata":{"info":{"description":"This is a v1 release of the Notification platform APIs.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Notifications","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"APIs for managing alerts.","name":"Alerts"}]},"pathMetadata":{},"sha256":"6f12b6494aff7b2571c9afcf3eb0d38ddcbe363c4ec576bad6a3ded7ed335455"}}},"/network-notifications/v1/alerts/async-operations/{task-id}":{"get":{"description":"This API endpoint retrieves the status of an asynchronous alert operation using the task ID returned from alert action endpoints (clear, defer, active, priority).\n","operationId":"alertActionStatus","parameters":[{"description":"The unique task identifier returned from an alert action request.\n","in":"path","name":"task-id","required":true,"schema":{"example":"abc123-def456-ghi789","type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/AlertActionStatusResponse__4774edd10512"},"400":{"$ref":"#/components/responses/BadRequestError__0c2a95c4aa99"},"401":{"$ref":"#/components/responses/Unauthorized__0c2a95c4aa99"},"403":{"$ref":"#/components/responses/Forbidden__0c2a95c4aa99"},"404":{"$ref":"#/components/responses/NotFoundError__0c2a95c4aa99"},"429":{"$ref":"#/components/responses/TooManyRequests__0c2a95c4aa99"},"500":{"$ref":"#/components/responses/InternalServerError__0c2a95c4aa99"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get async operation status","tags":["Alerts"],"x-source-document":{"file":"MRT/alertactionstatus.json","metadata":{"info":{"description":"This is a v1 release of the Notification platform APIs.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Notifications","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"APIs for managing alerts.","name":"Alerts"}]},"pathMetadata":{},"sha256":"8ce568bc8070cbb1ab2fda5971d1fa689ef1a07c1002f8141e6f8977fda76cc0"}}},"/network-notifications/v1/alerts/classification":{"get":{"description":"This API endpoint retrieves the classification of alerts based on the specified type. The classification provides aggregated counts of alerts grouped by the specified criteria.\n","operationId":"alertsClassification","parameters":[{"description":"The type of classification to retrieve. This determines how alerts are grouped. \nPossible values are `severity`, `status`, `priority`, `category`, `device_type`, `impacted_devices`\n","in":"query","name":"type","required":true,"schema":{"example":"category","type":"string"}},{"description":"OData Version 4.0 filter string to filter the alerts before classification.\n","in":"query","name":"filter","schema":{"example":"siteId eq '1234567'","type":"string"}},{"description":"Search string to filter alerts by name or summary before classification.\n","in":"query","name":"search","schema":{"example":"PoE","type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/AlertsClassificationResponse__7688f37a490e"},"400":{"$ref":"#/components/responses/BadRequestError__0c2a95c4aa99"},"401":{"$ref":"#/components/responses/Unauthorized__0c2a95c4aa99"},"403":{"$ref":"#/components/responses/Forbidden__0c2a95c4aa99"},"404":{"$ref":"#/components/responses/NotFoundError__0c2a95c4aa99"},"429":{"$ref":"#/components/responses/TooManyRequests__0c2a95c4aa99"},"500":{"$ref":"#/components/responses/InternalServerError__0c2a95c4aa99"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get alerts classification","tags":["Alerts"],"x-source-document":{"file":"MRT/alertsclassification.json","metadata":{"info":{"description":"This is a v1 release of the Notification platform APIs.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Notifications","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"APIs for managing alerts.","name":"Alerts"}]},"pathMetadata":{},"sha256":"57eeb9909d3e6d4340c16eeced2399c979ece948e913265afd41e8a08f453523"}}},"/network-notifications/v1/alerts/clear":{"post":{"description":"This API endpoint clears the specified alerts. Clearing an alert marks it as resolved with an optional reason and notes.\n","operationId":"clearAlerts","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClearAlertsRequest__0c2a95c4aa99"}}},"required":true},"responses":{"202":{"$ref":"#/components/responses/AlertActionResponse__0c2a95c4aa99"},"400":{"$ref":"#/components/responses/BadRequestError__0c2a95c4aa99"},"401":{"$ref":"#/components/responses/Unauthorized__0c2a95c4aa99"},"403":{"$ref":"#/components/responses/Forbidden__0c2a95c4aa99"},"404":{"$ref":"#/components/responses/NotFoundError__0c2a95c4aa99"},"429":{"$ref":"#/components/responses/TooManyRequests__0c2a95c4aa99"},"500":{"$ref":"#/components/responses/InternalServerError__0c2a95c4aa99"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Clear alerts","tags":["Alerts"],"x-source-document":{"file":"MRT/clearalerts.json","metadata":{"info":{"description":"This is a v1 release of the Notification platform APIs.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Notifications","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"APIs for managing alerts.","name":"Alerts"}]},"pathMetadata":{},"sha256":"9173fa1ff31ee6d9cf5136d4a6e288a0f4365710fcf79c1d35bee606571f8004"}}},"/network-notifications/v1/alerts/defer":{"post":{"description":"This API endpoint defers the specified alerts until a specified time. Deferred alerts will not generate notifications until the deferral period expires.\n","operationId":"deferAlerts","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeferAlertsRequest__f61270eea99f"}}},"required":true},"responses":{"202":{"$ref":"#/components/responses/AlertActionResponse__0c2a95c4aa99"},"400":{"$ref":"#/components/responses/BadRequestError__0c2a95c4aa99"},"401":{"$ref":"#/components/responses/Unauthorized__0c2a95c4aa99"},"403":{"$ref":"#/components/responses/Forbidden__0c2a95c4aa99"},"404":{"$ref":"#/components/responses/NotFoundError__0c2a95c4aa99"},"429":{"$ref":"#/components/responses/TooManyRequests__0c2a95c4aa99"},"500":{"$ref":"#/components/responses/InternalServerError__0c2a95c4aa99"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Defer alerts","tags":["Alerts"],"x-source-document":{"file":"MRT/deferalerts.json","metadata":{"info":{"description":"This is a v1 release of the Notification platform APIs.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Notifications","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"APIs for managing alerts.","name":"Alerts"}]},"pathMetadata":{},"sha256":"b499e726cbd8c072d7f11ef175e08dfd79d8d0bf9e23d2d3532a4ede07702b0f"}}},"/network-notifications/v1/alerts/priority":{"post":{"description":"This API endpoint sets the priority level for the specified alerts.\n","operationId":"setPriorityAlerts","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetPriorityAlertsRequest__6c8ef7be4c48"}}},"required":true},"responses":{"202":{"$ref":"#/components/responses/AlertActionResponse__0c2a95c4aa99"},"400":{"$ref":"#/components/responses/BadRequestError__0c2a95c4aa99"},"401":{"$ref":"#/components/responses/Unauthorized__0c2a95c4aa99"},"403":{"$ref":"#/components/responses/Forbidden__0c2a95c4aa99"},"404":{"$ref":"#/components/responses/NotFoundError__0c2a95c4aa99"},"429":{"$ref":"#/components/responses/TooManyRequests__0c2a95c4aa99"},"500":{"$ref":"#/components/responses/InternalServerError__0c2a95c4aa99"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Set alert priority","tags":["Alerts"],"x-source-document":{"file":"MRT/setpriorityalerts.json","metadata":{"info":{"description":"This is a v1 release of the Notification platform APIs.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Notifications","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"APIs for managing alerts.","name":"Alerts"}]},"pathMetadata":{},"sha256":"6941672590e18c121bca19d8e4e331a66f4926fdcbfcb295e31cb19443d29e3d"}}},"/network-notifications/v1/insights":{"get":{"description":"Returns AI-powered recommendations for optimizing performance. For site-level granularity `site-id` and `insight-id` filter shall be provided and for global recommendations `site-id` and `insight-id` filter shall be omitted. At the global level, the API returns global recommendations (across all sites) along with siteId and insightId.","operationId":"getSourceRecommendationsV1","parameters":[{"description":"Site identifier. Omit site-id to retrieve global recommendations across all sites. For site-level recommendations site-id can be obtained from the same API from global recommendations through the field `siteId`.","in":"query","name":"site-id","schema":{"example":"6985764272","type":"string"}},{"description":"Insight identifier. `insight-id` is used to filter recommendations, it can be obtained from the same API from global-level recommendations through the field 'insightId'.","in":"query","name":"insight-id","schema":{"example":"702","type":"string"}},{"description":"Maximum number of recommendations to return per page.","in":"query","name":"limit","schema":{"example":50,"minimum":1,"type":"integer"}},{"description":"Number of recommendations to skip before starting to collect the result set.","in":"query","name":"offset","schema":{"example":0,"minimum":0,"type":"integer"}},{"description":"Sort order for recommendations based on implicit field insight-id.","in":"query","name":"sort","schema":{"enum":["ASC","DESC"],"example":"ASC","type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/SourceRecommendationsResponse__cb479bb6e163"},"400":{"$ref":"#/components/responses/BadRequestError__0c2a95c4aa99"},"401":{"$ref":"#/components/responses/Unauthorized__0c2a95c4aa99"},"403":{"$ref":"#/components/responses/Forbidden__0c2a95c4aa99"},"404":{"$ref":"#/components/responses/NotFoundError__0c2a95c4aa99"},"429":{"$ref":"#/components/responses/TooManyRequests__0c2a95c4aa99"},"500":{"$ref":"#/components/responses/InternalServerError__0c2a95c4aa99"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"List source recommendations","tags":["Insights"],"x-source-document":{"file":"MRT/getsourcerecommendationsv1.json","metadata":{"info":{"description":"This is a v1 release of the Notification platform APIs.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Notifications","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"APIs for retrieving source recommendations.","name":"Insights"}]},"pathMetadata":{},"sha256":"0e8412d5a656c2a61c5b4dafdc53a9e950c5e1750375c9fda91581ea20e412ee"}}},"/network-notifications/v1/insights-schema":{"get":{"description":"Returns the JSON schema definition for one or all available insights.\n\nBehavior:\n- If `insight-id` is provided, returns only the schema for that specific insight.\n- If `insight-id` is omitted, returns schemas for all available insights as a JSON string.","operationId":"getInsightSchemasV1","parameters":[{"description":"Insight type identifier (e.g. `702`). When omitted, all insight schemas are returned. `insight-id` can be obtained from global-level recommendations through the field `insightId`.","in":"query","name":"insight-id","schema":{"example":"702","type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/InsightsSchemasResponse__78ccd937f281"},"400":{"$ref":"#/components/responses/BadRequestError__0c2a95c4aa99"},"401":{"$ref":"#/components/responses/Unauthorized__0c2a95c4aa99"},"403":{"$ref":"#/components/responses/Forbidden__0c2a95c4aa99"},"404":{"$ref":"#/components/responses/NotFoundError__0c2a95c4aa99"},"429":{"$ref":"#/components/responses/TooManyRequests__0c2a95c4aa99"},"500":{"$ref":"#/components/responses/InternalServerError__0c2a95c4aa99"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get insight schemas","tags":["Insights"],"x-source-document":{"file":"MRT/getinsightschemasv1.json","metadata":{"info":{"description":"This is a v1 release of the Notification platform APIs.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Notifications","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"APIs for retrieving source recommendations.","name":"Insights"}]},"pathMetadata":{},"sha256":"4a2e5744cc79a61fef73e5983252c69f9adb2496d91edbdfa1f55bcfc104b88d"}}},"/network-notifications/v1/notification-rules":{"get":{"description":"This API endpoint retrieves the list of notification rules. The notification rules list includes data source and destination channel details.\nNOTE: The source.alerts.alertCount field in responses is a summary count; use getNotificationRuleV1 to retrieve the full list of alertNames","operationId":"getNotificationRulesV1","parameters":[{"in":"query","name":"limit","required":false,"schema":{"$ref":"#/components/schemas/LimitParam__4d16a4598b40"}},{"in":"query","name":"offset","required":false,"schema":{"$ref":"#/components/schemas/OffsetParam__4d16a4598b40"}}],"responses":{"200":{"$ref":"#/components/responses/NotificationRules__4d16a4598b40"},"400":{"$ref":"#/components/responses/BadRequestError__0c2a95c4aa99"},"401":{"$ref":"#/components/responses/Unauthorized__0c2a95c4aa99"},"403":{"$ref":"#/components/responses/Forbidden__0c2a95c4aa99"},"404":{"$ref":"#/components/responses/NotFoundError__0c2a95c4aa99"},"429":{"$ref":"#/components/responses/TooManyRequests__0c2a95c4aa99"},"500":{"$ref":"#/components/responses/InternalServerError__0c2a95c4aa99"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"List all notification rules","tags":["Notification Rules"],"x-source-document":{"file":"MRT/getnotificationrulesv1.json","metadata":{"info":{"description":"This is a v1 release of the Notification platform APIs.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Notifications","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"APIs for managing notification rules.","name":"Notification Rules"}]},"pathMetadata":{},"sha256":"066b617cdd1d71bf0c8a0422d2020e65bbb7faebe181b33ff85b4abfc96aa162"}},"post":{"description":"This API is used to create a notification rule.","operationId":"createNotificationRuleV1","requestBody":{"content":{"application/json":{"schema":{"properties":{"notificationRuleInput":{"$ref":"#/components/schemas/NotificationRuleConfigInput__4e865062885b"}},"type":"object"}}},"required":true},"responses":{"201":{"$ref":"#/components/responses/NotificationRuleCreated__4e865062885b","description":"Notification rule created successfully."},"400":{"$ref":"#/components/responses/BadRequestError__0c2a95c4aa99"},"401":{"$ref":"#/components/responses/Unauthorized__0c2a95c4aa99"},"403":{"$ref":"#/components/responses/Forbidden__0c2a95c4aa99"},"404":{"$ref":"#/components/responses/NotFoundError__0c2a95c4aa99"},"409":{"$ref":"#/components/responses/ConflictError__4e865062885b"},"422":{"$ref":"#/components/responses/UnprocessableEntity__4e865062885b"},"429":{"$ref":"#/components/responses/TooManyRequests__0c2a95c4aa99"},"500":{"$ref":"#/components/responses/InternalServerError__0c2a95c4aa99"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Create a notification rule","tags":["Notification Rules"],"x-source-document":{"file":"MRT/createnotificationrulev1.json","metadata":{"info":{"description":"This is a v1 release of the Notification platform APIs.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Notifications","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"APIs for managing notification rules.","name":"Notification Rules"}]},"pathMetadata":{},"sha256":"4b21cf1a4d61522352e9d32ec0edcb137b1c8a92a3ad7ade7a65cbe08f02801c"}}},"/network-notifications/v1/notification-rules/{id}":{"delete":{"description":"This API is used to delete a notification rule.","operationId":"deleteNotificationRuleV1","parameters":[{"description":"ID of the notification rule.","in":"path","name":"id","required":true,"schema":{"example":"3f96ffea-73fe-4a9b-b253-ddc58c76fe25","maxLength":128,"type":"string"}}],"responses":{"204":{"$ref":"#/components/responses/ResponseWithNoContent__b3ff19dfda7f","description":"Notification rule deleted successfully."},"400":{"$ref":"#/components/responses/BadRequestError__0c2a95c4aa99"},"401":{"$ref":"#/components/responses/Unauthorized__0c2a95c4aa99"},"403":{"$ref":"#/components/responses/Forbidden__0c2a95c4aa99"},"404":{"$ref":"#/components/responses/NotFoundError__0c2a95c4aa99"},"429":{"$ref":"#/components/responses/TooManyRequests__0c2a95c4aa99"},"500":{"$ref":"#/components/responses/InternalServerError__0c2a95c4aa99"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Delete a notification rule","tags":["Notification Rules"],"x-source-document":{"file":"MRT/deletenotificationrulev1.json","metadata":{"info":{"description":"This is a v1 release of the Notification platform APIs.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Notifications","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"APIs for managing notification rules.","name":"Notification Rules"}]},"pathMetadata":{},"sha256":"6f3ca38b11b792ef84011d0dd54056c33e2535f32065f827dcd3869ef0dc9372"}},"get":{"description":"This API endpoint retrieves a notification rule based on the id provided. The notification rule includes data source and destination channel details.","operationId":"getNotificationRuleV1","parameters":[{"description":"ID of the notification rule.","in":"path","name":"id","required":true,"schema":{"example":"3f96ffea-73fe-4a9b-b253-ddc58c76fe25","maxLength":128,"type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/NotificationRule__75a43303d99b"},"400":{"$ref":"#/components/responses/BadRequestError__0c2a95c4aa99"},"401":{"$ref":"#/components/responses/Unauthorized__0c2a95c4aa99"},"403":{"$ref":"#/components/responses/Forbidden__0c2a95c4aa99"},"404":{"$ref":"#/components/responses/NotFoundError__0c2a95c4aa99"},"429":{"$ref":"#/components/responses/TooManyRequests__0c2a95c4aa99"},"500":{"$ref":"#/components/responses/InternalServerError__0c2a95c4aa99"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Retrieve a notification rule by its ID","tags":["Notification Rules"],"x-source-document":{"file":"MRT/getnotificationrulev1.json","metadata":{"info":{"description":"This is a v1 release of the Notification platform APIs.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Notifications","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"APIs for managing notification rules.","name":"Notification Rules"}]},"pathMetadata":{},"sha256":"92eced0bf794f169917ac3399be213a843fc5f82f4f842d64a6890bfb425cdad"}},"patch":{"description":"This API is used to update a notification rule.","operationId":"updateNotificationRuleV1","parameters":[{"description":"ID of the notification rule.","in":"path","name":"id","required":true,"schema":{"example":"3f96ffea-73fe-4a9b-b253-ddc58c76fe25","maxLength":128,"type":"string"}}],"requestBody":{"content":{"application/merge-patch+json":{"schema":{"properties":{"notificationRuleInput":{"$ref":"#/components/schemas/NotificationRuleUpdateInput__76e43b06d0ba"}},"type":"object"}}},"required":true},"responses":{"200":{"$ref":"#/components/responses/NotificationRule__75a43303d99b","description":"Notification rule updated successfully."},"400":{"$ref":"#/components/responses/BadRequestError__0c2a95c4aa99"},"401":{"$ref":"#/components/responses/Unauthorized__0c2a95c4aa99"},"403":{"$ref":"#/components/responses/Forbidden__0c2a95c4aa99"},"404":{"$ref":"#/components/responses/NotFoundError__0c2a95c4aa99"},"409":{"$ref":"#/components/responses/ConflictError__4e865062885b"},"422":{"$ref":"#/components/responses/UnprocessableEntity__4e865062885b"},"429":{"$ref":"#/components/responses/TooManyRequests__0c2a95c4aa99"},"500":{"$ref":"#/components/responses/InternalServerError__0c2a95c4aa99"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Update a notification rule","tags":["Notification Rules"],"x-source-document":{"file":"MRT/updatenotificationrulev1.json","metadata":{"info":{"description":"This is a v1 release of the Notification platform APIs.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Notifications","version":"1.0.0"},"openapi":"3.1.0","tags":[{"description":"APIs for managing notification rules.","name":"Notification Rules"}]},"pathMetadata":{},"sha256":"f06bf94f61d336b256b2e704511a5e9037fc65c34e65ebc48830e656d08a0687"}}},"/network-reporting/v1/reports":{"get":{"description":"This API endpoint returns User Reports filtered by the specified query parameters. Each report contains key details such as ID, name, type, and scope. Use the query parameters to filter results and retrieve only data that matches your specific requirements.","operationId":"listReportsV1","parameters":[{"description":"Search the Report based on Name, Type, Status and Saved By","example":"inventory","in":"query","name":"search","schema":{"type":"string"}},{"description":"OData Version 4.0 filter string (limited functionality). Supports only 'and' conjunction ('or' and 'not' are NOT supported). Supported fields and operators are in the table below.\n\n| Field | Operators |\n| --------- | -------- |\n| `status` (last run status) | `eq` and `in` |\n| `scheduleType` (report schedule type) |`eq` and `in` |\n\n**The operators are implemented as follows:**\n\n* `eq`: Only values exactly matching the given value are returned.\n\n* `in`: Only values present in the given list are returned.\n\n","example":"status in ('ACTIVE', 'COMPLETED', 'FAILED') and scheduleType in ('EVERY_MONTH', 'EVERY_WEEK', 'EVERY_DAY', 'ONE_TIME')","in":"query","name":"filter","schema":{"type":"string"}},{"description":"Sort expressions. Each sort expression is a property name optionally followed by a direction indicator asc (ascending) or desc (descending).\n\nIf a direction indicator is omitted the default direction is ascending.\n\nSupported fields are \n\n| Sort Field                          | Description                          |\n| ----------------------------------- | ------------------------------------ |\n| `name`                              | The name of the report.     |\n| `scope`                             | The specific sites where the report applies. |\n| `type`                              | The type or category of the report (e.g., inventory, client). |\n| `createdBy`                           | User who created the report. |\n| `scheduleType`       | Type of schedule for the report (e.g., recurring, one-time). |\n| `scheduleLastRunTs`          | Timestamp of the last time the report was executed. |\n| `scheduleNextRunTs`          | Timestamp of the next scheduled run for the report. |\n| `scheduleTotalRuns`          | Total number of times the report has been run. |\n| `scheduleEnd`        | The end date or timestamp of the report schedule. |\n\n","example":"scheduleLastRunTs desc","in":"query","name":"sort","schema":{"examples":["name asc","scope asc","type asc","scheduleType desc","scheduleLastRunTs desc","scheduleNextRunTs desc","scheduleTotalRuns desc","createdBy asc","scheduleEnd desc"],"maxLength":256,"type":"string"}},{"description":"Specifies the pagination cursor for the next page of resources. Minimum value is 1.","example":"1","in":"query","name":"next","schema":{"default":"1","type":"string"}},{"description":"Maximum number of reports to be retrieved. Allowed range is 1 to 100.","example":10,"in":"query","name":"limit","schema":{"default":10,"maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"$ref":"#/components/responses/ListReportsResponse__7d827151e05e"},"400":{"$ref":"#/components/responses/BadRequestError__66b457073e9b"},"401":{"$ref":"#/components/responses/Unauthorized__66b457073e9b"},"403":{"$ref":"#/components/responses/Forbidden__66b457073e9b"},"404":{"$ref":"#/components/responses/NotFoundError__66b457073e9b"},"429":{"$ref":"#/components/responses/TooManyRequests__66b457073e9b"},"500":{"$ref":"#/components/responses/InternalServerError__66b457073e9b"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"List Reports","tags":["Reporting"],"x-source-document":{"file":"MRT/listreportsv1.json","metadata":{"info":{"description":"The Reporting APIs for managing `Network Reports`.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Reporting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Reporting APIs to manage network reports","name":"Reporting"}]},"pathMetadata":{},"sha256":"bd0cdc4806e23428ca411e30aadcbf3adc61791c24695dbb1b385bb4fbbe837d"}},"post":{"description":"This API endpoint allows users to generate reports based on report-specific filters, report periods, and scheduling options. Reports can be scheduled for one-time or recurring execution and sent by email in multiple formats.\n\n## General Parameters\n\n| Parameter | Description | Required |\n|-----------|-------------|----------|\n| **name** | Name of the report. | true |\n| **type** | Type of the report. <br> Refer **Report Type** for more details. | true |\n| **timeZone** | User time zone in IANA format (for example, `America/New_York`). | true |\n| **filters** | Filters applied to refine report data. <br> Refer **Report Filter** for more details. | true |\n| **reportPeriod** | Time range defining the report data scope. <br> Refer **Report Period** for more details. | true |\n| **reportSchedule** | Defines how often the report is generated. <br> Refer **Report Schedule** for more details. | true |\n| **email** | Email recipients and report output formats. | false |\n\n## Report Type\n\nThe following report types and filter mappings are derived from Reports Metadata.\n\n| Report Name | Report Type | Supported Filters |\n|-------------|-------------|------------------|\n| Application Analytics | **appAnalytics** | `appCategories`, `connectionType`, `deviceTypes`, `scope`, `sites` |\n| Capacity Planning | **capacityPlanning** | `connectionType`, `deviceTypes`, `excludeDevices`, `gatewayCapacityThreshold`, `gatewayPercentageOfTimeGreaterThanThreshold`, `includeDevices`, `scope`, `sites`, `switchCapacityThreshold`, `switchPercentageOfTimeGreaterThanThreshold` |\n| Client Inventory | **clientInventory** | `connectionType`, `deviceTypes`, `excludeDevices`, `excludeUCClients`, `includeDevices`, `includeUCClients`, `includeUCModelOs`, `includeUCRole`, `includeUCSSIDs`, `includeUCVendor`, `scope`, `sites` |\n| Client Session | **clientSession** | `connectionType`, `deviceTypes`, `excludeDevices`, `excludeUCClients`, `includeDevices`, `includeUCClients`, `includeUCModelOs`, `includeUCRole`, `includeUCSSIDs`, `includeUCVendor`, `scope`, `sites` |\n| Device Uptime | **deviceUptime** | `deviceTypes`, `excludeDevices`, `includeDevices`, `scope`, `sites` |\n| Licenses | **licenses** | `scope` (global only) |\n| MSP Customer (For MSP Customers) | **mspcustomer** | `deviceOwnership`, `scope` (global only) |\n| MSP Inventory (For MSP Customers) | **mspinventory** | `scope` (global only) |\n| MSP License (For MSP Customers) | **msplicense** | `scope` (global only) |\n| MSP Subscription (For MSP Customers) | **mspsubscription** | `scope` (global only) |\n| Network Usage | **networkUsage** | `deviceTypes`, `excludeDevices`, `excludeUCSSIDs`, `includeDevices`, `includeUCSSIDs`, `scope`, `sites` |\n| Resource Utilization | **resourceUtilization** | `apCpuUtilThreshold`, `apMemoryUtilThreshold`, `deviceTypes`, `excludeDevices`, `gatewayCpuUtilThreshold`, `gatewayMemoryUtilThreshold`, `includeDevices`, `scope`, `sites`, `switchCpuUtilThreshold`, `switchMemoryUtilThreshold` |\n| RF Health | **rfHealth** | `excludeDevices`, `includeDevices`, `radioFrequency`, `scope`, `sites` |\n| Security Compliance | **securityCompliance** | `scope` (global only) |\n| Visitor | **visitor** | `scope`, `ssids` |\n| WIDS | **wids** | `scope`, `sites` |\n| Custom | **custom** | Filter support varies with respect to KPI selection. Refer Reports Metadata API |\n\n## Report Filter\n\n| Filter Name | Filter Type | Description | Required |\n|--------|-------------|-------------|----------|\n| Scope | **scope** | Scope filter for report. Allowed values are `global` and `sites`. | true if applicable |\n| Sites | **sites** | Site IDs filter for report. | true if `scope` is `sites` |\n| Device Types | **deviceTypes** | Device type filter. Allowed values: `access_points`, `switches`, `gateways`. | true if applicable |\n| Connection Type | **connectionType** | Connection type filter. Allowed values: `wired`, `wireless`, `all`. | true if applicable |\n| Device Ownership | **deviceOwnership** | Device ownership type filter. Allowed values: `MSP`, `CUSTOMER`. | true if applicable |\n| Application Categories | **appCategories** | Application category filter. Allowed values from metadata (for example, `Any`). | true if applicable |\n| Radio Frequency | **radioFrequency** | Frequency band filter. Allowed values: `2.4GHz`, `5GHz`, `6GHz`. | true if applicable |\n| SSID | **ssids** | SSID values used for visitor reports. | true if applicable |\n| Include Devices | **includeDevices** | Device serial numbers to include in report output. | false |\n| Exclude Devices | **excludeDevices** | Device serial numbers to exclude from report output. | false |\n| Include Unified Clients | **includeUCClients** | Unified client identifiers to include. | false |\n| Exclude Unified Clients | **excludeUCClients** | Unified client identifiers to exclude. | false |\n| Include Unified Client Vendor | **includeUCVendor** | Unified client vendor values to include. | false |\n| Include Unified Client Model/OS | **includeUCModelOs** | Unified client model or OS values to include. | false |\n| Include Unified Client Role | **includeUCRole** | Unified client role values to include. | false |\n| Include Unified Client SSIDs | **includeUCSSIDs** | Unified client SSIDs to include. | false |\n| Exclude Unified Client SSIDs | **excludeUCSSIDs** | Unified client SSIDs to exclude. | false |\n| AP CPU Utilization Threshold | **apCpuUtilThreshold** | AP CPU utilization threshold filter. Range: `0-100` (default: `70`). | false |\n| Switch CPU Utilization Threshold | **switchCpuUtilThreshold** | Switch CPU utilization threshold filter. Range: `0-100` (default: `70`). | false |\n| Gateway CPU Utilization Threshold | **gatewayCpuUtilThreshold** | Gateway CPU utilization threshold filter. Range: `0-100` (default: `70`). | false |\n| AP Memory Utilization Threshold | **apMemoryUtilThreshold** | AP memory utilization threshold filter. Range: `0-100` (default: `70`). | false |\n| Switch Memory Utilization Threshold | **switchMemoryUtilThreshold** | Switch memory utilization threshold filter. Range: `0-100` (default: `70`). | false |\n| Gateway Memory Utilization Threshold | **gatewayMemoryUtilThreshold** | Gateway memory utilization threshold filter. Range: `0-100` (default: `70`). | false |\n| Switch Capacity Threshold | **switchCapacityThreshold** | Switch capacity threshold filter. Range: `0-99` (default: `40`). | false |\n| Switch Percentage Of Time Greater Than Threshold | **switchPercentageOfTimeGreaterThanThreshold** | Percentage of time switch exceeds threshold. Range: `0-99` (default: `25`). | false |\n| Gateway Capacity Threshold | **gatewayCapacityThreshold** | Gateway capacity threshold filter. | false |\n| Gateway Percentage Of Time Greater Than Threshold | **gatewayPercentageOfTimeGreaterThanThreshold** | Percentage of time gateway exceeds threshold. | false |\n\n## Report Period\n\n| Report Period | Allowed Fields | Allowed Schedules |\n|--------------|----------------|------------------|\n| **SNAPSHOT** | None | `ONE_TIME`, `EVERY_DAY`, `EVERY_WEEK`, `EVERY_MONTH` |\n| **LAST_DAY** | `sliceTime` | `ONE_TIME`, `EVERY_DAY` |\n| **LAST_WEEK** | `sliceTime`, `sliceDays` | `ONE_TIME`, `EVERY_WEEK`, `EVERY_MONTH` |\n| **LAST_MONTH** | `sliceTime`, `sliceDays` | `ONE_TIME`, `EVERY_MONTH` |\n| **CUSTOM_RANGE** | `from`, `to` timestamps (without `sliceDays` or `sliceTime`) | `ONE_TIME` |\n\n`sliceTime` and `sliceDays` are applicable only for `resourceUtilization` and `capacityPlanning` report types.\n\n## Report Schedule\n\n| Schedule Type | Required Fields | Applicable Report Periods |\n|--------------|----------------|---------------------------|\n| **ONE_TIME** | None | All report periods |\n| **EVERY_DAY** | `startDate`, `endDate` | `LAST_DAY` |\n| **EVERY_WEEK** | `startDate`, `endDate` | `LAST_WEEK` |\n| **EVERY_MONTH** | `startDate`, `endDate` | `LAST_WEEK`, `LAST_MONTH` |","operationId":"createUserReportV1","requestBody":{"content":{"application/json":{"examples":{"appAnalytics":{"summary":"Application Analytics Report","value":{"report":{"email":{"formats":["CSV","PDF"],"recipients":["user1@mail.com","user2@mail.com"]},"filters":[{"filterType":"scope","values":["global"]},{"filterType":"deviceTypes","values":["access_points"]},{"filterType":"connectionType","values":["wireless"]},{"filterType":"appCategories","values":["Any"]}],"name":"Application Analytics Report","reportPeriod":{"type":"LAST_WEEK"},"reportSchedule":{"endDate":"2025-06-01T00:00:00Z","recurrenceType":"EVERY_WEEK","startDate":"2025-03-01T00:00:00Z"},"timeZone":"America/New_York","type":"appAnalytics"}}},"capacityPlanning":{"summary":"Capacity Planning Report","value":{"report":{"email":{"formats":["CSV","PDF"],"recipients":["user1@mail.com","user2@mail.com"]},"filters":[{"filterType":"scope","values":["global"]},{"filterType":"deviceTypes","values":["switches"]},{"filterType":"connectionType","values":["wired"]},{"filterType":"switchPercentageOfTimeGreaterThanThreshold","values":["55"]},{"filterType":"switchCapacityThreshold","values":["70"]}],"name":"Capacity Planning Report","reportPeriod":{"type":"LAST_MONTH"},"reportSchedule":{"endDate":"2025-06-01T00:00:00Z","recurrenceType":"EVERY_MONTH","startDate":"2025-02-01T00:00:00Z"},"timeZone":"America/New_York","type":"capacityPlanning"}}},"clientInventory":{"summary":"Client Inventory Report","value":{"report":{"filters":[{"filterType":"scope","values":["global"]},{"filterType":"deviceTypes","values":["access_points","switches"]},{"filterType":"connectionType","values":["all"]}],"name":"Client Inventory Report","reportPeriod":{"type":"LAST_DAY"},"reportSchedule":{"endDate":"2025-03-31T00:00:00Z","recurrenceType":"EVERY_DAY","startDate":"2025-03-01T00:00:00Z"},"timeZone":"America/New_York","type":"clientInventory"}}},"clientSession":{"summary":"Client Session Report","value":{"report":{"filters":[{"filterType":"scope","values":["sites"]},{"filterType":"sites","values":["123456"]},{"filterType":"deviceTypes","values":["switches","gateways"]},{"filterType":"connectionType","values":["wired"]}],"name":"Client Session Report","reportPeriod":{"from":"2025-01-01T00:00:00Z","to":"2025-02-01T00:00:00Z","type":"CUSTOM_RANGE"},"reportSchedule":{"recurrenceType":"ONE_TIME"},"timeZone":"America/New_York","type":"clientSession"}}},"custom":{"summary":"Custom Report","value":{"report":{"email":{"formats":["CSV","PDF"],"recipients":["user1@mail.com","user2@mail.com"]},"filters":[{"filterType":"scope","values":["sites"]},{"filterType":"sites","values":["123456"]},{"filterType":"radioFrequency","values":["2.4GHz","5GHz","6GHz"]}],"kpiWidgets":[{"kpiWidget":"sitesByPoorRadios24ghz","renderType":"TABLE"},{"columns":["siteName","timeBreachedChannelQuality","timeBreachedChannelUtilization","timeBreachedFrameDrops"],"kpiWidget":"sitesByPoorRadios5ghz","renderType":"TABLE"}],"name":"Custom Report","reportPeriod":{"type":"LAST_WEEK"},"reportSchedule":{"endDate":"2025-06-01T00:00:00Z","recurrenceType":"EVERY_WEEK","startDate":"2025-03-01T00:00:00Z"},"timeZone":"America/New_York","type":"custom"}}},"deviceUptime":{"summary":"Device Uptime Report","value":{"report":{"email":{"formats":["CSV","PDF"],"recipients":["user1@mail.com","user2@mail.com"]},"filters":[{"filterType":"scope","values":["sites"]},{"filterType":"sites","values":["123456"]},{"filterType":"deviceTypes","values":["gateways"]}],"name":"Device Uptime Report","reportPeriod":{"type":"LAST_DAY"},"reportSchedule":{"recurrenceType":"ONE_TIME"},"timeZone":"America/New_York","type":"deviceUptime"}}},"inventory":{"summary":"Inventory Report","value":{"report":{"email":{"formats":["CSV","PDF"],"recipients":["user1@mail.com","user2@mail.com"]},"filters":[{"filterType":"scope","values":["sites"]},{"filterType":"sites","values":["123456"]},{"filterType":"deviceTypes","values":["switches"]}],"name":"Inventory Report","reportPeriod":{"type":"LAST_WEEK"},"reportSchedule":{"endDate":"2025-06-01T00:00:00Z","recurrenceType":"EVERY_WEEK","startDate":"2025-03-01T00:00:00Z"},"timeZone":"America/New_York","type":"inventory"}}},"networkUsage":{"summary":"Network Usage Report","value":{"report":{"email":{"formats":["CSV","PDF"],"recipients":["user1@mail.com","user2@mail.com"]},"filters":[{"filterType":"scope","values":["sites"]},{"filterType":"sites","values":["123456"]},{"filterType":"deviceTypes","values":["switches"]}],"name":"Network Usage Report","reportPeriod":{"from":"2025-01-01T00:00:00Z","to":"2025-02-01T00:00:00Z","type":"CUSTOM_RANGE"},"reportSchedule":{"recurrenceType":"ONE_TIME"},"timeZone":"America/New_York","type":"networkUsage"}}},"resourceUtilization":{"summary":"Resource Utilization Report","value":{"report":{"email":{"formats":["CSV","PDF"],"recipients":["user1@mail.com","user2@mail.com"]},"filters":[{"filterType":"scope","values":["sites"]},{"filterType":"sites","values":["123456"]},{"filterType":"deviceTypes","values":["access_points","switches","gateways"]},{"filterType":"apMemoryUtilThreshold","values":["80"]},{"filterType":"switchMemoryUtilThreshold","values":["75"]},{"filterType":"gatewayMemoryUtilThreshold","values":["75"]},{"filterType":"apCpuUtilThreshold","values":["80"]},{"filterType":"switchCpuUtilThreshold","values":["75"]},{"filterType":"gatewayCpuUtilThreshold","values":["75"]}],"name":"Resource Utilization Report","reportPeriod":{"sliceDays":["MON","TUE","WED","THU"],"sliceTime":{"from":"01:00","to":"22:00"},"type":"LAST_WEEK"},"reportSchedule":{"endDate":"2025-06-01T00:00:00Z","recurrenceType":"EVERY_WEEK","startDate":"2025-03-01T00:00:00Z"},"timeZone":"America/New_York","type":"resourceUtilization"}}},"rfHealth":{"summary":"RF Health Report","value":{"report":{"email":{"formats":["CSV","PDF"],"recipients":["user1@mail.com","user2@mail.com"]},"filters":[{"filterType":"scope","values":["sites"]},{"filterType":"sites","values":["123456"]},{"filterType":"radioFrequency","values":["2.4GHz","5GHz","6GHz"]}],"name":"RF Health Report","reportPeriod":{"type":"LAST_WEEK"},"reportSchedule":{"endDate":"2025-06-01T00:00:00Z","recurrenceType":"EVERY_WEEK","startDate":"2025-03-01T00:00:00Z"},"timeZone":"America/New_York","type":"rfHealth"}}}},"schema":{"properties":{"report":{"$ref":"#/components/schemas/CreateReportsInput__c34075768619"}},"type":"object"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"description":"Created report resource.","properties":{"report":{"$ref":"#/components/schemas/Report__7d827151e05e"}},"required":["report"],"type":"object"}}},"description":"Successfully created report.","headers":{"Location":{"description":"URI of the created report resource","example":"/network-reporting/v1/reports/13570","schema":{"type":"string"}},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"400":{"$ref":"#/components/responses/BadRequestError__66b457073e9b"},"401":{"$ref":"#/components/responses/Unauthorized__66b457073e9b"},"403":{"$ref":"#/components/responses/Forbidden__66b457073e9b"},"409":{"$ref":"#/components/responses/ConflictError__c34075768619"},"429":{"$ref":"#/components/responses/TooManyRequests__66b457073e9b"},"500":{"$ref":"#/components/responses/InternalServerError__66b457073e9b"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Create Report","tags":["Reporting"],"x-source-document":{"file":"MRT/createuserreportv1.json","metadata":{"info":{"description":"The Reporting APIs for managing `Network Reports`.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Reporting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Reporting APIs to manage network reports","name":"Reporting"}]},"pathMetadata":{},"sha256":"ce2b084d4b2b320176c17234f97c9f095d880b3184bff7b3c8e145fbf86061e8"}}},"/network-reporting/v1/reports-meta":{"get":{"description":"This API endpoint allows users to retrieve reports metadata such as list of kpis, filters applicable for report types. This information is required when creating reports.","operationId":"getReportsMetadataV1","parameters":[{"description":"Report Type of report.","example":"inventory","in":"query","name":"type","required":false,"schema":{"type":"string"}},{"description":"KPI Widget name of reports.","example":"listApDevices","in":"query","name":"kpi-widget","required":false,"schema":{"type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/ReportsMetadataResponse__66b457073e9b"},"400":{"$ref":"#/components/responses/BadRequestError__66b457073e9b"},"401":{"$ref":"#/components/responses/Unauthorized__66b457073e9b"},"403":{"$ref":"#/components/responses/Forbidden__66b457073e9b"},"404":{"$ref":"#/components/responses/NotFoundError__66b457073e9b"},"429":{"$ref":"#/components/responses/TooManyRequests__66b457073e9b"},"500":{"$ref":"#/components/responses/InternalServerError__66b457073e9b"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get Reports Metadata","tags":["Reporting"],"x-source-document":{"file":"MRT/getreportsmetadatav1.json","metadata":{"info":{"description":"The Reporting APIs for managing `Network Reports`.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Reporting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Reporting APIs to manage network reports","name":"Reporting"}]},"pathMetadata":{},"sha256":"02f3017930956b01e90d0c2aff0207389343c0a6d07b7b23f5397440e0045f89"}}},"/network-reporting/v1/reports/{report-id}":{"delete":{"description":"This API endpoint deletes particular user report with report ID, it will also delete associated report runs in the process of deleting report. Report ID can be obtained from **List Reports API**.","operationId":"deleteUserReportV1","parameters":[{"description":"The unique identifier of the user report.","example":"1","in":"path","name":"report-id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"status":{"examples":["Success"],"type":"string"}},"type":"object"}}},"description":"Successfully deleted user report.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"400":{"$ref":"#/components/responses/BadRequestError__66b457073e9b"},"401":{"$ref":"#/components/responses/Unauthorized__66b457073e9b"},"403":{"$ref":"#/components/responses/Forbidden__66b457073e9b"},"404":{"$ref":"#/components/responses/NotFoundError__66b457073e9b"},"429":{"$ref":"#/components/responses/TooManyRequests__66b457073e9b"},"500":{"$ref":"#/components/responses/InternalServerError__66b457073e9b"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Delete Report","tags":["Reporting"],"x-source-document":{"file":"MRT/deleteuserreportv1.json","metadata":{"info":{"description":"The Reporting APIs for managing `Network Reports`.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Reporting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Reporting APIs to manage network reports","name":"Reporting"}]},"pathMetadata":{},"sha256":"2fb2465d43b070fb24c2be63a12cca8e52f67314e8992be40095cb8f45a38583"}},"get":{"description":"This API endpoint retrieves a specific user report by report ID. Report ID can be obtained from **List Reports API** or will be in **Create Report API** response.","operationId":"getUserReportV1","parameters":[{"description":"The unique identifier of the user report.","example":"13570","in":"path","name":"report-id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Report__7d827151e05e"}}},"description":"Successfully retrieved user report.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"400":{"$ref":"#/components/responses/BadRequestError__66b457073e9b"},"401":{"$ref":"#/components/responses/Unauthorized__66b457073e9b"},"403":{"$ref":"#/components/responses/Forbidden__66b457073e9b"},"404":{"$ref":"#/components/responses/NotFoundError__66b457073e9b"},"429":{"$ref":"#/components/responses/TooManyRequests__66b457073e9b"},"500":{"$ref":"#/components/responses/InternalServerError__66b457073e9b"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get Report","tags":["Reporting"],"x-source-document":{"file":"MRT/getuserreportv1.json","metadata":{"info":{"description":"The Reporting APIs for managing `Network Reports`.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Reporting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Reporting APIs to manage network reports","name":"Reporting"}]},"pathMetadata":{},"sha256":"1f2e81f822b3d69be35f4f9bcdcbe1b8256e740c29c33bc0d6da0c0d2c8a04bb"}},"put":{"description":"This API endpoint updates a User Report with a report ID. Report ID can be obtained from **List Reports API**.","operationId":"updateUserReportV1","parameters":[{"description":"The unique identifier of the user report.","example":"1","in":"path","name":"report-id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"email":{"properties":{"formats":{"$ref":"#/components/schemas/ReportFormats__70734de364b7"},"recipients":{"$ref":"#/components/schemas/Emails__70734de364b7"}},"type":"object"},"name":{"$ref":"#/components/schemas/Name__70734de364b7"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"id":{"examples":["1"],"type":"string"},"status":{"examples":["Success"],"type":"string"}},"type":"object"}}},"description":"Successfully updated the report with given report id.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"400":{"$ref":"#/components/responses/BadRequestError__66b457073e9b"},"401":{"$ref":"#/components/responses/Unauthorized__66b457073e9b"},"403":{"$ref":"#/components/responses/Forbidden__66b457073e9b"},"404":{"$ref":"#/components/responses/NotFoundError__66b457073e9b"},"429":{"$ref":"#/components/responses/TooManyRequests__66b457073e9b"},"500":{"$ref":"#/components/responses/InternalServerError__66b457073e9b"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Update Report","tags":["Reporting"],"x-source-document":{"file":"MRT/updateuserreportv1.json","metadata":{"info":{"description":"The Reporting APIs for managing `Network Reports`.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Reporting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Reporting APIs to manage network reports","name":"Reporting"}]},"pathMetadata":{},"sha256":"5e698c806d98f4c2ff80e7c1c4f132b5970edfe212d1399edc5b6eb8cb5e1bc5"}}},"/network-reporting/v1/reports/{report-id}/report-runs":{"get":{"description":"This API endpoint retrieves report execution history for a specific report ID. Each report run contains execution details including run ID, status, export data, and start/end timestamps. Obtain the required report ID from the List Reports API.","operationId":"listReportRunsV1","parameters":[{"description":"The unique identifier of the user report.","example":"1","in":"path","name":"report-id","required":true,"schema":{"type":"string"}},{"description":"Sort expression. Each sort expression is a property name optionally followed by a direction indicator asc (ascending) or desc (descending).\n\n If a direction indicator is omitted the default direction is ascending.\n\nSupported fields are `modifiedAt` and `status`.\n\n The field `modifiedAt` denotes last modified timestamp of the report run and `status` indicates report run current state - New, Running, Failed or Successful.","example":"modifiedAt desc","in":"query","name":"sort","required":false,"schema":{"examples":["modifiedAt desc, status desc"],"maxLength":256,"type":"string"}},{"description":"Specifies the pagination cursor for the next page of resources. Minimum value is 1.","example":"1","in":"query","name":"next","schema":{"default":"1","type":"string"}},{"description":"Maximum number of report runs to be returned. Allowed range is 1 to 100.","example":10,"in":"query","name":"limit","schema":{"default":10,"maximum":100,"minimum":1,"type":"integer"}}],"responses":{"200":{"$ref":"#/components/responses/ListReportRunsResponse__c419fe321fd2"},"400":{"$ref":"#/components/responses/BadRequestError__66b457073e9b"},"401":{"$ref":"#/components/responses/Unauthorized__66b457073e9b"},"403":{"$ref":"#/components/responses/Forbidden__66b457073e9b"},"404":{"$ref":"#/components/responses/NotFoundError__66b457073e9b"},"429":{"$ref":"#/components/responses/TooManyRequests__66b457073e9b"},"500":{"$ref":"#/components/responses/InternalServerError__66b457073e9b"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"List Report Runs","tags":["Reporting"],"x-source-document":{"file":"MRT/listreportrunsv1.json","metadata":{"info":{"description":"The Reporting APIs for managing `Network Reports`.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Reporting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Reporting APIs to manage network reports","name":"Reporting"}]},"pathMetadata":{},"sha256":"00f3d5c9a1288f9403b0ee30c945b0807081523e419db8f00727d6578f0c285d"}}},"/network-reporting/v1/reports/{report-id}/report-runs/{report-run-id}":{"delete":{"description":"This API endpoint deletes particular report runs with report run ID. Report ID can be obtained from **List Reports API** and Report run ID can be obtained from **List Report Runs API**.","operationId":"deleteReportRunV1","parameters":[{"description":"The unique identifier of the user report.","example":"1","in":"path","name":"report-id","required":true,"schema":{"type":"string"}},{"description":"The unique identifier of the report run.","example":"1","in":"path","name":"report-run-id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"status":{"examples":["Success"],"type":"string"}},"type":"object"}}},"description":"Status of report run deletion.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"400":{"$ref":"#/components/responses/BadRequestError__66b457073e9b"},"401":{"$ref":"#/components/responses/Unauthorized__66b457073e9b"},"403":{"$ref":"#/components/responses/Forbidden__66b457073e9b"},"404":{"$ref":"#/components/responses/NotFoundError__66b457073e9b"},"429":{"$ref":"#/components/responses/TooManyRequests__66b457073e9b"},"500":{"$ref":"#/components/responses/InternalServerError__66b457073e9b"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Delete Report Run","tags":["Reporting"],"x-source-document":{"file":"MRT/deletereportrunv1.json","metadata":{"info":{"description":"The Reporting APIs for managing `Network Reports`.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Reporting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Reporting APIs to manage network reports","name":"Reporting"}]},"pathMetadata":{},"sha256":"87914f6c5a11d23b922a03e2becb4f597d1a9993a9749a121c90139b84caaade"}}},"/network-reporting/v1/reports/{report-id}/report-runs/{report-run-id}/download-link":{"post":{"description":"This API endpoint allows users to retrieve a downloadable link for a previously generated report run. Users can specify the export file format (CSV or PDF) by providing the appropriate `exportType` parameter in the request body. The response will contain the file's download URL, MIME type (application/zip for CSV file format and application/pdf for PDF file format), and the suggested file name for the report. Report ID can be obtained from **List Reports API** and Report run ID can be obtained from **List Report Runs API**.","operationId":"downloadReportLinkV1","parameters":[{"description":"The unique identifier of the user report.","example":"1","in":"path","name":"report-id","required":true,"schema":{"type":"string"}},{"description":"The unique identifier of the report run","example":"1","in":"path","name":"report-run-id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"exportType":"CSV"},"schema":{"properties":{"exportType":{"$ref":"#/components/schemas/ReportFormat__70734de364b7","description":"export file format"}},"required":["exportType"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"fileName":{"examples":["report.zip"],"type":"string"},"mimeType":{"examples":["application/zip","application/pdf"],"type":"string"},"url":{"examples":["https://download-url/report"],"type":"string"}},"required":["fileName","mimeType","url"],"type":"object"}}},"description":"Successfully generated report download link.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"400":{"$ref":"#/components/responses/BadRequestError__66b457073e9b"},"401":{"$ref":"#/components/responses/Unauthorized__66b457073e9b"},"403":{"$ref":"#/components/responses/Forbidden__66b457073e9b"},"404":{"$ref":"#/components/responses/NotFoundError__66b457073e9b"},"429":{"$ref":"#/components/responses/TooManyRequests__66b457073e9b"},"500":{"$ref":"#/components/responses/InternalServerError__66b457073e9b"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get Download Report Link","tags":["Reporting"],"x-source-document":{"file":"MRT/downloadreportlinkv1.json","metadata":{"info":{"description":"The Reporting APIs for managing `Network Reports`.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Reporting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Reporting APIs to manage network reports","name":"Reporting"}]},"pathMetadata":{},"sha256":"630e66dc6a8666694d91e14d96bf57bed96ad28bc29de81ca50613150c5fb2c1"}}},"/network-services/v1/airmatch-ap":{"get":{"description":"Returns AP Information for all APs for a given tenant","operationId":"listApsV1","parameters":[{"description":"Offset for pagination of results","example":0,"in":"query","name":"offset","schema":{"default":0,"minimum":0,"type":"integer"}},{"description":"Limit for pagination of results","example":100,"in":"query","name":"limit","schema":{"default":500,"maximum":500,"minimum":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ap_info_all__3ad71c0ba798"}}},"description":"Successful operation","headers":{"X-RateLimit-Limit":{"description":"The maximum number of requests allowed per time window","schema":{"$ref":"#/components/schemas/X-RateLimit-Limit__01cfa36ad727"}},"X-RateLimit-Remaining":{"description":"The number of requests remaining in the current time window","schema":{"$ref":"#/components/schemas/X-RateLimit-Remaining__01cfa36ad727"}},"X-RateLimit-Reset":{"description":"The time at which the current rate limit window resets","schema":{"$ref":"#/components/schemas/X-RateLimit-Reset__01cfa36ad727"}}}},"400":{"$ref":"#/components/responses/BadRequest__01cfa36ad727"},"401":{"$ref":"#/components/responses/Unauthorized__000172564380"},"403":{"$ref":"#/components/responses/ForbiddenRequest__01cfa36ad727"},"404":{"$ref":"#/components/responses/NotFound__01cfa36ad727"},"429":{"$ref":"#/components/responses/TooManyRequests__000172564380"},"500":{"$ref":"#/components/responses/InternalServerError__000172564380"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get AP information for all APs of a tenant","tags":["AirMatch"],"x-source-document":{"file":"MRT/listapsv1.json","metadata":{"info":{"description":"Serves Wi-Fi client locations with filtering options available.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Services","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Operations related to AirMatch Services","name":"AirMatch"}]},"pathMetadata":{},"sha256":"dd22967da651e01f83b3ad8174485fc87f265d77f36d6434ff6eaccd9b908e8d"}}},"/network-services/v1/airmatch-ap-coverage-plan":{"get":{"description":"Returns all AP Coverage Plan documents for a given tenant","operationId":"listApCoveragePlansV1","parameters":[{"description":"Request ID filter to return specific AP Coverage Plan using request id provided by user in query parameter","example":["1fb6908c-25a6-4c9d-91ec-0b8e8aa394a2"],"explode":true,"in":"query","name":"id","schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Limit for pagination of results","example":100,"in":"query","name":"limit","schema":{"default":500,"maximum":500,"minimum":0,"type":"integer"}},{"description":"Offset for pagination of results","example":0,"in":"query","name":"offset","schema":{"default":0,"minimum":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ap_coverage_plan_all__0605cf9c5e30"}}},"description":"Successful operation","headers":{"X-RateLimit-Limit":{"description":"The maximum number of requests allowed per time window","schema":{"$ref":"#/components/schemas/X-RateLimit-Limit__01cfa36ad727"}},"X-RateLimit-Remaining":{"description":"The number of requests remaining in the current time window","schema":{"$ref":"#/components/schemas/X-RateLimit-Remaining__01cfa36ad727"}},"X-RateLimit-Reset":{"description":"The time at which the current rate limit window resets","schema":{"$ref":"#/components/schemas/X-RateLimit-Reset__01cfa36ad727"}}}},"400":{"$ref":"#/components/responses/BadRequest__01cfa36ad727"},"401":{"$ref":"#/components/responses/Unauthorized__000172564380"},"403":{"$ref":"#/components/responses/ForbiddenRequest__01cfa36ad727"},"404":{"$ref":"#/components/responses/NotFound__01cfa36ad727"},"429":{"$ref":"#/components/responses/TooManyRequests__000172564380"},"500":{"$ref":"#/components/responses/InternalServerError__000172564380"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get all AP coverage plan from collection","tags":["AirMatch"],"x-source-document":{"file":"MRT/listapcoverageplansv1.json","metadata":{"info":{"description":"Serves Wi-Fi client locations with filtering options available.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Services","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Operations related to AirMatch Services","name":"AirMatch"}]},"pathMetadata":{},"sha256":"da5837a0a2376b54623cd86659ed746651f801be4eb10d09693bb44d6ff978d8"}}},"/network-services/v1/airmatch-ap-coverage-plan/{serial-number}":{"get":{"description":"Returns AP Coverage Plan for a given AP Serial Number for a tenant","operationId":"getApCoveragePlanV1","parameters":[{"description":"AP Serial Number filter to get AP Coverage Plan","example":"CNHHJ0Y0TK","in":"path","name":"serial-number","required":true,"schema":{"type":"string"}},{"description":"Request ID filter to return specific AP Coverage Plan using request id provided by user in query parameter","example":["1fb6908c-25a6-4c9d-91ec-0b8e8aa394a2"],"explode":true,"in":"query","name":"id","schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Limit for pagination of results","example":100,"in":"query","name":"limit","schema":{"default":500,"maximum":500,"minimum":0,"type":"integer"}},{"description":"Offset for pagination of results","example":0,"in":"query","name":"offset","schema":{"default":0,"minimum":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ap_coverage_plan__0605cf9c5e30"}}},"description":"Successful operation","headers":{"X-RateLimit-Limit":{"description":"The maximum number of requests allowed per time window","schema":{"$ref":"#/components/schemas/X-RateLimit-Limit__01cfa36ad727"}},"X-RateLimit-Remaining":{"description":"The number of requests remaining in the current time window","schema":{"$ref":"#/components/schemas/X-RateLimit-Remaining__01cfa36ad727"}},"X-RateLimit-Reset":{"description":"The time at which the current rate limit window resets","schema":{"$ref":"#/components/schemas/X-RateLimit-Reset__01cfa36ad727"}}}},"400":{"$ref":"#/components/responses/BadRequest__01cfa36ad727"},"401":{"$ref":"#/components/responses/Unauthorized__000172564380"},"403":{"$ref":"#/components/responses/ForbiddenRequest__01cfa36ad727"},"404":{"$ref":"#/components/responses/NotFound__01cfa36ad727"},"429":{"$ref":"#/components/responses/TooManyRequests__000172564380"},"500":{"$ref":"#/components/responses/InternalServerError__000172564380"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get ap coverage plan for a given AP serial number","tags":["AirMatch"],"x-source-document":{"file":"MRT/getapcoverageplanv1.json","metadata":{"info":{"description":"Serves Wi-Fi client locations with filtering options available.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Services","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Operations related to AirMatch Services","name":"AirMatch"}]},"pathMetadata":{},"sha256":"1adab0ec16d4d9f9c41d2d85c1366c9835d79c91e3a4680fb8c21161a1791cba"}}},"/network-services/v1/airmatch-ap-neighbor-list/{serial-number}":{"get":{"description":"Get list of AP neighbors in the form of AP Serial Numbers for a given AP Serial Number for a tenant","operationId":"getApNeighborsV1","parameters":[{"description":"AP Serial Number used to look up list of AP neighbors for that AP Serial Number","example":"CNN9KD5MFX","in":"path","name":"serial-number","required":true,"schema":{"type":"string"}},{"description":"Number of AP serial numbers to get (max. 500)","example":100,"in":"query","name":"limit","schema":{"default":500,"maximum":500,"minimum":0,"type":"integer"}},{"description":"Neighbors up to this max pathloss (max. 150)","example":105,"in":"query","name":"cutoff","schema":{"maximum":150,"type":"integer"}},{"description":"Offset for pagination of results","example":0,"in":"query","name":"offset","schema":{"default":0,"minimum":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ap_neighbor_list__05ea522bb3f0"}}},"description":"Successful operation","headers":{"X-RateLimit-Limit":{"description":"The maximum number of requests allowed per time window","schema":{"$ref":"#/components/schemas/X-RateLimit-Limit__01cfa36ad727"}},"X-RateLimit-Remaining":{"description":"The number of requests remaining in the current time window","schema":{"$ref":"#/components/schemas/X-RateLimit-Remaining__01cfa36ad727"}},"X-RateLimit-Reset":{"description":"The time at which the current rate limit window resets","schema":{"$ref":"#/components/schemas/X-RateLimit-Reset__01cfa36ad727"}}}},"400":{"$ref":"#/components/responses/BadRequest__01cfa36ad727"},"401":{"$ref":"#/components/responses/Unauthorized__000172564380"},"403":{"$ref":"#/components/responses/ForbiddenRequest__01cfa36ad727"},"404":{"$ref":"#/components/responses/NotFound__01cfa36ad727"},"429":{"$ref":"#/components/responses/TooManyRequests__000172564380"},"500":{"$ref":"#/components/responses/InternalServerError__000172564380"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get list of AP neighbors for a given AP serial number","tags":["AirMatch"],"x-source-document":{"file":"MRT/getapneighborsv1.json","metadata":{"info":{"description":"Serves Wi-Fi client locations with filtering options available.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Services","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Operations related to AirMatch Services","name":"AirMatch"}]},"pathMetadata":{},"sha256":"f1b0d2a4dfe7d25f1bb146c7dd5d4999356fa7696765f721ef080b78663ab4b6"}}},"/network-services/v1/airmatch-ap-radio-relations/{serial-number}":{"get":{"description":"Returns AP Radio Relations Information for a specific AP based on its AP Serial number","operationId":"getApRadioRelationsV1","parameters":[{"description":"AP Serial number to query radio relations for that AP","example":"CNN9KD5NFX","in":"path","name":"serial-number","required":true,"schema":{"type":"string"}},{"description":"Limit for pagination of results","example":100,"in":"query","name":"limit","schema":{"default":500,"maximum":500,"minimum":0,"type":"integer"}},{"description":"Offset for pagination of results","example":0,"in":"query","name":"offset","schema":{"default":0,"minimum":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ap_radio_relations__1fd78b473a9f"}}},"description":"Successful operation","headers":{"X-RateLimit-Limit":{"description":"The maximum number of requests allowed per time window","schema":{"$ref":"#/components/schemas/X-RateLimit-Limit__01cfa36ad727"}},"X-RateLimit-Remaining":{"description":"The number of requests remaining in the current time window","schema":{"$ref":"#/components/schemas/X-RateLimit-Remaining__01cfa36ad727"}},"X-RateLimit-Reset":{"description":"The time at which the current rate limit window resets","schema":{"$ref":"#/components/schemas/X-RateLimit-Reset__01cfa36ad727"}}}},"400":{"$ref":"#/components/responses/BadRequest__01cfa36ad727"},"401":{"$ref":"#/components/responses/Unauthorized__000172564380"},"403":{"$ref":"#/components/responses/ForbiddenRequest__01cfa36ad727"},"404":{"$ref":"#/components/responses/NotFound__01cfa36ad727"},"429":{"$ref":"#/components/responses/TooManyRequests__000172564380"},"500":{"$ref":"#/components/responses/InternalServerError__000172564380"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get AP radio relations from edge document","tags":["AirMatch"],"x-source-document":{"file":"MRT/getapradiorelationsv1.json","metadata":{"info":{"description":"Serves Wi-Fi client locations with filtering options available.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Services","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Operations related to AirMatch Services","name":"AirMatch"}]},"pathMetadata":{},"sha256":"880b5ffbafdb74f3090217b082f4b1c0ed7f0811fceb2383380ab1151f8dcb5f"}}},"/network-services/v1/airmatch-ap/{serial-number}":{"get":{"description":"Returns Access Point (AP) Information based on its Serial number for a given tenant","operationId":"getApV1","parameters":[{"description":"AP Serial number to look up information for that AP","example":"CNHHJ0Y0TK","in":"path","name":"serial-number","required":true,"schema":{"type":"string"}},{"description":"Limit for pagination of results","example":100,"in":"query","name":"limit","schema":{"default":500,"maximum":500,"minimum":0,"type":"integer"}},{"description":"Offset for pagination of results","example":0,"in":"query","name":"offset","schema":{"default":0,"minimum":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ap_info__3ad71c0ba798"}}},"description":"Successful operation","headers":{"X-RateLimit-Limit":{"description":"The maximum number of requests allowed per time window","schema":{"$ref":"#/components/schemas/X-RateLimit-Limit__01cfa36ad727"}},"X-RateLimit-Remaining":{"description":"The number of requests remaining in the current time window","schema":{"$ref":"#/components/schemas/X-RateLimit-Remaining__01cfa36ad727"}},"X-RateLimit-Reset":{"description":"The time at which the current rate limit window resets","schema":{"$ref":"#/components/schemas/X-RateLimit-Reset__01cfa36ad727"}}}},"400":{"$ref":"#/components/responses/BadRequest__01cfa36ad727"},"401":{"$ref":"#/components/responses/Unauthorized__000172564380"},"403":{"$ref":"#/components/responses/ForbiddenRequest__01cfa36ad727"},"404":{"$ref":"#/components/responses/NotFound__01cfa36ad727"},"429":{"$ref":"#/components/responses/TooManyRequests__000172564380"},"500":{"$ref":"#/components/responses/InternalServerError__000172564380"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get AP information of a specific AP Ethernet MAC","tags":["AirMatch"],"x-source-document":{"file":"MRT/getapv1.json","metadata":{"info":{"description":"Serves Wi-Fi client locations with filtering options available.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Services","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Operations related to AirMatch Services","name":"AirMatch"}]},"pathMetadata":{},"sha256":"49afa94f596cb5e524233c414b072731f396cfb1862916a2d0d13516720da532"}}},"/network-services/v1/airmatch-board-limit/{serial-number}/{radio-mac}":{"get":{"description":"Returns Board limits of the radio for a given tenant","operationId":"getBoardLimitsV1","parameters":[{"description":"AP Serial","example":"CNP5L8M00Z","in":"path","name":"serial-number","required":true,"schema":{"type":"string"}},{"description":"Radio MAC","example":"D8:C7:C8:11:22:33","in":"path","name":"radio-mac","required":true,"schema":{"pattern":"^([0-9A-Fa-f]{2}[:]){5}([0-9A-Fa-f]{2})$","type":"string"}},{"description":"Limit for pagination of results","example":100,"in":"query","name":"limit","schema":{"default":500,"maximum":500,"minimum":0,"type":"integer"}},{"description":"Offset for pagination of results","example":0,"in":"query","name":"offset","schema":{"default":0,"minimum":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/board_limit__bdffbcf1590c"}}},"description":"Successful operation","headers":{"X-RateLimit-Limit":{"description":"The maximum number of requests allowed per time window","schema":{"$ref":"#/components/schemas/X-RateLimit-Limit__01cfa36ad727"}},"X-RateLimit-Remaining":{"description":"The number of requests remaining in the current time window","schema":{"$ref":"#/components/schemas/X-RateLimit-Remaining__01cfa36ad727"}},"X-RateLimit-Reset":{"description":"The time at which the current rate limit window resets","schema":{"$ref":"#/components/schemas/X-RateLimit-Reset__01cfa36ad727"}}}},"400":{"$ref":"#/components/responses/BadRequest__01cfa36ad727"},"401":{"$ref":"#/components/responses/Unauthorized__000172564380"},"403":{"$ref":"#/components/responses/ForbiddenRequest__01cfa36ad727"},"404":{"$ref":"#/components/responses/NotFound__01cfa36ad727"},"429":{"$ref":"#/components/responses/TooManyRequests__000172564380"},"500":{"$ref":"#/components/responses/InternalServerError__000172564380"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get board limits of a specific radio MAC for a given tenant","tags":["AirMatch"],"x-source-document":{"file":"MRT/getboardlimitsv1.json","metadata":{"info":{"description":"Serves Wi-Fi client locations with filtering options available.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Services","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Operations related to AirMatch Services","name":"AirMatch"}]},"pathMetadata":{},"sha256":"071026807964735dbcc7cb36f59a5043f753b88a6e1d41b12400ec93e40448ff"}}},"/network-services/v1/airmatch-device-config/{serial-number}":{"get":{"description":"Returns Device Configuration for a specific AP Serial number for a given tenant","operationId":"getDeviceConfigV1","parameters":[{"description":"AP Serial Num to get Device Config for","example":"CNN9KD5NFX","in":"path","name":"serial-number","required":true,"schema":{"type":"string"}},{"description":"Limit for pagination of results","example":100,"in":"query","name":"limit","schema":{"default":500,"maximum":500,"minimum":0,"type":"integer"}},{"description":"Offset for pagination of results","example":0,"in":"query","name":"offset","schema":{"default":0,"minimum":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/device_config__c0214e3e4937"}}},"description":"Successful operation","headers":{"X-RateLimit-Limit":{"description":"The maximum number of requests allowed per time window","schema":{"$ref":"#/components/schemas/X-RateLimit-Limit__01cfa36ad727"}},"X-RateLimit-Remaining":{"description":"The number of requests remaining in the current time window","schema":{"$ref":"#/components/schemas/X-RateLimit-Remaining__01cfa36ad727"}},"X-RateLimit-Reset":{"description":"The time at which the current rate limit window resets","schema":{"$ref":"#/components/schemas/X-RateLimit-Reset__01cfa36ad727"}}}},"400":{"$ref":"#/components/responses/BadRequest__01cfa36ad727"},"401":{"$ref":"#/components/responses/Unauthorized__000172564380"},"403":{"$ref":"#/components/responses/ForbiddenRequest__01cfa36ad727"},"404":{"$ref":"#/components/responses/NotFound__01cfa36ad727"},"429":{"$ref":"#/components/responses/TooManyRequests__000172564380"},"500":{"$ref":"#/components/responses/InternalServerError__000172564380"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Returns Device (AP) Configuration for a specific AP Serial number","tags":["AirMatch"],"x-source-document":{"file":"MRT/getdeviceconfigv1.json","metadata":{"info":{"description":"Serves Wi-Fi client locations with filtering options available.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Services","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Operations related to AirMatch Services","name":"AirMatch"}]},"pathMetadata":{},"sha256":"61736987f40046899532479d40f876a31ad9cb372f7280b78e513eee0d8b4bc6"}}},"/network-services/v1/airmatch-global-config-id":{"get":{"description":"Returns the global configuration ID for the tenant","operationId":"getGlobalConfigIdV1","parameters":[{"description":"Limit for pagination of results","example":100,"in":"query","name":"limit","schema":{"default":500,"maximum":500,"minimum":0,"type":"integer"}},{"description":"Offset for pagination of results","example":0,"in":"query","name":"offset","schema":{"default":0,"minimum":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/config_id__a5d2a68229f0"}}},"description":"Successful operation","headers":{"X-RateLimit-Limit":{"description":"The maximum number of requests allowed per time window","schema":{"$ref":"#/components/schemas/X-RateLimit-Limit__01cfa36ad727"}},"X-RateLimit-Remaining":{"description":"The number of requests remaining in the current time window","schema":{"$ref":"#/components/schemas/X-RateLimit-Remaining__01cfa36ad727"}},"X-RateLimit-Reset":{"description":"The time at which the current rate limit window resets","schema":{"$ref":"#/components/schemas/X-RateLimit-Reset__01cfa36ad727"}}}},"400":{"$ref":"#/components/responses/BadRequest__01cfa36ad727"},"401":{"$ref":"#/components/responses/Unauthorized__000172564380"},"403":{"$ref":"#/components/responses/ForbiddenRequest__01cfa36ad727"},"404":{"$ref":"#/components/responses/NotFound__01cfa36ad727"},"429":{"$ref":"#/components/responses/TooManyRequests__000172564380"},"500":{"$ref":"#/components/responses/InternalServerError__000172564380"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Returns the global configuration ID for the tenant","tags":["AirMatch"],"x-source-document":{"file":"MRT/getglobalconfigidv1.json","metadata":{"info":{"description":"Serves Wi-Fi client locations with filtering options available.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Services","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Operations related to AirMatch Services","name":"AirMatch"}]},"pathMetadata":{},"sha256":"b9a0ae2620d4958f62d378695e76492b04e4ea688c0d7156bf8986f09b470eb2"}}},"/network-services/v1/airmatch-history/{radio-mac}":{"get":{"description":"Returns Radio History events for a specific Radio MAC address for a given tenant","operationId":"getRadioHistoryV1","parameters":[{"description":"Radio MAC address to look up list of radio history events for that radio","example":"D8:C7:C8:11:22:33","in":"path","name":"radio-mac","required":true,"schema":{"pattern":"^([0-9A-Fa-f]{2}[:]){5}([0-9A-Fa-f]{2})$","type":"string"}},{"description":"Timestamp of oldest Radio History to start query result","example":"2017-07-21T17:32:28-0700","in":"query","name":"start-at","schema":{"format":"date-time","type":"string"}},{"description":"Timestamp of newest Radio History to end query result","example":"2017-07-21T17:32:28-0700","in":"query","name":"end-at","schema":{"format":"date-time","type":"string"}},{"description":"Limit for pagination of results","example":100,"in":"query","name":"limit","schema":{"default":500,"maximum":500,"minimum":0,"type":"integer"}},{"description":"Offset for pagination of results","example":0,"in":"query","name":"offset","schema":{"default":0,"minimum":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/history__e5ceeb20c3e5"}}},"description":"Successful operation","headers":{"X-RateLimit-Limit":{"description":"The maximum number of requests allowed per time window","schema":{"$ref":"#/components/schemas/X-RateLimit-Limit__01cfa36ad727"}},"X-RateLimit-Remaining":{"description":"The number of requests remaining in the current time window","schema":{"$ref":"#/components/schemas/X-RateLimit-Remaining__01cfa36ad727"}},"X-RateLimit-Reset":{"description":"The time at which the current rate limit window resets","schema":{"$ref":"#/components/schemas/X-RateLimit-Reset__01cfa36ad727"}}}},"400":{"$ref":"#/components/responses/BadRequest__01cfa36ad727"},"401":{"$ref":"#/components/responses/Unauthorized__000172564380"},"403":{"$ref":"#/components/responses/ForbiddenRequest__01cfa36ad727"},"404":{"$ref":"#/components/responses/NotFound__01cfa36ad727"},"429":{"$ref":"#/components/responses/TooManyRequests__000172564380"},"500":{"$ref":"#/components/responses/InternalServerError__000172564380"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get radio history of a specific Radio MAC","tags":["AirMatch"],"x-source-document":{"file":"MRT/getradiohistoryv1.json","metadata":{"info":{"description":"Serves Wi-Fi client locations with filtering options available.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Services","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Operations related to AirMatch Services","name":"AirMatch"}]},"pathMetadata":{},"sha256":"89445ffa6479344571a41984e882cd43f3e374b0f186b25f2f42cf737ae86199"}}},"/network-services/v1/airmatch-non-friend/{radio-mac}":{"get":{"description":"Returns list of non friend (non-neighbor) radios for that radio mac for a given tenant","operationId":"getNonFriendsV1","parameters":[{"description":"Reporting MAC address to look up list of non friend (non-neighbor) radios","example":"D8:C7:C8:11:22:33","in":"path","name":"radio-mac","required":true,"schema":{"pattern":"^([0-9A-Fa-f]{2}[:]){5}([0-9A-Fa-f]{2})$","type":"string"}},{"description":"Timestamp of oldest Pathloss to start query result","example":"2017-07-22T00:32:28.000Z","in":"query","name":"start-at","schema":{"format":"date-time","type":"string"}},{"description":"Timestamp of newest Pathloss to end query result","example":"2017-07-22T00:32:28.000Z","in":"query","name":"end-at","schema":{"format":"date-time","type":"string"}},{"description":"Limit for pagination of results","example":100,"in":"query","name":"limit","schema":{"default":500,"maximum":500,"minimum":0,"type":"integer"}},{"description":"Offset for pagination of results","example":0,"in":"query","name":"offset","schema":{"default":0,"minimum":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/non_friends__07e2669e8e8d"}}},"description":"Successful operation","headers":{"X-RateLimit-Limit":{"description":"The maximum number of requests allowed per time window","schema":{"$ref":"#/components/schemas/X-RateLimit-Limit__01cfa36ad727"}},"X-RateLimit-Remaining":{"description":"The number of requests remaining in the current time window","schema":{"$ref":"#/components/schemas/X-RateLimit-Remaining__01cfa36ad727"}},"X-RateLimit-Reset":{"description":"The time at which the current rate limit window resets","schema":{"$ref":"#/components/schemas/X-RateLimit-Reset__01cfa36ad727"}}}},"400":{"$ref":"#/components/responses/BadRequest__01cfa36ad727"},"401":{"$ref":"#/components/responses/Unauthorized__000172564380"},"403":{"$ref":"#/components/responses/ForbiddenRequest__01cfa36ad727"},"404":{"$ref":"#/components/responses/NotFound__01cfa36ad727"},"429":{"$ref":"#/components/responses/TooManyRequests__000172564380"},"500":{"$ref":"#/components/responses/InternalServerError__000172564380"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get list of non friend (non-neighbor) radios for that radio mac","tags":["AirMatch"],"x-source-document":{"file":"MRT/getnonfriendsv1.json","metadata":{"info":{"description":"Serves Wi-Fi client locations with filtering options available.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Services","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Operations related to AirMatch Services","name":"AirMatch"}]},"pathMetadata":{},"sha256":"460fc54ce5a38e4d77546f8ba49267815e8cc3cff70448431dae73dba991372b"}}},"/network-services/v1/airmatch-partition":{"get":{"description":"Returns RF Partition information for a given tenant with list of radios in that partition along with RF domain and partition information for a given tenant","operationId":"getRfPartitionV1","parameters":[{"description":"Radio Frequency band filter to return partitions for that band","example":"2.4GHz","in":"query","name":"band-selected","schema":{"enum":["2.4GHz","5GHz","6GHz"],"type":"string"}},{"description":"Partition Type filter to return partitions for that partition type. Supported values are normal, opmode, and dynamic","example":"normal","in":"query","name":"type","schema":{"enum":["normal","opmode","dynamic"],"type":"string"}},{"description":"Output Summary for Partition (default false)","example":false,"in":"query","name":"summary","schema":{"enum":[true,false],"type":"boolean"}},{"description":"Request ID used to find specific partition information using provided request id","example":["1fb6908c-25a6-4c9d-91ec-0b8e8aa394a2"],"explode":true,"in":"query","name":"id","schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Offset for pagination of results","example":0,"in":"query","name":"offset","schema":{"default":0,"minimum":0,"type":"integer"}},{"description":"Limit for pagination of results","example":100,"in":"query","name":"limit","schema":{"default":500,"maximum":500,"minimum":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/partition__728e89309681"}}},"description":"Successful operation","headers":{"X-RateLimit-Limit":{"description":"The maximum number of requests allowed per time window","schema":{"$ref":"#/components/schemas/X-RateLimit-Limit__01cfa36ad727"}},"X-RateLimit-Remaining":{"description":"The number of requests remaining in the current time window","schema":{"$ref":"#/components/schemas/X-RateLimit-Remaining__01cfa36ad727"}},"X-RateLimit-Reset":{"description":"The time at which the current rate limit window resets","schema":{"$ref":"#/components/schemas/X-RateLimit-Reset__01cfa36ad727"}}}},"400":{"$ref":"#/components/responses/BadRequest__01cfa36ad727"},"401":{"$ref":"#/components/responses/Unauthorized__000172564380"},"403":{"$ref":"#/components/responses/ForbiddenRequest__01cfa36ad727"},"404":{"$ref":"#/components/responses/NotFound__01cfa36ad727"},"429":{"$ref":"#/components/responses/TooManyRequests__000172564380"},"500":{"$ref":"#/components/responses/InternalServerError__000172564380"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get RF partition information","tags":["AirMatch"],"x-source-document":{"file":"MRT/getrfpartitionv1.json","metadata":{"info":{"description":"Serves Wi-Fi client locations with filtering options available.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Services","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Operations related to AirMatch Services","name":"AirMatch"}]},"pathMetadata":{},"sha256":"adff2ac034c925c179e8ad6242e006b97e3b45bb7d2c79514575afd97ccbda49"}},"post":{"description":"Sends an RF Partition Request to Airmatch to create new RF partitioning based on current pathloss information","operationId":"createRfPartitionV1","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/partition_response__2220d719af62"}}},"description":"Successful operation","headers":{"X-RateLimit-Limit":{"description":"The maximum number of requests allowed per time window","schema":{"$ref":"#/components/schemas/X-RateLimit-Limit__01cfa36ad727"}},"X-RateLimit-Remaining":{"description":"The number of requests remaining in the current time window","schema":{"$ref":"#/components/schemas/X-RateLimit-Remaining__01cfa36ad727"}},"X-RateLimit-Reset":{"description":"The time at which the current rate limit window resets","schema":{"$ref":"#/components/schemas/X-RateLimit-Reset__01cfa36ad727"}}}},"400":{"$ref":"#/components/responses/BadRequest__01cfa36ad727"},"401":{"$ref":"#/components/responses/Unauthorized__000172564380"},"403":{"$ref":"#/components/responses/ForbiddenRequest__01cfa36ad727"},"404":{"$ref":"#/components/responses/NotFound__01cfa36ad727"},"429":{"$ref":"#/components/responses/TooManyRequests__000172564380"},"500":{"$ref":"#/components/responses/InternalServerError__000172564380"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Send RF Partition Request to Airmatch","tags":["AirMatch"],"x-source-document":{"file":"MRT/createrfpartitionv1.json","metadata":{"info":{"description":"Serves Wi-Fi client locations with filtering options available.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Services","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Operations related to AirMatch Services","name":"AirMatch"}]},"pathMetadata":{},"sha256":"968e8349331601414fbb603b53d102f0a5d4c7ac3721dd3df30f3796d9b29863"}}},"/network-services/v1/airmatch-pathloss/{radio-mac}":{"get":{"description":"Returns all neighbors and pathloss information heard by a radio for a given tenant","operationId":"getPathlossV1","parameters":[{"description":"Reporting MAC address to look up list of Neighbors for that radio mac","example":"D8:C7:C8:11:22:33","in":"path","name":"radio-mac","required":true,"schema":{"pattern":"^([0-9A-Fa-f]{2}[:]){5}([0-9A-Fa-f]{2})$","type":"string"}},{"description":"Timestamp of oldest Pathloss to start query result","example":"2017-07-22T00:32:28.000Z","in":"query","name":"start-at","schema":{"format":"date-time","type":"string"}},{"description":"Timestamp of newest Pathloss to end query result","example":"2017-07-22T00:32:28.000Z","in":"query","name":"end-at","schema":{"format":"date-time","type":"string"}},{"description":"Append list of non friend (non-neighbor) pathloss to output (default false)","example":false,"in":"query","name":"include-non-friend","schema":{"enum":[true,false],"type":"boolean"}},{"description":"Limit for pagination of results","example":100,"in":"query","name":"limit","schema":{"default":500,"maximum":500,"minimum":0,"type":"integer"}},{"description":"Offset for pagination of results","example":0,"in":"query","name":"offset","schema":{"default":0,"minimum":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/pathloss__a0ec6e901581"}}},"description":"Successful operation","headers":{"X-RateLimit-Limit":{"description":"The maximum number of requests allowed per time window","schema":{"$ref":"#/components/schemas/X-RateLimit-Limit__01cfa36ad727"}},"X-RateLimit-Remaining":{"description":"The number of requests remaining in the current time window","schema":{"$ref":"#/components/schemas/X-RateLimit-Remaining__01cfa36ad727"}},"X-RateLimit-Reset":{"description":"The time at which the current rate limit window resets","schema":{"$ref":"#/components/schemas/X-RateLimit-Reset__01cfa36ad727"}}}},"400":{"$ref":"#/components/responses/BadRequest__01cfa36ad727"},"401":{"$ref":"#/components/responses/Unauthorized__000172564380"},"403":{"$ref":"#/components/responses/ForbiddenRequest__01cfa36ad727"},"404":{"$ref":"#/components/responses/NotFound__01cfa36ad727"},"429":{"$ref":"#/components/responses/TooManyRequests__000172564380"},"500":{"$ref":"#/components/responses/InternalServerError__000172564380"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get all neighbor pathloss for a tenant and radio mac","tags":["AirMatch"],"x-source-document":{"file":"MRT/getpathlossv1.json","metadata":{"info":{"description":"Serves Wi-Fi client locations with filtering options available.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Services","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Operations related to AirMatch Services","name":"AirMatch"}]},"pathMetadata":{},"sha256":"0932d148f5bdbf377c35dc7405c29a274eb515c3e57393a775da20abe976dbcd"}}},"/network-services/v1/airmatch-priority-rf-events":{"get":{"description":"Returns all Priority Radio Frequency (RF) channel change events caused by radar and noise for a tenant","operationId":"listPriorityRfEventsV1","parameters":[{"description":"Timestamp of oldest Priority RF Event to start query result","example":"2017-07-22T00:32:28.000Z","in":"query","name":"start-at","schema":{"format":"date-time","type":"string"}},{"description":"Timestamp of newest Priority RF Event to end query result","example":"2017-07-22T00:32:28.000Z","in":"query","name":"end-at","schema":{"format":"date-time","type":"string"}},{"description":"Limit for pagination of results","example":100,"in":"query","name":"limit","schema":{"default":500,"maximum":500,"minimum":0,"type":"integer"}},{"description":"Offset for pagination of results","example":0,"in":"query","name":"offset","schema":{"default":0,"minimum":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/prio_rf_events_all__f6f6dfb73ea1"}}},"description":"Successful operation","headers":{"X-RateLimit-Limit":{"description":"The maximum number of requests allowed per time window","schema":{"$ref":"#/components/schemas/X-RateLimit-Limit__01cfa36ad727"}},"X-RateLimit-Remaining":{"description":"The number of requests remaining in the current time window","schema":{"$ref":"#/components/schemas/X-RateLimit-Remaining__01cfa36ad727"}},"X-RateLimit-Reset":{"description":"The time at which the current rate limit window resets","schema":{"$ref":"#/components/schemas/X-RateLimit-Reset__01cfa36ad727"}}}},"400":{"$ref":"#/components/responses/BadRequest__01cfa36ad727"},"401":{"$ref":"#/components/responses/Unauthorized__000172564380"},"403":{"$ref":"#/components/responses/ForbiddenRequest__01cfa36ad727"},"404":{"$ref":"#/components/responses/NotFound__01cfa36ad727"},"429":{"$ref":"#/components/responses/TooManyRequests__000172564380"},"500":{"$ref":"#/components/responses/InternalServerError__000172564380"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get all radar and noise RF events of a tenant","tags":["AirMatch"],"x-source-document":{"file":"MRT/listpriorityrfeventsv1.json","metadata":{"info":{"description":"Serves Wi-Fi client locations with filtering options available.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Services","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Operations related to AirMatch Services","name":"AirMatch"}]},"pathMetadata":{},"sha256":"780802f88185d39422c49dfd383af9d9835a4af1c682537b5bf8054a983ddc38"}}},"/network-services/v1/airmatch-priority-rf-events/{radio-mac}":{"get":{"description":"Returns list of Priority Radio Frequency (RF) events that caused channel change due to radar and noise for a specific Radio MAC address for a given tenant","operationId":"getPriorityRfEventsV1","parameters":[{"description":"Radio MAC address to look up list of Priority RF events","example":"D8:C7:C8:11:22:33","in":"path","name":"radio-mac","required":true,"schema":{"pattern":"^([0-9A-Fa-f]{2}[:]){5}([0-9A-Fa-f]{2})$","type":"string"}},{"description":"Timestamp of oldest Priority RF Event to start query result","example":"2017-07-22T00:32:28.000Z","in":"query","name":"start-at","schema":{"format":"date-time","type":"string"}},{"description":"Timestamp of newest Priority RF Event to end query result","example":"2017-07-22T00:32:28.000Z","in":"query","name":"end-at","schema":{"format":"date-time","type":"string"}},{"description":"Limit for pagination of results","example":100,"in":"query","name":"limit","schema":{"default":500,"maximum":500,"minimum":0,"type":"integer"}},{"description":"Offset for pagination of results","example":0,"in":"query","name":"offset","schema":{"default":0,"minimum":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/prio_rf_events__97082ceeaaf5"}}},"description":"Successful operation","headers":{"X-RateLimit-Limit":{"description":"The maximum number of requests allowed per time window","schema":{"$ref":"#/components/schemas/X-RateLimit-Limit__01cfa36ad727"}},"X-RateLimit-Remaining":{"description":"The number of requests remaining in the current time window","schema":{"$ref":"#/components/schemas/X-RateLimit-Remaining__01cfa36ad727"}},"X-RateLimit-Reset":{"description":"The time at which the current rate limit window resets","schema":{"$ref":"#/components/schemas/X-RateLimit-Reset__01cfa36ad727"}}}},"400":{"$ref":"#/components/responses/BadRequest__01cfa36ad727"},"401":{"$ref":"#/components/responses/Unauthorized__000172564380"},"403":{"$ref":"#/components/responses/ForbiddenRequest__01cfa36ad727"},"404":{"$ref":"#/components/responses/NotFound__01cfa36ad727"},"429":{"$ref":"#/components/responses/TooManyRequests__000172564380"},"500":{"$ref":"#/components/responses/InternalServerError__000172564380"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get radar and noise RF events of a specific Radio MAC","tags":["AirMatch"],"x-source-document":{"file":"MRT/getpriorityrfeventsv1.json","metadata":{"info":{"description":"Serves Wi-Fi client locations with filtering options available.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Services","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Operations related to AirMatch Services","name":"AirMatch"}]},"pathMetadata":{},"sha256":"e0b6a4cca59572271aace952015fbd218d133ba1ed0ab1796a8d4d14878929ab"}}},"/network-services/v1/airmatch-radio":{"get":{"description":"Returns reporting radio information for all radios for that tenant or radios based on AP Serial if query parameter provided.","operationId":"listRadiosV1","parameters":[{"description":"AP Serial number to get reporting radio information for radios on that AP","example":"CNHHJ0Y0TK","in":"query","name":"serial-number","schema":{"type":"string"}},{"description":"Get Static Radio Documents for radios with static channel or power","example":true,"in":"query","name":"is-static","schema":{"type":"boolean"}},{"description":"Limit for pagination of results","example":100,"in":"query","name":"limit","schema":{"default":500,"maximum":500,"minimum":0,"type":"integer"}},{"description":"Offset for pagination of results","example":0,"in":"query","name":"offset","schema":{"default":0,"minimum":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/radio_info_all__a52d23f02a0b"}}},"description":"Successful operation","headers":{"X-RateLimit-Limit":{"description":"The maximum number of requests allowed per time window","schema":{"$ref":"#/components/schemas/X-RateLimit-Limit__01cfa36ad727"}},"X-RateLimit-Remaining":{"description":"The number of requests remaining in the current time window","schema":{"$ref":"#/components/schemas/X-RateLimit-Remaining__01cfa36ad727"}},"X-RateLimit-Reset":{"description":"The time at which the current rate limit window resets","schema":{"$ref":"#/components/schemas/X-RateLimit-Reset__01cfa36ad727"}}}},"400":{"$ref":"#/components/responses/BadRequest__01cfa36ad727"},"401":{"$ref":"#/components/responses/Unauthorized__000172564380"},"403":{"$ref":"#/components/responses/ForbiddenRequest__01cfa36ad727"},"404":{"$ref":"#/components/responses/NotFound__01cfa36ad727"},"429":{"$ref":"#/components/responses/TooManyRequests__000172564380"},"500":{"$ref":"#/components/responses/InternalServerError__000172564380"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get all radios for a tenant or radios based on AP Serial","tags":["AirMatch"],"x-source-document":{"file":"MRT/listradiosv1.json","metadata":{"info":{"description":"Serves Wi-Fi client locations with filtering options available.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Services","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Operations related to AirMatch Services","name":"AirMatch"}]},"pathMetadata":{},"sha256":"8ba89823e4e422d5afbce2898dbeb188d5ce391089ea7dea73403451d2d78a70"}}},"/network-services/v1/airmatch-radio-feasibility":{"get":{"description":"Returns current radio feasibility for all radios for a given tenant","operationId":"listRadioFeasibilityV1","parameters":[{"description":"Offset for pagination of results","example":0,"in":"query","name":"offset","schema":{"default":0,"minimum":0,"type":"integer"}},{"description":"Limit for pagination of results","example":100,"in":"query","name":"limit","schema":{"default":500,"maximum":500,"minimum":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/radio_feasibility_all__caa30c68a06b"}}},"description":"Successful operation","headers":{"X-RateLimit-Limit":{"description":"The maximum number of requests allowed per time window","schema":{"$ref":"#/components/schemas/X-RateLimit-Limit__01cfa36ad727"}},"X-RateLimit-Remaining":{"description":"The number of requests remaining in the current time window","schema":{"$ref":"#/components/schemas/X-RateLimit-Remaining__01cfa36ad727"}},"X-RateLimit-Reset":{"description":"The time at which the current rate limit window resets","schema":{"$ref":"#/components/schemas/X-RateLimit-Reset__01cfa36ad727"}}}},"400":{"$ref":"#/components/responses/BadRequest__01cfa36ad727"},"401":{"$ref":"#/components/responses/Unauthorized__000172564380"},"403":{"$ref":"#/components/responses/ForbiddenRequest__01cfa36ad727"},"404":{"$ref":"#/components/responses/NotFound__01cfa36ad727"},"429":{"$ref":"#/components/responses/TooManyRequests__000172564380"},"500":{"$ref":"#/components/responses/InternalServerError__000172564380"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get all radio feasibility for a tenant","tags":["AirMatch"],"x-source-document":{"file":"MRT/listradiofeasibilityv1.json","metadata":{"info":{"description":"Serves Wi-Fi client locations with filtering options available.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Services","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Operations related to AirMatch Services","name":"AirMatch"}]},"pathMetadata":{},"sha256":"a774107de96b914c5027974a27c75f8c0da267c861752f883f5285d22cf20043"}}},"/network-services/v1/airmatch-radio-feasibility/{radio-mac}":{"get":{"description":"Returns current radio feasibility for a specific radio MAC address for a given tenant","operationId":"getRadioFeasibilityV1","parameters":[{"description":"Radio MAC to look up list of radio feasibility for that radio","example":"D8:C7:C8:11:22:33","in":"path","name":"radio-mac","required":true,"schema":{"pattern":"^([0-9A-Fa-f]{2}[:]){5}([0-9A-Fa-f]{2})$","type":"string"}},{"description":"Limit for pagination of results","example":100,"in":"query","name":"limit","schema":{"default":500,"maximum":500,"minimum":0,"type":"integer"}},{"description":"Offset for pagination of results","example":0,"in":"query","name":"offset","schema":{"default":0,"minimum":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/radio_feasibility__3c7026e76daa"}}},"description":"Successful operation","headers":{"X-RateLimit-Limit":{"description":"The maximum number of requests allowed per time window","schema":{"$ref":"#/components/schemas/X-RateLimit-Limit__01cfa36ad727"}},"X-RateLimit-Remaining":{"description":"The number of requests remaining in the current time window","schema":{"$ref":"#/components/schemas/X-RateLimit-Remaining__01cfa36ad727"}},"X-RateLimit-Reset":{"description":"The time at which the current rate limit window resets","schema":{"$ref":"#/components/schemas/X-RateLimit-Reset__01cfa36ad727"}}}},"400":{"$ref":"#/components/responses/BadRequest__01cfa36ad727"},"401":{"$ref":"#/components/responses/Unauthorized__000172564380"},"403":{"$ref":"#/components/responses/ForbiddenRequest__01cfa36ad727"},"404":{"$ref":"#/components/responses/NotFound__01cfa36ad727"},"429":{"$ref":"#/components/responses/TooManyRequests__000172564380"},"500":{"$ref":"#/components/responses/InternalServerError__000172564380"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get radio feasibility of a specific radio MAC","tags":["AirMatch"],"x-source-document":{"file":"MRT/getradiofeasibilityv1.json","metadata":{"info":{"description":"Serves Wi-Fi client locations with filtering options available.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Services","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Operations related to AirMatch Services","name":"AirMatch"}]},"pathMetadata":{},"sha256":"6ef2c6b6219b2192c6c4c287bd1b82ad375a7a515117f9276e9c626404e6b308"}}},"/network-services/v1/airmatch-radio-partition/{radio-mac}":{"get":{"description":"Returns rf domain and friend partition id for a specific radio mac address for a given tenant","operationId":"getRadioPartitionV1","parameters":[{"description":"Radio MAC address to find in partition","example":"D8:C7:C8:11:22:33","in":"path","name":"radio-mac","required":true,"schema":{"pattern":"^([0-9A-Fa-f]{2}[:]){5}([0-9A-Fa-f]{2})$","type":"string"}},{"description":"Partition type","example":"normal","in":"query","name":"type","schema":{"enum":["normal","opmode","dynamic"],"type":"string"}},{"description":"Limit for pagination of results","example":100,"in":"query","name":"limit","schema":{"default":500,"maximum":500,"minimum":0,"type":"integer"}},{"description":"Offset for pagination of results","example":0,"in":"query","name":"offset","schema":{"default":0,"minimum":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/radio_partition__992133fe494f"}}},"description":"Successful operation","headers":{"X-RateLimit-Limit":{"description":"The maximum number of requests allowed per time window","schema":{"$ref":"#/components/schemas/X-RateLimit-Limit__01cfa36ad727"}},"X-RateLimit-Remaining":{"description":"The number of requests remaining in the current time window","schema":{"$ref":"#/components/schemas/X-RateLimit-Remaining__01cfa36ad727"}},"X-RateLimit-Reset":{"description":"The time at which the current rate limit window resets","schema":{"$ref":"#/components/schemas/X-RateLimit-Reset__01cfa36ad727"}}}},"400":{"$ref":"#/components/responses/BadRequest__01cfa36ad727"},"401":{"$ref":"#/components/responses/Unauthorized__000172564380"},"403":{"$ref":"#/components/responses/ForbiddenRequest__01cfa36ad727"},"404":{"$ref":"#/components/responses/NotFound__01cfa36ad727"},"429":{"$ref":"#/components/responses/TooManyRequests__000172564380"},"500":{"$ref":"#/components/responses/InternalServerError__000172564380"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get rf domain and partition id for a specific radio mac address","tags":["AirMatch"],"x-source-document":{"file":"MRT/getradiopartitionv1.json","metadata":{"info":{"description":"Serves Wi-Fi client locations with filtering options available.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Services","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Operations related to AirMatch Services","name":"AirMatch"}]},"pathMetadata":{},"sha256":"000a5c2b57fa2ee676c609f3647958ca55a97ccaf2926d75779c7a0d9ddb0f85"}}},"/network-services/v1/airmatch-radio/{radio-mac}":{"get":{"description":"Returns the reporting radio information for a specific tenant based on radio MAC address.","operationId":"getRadioV1","parameters":[{"description":"Radio MAC address to look up reporting radio information","example":"D8:C7:C8:11:22:33","in":"path","name":"radio-mac","required":true,"schema":{"pattern":"^([0-9A-Fa-f]{2}[:]){5}([0-9A-Fa-f]{2})$","type":"string"}},{"description":"AP Serial number to get reporting radio information for radios on that AP","example":"CNHHJ0Y0TK","in":"query","name":"serial-number","schema":{"type":"string"}},{"description":"Limit for pagination of results","example":100,"in":"query","name":"limit","schema":{"default":500,"maximum":500,"minimum":0,"type":"integer"}},{"description":"Offset for pagination of results","example":0,"in":"query","name":"offset","schema":{"default":0,"minimum":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/radio_info__02f79da05c85"}}},"description":"Successful operation","headers":{"X-RateLimit-Limit":{"description":"The maximum number of requests allowed per time window","schema":{"$ref":"#/components/schemas/X-RateLimit-Limit__01cfa36ad727"}},"X-RateLimit-Remaining":{"description":"The number of requests remaining in the current time window","schema":{"$ref":"#/components/schemas/X-RateLimit-Remaining__01cfa36ad727"}},"X-RateLimit-Reset":{"description":"The time at which the current rate limit window resets","schema":{"$ref":"#/components/schemas/X-RateLimit-Reset__01cfa36ad727"}}}},"400":{"$ref":"#/components/responses/BadRequest__01cfa36ad727"},"401":{"$ref":"#/components/responses/Unauthorized__000172564380"},"403":{"$ref":"#/components/responses/ForbiddenRequest__01cfa36ad727"},"404":{"$ref":"#/components/responses/NotFound__01cfa36ad727"},"429":{"$ref":"#/components/responses/TooManyRequests__000172564380"},"500":{"$ref":"#/components/responses/InternalServerError__000172564380"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get reporting radio information of a specific radio MAC","tags":["AirMatch"],"x-source-document":{"file":"MRT/getradiov1.json","metadata":{"info":{"description":"Serves Wi-Fi client locations with filtering options available.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Services","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Operations related to AirMatch Services","name":"AirMatch"}]},"pathMetadata":{},"sha256":"ff5a2e9a6a724d18c5ec9ed0d0d8d07a655fa584fc447932a107c3a91dd9c1c0"}}},"/network-services/v1/airmatch-rf-events":{"get":{"description":"Returns all non Priority Radio Frequency (RF) events for a tenant","operationId":"listRfEventsV1","parameters":[{"description":"Timestamp of oldest RF Event to start query result","example":"2017-07-22T00:32:28.000Z","in":"query","name":"start-at","schema":{"format":"date-time","type":"string"}},{"description":"Timestamp of newest RF Event to end query result","example":"2017-07-22T00:32:28.000Z","in":"query","name":"end-at","schema":{"format":"date-time","type":"string"}},{"description":"Limit for pagination of results","example":100,"in":"query","name":"limit","schema":{"default":500,"maximum":500,"minimum":0,"type":"integer"}},{"description":"Offset for pagination of results","example":0,"in":"query","name":"offset","schema":{"default":0,"minimum":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rf_events_all__de6c202caff6"}}},"description":"Successful operation","headers":{"X-RateLimit-Limit":{"description":"The maximum number of requests allowed per time window","schema":{"$ref":"#/components/schemas/X-RateLimit-Limit__01cfa36ad727"}},"X-RateLimit-Remaining":{"description":"The number of requests remaining in the current time window","schema":{"$ref":"#/components/schemas/X-RateLimit-Remaining__01cfa36ad727"}},"X-RateLimit-Reset":{"description":"The time at which the current rate limit window resets","schema":{"$ref":"#/components/schemas/X-RateLimit-Reset__01cfa36ad727"}}}},"400":{"$ref":"#/components/responses/BadRequest__01cfa36ad727"},"401":{"$ref":"#/components/responses/Unauthorized__000172564380"},"403":{"$ref":"#/components/responses/ForbiddenRequest__01cfa36ad727"},"404":{"$ref":"#/components/responses/NotFound__01cfa36ad727"},"429":{"$ref":"#/components/responses/TooManyRequests__000172564380"},"500":{"$ref":"#/components/responses/InternalServerError__000172564380"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get all RF events of a tenant","tags":["AirMatch"],"x-source-document":{"file":"MRT/listrfeventsv1.json","metadata":{"info":{"description":"Serves Wi-Fi client locations with filtering options available.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Services","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Operations related to AirMatch Services","name":"AirMatch"}]},"pathMetadata":{},"sha256":"31118165c1affca68ec7dcfed73a68f7d01744b24a7b48856d56aa5e78ae3e4f"}}},"/network-services/v1/airmatch-rf-events/{radio-mac}":{"get":{"description":"Returns non Priority Radio Frequency (RF) events for a specific Radio MAC address for a given tenant","operationId":"getRfEventsV1","parameters":[{"description":"Radio MAC to look up list of RF events for that radio","example":"D8:C7:C8:11:22:33","in":"path","name":"radio-mac","required":true,"schema":{"pattern":"^([0-9A-Fa-f]{2}[:]){5}([0-9A-Fa-f]{2})$","type":"string"}},{"description":"Timestamp of oldest RF Event to start query result","example":"2017-07-22T00:32:28.000Z","in":"query","name":"start-at","schema":{"format":"date-time","type":"string"}},{"description":"Timestamp of newest RF Event to end query result","example":"2017-07-22T00:32:28.000Z","in":"query","name":"end-at","schema":{"format":"date-time","type":"string"}},{"description":"Limit for pagination of results","example":100,"in":"query","name":"limit","schema":{"default":500,"maximum":500,"minimum":0,"type":"integer"}},{"description":"Offset for pagination of results","example":0,"in":"query","name":"offset","schema":{"default":0,"minimum":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rf_events__01cfa36ad727"}}},"description":"Successful operation","headers":{"X-RateLimit-Limit":{"description":"The maximum number of requests allowed per time window","schema":{"$ref":"#/components/schemas/X-RateLimit-Limit__01cfa36ad727"}},"X-RateLimit-Remaining":{"description":"The number of requests remaining in the current time window","schema":{"$ref":"#/components/schemas/X-RateLimit-Remaining__01cfa36ad727"}},"X-RateLimit-Reset":{"description":"The time at which the current rate limit window resets","schema":{"$ref":"#/components/schemas/X-RateLimit-Reset__01cfa36ad727"}}}},"400":{"$ref":"#/components/responses/BadRequest__01cfa36ad727"},"401":{"$ref":"#/components/responses/Unauthorized__000172564380"},"403":{"$ref":"#/components/responses/ForbiddenRequest__01cfa36ad727"},"404":{"$ref":"#/components/responses/NotFound__01cfa36ad727"},"429":{"$ref":"#/components/responses/TooManyRequests__000172564380"},"500":{"$ref":"#/components/responses/InternalServerError__000172564380"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get RF events of a specific Radio MAC","tags":["AirMatch"],"x-source-document":{"file":"MRT/getrfeventsv1.json","metadata":{"info":{"description":"Serves Wi-Fi client locations with filtering options available.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Services","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Operations related to AirMatch Services","name":"AirMatch"}]},"pathMetadata":{},"sha256":"6255cb9f63929a44811a605d8840ef475ea5ff45b0a0360bbfe254ccbb0f375d"}}},"/network-services/v1/airmatch-runnow":{"post":{"description":"Sends an optimization request to Airmatch to compute and deploy a solution based on user provided runmode and other parameters. Runmode is a required parameter and valid values are ON-DEMAND, INCREMENTAL, and OPMODE.","operationId":"runOptimizationV1","parameters":[{"description":"runmode (case-insensitive). Valid values: ON-DEMAND, INCREMENTAL, OPMODE","example":"ON-DEMAND","in":"query","name":"runmode","required":true,"schema":{"type":"string"}},{"description":"Threshold value filter used to process partition with user specified channel threshold value","example":true,"in":"query","name":"threshold","schema":{"enum":[true,false],"type":"boolean"}},{"description":"Delay the deployment of solution in minutes; Range [0-360], default 0","example":0,"in":"query","name":"delay","schema":{"$ref":"#/components/schemas/runnow_delay__96a2be0ca8b8"}},{"description":"Deploy Window in minutes; Range [0-360], default 120","example":120,"in":"query","name":"window","schema":{"$ref":"#/components/schemas/runnow_window__96a2be0ca8b8"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/runnow_response__96a2be0ca8b8"}}},"description":"Successful operation","headers":{"X-RateLimit-Limit":{"description":"The maximum number of requests allowed per time window","schema":{"$ref":"#/components/schemas/X-RateLimit-Limit__01cfa36ad727"}},"X-RateLimit-Remaining":{"description":"The number of requests remaining in the current time window","schema":{"$ref":"#/components/schemas/X-RateLimit-Remaining__01cfa36ad727"}},"X-RateLimit-Reset":{"description":"The time at which the current rate limit window resets","schema":{"$ref":"#/components/schemas/X-RateLimit-Reset__01cfa36ad727"}}}},"400":{"$ref":"#/components/responses/BadRequest__01cfa36ad727"},"401":{"$ref":"#/components/responses/Unauthorized__000172564380"},"403":{"$ref":"#/components/responses/ForbiddenRequest__01cfa36ad727"},"404":{"$ref":"#/components/responses/NotFound__01cfa36ad727"},"429":{"$ref":"#/components/responses/TooManyRequests__000172564380"},"500":{"$ref":"#/components/responses/InternalServerError__000172564380"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Sends an optimization request to Airmatch to compute and deploy a solution","tags":["AirMatch"],"x-source-document":{"file":"MRT/runoptimizationv1.json","metadata":{"info":{"description":"Serves Wi-Fi client locations with filtering options available.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Services","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Operations related to AirMatch Services","name":"AirMatch"}]},"pathMetadata":{},"sha256":"8549c118c62e3a670cd4c5f8c34070e2eaac10ae620396c4d1c2b3d26b189d1a"}}},"/network-services/v1/airmatch-service-config":{"get":{"description":"Returns Device Running Configuration for a given tenant","operationId":"getServiceConfigV1","parameters":[{"description":"Limit for pagination of results","example":100,"in":"query","name":"limit","schema":{"default":500,"maximum":500,"minimum":0,"type":"integer"}},{"description":"Offset for pagination of results","example":0,"in":"query","name":"offset","schema":{"default":0,"minimum":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/service_config__5cbafbf3f32c"}}},"description":"Successful operation","headers":{"X-RateLimit-Limit":{"description":"The maximum number of requests allowed per time window","schema":{"$ref":"#/components/schemas/X-RateLimit-Limit__01cfa36ad727"}},"X-RateLimit-Remaining":{"description":"The number of requests remaining in the current time window","schema":{"$ref":"#/components/schemas/X-RateLimit-Remaining__01cfa36ad727"}},"X-RateLimit-Reset":{"description":"The time at which the current rate limit window resets","schema":{"$ref":"#/components/schemas/X-RateLimit-Reset__01cfa36ad727"}}}},"400":{"$ref":"#/components/responses/BadRequest__01cfa36ad727"},"401":{"$ref":"#/components/responses/Unauthorized__000172564380"},"403":{"$ref":"#/components/responses/ForbiddenRequest__01cfa36ad727"},"404":{"$ref":"#/components/responses/NotFound__01cfa36ad727"},"429":{"$ref":"#/components/responses/TooManyRequests__000172564380"},"500":{"$ref":"#/components/responses/InternalServerError__000172564380"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Returns Device (AP) Running Configuration","tags":["AirMatch"],"x-source-document":{"file":"MRT/getserviceconfigv1.json","metadata":{"info":{"description":"Serves Wi-Fi client locations with filtering options available.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Services","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Operations related to AirMatch Services","name":"AirMatch"}]},"pathMetadata":{},"sha256":"47e7c609abd48d743f27c1f23ad391e678c8f66ee3e27946423271c6932da26e"}}},"/network-services/v1/airmatch-solution":{"get":{"description":"Returns the list of solver optimizations/solutions generated by Airmatch for a given tenant. This endpoint supports multiple query parameters to filter and paginate the list of solutions returned. If no query parameters are provided, it will return all solutions for the tenant up to the default pagination limit.","operationId":"listSolutionsV1","parameters":[{"description":"Number of solutions to return.","example":5,"in":"query","name":"count","schema":{"minimum":0,"type":"integer"}},{"description":"Filter for solutions with timestamp greater than or equal to the provided timestamp","example":"2017-07-22T00:32:28.000Z","in":"query","name":"start-at","schema":{"format":"date-time","type":"string"}},{"description":"Filter for solutions with timestamp less than or equal to the provided timestamp","example":"2017-07-22T00:32:28.000Z","in":"query","name":"end-at","schema":{"format":"date-time","type":"string"}},{"description":"Runmode Filter to return solutions for that runmode. Valid values are SCHEDULE, ON-DEMAND, INCREMENTAL, OPMODE, and EIRP.","example":"ON-DEMAND","in":"query","name":"runmode","schema":{"enum":["SCHEDULED","ON-DEMAND","INCREMENTAL","EIRP","OPMODE"],"type":"string"}},{"description":"RF Domain ID filter to return solutions for radios in a specific rf domain","example":1,"in":"query","name":"rf-domain-id","schema":{"minimum":0,"type":"integer"}},{"description":"RF Partition ID filter to return solutions for radios in a specific rf partition","example":0,"in":"query","name":"rf-partition-id","schema":{"minimum":0,"type":"integer"}},{"description":"Radio band filter to return solutions for radios in a specific band","example":"2.4GHz","in":"query","name":"band-selected","schema":{"enum":["2.4GHz","5GHz","6GHz"],"type":"string"}},{"description":"Request ID Filter to return specific solution using request id provided by user in query parameter","example":["1fb6908c-25a6-4c9d-91ec-0b8e8aa394a2"],"explode":true,"in":"query","name":"id","schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Filters solution documents based on deployment status field. Valid values are COMPUTED, SENT, RETRIED, DEPLOY_UNSUCCESSFUL, and CONFIRMED.","example":"DEPLOY_UNSUCCESSFUL","in":"query","name":"status","schema":{"enum":["COMPUTED","SENT","RETRIED","DEPLOY_UNSUCCESSFUL","CONFIRMED"],"type":"string"}},{"description":"Limit for pagination of results","example":100,"in":"query","name":"limit","schema":{"default":500,"maximum":500,"minimum":0,"type":"integer"}},{"description":"Offset for pagination of results","example":0,"in":"query","name":"offset","schema":{"default":0,"minimum":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/solution_all__28b1232a6d05"}}},"description":"Successful operation","headers":{"X-RateLimit-Limit":{"description":"The maximum number of requests allowed per time window","schema":{"$ref":"#/components/schemas/X-RateLimit-Limit__01cfa36ad727"}},"X-RateLimit-Remaining":{"description":"The number of requests remaining in the current time window","schema":{"$ref":"#/components/schemas/X-RateLimit-Remaining__01cfa36ad727"}},"X-RateLimit-Reset":{"description":"The time at which the current rate limit window resets","schema":{"$ref":"#/components/schemas/X-RateLimit-Reset__01cfa36ad727"}}}},"400":{"$ref":"#/components/responses/BadRequest__01cfa36ad727"},"401":{"$ref":"#/components/responses/Unauthorized__000172564380"},"403":{"$ref":"#/components/responses/ForbiddenRequest__01cfa36ad727"},"404":{"$ref":"#/components/responses/NotFound__01cfa36ad727"},"429":{"$ref":"#/components/responses/TooManyRequests__000172564380"},"500":{"$ref":"#/components/responses/InternalServerError__000172564380"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get solver optimizations for a given tenant","tags":["AirMatch"],"x-source-document":{"file":"MRT/listsolutionsv1.json","metadata":{"info":{"description":"Serves Wi-Fi client locations with filtering options available.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Services","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Operations related to AirMatch Services","name":"AirMatch"}]},"pathMetadata":{},"sha256":"98548d4ae4a94ecc15bd92a9814edd4e965764cd181759bb13a2139148c245e6"}}},"/network-services/v1/airmatch-solution/{radio-mac}":{"get":{"description":"Returns Solution/Radio Plan of a specific radio for a given tenant","operationId":"getSolutionV1","parameters":[{"description":"Radio MAC address to get solution for that radio mac","example":"D8:C7:C8:11:22:33","in":"path","name":"radio-mac","required":true,"schema":{"pattern":"^([0-9A-Fa-f]{2}[:]){5}([0-9A-Fa-f]{2})$","type":"string"}},{"description":"Number of solutions to return.","example":5,"in":"query","name":"count","schema":{"minimum":0,"type":"integer"}},{"description":"Filter for solutions with timestamp greater than or equal to the provided timestamp","example":"2017-07-22T00:32:28.000Z","in":"query","name":"start-at","schema":{"format":"date-time","type":"string"}},{"description":"Filter for solutions with timestamp less than or equal to the provided timestamp","example":"2017-07-22T00:32:28.000Z","in":"query","name":"end-at","schema":{"format":"date-time","type":"string"}},{"description":"Runmode Filter to return solutions for that runmode","example":"ON-DEMAND","in":"query","name":"runmode","schema":{"type":"string"}},{"description":"Request ID Filter to return specific solution using request id provided by user in query parameter","example":["1fb6908c-25a6-4c9d-91ec-0b8e8aa394a2"],"explode":true,"in":"query","name":"id","schema":{"items":{"type":"string"},"type":"array"},"style":"form"},{"description":"Limit for pagination of results","example":100,"in":"query","name":"limit","schema":{"default":500,"maximum":500,"minimum":0,"type":"integer"}},{"description":"Offset for pagination of results","example":0,"in":"query","name":"offset","schema":{"default":0,"minimum":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/solution__28b1232a6d05"}}},"description":"Successful operation","headers":{"X-RateLimit-Limit":{"description":"The maximum number of requests allowed per time window","schema":{"$ref":"#/components/schemas/X-RateLimit-Limit__01cfa36ad727"}},"X-RateLimit-Remaining":{"description":"The number of requests remaining in the current time window","schema":{"$ref":"#/components/schemas/X-RateLimit-Remaining__01cfa36ad727"}},"X-RateLimit-Reset":{"description":"The time at which the current rate limit window resets","schema":{"$ref":"#/components/schemas/X-RateLimit-Reset__01cfa36ad727"}}}},"400":{"$ref":"#/components/responses/BadRequest__01cfa36ad727"},"401":{"$ref":"#/components/responses/Unauthorized__000172564380"},"403":{"$ref":"#/components/responses/ForbiddenRequest__01cfa36ad727"},"404":{"$ref":"#/components/responses/NotFound__01cfa36ad727"},"429":{"$ref":"#/components/responses/TooManyRequests__000172564380"},"500":{"$ref":"#/components/responses/InternalServerError__000172564380"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get solution of a specific Radio MAC","tags":["AirMatch"],"x-source-document":{"file":"MRT/getsolutionv1.json","metadata":{"info":{"description":"Serves Wi-Fi client locations with filtering options available.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Services","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Operations related to AirMatch Services","name":"AirMatch"}]},"pathMetadata":{},"sha256":"22df48fd7b6f7b766ed283d9262717b430c76c93f19405cc52867ded32f12fab"}}},"/network-services/v1/ap-live-upgrades":{"get":{"description":"Get AP upgrade information organized in a hierarchy from the config scope at which they were triggered from.","operationId":"listApLiveUpgradesV1","parameters":[{"description":"Upgrade started after - in YYYY-MM-DDTHH:MM:SS[Z|(+|-)HH:MM] format.","example":"2025-01-31T13:00:00-07:00","in":"query","name":"start-at","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"Upgrade started before - in YYYY-MM-DDTHH:MM:SS[Z|(+|-)HH:MM] format.","example":"2025-02-28T18:00:00Z","in":"query","name":"end-at","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"Scope ID in which upgrade was initiated. Either this parameter or serial-numbers must be present","example":"34536546654","in":"query","name":"scope-id","required":false,"schema":{"type":"string"}},{"description":"Whether or not to include historical upgrades.","in":"query","name":"history","required":false,"schema":{"default":false,"type":"boolean"}},{"description":"Specifies the maximum number of upgrades in the response list.\n","in":"query","name":"limit","required":false,"schema":{"default":10,"examples":[5],"format":"int32","maximum":10,"minimum":1,"type":"integer"}},{"description":"Specifies the offset in the upgrades list at which to begin the response.\n","in":"query","name":"offset","required":false,"schema":{"default":0,"examples":[123],"format":"int64","maximum":2147483647,"minimum":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"count":{"description":"The number of objects returned in the response.\n","examples":[2],"format":"int32","maximum":10,"minimum":0,"type":"integer"},"items":{"items":{"properties":{"completedAt":{"examples":["2025-08-22T04:57:15.587Z"],"type":"string"},"createdAt":{"examples":["2025-08-22T03:57:14.587Z"],"format":"date-time","type":"string"},"customerId":{"examples":["2829030694de11efb0c6761baa27ec60"],"type":"string"},"generation":{"examples":[1],"format":"int64","type":"integer"},"id":{"description":"Unique id formed by combining Customer Id and Config Id.","examples":["2829030694de11efb0c6761baa27ec60--225"],"type":"string"},"initiatedAt":{"examples":["2025-08-22T03:57:15.587Z"],"type":"string"},"partitions":{"items":{"properties":{"apRebootSets":{"items":{"properties":{"apRebootSetStatus":{"enum":["REQUEST_RECEIVED_FROM_USER","IMAGE_DOWNLOAD_REQUESTED","IMAGE_DOWNLOAD_COMPLETED","REBOOT_READY","AWAITING_OTHER_REBOOT_COMPLETION","REBOOT_STARTED","REBOOT_COMPLETED","FAILED","COMPLETED_WITH_FAILURES","ABORTED"],"examples":["REBOOT_STARTED"],"type":"string"},"aps":{"items":{"properties":{"downloadFinishedAt":{"examples":["2025-08-22T03:59:34.902Z"],"type":"string"},"downloadRetries":{"examples":[1],"type":"integer"},"downloadStartedAt":{"examples":["2025-08-22T03:58:04.902Z"],"type":"string"},"failureReason":{"examples":["Device response not received post reboot"],"type":"string"},"rebootFinishedAt":{"examples":["2025-08-22T03:59:34.902Z"],"type":"string"},"rebootRetries":{"examples":[0],"type":"integer"},"rebootStartedAt":{"examples":["2025-08-22T03:59:54.902Z"],"type":"string"},"seed":{"examples":[true],"type":"boolean"},"seedAp":{"examples":["CNJ3KD5H7C"],"type":"string"},"seededAps":{"items":{"examples":["CNJ3KD5H7C"],"type":"string"},"type":"array"},"serial":{"examples":["CNJ3KD5H7C"],"type":"string"},"status":{"enum":["REQUEST_RECEIVED_FROM_USER","WAITING_ON_ANOTHER_UPGRADE","WAITING_FOR_SEEDING","IMAGE_DOWNLOAD_REQUESTED","IMAGE_DOWNLOAD_IN_PROGRESS","IMAGE_DOWNLOAD_COMPLETED","IMAGE_DOWNLOAD_FAILED","IMAGE_DOWNLOAD_FAILED_PERMANENTLY","UPDATING_BOOT_PARTITION","BOOT_PARTITION_UPDATED","BOOT_PARTITION_UPDATE_FAILED","SEEDING_OTHER_APS","REBOOT_READY","REBOOT_REQUESTED","REBOOTING","REBOOT_COMPLETED","FAILED","ABORTED"],"examples":["WAITING_FOR_SEEDING"],"type":"string"},"version":{"examples":["10.5.0.1_81235"],"type":"string"}},"type":"object"},"type":"array"},"downloadFinishedAt":{"examples":["2025-08-22T03:59:34.902Z"],"type":"string"},"downloadRetries":{"examples":[1],"type":"integer"},"downloadStartedAt":{"examples":["2025-08-22T03:58:04.902Z"],"type":"string"},"id":{"description":"Unique id formed by combining Customer Id, Config Id, RF partition id","examples":["2829030694de11efb0c6761baa27ec60--225_16111306652446720_RFD-1:RFP-4:ARS_2"],"type":"string"},"rebootFinishedAt":{"examples":["2025-08-22T03:59:34.902Z"],"type":"string"},"rebootRetries":{"examples":[0],"type":"integer"},"rebootStartedAt":{"examples":["2025-08-22T03:59:54.902Z"],"type":"string"},"statusCounts":{"items":{"properties":{"count":{"examples":[10],"type":"integer"},"status":{"enum":["REQUEST_RECEIVED_FROM_USER","WAITING_ON_ANOTHER_UPGRADE","WAITING_FOR_SEEDING","IMAGE_DOWNLOAD_REQUESTED","IMAGE_DOWNLOAD_IN_PROGRESS","IMAGE_DOWNLOAD_COMPLETED","IMAGE_DOWNLOAD_FAILED","IMAGE_DOWNLOAD_FAILED_PERMANENTLY","UPDATING_BOOT_PARTITION","BOOT_PARTITION_UPDATED","BOOT_PARTITION_UPDATE_FAILED","SEEDING_OTHER_APS","REBOOT_READY","REBOOT_REQUESTED","REBOOTING","REBOOT_COMPLETED","FAILED","ABORTED"],"examples":["IMAGE_DOWNLOAD_IN_PROGRESS"],"type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"type":"array"},"downloadFinishedAt":{"examples":["2025-08-22T03:59:34.902Z"],"type":"string"},"downloadRetries":{"examples":[1],"type":"integer"},"downloadStartedAt":{"examples":["2025-08-22T03:58:04.902Z"],"type":"string"},"id":{"description":"Unique id formed by combining Customer Id, Config Id, RF partition id","examples":["2829030694de11efb0c6761baa27ec60--225_16111306652446720_RFD-15:RFP-0"],"type":"string"},"partitionStatus":{"enum":["REQUEST_RECEIVED_FROM_USER","WAITING_ON_ANOTHER_UPGRADE","SENT_TO_WORKER","SUBNET_INFO_REQUESTED","SUBNET_INFO_RECEIVED","SEEDING_COMPLETED","LU_PARTITIONING_STARTED","LU_PARTITIONING_COMPLETED","IMAGE_DOWNLOADS_REQUESTED","IMAGE_DOWNLOADS_COMPLETED","REBOOTS_REQUESTED","AWAITING_OVERLAY_TUNNEL_CREATION","COMPLETED_WITH_FAILURES","REBOOTS_COMPLETED","FAILED","ABORTED"],"examples":["REBOOTS_REQUESTED"],"type":"string"},"rebootFinishedAt":{"examples":["2025-08-22T03:59:34.902Z"],"type":"string"},"rebootRetries":{"examples":[0],"type":"integer"},"rebootStartedAt":{"examples":["2025-08-22T03:59:54.902Z"],"type":"string"},"statusCounts":{"items":{"properties":{"count":{"examples":[10],"type":"integer"},"status":{"enum":["REQUEST_RECEIVED_FROM_USER","WAITING_ON_ANOTHER_UPGRADE","WAITING_FOR_SEEDING","IMAGE_DOWNLOAD_REQUESTED","IMAGE_DOWNLOAD_IN_PROGRESS","IMAGE_DOWNLOAD_COMPLETED","IMAGE_DOWNLOAD_FAILED","IMAGE_DOWNLOAD_FAILED_PERMANENTLY","UPDATING_BOOT_PARTITION","BOOT_PARTITION_UPDATED","BOOT_PARTITION_UPDATE_FAILED","SEEDING_OTHER_APS","REBOOT_READY","REBOOT_REQUESTED","REBOOTING","REBOOT_COMPLETED","FAILED","ABORTED"],"examples":["IMAGE_DOWNLOAD_IN_PROGRESS"],"type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"type":"array"},"requestReceivedAt":{"examples":["2025-08-22T03:57:14.587Z"],"type":"string"},"status":{"enum":["REQUEST_RECEIVED_FROM_USER","WAITING_ON_ANOTHER_UPGRADE","AWAITING_DEVICES_STATES","AWAITING_RF_PARTITIONING","RF_PARTITIONING_DONE","SENT_TO_WORKER","WORKER_PROCESSING_STARTED","IMAGE_DOWNLOADS_REQUESTED","IMAGE_DOWNLOADS_COMPLETED","REBOOTS_REQUESTED","ABORTED","FAILED","COMPLETED_WITH_FAILURES","COMPLETED"],"examples":["REBOOTS_REQUESTED"],"type":"string"},"statusCounts":{"items":{"properties":{"count":{"examples":[10],"type":"integer"},"status":{"enum":["REQUEST_RECEIVED_FROM_USER","WAITING_ON_ANOTHER_UPGRADE","WAITING_FOR_SEEDING","IMAGE_DOWNLOAD_REQUESTED","IMAGE_DOWNLOAD_IN_PROGRESS","IMAGE_DOWNLOAD_COMPLETED","IMAGE_DOWNLOAD_FAILED","IMAGE_DOWNLOAD_FAILED_PERMANENTLY","UPDATING_BOOT_PARTITION","BOOT_PARTITION_UPDATED","BOOT_PARTITION_UPDATE_FAILED","SEEDING_OTHER_APS","REBOOT_READY","REBOOT_REQUESTED","REBOOTING","REBOOT_COMPLETED","FAILED","ABORTED"],"examples":["IMAGE_DOWNLOAD_IN_PROGRESS"],"type":"string"}},"type":"object"},"type":"array"},"type":{"examples":["network-services/ap-live-upgrades"],"type":"string"},"updatedAt":{"examples":["2025-08-22T03:57:15.587Z"],"format":"date-time","type":"string"}},"required":["id","type","generation","createdAt","updatedAt"],"type":"object"},"type":"array"},"offset":{"description":"Offset of the first item in the response.\n","examples":[10],"format":"int32","maximum":2147483647,"minimum":0,"type":"integer"},"total":{"description":"Total number of objects matching the query.\n","examples":[20],"format":"int32","maximum":2147483647,"minimum":0,"type":"integer"}},"required":["items","count","offset","total"],"type":"object"}}},"description":"Successful response","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"400":{"$ref":"#/components/responses/BadRequestError__0052b7c55291"},"401":{"$ref":"#/components/responses/Unauthorized__000172564380"},"403":{"$ref":"#/components/responses/Forbidden__0052b7c55291"},"404":{"$ref":"#/components/responses/NotFoundError__0052b7c55291"},"429":{"$ref":"#/components/responses/TooManyRequests__000172564380"},"500":{"$ref":"#/components/responses/InternalServerError__000172564380"},"503":{"$ref":"#/components/responses/ServiceUnavailable__0a8a2717a0c0"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get all AP upgrades","tags":["Live Upgrade"],"x-source-document":{"file":"MRT/listapliveupgradesv1.json","metadata":{"info":{"description":"Serves Wi-Fi client locations with filtering options available.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Services","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Live Upgrade APIs to get AP and Gateway upgrade details","name":"Live Upgrade"}]},"pathMetadata":{},"sha256":"1b9ba35ab7a9395a45603caa24ad75868c15afeac77e06e89f1d631711033d10"}}},"/network-services/v1/ap-ranging-scans":{"post":{"description":"(USE WITH CAUTION) Will cause a wifi network outage! \n\nStarts an AP ranging scan for the given floor-id. \n\nAP ranging scans facilitate using automatic AP placement within the floorplan manager as it allows the system to collect inter-AP ranging information in a much shorter time frame.\n\nDuring an AP ranging scan, all wifi client connectivity on the 5GHz radio will be disrupted for the system-calculated scan duration. When the scan completes, the network will automatically restore itself.\n\nOnly one scan can be active on a floor at any time.\n\nThe other pre-requisites for starting an AP ranging scan are:\n\n1. APs on the given floor-id must be 'ftm-monitor' capable (ie. Running AOS firmware version 10.7.1 or greater)\n2. APs on the given floor-id must be configured in the same regulatory domain (ie. configured with the same country code)\n3. APs on the given floor must be synchronized with the same ntp server\n","operationId":"startApRangingScanV1","parameters":[{"description":"The Site ID where the scan(s) were executed.\n","in":"query","name":"site-id","required":true,"schema":{"$ref":"#/components/schemas/SiteIdopen__16fa337a67ef","format":"const","type":"string"}},{"description":"The Floor ID where the scan(s) were executed.\n","in":"query","name":"floor-id","required":true,"schema":{"$ref":"#/components/schemas/FloorIdopen__16fa337a67ef","format":"const","type":"string"}},{"description":"If present, the scan will not be started, but the request will be validated.\n","in":"query","name":"dry-run","required":false,"schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"description":"Scan parameters\n","properties":{"scanStartTime":{"description":"Timestamp in milliseconds since epoch UTC indicating the start time of the ftm-monitor mode scan. All APs will stop servicing wifi clients on the 5GHz radio 2 minutes before this time and will start the scan at the specified time. The minimum value is 5 minutes from the current time, the default value is 10 minutes from the current time if this parameter is not provided.\n","examples":["1729194009000"],"format":"const","maxLength":13,"type":"string"}},"type":"object"}}},"required":false},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartApRangingScanResponse__cb302d396c40"}}},"description":"Scan is pending\n","headers":{"Location":{"$ref":"#/components/headers/Locationopen__16fa337a67ef"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit__09b903e67f2b"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"400":{"$ref":"#/components/responses/BadRequestError__0052b7c55291"},"401":{"$ref":"#/components/responses/Unauthorized__000172564380"},"403":{"$ref":"#/components/responses/Forbidden__0052b7c55291"},"404":{"$ref":"#/components/responses/NoAPsFound__cb302d396c40"},"429":{"$ref":"#/components/responses/TooManyRequests__000172564380"},"500":{"$ref":"#/components/responses/InternalServerError__000172564380"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Start an AP ranging scan (USE WITH CAUTION)","tags":["Location"],"x-source-document":{"file":"MRT/startaprangingscanv1.json","metadata":{"info":{"description":"Serves Wi-Fi client locations with filtering options available.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Services","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"APIs that allow for interacting with Location Service offerings.","name":"Location"}]},"pathMetadata":{},"sha256":"be0d2c926ffc063e1c16650f1afb70f1c455bf241dcc9e61f7d89a812f0839e2"}}},"/network-services/v1/asset-tags":{"get":{"description":"This API endpoint retrieves a list of Asset Tags. Each Asset Tag in the returned list includes metadata details and last known location. The query parameters allow you to narrow down the results to access points that meet specific criteria, ensuring you receive only the relevant data.","operationId":"listAssetTagDataV1","parameters":[{"description":"OData 4.0 filter (limited functionality). Supports filtering on field `metadata/labels` only.\n","in":"query","name":"filter","required":false,"schema":{"$ref":"#/components/schemas/Filterasset__acdf4895bcad"}},{"description":"MAC address of the Asset Tag.\n\nNote: The filter, sort, limit, and offset parameters are not applicable if the MAC-address query parameter is specified.","in":"query","name":"mac-address","required":false,"schema":{"$ref":"#/components/schemas/MacAddressasset__a39bf531822f"}},{"description":"Retrieve data starting at the specified timestamp. Provided in RFC 3339 format. Example: `2023-01-01T23:10:41.123Z`. If no timestamp is provided, all data will be considered.\n","in":"query","name":"start-at","required":false,"schema":{"$ref":"#/components/schemas/DateTime__3f58b16772b5"}},{"description":"Denotes the maximum number of Asset Tags returned in the response. (Default: 100)\n","in":"query","name":"limit","required":false,"schema":{"$ref":"#/components/schemas/Limitasset__acdf4895bcad","format":"int32","type":"integer"}},{"description":"Specifies the zero-based resource offset from which to start the page. (Default: 0)\n","in":"query","name":"offset","required":false,"schema":{"$ref":"#/components/schemas/Offsetasset__acdf4895bcad","format":"int32","type":"integer"}},{"description":"Comma-separated list of sort expressions. Each sort expression is a property name optionally followed by a direction indicator: asc (ascending) or desc (descending).\n\nThe first sort expression in the list defines the primary sort order, the second defines the secondary sort order, and so on. If a direction indicator is omitted, the default direction is ascending.\n\nSupported fields are `metadata/name`, `macAddress`, `lastKnownLocation/batteryLevel`, and `lastKnownLocation/lastSeen`.","in":"query","name":"sort","required":false,"schema":{"example":"metadata/name asc,lastKnownLocation/lastSeen desc","format":"const","maxLength":256,"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagDataPage__acdf4895bcad"}}},"description":"Successful operation","headers":{"X-RateLimit-Limit":{"schema":{"$ref":"#/components/schemas/X-RateLimit-Limit__01cfa36ad727"}},"X-RateLimit-Remaining":{"schema":{"$ref":"#/components/schemas/X-RateLimit-Remainingasset__8de6ce4ea240"}},"X-RateLimit-Reset":{"schema":{"$ref":"#/components/schemas/X-RateLimit-Resetasset__8de6ce4ea240"}}}},"400":{"$ref":"#/components/responses/BadRequestasset__8de6ce4ea240"},"401":{"$ref":"#/components/responses/Unauthorized__000172564380"},"403":{"$ref":"#/components/responses/ForbiddenRequestasset__8de6ce4ea240"},"429":{"$ref":"#/components/responses/TooManyRequests__000172564380"},"500":{"$ref":"#/components/responses/InternalServerError__000172564380"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get a list of Asset Tags","tags":["Location"],"x-source-document":{"file":"MRT/listassettagdatav1.json","metadata":{"info":{"description":"Serves Wi-Fi client locations with filtering options available.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Services","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"APIs that allow for interacting with Location Service offerings.","name":"Location"}]},"pathMetadata":{},"sha256":"12dc450e221ca73f3cbab8cbb09e903f6cecf87296bcf7da7b3016aa514ddd8c"}}},"/network-services/v1/asset-tags/{asset-tag-id}":{"get":{"description":"This API retrieves detailed information about a specific Asset Tag.","operationId":"getAssetTagDataByAssetTagIdV1","parameters":[{"description":"ID of the Asset Tag","in":"path","name":"asset-tag-id","required":true,"schema":{"$ref":"#/components/schemas/DeviceId__8de6ce4ea240"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagData__a39bf531822f"}}},"description":"Successful operation","headers":{"X-RateLimit-Limit":{"schema":{"$ref":"#/components/schemas/X-RateLimit-Limit__01cfa36ad727"}},"X-RateLimit-Remaining":{"schema":{"$ref":"#/components/schemas/X-RateLimit-Remainingasset__8de6ce4ea240"}},"X-RateLimit-Reset":{"schema":{"$ref":"#/components/schemas/X-RateLimit-Resetasset__8de6ce4ea240"}}}},"400":{"$ref":"#/components/responses/BadRequestasset__8de6ce4ea240"},"401":{"$ref":"#/components/responses/Unauthorized__000172564380"},"403":{"$ref":"#/components/responses/ForbiddenRequestasset__8de6ce4ea240"},"404":{"$ref":"#/components/responses/NotFoundasset__8de6ce4ea240"},"429":{"$ref":"#/components/responses/TooManyRequests__000172564380"},"500":{"$ref":"#/components/responses/InternalServerError__000172564380"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get Asset Tag details","tags":["Location"],"x-source-document":{"file":"MRT/getassettagdatabyassettagidv1.json","metadata":{"info":{"description":"Serves Wi-Fi client locations with filtering options available.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Services","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"APIs that allow for interacting with Location Service offerings.","name":"Location"}]},"pathMetadata":{},"sha256":"ea69c0d586d904bf7ef6a809e6048c7efb94f5bc041c73d13f97a54902252e26"}}},"/network-services/v1/asset-tags/{asset-tag-id}/image":{"delete":{"description":"Removes the image associated with the specified Asset Tag. This operation is idempotent: if the Asset Tag has no image, 204 is returned with no error.","operationId":"deleteAssetTagImageV1","parameters":[{"description":"ID of the Asset Tag","in":"path","name":"asset-tag-id","required":true,"schema":{"$ref":"#/components/schemas/DeviceId__8de6ce4ea240"}}],"responses":{"204":{"description":"Image deleted successfully, or the Asset Tag had no image.","headers":{"X-RateLimit-Limit":{"schema":{"$ref":"#/components/schemas/X-RateLimit-Limit__01cfa36ad727"}},"X-RateLimit-Remaining":{"schema":{"$ref":"#/components/schemas/X-RateLimit-Remainingasset__8de6ce4ea240"}},"X-RateLimit-Reset":{"schema":{"$ref":"#/components/schemas/X-RateLimit-Resetasset__8de6ce4ea240"}}}},"400":{"$ref":"#/components/responses/BadRequestasset__8de6ce4ea240"},"401":{"$ref":"#/components/responses/Unauthorized__000172564380"},"403":{"$ref":"#/components/responses/ForbiddenRequestasset__8de6ce4ea240"},"404":{"$ref":"#/components/responses/NotFoundasset__8de6ce4ea240"},"429":{"$ref":"#/components/responses/TooManyRequests__000172564380"},"500":{"$ref":"#/components/responses/InternalServerError__000172564380"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Delete Asset Tag image","tags":["Location"],"x-source-document":{"file":"MRT/deleteassettagimagev1.json","metadata":{"info":{"description":"Serves Wi-Fi client locations with filtering options available.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Services","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"APIs that allow for interacting with Location Service offerings.","name":"Location"}]},"pathMetadata":{},"sha256":"7b0a12614c793352848303a16f452216c752911c6e8a10b6495fe5a6be759417"}},"get":{"description":"Returns the image associated with the specified Asset Tag. Returns 404 if the Asset Tag does not exist or has no image.","operationId":"getAssetTagImageV1","parameters":[{"description":"ID of the Asset Tag","in":"path","name":"asset-tag-id","required":true,"schema":{"$ref":"#/components/schemas/DeviceId__8de6ce4ea240"}}],"responses":{"200":{"content":{"image/jpeg":{"schema":{"description":"JPEG image of the Asset Tag.","format":"binary","type":"string"}},"image/png":{"schema":{"description":"PNG image of the Asset Tag.","format":"binary","type":"string"}},"image/webp":{"schema":{"description":"WebP image of the Asset Tag.","format":"binary","type":"string"}}},"description":"Image file associated with the Asset Tag.","headers":{"X-RateLimit-Limit":{"schema":{"$ref":"#/components/schemas/X-RateLimit-Limit__01cfa36ad727"}},"X-RateLimit-Remaining":{"schema":{"$ref":"#/components/schemas/X-RateLimit-Remainingasset__8de6ce4ea240"}},"X-RateLimit-Reset":{"schema":{"$ref":"#/components/schemas/X-RateLimit-Resetasset__8de6ce4ea240"}}}},"400":{"$ref":"#/components/responses/BadRequestasset__8de6ce4ea240"},"401":{"$ref":"#/components/responses/Unauthorized__000172564380"},"403":{"$ref":"#/components/responses/ForbiddenRequestasset__8de6ce4ea240"},"404":{"$ref":"#/components/responses/NotFoundasset__8de6ce4ea240"},"429":{"$ref":"#/components/responses/TooManyRequests__000172564380"},"500":{"$ref":"#/components/responses/InternalServerError__000172564380"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get Asset Tag image","tags":["Location"],"x-source-document":{"file":"MRT/getassettagimagev1.json","metadata":{"info":{"description":"Serves Wi-Fi client locations with filtering options available.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Services","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"APIs that allow for interacting with Location Service offerings.","name":"Location"}]},"pathMetadata":{},"sha256":"fc4284602cba30a1bb696a3472bc03820e37a2f8029c70419746fe29f7c6e8ac"}},"put":{"description":"Uploads an image for the specified Asset Tag, replacing any existing image. Supported formats: JPEG (.jpg, .jpeg), PNG (.png), and WebP (.webp). Maximum file size: 4 MB.","operationId":"updateAssetTagImageV1","parameters":[{"description":"ID of the Asset Tag","in":"path","name":"asset-tag-id","required":true,"schema":{"$ref":"#/components/schemas/DeviceId__8de6ce4ea240"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"file":{"description":"Image file to upload. Supported formats: JPEG (.jpg, .jpeg), PNG (.png), WebP (.webp). Maximum size: 4 MB.","format":"binary","type":"string"}},"required":["file"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetTagImageResponse__bd05c508a545"}}},"description":"Image uploaded successfully.","headers":{"X-RateLimit-Limit":{"schema":{"$ref":"#/components/schemas/X-RateLimit-Limit__01cfa36ad727"}},"X-RateLimit-Remaining":{"schema":{"$ref":"#/components/schemas/X-RateLimit-Remainingasset__8de6ce4ea240"}},"X-RateLimit-Reset":{"schema":{"$ref":"#/components/schemas/X-RateLimit-Resetasset__8de6ce4ea240"}}}},"400":{"$ref":"#/components/responses/BadRequestasset__8de6ce4ea240"},"401":{"$ref":"#/components/responses/Unauthorized__000172564380"},"403":{"$ref":"#/components/responses/ForbiddenRequestasset__8de6ce4ea240"},"404":{"$ref":"#/components/responses/NotFoundasset__8de6ce4ea240"},"429":{"$ref":"#/components/responses/TooManyRequests__000172564380"},"500":{"$ref":"#/components/responses/InternalServerError__000172564380"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Upload or replace Asset Tag image","tags":["Location"],"x-source-document":{"file":"MRT/updateassettagimagev1.json","metadata":{"info":{"description":"Serves Wi-Fi client locations with filtering options available.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Services","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"APIs that allow for interacting with Location Service offerings.","name":"Location"}]},"pathMetadata":{},"sha256":"7d3c7467deb9da149acdc8492ab31c474a99548ac4f5bc5cb440f37cb8f6026b"}}},"/network-services/v1/asset-tags/{asset-tag-id}/metadata":{"delete":{"description":"This API removes all metadata parameters for a specific Asset Tag.","operationId":"deleteAssetTagDataByAssetTagIdV1","parameters":[{"description":"ID of the Asset Tag","in":"path","name":"asset-tag-id","required":true,"schema":{"$ref":"#/components/schemas/DeviceId__8de6ce4ea240"}}],"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagMetadataDeleteResponse__faeb43aeab4d"}}},"description":"Asset Tag metadata delete request has been accepted","headers":{"Location":{"schema":{"$ref":"#/components/schemas/LocationHeader__a3b548d8bd3f"}},"X-RateLimit-Limit":{"schema":{"$ref":"#/components/schemas/X-RateLimit-Limit__01cfa36ad727"}},"X-RateLimit-Remaining":{"schema":{"$ref":"#/components/schemas/X-RateLimit-Remainingasset__8de6ce4ea240"}},"X-RateLimit-Reset":{"schema":{"$ref":"#/components/schemas/X-RateLimit-Resetasset__8de6ce4ea240"}}}},"400":{"$ref":"#/components/responses/BadRequestasset__8de6ce4ea240"},"401":{"$ref":"#/components/responses/Unauthorized__000172564380"},"403":{"$ref":"#/components/responses/ForbiddenRequestasset__8de6ce4ea240"},"404":{"$ref":"#/components/responses/NotFoundasset__8de6ce4ea240"},"429":{"$ref":"#/components/responses/TooManyRequests__000172564380"},"500":{"$ref":"#/components/responses/InternalServerError__000172564380"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Remove Asset Tag metadata","tags":["Location"],"x-source-document":{"file":"MRT/deleteassettagdatabyassettagidv1.json","metadata":{"info":{"description":"Serves Wi-Fi client locations with filtering options available.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Services","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"APIs that allow for interacting with Location Service offerings.","name":"Location"}]},"pathMetadata":{},"sha256":"72ffe2ac9de6d016d1c8edc28d903d4eb5ae19993e414f859ea232e3a84ad32d"}},"post":{"description":"This API creates metadata for a specific Asset Tag.","operationId":"createAssetTagDataByAssetTagIdV1","parameters":[{"description":"ID of the Asset Tag","in":"path","name":"asset-tag-id","required":true,"schema":{"$ref":"#/components/schemas/DeviceId__8de6ce4ea240"}}],"requestBody":{"content":{"application/json":{"schema":{"description":"Object with request parameters of Asset Tag metadata","properties":{"customId":{"$ref":"#/components/schemas/CustomId__a39bf531822f"},"labels":{"$ref":"#/components/schemas/TagLabels__a39bf531822f"},"name":{"$ref":"#/components/schemas/TagName__a39bf531822f"},"notes":{"$ref":"#/components/schemas/TagNotes__a39bf531822f"}},"required":[],"type":"object"}}},"required":true},"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagDataUpdateResponse__a3b548d8bd3f"}}},"description":"Asset Tag metadata update request has been accepted\n","headers":{"Location":{"schema":{"$ref":"#/components/schemas/LocationHeader__a3b548d8bd3f"}},"X-RateLimit-Limit":{"schema":{"$ref":"#/components/schemas/X-RateLimit-Limit__01cfa36ad727"}},"X-RateLimit-Remaining":{"schema":{"$ref":"#/components/schemas/X-RateLimit-Remainingasset__8de6ce4ea240"}},"X-RateLimit-Reset":{"schema":{"$ref":"#/components/schemas/X-RateLimit-Resetasset__8de6ce4ea240"}}}},"400":{"$ref":"#/components/responses/BadRequestasset__8de6ce4ea240"},"401":{"$ref":"#/components/responses/Unauthorized__000172564380"},"403":{"$ref":"#/components/responses/ForbiddenRequestasset__8de6ce4ea240"},"404":{"$ref":"#/components/responses/NotFoundasset__8de6ce4ea240"},"429":{"$ref":"#/components/responses/TooManyRequests__000172564380"},"500":{"$ref":"#/components/responses/InternalServerError__000172564380"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Create Asset Tag metadata","tags":["Location"],"x-source-document":{"file":"MRT/createassettagdatabyassettagidv1.json","metadata":{"info":{"description":"Serves Wi-Fi client locations with filtering options available.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Services","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"APIs that allow for interacting with Location Service offerings.","name":"Location"}]},"pathMetadata":{},"sha256":"30015733198548533e34aad8e4c22271e3d5029a5244bb5a42a9c468f4fff30b"}},"put":{"description":"This API replaces Asset Tag metadata with the request body content.","operationId":"updateAssetTagDataByAssetTagIdV1","parameters":[{"description":"ID of the Asset Tag","in":"path","name":"asset-tag-id","required":true,"schema":{"$ref":"#/components/schemas/DeviceId__8de6ce4ea240"}}],"requestBody":{"content":{"application/json":{"schema":{"description":"Object with request parameters of Asset Tag metadata","properties":{"customId":{"$ref":"#/components/schemas/CustomId__a39bf531822f"},"labels":{"$ref":"#/components/schemas/TagLabels__a39bf531822f"},"name":{"$ref":"#/components/schemas/TagName__a39bf531822f"},"notes":{"$ref":"#/components/schemas/TagNotes__a39bf531822f"}},"required":[],"type":"object"}}},"required":true},"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagDataUpdateResponse__a3b548d8bd3f"}}},"description":"Asset Tag metadata update request has been accepted\n","headers":{"Location":{"schema":{"$ref":"#/components/schemas/LocationHeader__a3b548d8bd3f"}},"X-RateLimit-Limit":{"schema":{"$ref":"#/components/schemas/X-RateLimit-Limit__01cfa36ad727"}},"X-RateLimit-Remaining":{"schema":{"$ref":"#/components/schemas/X-RateLimit-Remainingasset__8de6ce4ea240"}},"X-RateLimit-Reset":{"schema":{"$ref":"#/components/schemas/X-RateLimit-Resetasset__8de6ce4ea240"}}}},"400":{"$ref":"#/components/responses/BadRequestasset__8de6ce4ea240"},"401":{"$ref":"#/components/responses/Unauthorized__000172564380"},"403":{"$ref":"#/components/responses/ForbiddenRequestasset__8de6ce4ea240"},"404":{"$ref":"#/components/responses/NotFoundasset__8de6ce4ea240"},"429":{"$ref":"#/components/responses/TooManyRequests__000172564380"},"500":{"$ref":"#/components/responses/InternalServerError__000172564380"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Update Asset Tag metadata","tags":["Location"],"x-source-document":{"file":"MRT/updateassettagdatabyassettagidv1.json","metadata":{"info":{"description":"Serves Wi-Fi client locations with filtering options available.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Services","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"APIs that allow for interacting with Location Service offerings.","name":"Location"}]},"pathMetadata":{},"sha256":"1dec8158daf614ba72579426ea51d3bea28457043abf448f784751ffdd44243e"}}},"/network-services/v1/audits":{"get":{"description":"This API retrieves all the audit logs based on the tenants.","operationId":"listAuditsV1","parameters":[{"description":"Data is required starting from this timestamp, provided in RFC 3339 (and ISO 8601) format in the UTC timezone with milliseconds. The difference between *end-at* and *start-at* should be less than 90 days.","in":"query","name":"start-at","required":true,"schema":{"$ref":"#/components/schemas/DateTime__1335a419f403"}},{"description":"Data is required up to this timestamp, provided in RFC 3339 (and ISO 8601) format in the UTC timezone with milliseconds. The timestamp must be earlier than the current time and later than the start-at.","in":"query","name":"end-at","required":true,"schema":{"$ref":"#/components/schemas/DateTime__1335a419f403"}},{"description":"OData Version 4.0 filter string (limited functionality). Supports only 'and' conjunction ('or' and 'not' are NOT supported). Supported fields and operators are in the below given table.\n\n| Field | Operators |\n| --------- | -------- |\n|  `destination` | `eq` and `in` |\n| `category` | `eq` and `in` |\n| `subCategory` | `eq` and `in` |\n\n**The operators are implemented as follows:**\n\n* `eq`: Only values exactly matching the given value are returned.\n\n* `in`: Only values present in the given list are returned.\n\n.","in":"query","name":"filter","required":false,"schema":{"example":"subCategory eq 'Configuration' and  category eq 'Alert Management' and destination eq 'Global'","maxLength":1024,"type":"string"}},{"description":"Comma separated list of sort expressions. Each sort expression is a property name optionally followed by a direction indicator asc (ascending) or desc (descending).\n\nThe first sort expression in the list defines the primary sort order, the second defines the secondary sort order, and so on. If a direction indicator is omitted the default direction is ascending.\n\nSupported fields are port, speed, neighbour, neighbourFamily, nativeVlan, neighbourRole, alias, connector, lag, vlanMode, poeClass, ipv4 and mtu. Default sort by name.\n","in":"query","name":"sort","required":false,"schema":{"example":"occurredOn desc","maxLength":1024,"type":"string"}},{"description":"Specifies the maximum number of Audits returned in the response list.\n","in":"query","name":"limit","required":false,"schema":{"default":200,"example":200,"format":"int32","maximum":1000,"minimum":0,"type":"integer"}},{"description":"Number of items to skip before returning results.\n","in":"query","name":"offset","required":false,"schema":{"default":1,"example":1,"format":"int32","maximum":1000,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuditListResponse__3246551a91fd"}}},"description":"Successful operation","headers":{"X-RateLimit-Limit":{"schema":{"$ref":"#/components/schemas/X-RateLimit-Limit__01cfa36ad727"}},"X-RateLimit-Remaining":{"schema":{"$ref":"#/components/schemas/X-RateLimit-Remainingasset__8de6ce4ea240"}},"X-RateLimit-Reset":{"schema":{"$ref":"#/components/schemas/X-RateLimit-Resetasset__8de6ce4ea240"}}}},"400":{"$ref":"#/components/responses/BadRequestaudit__13edfa6d725b"},"401":{"$ref":"#/components/responses/Unauthorized__000172564380"},"403":{"$ref":"#/components/responses/ForbiddenRequestaudit__13edfa6d725b"},"404":{"$ref":"#/components/responses/Error404audit__13edfa6d725b"},"429":{"$ref":"#/components/responses/TooManyRequests__000172564380"},"500":{"$ref":"#/components/responses/InternalServerError__000172564380"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get audit logs belonging to the tenant.","tags":["Audit Trail Information"],"x-source-document":{"file":"MRT/listauditsv1.json","metadata":{"info":{"description":"Serves Wi-Fi client locations with filtering options available.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Services","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Automated audit data","name":"Audit Trail Information"}]},"pathMetadata":{},"sha256":"7aaa4593fdd56b8a5073892966ad35ae851bd3235eb47a18a7180d1df0a91aa7"}}},"/network-services/v1/audits/{id}":{"get":{"description":"Retrieves the audit log entry for a given audit ID.","operationId":"getAuditByIdV1","parameters":[{"description":"Audit Id log required","example":"1a7a4e3d-6ab8-4d34-93cf-7443e0f32bbe","in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuditDetailResponse__13edfa6d725b"}}},"description":"Successful operation","headers":{"X-RateLimit-Limit":{"schema":{"$ref":"#/components/schemas/X-RateLimit-Limit__01cfa36ad727"}},"X-RateLimit-Remaining":{"schema":{"$ref":"#/components/schemas/X-RateLimit-Remainingasset__8de6ce4ea240"}},"X-RateLimit-Reset":{"schema":{"$ref":"#/components/schemas/X-RateLimit-Resetasset__8de6ce4ea240"}}}},"400":{"$ref":"#/components/responses/BadRequestaudit__13edfa6d725b"},"401":{"$ref":"#/components/responses/Unauthorized__000172564380"},"403":{"$ref":"#/components/responses/ForbiddenRequestaudit__13edfa6d725b"},"404":{"$ref":"#/components/responses/Error404audit__13edfa6d725b"},"429":{"$ref":"#/components/responses/TooManyRequests__000172564380"},"500":{"$ref":"#/components/responses/InternalServerError__000172564380"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get Audit log based on the audit id.","tags":["Audit Trail Information"],"x-source-document":{"file":"MRT/getauditbyidv1.json","metadata":{"info":{"description":"Serves Wi-Fi client locations with filtering options available.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Services","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Automated audit data","name":"Audit Trail Information"}]},"pathMetadata":{},"sha256":"80e3bca2c8f7e33d6a69ac0fe47c75bbfa578fea6e5dd073bf34c49690181a49"}}},"/network-services/v1/device-live-upgrades":{"get":{"description":"Get AP or Gateway upgrade information in a flat format keyed by device serials.","operationId":"listDeviceLiveUpgradesV1","parameters":[{"description":"Upgrade started after - in YYYY-MM-DDTHH:MM:SS[Z|(+|-)HH:MM] format.","example":"2025-01-31T13:00:00-07:00","in":"query","name":"start-at","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"Upgrade started before - in YYYY-MM-DDTHH:MM:SS[Z|(+|-)HH:MM] format.","example":"2025-02-28T18:00:00Z","in":"query","name":"end-at","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"List of comma separated device serials. Either this parameter or scope-id must be present","example":"CNJ3KD5H7C,CX0002127","in":"query","name":"serial-numbers","required":false,"schema":{"type":"string"}},{"description":"Scope ID in which upgrade was initiated","example":"34536546654","in":"query","name":"scope-id","required":false,"schema":{"type":"string"}},{"description":"Whether or not to include historical upgrades.","in":"query","name":"history","required":false,"schema":{"default":false,"type":"boolean"}},{"description":"Specifies the maximum number of device upgrades in the response list.\n","in":"query","name":"limit","required":false,"schema":{"default":1000,"examples":[100],"format":"int32","maximum":2000,"minimum":1,"type":"integer"}},{"description":"Specifies the offset in the device upgrades list at which to begin the response.\n","in":"query","name":"offset","required":false,"schema":{"default":0,"examples":[123],"format":"int64","maximum":2147483647,"minimum":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"count":{"description":"The number of objects returned in the response.\n","examples":[100],"format":"int32","maximum":2000,"minimum":0,"type":"integer"},"items":{"items":{"properties":{"clusterName":{"examples":["3167467890:Site-LA-Cluster"],"type":"string"},"createdAt":{"examples":["2025-08-22T03:55:39.080Z"],"format":"date-time","type":"string"},"downloadFinishedAt":{"examples":["2025-08-22T03:57:39.080Z"],"type":"string"},"downloadRetries":{"examples":[0],"type":"integer"},"downloadStartedAt":{"examples":["2025-08-22T03:55:39.080Z"],"type":"string"},"failureReason":{"examples":["Device response not received post reboot"],"type":"string"},"generation":{"examples":[1],"format":"int64","type":"integer"},"id":{"description":"Unique id formed by combining Device serial number, Customer Id, Config Id","examples":["CNJ3KD5H7C:2829030694de11efb0c6761baa27ec60--225"],"type":"string"},"rebootFinishedAt":{"examples":["2025-08-22T03:57:39.080Z"],"type":"string"},"rebootRetries":{"examples":[0],"type":"integer"},"rebootStartedAt":{"examples":["2025-08-22T03:57:39.080Z"],"type":"string"},"seed":{"examples":[false],"type":"boolean"},"seedAp":{"examples":["CNJ3KD5H7C"],"type":"string"},"seededAps":{"items":{"examples":["CNJ3KD5H7C"],"type":"string"},"type":"array"},"serial":{"examples":["CNJ3KD5H7C"],"type":"string"},"status":{"enum":["NOT_STARTED","IMAGE_DOWNLOAD_REQUESTED","IMAGE_DOWNLOAD_IN_PROGRESS","IMAGE_DOWNLOAD_COMPLETED","IMAGE_DOWNLOAD_FAILED","IMAGE_DOWNLOAD_FAILED_PERMANENTLY","UPDATING_BOOT_PARTITION","BOOT_PARTITION_UPDATED","BOOT_PARTITION_UPDATE_FAILED","REBOOT_REQUESTED","REBOOTING","REBOOT_COMPLETED","FAILED","ABORTED"],"examples":["IMAGE_DOWNLOAD_IN_PROGRESS"],"type":"string"},"type":{"examples":["network-services/device-live-upgrades"],"type":"string"},"updatedAt":{"examples":["2025-08-22T03:57:39.080Z"],"format":"date-time","type":"string"},"version":{"examples":["10.5.0.1_81234"],"type":"string"}},"required":["id","type","generation","createdAt","updatedAt"],"type":"object"},"type":"array"},"offset":{"description":"Offset of the first item in the response.\n","examples":[200],"format":"int32","maximum":2147483647,"minimum":0,"type":"integer"},"total":{"description":"Total number of objects matching the query.\n","examples":[500],"format":"int32","maximum":2147483647,"minimum":0,"type":"integer"}},"required":["items","count","offset","total"],"type":"object"}}},"description":"Successful response","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"400":{"$ref":"#/components/responses/BadRequestError__0052b7c55291"},"401":{"$ref":"#/components/responses/Unauthorized__000172564380"},"403":{"$ref":"#/components/responses/Forbidden__0052b7c55291"},"404":{"$ref":"#/components/responses/NotFoundError__0052b7c55291"},"429":{"$ref":"#/components/responses/TooManyRequests__000172564380"},"500":{"$ref":"#/components/responses/InternalServerError__000172564380"},"503":{"$ref":"#/components/responses/ServiceUnavailable__0a8a2717a0c0"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get device upgrades","tags":["Live Upgrade"],"x-source-document":{"file":"MRT/listdeviceliveupgradesv1.json","metadata":{"info":{"description":"Serves Wi-Fi client locations with filtering options available.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Services","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Live Upgrade APIs to get AP and Gateway upgrade details","name":"Live Upgrade"}]},"pathMetadata":{},"sha256":"3f24c5caac50f943c9ae610ae300f51c6dab7d06ba1ef186a968662d7c675785"}}},"/network-services/v1/fco-resp-info-all":{"get":{"description":"This API retrieves the Automated Frequency Coordination channel and EIRP data for all the access points.","operationId":"listAfcRespInfoV1","parameters":[{"description":"The maximum number of items to return.","in":"query","name":"limit","schema":{"$ref":"#/components/schemas/Limitfco__09b903e67f2b"}},{"description":"The offset of the first item in the collection to return.","in":"query","name":"offset","schema":{"$ref":"#/components/schemas/Offsetfco__09b903e67f2b"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/fco_resp_info_all__09b903e67f2b"}}},"description":"Successful operation","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit__09b903e67f2b"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remainingfco__09b903e67f2b"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Resetfco__09b903e67f2b"}}},"400":{"$ref":"#/components/responses/BadRequestfco__09b903e67f2b"},"401":{"$ref":"#/components/responses/Unauthorized__000172564380"},"403":{"$ref":"#/components/responses/ForbiddenRequestfco__09b903e67f2b"},"429":{"$ref":"#/components/responses/TooManyRequests__000172564380"},"500":{"$ref":"#/components/responses/InternalServerError__000172564380"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get AFC channel data for all access points belonging to the tenant.","tags":["FCO Response Information"],"x-source-document":{"file":"MRT/listafcrespinfov1.json","metadata":{"info":{"description":"Serves Wi-Fi client locations with filtering options available.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Services","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Automated Frequency Coordination channel data","name":"FCO Response Information"}]},"pathMetadata":{},"sha256":"e08c624b000f72d30a4c8504e39c26b0eeba1ed2d806e132dff0ebca95100fbc"}}},"/network-services/v1/fco-resp-info/{serial-number}":{"get":{"description":"This API retrieves the Automated Frequency Coordination channel and EIRP data for the specific AP serial number that has been provided.","operationId":"getAfcRespInfoV1","parameters":[{"description":"The serial number of the access point for which AFC channel data is required","example":"ABCDEFG99H","in":"path","name":"serial-number","required":true,"schema":{"format":"string","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/fco_resp_info__09b903e67f2b"}}},"description":"Successful operation","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit__09b903e67f2b"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remainingfco__09b903e67f2b"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Resetfco__09b903e67f2b"}}},"400":{"$ref":"#/components/responses/BadRequestfco__09b903e67f2b"},"401":{"$ref":"#/components/responses/Unauthorized__000172564380"},"403":{"$ref":"#/components/responses/ForbiddenRequestfco__09b903e67f2b"},"429":{"$ref":"#/components/responses/TooManyRequests__000172564380"},"500":{"$ref":"#/components/responses/InternalServerError__000172564380"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get AFC channel data of a specific AP.","tags":["FCO Response Information"],"x-source-document":{"file":"MRT/getafcrespinfov1.json","metadata":{"info":{"description":"Serves Wi-Fi client locations with filtering options available.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Services","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Automated Frequency Coordination channel data","name":"FCO Response Information"}]},"pathMetadata":{},"sha256":"1b28fc0cb221c203e8c8a068ce0f2ce786ac6fd78989b77f1ec7cb57dd4c9c19"}}},"/network-services/v1/firmware-details":{"get":{"description":"This API endpoint retrieves list of device's firmware details such as firmware version, upgrade status, recommended version, firmware classification and last upgraded timestamp.\n","operationId":"getFirmwareDetailsListV1","parameters":[{"$ref":"#/components/parameters/Filter__c0c1228d8f7d"},{"$ref":"#/components/parameters/SortV1__c0c1228d8f7d"},{"description":"Denotes the maximum number of items returned in the response. Maximum value is 1000.\n","in":"query","name":"limit","required":false,"schema":{"$ref":"#/components/schemas/Limitfirmware__c0c1228d8f7d"}},{"description":"Specifies the pagination cursor for the next page of resources. The minimum value is 1.\n","in":"query","name":"next","required":false,"schema":{"$ref":"#/components/schemas/Next__6a214df6704a"}}],"responses":{"200":{"$ref":"#/components/responses/FirmwareDetailsListResponse__c0c1228d8f7d"},"400":{"$ref":"#/components/responses/BadRequestError__0052b7c55291"},"401":{"$ref":"#/components/responses/Unauthorized__000172564380"},"403":{"$ref":"#/components/responses/Forbidden__0052b7c55291"},"429":{"$ref":"#/components/responses/TooManyRequests__000172564380"},"500":{"$ref":"#/components/responses/InternalServerError__000172564380"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get device list with firmware details","tags":["Firmware Management"],"x-source-document":{"file":"MRT/getfirmwaredetailslistv1.json","metadata":{"info":{"description":"Serves Wi-Fi client locations with filtering options available.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Services","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Firmware management APIs","name":"Firmware Management"}]},"pathMetadata":{},"sha256":"6a94b9624fc92038f10bc5a8f669a0c7644150b49994d4d7c4d9d3283e784f7e"}}},"/network-services/v1/gateway-live-upgrades":{"get":{"description":"Get Gateway upgrade information organized in a hierarchy from the config scope at which they were triggered from.","operationId":"listGatewayLiveUpgradesV1","parameters":[{"description":"Upgrade started after - in YYYY-MM-DDTHH:MM:SS[Z|(+|-)HH:MM] format.","example":"2025-01-31T13:00:00-07:00","in":"query","name":"start-at","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"Upgrade started before - in YYYY-MM-DDTHH:MM:SS[Z|(+|-)HH:MM] format.","example":"2025-02-28T18:00:00Z","in":"query","name":"end-at","required":false,"schema":{"format":"date-time","type":"string"}},{"description":"Scope ID in which upgrade was initiated.","example":"34536546654","in":"query","name":"scope-id","required":false,"schema":{"type":"string"}},{"description":"Whether or not to include historical upgrades.","in":"query","name":"history","required":false,"schema":{"default":false,"type":"boolean"}},{"description":"Specifies the maximum number of upgrades in the response list.\n","in":"query","name":"limit","required":false,"schema":{"default":10,"examples":[5],"format":"int32","maximum":10,"minimum":1,"type":"integer"}},{"description":"Specifies the offset in the upgrades list at which to begin the response.\n","in":"query","name":"offset","required":false,"schema":{"default":0,"examples":[123],"format":"int64","maximum":2147483647,"minimum":0,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"count":{"description":"The number of objects returned in the response.\n","examples":[2],"format":"int32","maximum":10,"minimum":0,"type":"integer"},"items":{"items":{"properties":{"clusters":{"items":{"properties":{"clusterStatus":{"examples":["REBOOT_STARTED"],"type":"string"},"downloadFinishedAt":{"examples":["2025-08-22T03:59:34.902Z"],"type":"string"},"downloadRetries":{"examples":[1],"type":"integer"},"downloadStartedAt":{"examples":["2025-08-22T03:58:04.902Z"],"type":"string"},"gateways":{"items":{"properties":{"clusterName":{"examples":["3456789012:Site-LA-Cluster"],"type":"string"},"downloadFinishedAt":{"examples":["2025-08-22T03:59:34.902Z"],"type":"string"},"downloadRetries":{"examples":[1],"type":"integer"},"downloadStartedAt":{"examples":["2025-08-22T03:58:04.902Z"],"type":"string"},"failureReason":{"examples":["Device response not received post reboot"],"type":"string"},"rebootFinishedAt":{"examples":["2025-08-22T03:59:34.902Z"],"type":"string"},"rebootRetries":{"examples":[0],"type":"integer"},"rebootStartedAt":{"examples":["2025-08-22T03:59:54.902Z"],"type":"string"},"serial":{"examples":["CNJ3KD5H7C"],"type":"string"},"status":{"enum":["REQUEST_RECEIVED_FROM_USER","WAITING_ON_ANOTHER_UPGRADE","IMAGE_DOWNLOAD_REQUESTED","IMAGE_DOWNLOAD_IN_PROGRESS","IMAGE_DOWNLOAD_COMPLETED","IMAGE_DOWNLOAD_FAILED","IMAGE_DOWNLOAD_FAILED_PERMANENTLY","UPDATING_BOOT_PARTITION","REBOOT_READY","REBOOT_REQUESTED","REBOOTING","REBOOT_COMPLETED","FAILED","ABORTED"],"examples":["IMAGE_DOWNLOAD_IN_PROGRESS"],"type":"string"},"version":{"examples":["10.5.0.1_81235"],"type":"string"}},"type":"object"},"type":"array"},"name":{"examples":["3456789012:Site-LA-Cluster"],"type":"string"},"rebootFinishedAt":{"examples":["2025-08-22T03:59:34.902Z"],"type":"string"},"rebootRetries":{"examples":[0],"type":"integer"},"rebootStartedAt":{"examples":["2025-08-22T03:59:54.902Z"],"type":"string"},"statusCounts":{"items":{"properties":{"count":{"examples":[10],"type":"integer"},"status":{"enum":["REQUEST_RECEIVED_FROM_USER","WAITING_ON_ANOTHER_UPGRADE","IMAGE_DOWNLOAD_REQUESTED","IMAGE_DOWNLOAD_IN_PROGRESS","IMAGE_DOWNLOAD_COMPLETED","IMAGE_DOWNLOAD_FAILED","IMAGE_DOWNLOAD_FAILED_PERMANENTLY","UPDATING_BOOT_PARTITION","REBOOT_READY","REBOOT_REQUESTED","REBOOTING","REBOOT_COMPLETED","FAILED","ABORTED"],"examples":["IMAGE_DOWNLOAD_IN_PROGRESS"],"type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"type":"array"},"completedAt":{"examples":["2025-08-22T04:57:15.587Z"],"type":"string"},"createdAt":{"examples":["2025-08-22T03:57:14.587Z"],"format":"date-time","type":"string"},"customerId":{"examples":["2829030694de11efb0c6761baa27ec60"],"type":"string"},"generation":{"examples":[1],"format":"int64","type":"integer"},"id":{"description":"Unique id formed by combining Customer Id, Config Id","examples":["2829030694de11efb0c6761baa27ec60--225"],"type":"string"},"initiatedAt":{"examples":["2025-08-22T03:57:15.587Z"],"type":"string"},"requestReceivedAt":{"examples":["2025-08-22T03:57:14.587Z"],"type":"string"},"status":{"enum":["REQUEST_RECEIVED_FROM_USER","WAITING_ON_ANOTHER_UPGRADE","SENT_TO_WORKER","IMAGE_DOWNLOADS_REQUESTED","IMAGE_DOWNLOADS_COMPLETED","REBOOTS_REQUESTED","ABORTED","FAILED","COMPLETED_WITH_FAILURES","COMPLETED"],"examples":["REBOOTS_REQUESTED"],"type":"string"},"statusCounts":{"items":{"properties":{"count":{"examples":[10],"type":"integer"},"status":{"enum":["REQUEST_RECEIVED_FROM_USER","WAITING_ON_ANOTHER_UPGRADE","IMAGE_DOWNLOAD_REQUESTED","IMAGE_DOWNLOAD_IN_PROGRESS","IMAGE_DOWNLOAD_COMPLETED","IMAGE_DOWNLOAD_FAILED","IMAGE_DOWNLOAD_FAILED_PERMANENTLY","UPDATING_BOOT_PARTITION","REBOOT_READY","REBOOT_REQUESTED","REBOOTING","REBOOT_COMPLETED","FAILED","ABORTED"],"examples":["IMAGE_DOWNLOAD_IN_PROGRESS"],"type":"string"}},"type":"object"},"type":"array"},"type":{"examples":["network-services/gateway-live-upgrades"],"type":"string"},"updatedAt":{"examples":["2025-08-22T03:57:15.587Z"],"format":"date-time","type":"string"}},"required":["id","type","generation","createdAt","updatedAt"],"type":"object"},"type":"array"},"offset":{"description":"Offset of the first item in the response.\n","examples":[10],"format":"int32","maximum":2147483647,"minimum":0,"type":"integer"},"total":{"description":"Total number of objects matching the query.\n","examples":[20],"format":"int32","maximum":2147483647,"minimum":0,"type":"integer"}},"required":["items","count","offset","total"],"type":"object"}}},"description":"Successful response","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"400":{"$ref":"#/components/responses/BadRequestError__0052b7c55291"},"401":{"$ref":"#/components/responses/Unauthorized__000172564380"},"403":{"$ref":"#/components/responses/Forbidden__0052b7c55291"},"404":{"$ref":"#/components/responses/NotFoundError__0052b7c55291"},"429":{"$ref":"#/components/responses/TooManyRequests__000172564380"},"500":{"$ref":"#/components/responses/InternalServerError__000172564380"},"503":{"$ref":"#/components/responses/ServiceUnavailable__0a8a2717a0c0"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get all Gateway upgrades","tags":["Live Upgrade"],"x-source-document":{"file":"MRT/listgatewayliveupgradesv1.json","metadata":{"info":{"description":"Serves Wi-Fi client locations with filtering options available.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Services","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Live Upgrade APIs to get AP and Gateway upgrade details","name":"Live Upgrade"}]},"pathMetadata":{},"sha256":"936d7f8952d2fede9e4dae31998ff896ef9f5743f37afb16609f5ad8e44b48f2"}}},"/network-services/v1/location-analytics/sites/insights":{"get":{"description":"This API provides the insights for each site of a tenant for a given time range.","operationId":"getLaSitesInsightsForAPIV1","parameters":[{"$ref":"#/components/parameters/start-at__0052b7c55291"},{"$ref":"#/components/parameters/end-at__0052b7c55291"},{"$ref":"#/components/parameters/limit__f20300aab7a0"},{"$ref":"#/components/parameters/offset__f20300aab7a0"},{"$ref":"#/components/parameters/sort__f20300aab7a0"}],"responses":{"200":{"$ref":"#/components/responses/LaSitesInsightsResponseForAPI__f20300aab7a0"},"400":{"$ref":"#/components/responses/BadRequestError__0052b7c55291"},"401":{"$ref":"#/components/responses/Unauthorized__000172564380"},"403":{"$ref":"#/components/responses/Forbidden__0052b7c55291"},"404":{"$ref":"#/components/responses/NotFoundError__0052b7c55291"},"429":{"$ref":"#/components/responses/TooManyRequests__000172564380"},"500":{"$ref":"#/components/responses/InternalServerError__000172564380"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get the insights for each site of a tenant for a given time range.","tags":["Location Analytics"],"x-source-document":{"file":"MRT/getlasitesinsightsforapiv1.json","metadata":{"info":{"description":"Serves Wi-Fi client locations with filtering options available.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Services","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Location Analytics APIs to get the client related analytics describing how the client is classified.","name":"Location Analytics"}]},"pathMetadata":{},"sha256":"95b580a495bb5860e60d4f87b34f44c2e59479e50b483e70ae77cb792516e7df"}}},"/network-services/v1/location-analytics/trends":{"get":{"description":"This API provides the trends of visitors and passerby for a tenant across all the sites or for a specific site within the given time range.","operationId":"getLaTrendsForAPIV1","parameters":[{"$ref":"#/components/parameters/start-at__0052b7c55291"},{"$ref":"#/components/parameters/end-at__0052b7c55291"},{"$ref":"#/components/parameters/site-id__0052b7c55291"}],"responses":{"200":{"$ref":"#/components/responses/LaTrendsResponseForAPI__0052b7c55291"},"400":{"$ref":"#/components/responses/BadRequestError__0052b7c55291"},"401":{"$ref":"#/components/responses/Unauthorized__000172564380"},"403":{"$ref":"#/components/responses/Forbidden__0052b7c55291"},"404":{"$ref":"#/components/responses/NotFoundError__0052b7c55291"},"429":{"$ref":"#/components/responses/TooManyRequests__000172564380"},"500":{"$ref":"#/components/responses/InternalServerError__000172564380"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get all the trends of a client for a tenant or a site for a given time range.","tags":["Location Analytics"],"x-source-document":{"file":"MRT/getlatrendsforapiv1.json","metadata":{"info":{"description":"Serves Wi-Fi client locations with filtering options available.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Services","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Location Analytics APIs to get the client related analytics describing how the client is classified.","name":"Location Analytics"}]},"pathMetadata":{},"sha256":"394d95e848f0543a5ff98c693b18b99c3516c7e5782de90708f5b136d2c34bbe"}}},"/network-services/v1/sitemaps/{site-id}/floors/{floor-id}/ap-ranging-scans":{"get":{"description":"Gets a list of scan statuses for AP ranging scans that were triggered on this floor-id.\n","operationId":"getApRangingScanListV1","parameters":[{"description":"Site ID where the scan(s) were executed.\n","in":"path","name":"site-id","required":true,"schema":{"$ref":"#/components/schemas/SiteIdopen__16fa337a67ef","format":"const","type":"string"}},{"description":"Floor ID where the scan(s) were executed.\n","in":"path","name":"floor-id","required":true,"schema":{"$ref":"#/components/schemas/FloorIdopen__16fa337a67ef","format":"const","type":"string"}},{"in":"query","name":"limit","required":false,"schema":{"$ref":"#/components/schemas/LimitParam__306cd00aed2d","format":"int32","type":"integer"}},{"in":"query","name":"next","required":false,"schema":{"$ref":"#/components/schemas/NextParam__306cd00aed2d","format":"const","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListApRangingScanStatus__306cd00aed2d"}}},"description":"List of AP ranging scans matching the floor-id\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit__09b903e67f2b"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"400":{"$ref":"#/components/responses/BadRequestError__0052b7c55291"},"401":{"$ref":"#/components/responses/Unauthorized__000172564380"},"403":{"$ref":"#/components/responses/Forbidden__0052b7c55291"},"429":{"$ref":"#/components/responses/TooManyRequests__000172564380"},"500":{"$ref":"#/components/responses/InternalServerError__000172564380"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"List AP ranging scans","tags":["Location"],"x-source-document":{"file":"MRT/getaprangingscanlistv1.json","metadata":{"info":{"description":"Serves Wi-Fi client locations with filtering options available.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Services","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"APIs that allow for interacting with Location Service offerings.","name":"Location"}]},"pathMetadata":{},"sha256":"e2705c68b3507e68f33eb3453197e2bbcde19997c6462ed7a745916bb85a0afb"}}},"/network-services/v1/sitemaps/{site-id}/floors/{floor-id}/ap-ranging-scans/{scan-id}":{"delete":{"description":"Stop a previously created AP ranging scan. Only scans in the PENDING state can successfully be stopped. Once a scan has transitioned to the SCHEDULED or SCANNING states, the user will need to wait for the scan to complete before the network can be restored. Scans in the other states are already stopped, so stopping them will effectively be a no-op.\n","operationId":"stopApRangingScanV1","parameters":[{"description":"Site ID where the scan(s) were executed.\n","in":"path","name":"site-id","required":true,"schema":{"$ref":"#/components/schemas/SiteIdopen__16fa337a67ef","format":"const","type":"string"}},{"description":"Floor ID where the scan(s) were executed.\n","in":"path","name":"floor-id","required":true,"schema":{"$ref":"#/components/schemas/FloorIdopen__16fa337a67ef","format":"const","type":"string"}},{"description":"The Scan ID.\n","in":"path","name":"scan-id","required":true,"schema":{"$ref":"#/components/schemas/SessionId__16fa337a67ef"}}],"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApRangingScanDeleteResponse__16fa337a67ef"}}},"description":"Scan was successfully stopped\n","headers":{"Location":{"$ref":"#/components/headers/Locationopen__16fa337a67ef"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit__09b903e67f2b"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"400":{"$ref":"#/components/responses/BadRequestError__0052b7c55291"},"401":{"$ref":"#/components/responses/Unauthorized__000172564380"},"403":{"$ref":"#/components/responses/Forbidden__0052b7c55291"},"404":{"$ref":"#/components/responses/ScanNotFound__16fa337a67ef"},"429":{"$ref":"#/components/responses/TooManyRequests__000172564380"},"500":{"$ref":"#/components/responses/InternalServerError__000172564380"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Stop a scan","tags":["Location"],"x-source-document":{"file":"MRT/stopaprangingscanv1.json","metadata":{"info":{"description":"Serves Wi-Fi client locations with filtering options available.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Services","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"APIs that allow for interacting with Location Service offerings.","name":"Location"}]},"pathMetadata":{},"sha256":"c1e2c22ee81b027c21a23d453052cb7235e57b72eaa2c34b434429ab194300dd"}},"get":{"description":"Returns the status of the AP ranging scan identified by the scan-id.","operationId":"getApRangingScanV1","parameters":[{"description":"Site ID where the scan(s) were executed.\n","in":"path","name":"site-id","required":true,"schema":{"$ref":"#/components/schemas/SiteIdopen__16fa337a67ef","format":"const","type":"string"}},{"description":"Floor ID where the scan(s) were executed.\n","in":"path","name":"floor-id","required":true,"schema":{"$ref":"#/components/schemas/FloorIdopen__16fa337a67ef","format":"const","type":"string"}},{"description":"The Scan ID.\n","in":"path","name":"scan-id","required":true,"schema":{"$ref":"#/components/schemas/SessionId__16fa337a67ef"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApRangingScanStatus__306cd00aed2d"}}},"description":"Returned FTM scan resource.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit__09b903e67f2b"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"400":{"$ref":"#/components/responses/BadRequestError__0052b7c55291"},"401":{"$ref":"#/components/responses/Unauthorized__000172564380"},"403":{"$ref":"#/components/responses/Forbidden__0052b7c55291"},"429":{"$ref":"#/components/responses/TooManyRequests__000172564380"},"500":{"$ref":"#/components/responses/InternalServerError__000172564380"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get scan resource","tags":["Location"],"x-source-document":{"file":"MRT/getaprangingscanv1.json","metadata":{"info":{"description":"Serves Wi-Fi client locations with filtering options available.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Services","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"APIs that allow for interacting with Location Service offerings.","name":"Location"}]},"pathMetadata":{},"sha256":"abb5ae32aa2aff793e52e3ecb874764d4d19eb77b9e67709723901e8bc26617e"}}},"/network-services/v1/sites/{site-id}/device-locations":{"get":{"description":"This API endpoint retrieves a list of network devices that have been assigned location information (e.g. after being placed on a floorplan and/or automatically determined by the system). Each device in the returned list includes details like serial number, MAC address, IP address, consolidated location, etc. The consolidated location of a device is the best known location of the device (x/y coordinates on the floorplan and/or latitude/longitude geographic coordinates) with the administrator-specified position always taking precedence.  The query parameters allow you to narrow down the results to devices that meet specific criteria, ensuring you receive only the relevant data. Device lists are restricted to a single site represented by the required site-id query parameter.","operationId":"getDeviceLocationsV1","parameters":[{"description":"The ID of the Site for which device location information is requested.\n","in":"path","name":"site-id","required":true,"schema":{"$ref":"#/components/schemas/SiteIddeviceloc__6a214df6704a","format":"const","type":"string"}},{"description":"OData 4.0 filter (limited functionality). Supports only 'and' conjunction ('or' and 'not' are NOT supported). Supports filtering on fields floorId and buildingId only.\n","in":"query","name":"filter","required":false,"schema":{"$ref":"#/components/schemas/Filter__6a214df6704a"}},{"in":"query","name":"limit","required":false,"schema":{"$ref":"#/components/schemas/Limitdeviceloc__6a214df6704a","format":"int32","type":"integer"}},{"in":"query","name":"next","required":false,"schema":{"$ref":"#/components/schemas/Next__6a214df6704a","format":"const","type":"string"}},{"description":"Filter for devices with or without location based on this parameter.\n","in":"query","name":"with-location","required":false,"schema":{"default":true,"examples":[true],"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListDeviceLocationSummary__6a214df6704a"}}},"description":"Returned device list with their consolidated locations.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit__09b903e67f2b"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"400":{"$ref":"#/components/responses/BadRequestError__0052b7c55291"},"401":{"$ref":"#/components/responses/Unauthorized__000172564380"},"403":{"$ref":"#/components/responses/Forbidden__0052b7c55291"},"429":{"$ref":"#/components/responses/TooManyRequests__000172564380"},"500":{"$ref":"#/components/responses/InternalServerError__000172564380"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"List devices with location information","tags":["Location"],"x-source-document":{"file":"MRT/getdevicelocationsv1.json","metadata":{"info":{"description":"Serves Wi-Fi client locations with filtering options available.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Services","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"APIs that allow for interacting with Location Service offerings.","name":"Location"}]},"pathMetadata":{},"sha256":"c8b523a1aad4ed8d4a214b9be7f12f4679574d400fbb93e4bbc69903291d7648"}}},"/network-services/v1/sites/{site-id}/device-locations/{location-id}":{"get":{"description":"This API provides the location details for a specific location resource. The site-id must be provided alongside the location-id to properly fetch the location data. Each unique location-id represents a change in device location, for example if an AP was moved from one floorplan to another a new location resource with a unique location-id will be created.","operationId":"getLocationByIdV1","parameters":[{"description":"ID of the Site for which device location information is requested.\n","in":"path","name":"site-id","required":true,"schema":{"$ref":"#/components/schemas/SiteIddeviceloc__6a214df6704a","format":"const","type":"string"}},{"description":"The ID of the location resource to be fetched.\n","in":"path","name":"location-id","required":true,"schema":{"$ref":"#/components/schemas/LocationId__6a214df6704a"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceLocationSummary__6a214df6704a"}}},"description":"Returned device location resource.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit__09b903e67f2b"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"400":{"$ref":"#/components/responses/BadRequestError__0052b7c55291"},"401":{"$ref":"#/components/responses/Unauthorized__000172564380"},"403":{"$ref":"#/components/responses/Forbidden__0052b7c55291"},"429":{"$ref":"#/components/responses/TooManyRequests__000172564380"},"500":{"$ref":"#/components/responses/InternalServerError__000172564380"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get location resource","tags":["Location"],"x-source-document":{"file":"MRT/getlocationbyidv1.json","metadata":{"info":{"description":"Serves Wi-Fi client locations with filtering options available.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Services","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"APIs that allow for interacting with Location Service offerings.","name":"Location"}]},"pathMetadata":{},"sha256":"377b99e3c1df04b2862ba8dce4587980e1ba93f118b02c5633c9a54d1ac515ac"}}},"/network-services/v1/sites/{site-id}/devices/{serial-number}/location":{"delete":{"description":"Remove the adminSpecifiedLocation coordinates of a device. The device must be identified by the site-id and serial-number.\nIf the AP has a built-in GPS receiver and a GPS position is known, then the consolidated device location will fall back to the last known GPS position.\n","operationId":"delDeviceAdminLocationV1","parameters":[{"description":"The ID of the Site for which device location information should be removed.\n","in":"path","name":"site-id","required":true,"schema":{"$ref":"#/components/schemas/SiteIddeviceloc__6a214df6704a","format":"const","type":"string"}},{"description":"The device serial for which the location information is being removed.\n","in":"path","name":"serial-number","required":true,"schema":{"$ref":"#/components/schemas/DeviceSerial__6a214df6704a"}}],"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationDeleteResponse__8bd44b0ed12d"}}},"description":"Device coordinates delete accepted. Location will be updated shortly in the database.\n","headers":{"Location":{"$ref":"#/components/headers/Location__8bd44b0ed12d"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit__09b903e67f2b"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"400":{"$ref":"#/components/responses/BadRequestError__0052b7c55291"},"401":{"$ref":"#/components/responses/Unauthorized__000172564380"},"403":{"$ref":"#/components/responses/Forbidden__0052b7c55291"},"404":{"$ref":"#/components/responses/DeviceNotFound__8bd44b0ed12d"},"429":{"$ref":"#/components/responses/TooManyRequests__000172564380"},"500":{"$ref":"#/components/responses/InternalServerError__000172564380"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Delete device coordinates","tags":["Location"],"x-source-document":{"file":"MRT/deldeviceadminlocationv1.json","metadata":{"info":{"description":"Serves Wi-Fi client locations with filtering options available.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Services","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"APIs that allow for interacting with Location Service offerings.","name":"Location"}]},"pathMetadata":{},"sha256":"49b2be7b00520e7cf792a7506d37474cd2d708b9312899523902dd477d7c79d7"}},"get":{"description":"Return the location information for a device identified by the required parameters site-id and serial-number. The device must exist in the system and have associated location data.\n","operationId":"getDeviceDetailedLocationV1","parameters":[{"description":"The ID of the Site for which device location information is requested.\n","in":"path","name":"site-id","required":true,"schema":{"$ref":"#/components/schemas/SiteIddeviceloc__6a214df6704a","format":"const","type":"string"}},{"description":"The device serial for which the location information is being requested.\n","in":"path","name":"serial-number","required":true,"schema":{"$ref":"#/components/schemas/DeviceSerial__6a214df6704a","format":"const","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeviceLocationSummary__6a214df6704a"}}},"description":"Object containing the device's geographic coordinates matching the request criteria. \nIf no device with the requested information is found, then an empty list is returned.\n","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit__09b903e67f2b"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"400":{"$ref":"#/components/responses/BadRequestError__0052b7c55291"},"401":{"$ref":"#/components/responses/Unauthorized__000172564380"},"403":{"$ref":"#/components/responses/Forbidden__0052b7c55291"},"404":{"$ref":"#/components/responses/DeviceNotFound__8bd44b0ed12d"},"429":{"$ref":"#/components/responses/TooManyRequests__000172564380"},"500":{"$ref":"#/components/responses/InternalServerError__000172564380"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get device location details","tags":["Location"],"x-source-document":{"file":"MRT/getdevicedetailedlocationv1.json","metadata":{"info":{"description":"Serves Wi-Fi client locations with filtering options available.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Services","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"APIs that allow for interacting with Location Service offerings.","name":"Location"}]},"pathMetadata":{},"sha256":"49edf999a6dcb11e1af9e55ffd2c6afc2c920acc53eeb961751b87ad2486dafc"}},"post":{"description":"This API can set or update the adminSpecifiedLocation of an AP. The device to update must be identified by both the site-id and serial-number and MUST exist in the system to set its location. The adminSpecifiedLocation of a device will always override the latest consolidatedLocation.\nIf the `center` is provided in the request body, these coordinates will be programmed into the AP to support FTM based client location services (if enabled).\n","operationId":"putDeviceAdminLocationV1","parameters":[{"description":"The ID of the Site for which device location information is being set.\n","in":"path","name":"site-id","required":true,"schema":{"$ref":"#/components/schemas/SiteIddeviceloc__6a214df6704a","format":"const","type":"string"}},{"description":"The device serial for which the location information is being requested.\n","in":"path","name":"serial-number","required":true,"schema":{"$ref":"#/components/schemas/DeviceSerial__6a214df6704a","format":"const","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"description":"Administratively determined device geo and relative location.\n","properties":{"altitude":{"$ref":"#/components/schemas/Altitude__6a214df6704a"},"cartesianCoordinates":{"$ref":"#/components/schemas/CartesianCoordinates__6a214df6704a"},"center":{"$ref":"#/components/schemas/Center__6a214df6704a"},"lciUncertainty":{"$ref":"#/components/schemas/LCIUncertainty__6a214df6704a"}},"required":["center"],"type":"object"}}},"required":true},"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationUpdateResponse__df5276e7183b"}}},"description":"Device coordinates update accepted. Location will be updated shortly in the database.\n","headers":{"Location":{"$ref":"#/components/headers/Location__8bd44b0ed12d"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit__09b903e67f2b"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"400":{"$ref":"#/components/responses/BadRequestError__0052b7c55291"},"401":{"$ref":"#/components/responses/Unauthorized__000172564380"},"403":{"$ref":"#/components/responses/Forbidden__0052b7c55291"},"404":{"$ref":"#/components/responses/DeviceNotFound__8bd44b0ed12d"},"429":{"$ref":"#/components/responses/TooManyRequests__000172564380"},"500":{"$ref":"#/components/responses/InternalServerError__000172564380"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Set device coordinates","tags":["Location"],"x-source-document":{"file":"MRT/putdeviceadminlocationv1.json","metadata":{"info":{"description":"Serves Wi-Fi client locations with filtering options available.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Services","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"APIs that allow for interacting with Location Service offerings.","name":"Location"}]},"pathMetadata":{},"sha256":"4b5efd5b454479973b0c4f8321dee0db71414fac9d306dc8db5474baff7e5662"}}},"/network-services/v1/webhooks":{"get":{"description":"This API endpoint retrieves a list of Webhooks and the details associated to the receiver such as the endpointURL and the authMechanism along with createdAt and updatedAt timestamps. Results can optionally be narrowed using an OData filter query parameter.","operationId":"getWebhooksV1","parameters":[{"$ref":"#/components/parameters/Filterwebhooks__2efde5827a74"}],"responses":{"200":{"$ref":"#/components/responses/WebhookDetailsList__2efde5827a74"},"400":{"$ref":"#/components/responses/BadRequestError__0052b7c55291"},"401":{"$ref":"#/components/responses/Unauthorized__000172564380"},"403":{"$ref":"#/components/responses/Forbidden__0052b7c55291"},"404":{"$ref":"#/components/responses/NotFoundError__0052b7c55291"},"429":{"$ref":"#/components/responses/TooManyRequests__000172564380"},"500":{"$ref":"#/components/responses/InternalServerError__000172564380"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"List all Webhooks","tags":["Webhooks"],"x-source-document":{"file":"MRT/getwebhooksv1.json","metadata":{"info":{"description":"Serves Wi-Fi client locations with filtering options available.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Services","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"APIs for managing webhooks.","name":"Webhooks"}]},"pathMetadata":{},"sha256":"c7a3055bfc3f7f5e6a2a49a5852f2d67c49e8cb9a440a3581862838dabe232d7"}},"post":{"description":"This API endpoint creates a new Webhook using details of the receiver such as the endpoint URL and the authMechanism. Auth mechanism can be either API key or OIDC. Use dropdown beside input in body parameters to change authMechanism and provide respective parameters for the authentication type.","operationId":"createWebhookV1","requestBody":{"content":{"application/json":{"examples":{"apiKeyAuthentication":{"$ref":"#/components/examples/WebhookCreateApiKeyRequest__c1c7772865ac"},"oidcAuthentication":{"$ref":"#/components/examples/WebhookCreateOidcRequest__c1c7772865ac"}},"schema":{"$ref":"#/components/schemas/WebhookCreateInput__c1c7772865ac"}}},"description":"Request body for creating a new Webhook."},"responses":{"200":{"$ref":"#/components/responses/WebhookCreate__c1c7772865ac"},"400":{"$ref":"#/components/responses/BadRequestError__0052b7c55291"},"401":{"$ref":"#/components/responses/Unauthorized__000172564380"},"403":{"$ref":"#/components/responses/Forbidden__0052b7c55291"},"404":{"$ref":"#/components/responses/NotFoundError__0052b7c55291"},"429":{"$ref":"#/components/responses/TooManyRequests__000172564380"},"500":{"$ref":"#/components/responses/InternalServerError__000172564380"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Create a Webhook","tags":["Webhooks"],"x-source-document":{"file":"MRT/createwebhookv1.json","metadata":{"info":{"description":"Serves Wi-Fi client locations with filtering options available.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Services","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"APIs for managing webhooks.","name":"Webhooks"}]},"pathMetadata":{},"sha256":"31dd0c8c42ed0b99a697af5048f8790c3a918bb51931998cfe267fae22882032"}}},"/network-services/v1/webhooks/{id}":{"delete":{"description":"This API endpoint deletes an existing Webhook.","operationId":"deleteWebhookV1","parameters":[{"$ref":"#/components/parameters/Id__715550e8d02e"}],"responses":{"204":{"description":"Webhook deleted successfully","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset__004689200476"}}},"400":{"$ref":"#/components/responses/BadRequestError__0052b7c55291"},"401":{"$ref":"#/components/responses/Unauthorized__000172564380"},"403":{"$ref":"#/components/responses/Forbidden__0052b7c55291"},"404":{"$ref":"#/components/responses/NotFoundError__0052b7c55291"},"429":{"$ref":"#/components/responses/TooManyRequests__000172564380"},"500":{"$ref":"#/components/responses/InternalServerError__000172564380"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Delete a Webhook by ID","tags":["Webhooks"],"x-source-document":{"file":"MRT/deletewebhookv1.json","metadata":{"info":{"description":"Serves Wi-Fi client locations with filtering options available.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Services","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"APIs for managing webhooks.","name":"Webhooks"}]},"pathMetadata":{},"sha256":"724211974d8a12f160d5eb1f268487923971f125c11a482b3208dca285e70864"}},"get":{"description":"This API endpoint retrieves Webhook details for the specified Webhook ID such as the endpointURL and the authMechanism along with createdAt and updatedAt timestamps.","operationId":"getWebhookV1","parameters":[{"$ref":"#/components/parameters/Id__715550e8d02e"}],"responses":{"200":{"$ref":"#/components/responses/WebhookDetailsResponse__715550e8d02e"},"400":{"$ref":"#/components/responses/BadRequestError__0052b7c55291"},"401":{"$ref":"#/components/responses/Unauthorized__000172564380"},"403":{"$ref":"#/components/responses/Forbidden__0052b7c55291"},"404":{"$ref":"#/components/responses/NotFoundError__0052b7c55291"},"429":{"$ref":"#/components/responses/TooManyRequests__000172564380"},"500":{"$ref":"#/components/responses/InternalServerError__000172564380"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get a Webhook details by ID","tags":["Webhooks"],"x-source-document":{"file":"MRT/getwebhookv1.json","metadata":{"info":{"description":"Serves Wi-Fi client locations with filtering options available.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Services","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"APIs for managing webhooks.","name":"Webhooks"}]},"pathMetadata":{},"sha256":"a928c9943a7f4874b0b4706426c1591a3acaf51a79ad6e1736ded155e0d02d32"}},"patch":{"description":"This API endpoint modifies an existing Webhook. One or multiple parameters in the body can be used to update the Webhook. Example - updating the endpoint URL for a existing Webhook. To only change name and endpoint parameters, select Payload in dropdown. To change Auth mechanism, select \"Authentication Update\" in the dropdown and select authentication type.","operationId":"patchWebhookV1","parameters":[{"$ref":"#/components/parameters/Id__715550e8d02e"}],"requestBody":{"content":{"application/json":{"examples":{"apiKeyAuthentication":{"$ref":"#/components/examples/WebhookPatchApiKeyRequest__fa99fffcc525"},"oidcAuthentication":{"$ref":"#/components/examples/WebhookPatchOidcRequest__fa99fffcc525"}},"schema":{"$ref":"#/components/schemas/WebhookPatchInput__fa99fffcc525"}}},"description":"Request body for patching an existing Webhook.","required":true},"responses":{"200":{"$ref":"#/components/responses/WebhookPatchResponse__fa99fffcc525"},"400":{"$ref":"#/components/responses/BadRequestError__0052b7c55291"},"401":{"$ref":"#/components/responses/Unauthorized__000172564380"},"403":{"$ref":"#/components/responses/Forbidden__0052b7c55291"},"404":{"$ref":"#/components/responses/NotFoundError__0052b7c55291"},"429":{"$ref":"#/components/responses/TooManyRequests__000172564380"},"500":{"$ref":"#/components/responses/InternalServerError__000172564380"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Patch a Webhook by ID","tags":["Webhooks"],"x-source-document":{"file":"MRT/patchwebhookv1.json","metadata":{"info":{"description":"Serves Wi-Fi client locations with filtering options available.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Services","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"APIs for managing webhooks.","name":"Webhooks"}]},"pathMetadata":{},"sha256":"8bccd8c5ce4710342b701482bad85a85d4499e7cee4dfdc62476a74009603498"}},"put":{"description":"This API endpoint modifies an existing Webhook. All the request body parameters should be provided to update the Webhook. Auth mechanism can be either API key or OIDC. Use dropdown beside input in body parameters to change authMechanism and provide respective parameters for the authentication type.","operationId":"updateWebhookV1","parameters":[{"$ref":"#/components/parameters/Id__715550e8d02e"}],"requestBody":{"content":{"application/json":{"examples":{"apiKeyAuthentication":{"$ref":"#/components/examples/WebhookUpdateApiKeyRequest__d01d12c7fb0d"},"oidcAuthentication":{"$ref":"#/components/examples/WebhookUpdateOidcRequest__d01d12c7fb0d"}},"schema":{"$ref":"#/components/schemas/WebhookUpdateInput__d01d12c7fb0d"}}},"description":"Request body for updating an existing Webhook.","required":true},"responses":{"200":{"$ref":"#/components/responses/WebhookUpdateResponse__d01d12c7fb0d"},"400":{"$ref":"#/components/responses/BadRequestError__0052b7c55291"},"401":{"$ref":"#/components/responses/Unauthorized__000172564380"},"403":{"$ref":"#/components/responses/Forbidden__0052b7c55291"},"404":{"$ref":"#/components/responses/NotFoundError__0052b7c55291"},"429":{"$ref":"#/components/responses/TooManyRequests__000172564380"},"500":{"$ref":"#/components/responses/InternalServerError__000172564380"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Update a Webhook by ID","tags":["Webhooks"],"x-source-document":{"file":"MRT/updatewebhookv1.json","metadata":{"info":{"description":"Serves Wi-Fi client locations with filtering options available.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Services","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"APIs for managing webhooks.","name":"Webhooks"}]},"pathMetadata":{},"sha256":"5f3e4ddcbbe869c7dcc4b7069c265a35d4f86aab0fc517e1f97e5537bc8fbd1b"}}},"/network-services/v1/webhooks/{id}/rotate-hmac-key":{"post":{"description":"This API endpoint rotates the HMAC key for an existing Webhook.","operationId":"rotateWebhookHmacKeyV1","parameters":[{"description":"Unique identifier for the webhook. This can be obtained from the List Webhooks API.","in":"path","name":"id","required":true,"schema":{"format":"uuid","maxLength":16,"type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/WebhookRotateHmacKeyResponse__d05e666c56bb"},"400":{"$ref":"#/components/responses/BadRequestError__0052b7c55291"},"401":{"$ref":"#/components/responses/Unauthorized__000172564380"},"403":{"$ref":"#/components/responses/Forbidden__0052b7c55291"},"404":{"$ref":"#/components/responses/NotFoundError__0052b7c55291"},"429":{"$ref":"#/components/responses/TooManyRequests__000172564380"},"500":{"$ref":"#/components/responses/InternalServerError__000172564380"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Rotate HMAC key for a Webhook by ID","tags":["Webhooks"],"x-source-document":{"file":"MRT/rotatewebhookhmackeyv1.json","metadata":{"info":{"description":"Serves Wi-Fi client locations with filtering options available.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Services","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"APIs for managing webhooks.","name":"Webhooks"}]},"pathMetadata":{},"sha256":"69b72e3f888971a2eb631b0fddc922e9f97d916c488efd87aa1ee61e040ac2da"}}},"/network-services/v1/wids-intrusions":{"get":{"description":"This API endpoint retrieves wireless security events and intrusion alerts detected by the WIDS system. \n\nSupports filtering by site, event category (client/infrastructure), specific event types, severity levels, radio bands, and time ranges. \n","operationId":"listIntrusionsV1","parameters":[{"description":"OData Version 4.0 filter string (limited functionality). Supports only 'and' conjunction ('or' and 'not' are NOT supported).\n\n**Supported Fields and Operators:**\n\n| Field | Operators |\n|-------|----------|\n| `siteId` | `eq`, `in` |\n| `category` | `eq`, `in` |\n| `eventType` | `eq`, `in` |\n| `level` | `eq`, `in` |\n| `radioBand` | `eq`, `in`|\n\n**Operator Definitions:**\n- `eq`: Only values exactly matching the given value are returned\n- `in`: Only values present in the given list are returned\n\n**Applicable Values by Field:**\n\n| Field | Applicable Terms |\n|-------|------------------|\n| `siteId` | `string` |\n| `category` | `['CLIENT', 'INFRASTRUCTURE']` |\n| `eventType` | `See SignatureType schema for all possible values` |\n| `level` | `['LOW', 'MEDIUM', 'HIGH']` |\n| `radioBand` | `['UNSPECIFIED', 'BAND_2_4GHZ', 'BAND_5GHZ', 'BAND_6GHZ']`|","examples":{"default":{"value":"siteId eq 'site_1' and category eq 'INFRASTRUCTURE' and level in ('MEDIUM', 'HIGH')"}},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Retrieve data starting at the specified timestamp. Given in milliseconds from epoch. (Default: 3 hours ago)\n","in":"query","name":"start-at","required":false,"schema":{"$ref":"#/components/schemas/StartQueryTime__000172564380"}},{"description":"Retrieve data ending at the specified timestamp. Given in milliseconds from epoch. (Default: current time)\n","in":"query","name":"end-at","required":false,"schema":{"$ref":"#/components/schemas/EndQueryTime__000172564380"}},{"description":"Denotes the maximum number of items returned in the response. (Default: 100)\n","in":"query","name":"limit","required":false,"schema":{"$ref":"#/components/schemas/Limitwids__000172564380"}},{"description":"Specifies the zero-based resource offset to start the page from. (Default: 0)\n","in":"query","name":"offset","required":false,"schema":{"$ref":"#/components/schemas/Offsetwids__000172564380"}},{"description":"Comma separated list of sort expressions. Each sort expression is a property name optionally followed by a direction indicator asc (ascending) or desc (descending).\n\nThe first sort expression in the list defines the primary sort order, the second defines the secondary sort order, and so on. If a direction indicator is omitted the default direction is ascending.\n\nSupported fields are `eventType`, `category`, `level`, `eventTime`, `stationMac`, `detectingAp`, `radioBand`, and `siteName`\n","in":"query","name":"sort","required":false,"schema":{"examples":["level asc,eventTime desc"],"maxLength":256,"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntrusionListPage__000172564380"}}},"description":"Successful operation","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"400":{"$ref":"#/components/responses/BadRequestwids__000172564380"},"401":{"$ref":"#/components/responses/Unauthorized__000172564380"},"403":{"$ref":"#/components/responses/ForbiddenRequestwids__000172564380"},"429":{"$ref":"#/components/responses/TooManyRequests__000172564380"},"500":{"$ref":"#/components/responses/InternalServerError__000172564380"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get a list of signatures over a time period.","tags":["WIDS"],"x-source-document":{"file":"MRT/listintrusionsv1.json","metadata":{"info":{"description":"Serves Wi-Fi client locations with filtering options available.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Services","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":" APIs for retrieving and managing wireless APs and signatures detected by the WIDS (Wireless Intrusion Detection System).","name":"WIDS"}]},"pathMetadata":{},"sha256":"504f717ace64acb4234c5708e134d62f1ad238e3a09e0bbcc0f29725602dab95"}}},"/network-services/v1/wids-monitored-aps":{"get":{"description":"This API endpoint retrieves wireless access points detected and monitored by the WIDS (Wireless Intrusion Detection System). \n\nSupports filtering by site, classification type, detection method, time ranges, containment status, and encryption protocols. \n","operationId":"listMonitoredApsV1","parameters":[{"description":"OData Version 4.0 filter string (limited functionality). Supports only 'and' conjunction ('or' and 'not' are NOT supported).\n\n**Supported Fields and Operators:**\n\n| Field | Operators |\n|-------|----------|\n| `siteId` | `eq`, `in` |\n| `classification` | `eq`, `in` |\n| `classificationMethod` | `eq`, `in` |\n| `firstSeen` | `le`, `ge` |\n| `lastSeen` | `le`, `ge` |\n| `containmentStatus` | `eq`, `in` |\n| `encryption` | `eq`, `in` |\n\n**Operator Definitions:**\n- `eq`: Only values exactly matching the given value are returned\n- `in`: Only values present in the given list are returned\n- `le`: Less than or equal to (for time fields)\n- `ge`: Greater than or equal to (for time fields)\n\n**Applicable Values by Field:**\n\n| Field | Applicable Terms |\n|-------|------------------|\n| `siteId` | `string` |\n| `classification` | `['UNKNOWN', 'INTERFERING', 'SUSPECT_ROGUE', 'ROGUE', 'VALID', 'DOS', 'KNOWN_INTERFERING']` |\n| `classificationMethod` | `['DEVICE', 'RULE', 'MANUAL', 'UNSPECIFIED']` |\n| `firstSeen` | `epoch time in seconds` |\n| `lastSeen` | `epoch time in seconds` |\n| `containmentStatus` | `['CONTAINED', 'UN_CONTAINED', 'KNOWN_INTERFERING']` |\n| `encryption` | `['UNSPECIFIED', 'OPEN', 'WEP', 'WPA', 'WPA2', 'WPA3']` |","examples":{"default":{"value":"siteId eq 'site_1' and classification in ('SUSPECT_ROGUE', 'ROGUE')"}},"in":"query","name":"filter","schema":{"type":"string"}},{"description":"Retrieve data starting at the specified timestamp. Given in milliseconds from epoch. (Default: 3 hours ago)\n","in":"query","name":"start-at","required":false,"schema":{"$ref":"#/components/schemas/StartQueryTime__000172564380"}},{"description":"Retrieve data ending at the specified timestamp. Given in milliseconds from epoch. (Default: current time)\n","in":"query","name":"end-at","required":false,"schema":{"$ref":"#/components/schemas/EndQueryTime__000172564380"}},{"description":"Denotes the maximum number of items returned in the response. (Default: 100)\n","in":"query","name":"limit","required":false,"schema":{"$ref":"#/components/schemas/Limitwids__000172564380"}},{"description":"Specifies the zero-based resource offset to start the page from. (Default: 0)\n","in":"query","name":"offset","required":false,"schema":{"$ref":"#/components/schemas/Offsetwids__000172564380"}},{"description":"Comma separated list of sort expressions. Each sort expression is a property name optionally followed by a direction indicator asc (ascending) or desc (descending).\n\nThe first sort expression in the list defines the primary sort order, the second defines the secondary sort order, and so on. If a direction indicator is omitted the default direction is ascending.\n\nSupported fields are `bssid`, `name`, `classification`, `classificationMethod`, `ssid`, `lastSeen`, `firstSeen`, `signal`, `encryption`, `containmentStatus`, `macVendor`, and `siteName`\n","in":"query","name":"sort","required":false,"schema":{"examples":["name asc,lastSeen desc"],"maxLength":256,"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitoredApListPage__d67ae4720000"}}},"description":"Successful operation","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-Rate-Limit-Limit__000172564380"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-Rate-Limit-Remaining__000172564380"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-Rate-Limit-Reset__000172564380"}}},"400":{"$ref":"#/components/responses/BadRequestwids__000172564380"},"401":{"$ref":"#/components/responses/Unauthorized__000172564380"},"403":{"$ref":"#/components/responses/ForbiddenRequestwids__000172564380"},"429":{"$ref":"#/components/responses/TooManyRequests__000172564380"},"500":{"$ref":"#/components/responses/InternalServerError__000172564380"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get a list of monitored APs over a time period.","tags":["WIDS"],"x-source-document":{"file":"MRT/listmonitoredapsv1.json","metadata":{"info":{"description":"Serves Wi-Fi client locations with filtering options available.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Services","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":" APIs for retrieving and managing wireless APs and signatures detected by the WIDS (Wireless Intrusion Detection System).","name":"WIDS"}]},"pathMetadata":{},"sha256":"42df021d866da9ffa79df1a6dc971581d26ddc33d1807f15286b73a9e5b7f9ac"}}},"/network-services/v1/wifi-clients-locations":{"get":{"description":"This API provides Wi-Fi client locations using a variety of query options. Please use either `latest-location-per-client` or `latest-connected-client-mac` query parameters. For details please refer to descriptions of corresponding parameters.","operationId":"listClientLocationsForAPIV1","parameters":[{"description":"This is required parameter if latest-location-per-client parameter is used. OData Version 4.0 filter string (limited functionality). Supports only 'and' conjunction ('or' and 'not' are NOT supported). Supported fields and operators are in the below given table.\n\n| Field | Operators |\n| --------- | -------- |\n| `siteId` (mandatory) | `eq` and `in` |\n| `buildingId` | `eq` and `in` |\n| `floorId` | `eq` and `in` |\n| `associated` | `eq` |\n| `connected` | `eq` |\n\n**The operators are implemented as follows:**\n\n* `eq`: Only values exactly matching the given value are returned.\n\n* `in`: Only values present in the given list are returned.\n\n Note: Provide boolean values (true/false) in lowercase.","example":"siteId eq '1033566193' and buildingId in ('buildingId1','buildingId2') and floorId in ('defaultFloorId3', 'defaultFloorId4') and associated eq true and connected eq false","in":"query","name":"filter","required":false,"schema":{"format":"const","maxLength":2048,"type":"string"}},{"description":"Retrieve data starting at the specified timestamp. Provided in RFC 3339 format. Example: `2023-01-01T23:10:41.123Z`. If no timestamp is provided, all data will be considered.\n","in":"query","name":"start-at","required":false,"schema":{"$ref":"#/components/schemas/DateTime__3f58b16772b5","format":"int64","type":"integer"}},{"description":"Denotes the maximum number of clients returned in the response. (Default: 100)\n","in":"query","name":"limit","required":false,"schema":{"$ref":"#/components/schemas/Limitasset__acdf4895bcad","format":"int32","type":"integer"}},{"description":"Specifies the zero-based resource offset to start the page from. Default: 0\n","in":"query","name":"offset","required":false,"schema":{"$ref":"#/components/schemas/Offsetasset__acdf4895bcad","format":"int32","type":"integer"}},{"description":"Provides a list of latest client locations. Only the value of 1 is supported for the moment. It is mutually exclusive from parameter latest-connected-client-mac.\n","in":"query","name":"latest-location-per-client","required":false,"schema":{"$ref":"#/components/schemas/LatestLocationPerClient__3f58b16772b5","format":"int32","type":"integer"}},{"description":"Provides the latest location information for a specific client that is connected and associated. Do not provide filter, offset and limit when using this query parameter. It is mutually exclusive from parameter latest-location-per-client.\n","in":"query","name":"latest-connected-client-mac","required":false,"schema":{"$ref":"#/components/schemas/LastConnectClientMacAddress__3f58b16772b5","format":"const","type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/SuccessResponse__3f58b16772b5"},"400":{"$ref":"#/components/responses/Error400__3f58b16772b5"},"401":{"$ref":"#/components/responses/Unauthorized__000172564380"},"403":{"$ref":"#/components/responses/Forbidden__0052b7c55291"},"404":{"$ref":"#/components/responses/Error404__3f58b16772b5"},"429":{"$ref":"#/components/responses/TooManyRequests__000172564380"},"500":{"$ref":"#/components/responses/DatabaseError__3f58b16772b5"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get locations of Wi-Fi clients","tags":["Location"],"x-source-document":{"file":"MRT/listclientlocationsforapiv1.json","metadata":{"info":{"description":"Serves Wi-Fi client locations with filtering options available.","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Services","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"APIs that allow for interacting with Location Service offerings.","name":"Location"}]},"pathMetadata":{},"sha256":"69aee64b79f25c3735c52805b2da1f2b56f605b52006da01be241380f0cb1256"}}},"/network-troubleshooting/v1/aos-s/{serial-number}/cableTest":{"post":{"description":"Starts an asynchronous Cable Test on the specified AOS-S Switch.","operationId":"initiatePvosCableTestV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"}],"requestBody":{"content":{"application/json":{"examples":{"minimal":{"summary":"AOS-S Switch Cable Test request","value":{"ports":["1","2"]}}},"schema":{"$ref":"#/components/schemas/CableTestHppcRequest__5abd6a941c65"}}},"description":"AOS-S Switch Cable Test command parameters","required":true},"responses":{"202":{"content":{"application/json":{"example":{"location":"/network-troubleshooting/v1/aos-s/{serial-number}/cableTest/async-operations/{task-id}","startTime":"2025-04-09T10:00:00Z","status":"INITIATED"},"schema":{"$ref":"#/components/schemas/AsyncOperationStatus__02a6567f3633"}}},"description":"Accepted. The operation has been successfully initiated. The response includes the location to track the operation's status."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/DeviceNotFound__02a6567f3633"},"409":{"$ref":"#/components/responses/DeviceOffline__02a6567f3633"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Initiate a Cable Test on a AOS-S Switch","tags":["AOS-S Switches"],"x-source-document":{"file":"MRT/initiatepvoscabletestv1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on AOS-S Switches (The stackId should be used in place of the serial for stack switches)","name":"AOS-S Switches"}]},"pathMetadata":{},"sha256":"8044ad3d80e524c0f62bfafb3beca945e0f22bbc3114e037bd4012cafe9aa2a5"}}},"/network-troubleshooting/v1/aos-s/{serial-number}/cableTest/async-operations/{task-id}":{"get":{"description":"Retrieves the status and results of a previously initiated asynchronous AOS-S Switch Cable Test.","operationId":"getPvosCableTestResultV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"},{"$ref":"#/components/parameters/AsyncTaskId__03efdde95a47"}],"responses":{"200":{"content":{"application/json":{"examples":{"completed":{"summary":"AOS-S Switch Cable Test completed successfully","value":{"endTime":"2025-05-21T04:49:40.514983412Z","failReason":null,"output":{"ports":["3","6"],"results":[{"cablePairDiagnostics":[{"length":"0","pairName":"1-2","status":"Open"},{"length":"0","pairName":"3-6","status":"Open"},{"length":"0","pairName":"4-5","status":"Open"},{"length":"0","pairName":"7-8","status":"Open"}],"interfaceName":"3"},{"cablePairDiagnostics":[{"length":"0","pairName":"1-2","status":"Open"},{"length":"0","pairName":"3-6","status":"Open"},{"length":"0","pairName":"4-5","status":"Open"},{"length":"0","pairName":"7-8","status":"Open"}],"interfaceName":"6"}]},"progressPercent":100,"startTime":"2025-05-21T04:49:39.372776208Z","status":"COMPLETED"}},"running":{"summary":"Operation still running","value":{"endTime":null,"output":null,"progressPercent":0,"startTime":"2025-04-09T10:14:08Z","status":"RUNNING"}}},"schema":{"$ref":"#/components/schemas/CableTestHppcResult__66f350adb118"}}},"description":"OK. Returns the status and results of the AOS-S Switch Cable Test."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/TaskNotFound__03efdde95a47"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get AOS-S Switch Cable Test status and results","tags":["AOS-S Switches"],"x-source-document":{"file":"MRT/getpvoscabletestresultv1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on AOS-S Switches (The stackId should be used in place of the serial for stack switches)","name":"AOS-S Switches"}]},"pathMetadata":{},"sha256":"f65a8c509dbce91111bec4dc9cc80a6c1c3c349dd9e7bf7b1706e46fc6a78447"}}},"/network-troubleshooting/v1/aos-s/{serial-number}/getArpTable":{"post":{"description":"Starts an asynchronous Get Arp Table test on the specified AOS-S Switch.","operationId":"initiatePvosGetArpTableV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"}],"responses":{"202":{"content":{"application/json":{"example":{"location":"/network-troubleshooting/v1/aos-s/{serial-number}/getArpTable/async-operations/{task-id}","startTime":"2025-04-09T10:00:00Z","status":"INITIATED"},"schema":{"$ref":"#/components/schemas/AsyncOperationStatus__02a6567f3633"}}},"description":"Accepted. The operation has been successfully initiated. The response includes the location to track the operation's status."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/DeviceNotFound__02a6567f3633"},"409":{"$ref":"#/components/responses/DeviceOffline__02a6567f3633"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Initiate a Get Arp Table test on a AOS-S Switch","tags":["AOS-S Switches"],"x-source-document":{"file":"MRT/initiatepvosgetarptablev1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on AOS-S Switches (The stackId should be used in place of the serial for stack switches)","name":"AOS-S Switches"}]},"pathMetadata":{},"sha256":"213afec7657f9d6cf68ca2686d5bcb84520742fc64d9ca21ce640201c13fb8f9"}}},"/network-troubleshooting/v1/aos-s/{serial-number}/getArpTable/async-operations/{task-id}":{"get":{"description":"Retrieves the status and results of a previously initiated asynchronous AOS-S Switch Get Arp Table test.","operationId":"getPvosGetArpTableResultV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"},{"$ref":"#/components/parameters/AsyncTaskId__03efdde95a47"}],"responses":{"200":{"content":{"application/json":{"examples":{"completed":{"summary":"AOS-S Switch Get Arp Table completed successfully","value":{"endTime":"2025-05-21T04:47:50.638367494Z","failReason":null,"output":{"entries":[{"entryType":"dynamic","ipAddress":"10.97.118.2","macAddress":"ec6794-7e1fc0","port":"1"}]},"progressPercent":100,"startTime":"2025-05-21T04:47:49.339145537Z","status":"COMPLETED"}},"running":{"summary":"Operation still running","value":{"endTime":null,"output":null,"progressPercent":0,"rawOutput":null,"startTime":"2025-04-09T10:14:08Z","status":"RUNNING"}}},"schema":{"$ref":"#/components/schemas/GetArpTableHppcResult__6969b1a4b1d4"}}},"description":"OK. Returns the status and results of the AOS-S Switch Get Arp Table test."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/TaskNotFound__03efdde95a47"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get AOS-S Switch Get Arp Table test status and results","tags":["AOS-S Switches"],"x-source-document":{"file":"MRT/getpvosgetarptableresultv1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on AOS-S Switches (The stackId should be used in place of the serial for stack switches)","name":"AOS-S Switches"}]},"pathMetadata":{},"sha256":"5c6c98330cf7ba9687f82bea66c55db1ac4a6fad3e154b2396a070b30b429e17"}}},"/network-troubleshooting/v1/aos-s/{serial-number}/list-tasks":{"get":{"description":"Retrieves a list of all active or recently completed asynchronous operations for the specified AOS-S Switch, grouped by test name. Results are sorted by startTime in descending order (most recently started first).","operationId":"listAossTasksV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskListResponse__3c2901e6fd8d"}}},"description":"OK. Returns the list of active/recent tasks."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/DeviceNotFound__02a6567f3633"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"List active async tasks for an AOS-S Switch","tags":["AOS-S Switches"],"x-source-document":{"file":"MRT/listaosstasksv1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on AOS-S Switches (The stackId should be used in place of the serial for stack switches)","name":"AOS-S Switches"}]},"pathMetadata":{},"sha256":"ee2497b878a49b8ed4bab9d4e468fea32e902cd1e653f18a4b896b07d901194d"}}},"/network-troubleshooting/v1/aos-s/{serial-number}/locate":{"post":{"description":"Initiates a locate (e.g., blinking LED) operation on the specified AOS-S Switch.","operationId":"locatePvosSwitchV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"}],"responses":{"202":{"content":{"application/json":{"example":{"startTime":"2025-06-25T08:31:15.380079232Z","status":"INITIATED"},"schema":{"$ref":"#/components/schemas/ActionInitiatedStatus__11d6968be580"}}},"description":"Accepted. The locate action has been successfully initiated."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/DeviceNotFound__02a6567f3633"},"409":{"$ref":"#/components/responses/DeviceConflictLocating__322170916979"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Locate an AOS-S Switch","tags":["AOS-S Switches"],"x-source-document":{"file":"MRT/locatepvosswitchv1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on AOS-S Switches (The stackId should be used in place of the serial for stack switches)","name":"AOS-S Switches"}]},"pathMetadata":{},"sha256":"17fc21443d1c3d70ce19eb0836cd1ff838c403f771b6ee671bedb7efff4c2c42"}}},"/network-troubleshooting/v1/aos-s/{serial-number}/ping":{"post":{"description":"Starts an asynchronous Ping test on the specified AOS-S Switch.","operationId":"initiatePvosPingV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"}],"requestBody":{"content":{"application/json":{"examples":{"full":{"summary":"AOS-S Switch Ping request with additional parameters","value":{"count":5,"destination":"www.google.com","includeRawOutput":true,"ipAddress":"10.1.1.10","loopbackPort":3000,"packetSize":10,"useIpv6":true,"vlan":1}},"minimal":{"summary":"Minimal AOS-S Switch Ping request","value":{"destination":"www.google.com"}}},"schema":{"$ref":"#/components/schemas/PingHppcRequest__eb91b21dda1e"}}},"description":"AOS-S Switch Ping command parameters","required":true},"responses":{"202":{"content":{"application/json":{"example":{"location":"/network-troubleshooting/v1/aos-s/{serial-number}/ping/async-operations/{task-id}","startTime":"2025-04-09T10:00:00Z","status":"INITIATED"},"schema":{"$ref":"#/components/schemas/AsyncOperationStatus__02a6567f3633"}}},"description":"Accepted. The operation has been successfully initiated. The response includes the location to track the operation's status."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/DeviceNotFound__02a6567f3633"},"409":{"$ref":"#/components/responses/DeviceOffline__02a6567f3633"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Initiate a Ping test on a AOS-S Switch","tags":["AOS-S Switches"],"x-source-document":{"file":"MRT/initiatepvospingv1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on AOS-S Switches (The stackId should be used in place of the serial for stack switches)","name":"AOS-S Switches"}]},"pathMetadata":{},"sha256":"75273ea75b1c050d793d52fdd961207636cff6f79c3c5210b428dbe60e25177a"}}},"/network-troubleshooting/v1/aos-s/{serial-number}/ping/async-operations/{task-id}":{"get":{"description":"Retrieves the status and results of a previously initiated asynchronous AOS-S Switch Ping test.","operationId":"getPvosPingResultV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"},{"$ref":"#/components/parameters/AsyncTaskId__03efdde95a47"}],"responses":{"200":{"content":{"application/json":{"examples":{"completed":{"summary":"AOS-S Switch Ping completed successfully","value":{"endTime":"2025-05-21T05:10:26.892804343Z","failReason":null,"output":{"averageRoundTripTimeMilliseconds":"7","maximumRoundTripTimeMilliseconds":"8","minimumRoundTripTimeMilliseconds":"7","packetLossPercent":"0","receivedPacketsCount":"5","replies":[{"sentPacketAddress":"8.8.8.8","sentPacketIcmpSequenceNumber":"1","sentPacketTimeMilliseconds":"8"},{"sentPacketAddress":"8.8.8.8","sentPacketIcmpSequenceNumber":"2","sentPacketTimeMilliseconds":"8"},{"sentPacketAddress":"8.8.8.8","sentPacketIcmpSequenceNumber":"3","sentPacketTimeMilliseconds":"8"},{"sentPacketAddress":"8.8.8.8","sentPacketIcmpSequenceNumber":"4","sentPacketTimeMilliseconds":"7"},{"sentPacketAddress":"8.8.8.8","sentPacketIcmpSequenceNumber":"5","sentPacketTimeMilliseconds":"8"}],"transmittedPacketsCount":"5"},"progressPercent":100,"rawOutput":"\nping 8.8.8.8 repetitions 5\n8.8.8.8 is alive, iteration 1, time = 8 ms\n8.8.8.8 is alive, iteration 2, time = 8 ms\n8.8.8.8 is alive, iteration 3, time = 8 ms\n8.8.8.8 is alive, iteration 4, time = 7 ms\n8.8.8.8 is alive, iteration 5, time = 8 ms\n5 packets transmitted, 5 packets received, 0% packet loss\nround-trip (ms) min/avg/max = 7/7/8\n\n","startTime":"2025-05-21T05:10:20.861006578Z","status":"COMPLETED"}},"running":{"summary":"Operation still running","value":{"endTime":null,"output":null,"progressPercent":0,"rawOutput":null,"startTime":"2025-04-09T10:14:08Z","status":"RUNNING"}}},"schema":{"$ref":"#/components/schemas/PingHppcResult__41907dccf1b5"}}},"description":"OK. Returns the status and results of the AOS-S Switch Ping test."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/TaskNotFound__03efdde95a47"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get AOS-S Switch Ping test status and results","tags":["AOS-S Switches"],"x-source-document":{"file":"MRT/getpvospingresultv1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on AOS-S Switches (The stackId should be used in place of the serial for stack switches)","name":"AOS-S Switches"}]},"pathMetadata":{},"sha256":"3f9b0efe1502a88037a047803ae2d8b2e273f5ced83cb13eb9ed6c72d91c7a88"}}},"/network-troubleshooting/v1/aos-s/{serial-number}/poeBounce":{"post":{"description":"Starts an asynchronous Poe Bounce test on the specified AOS-S Switch.","operationId":"initiatePvosPoeBounceV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"}],"requestBody":{"content":{"application/json":{"examples":{"minimal":{"summary":"AOS-S Switch Poe Bounce request","value":{"ports":["1","2"]}}},"schema":{"$ref":"#/components/schemas/PoeBounceHppcRequest__70acd77dd00b"}}},"description":"AOS-S Switch Poe Bounce command parameters","required":true},"responses":{"202":{"content":{"application/json":{"example":{"location":"/network-troubleshooting/v1/aos-s/{serial-number}/poeBounce/async-operations/{task-id}","startTime":"2025-04-09T10:00:00Z","status":"INITIATED"},"schema":{"$ref":"#/components/schemas/AsyncOperationStatus__02a6567f3633"}}},"description":"Accepted. The operation has been successfully initiated. The response includes the location to track the operation's status."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/DeviceNotFound__02a6567f3633"},"409":{"$ref":"#/components/responses/DeviceOffline__02a6567f3633"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Initiate a Poe Bounce test on a AOS-S Switch","tags":["AOS-S Switches"],"x-source-document":{"file":"MRT/initiatepvospoebouncev1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on AOS-S Switches (The stackId should be used in place of the serial for stack switches)","name":"AOS-S Switches"}]},"pathMetadata":{},"sha256":"90a074817446dd60a7ef93dc1aececfa38208dd3912d84e701cef282a779c958"}}},"/network-troubleshooting/v1/aos-s/{serial-number}/poeBounce/async-operations/{task-id}":{"get":{"description":"Retrieves the status and results of a previously initiated asynchronous AOS-S Switch Poe Bounce test.","operationId":"getPvosPoeBounceResultV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"},{"$ref":"#/components/parameters/AsyncTaskId__03efdde95a47"}],"responses":{"200":{"content":{"application/json":{"examples":{"completed":{"summary":"AOS-S Switch Poe Bounce completed successfully","value":{"endTime":"2025-05-21T04:44:00.888823118Z","failReason":null,"output":{"ports":["43","7"],"results":[{"port":"43","status":"Failed.  Invalid port."},{"port":"7","status":"Bounced"}]},"progressPercent":100,"startTime":"2025-05-21T04:43:59.582064497Z","status":"COMPLETED"}},"running":{"summary":"Operation still running","value":{"endTime":null,"output":null,"progressPercent":0,"startTime":"2025-04-09T10:14:08Z","status":"RUNNING"}}},"schema":{"$ref":"#/components/schemas/PoeBounceHppcResult__18cb9bf0b651"}}},"description":"OK. Returns the status and results of the AOS-S Switch Poe Bounce test."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/TaskNotFound__03efdde95a47"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get AOS-S Switch Poe Bounce test status and results","tags":["AOS-S Switches"],"x-source-document":{"file":"MRT/getpvospoebounceresultv1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on AOS-S Switches (The stackId should be used in place of the serial for stack switches)","name":"AOS-S Switches"}]},"pathMetadata":{},"sha256":"a763b7efe0460b900107a6b2288df600d3a3b26f61187cc2fe508861b7b9e54f"}}},"/network-troubleshooting/v1/aos-s/{serial-number}/portBounce":{"post":{"description":"Starts an asynchronous Port Bounce test on the specified AOS-S Switch.","operationId":"initiatePvosPortBounceV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"}],"requestBody":{"content":{"application/json":{"examples":{"minimal":{"summary":"AOS-S Switch Port Bounce request","value":{"ports":["1","2"]}}},"schema":{"$ref":"#/components/schemas/PortBounceHppcRequest__2c7cfaa27566"}}},"description":"AOS-S Switch Port Bounce command parameters","required":true},"responses":{"202":{"content":{"application/json":{"example":{"location":"/network-troubleshooting/v1/aos-s/{serial-number}/portBounce/async-operations/{task-id}","startTime":"2025-04-09T10:00:00Z","status":"INITIATED"},"schema":{"$ref":"#/components/schemas/AsyncOperationStatus__02a6567f3633"}}},"description":"Accepted. The operation has been successfully initiated. The response includes the location to track the operation's status."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/DeviceNotFound__02a6567f3633"},"409":{"$ref":"#/components/responses/DeviceOffline__02a6567f3633"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Initiate a Port Bounce test on a AOS-S Switch","tags":["AOS-S Switches"],"x-source-document":{"file":"MRT/initiatepvosportbouncev1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on AOS-S Switches (The stackId should be used in place of the serial for stack switches)","name":"AOS-S Switches"}]},"pathMetadata":{},"sha256":"2baa3e5f2dbf23076c7177294daf9b9a927299d9332210255a3fbfcdc0d73e50"}}},"/network-troubleshooting/v1/aos-s/{serial-number}/portBounce/async-operations/{task-id}":{"get":{"description":"Retrieves the status and results of a previously initiated asynchronous AOS-S Switch Port Bounce test.","operationId":"getPvosPortBounceResultV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"},{"$ref":"#/components/parameters/AsyncTaskId__03efdde95a47"}],"responses":{"200":{"content":{"application/json":{"examples":{"completed":{"summary":"AOS-S Switch Port Bounce completed successfully","value":{"endTime":"2025-05-21T04:42:45.273878693Z","failReason":null,"output":{"ports":["5-7"],"results":[{"port":"5-7","status":"Bounced"}]},"progressPercent":100,"startTime":"2025-05-21T04:42:44.345783226Z","status":"COMPLETED"}},"running":{"summary":"Operation still running","value":{"endTime":null,"output":null,"progressPercent":0,"startTime":"2025-04-09T10:14:08Z","status":"RUNNING"}}},"schema":{"$ref":"#/components/schemas/PortBounceHppcResult__75a5db3c309d"}}},"description":"OK. Returns the status and results of the AOS-S Switch Port Bounce test."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/TaskNotFound__03efdde95a47"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get AOS-S Switch Port Bounce test status and results","tags":["AOS-S Switches"],"x-source-document":{"file":"MRT/getpvosportbounceresultv1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on AOS-S Switches (The stackId should be used in place of the serial for stack switches)","name":"AOS-S Switches"}]},"pathMetadata":{},"sha256":"79396c61f93a5600b5061e48d25a356e2fe98666397cf1f2dd4d84474f452dde"}}},"/network-troubleshooting/v1/aos-s/{serial-number}/reboot":{"post":{"description":"Initiates a reboot operation on the specified AOS-S Switch.","operationId":"rebootPvosSwitchV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"}],"responses":{"202":{"content":{"application/json":{"example":{"startTime":"2025-06-25T08:31:15.380079232Z","status":"INITIATED"},"schema":{"$ref":"#/components/schemas/ActionInitiatedStatus__11d6968be580"}}},"description":"Accepted. The reboot action has been successfully initiated."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/DeviceNotFound__02a6567f3633"},"409":{"$ref":"#/components/responses/DeviceConflictRebooting__78801b30c1be"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Reboot an AOS-S Switch","tags":["AOS-S Switches"],"x-source-document":{"file":"MRT/rebootpvosswitchv1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on AOS-S Switches (The stackId should be used in place of the serial for stack switches)","name":"AOS-S Switches"}]},"pathMetadata":{},"sha256":"11d38369350023e4b65c43c417a133684d61ee5a7d539f04c4b319c79e6360c7"}}},"/network-troubleshooting/v1/aos-s/{serial-number}/show-commands":{"get":{"description":"Returns most used/top 'show' commands supported on given AOS-S switch. ","operationId":"listAossShowCommandsV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShowCommandsResponse__3ba348bd5d1e"}}},"description":"OK."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/DeviceNotFound__02a6567f3633"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"List 'show' commands (AOS-S - top commands)","tags":["AOS-S Switches"],"x-source-document":{"file":"MRT/listaossshowcommandsv1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on AOS-S Switches (The stackId should be used in place of the serial for stack switches)","name":"AOS-S Switches"}]},"pathMetadata":{},"sha256":"904b633507e1ac7b1ee3ae8fe3cb0947aed2f1f18209eb16b8329b5dc6dcf8ee"}}},"/network-troubleshooting/v1/aos-s/{serial-number}/showCommands":{"post":{"description":"Starts an asynchronous execution of one or more 'show' commands on an AOS-S switch. Rejected with 400 if any command does not start with 'show ', or if more than 20 commands are provided.","operationId":"runAossShowCommandsV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"}],"requestBody":{"content":{"application/json":{"example":{"commands":["show ip route","show version"]},"schema":{"$ref":"#/components/schemas/ShowCommandRequest__1070839fcc3b"}}},"description":"The list of 'show' commands to run.","required":true},"responses":{"202":{"content":{"application/json":{"example":{"location":"/network-troubleshooting/v1/aos-s/{serial-number}/showCommands/async-operations/{task-id}","startTime":"2025-08-25T10:00:00Z","status":"INITIATED"},"schema":{"$ref":"#/components/schemas/AsyncOperationStatus__02a6567f3633"}}},"description":"Accepted."},"400":{"$ref":"#/components/responses/BadRequestShowCommand__1070839fcc3b"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/DeviceNotFound__02a6567f3633"},"409":{"$ref":"#/components/responses/DeviceOffline__02a6567f3633"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Run 'show' commands (AOS-S)","tags":["AOS-S Switches"],"x-source-document":{"file":"MRT/runaossshowcommandsv1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on AOS-S Switches (The stackId should be used in place of the serial for stack switches)","name":"AOS-S Switches"}]},"pathMetadata":{},"sha256":"d57856541466053b260444203b35adbc7d998d16095b759f5f2958c3f802e4a1"}}},"/network-troubleshooting/v1/aos-s/{serial-number}/showCommands/async-operations/{task-id}":{"get":{"description":"Polls the async task for the 'show' commands and returns status and raw text output.","operationId":"getAossShowCommandsResultV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"},{"$ref":"#/components/parameters/AsyncTaskId__03efdde95a47"}],"responses":{"200":{"content":{"application/json":{"examples":{"completed":{"summary":"Command finished successfully","value":{"endTime":"2026-02-03T14:21:02.004881090Z","failReason":null,"output":{"commands":["show version"],"results":[{"command":"show version","output":"ArubaOS-Switch Version 16.x\n..."}]},"progressPercent":100,"startTime":"2026-02-03T14:20:59.912054756Z","status":"COMPLETED"}}},"schema":{"$ref":"#/components/schemas/ShowCommandResult__8cc1ef82c4a3"}}},"description":"OK."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/TaskNotFound__03efdde95a47"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get 'show' commands status/result (AOS-S)","tags":["AOS-S Switches"],"x-source-document":{"file":"MRT/getaossshowcommandsresultv1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on AOS-S Switches (The stackId should be used in place of the serial for stack switches)","name":"AOS-S Switches"}]},"pathMetadata":{},"sha256":"04b2b84162219debb1c93c5504385a524517ba0daf66cb5a171e9729977c8412"}}},"/network-troubleshooting/v1/aos-s/{serial-number}/traceroute":{"post":{"description":"Starts an asynchronous Traceroute test on the specified AOS-S Switch.","operationId":"initiatePvosTracerouteV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"}],"requestBody":{"content":{"application/json":{"examples":{"full":{"summary":"AOS-S Switch Traceroute request with additional parameters","value":{"destination":"www.google.com","includeRawOutput":true,"ipAddress":"10.1.1.0","loopbackPort":3000,"sourceInterface":"1","vlan":1}},"minimal":{"summary":"Minimal AOS-S Switch Traceroute request","value":{"destination":"www.google.com"}}},"schema":{"$ref":"#/components/schemas/TracerouteHppcRequest__91e04df244b6"}}},"description":"AOS-S Switch Traceroute command parameters","required":true},"responses":{"202":{"content":{"application/json":{"example":{"location":"/network-troubleshooting/v1/aos-s/{serial-number}/traceroute/async-operations/{task-id}","startTime":"2025-04-09T10:00:00Z","status":"INITIATED"},"schema":{"$ref":"#/components/schemas/AsyncOperationStatus__02a6567f3633"}}},"description":"Accepted. The operation has been successfully initiated. The response includes the location to track the operation's status."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/DeviceNotFound__02a6567f3633"},"409":{"$ref":"#/components/responses/DeviceOffline__02a6567f3633"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Initiate a Traceroute test on a AOS-S Switch","tags":["AOS-S Switches"],"x-source-document":{"file":"MRT/initiatepvostraceroutev1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on AOS-S Switches (The stackId should be used in place of the serial for stack switches)","name":"AOS-S Switches"}]},"pathMetadata":{},"sha256":"05c902385be712bd8711b14e68d331c5a9b1516bbaad3f08c8493c6b3b47ce17"}}},"/network-troubleshooting/v1/aos-s/{serial-number}/traceroute/async-operations/{task-id}":{"get":{"description":"Retrieves the status and results of a previously initiated asynchronous AOS-S Switch Traceroute test.","operationId":"getPvosTracerouteResultV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"},{"$ref":"#/components/parameters/AsyncTaskId__03efdde95a47"}],"responses":{"200":{"content":{"application/json":{"examples":{"completed":{"summary":"AOS-S Switch Traceroute completed successfully","value":{"endTime":"2025-05-21T11:39:31.826643044Z","failReason":null,"output":{"destination":"blrubshared-pdash.arubacorp.net","hops":[{"hop":"1","probes":[{"ipAddress":"null","responseTimeMilliseconds":"1 ms","reverseDnsResolution":"10.97.118.2"},{"ipAddress":"null","responseTimeMilliseconds":"1 ms","reverseDnsResolution":"10.97.118.2"},{"ipAddress":"null","responseTimeMilliseconds":"1 ms","reverseDnsResolution":"10.97.118.2"}]},{"hop":"2","probes":[{"ipAddress":"null","responseTimeMilliseconds":"1 ms","reverseDnsResolution":"10.97.112.1"},{"ipAddress":"null","responseTimeMilliseconds":"0 ms","reverseDnsResolution":"10.97.112.1"},{"ipAddress":"null","responseTimeMilliseconds":"1 ms","reverseDnsResolution":"10.97.112.1"}]},{"hop":"3","probes":[]},{"hop":"5","probes":[{"ipAddress":"null","responseTimeMilliseconds":"1 ms","reverseDnsResolution":"10.186.172.153"},{"ipAddress":"null","responseTimeMilliseconds":"1 ms","reverseDnsResolution":"10.186.172.153"},{"ipAddress":"null","responseTimeMilliseconds":"0 ms","reverseDnsResolution":"10.186.172.153"}]}]},"progressPercent":100,"rawOutput":"\ntraceroute blrubshared-pdash.arubacorp.net\ntraceroute to 10.186.172.153 ,\n              1 hop min, 30 hops max, 5 sec. timeout, 3 probes\n 1 10.97.118.2           1 ms      1 ms      1 ms\n 2 10.97.112.1           1 ms      0 ms      1 ms\n 3  *  *  * \n 4 10.186.128.6          1 ms10.186.128.4          1 ms      1 ms\n 5 10.186.172.153        1 ms      1 ms      0 ms\n\n","startTime":"2025-05-21T11:39:13.645841269Z","status":"COMPLETED"}},"running":{"summary":"Operation still running","value":{"endTime":null,"output":null,"progressPercent":0,"rawOutput":null,"startTime":"2025-04-09T10:14:08Z","status":"RUNNING"}}},"schema":{"$ref":"#/components/schemas/TracerouteHppcResult__c1b1032af793"}}},"description":"OK. Returns the status and results of the AOS-S Switch Traceroute test."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/TaskNotFound__03efdde95a47"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get AOS-S Switch Traceroute test status and results","tags":["AOS-S Switches"],"x-source-document":{"file":"MRT/getpvostracerouteresultv1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on AOS-S Switches (The stackId should be used in place of the serial for stack switches)","name":"AOS-S Switches"}]},"pathMetadata":{},"sha256":"13e6d5341116c7562e73d2c8e575119d4bce896aa0c6d606984529f796539eb3"}}},"/network-troubleshooting/v1/aps/{serial-number}/aaa":{"post":{"description":"Starts an asynchronous AAA test on the specified AP.","operationId":"initiateApAaaV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"}],"requestBody":{"content":{"application/json":{"example":{"password":"password123","serverName":"radius-server-1","username":"testuser"},"schema":{"$ref":"#/components/schemas/AaaApRequest__10d7df8bd8fe"}}},"description":"AP AAA command parameters","required":true},"responses":{"202":{"content":{"application/json":{"example":{"location":"/network-troubleshooting/v1/aps/{serial-number}/aaa/async-operations/{task-id}","startTime":"2025-07-22T10:00:00Z","status":"INITIATED"},"schema":{"$ref":"#/components/schemas/AsyncOperationStatus__02a6567f3633"}}},"description":"Accepted. The operation has been successfully initiated."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/DeviceNotFound__02a6567f3633"},"409":{"$ref":"#/components/responses/DeviceOffline__02a6567f3633"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Initiate an AAA test on an AP","tags":["Access Points"],"x-source-document":{"file":"MRT/initiateapaaav1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on Access Points (APs)","name":"Access Points"}]},"pathMetadata":{},"sha256":"6770a51094c41c5540a2ea1f92b309e82184983580720cac2340d0c1ae81357f"}}},"/network-troubleshooting/v1/aps/{serial-number}/aaa/async-operations/{task-id}":{"get":{"description":"Retrieves the status and results of a previously initiated asynchronous AP AAA test.","operationId":"getApAaaResultV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"},{"$ref":"#/components/parameters/AsyncTaskId__03efdde95a47"}],"responses":{"200":{"content":{"application/json":{"examples":{"completed-failed":{"summary":"AP AAA test failed","value":{"endTime":"2025-07-22T10:01:08Z","failReason":"Authentication timed out","output":{"authenticationStatus":"Failed","serverName":"radius-server-1"},"progressPercent":100,"startTime":"2025-07-22T10:01:05Z","status":"COMPLETED"}},"completed-passed":{"summary":"AP AAA test passed","value":{"endTime":"2025-07-22T10:00:07Z","failReason":null,"output":{"authenticationStatus":"Passed","serverName":"radius-server-1"},"progressPercent":100,"startTime":"2025-07-22T10:00:05Z","status":"COMPLETED"}}},"schema":{"$ref":"#/components/schemas/AaaApResult__840e5db6667e"}}},"description":"OK. Returns the status and results of the AP AAA test."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/TaskNotFound__03efdde95a47"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get AP AAA test status and results","tags":["Access Points"],"x-source-document":{"file":"MRT/getapaaaresultv1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on Access Points (APs)","name":"Access Points"}]},"pathMetadata":{},"sha256":"a25933037a82d99be63f13cb6d410b7399e82a15fc2741a6b713f24b21fdaa0b"}}},"/network-troubleshooting/v1/aps/{serial-number}/disconnectUserAll":{"post":{"description":"Initiates a disconnect action for all users connected to the specified Access Point.","operationId":"disconnectAllUsersApV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"}],"responses":{"202":{"content":{"application/json":{"example":{"startTime":"2025-07-22T15:00:00Z","status":"INITIATED"},"schema":{"$ref":"#/components/schemas/ActionInitiatedStatus__11d6968be580"}}},"description":"Accepted. The disconnect action has been successfully initiated."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/DeviceNotFound__02a6567f3633"},"409":{"$ref":"#/components/responses/DeviceOffline__02a6567f3633"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Disconnect all users from an Access Point","tags":["Access Points"],"x-source-document":{"file":"MRT/disconnectallusersapv1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on Access Points (APs)","name":"Access Points"}]},"pathMetadata":{},"sha256":"475d340e66d0e95e96b39ec4fb5bfffcade9e59c36de94cbd176d2474ff9f032"}}},"/network-troubleshooting/v1/aps/{serial-number}/disconnectUserByMacAddress":{"post":{"description":"Initiates a disconnect action for a specific user connected to the specified Access Point, identified by their MAC address.","operationId":"disconnectUserByMacApV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"}],"requestBody":{"content":{"application/json":{"example":{"userMacAddress":"AA:BB:CC:DD:EE:FF"},"schema":{"$ref":"#/components/schemas/DisconnectUserByMacApRequest__f6f569e0e58f"}}},"description":"User MAC address to disconnect","required":true},"responses":{"202":{"content":{"application/json":{"example":{"startTime":"2025-07-22T15:05:00Z","status":"INITIATED"},"schema":{"$ref":"#/components/schemas/ActionInitiatedStatus__11d6968be580"}}},"description":"Accepted. The disconnect action has been successfully initiated."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/DeviceNotFound__02a6567f3633"},"409":{"$ref":"#/components/responses/DeviceOffline__02a6567f3633"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Disconnect a specific user by MAC address from an Access Point","tags":["Access Points"],"x-source-document":{"file":"MRT/disconnectuserbymacapv1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on Access Points (APs)","name":"Access Points"}]},"pathMetadata":{},"sha256":"65319760daab96e9c0e2686cdbfbe2a3bf621e9c51546a53136780d8f5996fdb"}}},"/network-troubleshooting/v1/aps/{serial-number}/disconnectUserByNetwork":{"post":{"description":"Initiates a disconnect action for all users connected to a specific network (SSID) on the specified Access Point.","operationId":"disconnectUserByNetworkApV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"}],"requestBody":{"content":{"application/json":{"example":{"networkName":"Corporate-WiFi-5G"},"schema":{"$ref":"#/components/schemas/DisconnectUserByNetworkApRequest__a6e5659453ab"}}},"description":"Network name (SSID) to disconnect users from","required":true},"responses":{"202":{"content":{"application/json":{"example":{"startTime":"2025-07-22T15:10:00Z","status":"INITIATED"},"schema":{"$ref":"#/components/schemas/ActionInitiatedStatus__11d6968be580"}}},"description":"Accepted. The disconnect action has been successfully initiated."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/DeviceNotFound__02a6567f3633"},"409":{"$ref":"#/components/responses/DeviceOffline__02a6567f3633"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Disconnect all users from a specific network (SSID) on an Access Point","tags":["Access Points"],"x-source-document":{"file":"MRT/disconnectuserbynetworkapv1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on Access Points (APs)","name":"Access Points"}]},"pathMetadata":{},"sha256":"bbfd7aa2a752f253535d090c7f03bf5d132ae534d97733c1de6f02872c8e126a"}}},"/network-troubleshooting/v1/aps/{serial-number}/getArpTable":{"post":{"description":"Starts an asynchronous Get Arp Table test on the specified AP.","operationId":"initiateApGetArpTableV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"}],"responses":{"202":{"content":{"application/json":{"example":{"location":"/network-troubleshooting/v1/aps/{serial-number}/getArpTable/async-operations/{task-id}","startTime":"2025-04-09T10:00:00Z","status":"INITIATED"},"schema":{"$ref":"#/components/schemas/AsyncOperationStatus__02a6567f3633"}}},"description":"Accepted. The operation has been successfully initiated. The response includes the location to track the operation's status."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/DeviceNotFound__02a6567f3633"},"409":{"$ref":"#/components/responses/DeviceOffline__02a6567f3633"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Initiate a Get Arp Table test on an AP","tags":["Access Points"],"x-source-document":{"file":"MRT/initiateapgetarptablev1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on Access Points (APs)","name":"Access Points"}]},"pathMetadata":{},"sha256":"a3fcfd85b6844401bb37b95a84a1a0511cf3b884afeece5173db63ffa7a39a3b"}}},"/network-troubleshooting/v1/aps/{serial-number}/getArpTable/async-operations/{task-id}":{"get":{"description":"Retrieves the status and results of a previously initiated asynchronous AP Get Arp Table test.","operationId":"getApGetArpTableResultV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"},{"$ref":"#/components/parameters/AsyncTaskId__03efdde95a47"}],"responses":{"200":{"content":{"application/json":{"examples":{"completed":{"summary":"AP Get Arp Table completed successfully","value":{"endTime":"2025-05-20T13:25:03.920485478Z","failReason":null,"output":{"entries":[{"device":"br0.3333","flags":"0x2","hardwareType":"0x1","ipAddress":"172.31.98.18","macAddress":"a4:83:e7:18:ec:9f","mask":"*"},{"device":"br0","flags":"0x2","hardwareType":"0x1","ipAddress":"10.27.113.225","macAddress":"ec:eb:b8:19:aa:00","mask":"*"},{"device":"br0","flags":"0x2","hardwareType":"0x1","ipAddress":"10.27.113.226","macAddress":"20:4c:03:11:f3:90","mask":"*"},{"device":"br0.3333","flags":"0x0","hardwareType":"0x1","ipAddress":"172.31.98.36","macAddress":"00:00:00:00:00:00","mask":"*"},{"device":"br0.3333","flags":"0x6","hardwareType":"0x1","ipAddress":"172.31.98.2","macAddress":"c8:b5:ad:c3:b2:02","mask":"*"}]},"progressPercent":100,"rawOutput":"\nCOMMAND=show arp\nIP address       HW type     Flags       HW address            Mask     Device\n172.31.98.18     0x1         0x2         a4:83:e7:18:ec:9f     *        br0.3333\n10.27.113.225    0x1         0x2         ec:eb:b8:19:aa:00     *        br0\n10.27.113.226    0x1         0x2         20:4c:03:11:f3:90     *        br0\n172.31.98.36     0x1         0x0         00:00:00:00:00:00     *        br0.3333\n172.31.98.2      0x1         0x6         c8:b5:ad:c3:b2:02     *        br0.3333\n","startTime":"2025-05-20T13:25:03.610188852Z","status":"COMPLETED"}},"running":{"summary":"Operation still running","value":{"endTime":null,"output":null,"progressPercent":0,"rawOutput":null,"startTime":"2025-04-09T10:14:08Z","status":"RUNNING"}}},"schema":{"$ref":"#/components/schemas/GetArpTableApResult__bb3cf760e22a"}}},"description":"OK. Returns the status and results of the AP Get Arp Table test."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/TaskNotFound__03efdde95a47"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get AP Get Arp Table test status and results","tags":["Access Points"],"x-source-document":{"file":"MRT/getapgetarptableresultv1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on Access Points (APs)","name":"Access Points"}]},"pathMetadata":{},"sha256":"513e2dfe94a576efbd8d2bad7847cc5613c88ace2f10a9d8dc131a0b45f751ea"}}},"/network-troubleshooting/v1/aps/{serial-number}/http":{"post":{"description":"Starts an asynchronous HTTP test on the specified AP.","operationId":"initiateApHttpV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"}],"requestBody":{"content":{"application/json":{"examples":{"full":{"summary":"AP Http request with additional parameters","value":{"timeout":5,"url":"www.google.com"}},"minimal":{"summary":"Minimal AP Http request","value":{"url":"www.google.com"}}},"schema":{"$ref":"#/components/schemas/HttpApRequest__c3cbd398bd37"}}},"description":"AP Http command parameters","required":true},"responses":{"202":{"content":{"application/json":{"example":{"location":"/network-troubleshooting/v1/aps/{serial-number}/http/async-operations/{task-id}","startTime":"2025-04-09T10:00:00Z","status":"INITIATED"},"schema":{"$ref":"#/components/schemas/AsyncOperationStatus__02a6567f3633"}}},"description":"Accepted. The operation has been successfully initiated. The response includes the location to track the operation's status."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/DeviceNotFound__02a6567f3633"},"409":{"$ref":"#/components/responses/DeviceOffline__02a6567f3633"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Initiate an HTTP test on an AP","tags":["Access Points"],"x-source-document":{"file":"MRT/initiateaphttpv1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on Access Points (APs)","name":"Access Points"}]},"pathMetadata":{},"sha256":"0269d629d0eaa080f8963da55053c7b483ecb74684c8158c1013ec448dcd5d8b"}}},"/network-troubleshooting/v1/aps/{serial-number}/http/async-operations/{task-id}":{"get":{"description":"Retrieves the status and results of a previously initiated asynchronous AP HTTP test.","operationId":"getApHttpResultV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"},{"$ref":"#/components/parameters/AsyncTaskId__03efdde95a47"}],"responses":{"200":{"content":{"application/json":{"examples":{"completed":{"summary":"AP Http completed successfully","value":{"endTime":"2025-05-20T13:21:00.449524726Z","failReason":null,"output":{"downloadBytesInKB":"19","downloadRateInKbps":"125","url":"www.google.com"},"progressPercent":100,"startTime":"2025-05-20T13:20:58.202843531Z","status":"COMPLETED"}},"running":{"summary":"Operation still running","value":{"endTime":null,"output":null,"progressPercent":0,"startTime":"2025-04-09T10:14:08Z","status":"RUNNING"}}},"schema":{"$ref":"#/components/schemas/HttpApResult__78f43680b94b"}}},"description":"OK. Returns the status and results of the AP HTTP test."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/TaskNotFound__03efdde95a47"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get AP HTTP test status and results","tags":["Access Points"],"x-source-document":{"file":"MRT/getaphttpresultv1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on Access Points (APs)","name":"Access Points"}]},"pathMetadata":{},"sha256":"2327c713a5a19e7469bd74a197948192f8776bc48b2655c79f1f013bfbb3fbf0"}}},"/network-troubleshooting/v1/aps/{serial-number}/https":{"post":{"description":"Starts an asynchronous HTTPS test on the specified AP.","operationId":"initiateApHttpsV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"}],"requestBody":{"content":{"application/json":{"examples":{"full":{"summary":"AP Https request with additional parameters","value":{"timeout":5,"url":"www.google.com"}},"minimal":{"summary":"Minimal AP Https request","value":{"url":"www.google.com"}}},"schema":{"$ref":"#/components/schemas/HttpsApRequest__8348a8a53499"}}},"description":"AP Https command parameters","required":true},"responses":{"202":{"content":{"application/json":{"example":{"location":"/network-troubleshooting/v1/aps/{serial-number}/https/async-operations/{task-id}","startTime":"2025-04-09T10:00:00Z","status":"INITIATED"},"schema":{"$ref":"#/components/schemas/AsyncOperationStatus__02a6567f3633"}}},"description":"Accepted. The operation has been successfully initiated. The response includes the location to track the operation's status."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/DeviceNotFound__02a6567f3633"},"409":{"$ref":"#/components/responses/DeviceOffline__02a6567f3633"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Initiate an HTTPS test on an AP","tags":["Access Points"],"x-source-document":{"file":"MRT/initiateaphttpsv1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on Access Points (APs)","name":"Access Points"}]},"pathMetadata":{},"sha256":"9fc31332d148a078636a078f3f50ff79e453ae1ad9425aa143ba711e94d98336"}}},"/network-troubleshooting/v1/aps/{serial-number}/https/async-operations/{task-id}":{"get":{"description":"Retrieves the status and results of a previously initiated asynchronous AP HTTPS test.","operationId":"getApHttpsResultV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"},{"$ref":"#/components/parameters/AsyncTaskId__03efdde95a47"}],"responses":{"200":{"content":{"application/json":{"examples":{"completed":{"summary":"AP Https completed successfully","value":{"endTime":"2025-05-20T13:21:00.449524726Z","failReason":null,"output":{"downloadBytesInKB":"19","downloadRateInKbps":"125","url":"www.google.com"},"progressPercent":100,"rawOutput":null,"startTime":"2025-05-20T13:20:58.202843531Z","status":"COMPLETED"}},"running":{"summary":"Operation still running","value":{"endTime":null,"output":null,"progressPercent":0,"startTime":"2025-04-09T10:14:08Z","status":"RUNNING"}}},"schema":{"$ref":"#/components/schemas/HttpsApResult__cfd56278c765"}}},"description":"OK. Returns the status and results of the AP HTTPS test."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/TaskNotFound__03efdde95a47"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get AP HTTPS test status and results","tags":["Access Points"],"x-source-document":{"file":"MRT/getaphttpsresultv1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on Access Points (APs)","name":"Access Points"}]},"pathMetadata":{},"sha256":"6af09586410aa5f2604df8808e3bd4fd23c46785d7bab5bd9a91623cc8ecb227"}}},"/network-troubleshooting/v1/aps/{serial-number}/list-tasks":{"get":{"description":"Retrieves a list of all active or recently completed asynchronous operations for the specified AP, grouped by test name. Results are sorted by startTime in descending order (most recently started first).","operationId":"listApTasksV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskListResponse__3c2901e6fd8d"}}},"description":"OK. Returns the list of active/recent tasks."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/DeviceNotFound__02a6567f3633"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"List active async tasks for an AP","tags":["Access Points"],"x-source-document":{"file":"MRT/listaptasksv1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on Access Points (APs)","name":"Access Points"}]},"pathMetadata":{},"sha256":"1c45c290519d8b970c4bace6f21cae7f43ceee45177c03bcf482eb5f4b4a7901"}}},"/network-troubleshooting/v1/aps/{serial-number}/locate":{"post":{"description":"Initiates a locate (e.g., blinking LED) operation on the specified Access Point.","operationId":"locateApV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"}],"responses":{"202":{"content":{"application/json":{"example":{"startTime":"2025-06-25T08:31:15.380079232Z","status":"INITIATED"},"schema":{"$ref":"#/components/schemas/ActionInitiatedStatus__11d6968be580"}}},"description":"Accepted. The locate action has been successfully initiated."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/DeviceNotFound__02a6567f3633"},"409":{"$ref":"#/components/responses/DeviceConflictLocating__322170916979"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Locate an Access Point","tags":["Access Points"],"x-source-document":{"file":"MRT/locateapv1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on Access Points (APs)","name":"Access Points"}]},"pathMetadata":{},"sha256":"135eaa89a5b1584ef6479da5b9a6dfb79539647fb4ac97972fafebd2c9335a8c"}}},"/network-troubleshooting/v1/aps/{serial-number}/nslookup":{"post":{"description":"Starts an asynchronous Nslookup test on the specified AP.","operationId":"initiateApNslookupV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"}],"requestBody":{"content":{"application/json":{"examples":{"full":{"summary":"AP Nslookup request with a specific DNS server","value":{"dnsServer":"8.8.8.8","host":"www.google.com"}},"minimal":{"summary":"Minimal AP Nslookup request","value":{"host":"www.google.com"}}},"schema":{"$ref":"#/components/schemas/NslookupApRequest__b4a33e98130d"}}},"description":"AP Nslookup command parameters","required":true},"responses":{"202":{"content":{"application/json":{"example":{"location":"/network-troubleshooting/v1/aps/{serial-number}/nslookup/async-operations/{task-id}","startTime":"2025-04-09T10:00:00Z","status":"INITIATED"},"schema":{"$ref":"#/components/schemas/AsyncOperationStatus__02a6567f3633"}}},"description":"Accepted. The operation has been successfully initiated. The response includes the location to track the operation's status."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/DeviceNotFound__02a6567f3633"},"409":{"$ref":"#/components/responses/DeviceOffline__02a6567f3633"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Initiate an Nslookup test on an AP","tags":["Access Points"],"x-source-document":{"file":"MRT/initiateapnslookupv1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on Access Points (APs)","name":"Access Points"}]},"pathMetadata":{},"sha256":"db82e8be1ba4090b5c6df0146a8d330df6961061e3de8f6bfec04169168888ad"}}},"/network-troubleshooting/v1/aps/{serial-number}/nslookup/async-operations/{task-id}":{"get":{"description":"Retrieves the status and results of a previously initiated asynchronous AP Nslookup test.","operationId":"getApNslookupResultV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"},{"$ref":"#/components/parameters/AsyncTaskId__03efdde95a47"}],"responses":{"200":{"content":{"application/json":{"examples":{"completed":{"summary":"AP Nslookup completed successfully","value":{"endTime":"2025-05-20T13:26:21.719771353Z","failReason":null,"output":{"dnsServer":"8.8.8.8","hostName":"www.google.com","resolvedAddresses":["142.251.46.164"]},"progressPercent":100,"startTime":"2025-05-20T13:26:20.837887330Z","status":"COMPLETED"}},"running":{"summary":"Operation still running","value":{"endTime":null,"output":null,"progressPercent":50,"startTime":"2025-04-09T10:14:08Z","status":"RUNNING"}}},"schema":{"$ref":"#/components/schemas/NslookupApResult__f35d32c913eb"}}},"description":"OK. Returns the status and results of the AP Nslookup test."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/TaskNotFound__03efdde95a47"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get AP Nslookup test status and results","tags":["Access Points"],"x-source-document":{"file":"MRT/getapnslookupresultv1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on Access Points (APs)","name":"Access Points"}]},"pathMetadata":{},"sha256":"9886cc24cce46a42850f15239fa523314a15ddcac81f93c87dcbc6d3d51df687"}}},"/network-troubleshooting/v1/aps/{serial-number}/ping":{"post":{"description":"Starts an asynchronous Ping test on the specified AP.","operationId":"initiateApPingV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"}],"requestBody":{"content":{"application/json":{"examples":{"full":{"summary":"AP Ping request with additional parameters","value":{"count":5,"destination":"www.google.com","includeRawOutput":true,"interfacePort":"eth0","packetSize":10,"vlan":3000}},"minimal":{"summary":"Minimal AP Ping request","value":{"destination":"www.google.com"}}},"schema":{"$ref":"#/components/schemas/PingApRequest__11bfc6a440f0"}}},"description":"AP Ping command parameters","required":true},"responses":{"202":{"content":{"application/json":{"example":{"location":"/network-troubleshooting/v1/aps/{serial-number}/ping/async-operations/{task-id}","startTime":"2025-04-09T10:00:00Z","status":"INITIATED"},"schema":{"$ref":"#/components/schemas/AsyncOperationStatus__02a6567f3633"}}},"description":"Accepted. The operation has been successfully initiated. The response includes the location to track the operation's status."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/DeviceNotFound__02a6567f3633"},"409":{"$ref":"#/components/responses/DeviceOffline__02a6567f3633"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Initiate a Ping test on an AP","tags":["Access Points"],"x-source-document":{"file":"MRT/initiateappingv1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on Access Points (APs)","name":"Access Points"}]},"pathMetadata":{},"sha256":"0900b229f70d352d0118958b2519a1c71bb6073974a4c7d1b6f59f1bdabb8129"}}},"/network-troubleshooting/v1/aps/{serial-number}/ping/async-operations/{task-id}":{"get":{"description":"Retrieves the status and results of a previously initiated asynchronous AP Ping test.","operationId":"getApPingResultV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"},{"$ref":"#/components/parameters/AsyncTaskId__03efdde95a47"}],"responses":{"200":{"content":{"application/json":{"examples":{"completed":{"summary":"AP Ping completed successfully","value":{"endTime":"2025-05-20T13:08:04.034123064Z","failReason":null,"output":{"averageRoundTripTimeMilliseconds":"204.7","destination":"www.google.com","maximumRoundTripTimeMilliseconds":"209.8","minimumRoundTripTimeMilliseconds":"200.2","packetLossPercent":"20","receivedPacketsCount":"4","replies":[{"sentPacketAddress":"142.251.46.164","sentPacketIcmpSequenceNumber":"0","sentPacketSizeBytes":"64","sentPacketTimeMilliseconds":"200.2","sentPacketTimeToLive":"108"},{"sentPacketAddress":"142.251.46.164","sentPacketIcmpSequenceNumber":"1","sentPacketSizeBytes":"64","sentPacketTimeMilliseconds":"209.8","sentPacketTimeToLive":"108"},{"sentPacketAddress":"142.251.46.164","sentPacketIcmpSequenceNumber":"3","sentPacketSizeBytes":"64","sentPacketTimeMilliseconds":"208.8","sentPacketTimeToLive":"108"},{"sentPacketAddress":"142.251.46.164","sentPacketIcmpSequenceNumber":"4","sentPacketSizeBytes":"64","sentPacketTimeMilliseconds":"200.2","sentPacketTimeToLive":"108"}],"resolvedIp":"142.251.46.164","transmittedPacketsCount":"5"},"progressPercent":100,"rawOutput":"\nCOMMAND=ping www.google.com\nPING 142.251.46.164 (142.251.46.164): 56 data bytes\n64 bytes from 142.251.46.164: icmp_seq=0 ttl=108 time=200.2 ms\n64 bytes from 142.251.46.164: icmp_seq=1 ttl=108 time=209.8 ms\n64 bytes from 142.251.46.164: icmp_seq=3 ttl=108 time=208.8 ms\n64 bytes from 142.251.46.164: icmp_seq=4 ttl=108 time=200.2 ms\n\n--- 142.251.46.164 ping statistics ---\n5 packets transmitted, 4 packets received, 20% packet loss\nround-trip min/avg/max = 200.2/204.7/209.8 ms\n","startTime":"2025-05-20T13:07:48.849780286Z","status":"COMPLETED"}},"completed with failure":{"summary":"AP Ping failed result","value":{"endTime":"2025-05-20T13:26:21.719771353Z","failReason":"Destination not resolved","output":null,"progressPercent":100,"rawOutput":"\nCOMMAND=ping www.djgdij.com\nhost address failed because the ipv4/v6 address www.djgdij.com is invalid.\n","startTime":"2025-05-20T13:26:20.837887330Z","status":"COMPLETED"}},"running":{"summary":"Operation still running","value":{"endTime":null,"output":null,"progressPercent":0,"rawOutput":null,"startTime":"2025-04-09T10:14:08Z","status":"RUNNING"}}},"schema":{"$ref":"#/components/schemas/PingApResult__d63f315f0dff"}}},"description":"OK. Returns the status and results of the AP Ping test."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/TaskNotFound__03efdde95a47"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get AP Ping test status and results","tags":["Access Points"],"x-source-document":{"file":"MRT/getappingresultv1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on Access Points (APs)","name":"Access Points"}]},"pathMetadata":{},"sha256":"7a784f9b62422a06f117bb9532a316bf4d4879e3a36046eb70e81131188ae2d1"}}},"/network-troubleshooting/v1/aps/{serial-number}/reboot":{"post":{"description":"Initiates a reboot operation on the specified Access Point.","operationId":"rebootApV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"}],"responses":{"202":{"content":{"application/json":{"example":{"startTime":"2025-06-25T08:31:15.380079232Z","status":"INITIATED"},"schema":{"$ref":"#/components/schemas/ActionInitiatedStatus__11d6968be580"}}},"description":"Accepted. The reboot action has been successfully initiated."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/DeviceNotFound__02a6567f3633"},"409":{"$ref":"#/components/responses/DeviceConflictRebooting__78801b30c1be"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Reboot an Access Point","tags":["Access Points"],"x-source-document":{"file":"MRT/rebootapv1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on Access Points (APs)","name":"Access Points"}]},"pathMetadata":{},"sha256":"0f643381148ba5d1b2a9e124d9ce3903383e8062240a4edf281178346ba422fd"}}},"/network-troubleshooting/v1/aps/{serial-number}/rebootSwarm":{"post":{"description":"Initiates a reboot operation on the entire Swarm, triggered via its current conductor AP. The {serial-number} must be the serial of the Swarm's active conductor.","operationId":"rebootApSwarmV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"}],"responses":{"202":{"content":{"application/json":{"example":{"startTime":"2025-10-28T11:00:00Z","status":"INITIATED"},"schema":{"$ref":"#/components/schemas/ActionInitiatedStatus__11d6968be580"}}},"description":"Accepted. The Swarm reboot action has been successfully initiated."},"400":{"content":{"application/json":{"examples":{"notConductor":{"summary":"Device is not a conductor","value":{"errorCode":"HPE_GL_ERROR_BAD_REQUEST","message":"Given device is not a conductor"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse__02a6567f3633"}}},"description":"Bad Request. Validation errors, or the specified device is not a conductor.","headers":{"X-RateLimit-Limit":{"description":"Request limit per hour.","schema":{"format":"int64","maximum":9223372036854776000,"minimum":0,"type":"integer"}},"X-RateLimit-Remaining":{"description":"The number of requests left for the time window.","schema":{"format":"int64","maximum":9223372036854776000,"minimum":0,"type":"integer"}},"X-RateLimit-Reset":{"description":"The date-time (RFC 3339 timestamp in UTC+0) at which the current rate limit window resets.","schema":{"format":"date-time","maxLength":20,"type":"string"}}}},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/DeviceNotFound__02a6567f3633"},"409":{"$ref":"#/components/responses/DeviceConflictRebooting__78801b30c1be"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Reboot an AP Swarm","tags":["Access Points"],"x-source-document":{"file":"MRT/rebootapswarmv1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on Access Points (APs)","name":"Access Points"}]},"pathMetadata":{},"sha256":"e2562395d9a17128a61e06884d3ceb59ba05aecee53733aab375a35492b22849"}}},"/network-troubleshooting/v1/aps/{serial-number}/show-commands":{"get":{"description":"Returns most used/top 'show' commands supported on given AP. ","operationId":"listApShowCommandsV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShowCommandsResponse__3ba348bd5d1e"}}},"description":"OK. Returns the list of 'show' commands grouped by category."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/DeviceNotFound__02a6567f3633"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"List 'show' commands (AP - top commands)","tags":["Access Points"],"x-source-document":{"file":"MRT/listapshowcommandsv1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on Access Points (APs)","name":"Access Points"}]},"pathMetadata":{},"sha256":"ff0ff7b880ff95d7f753602ad5b05fd0491f9b1e08c71f5e31f9341c223a650c"}}},"/network-troubleshooting/v1/aps/{serial-number}/showCommands":{"post":{"description":"Starts an asynchronous execution of one or more 'show' commands on an AP. The request is rejected with 400 if any command does not start with 'show ', or if more than 20 commands are provided.","operationId":"runApShowCommandsV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"}],"requestBody":{"content":{"application/json":{"example":{"commands":["show interface brief","show version"]},"schema":{"$ref":"#/components/schemas/ShowCommandRequest__1070839fcc3b"}}},"description":"The list of 'show' commands to run.","required":true},"responses":{"202":{"content":{"application/json":{"example":{"location":"/network-troubleshooting/v1/aps/{serial-number}/showCommands/async-operations/{task-id}","startTime":"2025-08-25T10:00:00Z","status":"INITIATED"},"schema":{"$ref":"#/components/schemas/AsyncOperationStatus__02a6567f3633"}}},"description":"Accepted. Operation initiated; use the returned location to poll status/result."},"400":{"$ref":"#/components/responses/BadRequestShowCommand__1070839fcc3b"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/DeviceNotFound__02a6567f3633"},"409":{"$ref":"#/components/responses/DeviceOffline__02a6567f3633"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Run 'show' commands (AP)","tags":["Access Points"],"x-source-document":{"file":"MRT/runapshowcommandsv1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on Access Points (APs)","name":"Access Points"}]},"pathMetadata":{},"sha256":"fc0db21a5a2fcc20eff0f6a0e3c40e6bb2801d9b2ed54c0b1baeb46d1856d1b4"}}},"/network-troubleshooting/v1/aps/{serial-number}/showCommands/async-operations/{task-id}":{"get":{"description":"Polls the async task for the 'show' commands and returns status and raw text output.","operationId":"getApShowCommandsResultV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"},{"$ref":"#/components/parameters/AsyncTaskId__03efdde95a47"}],"responses":{"200":{"content":{"application/json":{"examples":{"completed":{"summary":"Command finished successfully","value":{"endTime":"2026-02-03T14:21:02.004881090Z","failReason":null,"output":{"commands":["show version"],"results":[{"command":"show version","output":"\r\n\r\n## Command: show version - Tue Feb 3 06:39:02 2026\n====================================================\n\nTue Feb 03 06:39:02.313 2026\nHPE Aruba Networking Wireless Operating System.\nAOS-10 (MODEL: Aruba7010), Version 10.7.2.0 SSR\nWebsite: http://www.arubanetworks.com\n(c) Copyright 2025 Hewlett Packard Enterprise Development LP.\nCompiled on 2025-02-10 at 15:26:21 UTC (build 91891) by jenkins\n\nROM: System Bootstrap, Version CPBoot 1.0.7.0 (build 65676)\nBuilt: 2018-07-06 04:23:32\nBuilt by: p4build@re_client_65676\n\n\nSwitch uptime is 43 days 14 hours 8 minutes 8 seconds\nReboot Cause: Power Cycle (Intent:cause:register ee:ee:0:8000)\nSupervisor Card\nProcessor (XLP208 Rev B1 (Secure Boot) , 800 MHz) with 3797M bytes of memory.\n32K bytes of non-volatile configuration memory.\n1936M bytes of Supervisor Card system flash.\n"}]},"progressPercent":100,"startTime":"2026-02-03T14:20:59.912054756Z","status":"COMPLETED"}},"running":{"summary":"Still running","value":{"endTime":null,"failReason":null,"output":null,"progressPercent":40,"startTime":"2025-08-25T10:00:01Z","status":"RUNNING"}}},"schema":{"$ref":"#/components/schemas/ShowCommandResult__8cc1ef82c4a3"}}},"description":"OK. Returns the status and result for the run 'show' commands."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/TaskNotFound__03efdde95a47"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get 'show' commands status/result (AP)","tags":["Access Points"],"x-source-document":{"file":"MRT/getapshowcommandsresultv1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on Access Points (APs)","name":"Access Points"}]},"pathMetadata":{},"sha256":"a21479d9bdd153b0e5e654f41c599416a8b31ca1a34a8fce937a65cfae7f477f"}}},"/network-troubleshooting/v1/aps/{serial-number}/speedtest":{"post":{"description":"Starts an asynchronous Speedtest on the specified AP.","operationId":"initiateApSpeedtestV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"}],"requestBody":{"content":{"application/json":{"examples":{"full":{"summary":"AP Speedtest request with additional parameters","value":{"bandwidth":1000,"includeReverse":true,"iperfServerAddress":"84.1.43.23","omit":3,"parallel":10,"protocol":"tcp","secondsToMeasure":20,"serverPort":5055,"windowSize":1000}},"minimal":{"summary":"Minimal AP Speedtest request","value":{"iperfServerAddress":"84.1.43.23"}}},"schema":{"$ref":"#/components/schemas/SpeedtestApRequest__6778d358380c"}}},"description":"AP Speedtest command parameters","required":true},"responses":{"202":{"content":{"application/json":{"example":{"location":"/network-troubleshooting/v1/aps/{serial-number}/speedtest/async-operations/{task-id}","startTime":"2025-04-09T10:00:00Z","status":"INITIATED"},"schema":{"$ref":"#/components/schemas/AsyncOperationStatus__02a6567f3633"}}},"description":"Accepted. The operation has been successfully initiated. The response includes the location to track the operation's status."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/DeviceNotFound__02a6567f3633"},"409":{"$ref":"#/components/responses/DeviceOffline__02a6567f3633"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Initiate a Speedtest on an AP","tags":["Access Points"],"x-source-document":{"file":"MRT/initiateapspeedtestv1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on Access Points (APs)","name":"Access Points"}]},"pathMetadata":{},"sha256":"c23d8c17b71e8e1a07e8820ac03db18259c310d388da179310f740ee2a163899"}}},"/network-troubleshooting/v1/aps/{serial-number}/speedtest/async-operations/{task-id}":{"get":{"description":"Retrieves the status and results of a previously initiated asynchronous AP Speedtest.","operationId":"getApSpeedtestResultV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"},{"$ref":"#/components/parameters/AsyncTaskId__03efdde95a47"}],"responses":{"200":{"content":{"application/json":{"examples":{"completed":{"summary":"AP Speedtest completed successfully","value":{"endTime":"2025-05-20T13:19:48.499847376Z","failReason":null,"output":{"downstreamBandwidthInMbps":null,"downstreamBytes":null,"downstreamDatagrams":null,"downstreamJitter":null,"downstreamLostPackets":null,"downstreamRetries":null,"intervalInSeconds":"10","iperfServerAddress":"84.17.57.129","protocol":"TCP","serverPort":"51118","upstreamBandwidthInMbps":"16.855683","upstreamBytes":"21069984","upstreamDatagrams":null,"upstreamJitter":null,"upstreamLostPackets":null,"upstreamRetries":"1442"},"progressPercent":100,"startTime":"2025-05-20T13:19:36.125254066Z","status":"COMPLETED"}},"running":{"summary":"Operation still running","value":{"endTime":null,"output":null,"progressPercent":0,"startTime":"2025-04-09T10:14:08Z","status":"RUNNING"}}},"schema":{"$ref":"#/components/schemas/SpeedtestApResult__fddb7d22dcc0"}}},"description":"OK. Returns the status and results of the AP Speedtest."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/TaskNotFound__03efdde95a47"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get AP Speedtest status and results","tags":["Access Points"],"x-source-document":{"file":"MRT/getapspeedtestresultv1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on Access Points (APs)","name":"Access Points"}]},"pathMetadata":{},"sha256":"78b62034f6c99566ceeed34aafdbec0864e3e73a873d2194fe0aa3456bd3a747"}}},"/network-troubleshooting/v1/aps/{serial-number}/tcp":{"post":{"description":"Starts an asynchronous TCP test on the specified AP.","operationId":"initiateApTcpV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"}],"requestBody":{"content":{"application/json":{"examples":{"full":{"summary":"AP Tcp request with additional parameters","value":{"host":"www.google.com","port":443,"timeout":5}},"minimal":{"summary":"Minimal AP Tcp request","value":{"host":"www.google.com","port":443}}},"schema":{"$ref":"#/components/schemas/TcpApRequest__07d6ba732ff6"}}},"description":"AP Tcp command parameters","required":true},"responses":{"202":{"content":{"application/json":{"example":{"location":"/network-troubleshooting/v1/aps/{serial-number}/tcp/async-operations/{task-id}","startTime":"2025-04-09T10:00:00Z","status":"INITIATED"},"schema":{"$ref":"#/components/schemas/AsyncOperationStatus__02a6567f3633"}}},"description":"Accepted. The operation has been successfully initiated. The response includes the location to track the operation's status."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/DeviceNotFound__02a6567f3633"},"409":{"$ref":"#/components/responses/DeviceOffline__02a6567f3633"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Initiate a TCP test on an AP","tags":["Access Points"],"x-source-document":{"file":"MRT/initiateaptcpv1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on Access Points (APs)","name":"Access Points"}]},"pathMetadata":{},"sha256":"66b182b31929ecee0aaddf61399b289036d5d0b00548719c84fb4cbdf48e5289"}}},"/network-troubleshooting/v1/aps/{serial-number}/tcp/async-operations/{task-id}":{"get":{"description":"Retrieves the status and results of a previously initiated asynchronous AP TCP test.","operationId":"getApTcpResultV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"},{"$ref":"#/components/parameters/AsyncTaskId__03efdde95a47"}],"responses":{"200":{"content":{"application/json":{"examples":{"completed":{"summary":"AP Tcp completed successfully","value":{"endTime":"2025-05-20T13:23:34.121460257Z","failReason":null,"output":{"connectionTimeInMilliseconds":"209","host":"www.google.com"},"progressPercent":100,"startTime":"2025-05-20T13:23:33.299455647Z","status":"COMPLETED"}},"running":{"summary":"Operation still running","value":{"endTime":null,"output":null,"progressPercent":0,"startTime":"2025-04-09T10:14:08Z","status":"RUNNING"}}},"schema":{"$ref":"#/components/schemas/TcpApResult__a1a5a1487152"}}},"description":"OK. Returns the status and results of the AP TCP test."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/TaskNotFound__03efdde95a47"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get AP TCP test status and results","tags":["Access Points"],"x-source-document":{"file":"MRT/getaptcpresultv1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on Access Points (APs)","name":"Access Points"}]},"pathMetadata":{},"sha256":"8a8ec916908d871060ce9d398cfcdc4b184f81afe4fe0ef31e9f93001c927ded"}}},"/network-troubleshooting/v1/aps/{serial-number}/traceroute":{"post":{"description":"Starts an asynchronous Traceroute test on the specified AP.","operationId":"initiateApTracerouteV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"}],"requestBody":{"content":{"application/json":{"examples":{"full":{"summary":"AP Traceroute request with additional parameters","value":{"destination":"www.google.com","includeRawOutput":false}},"minimal":{"summary":"Minimal AP Traceroute request","value":{"destination":"www.google.com"}}},"schema":{"$ref":"#/components/schemas/TracerouteApRequest__40b936d0123d"}}},"description":"AP Traceroute command parameters","required":true},"responses":{"202":{"content":{"application/json":{"example":{"location":"/network-troubleshooting/v1/aps/{serial-number}/traceroute/async-operations/{task-id}","startTime":"2025-04-09T10:00:00Z","status":"INITIATED"},"schema":{"$ref":"#/components/schemas/AsyncOperationStatus__02a6567f3633"}}},"description":"Accepted. The operation has been successfully initiated. The response includes the location to track the operation's status."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/DeviceNotFound__02a6567f3633"},"409":{"$ref":"#/components/responses/DeviceOffline__02a6567f3633"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Initiate a Traceroute test on an AP","tags":["Access Points"],"x-source-document":{"file":"MRT/initiateaptraceroutev1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on Access Points (APs)","name":"Access Points"}]},"pathMetadata":{},"sha256":"04e947ae2d854d330fd7b6080158421dd9ac9ff0184368a50e11dff193a4fedf"}}},"/network-troubleshooting/v1/aps/{serial-number}/traceroute/async-operations/{task-id}":{"get":{"description":"Retrieves the status and results of a previously initiated asynchronous AP Traceroute test.","operationId":"getApTracerouteResultV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"},{"$ref":"#/components/parameters/AsyncTaskId__03efdde95a47"}],"responses":{"200":{"content":{"application/json":{"examples":{"completed":{"summary":"AP Traceroute completed successfully","value":{"endTime":"2025-05-20T13:17:07.358841792Z","failReason":null,"output":{"destination":"www.google.com","hops":[{"hop":"1","probes":[{"ipAddress":"null","responseTimeMilliseconds":"33.799 ms","reverseDnsResolution":"10.27.113.225"},{"ipAddress":"null","responseTimeMilliseconds":"0.942 ms","reverseDnsResolution":"10.27.113.225"},{"ipAddress":"null","responseTimeMilliseconds":"0.897 ms","reverseDnsResolution":"10.27.113.225"}]},{"hop":"2","probes":[{"ipAddress":"null","responseTimeMilliseconds":"0.890 ms","reverseDnsResolution":"10.27.113.1"},{"ipAddress":"null","responseTimeMilliseconds":"399.632 ms","reverseDnsResolution":"10.27.113.1"},{"ipAddress":"null","responseTimeMilliseconds":"0.887 ms","reverseDnsResolution":"10.27.113.1"}]},{"hop":"3","probes":[{"ipAddress":"null","responseTimeMilliseconds":"0.890 ms","reverseDnsResolution":"10.27.70.2"},{"ipAddress":"null","responseTimeMilliseconds":"0.795 ms","reverseDnsResolution":"10.27.70.2"},{"ipAddress":"null","responseTimeMilliseconds":"997.445 ms","reverseDnsResolution":"10.27.70.2"}]},{"hop":"4","probes":[{"ipAddress":"null","responseTimeMilliseconds":"0.889 ms","reverseDnsResolution":"10.27.66.2"},{"ipAddress":"null","responseTimeMilliseconds":"0.889 ms","reverseDnsResolution":"10.27.66.2"},{"ipAddress":"null","responseTimeMilliseconds":"0.801 ms","reverseDnsResolution":"10.27.66.2"}]},{"hop":"5","probes":[{"ipAddress":"null","responseTimeMilliseconds":"*","reverseDnsResolution":"null"},{"ipAddress":"null","responseTimeMilliseconds":"*","reverseDnsResolution":"null"},{"ipAddress":"null","responseTimeMilliseconds":"*","reverseDnsResolution":"null"}]},{"hop":"6","probes":[{"ipAddress":"null","responseTimeMilliseconds":"*","reverseDnsResolution":"null"},{"ipAddress":"null","responseTimeMilliseconds":"*","reverseDnsResolution":"null"},{"ipAddress":"null","responseTimeMilliseconds":"*","reverseDnsResolution":"null"}]},{"hop":"7","probes":[{"ipAddress":"null","responseTimeMilliseconds":"*","reverseDnsResolution":"null"},{"ipAddress":"null","responseTimeMilliseconds":"*","reverseDnsResolution":"null"},{"ipAddress":"null","responseTimeMilliseconds":"*","reverseDnsResolution":"null"}]},{"hop":"8","probes":[{"ipAddress":"null","responseTimeMilliseconds":"*","reverseDnsResolution":"null"},{"ipAddress":"null","responseTimeMilliseconds":"*","reverseDnsResolution":"null"},{"ipAddress":"null","responseTimeMilliseconds":"*","reverseDnsResolution":"null"}]},{"hop":"9","probes":[{"ipAddress":"null","responseTimeMilliseconds":"*","reverseDnsResolution":"null"},{"ipAddress":"null","responseTimeMilliseconds":"*","reverseDnsResolution":"null"},{"ipAddress":"null","responseTimeMilliseconds":"*","reverseDnsResolution":"null"}]},{"hop":"10","probes":[{"ipAddress":"null","responseTimeMilliseconds":"*","reverseDnsResolution":"null"},{"ipAddress":"null","responseTimeMilliseconds":"*","reverseDnsResolution":"null"},{"ipAddress":"null","responseTimeMilliseconds":"*","reverseDnsResolution":"null"}]},{"hop":"11","probes":[{"ipAddress":"null","responseTimeMilliseconds":"*","reverseDnsResolution":"null"},{"ipAddress":"null","responseTimeMilliseconds":"*","reverseDnsResolution":"null"},{"ipAddress":"null","responseTimeMilliseconds":"*","reverseDnsResolution":"null"}]},{"hop":"12","probes":[{"ipAddress":"null","responseTimeMilliseconds":"*","reverseDnsResolution":"null"},{"ipAddress":"null","responseTimeMilliseconds":"*","reverseDnsResolution":"null"},{"ipAddress":"null","responseTimeMilliseconds":"*","reverseDnsResolution":"null"}]},{"hop":"13","probes":[{"ipAddress":"null","responseTimeMilliseconds":"*","reverseDnsResolution":"null"},{"ipAddress":"null","responseTimeMilliseconds":"*","reverseDnsResolution":"null"},{"ipAddress":"null","responseTimeMilliseconds":"*","reverseDnsResolution":"null"}]},{"hop":"14","probes":[{"ipAddress":"null","responseTimeMilliseconds":"*","reverseDnsResolution":"null"},{"ipAddress":"null","responseTimeMilliseconds":"*","reverseDnsResolution":"null"},{"ipAddress":"null","responseTimeMilliseconds":"*","reverseDnsResolution":"null"}]},{"hop":"15","probes":[{"ipAddress":"null","responseTimeMilliseconds":"*","reverseDnsResolution":"null"},{"ipAddress":"null","responseTimeMilliseconds":"*","reverseDnsResolution":"null"},{"ipAddress":"null","responseTimeMilliseconds":"*","reverseDnsResolution":"null"}]},{"hop":"16","probes":[{"ipAddress":"null","responseTimeMilliseconds":"*","reverseDnsResolution":"null"},{"ipAddress":"null","responseTimeMilliseconds":"*","reverseDnsResolution":"null"},{"ipAddress":"null","responseTimeMilliseconds":"*","reverseDnsResolution":"null"}]},{"hop":"17","probes":[{"ipAddress":"null","responseTimeMilliseconds":"*","reverseDnsResolution":"null"},{"ipAddress":"null","responseTimeMilliseconds":"*","reverseDnsResolution":"null"},{"ipAddress":"null","responseTimeMilliseconds":"*","reverseDnsResolution":"null"}]},{"hop":"18","probes":[{"ipAddress":"null","responseTimeMilliseconds":"*","reverseDnsResolution":"null"},{"ipAddress":"null","responseTimeMilliseconds":"*","reverseDnsResolution":"null"},{"ipAddress":"null","responseTimeMilliseconds":"*","reverseDnsResolution":"null"}]},{"hop":"19","probes":[{"ipAddress":"null","responseTimeMilliseconds":"*","reverseDnsResolution":"null"},{"ipAddress":"null","responseTimeMilliseconds":"*","reverseDnsResolution":"null"},{"ipAddress":"null","responseTimeMilliseconds":"*","reverseDnsResolution":"null"}]},{"hop":"20","probes":[{"ipAddress":"null","responseTimeMilliseconds":"*","reverseDnsResolution":"null"},{"ipAddress":"null","responseTimeMilliseconds":"*","reverseDnsResolution":"null"},{"ipAddress":"null","responseTimeMilliseconds":"*","reverseDnsResolution":"null"}]},{"hop":"21","probes":[{"ipAddress":"null","responseTimeMilliseconds":"*","reverseDnsResolution":"null"},{"ipAddress":"null","responseTimeMilliseconds":"*","reverseDnsResolution":"null"},{"ipAddress":"null","responseTimeMilliseconds":"*","reverseDnsResolution":"null"}]},{"hop":"22","probes":[{"ipAddress":"null","responseTimeMilliseconds":"*","reverseDnsResolution":"null"},{"ipAddress":"null","responseTimeMilliseconds":"*","reverseDnsResolution":"null"},{"ipAddress":"null","responseTimeMilliseconds":"*","reverseDnsResolution":"null"}]},{"hop":"23","probes":[{"ipAddress":"null","responseTimeMilliseconds":"*","reverseDnsResolution":"null"},{"ipAddress":"null","responseTimeMilliseconds":"*","reverseDnsResolution":"null"},{"ipAddress":"null","responseTimeMilliseconds":"*","reverseDnsResolution":"null"}]},{"hop":"24","probes":[{"ipAddress":"null","responseTimeMilliseconds":"*","reverseDnsResolution":"null"},{"ipAddress":"null","responseTimeMilliseconds":"*","reverseDnsResolution":"null"},{"ipAddress":"null","responseTimeMilliseconds":"*","reverseDnsResolution":"null"}]},{"hop":"25","probes":[{"ipAddress":"null","responseTimeMilliseconds":"*","reverseDnsResolution":"null"},{"ipAddress":"null","responseTimeMilliseconds":"*","reverseDnsResolution":"null"},{"ipAddress":"null","responseTimeMilliseconds":"*","reverseDnsResolution":"null"}]},{"hop":"26","probes":[{"ipAddress":"null","responseTimeMilliseconds":"*","reverseDnsResolution":"null"},{"ipAddress":"null","responseTimeMilliseconds":"*","reverseDnsResolution":"null"},{"ipAddress":"null","responseTimeMilliseconds":"*","reverseDnsResolution":"null"}]},{"hop":"27","probes":[{"ipAddress":"null","responseTimeMilliseconds":"*","reverseDnsResolution":"null"},{"ipAddress":"null","responseTimeMilliseconds":"*","reverseDnsResolution":"null"},{"ipAddress":"null","responseTimeMilliseconds":"*","reverseDnsResolution":"null"}]},{"hop":"28","probes":[{"ipAddress":"null","responseTimeMilliseconds":"*","reverseDnsResolution":"null"},{"ipAddress":"null","responseTimeMilliseconds":"*","reverseDnsResolution":"null"},{"ipAddress":"null","responseTimeMilliseconds":"*","reverseDnsResolution":"null"}]},{"hop":"29","probes":[{"ipAddress":"null","responseTimeMilliseconds":"*","reverseDnsResolution":"null"},{"ipAddress":"null","responseTimeMilliseconds":"*","reverseDnsResolution":"null"},{"ipAddress":"null","responseTimeMilliseconds":"*","reverseDnsResolution":"null"}]},{"hop":"30","probes":[{"ipAddress":"null","responseTimeMilliseconds":"*","reverseDnsResolution":"null"},{"ipAddress":"null","responseTimeMilliseconds":"*","reverseDnsResolution":"null"},{"ipAddress":"null","responseTimeMilliseconds":"*","reverseDnsResolution":"null"}]}],"resolvedIp":"142.251.46.164"},"progressPercent":100,"rawOutput":"\nCOMMAND=traceroute www.google.com\ntraceroute to 142.251.46.164 (142.251.46.164), 30 hops max, 38 byte packets\n 1  10.27.113.225  33.799 ms  0.942 ms  0.897 ms\n 2  10.27.113.1  0.890 ms  399.632 ms  0.887 ms\n 3  10.27.70.2  0.890 ms  0.795 ms  997.445 ms\n 4  10.27.66.2  0.889 ms  0.889 ms  0.801 ms\n 5  * * *\n 6  * * *\n 7  * * *\n 8  * * *\n 9  * * *\n10  * * *\n11  * * *\n12  * * *\n13  * * *\n14  * * *\n15  * * *\n16  * * *\n17  * * *\n18  * * *\n19  * * *\n20  * * *\n21  * * *\n22  * * *\n23  * * *\n24  * * *\n25  * * *\n26  * * *\n27  * * *\n28  * * *\n29  * * *\n30  * * *\n","startTime":"2025-05-20T13:14:29.148912180Z","status":"COMPLETED"}},"running":{"summary":"Operation still running","value":{"endTime":null,"failReason":null,"output":null,"progressPercent":0,"rawOutput":null,"startTime":"2025-05-20T13:14:29.148912180Z","status":"RUNNING"}}},"schema":{"$ref":"#/components/schemas/TracerouteApResult__03efdde95a47"}}},"description":"OK. Returns the status and results of the AP Traceroute test."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/TaskNotFound__03efdde95a47"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get AP Traceroute test status and results","tags":["Access Points"],"x-source-document":{"file":"MRT/getaptracerouteresultv1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on Access Points (APs)","name":"Access Points"}]},"pathMetadata":{},"sha256":"7c8896db7c6bf1164aae1dd98861c3ce569133ba780761b8784186c1deab627f"}}},"/network-troubleshooting/v1/cx/{serial-number}/aaa":{"post":{"description":"Starts an asynchronous Aaa test on the specified CX Switch.","operationId":"initiateCxAaaV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"}],"requestBody":{"content":{"application/json":{"examples":{"full":{"summary":"CX Switch Aaa request with additional parameters","value":{"authMethodType":"pap","password":"aruba@123","radiusServerIp":"10.1.1.0","radiusServerPort":5000,"username":"testuser","vrfName":"default"}},"minimal":{"summary":"Minimal CX Switch Aaa request","value":{"authMethodType":"chap","password":"aruba@123","radiusServerIp":"10.1.1.0","username":"testuser"}}},"schema":{"$ref":"#/components/schemas/AaaCxRequest__dbd7deaef1e9"}}},"description":"CX Switch Aaa command parameters","required":true},"responses":{"202":{"content":{"application/json":{"example":{"location":"/network-troubleshooting/v1/cx/{serial-number}/aaa/async-operations/{task-id}","startTime":"2025-04-09T10:00:00Z","status":"INITIATED"},"schema":{"$ref":"#/components/schemas/AsyncOperationStatus__02a6567f3633"}}},"description":"Accepted. The operation has been successfully initiated. The response includes the location to track the operation's status."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/DeviceNotFound__02a6567f3633"},"409":{"$ref":"#/components/responses/DeviceOffline__02a6567f3633"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Initiate a Aaa test on a CX Switch","tags":["CX Switches"],"x-source-document":{"file":"MRT/initiatecxaaav1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on CX Switches (The stackId should be used in place of the serial for stack switches)","name":"CX Switches"}]},"pathMetadata":{},"sha256":"ecd0128a412cb7400c0487ef8405739e8716efde9fca61310d5234a2bd3d4566"}}},"/network-troubleshooting/v1/cx/{serial-number}/aaa/async-operations/{task-id}":{"get":{"description":"Retrieves the status and results of a previously initiated asynchronous CX Switch Aaa test.","operationId":"getCxAaaResultV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"},{"$ref":"#/components/parameters/AsyncTaskId__03efdde95a47"}],"responses":{"200":{"content":{"application/json":{"examples":{"completed":{"summary":"CX Switch Aaa completed successfully","value":{"endTime":"2025-05-21T17:07:31.123316017Z","failReason":null,"output":{"authMethodType":"chap","authenticationStatus":"accept","radiusServerIp":"10.1.1.10","username":"005056bd4115"},"progressPercent":100,"startTime":"2025-05-21T17:07:24.895362597Z","status":"COMPLETED"}},"running":{"summary":"Operation still running","value":{"endTime":null,"output":null,"progressPercent":0,"startTime":"2025-04-09T10:14:08Z","status":"RUNNING"}}},"schema":{"$ref":"#/components/schemas/AaaCxResult__931317077098"}}},"description":"OK. Returns the status and results of the CX Switch Aaa test."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/TaskNotFound__03efdde95a47"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get CX Switch Aaa test status and results","tags":["CX Switches"],"x-source-document":{"file":"MRT/getcxaaaresultv1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on CX Switches (The stackId should be used in place of the serial for stack switches)","name":"CX Switches"}]},"pathMetadata":{},"sha256":"4509f5ab74ff98b018f825cce18212f676028a61eae2086ac026dcc8f47c2665"}}},"/network-troubleshooting/v1/cx/{serial-number}/cableTest":{"post":{"description":"Starts an asynchronous Cable Test on the specified CX Switch.","operationId":"initiateCxCableTestV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"}],"requestBody":{"content":{"application/json":{"examples":{"minimal":{"summary":"CX Switch Cable Test request","value":{"ports":["1/1/1","1/1/2","2/1/1"]}}},"schema":{"$ref":"#/components/schemas/CableTestCxRequest__69f41ecbf63b"}}},"description":"CX Switch Cable Test command parameters","required":true},"responses":{"202":{"content":{"application/json":{"example":{"location":"/network-troubleshooting/v1/cx/{serial-number}/cableTest/async-operations/{task-id}","startTime":"2025-04-09T10:00:00Z","status":"INITIATED"},"schema":{"$ref":"#/components/schemas/AsyncOperationStatus__02a6567f3633"}}},"description":"Accepted. The operation has been successfully initiated. The response includes the location to track the operation's status."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/DeviceNotFound__02a6567f3633"},"409":{"$ref":"#/components/responses/DeviceOffline__02a6567f3633"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Initiate a Cable Test on a CX Switch","tags":["CX Switches"],"x-source-document":{"file":"MRT/initiatecxcabletestv1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on CX Switches (The stackId should be used in place of the serial for stack switches)","name":"CX Switches"}]},"pathMetadata":{},"sha256":"33e8418b4c1e7988a36ae63f1bd3956ac8e7471e6569dd877c352e59d438b460"}}},"/network-troubleshooting/v1/cx/{serial-number}/cableTest/async-operations/{task-id}":{"get":{"description":"Retrieves the status and results of a previously initiated asynchronous CX Switch Cable Test.","operationId":"getCxCableTestResultV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"},{"$ref":"#/components/parameters/AsyncTaskId__03efdde95a47"}],"responses":{"200":{"content":{"application/json":{"examples":{"completed":{"summary":"CX Switch Cable Test completed successfully","value":{"endTime":"2025-05-20T09:32:57.201302340Z","failReason":null,"output":{"ports":["1/1/1"],"results":[{"cablePairDiagnostics":[{"accuracy":"10","length":"0","pairName":"7-8","status":"Good"},{"accuracy":"10","length":"0","pairName":"1-2","status":"Good"},{"accuracy":"10","length":"0","pairName":"3-6","status":"Good"},{"accuracy":"10","length":"0","pairName":"4-5","status":"Good"}],"interfaceName":"1/1/1","state":"complete"}]},"progressPercent":100,"startTime":"2025-05-20T09:32:26.217392470Z","status":"COMPLETED"}},"running":{"summary":"Operation still running","value":{"endTime":null,"output":null,"progressPercent":0,"startTime":"2025-04-09T10:14:08Z","status":"RUNNING"}}},"schema":{"$ref":"#/components/schemas/CableTestCxResult__eca40f050f94"}}},"description":"OK. Returns the status and results of the CX Switch Cable Test."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/TaskNotFound__03efdde95a47"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get CX Switch Cable Test status and results","tags":["CX Switches"],"x-source-document":{"file":"MRT/getcxcabletestresultv1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on CX Switches (The stackId should be used in place of the serial for stack switches)","name":"CX Switches"}]},"pathMetadata":{},"sha256":"636bbac22da29a5a3aa5b0bb18013e0609cb75fb58a4b3918b9fed45b58644e8"}}},"/network-troubleshooting/v1/cx/{serial-number}/http":{"post":{"description":"Starts an asynchronous Http test on the specified CX Switch.","operationId":"initiateCxHttpV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"}],"requestBody":{"content":{"application/json":{"examples":{"full":{"summary":"CX Switch Http request with additional parameters","value":{"destination":"www.google.com","nameServer":"1.1.1.1","protocol":"HTTPS","sourceInterface":"1/1/1","sourcePort":3000,"vrfName":"default"}},"minimal":{"summary":"Minimal CX Switch Http request","value":{"destination":"www.google.com"}}},"schema":{"$ref":"#/components/schemas/HttpCxRequest__87b115ffbfa6"}}},"description":"CX Switch Http command parameters","required":true},"responses":{"202":{"content":{"application/json":{"example":{"location":"/network-troubleshooting/v1/cx/{serial-number}/http/async-operations/{task-id}","startTime":"2025-04-09T10:00:00Z","status":"INITIATED"},"schema":{"$ref":"#/components/schemas/AsyncOperationStatus__02a6567f3633"}}},"description":"Accepted. The operation has been successfully initiated. The response includes the location to track the operation's status."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/DeviceNotFound__02a6567f3633"},"409":{"$ref":"#/components/responses/DeviceOffline__02a6567f3633"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Initiate a Http test on a CX Switch","tags":["CX Switches"],"x-source-document":{"file":"MRT/initiatecxhttpv1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on CX Switches (The stackId should be used in place of the serial for stack switches)","name":"CX Switches"}]},"pathMetadata":{},"sha256":"5d17ba2a185a087061529c595dd9b1cc4992d3741ea6c50914e2d40d21aac291"}}},"/network-troubleshooting/v1/cx/{serial-number}/http/async-operations/{task-id}":{"get":{"description":"Retrieves the status and results of a previously initiated asynchronous CX Switch Http test.","operationId":"getCxHttpResultV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"},{"$ref":"#/components/parameters/AsyncTaskId__03efdde95a47"}],"responses":{"200":{"content":{"application/json":{"examples":{"completed":{"summary":"CX Switch Http completed successfully","value":{"endTime":"2025-05-21T09:03:51.160435814Z","failReason":null,"output":{"destination":"https://switch1.google.com","results":{"averageRttInMilliseconds":0,"dhcpServerIp":null,"dnsError":null,"dnsRttInMilliseconds":0,"httpError":null,"httpTransactionRttInMilliseconds":null,"maximumRttInMilliseconds":0,"minimumRttInMilliseconds":0,"packetsReceived":1,"packetsTransmitted":1,"resolvedIp":null},"statistics":{"bindError":0,"destinationAddressUnreachableCount":0,"dhcpFailed":null,"dhcpNack":null,"dhcpNoOffer":null,"dnsFormatError":null,"dnsNameExists":null,"dnsNonExistentDomain":null,"dnsNotAuthoritative":null,"dnsNotImplemented":null,"dnsNotZone":null,"dnsQueryRefused":null,"dnsResolutionFailures":0,"dnsRrsetExists":null,"dnsServerFailure":null,"probesTimedOut":0,"probesTransmitted":2,"socketReceiveError":0,"transmissionError":0}},"progressPercent":100,"startTime":"2025-05-21T09:03:10.639546402Z","status":"COMPLETED"}},"running":{"summary":"Operation still running","value":{"endTime":null,"output":null,"progressPercent":0,"startTime":"2025-04-09T10:14:08Z","status":"RUNNING"}}},"schema":{"$ref":"#/components/schemas/HttpCxResult__0f46fc6247ab"}}},"description":"OK. Returns the status and results of the CX Switch Http test."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/TaskNotFound__03efdde95a47"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get CX Switch Http test status and results","tags":["CX Switches"],"x-source-document":{"file":"MRT/getcxhttpresultv1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on CX Switches (The stackId should be used in place of the serial for stack switches)","name":"CX Switches"}]},"pathMetadata":{},"sha256":"449e6d921708a34cb28036ee436477ff9c1e8c408586106e52ecc5f5937bcadc"}}},"/network-troubleshooting/v1/cx/{serial-number}/list-tasks":{"get":{"description":"Retrieves a list of all active or recently completed asynchronous operations for the specified CX Switch, grouped by test name. Results are sorted by startTime in descending order (most recently started first).","operationId":"listCxTasksV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskListResponse__3c2901e6fd8d"}}},"description":"OK. Returns the list of active/recent tasks."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/DeviceNotFound__02a6567f3633"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"List active async tasks for a CX Switch","tags":["CX Switches"],"x-source-document":{"file":"MRT/listcxtasksv1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on CX Switches (The stackId should be used in place of the serial for stack switches)","name":"CX Switches"}]},"pathMetadata":{},"sha256":"6bdec44b9cf058b436a59e7be7e2debc9496e227e8d5fe008c6e279261f95787"}}},"/network-troubleshooting/v1/cx/{serial-number}/locate":{"post":{"description":"Initiates a locate (e.g., blinking LED) operation on the specified CX Switch.","operationId":"locateCxSwitchV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"}],"responses":{"202":{"content":{"application/json":{"example":{"startTime":"2025-06-25T08:31:15.380079232Z","status":"INITIATED"},"schema":{"$ref":"#/components/schemas/ActionInitiatedStatus__11d6968be580"}}},"description":"Accepted. The locate action has been successfully initiated."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/DeviceNotFound__02a6567f3633"},"409":{"$ref":"#/components/responses/DeviceConflictLocating__322170916979"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Locate a CX Switch","tags":["CX Switches"],"x-source-document":{"file":"MRT/locatecxswitchv1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on CX Switches (The stackId should be used in place of the serial for stack switches)","name":"CX Switches"}]},"pathMetadata":{},"sha256":"9de5ff7ff7d33590df84663a65c95324840bb8c90f7066409658881c8eed2642"}}},"/network-troubleshooting/v1/cx/{serial-number}/ping":{"post":{"description":"Starts an asynchronous Ping test on the specified CX Switch.","operationId":"initiateCxPingV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"}],"requestBody":{"content":{"application/json":{"examples":{"full":{"summary":"CX Switch Ping request with additional parameters","value":{"count":5,"destination":"www.google.com","includeRawOutput":true,"packetSize":10,"useIpv6":true,"useManagementInterface":true,"vrfName":"blue"}},"minimal":{"summary":"Minimal CX Switch Ping request","value":{"destination":"www.google.com"}}},"schema":{"$ref":"#/components/schemas/PingCxRequest__b6689a53ee20"}}},"description":"CX Switch Ping command parameters","required":true},"responses":{"202":{"content":{"application/json":{"example":{"location":"/network-troubleshooting/v1/cx/{serial-number}/ping/async-operations/{task-id}","startTime":"2025-04-09T10:00:00Z","status":"INITIATED"},"schema":{"$ref":"#/components/schemas/AsyncOperationStatus__02a6567f3633"}}},"description":"Accepted. The operation has been successfully initiated. The response includes the location to track the operation's status."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/DeviceNotFound__02a6567f3633"},"409":{"$ref":"#/components/responses/DeviceOffline__02a6567f3633"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Initiate a Ping test on a CX Switch","tags":["CX Switches"],"x-source-document":{"file":"MRT/initiatecxpingv1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on CX Switches (The stackId should be used in place of the serial for stack switches)","name":"CX Switches"}]},"pathMetadata":{},"sha256":"41d2613f717cd47ad27ce99e9203f15b6bdd0f600ccc4291bbf45879bacfb7c0"}}},"/network-troubleshooting/v1/cx/{serial-number}/ping/async-operations/{task-id}":{"get":{"description":"Retrieves the status and results of a previously initiated asynchronous CX Switch Ping test.","operationId":"getCxPingResultV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"},{"$ref":"#/components/parameters/AsyncTaskId__03efdde95a47"}],"responses":{"200":{"content":{"application/json":{"examples":{"completed":{"summary":"CX Switch Ping completed successfully","value":{"endTime":"2025-05-20T09:38:41.881905174Z","failReason":null,"output":{"averageRoundTripTimeMilliseconds":"0.464","destination":"10.1.1.10","maximumRoundTripTimeMilliseconds":"0.485","minimumRoundTripTimeMilliseconds":"0.447","packetLossPercent":"0","receivedPacketsCount":"5","replies":[{"sentPacketAddress":"10.1.1.10","sentPacketIcmpSequenceNumber":"1","sentPacketSizeBytes":"108","sentPacketTimeMilliseconds":"0.447","sentPacketTimeToLive":"64"},{"sentPacketAddress":"10.1.1.10","sentPacketIcmpSequenceNumber":"2","sentPacketSizeBytes":"108","sentPacketTimeMilliseconds":"0.460","sentPacketTimeToLive":"64"},{"sentPacketAddress":"10.1.1.10","sentPacketIcmpSequenceNumber":"3","sentPacketSizeBytes":"108","sentPacketTimeMilliseconds":"0.478","sentPacketTimeToLive":"64"},{"sentPacketAddress":"10.1.1.10","sentPacketIcmpSequenceNumber":"4","sentPacketSizeBytes":"108","sentPacketTimeMilliseconds":"0.485","sentPacketTimeToLive":"64"},{"sentPacketAddress":"10.1.1.10","sentPacketIcmpSequenceNumber":"5","sentPacketSizeBytes":"108","sentPacketTimeMilliseconds":"0.452","sentPacketTimeToLive":"64"}],"resolvedIp":"10.1.1.10","standardDeviationRoundTripTimeMilliseconds":"0.014","totalRoundTripTimeMilliseconds":"4077","transmittedPacketsCount":"5"},"progressPercent":100,"rawOutput":"PING 10.1.1.10 (10.1.1.10) 100(128) bytes of data.\n108 bytes from 10.1.1.10: icmp_seq=1 ttl=64 time=0.447 ms\n108 bytes from 10.1.1.10: icmp_seq=2 ttl=64 time=0.460 ms\n108 bytes from 10.1.1.10: icmp_seq=3 ttl=64 time=0.478 ms\n108 bytes from 10.1.1.10: icmp_seq=4 ttl=64 time=0.485 ms\n108 bytes from 10.1.1.10: icmp_seq=5 ttl=64 time=0.452 ms\n\n--- 10.1.1.10 ping statistics ---\n5 packets transmitted, 5 received, 0% packet loss, time 4077ms\nrtt min/avg/max/mdev = 0.447/0.464/0.485/0.014 ms\n","startTime":"2025-05-20T09:38:36.390303695Z","status":"COMPLETED"}},"running":{"summary":"Operation still running","value":{"endTime":null,"output":null,"progressPercent":0,"rawOutput":null,"startTime":"2025-04-09T10:14:08Z","status":"RUNNING"}}},"schema":{"$ref":"#/components/schemas/PingCxResult__8e49265a363a"}}},"description":"OK. Returns the status and results of the CX Switch Ping test."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/TaskNotFound__03efdde95a47"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get CX Switch Ping test status and results","tags":["CX Switches"],"x-source-document":{"file":"MRT/getcxpingresultv1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on CX Switches (The stackId should be used in place of the serial for stack switches)","name":"CX Switches"}]},"pathMetadata":{},"sha256":"dedca0ebd066fa57186ac1a3cee7aa15744485710e70c525a3c3c2e5648b2156"}}},"/network-troubleshooting/v1/cx/{serial-number}/poeBounce":{"post":{"description":"Starts an asynchronous Poe Bounce test on the specified CX Switch.","operationId":"initiateCxPoeBounceV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"}],"requestBody":{"content":{"application/json":{"examples":{"minimal":{"summary":"CX Switch Poe Bounce request","value":{"ports":["1/1/1","1/1/2"]}}},"schema":{"$ref":"#/components/schemas/PoeBounceCxRequest__d4399c486239"}}},"description":"CX Switch Poe Bounce command parameters","required":true},"responses":{"202":{"content":{"application/json":{"example":{"location":"/network-troubleshooting/v1/cx/{serial-number}/poeBounce/async-operations/{task-id}","startTime":"2025-04-09T10:00:00Z","status":"INITIATED"},"schema":{"$ref":"#/components/schemas/AsyncOperationStatus__02a6567f3633"}}},"description":"Accepted. The operation has been successfully initiated. The response includes the location to track the operation's status."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/DeviceNotFound__02a6567f3633"},"409":{"$ref":"#/components/responses/DeviceOffline__02a6567f3633"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Initiate a Poe Bounce test on a CX Switch","tags":["CX Switches"],"x-source-document":{"file":"MRT/initiatecxpoebouncev1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on CX Switches (The stackId should be used in place of the serial for stack switches)","name":"CX Switches"}]},"pathMetadata":{},"sha256":"37fb0bcd2a8c37b1ba89d6ee9575ca63680cf9102bcc388f73346845b1796e90"}}},"/network-troubleshooting/v1/cx/{serial-number}/poeBounce/async-operations/{task-id}":{"get":{"description":"Retrieves the status and results of a previously initiated asynchronous CX Switch Poe Bounce test.","operationId":"getCxPoeBounceResultV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"},{"$ref":"#/components/parameters/AsyncTaskId__03efdde95a47"}],"responses":{"200":{"content":{"application/json":{"examples":{"completed":{"summary":"CX Switch Poe Bounce completed successfully","value":{"endTime":"2025-05-20T09:34:15.754612710Z","failReason":null,"output":{"ports":["1/1/1","1/1/2","1/1/3"],"results":[{"port":"1/1/1","status":"Bounced"},{"port":"1/1/2","status":"Bounced"},{"port":"1/1/3","status":"Bounced"}]},"progressPercent":100,"startTime":"2025-05-20T09:34:13.246148554Z","status":"COMPLETED"}},"running":{"summary":"Operation still running","value":{"endTime":null,"output":null,"progressPercent":0,"startTime":"2025-04-09T10:14:08Z","status":"RUNNING"}}},"schema":{"$ref":"#/components/schemas/PoeBounceCxResult__e9e3ce3e7e7a"}}},"description":"OK. Returns the status and results of the CX Switch Poe Bounce test."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/TaskNotFound__03efdde95a47"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get CX Switch Poe Bounce test status and results","tags":["CX Switches"],"x-source-document":{"file":"MRT/getcxpoebounceresultv1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on CX Switches (The stackId should be used in place of the serial for stack switches)","name":"CX Switches"}]},"pathMetadata":{},"sha256":"1a3b5e0439f34f8cb6c2c80990383776767fd9e55a732bbf77a28846c071042e"}}},"/network-troubleshooting/v1/cx/{serial-number}/portBounce":{"post":{"description":"Starts an asynchronous Port Bounce test on the specified CX Switch.","operationId":"initiateCxPortBounceV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"}],"requestBody":{"content":{"application/json":{"examples":{"minimal":{"summary":"CX Switch Port Bounce request","value":{"ports":["1/1/1","1/1/2"]}}},"schema":{"$ref":"#/components/schemas/PortBounceCxRequest__320ac740feba"}}},"description":"CX Switch Port Bounce command parameters","required":true},"responses":{"202":{"content":{"application/json":{"example":{"location":"/network-troubleshooting/v1/cx/{serial-number}/portBounce/async-operations/{task-id}","startTime":"2025-04-09T10:00:00Z","status":"INITIATED"},"schema":{"$ref":"#/components/schemas/AsyncOperationStatus__02a6567f3633"}}},"description":"Accepted. The operation has been successfully initiated. The response includes the location to track the operation's status."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/DeviceNotFound__02a6567f3633"},"409":{"$ref":"#/components/responses/DeviceOffline__02a6567f3633"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Initiate a Port Bounce test on a CX Switch","tags":["CX Switches"],"x-source-document":{"file":"MRT/initiatecxportbouncev1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on CX Switches (The stackId should be used in place of the serial for stack switches)","name":"CX Switches"}]},"pathMetadata":{},"sha256":"e2386858ea5107147afef7d72f71244bb9063e162910e30992ffcf3229021edb"}}},"/network-troubleshooting/v1/cx/{serial-number}/portBounce/async-operations/{task-id}":{"get":{"description":"Retrieves the status and results of a previously initiated asynchronous CX Switch Port Bounce test.","operationId":"getCxPortBounceResultV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"},{"$ref":"#/components/parameters/AsyncTaskId__03efdde95a47"}],"responses":{"200":{"content":{"application/json":{"examples":{"completed":{"summary":"CX Switch Port Bounce completed successfully","value":{"endTime":"2025-05-20T09:35:05.344339885Z","failReason":null,"output":{"ports":["1/1/1","1/1/2","1/1/3"],"results":[{"port":"1/1/1","status":"Bounced"},{"port":"1/1/2","status":"Bounced"},{"port":"1/1/3","status":"Bounced"}]},"progressPercent":100,"startTime":"2025-05-20T09:35:03.080589059Z","status":"COMPLETED"}},"running":{"summary":"Operation still running","value":{"endTime":null,"output":null,"progressPercent":0,"startTime":"2025-04-09T10:14:08Z","status":"RUNNING"}}},"schema":{"$ref":"#/components/schemas/PortBounceCxResult__bb628fb1cc10"}}},"description":"OK. Returns the status and results of the CX Switch Port Bounce test."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/TaskNotFound__03efdde95a47"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get CX Switch Port Bounce test status and results","tags":["CX Switches"],"x-source-document":{"file":"MRT/getcxportbounceresultv1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on CX Switches (The stackId should be used in place of the serial for stack switches)","name":"CX Switches"}]},"pathMetadata":{},"sha256":"a711c27777ff5512ff0ef710ec8b48867ce858bc845b8af95d8e551a232918da"}}},"/network-troubleshooting/v1/cx/{serial-number}/reboot":{"post":{"description":"Initiates a reboot operation on the specified CX Switch.","operationId":"rebootCxSwitchV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"}],"responses":{"202":{"content":{"application/json":{"example":{"startTime":"2025-06-25T08:31:15.380079232Z","status":"INITIATED"},"schema":{"$ref":"#/components/schemas/ActionInitiatedStatus__11d6968be580"}}},"description":"Accepted. The reboot action has been successfully initiated."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/DeviceNotFound__02a6567f3633"},"409":{"$ref":"#/components/responses/DeviceConflictRebooting__78801b30c1be"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Reboot a CX Switch","tags":["CX Switches"],"x-source-document":{"file":"MRT/rebootcxswitchv1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on CX Switches (The stackId should be used in place of the serial for stack switches)","name":"CX Switches"}]},"pathMetadata":{},"sha256":"7f1ae5ea52715c97528ebf447ed3d1533896bada3494bbc0ed2458f07bdc8047"}}},"/network-troubleshooting/v1/cx/{serial-number}/show-commands":{"get":{"description":"Returns the strict list of supported 'show' commands for CX. Only commands that are present in this list would work.","operationId":"listCxShowCommandsV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShowCommandsResponse__3ba348bd5d1e"}}},"description":"OK. Returns the strict, supported list."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/DeviceNotFound__02a6567f3633"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"List 'show' commands (CX - strict supported list)","tags":["CX Switches"],"x-source-document":{"file":"MRT/listcxshowcommandsv1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on CX Switches (The stackId should be used in place of the serial for stack switches)","name":"CX Switches"}]},"pathMetadata":{},"sha256":"e1253a2996a3cce6da28569a7224b5f4a138fe7c0a0759513015cbbc60786190"}}},"/network-troubleshooting/v1/cx/{serial-number}/showCommands":{"post":{"description":"Starts an asynchronous execution of one or more 'show' commands on a CX switch. Rejected with 400 if any command does not start with 'show ', or if more than 20 commands are provided.","operationId":"runCxShowCommandsV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"}],"requestBody":{"content":{"application/json":{"example":{"commands":["show interface brief","show version"]},"schema":{"$ref":"#/components/schemas/ShowCommandRequest__1070839fcc3b"}}},"description":"The list of 'show' commands to run.","required":true},"responses":{"202":{"content":{"application/json":{"example":{"location":"/network-troubleshooting/v1/cx/{serial-number}/showCommands/async-operations/{task-id}","startTime":"2025-08-25T10:00:00Z","status":"INITIATED"},"schema":{"$ref":"#/components/schemas/AsyncOperationStatus__02a6567f3633"}}},"description":"Accepted. Operation initiated; use the returned location to poll status/result."},"400":{"$ref":"#/components/responses/BadRequestShowCommand__1070839fcc3b"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/DeviceNotFound__02a6567f3633"},"409":{"$ref":"#/components/responses/DeviceOffline__02a6567f3633"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Run 'show' commands (CX)","tags":["CX Switches"],"x-source-document":{"file":"MRT/runcxshowcommandsv1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on CX Switches (The stackId should be used in place of the serial for stack switches)","name":"CX Switches"}]},"pathMetadata":{},"sha256":"77926b1586394ce3b91475c09ed62cc0e27f98c21427a169b75655be9e5b96c5"}}},"/network-troubleshooting/v1/cx/{serial-number}/showCommands/async-operations/{task-id}":{"get":{"description":"Polls the async task for the 'show' commands and returns status and raw text output.","operationId":"getCxShowCommandsResultV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"},{"$ref":"#/components/parameters/AsyncTaskId__03efdde95a47"}],"responses":{"200":{"content":{"application/json":{"examples":{"completed":{"summary":"Command finished successfully","value":{"endTime":"2026-02-03T14:21:02.004881090Z","failReason":null,"output":{"commands":["show version"],"results":[{"command":"show version","output":"AOS-CX Version 10.x\n..."}]},"progressPercent":100,"startTime":"2026-02-03T14:20:59.912054756Z","status":"COMPLETED"}}},"schema":{"$ref":"#/components/schemas/ShowCommandResult__8cc1ef82c4a3"}}},"description":"OK."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/TaskNotFound__03efdde95a47"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get 'show' commands status/result (CX)","tags":["CX Switches"],"x-source-document":{"file":"MRT/getcxshowcommandsresultv1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on CX Switches (The stackId should be used in place of the serial for stack switches)","name":"CX Switches"}]},"pathMetadata":{},"sha256":"8cf7add3a6721d3877f00d2c8c5f6d1f52daca235a0d3828d0d85373e7c16e46"}}},"/network-troubleshooting/v1/cx/{serial-number}/traceroute":{"post":{"description":"Starts an asynchronous Traceroute test on the specified CX Switch.","operationId":"initiateCxTracerouteV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"}],"requestBody":{"content":{"application/json":{"examples":{"full":{"summary":"CX Switch Traceroute request with additional parameters","value":{"destination":"www.google.com","includeRawOutput":true,"useIpv6":true,"useManagementInterface":true,"vrfName":"blue"}},"minimal":{"summary":"Minimal CX Switch Traceroute request","value":{"destination":"www.google.com"}}},"schema":{"$ref":"#/components/schemas/TracerouteCxRequest__8c88e69cb498"}}},"description":"CX Switch Traceroute command parameters","required":true},"responses":{"202":{"content":{"application/json":{"example":{"location":"/network-troubleshooting/v1/cx/{serial-number}/traceroute/async-operations/{task-id}","startTime":"2025-04-09T10:00:00Z","status":"INITIATED"},"schema":{"$ref":"#/components/schemas/AsyncOperationStatus__02a6567f3633"}}},"description":"Accepted. The operation has been successfully initiated. The response includes the location to track the operation's status."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/DeviceNotFound__02a6567f3633"},"409":{"$ref":"#/components/responses/DeviceOffline__02a6567f3633"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Initiate a Traceroute test on a CX Switch","tags":["CX Switches"],"x-source-document":{"file":"MRT/initiatecxtraceroutev1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on CX Switches (The stackId should be used in place of the serial for stack switches)","name":"CX Switches"}]},"pathMetadata":{},"sha256":"981ca00490aec63420c9b685b914562df8293886fc9c2aacbf22c38675fe6a5a"}}},"/network-troubleshooting/v1/cx/{serial-number}/traceroute/async-operations/{task-id}":{"get":{"description":"Retrieves the status and results of a previously initiated asynchronous CX Switch Traceroute test.","operationId":"getCxTracerouteResultV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"},{"$ref":"#/components/parameters/AsyncTaskId__03efdde95a47"}],"responses":{"200":{"content":{"application/json":{"examples":{"completed":{"summary":"CX Switch Traceroute completed successfully","value":{"endTime":"2025-05-20T09:40:11.490562492Z","failReason":null,"output":{"destination":"10.1.1.10","hops":[{"hop":"1","probes":[{"ipAddress":"null","responseTimeMilliseconds":"0.529ms","reverseDnsResolution":"10.1.1.10"},{"ipAddress":"null","responseTimeMilliseconds":"0.320ms","reverseDnsResolution":"10.1.1.10"},{"ipAddress":"null","responseTimeMilliseconds":"0.166ms","reverseDnsResolution":"10.1.1.10"}]}],"resolvedIp":"10.1.1.10"},"progressPercent":100,"rawOutput":"traceroute to 10.1.1.10 (10.1.1.10), 1 hops min, 30 hops max, 3 sec. timeout, 3 probes\n  1   10.1.1.10  0.529ms  0.320ms  0.166ms \n","startTime":"2025-05-20T09:40:10.047563489Z","status":"COMPLETED"}},"running":{"summary":"Operation still running","value":{"endTime":null,"output":null,"progressPercent":0,"rawOutput":null,"startTime":"2025-04-09T10:14:08Z","status":"RUNNING"}}},"schema":{"$ref":"#/components/schemas/TracerouteCxResult__8e9868fc7ec0"}}},"description":"OK. Returns the status and results of the CX Switch Traceroute test."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/TaskNotFound__03efdde95a47"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get CX Switch Traceroute test status and results","tags":["CX Switches"],"x-source-document":{"file":"MRT/getcxtracerouteresultv1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on CX Switches (The stackId should be used in place of the serial for stack switches)","name":"CX Switches"}]},"pathMetadata":{},"sha256":"37826701d03a9931be1c3989d1e0526aa99f61ab786bf63895c946c0a9ce4488"}}},"/network-troubleshooting/v1/event-extra-attributes":{"get":{"description":"This API endpoint retrieves extra attributes of the event. The response includes event attributes as key-value pairs.","operationId":"EventExtraAttributesV1","parameters":[{"description":"Unique identifier of the event to retrieve details for.","example":"b451eff1-cff0f-4b1c-8f3d-2a5e6f7d8e9a","in":"query","name":"event-identifier","required":true,"schema":{"maxLength":128,"type":"string"}},{"description":"Site ID to filter the event details for a specific site.","example":"9219985648","in":"query","name":"site-id","required":true,"schema":{"maxLength":128,"type":"string"}},{"description":"Timestamp of when the event occurred, provided in RFC 3339 (and ISO 8601) format in the UTC timezone with milliseconds.","in":"query","name":"time-at","required":true,"schema":{"$ref":"#/components/schemas/DateTime__1335a419f403"}}],"responses":{"200":{"$ref":"#/components/responses/EventDetailsResponse__1335a419f403"},"400":{"$ref":"#/components/responses/BadRequestError__1335a419f403"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/NotFoundError__1335a419f403"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get Event Extra Attributes","tags":["Events"],"x-source-document":{"file":"MRT/eventextraattributesv1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"APIs to manage and retrieve network events","name":"Events"}]},"pathMetadata":{},"sha256":"4e5602182c0a1209ecdea9eafcc6599a9744f908ad9d0a08e27965722c5b3d45"}}},"/network-troubleshooting/v1/event-filters":{"get":{"description":"This endpoint returns available filter options for network events, including categories, source types, and event names with their respective counts. Use this information to construct filters for the List Events API.","operationId":"EventFiltersV1","parameters":[{"description":"Type of context (SITE, ACCESS_POINT, SWITCH, GATEWAY, WIRELESS_CLIENT, WIRED_CLIENT, BRIDGE).","example":"SITE","in":"query","name":"context-type","required":true,"schema":{"enum":["SITE","ACCESS_POINT","SWITCH","GATEWAY","WIRELESS_CLIENT","WIRED_CLIENT","BRIDGE"],"type":"string"}},{"description":"Context Identifier (site ID, device serial number or client MAC address).","example":"9219985648","in":"query","name":"context-identifier","required":true,"schema":{"maxLength":128,"type":"string"}},{"description":"Data is required starting from this timestamp, provided in RFC 3339 (and ISO 8601) format in the UTC timezone with milliseconds. The difference between *end-at* and *start-at* should be less than 30 days.","in":"query","name":"start-at","required":true,"schema":{"$ref":"#/components/schemas/DateTime__1335a419f403"}},{"description":"Data is required up to this timestamp, provided in RFC 3339 (and ISO 8601) format in the UTC timezone with milliseconds. The timestamp must be earlier than the current time and later than the start-at.","in":"query","name":"end-at","required":true,"schema":{"$ref":"#/components/schemas/DateTime__1335a419f403"}},{"description":"Site ID to filter the event details for a specific site.","example":"9219985648","in":"query","name":"site-id","required":true,"schema":{"maxLength":128,"type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/EventFiltersResponse__2c64e622674f"},"400":{"$ref":"#/components/responses/BadRequestError__1335a419f403"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/NotFoundError__1335a419f403"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get Event Filters","tags":["Events"],"x-source-document":{"file":"MRT/eventfiltersv1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"APIs to manage and retrieve network events","name":"Events"}]},"pathMetadata":{},"sha256":"8af594ed02a556f6d08206819888a66d118e43b3591bd025e9997ec23f4a2e74"}}},"/network-troubleshooting/v1/events":{"get":{"description":"This API endpoint retrieves a list of Network Events, based on the query parameters provided. Each Event in the returned list includes details like event name, category, source type, severity, etc. The query parameters allow you to narrow down the results that meet specific criteria, ensuring you receive only the relevant data.","operationId":"EventListV1","parameters":[{"description":"Type of context (SITE, ACCESS_POINT, SWITCH, GATEWAY, WIRELESS_CLIENT, WIRED_CLIENT, BRIDGE).","example":"SITE","in":"query","name":"context-type","required":true,"schema":{"enum":["SITE","ACCESS_POINT","SWITCH","GATEWAY","WIRELESS_CLIENT","WIRED_CLIENT","BRIDGE"],"type":"string"}},{"description":"Context Identifier (site ID, device serial number or client MAC address).","example":"9219985648","in":"query","name":"context-identifier","required":true,"schema":{"maxLength":128,"type":"string"}},{"description":"Data is required starting from this timestamp, provided in RFC 3339 (and ISO 8601) format in the UTC timezone with milliseconds. The difference between *end-at* and *start-at* should be less than 30 days.","in":"query","name":"start-at","required":true,"schema":{"$ref":"#/components/schemas/DateTime__1335a419f403"}},{"description":"Data is required up to this timestamp, provided in RFC 3339 (and ISO 8601) format in the UTC timezone with milliseconds. The timestamp must be earlier than the current time and later than the start-at.","in":"query","name":"end-at","required":true,"schema":{"$ref":"#/components/schemas/DateTime__1335a419f403"}},{"description":"Site ID to filter the event details for a specific site.","example":"9219985648","in":"query","name":"site-id","required":true,"schema":{"maxLength":128,"type":"string"}},{"description":"Search events by name, serial number, host name, client MAC address or device MAC address. Full text search is not supported. Search is restricted to the metadata.","example":"Client 802.1x Radius Timeout","in":"query","name":"search","schema":{"maxLength":256,"type":"string"}},{"description":"OData Version 4.0 filter string (limited functionality). Supports only 'and' conjunction ('or' and 'not' are NOT supported). Supported fields and operators are in the below given table.\n\n| Field | Operators |\n| --------- | -------- |\n| `eventId` | `eq` and `in` |\n| `category` |`eq` and `in` |\n| `sourceType` |`eq` and `in` |\n\n**The operators are implemented as follows:**\n\n* `eq`: Only values exactly matching the given value are returned.\n\n* `in`: Only values present in the given list are returned.\n\n","example":"eventId eq '12' and category in ('Connectivity', 'Client')","in":"query","name":"filter","schema":{"maxLength":512,"type":"string"}},{"description":"Sort expressions. A sort expression is a property name optionally followed by a direction indicator asc (ascending) or desc (descending).\n\nIf a direction indicator is omitted, the default direction is descending.\n\nSupported fields are \n\n| Sort Field                          | Description                          |\n| ----------------------------------- | ------------------------------------ |\n| `timeAt`                              | The field `timeAt` denotes event timestamp. |\n\n","example":"timeAt desc","in":"query","name":"sort","schema":{"maxLength":128,"type":"string"}},{"description":"Specifies the pagination cursor for the next page of resources. Minimum value is 1.","in":"query","name":"next","schema":{"$ref":"#/components/schemas/Next__15b755dc22d8"}},{"description":"Maximum number of events to be retrieved. Allowed range is 1 to 1000.","in":"query","name":"limit","required":true,"schema":{"default":100,"example":100,"format":"int64","maximum":1000,"minimum":1,"type":"integer"}}],"responses":{"200":{"$ref":"#/components/responses/ListEventsResponse__15b755dc22d8"},"400":{"$ref":"#/components/responses/BadRequestError__1335a419f403"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/NotFoundError__1335a419f403"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"List Events","tags":["Events"],"x-source-document":{"file":"MRT/eventlistv1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"APIs to manage and retrieve network events","name":"Events"}]},"pathMetadata":{},"sha256":"2b6c4bd8ed07cb8b02597082591dc91f0c08a56697f8a51ace445c42c732e981"}}},"/network-troubleshooting/v1/gateways/{serial-number}/disconnectClientAll":{"post":{"description":"Initiates a disconnect action for all clients connected to the specified Gateway.","operationId":"disconnectAllClientsGwV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"}],"responses":{"202":{"content":{"application/json":{"example":{"startTime":"2025-07-23T11:00:00Z","status":"INITIATED"},"schema":{"$ref":"#/components/schemas/ActionInitiatedStatus__11d6968be580"}}},"description":"Accepted. The disconnect action has been successfully initiated."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/DeviceNotFound__02a6567f3633"},"409":{"$ref":"#/components/responses/DeviceOffline__02a6567f3633"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Disconnect all clients from a Gateway","tags":["Gateways"],"x-source-document":{"file":"MRT/disconnectallclientsgwv1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on Gateways","name":"Gateways"}]},"pathMetadata":{},"sha256":"df12f7e7a3def9741dfab543c21ab0248f7800059fe7b30fb31c24b57edaa209"}}},"/network-troubleshooting/v1/gateways/{serial-number}/disconnectClientByMacAddress":{"post":{"description":"Initiates a disconnect action for a specific client connected to the specified Gateway, identified by its MAC address.","operationId":"disconnectClientByMacGwV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"}],"requestBody":{"content":{"application/json":{"example":{"clientMacAddress":"11:22:33:44:55:66"},"schema":{"$ref":"#/components/schemas/DisconnectClientByMacGwRequest__444ca2202914"}}},"description":"Client MAC address to disconnect","required":true},"responses":{"202":{"content":{"application/json":{"example":{"startTime":"2025-07-23T11:05:00Z","status":"INITIATED"},"schema":{"$ref":"#/components/schemas/ActionInitiatedStatus__11d6968be580"}}},"description":"Accepted. The disconnect action has been successfully initiated."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/DeviceNotFound__02a6567f3633"},"409":{"$ref":"#/components/responses/DeviceOffline__02a6567f3633"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Disconnect a specific client by MAC address from a Gateway","tags":["Gateways"],"x-source-document":{"file":"MRT/disconnectclientbymacgwv1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on Gateways","name":"Gateways"}]},"pathMetadata":{},"sha256":"edaac813e20901b54169ff88d5315ac0135fc842bc8c6067a0c0a2596e012345"}}},"/network-troubleshooting/v1/gateways/{serial-number}/getArpTable":{"post":{"description":"Starts an asynchronous Get Arp Table test on the specified Gateway.","operationId":"initiateGwGetArpTableV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"}],"responses":{"202":{"content":{"application/json":{"example":{"location":"/network-troubleshooting/v1/gateways/{serial-number}/getArpTable/async-operations/{task-id}","startTime":"2025-04-09T10:00:00Z","status":"INITIATED"},"schema":{"$ref":"#/components/schemas/AsyncOperationStatus__02a6567f3633"}}},"description":"Accepted. The operation has been successfully initiated. The response includes the location to track the operation's status."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/DeviceNotFound__02a6567f3633"},"409":{"$ref":"#/components/responses/DeviceOffline__02a6567f3633"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Initiate a Get Arp Table test on a Gateway","tags":["Gateways"],"x-source-document":{"file":"MRT/initiategwgetarptablev1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on Gateways","name":"Gateways"}]},"pathMetadata":{},"sha256":"054f3b788ba2f7d12b7599ba48c93e138af8cb811ce3b498d459148c483b07f9"}}},"/network-troubleshooting/v1/gateways/{serial-number}/getArpTable/async-operations/{task-id}":{"get":{"description":"Retrieves the status and results of a previously initiated asynchronous Gateway Get Arp Table test.","operationId":"getGwGetArpTableResultV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"},{"$ref":"#/components/parameters/AsyncTaskId__03efdde95a47"}],"responses":{"200":{"content":{"application/json":{"examples":{"completed":{"summary":"Gateway Get Arp Table completed successfully","value":{"endTime":"2025-05-20T14:07:59.805075582Z","failReason":null,"output":{"entries":[{"address":"10.27.119.173","interfaceAndPort":"docker_gwbridge","macAddress":"02:42:a9:fe:80:04","protocol":"Internet"},{"address":"10.27.119.177","interfaceAndPort":"vlan4094","macAddress":"94:f1:28:0c:77:00","protocol":"Internet"}]},"progressPercent":100,"rawOutput":"\nARP Table\n---------\nProtocol  Address        Hardware Address   Interface\n--------  -------        ----------------   ---------\nInternet  ridge          02:42:a9:fe:80:04  docker_gwbridge\n\nInternet  10.27.119.177  94:f1:28:0c:77:00  vlan4094\n\n","startTime":"2025-05-20T14:07:59.506787035Z","status":"COMPLETED"}},"running":{"summary":"Operation still running","value":{"endTime":null,"output":null,"progressPercent":0,"rawOutput":null,"startTime":"2025-04-09T10:14:08Z","status":"RUNNING"}}},"schema":{"$ref":"#/components/schemas/GetArpTableMcResult__53834e96d6c4"}}},"description":"OK. Returns the status and results of the Gateway Get Arp Table test."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/TaskNotFound__03efdde95a47"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get Gateway Get Arp Table test status and results","tags":["Gateways"],"x-source-document":{"file":"MRT/getgwgetarptableresultv1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on Gateways","name":"Gateways"}]},"pathMetadata":{},"sha256":"12bdf373207dd9718c99226446ab517c7da18225cb2d52ceb17362ef089a8fe8"}}},"/network-troubleshooting/v1/gateways/{serial-number}/halt":{"post":{"description":"Initiates a halt (shutdown) operation on the specified Gateway.","operationId":"haltGatewayV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"}],"responses":{"202":{"content":{"application/json":{"example":{"startTime":"2025-07-23T11:10:00Z","status":"INITIATED"},"schema":{"$ref":"#/components/schemas/ActionInitiatedStatus__11d6968be580"}}},"description":"Accepted. The halt action has been successfully initiated."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/DeviceNotFound__02a6567f3633"},"409":{"$ref":"#/components/responses/DeviceOffline__02a6567f3633"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Halt a Gateway","tags":["Gateways"],"x-source-document":{"file":"MRT/haltgatewayv1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on Gateways","name":"Gateways"}]},"pathMetadata":{},"sha256":"e45f2ea3f37201b4701fffb7a23a94924754d714c09991ade931279b5d9d2b21"}}},"/network-troubleshooting/v1/gateways/{serial-number}/http":{"post":{"description":"Starts an asynchronous Http test on the specified Gateway.","operationId":"initiateGwHttpV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"}],"requestBody":{"content":{"application/json":{"examples":{"full":{"summary":"Gateway Http request with additional parameters","value":{"count":5,"includeRawOutput":true,"interval":5,"url":"www.google.com"}},"minimal":{"summary":"Minimal Gateway Http request","value":{"url":"www.google.com"}}},"schema":{"$ref":"#/components/schemas/HttpMcRequest__dbe206175393"}}},"description":"Gateway Http command parameters","required":true},"responses":{"202":{"content":{"application/json":{"example":{"location":"/network-troubleshooting/v1/gateways/{serial-number}/http/async-operations/{task-id}","startTime":"2025-04-09T10:00:00Z","status":"INITIATED"},"schema":{"$ref":"#/components/schemas/AsyncOperationStatus__02a6567f3633"}}},"description":"Accepted. The operation has been successfully initiated. The response includes the location to track the operation's status."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/DeviceNotFound__02a6567f3633"},"409":{"$ref":"#/components/responses/DeviceOffline__02a6567f3633"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Initiate a Http test on a Gateway","tags":["Gateways"],"x-source-document":{"file":"MRT/initiategwhttpv1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on Gateways","name":"Gateways"}]},"pathMetadata":{},"sha256":"b2120f219c214a6d8ff12ee3273469c13255d49e851730a246d4bd0a321a7639"}}},"/network-troubleshooting/v1/gateways/{serial-number}/http/async-operations/{task-id}":{"get":{"description":"Retrieves the status and results of a previously initiated asynchronous Gateway Http test.","operationId":"getGwHttpResultV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"},{"$ref":"#/components/parameters/AsyncTaskId__03efdde95a47"}],"responses":{"200":{"content":{"application/json":{"examples":{"completed":{"summary":"Gateway Http completed successfully","value":{"endTime":"2025-05-20T14:06:31.154766496Z","failReason":null,"output":{"averageLatencyMilliseconds":"407","maximumLatencyMilliseconds":"654","minimumLatencyMilliseconds":"331","receivedPacketsCount":"5","responses":[{"downloadRate":"57.52KB/sec","responseBytes":"19556","responseCode":"200/OK","responseNumber":"1","responseTimeMilliseconds":"340"},{"downloadRate":"29.85KB/sec","responseBytes":"19521","responseCode":"200/OK","responseNumber":"2","responseTimeMilliseconds":"654"},{"downloadRate":"57.57KB/sec","responseBytes":"20035","responseCode":"200/OK","responseNumber":"3","responseTimeMilliseconds":"349"},{"downloadRate":"54.06KB/sec","responseBytes":"19568","responseCode":"200/OK","responseNumber":"4","responseTimeMilliseconds":"362"},{"downloadRate":"59.16KB/sec","responseBytes":"19583","responseCode":"200/OK","responseNumber":"5","responseTimeMilliseconds":"331"}],"sentPacketsCount":"5","successRatePercent":"100","url":"www.google.com"},"progressPercent":100,"rawOutput":"\nPinging 'www.google.com'\n\nPress 'q' to abort.\r\n1> Reply: [200/OK] bytes=19556 time=340ms Rate=57.52KB/sec\n2> Reply: [200/OK] bytes=19521 time=654ms Rate=29.85KB/sec\n3> Reply: [200/OK] bytes=20035 time=349ms Rate=57.57KB/sec\n4> Reply: [200/OK] bytes=19568 time=362ms Rate=54.06KB/sec\n5> Reply: [200/OK] bytes=19583 time=331ms Rate=59.16KB/sec\n\nPing Statistics for www.google.com\nPackets: Sent : 5 Received : 5 Success Rate is 100 percent (5/5)\nApproximate round trip time : max/avg/min = 654/407/331 ms\n","startTime":"2025-05-20T14:06:28.690974183Z","status":"COMPLETED"}},"running":{"summary":"Operation still running","value":{"endTime":null,"output":null,"progressPercent":0,"rawOutput":null,"startTime":"2025-04-09T10:14:08Z","status":"RUNNING"}}},"schema":{"$ref":"#/components/schemas/HttpMcResult__fd2addb716a2"}}},"description":"OK. Returns the status and results of the Gateway Http test."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/TaskNotFound__03efdde95a47"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get Gateway Http test status and results","tags":["Gateways"],"x-source-document":{"file":"MRT/getgwhttpresultv1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on Gateways","name":"Gateways"}]},"pathMetadata":{},"sha256":"27833a0114f4f1478fa83f98ea4cc48cd8a9502d327a618edb20ba2a9188fd95"}}},"/network-troubleshooting/v1/gateways/{serial-number}/https":{"post":{"description":"Starts an asynchronous Https test on the specified Gateway.","operationId":"initiateGwHttpsV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"}],"requestBody":{"content":{"application/json":{"examples":{"full":{"summary":"Gateway Https request with additional parameters","value":{"count":5,"includeRawOutput":true,"interval":5,"url":"www.google.com"}},"minimal":{"summary":"Minimal Gateway Https request","value":{"url":"www.google.com"}}},"schema":{"$ref":"#/components/schemas/HttpsMcRequest__1abcb48aae72"}}},"description":"Gateway Https command parameters","required":true},"responses":{"202":{"content":{"application/json":{"example":{"location":"/network-troubleshooting/v1/gateways/{serial-number}/https/async-operations/{task-id}","startTime":"2025-04-09T10:00:00Z","status":"INITIATED"},"schema":{"$ref":"#/components/schemas/AsyncOperationStatus__02a6567f3633"}}},"description":"Accepted. The operation has been successfully initiated. The response includes the location to track the operation's status."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/DeviceNotFound__02a6567f3633"},"409":{"$ref":"#/components/responses/DeviceOffline__02a6567f3633"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Initiate a Https test on a Gateway","tags":["Gateways"],"x-source-document":{"file":"MRT/initiategwhttpsv1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on Gateways","name":"Gateways"}]},"pathMetadata":{},"sha256":"3580c84b7137576cfd8915cbda2cc8b0d5c9ebe6d02c9370a8a0218c9504db35"}}},"/network-troubleshooting/v1/gateways/{serial-number}/https/async-operations/{task-id}":{"get":{"description":"Retrieves the status and results of a previously initiated asynchronous Gateway Https test.","operationId":"getGwHttpsResultV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"},{"$ref":"#/components/parameters/AsyncTaskId__03efdde95a47"}],"responses":{"200":{"content":{"application/json":{"examples":{"completed":{"summary":"Gateway Https completed successfully","value":{"endTime":"2025-05-20T14:06:31.154766496Z","failReason":null,"output":{"averageLatencyMilliseconds":"407","maximumLatencyMilliseconds":"654","minimumLatencyMilliseconds":"331","receivedPacketsCount":"5","responses":[{"downloadRate":"57.52KB/sec","responseBytes":"19556","responseCode":"200/OK","responseNumber":"1","responseTimeMilliseconds":"340"},{"downloadRate":"29.85KB/sec","responseBytes":"19521","responseCode":"200/OK","responseNumber":"2","responseTimeMilliseconds":"654"},{"downloadRate":"57.57KB/sec","responseBytes":"20035","responseCode":"200/OK","responseNumber":"3","responseTimeMilliseconds":"349"},{"downloadRate":"54.06KB/sec","responseBytes":"19568","responseCode":"200/OK","responseNumber":"4","responseTimeMilliseconds":"362"},{"downloadRate":"59.16KB/sec","responseBytes":"19583","responseCode":"200/OK","responseNumber":"5","responseTimeMilliseconds":"331"}],"sentPacketsCount":"5","successRatePercent":"100","url":"www.google.com"},"progressPercent":100,"rawOutput":"\nPinging 'www.google.com'\n\nPress 'q' to abort.\r\n1> Reply: [200/OK] bytes=19556 time=340ms Rate=57.52KB/sec\n2> Reply: [200/OK] bytes=19521 time=654ms Rate=29.85KB/sec\n3> Reply: [200/OK] bytes=20035 time=349ms Rate=57.57KB/sec\n4> Reply: [200/OK] bytes=19568 time=362ms Rate=54.06KB/sec\n5> Reply: [200/OK] bytes=19583 time=331ms Rate=59.16KB/sec\n\nPing Statistics for www.google.com\nPackets: Sent : 5 Received : 5 Success Rate is 100 percent (5/5)\nApproximate round trip time : max/avg/min = 654/407/331 ms\n","startTime":"2025-05-20T14:06:28.690974183Z","status":"COMPLETED"}},"running":{"summary":"Operation still running","value":{"endTime":null,"output":null,"progressPercent":0,"rawOutput":null,"startTime":"2025-04-09T10:14:08Z","status":"RUNNING"}}},"schema":{"$ref":"#/components/schemas/HttpsMcResult__98f2735f9f4e"}}},"description":"OK. Returns the status and results of the Gateway Https test."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/TaskNotFound__03efdde95a47"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get Gateway Https test status and results","tags":["Gateways"],"x-source-document":{"file":"MRT/getgwhttpsresultv1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on Gateways","name":"Gateways"}]},"pathMetadata":{},"sha256":"dde9774cc4e411fd437ea29ce8141c42c83296d9a54d4ded3d9163effc90bee7"}}},"/network-troubleshooting/v1/gateways/{serial-number}/iperf":{"post":{"description":"Starts an asynchronous Iperf test on the specified Gateway.","operationId":"initiateGwIperfV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"}],"requestBody":{"content":{"application/json":{"examples":{"full":{"summary":"Gateway Iperf request with additional parameters","value":{"duration":20,"includeRawOutput":true,"includeReverse":true,"iperfServerAddress":"82.1.39.23","omit":10,"parallel":10,"port":5050,"protocol":"tcp","vlanInterface":"152"}},"minimal":{"summary":"Minimal Gateway Iperf request","value":{"iperfServerAddress":"82.1.39.23"}}},"schema":{"$ref":"#/components/schemas/IperfMcRequest__02a6567f3633"}}},"description":"Gateway Iperf command parameters","required":true},"responses":{"202":{"content":{"application/json":{"example":{"location":"/network-troubleshooting/v1/gateways/{serial-number}/iperf/async-operations/{task-id}","startTime":"2025-04-09T10:00:00Z","status":"INITIATED"},"schema":{"$ref":"#/components/schemas/AsyncOperationStatus__02a6567f3633"}}},"description":"Accepted. The operation has been successfully initiated. The response includes the location to track the operation's status."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/DeviceNotFound__02a6567f3633"},"409":{"$ref":"#/components/responses/DeviceOffline__02a6567f3633"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Initiate a Iperf test on a Gateway","tags":["Gateways"],"x-source-document":{"file":"MRT/initiategwiperfv1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on Gateways","name":"Gateways"}]},"pathMetadata":{},"sha256":"1787529b86efcaf7a78ef715fa4302c4cfd298d72a0a63633ab90aa2fb03fd17"}}},"/network-troubleshooting/v1/gateways/{serial-number}/iperf/async-operations/{task-id}":{"get":{"description":"Retrieves the status and results of a previously initiated asynchronous Gateway Iperf test.","operationId":"getGwIperfResultV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"},{"$ref":"#/components/parameters/AsyncTaskId__03efdde95a47"}],"responses":{"200":{"content":{"application/json":{"examples":{"completed":{"summary":"Gateway Iperf completed successfully","value":{"endTime":"2025-05-20T14:03:27.301496079Z","failReason":null,"output":{"iperfServerAddress":"84.17.57.129","metrics":[{"bandwidthInbps":"53.9 Mbits/sec","id":"[  4]","intervalInSeconds":"0.00-1.00","transferSizeInBytes":"6.42 MBytes"},{"bandwidthInbps":"0.00 bits/sec","id":"[  4]","intervalInSeconds":"1.00-2.00","transferSizeInBytes":"0.00 Bytes"},{"bandwidthInbps":"0.00 bits/sec","id":"[  4]","intervalInSeconds":"2.00-3.00","transferSizeInBytes":"0.00 Bytes"},{"bandwidthInbps":"0.00 bits/sec","id":"[  4]","intervalInSeconds":"3.00-4.00","transferSizeInBytes":"0.00 Bytes"},{"bandwidthInbps":"21.0 Mbits/sec","id":"[  4]","intervalInSeconds":"4.00-5.00","transferSizeInBytes":"2.50 MBytes"},{"bandwidthInbps":"0.00 bits/sec","id":"[  4]","intervalInSeconds":"5.00-6.00","transferSizeInBytes":"0.00 Bytes"},{"bandwidthInbps":"0.00 bits/sec","id":"[  4]","intervalInSeconds":"6.00-7.00","transferSizeInBytes":"0.00 Bytes"},{"bandwidthInbps":"0.00 bits/sec","id":"[  4]","intervalInSeconds":"7.00-8.00","transferSizeInBytes":"0.00 Bytes"},{"bandwidthInbps":"0.00 bits/sec","id":"[  4]","intervalInSeconds":"8.00-9.00","transferSizeInBytes":"0.00 Bytes"},{"bandwidthInbps":"21.0 Mbits/sec","id":"[  4]","intervalInSeconds":"9.00-10.00","transferSizeInBytes":"2.50 MBytes"}],"receiverBandwidth":"7.67 Mbits/sec","senderBandwidth":"9.58 Mbits/sec","totalTransferredBytesFromReceiver":"9.14 MBytes","totalTransferredBytesFromSender":"11.4 MBytes"},"progressPercent":100,"rawOutput":"\nPerf-test: Finished\n\nMay 20 07:02:29 2025\niperf 3.0.11\nLinux Aruba9004-LTE_E3_E9_30 5.10.209 #92514 SMP PREEMPT Tue Apr 22 14:41:40 PDT 2025 x86_64 GNU/Linux\nTime: Tue, 20 May 2025 14:02:30 GMT\nConnecting to host 84.17.57.129, port 5201\n      Cookie: Aruba9004-LTE_E3_E9_30.1747749749.92\n      TCP MSS: 1448 (default)\n[  4] local 10.27.119.178 port 55312 connected to 84.17.57.129 port 5201\nStarting Test: protocol: TCP, 1 streams, 131072 byte blocks, omitting 0 seconds, 10 second test\n[ ID] Interval           Transfer     Bandwidth       Retr  Cwnd\n[  4]   0.00-1.00   sec  6.42 MBytes  53.9 Mbits/sec    3    618 KBytes       \n[  4]   1.00-2.00   sec  0.00 Bytes  0.00 bits/sec   15    618 KBytes       \n[  4]   2.00-3.00   sec  0.00 Bytes  0.00 bits/sec   15    618 KBytes       \n[  4]   3.00-4.00   sec  0.00 Bytes  0.00 bits/sec   15    618 KBytes       \n[  4]   4.00-5.00   sec  2.50 MBytes  21.0 Mbits/sec   10    339 KBytes       \n[  4]   5.00-6.00   sec  0.00 Bytes  0.00 bits/sec   15    339 KBytes       \n[  4]   6.00-7.00   sec  0.00 Bytes  0.00 bits/sec   15    339 KBytes       \n[  4]   7.00-8.00   sec  0.00 Bytes  0.00 bits/sec   16   5.66 KBytes       \n[  4]   8.00-9.00   sec  0.00 Bytes  0.00 bits/sec   92   14.1 KBytes       \n[  4]   9.00-10.00  sec  2.50 MBytes  21.0 Mbits/sec   43    682 KBytes       \n- - - - - - - - - - - - - - - - - - - - - - - - -\nTest Complete. Summary Results:\n[ ID] Interval           Transfer     Bandwidth       Retr\n[  4]   0.00-10.00  sec  11.4 MBytes  9.58 Mbits/sec  239             sender\n[  4]   0.00-10.00  sec  9.14 MBytes  7.67 Mbits/sec                  receiver\nCPU Utilization: local/sender 1.2% (0.1%u/1.1%s), remote/receiver 0.0% (0.0%u/0.0%s)\n\niperf Done.\n","startTime":"2025-05-20T14:02:29.753198552Z","status":"COMPLETED"}},"running":{"summary":"Operation still running","value":{"endTime":null,"output":null,"progressPercent":0,"rawOutput":null,"startTime":"2025-04-09T10:14:08Z","status":"RUNNING"}}},"schema":{"$ref":"#/components/schemas/IperfMcResult__768b748deb18"}}},"description":"OK. Returns the status and results of the Gateway Iperf test."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/TaskNotFound__03efdde95a47"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get Gateway Iperf test status and results","tags":["Gateways"],"x-source-document":{"file":"MRT/getgwiperfresultv1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on Gateways","name":"Gateways"}]},"pathMetadata":{},"sha256":"8fbcc2b6598309d0dc600ba7594f86b539014d8423b8174b8a3174dd2c99dce0"}}},"/network-troubleshooting/v1/gateways/{serial-number}/list-tasks":{"get":{"description":"Retrieves a list of all active or recently completed asynchronous operations for the specified Gateway, grouped by test name. Results are sorted by startTime in descending order (most recently started first).","operationId":"listGwTasksV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskListResponse__3c2901e6fd8d"}}},"description":"OK. Returns the list of active/recent tasks."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/DeviceNotFound__02a6567f3633"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"List active async tasks for a Gateway","tags":["Gateways"],"x-source-document":{"file":"MRT/listgwtasksv1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on Gateways","name":"Gateways"}]},"pathMetadata":{},"sha256":"5fa98418af14f99a51b95c495828057dae5cd073fbf38c9d667d040adc25ebb9"}}},"/network-troubleshooting/v1/gateways/{serial-number}/ping":{"post":{"description":"Starts an asynchronous Ping test on the specified Gateway.","operationId":"initiateGwPingV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"}],"requestBody":{"content":{"application/json":{"examples":{"full":{"summary":"Gateway Ping request with additional parameters","value":{"count":50,"destination":"www.google.com","dontFragmentFlag":false,"dscp":30,"includeRawOutput":true,"packetSize":10,"sourceInterface":"vlan-interface","ttl":100,"useIpv6":true,"vlan":152}},"minimal":{"summary":"Minimal Gateway Ping request","value":{"destination":"www.google.com"}}},"schema":{"$ref":"#/components/schemas/PingMcRequest__fe5c44d623cd"}}},"description":"Gateway Ping command parameters","required":true},"responses":{"202":{"content":{"application/json":{"example":{"location":"/network-troubleshooting/v1/gateways/{serial-number}/ping/async-operations/{task-id}","startTime":"2025-04-09T10:00:00Z","status":"INITIATED"},"schema":{"$ref":"#/components/schemas/AsyncOperationStatus__02a6567f3633"}}},"description":"Accepted. The operation has been successfully initiated. The response includes the location to track the operation's status."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/DeviceNotFound__02a6567f3633"},"409":{"$ref":"#/components/responses/DeviceOffline__02a6567f3633"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Initiate a Ping test on a Gateway","tags":["Gateways"],"x-source-document":{"file":"MRT/initiategwpingv1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on Gateways","name":"Gateways"}]},"pathMetadata":{},"sha256":"fd631f2fe98abad5f045d86c71ae615d1d900b4d5b9a981b34d6149837587a1e"}}},"/network-troubleshooting/v1/gateways/{serial-number}/ping/async-operations/{task-id}":{"get":{"description":"Retrieves the status and results of a previously initiated asynchronous Gateway Ping test.","operationId":"getGwPingResultV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"},{"$ref":"#/components/parameters/AsyncTaskId__03efdde95a47"}],"responses":{"200":{"content":{"application/json":{"examples":{"completed":{"summary":"Gateway Ping completed successfully","value":{"endTime":"2025-05-20T13:35:00.211569256Z","failReason":null,"output":{"averageLatencyMilliseconds":"207.567","destination":"142.251.214.132","maximumLatencyMilliseconds":"211.744","minimumLatencyMilliseconds":"200.873","packetSizeBytes":"92","receivedPacketsCount":"5","sentPacketsCount":"5","successRatePercent":"100","timeoutSeconds":"2"},"progressPercent":100,"rawOutput":"\r\n! - Success  . - Failure  D - Duplicate Response\r\n\rPress 'q' to abort.\r\nSending 5, 92-byte ICMP Echos to 142.251.214.132, timeout is 2 seconds:\r\n!!!!!\r\nSuccess rate is 100 percent (5/5), round-trip min/avg/max = 200.873/207.567/211.744 ms\n\r\n","startTime":"2025-05-20T13:34:57.099357263Z","status":"COMPLETED"}},"running":{"summary":"Operation still running","value":{"endTime":null,"output":null,"progressPercent":0,"rawOutput":null,"startTime":"2025-04-09T10:14:08Z","status":"RUNNING"}}},"schema":{"$ref":"#/components/schemas/PingMcResult__f7a0d49cd9fa"}}},"description":"OK. Returns the status and results of the Gateway Ping test."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/TaskNotFound__03efdde95a47"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get Gateway Ping test status and results","tags":["Gateways"],"x-source-document":{"file":"MRT/getgwpingresultv1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on Gateways","name":"Gateways"}]},"pathMetadata":{},"sha256":"34da2faa24b2d1b23c9decfcecdd5215d67d67b5f7f3fff88a788fdb6858fca0"}}},"/network-troubleshooting/v1/gateways/{serial-number}/pingSweep":{"post":{"description":"Starts an asynchronous PingSweep on a Gateway. PingSweep expects 'startPacketSize', 'endPacketSize', 'count' and 'sweepInterval' to ping with various sizes.","operationId":"runGatewayPingSweepV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"}],"requestBody":{"content":{"application/json":{"example":{"count":2,"destination":"1.1.1.1","endPacketSize":50,"startPacketSize":10,"sweepInterval":10},"schema":{"$ref":"#/components/schemas/GatewayPingSweepRequest__3fdecb5eb736"}}},"description":"PingSweep request.","required":true},"responses":{"202":{"content":{"application/json":{"example":{"location":"/network-troubleshooting/v1/gateways/{serial-number}/pingSweep/async-operations/{task-id}","startTime":"2025-09-18T10:00:00Z","status":"INITIATED"},"schema":{"$ref":"#/components/schemas/AsyncOperationStatus__02a6567f3633"}}},"description":"Accepted. Operation initiated; poll the provided location for status/result."},"400":{"content":{"application/json":{"examples":{"forbiddenPacketSize":{"summary":"Total packets invalid","value":{"errorCode":"HPE_GL_ERROR_BAD_REQUEST","message":"The total number of ICMP requests should be between 1 to 100"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse__02a6567f3633"}}},"description":"Bad Request","headers":{"X-RateLimit-Limit":{"description":"Request limit per hour.","schema":{"format":"int64","maximum":9223372036854776000,"minimum":0,"type":"integer"}},"X-RateLimit-Remaining":{"description":"The number of requests left for the time window.","schema":{"format":"int64","maximum":9223372036854776000,"minimum":0,"type":"integer"}},"X-RateLimit-Reset":{"description":"The date-time (RFC 3339 timestamp in UTC+0) at which the current rate limit window resets.","schema":{"format":"date-time","maxLength":20,"type":"string"}}}},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/DeviceNotFound__02a6567f3633"},"409":{"$ref":"#/components/responses/DeviceOffline__02a6567f3633"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Run PingSweep (Gateway)","tags":["Gateways"],"x-source-document":{"file":"MRT/rungatewaypingsweepv1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on Gateways","name":"Gateways"}]},"pathMetadata":{},"sha256":"950006e14abfb7a066c2592ebe427830a1cf5083caf940d8f9ac73a15dd1390b"}}},"/network-troubleshooting/v1/gateways/{serial-number}/pingSweep/async-operations/{task-id}":{"get":{"description":"Polls the asynchronous PingSweep task and returns its status and raw results.","operationId":"getGatewayPingSweepResultV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"},{"$ref":"#/components/parameters/AsyncTaskId__03efdde95a47"}],"responses":{"200":{"content":{"application/json":{"examples":{"completed":{"summary":"Completed","value":{"endTime":"2025-09-18T10:00:05Z","failReason":null,"output":{"averageRoundTripTimeMilliseconds":"110.767","destination":"1.1.1.1","maximumRoundTripTimeMilliseconds":"110.88","minimumRoundTripTimeMilliseconds":"110.597","receivedPacketsCount":"10","responses":[{"count":"1","replies":[{"requestId":"1","size":"10","timedOut":false},{"requestId":"2","size":"20","timedOut":false},{"requestId":"3","size":"30","timedOut":false},{"requestId":"4","size":"40","timedOut":false},{"requestId":"5","size":"50","timedOut":false}]},{"count":"2","replies":[{"requestId":"6","size":"10","timedOut":false},{"requestId":"7","size":"20","timedOut":false},{"requestId":"8","size":"30","timedOut":false},{"requestId":"9","size":"40","timedOut":false},{"requestId":"10","size":"50","timedOut":false}]}],"successRate":"100","transmittedPacketsCount":"10"},"progressPercent":100,"startTime":"2025-09-18T10:00:01Z","status":"COMPLETED"}},"running":{"summary":"Still running","value":{"endTime":null,"failReason":null,"output":null,"progressPercent":40,"startTime":"2025-09-18T10:00:01Z","status":"RUNNING"}}},"schema":{"$ref":"#/components/schemas/GatewayPingSweepResult__8aa6df07e528"}}},"description":"OK. Returns current status and, when completed, the full PingSweep output."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/TaskNotFound__03efdde95a47"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get PingSweep status/result (Gateway)","tags":["Gateways"],"x-source-document":{"file":"MRT/getgatewaypingsweepresultv1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on Gateways","name":"Gateways"}]},"pathMetadata":{},"sha256":"4a37130979f90ab34fcb0bee205eefaff4264d6a49c9fac6ed01099d08cc11bf"}}},"/network-troubleshooting/v1/gateways/{serial-number}/poeBounce":{"post":{"description":"Starts an asynchronous Poe Bounce test on the specified Gateway.","operationId":"initiateGwPoeBounceV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"}],"requestBody":{"content":{"application/json":{"examples":{"minimal":{"summary":"Gateway Poe Bounce request","value":{"ports":["GE 0/0/0","GE 0/0/1"]}}},"schema":{"$ref":"#/components/schemas/PoeBounceMcRequest__a8fc1c0cd247"}}},"description":"Gateway Poe Bounce command parameters","required":true},"responses":{"202":{"content":{"application/json":{"example":{"location":"/network-troubleshooting/v1/gateways/{serial-number}/poeBounce/async-operations/{task-id}","startTime":"2025-04-09T10:00:00Z","status":"INITIATED"},"schema":{"$ref":"#/components/schemas/AsyncOperationStatus__02a6567f3633"}}},"description":"Accepted. The operation has been successfully initiated. The response includes the location to track the operation's status."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/DeviceNotFound__02a6567f3633"},"409":{"$ref":"#/components/responses/DeviceOffline__02a6567f3633"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Initiate a Poe Bounce test on a Gateway","tags":["Gateways"],"x-source-document":{"file":"MRT/initiategwpoebouncev1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on Gateways","name":"Gateways"}]},"pathMetadata":{},"sha256":"9f31931be325529b93685f065f446c17fa44e3c72f80853cffa7a735eb25c96d"}}},"/network-troubleshooting/v1/gateways/{serial-number}/poeBounce/async-operations/{task-id}":{"get":{"description":"Retrieves the status and results of a previously initiated asynchronous Gateway Poe Bounce test.","operationId":"getGwPoeBounceResultV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"},{"$ref":"#/components/parameters/AsyncTaskId__03efdde95a47"}],"responses":{"200":{"content":{"application/json":{"examples":{"completed":{"summary":"Gateway Poe Bounce completed successfully","value":{"endTime":"2025-05-20T13:42:41.923609070Z","failReason":null,"output":{"ports":["GE 0/0/0","GE 0/0/1"],"results":[{"port":"0/0/0","status":"Bounced"},{"port":"0/0/1","status":"Bounced"}]},"progressPercent":100,"startTime":"2025-05-20T13:40:15.774840498Z","status":"COMPLETED"}},"running":{"summary":"Operation still running","value":{"endTime":null,"output":null,"progressPercent":0,"startTime":"2025-04-09T10:14:08Z","status":"RUNNING"}}},"schema":{"$ref":"#/components/schemas/PoeBounceMcResult__bc60235bc5bf"}}},"description":"OK. Returns the status and results of the Gateway Poe Bounce test."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/TaskNotFound__03efdde95a47"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get Gateway Poe Bounce test status and results","tags":["Gateways"],"x-source-document":{"file":"MRT/getgwpoebounceresultv1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on Gateways","name":"Gateways"}]},"pathMetadata":{},"sha256":"4b4fbdce6321f4ca467642ac8fb44e331b2ba9a3b54c5f67d444457681b8284c"}}},"/network-troubleshooting/v1/gateways/{serial-number}/portBounce":{"post":{"description":"Starts an asynchronous Port Bounce test on the specified Gateway.","operationId":"initiateGwPortBounceV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"}],"requestBody":{"content":{"application/json":{"examples":{"minimal":{"summary":"Gateway Port Bounce request","value":{"ports":["GE 0/0/0","GE 0/0/1"]}}},"schema":{"$ref":"#/components/schemas/PortBounceMcRequest__15ee60ab88b2"}}},"description":"Gateway Port Bounce command parameters","required":true},"responses":{"202":{"content":{"application/json":{"example":{"location":"/network-troubleshooting/v1/gateways/{serial-number}/portBounce/async-operations/{task-id}","startTime":"2025-04-09T10:00:00Z","status":"INITIATED"},"schema":{"$ref":"#/components/schemas/AsyncOperationStatus__02a6567f3633"}}},"description":"Accepted. The operation has been successfully initiated. The response includes the location to track the operation's status."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/DeviceNotFound__02a6567f3633"},"409":{"$ref":"#/components/responses/DeviceOffline__02a6567f3633"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Initiate a Port Bounce test on a Gateway","tags":["Gateways"],"x-source-document":{"file":"MRT/initiategwportbouncev1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on Gateways","name":"Gateways"}]},"pathMetadata":{},"sha256":"5429857765bd7bdd3f09e16f62129d847f7e64c05880470ce85beb73439fe320"}}},"/network-troubleshooting/v1/gateways/{serial-number}/portBounce/async-operations/{task-id}":{"get":{"description":"Retrieves the status and results of a previously initiated asynchronous Gateway Port Bounce test.","operationId":"getGwPortBounceResultV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"},{"$ref":"#/components/parameters/AsyncTaskId__03efdde95a47"}],"responses":{"200":{"content":{"application/json":{"examples":{"completed":{"summary":"Gateway Port Bounce completed successfully","value":{"endTime":"2025-05-20T13:42:41.923609070Z","failReason":null,"output":{"ports":["GE 0/0/0","GE 0/0/1"],"results":[{"port":"0/0/0","status":"Bounced"},{"port":"0/0/1","status":"Bounced"}]},"progressPercent":100,"startTime":"2025-05-20T13:40:15.774840498Z","status":"COMPLETED"}},"running":{"summary":"Operation still running","value":{"endTime":null,"output":null,"progressPercent":0,"startTime":"2025-04-09T10:14:08Z","status":"RUNNING"}}},"schema":{"$ref":"#/components/schemas/PortBounceMcResult__835ad6fe2d5c"}}},"description":"OK. Returns the status and results of the Gateway Port Bounce test."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/TaskNotFound__03efdde95a47"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get Gateway Port Bounce test status and results","tags":["Gateways"],"x-source-document":{"file":"MRT/getgwportbounceresultv1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on Gateways","name":"Gateways"}]},"pathMetadata":{},"sha256":"9e2f8489206bed414864051851db4933ab23419e7839bf3df55e78aa8371c471"}}},"/network-troubleshooting/v1/gateways/{serial-number}/reboot":{"post":{"description":"Initiates a reboot operation on the specified Gateway.","operationId":"rebootGatewayV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"}],"responses":{"202":{"content":{"application/json":{"example":{"startTime":"2025-06-25T08:31:15.380079232Z","status":"INITIATED"},"schema":{"$ref":"#/components/schemas/ActionInitiatedStatus__11d6968be580"}}},"description":"Accepted. The reboot action has been successfully initiated."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/DeviceNotFound__02a6567f3633"},"409":{"$ref":"#/components/responses/DeviceConflictRebooting__78801b30c1be"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Reboot a Gateway","tags":["Gateways"],"x-source-document":{"file":"MRT/rebootgatewayv1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on Gateways","name":"Gateways"}]},"pathMetadata":{},"sha256":"4fca98bb0dfcd83cc66bae5a4e06c89a4f5678b34f593bf7ff3ee4e36715652a"}}},"/network-troubleshooting/v1/gateways/{serial-number}/show-commands":{"get":{"description":"Returns most used/top 'show' commands supported on given Gateway. ","operationId":"listGwShowCommandsV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShowCommandsResponse__3ba348bd5d1e"}}},"description":"OK."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/DeviceNotFound__02a6567f3633"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"List 'show' commands (Gateway - top commands)","tags":["Gateways"],"x-source-document":{"file":"MRT/listgwshowcommandsv1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on Gateways","name":"Gateways"}]},"pathMetadata":{},"sha256":"3bf5ac9dd7b5ee8246a1f057636d0854c27ec7bd2c90edb2eed58d065a1324c3"}}},"/network-troubleshooting/v1/gateways/{serial-number}/showCommands":{"post":{"description":"Starts an asynchronous execution of one or more 'show' commands on a Gateway. Rejected with 400 if any command does not start with 'show ', or if more than 20 commands are provided.","operationId":"runGwShowCommandsV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"}],"requestBody":{"content":{"application/json":{"example":{"commands":["show arp","show version"]},"schema":{"$ref":"#/components/schemas/ShowCommandRequest__1070839fcc3b"}}},"description":"The list of 'show' commands to run.","required":true},"responses":{"202":{"content":{"application/json":{"example":{"location":"/network-troubleshooting/v1/gateways/{serial-number}/showCommands/async-operations/{task-id}","startTime":"2025-08-25T10:00:00Z","status":"INITIATED"},"schema":{"$ref":"#/components/schemas/AsyncOperationStatus__02a6567f3633"}}},"description":"Accepted."},"400":{"$ref":"#/components/responses/BadRequestShowCommand__1070839fcc3b"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/DeviceNotFound__02a6567f3633"},"409":{"$ref":"#/components/responses/DeviceOffline__02a6567f3633"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Run 'show' commands (Gateway)","tags":["Gateways"],"x-source-document":{"file":"MRT/rungwshowcommandsv1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on Gateways","name":"Gateways"}]},"pathMetadata":{},"sha256":"0eeb7492e11d6dd42deabb7a97747a8a89396c666efb0b4639590b465f7f40eb"}}},"/network-troubleshooting/v1/gateways/{serial-number}/showCommands/async-operations/{task-id}":{"get":{"description":"Polls the async task for the 'show' commands and returns status and raw text output.","operationId":"getGwShowCommandsResultV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"},{"$ref":"#/components/parameters/AsyncTaskId__03efdde95a47"}],"responses":{"200":{"content":{"application/json":{"examples":{"completed":{"summary":"Command finished successfully","value":{"endTime":"2026-02-03T14:21:02.004881090Z","failReason":null,"output":{"commands":["show version"],"results":[{"command":"show version","output":"ArubaOS Version 8.x\n..."}]},"progressPercent":100,"startTime":"2026-02-03T14:20:59.912054756Z","status":"COMPLETED"}}},"schema":{"$ref":"#/components/schemas/ShowCommandResult__8cc1ef82c4a3"}}},"description":"OK."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/TaskNotFound__03efdde95a47"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get 'show' commands status/result (Gateway)","tags":["Gateways"],"x-source-document":{"file":"MRT/getgwshowcommandsresultv1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on Gateways","name":"Gateways"}]},"pathMetadata":{},"sha256":"0f812fce38c310652ff5e46a3433fb44316061dbb05317b3ec19e865abe0e30e"}}},"/network-troubleshooting/v1/gateways/{serial-number}/traceroute":{"post":{"description":"Starts an asynchronous Traceroute test on the specified Gateway.","operationId":"initiateGwTracerouteV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"}],"requestBody":{"content":{"application/json":{"examples":{"full":{"summary":"Gateway Traceroute request with additional parameters","value":{"destination":"www.google.com","includeRawOutput":false,"vlanIp":"10.27.115.18"}},"minimal":{"summary":"Minimal Gateway Traceroute request","value":{"destination":"www.google.com"}}},"schema":{"$ref":"#/components/schemas/TracerouteMcRequest__ad10a58c7624"}}},"description":"Gateway Traceroute command parameters","required":true},"responses":{"202":{"content":{"application/json":{"example":{"location":"/network-troubleshooting/v1/gateways/{serial-number}/traceroute/async-operations/{task-id}","startTime":"2025-04-09T10:00:00Z","status":"INITIATED"},"schema":{"$ref":"#/components/schemas/AsyncOperationStatus__02a6567f3633"}}},"description":"Accepted. The operation has been successfully initiated. The response includes the location to track the operation's status."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/DeviceNotFound__02a6567f3633"},"409":{"$ref":"#/components/responses/DeviceOffline__02a6567f3633"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Initiate a Traceroute test on a Gateway","tags":["Gateways"],"x-source-document":{"file":"MRT/initiategwtraceroutev1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on Gateways","name":"Gateways"}]},"pathMetadata":{},"sha256":"93ac7d0526fd58a8a598f1c61daec50ee2f0dcd2b87d8f8c35fd0cb06b38a8fb"}}},"/network-troubleshooting/v1/gateways/{serial-number}/traceroute/async-operations/{task-id}":{"get":{"description":"Retrieves the status and results of a previously initiated asynchronous Gateway Traceroute test.","operationId":"getGwTracerouteResultV1","parameters":[{"$ref":"#/components/parameters/DeviceSerial__02a6567f3633"},{"$ref":"#/components/parameters/AsyncTaskId__03efdde95a47"}],"responses":{"200":{"content":{"application/json":{"examples":{"completed":{"summary":"Gateway Traceroute completed successfully","value":{"endTime":"2025-05-21T11:39:31.826643044Z","failReason":null,"output":{"destination":"blrubshared-pdash.arubacorp.net","hops":[{"hop":"1","probes":[{"ipAddress":"null","responseTimeMilliseconds":"1 ms","reverseDnsResolution":"10.97.118.2"},{"ipAddress":"null","responseTimeMilliseconds":"1 ms","reverseDnsResolution":"10.97.118.2"},{"ipAddress":"null","responseTimeMilliseconds":"1 ms","reverseDnsResolution":"10.97.118.2"}]},{"hop":"2","probes":[{"ipAddress":"null","responseTimeMilliseconds":"1 ms","reverseDnsResolution":"10.97.112.1"},{"ipAddress":"null","responseTimeMilliseconds":"0 ms","reverseDnsResolution":"10.97.112.1"},{"ipAddress":"null","responseTimeMilliseconds":"1 ms","reverseDnsResolution":"10.97.112.1"}]},{"hop":"3","probes":[]},{"hop":"5","probes":[{"ipAddress":"null","responseTimeMilliseconds":"1 ms","reverseDnsResolution":"10.186.172.153"},{"ipAddress":"null","responseTimeMilliseconds":"1 ms","reverseDnsResolution":"10.186.172.153"},{"ipAddress":"null","responseTimeMilliseconds":"0 ms","reverseDnsResolution":"10.186.172.153"}]}]},"progressPercent":100,"rawOutput":"\ntraceroute blrubshared-pdash.arubacorp.net\ntraceroute to 10.186.172.153 ,\n              1 hop min, 30 hops max, 5 sec. timeout, 3 probes\n 1 10.97.118.2           1 ms      1 ms      1 ms\n 2 10.97.112.1           1 ms      0 ms      1 ms\n 3  *  *  * \n 4 10.186.128.6          1 ms10.186.128.4          1 ms      1 ms\n 5 10.186.172.153        1 ms      1 ms      0 ms\n\n","startTime":"2025-05-21T11:39:13.645841269Z","status":"COMPLETED"}},"running":{"summary":"Operation still running","value":{"endTime":null,"output":null,"progressPercent":0,"rawOutput":null,"startTime":"2025-04-09T10:14:08Z","status":"RUNNING"}}},"schema":{"$ref":"#/components/schemas/TracerouteMcResult__a85855bba103"}}},"description":"OK. Returns the status and results of the Gateway Traceroute test."},"400":{"$ref":"#/components/responses/BadRequest__02a6567f3633"},"401":{"$ref":"#/components/responses/Unauthorized__02a6567f3633"},"403":{"$ref":"#/components/responses/Forbidden__02a6567f3633"},"404":{"$ref":"#/components/responses/TaskNotFound__03efdde95a47"},"429":{"$ref":"#/components/responses/TooManyRequests__02a6567f3633"},"500":{"$ref":"#/components/responses/InternalServerError__02a6567f3633"}},"security":[{"OAuth2__000172564380":[]}],"servers":[{"description":"eu","url":"https://de1.api.central.arubanetworks.com"},{"description":"eucentral2","url":"https://de2.api.central.arubanetworks.com"},{"description":"eucentral3","url":"https://de3.api.central.arubanetworks.com"},{"description":"ukwest2","url":"https://gb1.api.central.arubanetworks.com"},{"description":"prod","url":"https://us1.api.central.arubanetworks.com"},{"description":"central-prod2","url":"https://us2.api.central.arubanetworks.com"},{"description":"uswest4","url":"https://us4.api.central.arubanetworks.com"},{"description":"uswest5","url":"https://us5.api.central.arubanetworks.com"},{"description":"us-east-1","url":"https://us6.api.central.arubanetworks.com"},{"description":"starman","url":"https://ca1.api.central.arubanetworks.com"},{"description":"apac","url":"https://in1.api.central.arubanetworks.com"},{"description":"apaceast","url":"https://jp1.api.central.arubanetworks.com"},{"description":"apacsouth","url":"https://au1.api.central.arubanetworks.com"},{"description":"uaenorth1","url":"https://ae1.api.central.arubanetworks.com"},{"description":"china-prod","url":"https://cn1.api.central.arubanetworks.com.cn"},{"description":"internal2","url":"https://internal.api.central.arubanetworks.com"}],"summary":"Get Gateway Traceroute test status and results","tags":["Gateways"],"x-source-document":{"file":"MRT/getgwtracerouteresultv1.json","metadata":{"info":{"description":"API service to run troubleshooting tests on devices - Access Points (APs), CX Switches, AOS-S Switches, and Gateways (GWs).","license":{"name":"HPE","url":"https://www.hpe.com/us/en/software/licensing.html"},"title":"Troubleshooting","version":"0.0.1"},"openapi":"3.1.0","tags":[{"description":"Troubleshooting operations on Gateways","name":"Gateways"}]},"pathMetadata":{},"sha256":"980f9c42943ec05287bdda630b9891c0553245ad283c5602ef094af93b3e30f3"}}}},"tags":[{"description":"Troubleshooting operations on AOS-S Switches (The stackId should be used in place of the serial for stack switches)","name":"AOS-S Switches"},{"description":"Troubleshooting operations on Access Points (APs)","name":"Access Points"},{"description":"Operations related to AirMatch Services","name":"AirMatch"},{"description":"APIs for managing alert configurations — retrieve threshold rules and severity settings per alert type and scope.","name":"Alert Configurations"},{"description":"APIs for managing alerts.","name":"Alerts"},{"description":"Application Visibility APIs provide details about applications accessed in a site or by a client.","name":"Application Visibility"},{"description":"Automated audit data","name":"Audit Trail Information"},{"description":"Troubleshooting operations on CX Switches (The stackId should be used in place of the serial for stack switches)","name":"CX Switches"},{"description":"APIs to retrieve onboarding stage scores, stage export summaries, top reasons, and top grouped counts.","name":"Client Onboarding"},{"description":"APIs for managing network clients.","name":"Clients"},{"description":"Device monitoring APIs to get device details and its metrics","name":"Devices"},{"description":"APIs to manage and retrieve network events","name":"Events"},{"description":"Automated Frequency Coordination channel data","name":"FCO Response Information"},{"description":"Firewall Session Monitoring APIs to retrieve firewall session logs from a site.","name":"Firewall Session"},{"description":"Firmware management APIs","name":"Firmware Management"},{"description":"FloorPlan Manager APIs to get details about FloorMap and entities placed on FloorMap","name":"FloorPlan"},{"description":"Troubleshooting operations on Gateways","name":"Gateways"},{"description":"IDPS(Intrusion Detection and Prevention System) Monitoring APIs to retrieve threat list and a particular threat details","name":"IDPS"},{"description":"APIs for retrieving source recommendations.","name":"Insights"},{"description":"Live Upgrade APIs to get AP and Gateway upgrade details","name":"Live Upgrade"},{"description":"APIs that allow for interacting with Location Service offerings.","name":"Location"},{"description":"Location Analytics APIs to get the client related analytics describing how the client is classified.","name":"Location Analytics"},{"description":"MSP APIs to get and manage tenants related information.","name":"MSP"},{"description":"APIs for managing notification rules.","name":"Notification Rules"},{"description":"Reporting APIs to manage network reports","name":"Reporting"},{"description":"Site Health APIs to get site details with health, devices, clients, alerts information.","name":"Site Health"},{"description":"APIs to retrieve subscription and license information.","name":"Subscriptions"},{"description":"Switch Monitoring APIs to get details about Switch and related info","name":"Switch"},{"description":"Topology APIs to get Topology and device relationship information","name":"Topology"},{"description":" APIs for retrieving and managing wireless APs and signatures detected by the WIDS (Wireless Intrusion Detection System).","name":"WIDS"},{"description":"APIs for managing webhooks.","name":"Webhooks"}]}