diff --git a/openapi-specs/sase/monitor-services-5g/SASE-5G-Monitor.yaml b/openapi-specs/sase/monitor-services-5g/SASE-5G-Monitor.yaml index 0521c5baa..90a8df989 100644 --- a/openapi-specs/sase/monitor-services-5g/SASE-5G-Monitor.yaml +++ b/openapi-specs/sase/monitor-services-5g/SASE-5G-Monitor.yaml @@ -18,11 +18,8 @@ paths: get: tags: - Total Tenants - summary: Fetch Tenant Totals - description: "Returns the aggregate count of onboarded tenants across the 5G\ - \ service \ninfrastructure. Monitoring teams call this during system audits\ - \ to verify \nthe scale of the multi-tenant environment within the management\ - \ plane." + summary: Get Total Tenants + description: Returns the total count of tenants. responses: '200': description: Success @@ -46,11 +43,8 @@ paths: get: tags: - Registered UE Mappings - summary: Count Registered Devices - description: "Provides the current number of registered User Equipment (UE)\ - \ device \nmappings within the 5G network. Network operators perform this\ - \ check to \nassess active device density and ensure session registration\ - \ alignment \nacross all 5G nodes." + summary: Get Registered UE Mappings + description: Returns the count of registered device mappings. responses: '200': description: Success @@ -74,10 +68,8 @@ paths: get: tags: - UE IP Region - summary: List Active Regions - description: "Lists all compute regions currently hosting registered 5G User\ - \ Equipment. \nInfrastructure architects query this during regional performance\ - \ analysis \nto determine where subscriber traffic is geographically concentrated." + summary: Get UEs Region + description: Returns the list of regions where UEs are registered. responses: '200': description: Success @@ -101,11 +93,8 @@ paths: post: tags: - 5G Registered Trend - summary: Analyze Registration Trends - description: "Generates a time-series report of subscriber registration activities\ - \ over \na specific time window. Engineers utilize these trends during capacity\ - \ \nplanning to identify peak usage intervals and regional registration spikes\ - \ \nwithin the management plane." + summary: Get Registered UE Trend + description: Returns the trend of registered UE devices over time. requestBody: content: application/json: @@ -160,11 +149,8 @@ paths: post: tags: - 5G Deregistered Trend - summary: Track Deregistration Trends - description: "Monitors the frequency and volume of User Equipment session terminations\ - \ \nover time. Security analysts use this telemetry to detect anomalous \n\ - disconnect patterns or regional connectivity drops during active \nmonitoring\ - \ windows." + summary: Get DeRegistered UE Trend + description: Returns the trend of deregistered UE devices over time. requestBody: content: application/json: @@ -219,11 +205,9 @@ paths: post: tags: - Added and Cleared Mappings - summary: Audit Mapping Changes - description: "Calculates the number of newly added and cleared User Equipment\ - \ IP Address \nmappings for a designated period. System administrators trigger\ - \ this \naudit to track device churn and verify lifecycle transitions within\ - \ \nthe 5G management plane." + summary: Get Added/Cleared Mappings Count + description: Returns the count of added and cleared UE IP Address mappings over + a period of time. requestBody: content: application/json: @@ -263,11 +247,8 @@ paths: get: tags: - Unknown IP Regions - summary: Identify Unknown Regions - description: "Returns a list of regions where IP Address addresses not explicitly\ - \ mapped to \nknown User Equipment have been detected. Security teams check\ - \ these \nlocations to investigate potential unauthorized traffic or misconfigured\ - \ \n5G signaling paths." + summary: Get Unknown IP Address Region + description: Returns the regions where unknown IPs are detected. responses: '200': description: Success @@ -291,11 +272,8 @@ paths: post: tags: - 5G Unknown IPs Trend - summary: Monitor Unknown Trends - description: "Tracks the volume of unknown IP Address address detections over\ - \ a historical \ntime range. Network engineers monitor these trends to troubleshoot\ - \ \ndiscovery gaps and improve the accuracy of subscriber mapping across \n\ - regional interconnects." + summary: Get Unknown IP Address Trend + description: Returns the trend of unknown IP Address addresses over time. requestBody: content: application/json: @@ -354,11 +332,8 @@ paths: get: tags: - Active Mappings - summary: Check Active Mappings - description: "Displays the total number of User Equipment mappings currently\ - \ in an \nactive state. Monitoring dashboards use this metric to provide a\ - \ \nreal-time snapshot of 5G session health and operational throughput \n\ - readiness." + summary: Get Active UE Mappings + description: Returns the count of active UE mappings. responses: '200': description: Success @@ -382,11 +357,8 @@ paths: get: tags: - Configured UE Mappings - summary: Verify Configured Mappings - description: "Returns the count of User Equipment mappings manually provisioned\ - \ by \nadministrators. Operational leads compare this value against active\ - \ \nregistrations to verify onboarding success and subscriber provisioning\ - \ \naccuracy." + summary: Get Configured UE Mappings + description: Returns the count of UEs configured by the users. responses: '200': description: Success @@ -410,11 +382,9 @@ paths: get: tags: - Unknown UE Mappings - summary: Detect Unconfigured Subscribers - description: "Reports the count of User Equipment that successfully registered\ - \ via \nRadius or Application Programming Interface but lack a predefined\ - \ configuration. Analysts review \nthese mappings to bridge gaps between dynamic\ - \ 5G sessions and static \nmanagement records." + summary: Get Unknown UE Mappings + description: Returns the count of UE mappings which were not configured by user, + but got registered either via Radius or Application Programming Interface. responses: '200': description: Success @@ -464,11 +434,10 @@ paths: post: tags: - UE Mappings - summary: Search Subscriber Details - description: "Provides a comprehensive search interface for User Equipment mappings\ - \ \nusing IMSI, IMEI, or IP Address address identifiers. Developers integrate\ - \ this \nto enable granular drill-downs into subscriber metadata, tenant \n\ - provisioning status, and group associations." + summary: UE Mapping Details + description: List all the UE Mappings or search a particular UE Mapping by IMSI, + IMEI or IP Address Address. If no pagination is provided by deafult 100 records + will be returned. requestBody: content: application/json: @@ -486,6 +455,33 @@ paths: tenant: - '1459340040' - '1635727460' + Paginated List With Region Filter: + value: + pageSize: 100 + pageNum: 0 + region: us-west2 + Paginated List With Region and Tenant Filter: + value: + pageSize: 100 + pageNum: 0 + region: us-west2 + tenant: + - '1459340040' + - '1635727460' + Search with Pagination: + value: + searchKey: '500012222222222' + pageSize: 100 + pageNum: 0 + Search with Pagination and Filtering: + value: + searchKey: '310260418380113' + pageSize: 100 + pageNum: 0 + region: us-west2 + tenant: + - '1459340040' + - '1635727460' responses: '200': description: Success @@ -510,6 +506,29 @@ paths: dataCount: 1 status: subCode: 200 + Multiple Mappings: + value: + data: + mappings: + - apn: pan.pcweb.comm + createTime: 1759426780582 + imei: '000000000000000' + imsi: '310260418380113' + tenantProvisioned: Inactive + tsgId: '1558164857' + - apn: pan.fast.comm + createTime: 1759426957812 + imei: '359414782481750' + imsi: '310260418380113' + tenantProvisioned: Inactive + tsgId: '1558164857' + totalCount: 2 + header: + createdAt: '2025-12-17T02:08:33Z' + clientRequestId: null + dataCount: 2 + status: + subCode: 200 '400': description: Bad Request '401': @@ -521,11 +540,8 @@ paths: get: tags: - Total Proxies - summary: Count Active Proxies - description: "Returns the total number of proxy servers configured to handle\ - \ 5G \ncontrol plane traffic. Administrators audit this count during \ninfrastructure\ - \ maintenance to ensure all intended signaling gateways \nare recognized by\ - \ the monitoring service." + summary: Get Total Proxies + description: Returns the total count of proxy servers configured by the client. responses: '200': description: Success @@ -549,11 +565,8 @@ paths: post: tags: - Incidents by Severity - summary: Categorize Incident Severities - description: "Aggregates active 5G service incidents based on critical, warning,\ - \ or \ninformational severity levels. NOC engineers use this data during \n\ - incident response windows to prioritize remediation efforts across \nthe global\ - \ 5G fabric." + summary: Get Incidents By Severity + description: Returns the count of incidents based on severity levels. parameters: - name: agg_by in: query @@ -582,6 +595,16 @@ paths: operator: equals values: - Raised + - property: severity + operator: in + values: + - Critical + - Warning + - property: domain + operator: in + values: + - External + - external responses: '200': description: Success @@ -603,11 +626,10 @@ paths: post: tags: - API Stats - summary: Monitor Application Programming Interface Performance - description: "Returns success and failure statistics for 5G management Application\ - \ Programming Interface calls made \nthrough the SCM interface. Technical\ - \ teams monitor these stats to \nensure high availability and detect potential\ - \ integration issues \nbetween 5G cores and the management plane." + summary: Get Application Programming Interface Stats + description: Returns the total Application Programming Interface calls made + and count of success and failure calls. Applicable for interface type Application + Programming Interface. requestBody: content: application/json: @@ -648,11 +670,8 @@ paths: get: tags: - 5G Network Interconnects and Bandwidth - summary: Inspect Interconnect Health - description: "Provides a detailed overview of 5G network interconnects, including\ - \ \ntotal bandwidth and regional VLAN status. Network engineers utilize \n\ - this check to verify that regional data paths remain \"up\" and meet \nthroughput\ - \ capacity requirements." + summary: Get Interconnect Details + description: Returns total bandwidth, region list and 5G Network Connections. responses: '200': description: Success @@ -684,11 +703,8 @@ paths: post: tags: - Throughput Trend - summary: Analyze Throughput Performance - description: "Generates egress and ingress throughput metrics for 5G interconnects\ - \ \nover a requested interval. Analysts monitor these throughput levels \n\ - to detect congestion points and optimize traffic flow across the \nregional\ - \ security perimeter." + summary: Get Throughput Trend + description: Returns the throughput trend data for egress and ingress traffic. requestBody: content: application/json: @@ -727,6 +743,10 @@ paths: ingress_throughput: 0.003023766583801299 event_time: 1765324800000 region: us-central1 + - egress_throughput: 0.0027237501165300205 + ingress_throughput: 0.0034827909235609217 + event_time: 1765411200000 + region: us-central1 '400': description: Bad Request '401': @@ -738,10 +758,8 @@ paths: get: tags: - Total Number of Configured Users - summary: Fetch User Totals - description: "Reports the total number of users configured within the 5G monitoring\ - \ \ndomain. Management teams use this count for license auditing and \nto\ - \ track the growth of the subscriber base across the multi-tenant \nenvironment." + summary: Get Total Configured Users + description: Returns the total count of configured users. responses: '200': description: Success @@ -761,6 +779,58 @@ paths: '500': description: Server Error operationId: GetMtMonitor5gUsers + /mt/monitor/5g/ueIp/bandwidth: + post: + tags: + - Bandwidth Consumption + summary: Get Bandwidth Consumption for Users + description: Returns the egress and ingress bandwidth consumption for users. + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BandwidthRequest' + example: + filter: + rules: + - property: event_time + operator: last_n_days + values: + - 7 + - property: tsg_id + operator: in + values: + - '1916630658' + - '1316969669' + - '1817714134' + - property: compute_region + operator: in + values: + - us-central1 + responses: + '200': + description: Success + content: + application/json: + example: + data: + - username: iot-test\\112233445566776_test.com + total_rx_bytes: 0 + total_tx_bytes: 0 + rx_throughput_bps: 0.0 + tx_throughput_bps: 0.0 + imei: 100000000000000 + imsi: 112233445566776 + apn: test.com + tsg_id: 12345678 + compute_region: us-west2 + '400': + description: Bad Request + '401': + description: Permission Denied + '500': + description: Server Error + operationId: PostMtMonitor5gUeipBandwidth servers: - url: https://stratacloudmanager.paloaltonetworks.com security: @@ -797,8 +867,7 @@ components: type: string values: type: array - items: - type: object + items: {} histogram: type: object properties: @@ -829,8 +898,7 @@ components: type: string values: type: array - items: - type: object + items: {} MappingRequest: type: object properties: @@ -872,8 +940,7 @@ components: type: string values: type: array - items: - type: object + items: {} ThroughputRequest: type: object properties: @@ -900,8 +967,7 @@ components: type: string values: type: array - items: - type: object + items: {} histogram: type: object properties: @@ -913,4 +979,24 @@ components: type: boolean value: type: string + BandwidthRequest: + type: object + properties: + filter: + type: object + properties: + operator: + type: string + rules: + type: array + items: + type: object + properties: + property: + type: string + operator: + type: string + values: + type: array + items: {} ExternalTags: {}