openapi: 3.0.2 info: title: SASE 5G Monitor Service API version: '1.0' description: "The SASE 5G Monitoring Service provides real-time visibility and technical telemetry \nfor enterprise 5G infrastructure within the Strata Cloud Manager (SCM) ecosystem. \nTechnical leads and network analysts utilize these APIs to track subscriber scaling, \nmonitor regional registration trends, and audit network throughput performance.\n\nBy leveraging these endpoints, organizations maintain a continuous feedback loop on \nUser Equipment (UE) activity and regional interconnect health. The service enables \nproactive troubleshooting through incident severity tracking and API performance\ \ \nmonitoring, ensuring that global 5G connectivity meets strict service level objectives \nwhile identifying unauthorized traffic or signaling gaps. This spec was created on February 13, 2026. © 2026 Palo Alto Networks, Inc." paths: /mt/monitor/5g/tenants: get: tags: - Total Tenants summary: Palo Alto Networks 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." responses: '200': description: Success content: application/json: example: data: total_tenants: 8 header: createdAt: '2025-12-17T01:28:33Z' clientRequestId: dataCount: 1 status: subCode: 200 '401': description: Permission Denied '500': description: Server Error operationId: GetMtMonitor5gTenants x-microcks-operation: delay: 0 dispatcher: FALLBACK /mt/monitor/5g/ueIp/registered: get: tags: - Registered UE Mappings summary: Palo Alto Networks 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." responses: '200': description: Success content: application/json: example: data: registered_device: 6 header: createdAt: '2025-12-17T02:03:07Z' clientRequestId: dataCount: 1 status: subCode: 200 '401': description: Permission Denied '500': description: Server Error operationId: GetMtMonitor5gUeipRegistered x-microcks-operation: delay: 0 dispatcher: FALLBACK /mt/monitor/5g/ueIp/region: get: tags: - UE IP Region summary: Palo Alto Networks 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." responses: '200': description: Success content: application/json: example: data: - compute_region: us-west2 header: createdAt: '2025-12-17T02:06:52Z' clientRequestId: dataCount: 1 status: subCode: 200 '401': description: Permission Denied '500': description: Server Error operationId: GetMtMonitor5gUeipRegion x-microcks-operation: delay: 0 dispatcher: FALLBACK /mt/monitor/5g/ueIp/registered/trend: post: tags: - 5G Registered Trend summary: Palo Alto Networks 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." requestBody: content: application/json: schema: $ref: '#/components/schemas/TrendRequest' example: properties: - property: imei function: count alias: registered_count filter: operator: AND rules: - property: event_time operator: last_n_days values: - 7 - property: compute_region operator: in values: - us-central1 histogram: property: event_time range: day enableEmptyInterval: false value: '1' responses: '200': description: Success content: application/json: example: data: - event_time: 1765324800000 registered_count: 4 - event_time: 1765411200000 registered_count: 4 header: createdAt: '2025-12-17T02:05:29Z' clientRequestId: dataCount: 7 status: subCode: 200 '400': description: Bad Request '401': description: Permission Denied '500': description: Server Error operationId: PostMtMonitor5gUeipRegisteredTrend x-microcks-operation: delay: 0 dispatcher: FALLBACK /mt/monitor/5g/ueIp/deregistered/trend: post: tags: - 5G Deregistered Trend summary: Palo Alto Networks Track Deregistration Trends description: "Monitors the frequency and volume of User Equipment session terminations \nover time. Security analysts use this telemetry to detect anomalous \ndisconnect patterns or regional connectivity drops during active \nmonitoring windows." requestBody: content: application/json: schema: $ref: '#/components/schemas/TrendRequest' example: properties: - property: imei function: count alias: deregistered_count filter: operator: AND rules: - property: event_time operator: last_n_days values: - 7 - property: compute_region operator: in values: - us-central1 histogram: property: event_time range: day enableEmptyInterval: false value: '1' responses: '200': description: Success content: application/json: example: data: - event_time: 1765324800000 deregistered_count: 3 - event_time: 1765411200000 deregistered_count: 3 header: createdAt: '2025-12-17T02:05:42Z' clientRequestId: dataCount: 7 status: subCode: 200 '400': description: Bad Request '401': description: Permission Denied '500': description: Server Error operationId: PostMtMonitor5gUeipDeregisteredTrend x-microcks-operation: delay: 0 dispatcher: FALLBACK /mt/monitor/5g/ueIp/count: post: tags: - Added and Cleared Mappings summary: Palo Alto Networks 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." requestBody: content: application/json: schema: $ref: '#/components/schemas/CountFilterRequest' example: filter: operator: AND rules: - property: event_time operator: last_n_days values: - 7 responses: '200': description: Success content: application/json: example: data: add_count: 28 delete_count: 19 header: createdAt: '2025-12-17T02:07:14Z' clientRequestId: dataCount: 1 status: subCode: 200 '400': description: Bad Request '401': description: Permission Denied '500': description: Server Error operationId: PostMtMonitor5gUeipCount x-microcks-operation: delay: 0 dispatcher: FALLBACK /mt/monitor/5g/unknownIp/region: get: tags: - Unknown IP Regions summary: Palo Alto Networks 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." responses: '200': description: Success content: application/json: example: data: - compute_region: us-west2 header: createdAt: '2025-12-17T02:04:26Z' clientRequestId: dataCount: 1 status: subCode: 200 '401': description: Permission Denied '500': description: Server Error operationId: GetMtMonitor5gUnknownipRegion x-microcks-operation: delay: 0 dispatcher: FALLBACK /mt/monitor/5g/unknownIp/trend: post: tags: - 5G Unknown IPs Trend summary: Palo Alto Networks 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 \nregional interconnects." requestBody: content: application/json: schema: $ref: '#/components/schemas/TrendRequest' example: properties: - property: ip_address function: distinct_count alias: count - property: compute_region alias: region filter: operator: AND rules: - property: event_time operator: last_n_days values: - 7 - property: compute_region operator: in values: - us-central1 histogram: property: event_time range: day enableEmptyInterval: false value: '1' responses: '200': description: Success content: application/json: example: data: - region: us-central1 event_time: 1765324800000 count: 13 - region: us-central1 event_time: 1765411200000 count: 7 header: createdAt: '2025-12-17T02:05:04Z' clientRequestId: dataCount: 8 status: subCode: 200 '400': description: Bad Request '401': description: Permission Denied '500': description: Server Error operationId: PostMtMonitor5gUnknownipTrend x-microcks-operation: delay: 0 dispatcher: FALLBACK /mt/monitor/5g/mapping/activeUEs: get: tags: - Active Mappings summary: Palo Alto Networks 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 \nreadiness." responses: '200': description: Success content: application/json: example: data: active_mappings: 4 header: createdAt: '2025-12-17T02:05:18Z' clientRequestId: dataCount: 1 status: subCode: 200 '401': description: Permission Denied '500': description: Server Error operationId: GetMtMonitor5gMappingActiveues x-microcks-operation: delay: 0 dispatcher: FALLBACK /mt/monitor/5g/mapping/configuredUEs: get: tags: - Configured UE Mappings summary: Palo Alto Networks 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." responses: '200': description: Success content: application/json: example: data: configured_ue_count: 94 header: createdAt: '2025-12-17T02:07:37Z' clientRequestId: dataCount: 1 status: subCode: 200 '401': description: Permission Denied '500': description: Server Error operationId: GetMtMonitor5gMappingConfiguredues x-microcks-operation: delay: 0 dispatcher: FALLBACK /mt/monitor/5g/mapping/unknownUEs: get: tags: - Unknown UE Mappings summary: Palo Alto Networks 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." responses: '200': description: Success content: application/json: example: data: unknown_mappings: 1 header: createdAt: '2025-12-17T02:07:45Z' clientRequestId: dataCount: 1 status: subCode: 200 '401': description: Permission Denied '500': description: Server Error operationId: GetMtMonitor5gMappingUnknownues x-microcks-operation: delay: 0 dispatcher: FALLBACK /mt/monitor/5g/mapping/region: get: tags: - Mappings Region summary: Palo Alto Networks Get 5G Mapping Regions description: Returns the list of regions where mappings exist. responses: '200': description: Success content: application/json: example: data: - us-west2 - us-central1 header: createdAt: '2025-12-17T02:10:45Z' clientRequestId: dataCount: 2 status: subCode: 200 '401': description: Permission Denied '500': description: Server Error operationId: GetMtMonitor5gMappingRegion x-microcks-operation: delay: 0 dispatcher: FALLBACK /mt/monitor/5g/mapping: post: tags: - UE Mappings summary: Palo Alto Networks 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 \nprovisioning status, and group associations." requestBody: content: application/json: schema: $ref: '#/components/schemas/MappingRequest' examples: Paginated List: value: pageSize: 100 pageNum: 0 Paginated List With Tenant Filter: value: pageSize: 100 pageNum: 0 tenant: - '1459340040' - '1635727460' responses: '200': description: Success content: application/json: examples: Single Mapping: value: data: mappings: - apn: demo.com createTime: 1737113951692 groups: new_grp imei: '000000000000000' imsi: '500012222222222' tenantProvisioned: Inactive tsgId: '1131085573' totalCount: 1 header: createdAt: '2025-12-17T02:07:58Z' clientRequestId: dataCount: 1 status: subCode: 200 '400': description: Bad Request '401': description: Permission Denied '500': description: Server Error operationId: PostMtMonitor5gMapping x-microcks-operation: delay: 0 dispatcher: FALLBACK /mt/monitor/5g/proxy: get: tags: - Total Proxies summary: Palo Alto Networks 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." responses: '200': description: Success content: application/json: example: data: count: 5 header: createdAt: '2025-12-17T02:05:51Z' clientRequestId: dataCount: 1 status: subCode: 200 '401': description: Permission Denied '500': description: Server Error operationId: GetMtMonitor5gProxy x-microcks-operation: delay: 0 dispatcher: FALLBACK /mt/monitor/5g/incidents/count: post: tags: - Incidents by Severity summary: Palo Alto Networks Categorize Incident Severities description: "Aggregates active 5G service incidents based on critical, warning, or \ninformational severity levels. NOC engineers use this data during \nincident response windows to prioritize remediation efforts across \nthe global 5G fabric." parameters: - name: agg_by in: query schema: type: string enum: - tenant description: Aggregation parameter example: tenant requestBody: content: application/json: schema: $ref: '#/components/schemas/IncidentsCountRequest' example: properties: - property: total_count - property: critical_count - property: warning_count filter: rules: - property: raised_time operator: last_n_days values: - 7 - property: status operator: equals values: - Raised responses: '200': description: Success content: application/json: example: data: - total_count: 680 critical_count: 340 warning_count: 0 '400': description: Bad Request '401': description: Permission Denied '500': description: Server Error operationId: PostMtMonitor5gIncidentsCount x-microcks-operation: delay: 0 dispatcher: FALLBACK /mt/monitor/5g/api/stats: post: tags: - API Stats summary: Palo Alto Networks 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." requestBody: content: application/json: schema: $ref: '#/components/schemas/CountFilterRequest' example: filter: operator: AND rules: - property: event_time operator: last_n_days values: - 7 responses: '200': description: Success content: application/json: example: data: total_count: 0 success_count: 0 failure_count: 0 header: createdAt: '2025-12-17T02:06:39Z' clientRequestId: dataCount: 1 status: subCode: 200 '400': description: Bad Request '401': description: Permission Denied '500': description: Server Error operationId: PostMtMonitor5gApiStats x-microcks-operation: delay: 0 dispatcher: FALLBACK /mt/monitor/5g/interconnect/details: get: tags: - 5G Network Interconnects and Bandwidth summary: Palo Alto Networks Inspect Interconnect Health description: "Provides a detailed overview of 5G network interconnects, including \ntotal bandwidth and regional VLAN status. Network engineers utilize \nthis check to verify that regional data paths remain \"up\" and meet \nthroughput capacity requirements." responses: '200': description: Success content: application/json: example: data: - bandwidth: 200 regions: - us-east1 - us-west2 - us-central1 vlanStatus: down: 0 total: 8 up: 8 header: createdAt: '2025-12-17T02:07:25Z' clientRequestId: dataCount: 1 status: subCode: 200 '401': description: Permission Denied '500': description: Server Error operationId: GetMtMonitor5gInterconnectDetails x-microcks-operation: delay: 0 dispatcher: FALLBACK /mt/monitor/5g/interconnect/throughput: post: tags: - Throughput Trend summary: Palo Alto Networks Analyze Throughput Performance description: "Generates egress and ingress throughput metrics for 5G interconnects \nover a requested interval. Analysts monitor these throughput levels \nto detect congestion points and optimize traffic flow across the \nregional security perimeter." requestBody: content: application/json: schema: $ref: '#/components/schemas/ThroughputRequest' example: properties: - property: egress_throughput - property: ingress_throughput - property: event_time - property: region filter: operator: AND rules: - property: event_time operator: last_n_days values: - 7 - property: region operator: equals values: - us-central1 histogram: property: event_time range: day enableEmptyInterval: false value: '1' responses: '200': description: Success content: application/json: example: data: - egress_throughput: 0.002508770165798529 ingress_throughput: 0.003023766583801299 event_time: 1765324800000 region: us-central1 '400': description: Bad Request '401': description: Permission Denied '500': description: Server Error operationId: PostMtMonitor5gInterconnectThroughput x-microcks-operation: delay: 0 dispatcher: FALLBACK /mt/monitor/5g/users: get: tags: - Total Number of Configured Users summary: Palo Alto Networks 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." responses: '200': description: Success content: application/json: example: data: total_users: 5000 header: createdAt: '2025-12-17T02:08:46Z' clientRequestId: dataCount: 1 status: subCode: 200 '401': description: Permission Denied '500': description: Server Error operationId: GetMtMonitor5gUsers x-microcks-operation: delay: 0 dispatcher: FALLBACK servers: - url: https://stratacloudmanager.paloaltonetworks.com security: - BearerAuth: [] components: schemas: TrendRequest: type: object properties: properties: type: array items: type: object properties: property: type: string example: example-property function: type: string example: example-function alias: type: string example: example-alias example: - property: example-property function: example-function alias: example-alias - property: example-property function: example-function alias: example-alias filter: type: object properties: operator: type: string example: example-operator rules: type: array items: type: object properties: property: type: string example: example-property operator: type: string example: example-operator values: type: array items: type: object example: - {} - {} example: - property: example-property operator: example-operator values: - {} - {} example: operator: example-operator rules: - property: example-property operator: example-operator values: - {} - property: example-property operator: example-operator values: - {} - {} histogram: type: object properties: property: type: string example: example-property range: type: string example: example-range enableEmptyInterval: type: boolean example: true value: type: string example: example-value example: property: example-property range: example-range enableEmptyInterval: true value: example-value CountFilterRequest: type: object properties: filter: type: object properties: operator: type: string example: example-operator rules: type: array items: type: object properties: property: type: string example: example-property operator: type: string example: example-operator values: type: array items: type: object example: - {} - {} example: - property: example-property operator: example-operator values: - {} - property: example-property operator: example-operator values: - {} example: operator: example-operator rules: - property: example-property operator: example-operator values: - {} - property: example-property operator: example-operator values: - {} - {} MappingRequest: type: object properties: pageSize: type: integer format: int32 example: 836 pageNum: type: integer format: int32 example: 110 searchKey: type: string example: example-searchKey region: type: string example: eu-west-1 tenant: type: array items: type: string example: - example-tenant_item - example-tenant_item IncidentsCountRequest: type: object properties: properties: type: array items: type: object properties: property: type: string example: example-property example: - property: example-property - property: example-property filter: type: object properties: rules: type: array items: type: object properties: property: type: string example: example-property operator: type: string example: example-operator values: type: array items: type: object example: - {} example: - property: example-property operator: example-operator values: - {} - property: example-property operator: example-operator values: - {} example: rules: - property: example-property operator: example-operator values: - {} - property: example-property operator: example-operator values: - {} - {} ThroughputRequest: type: object properties: properties: type: array items: type: object properties: property: type: string example: example-property example: - property: example-property - property: example-property filter: type: object properties: operator: type: string example: example-operator rules: type: array items: type: object properties: property: type: string example: example-property operator: type: string example: example-operator values: type: array items: type: object example: - {} example: - property: example-property operator: example-operator values: - {} - {} - property: example-property operator: example-operator values: - {} example: operator: example-operator rules: - property: example-property operator: example-operator values: - {} histogram: type: object properties: property: type: string example: example-property range: type: string example: example-range enableEmptyInterval: type: boolean example: false value: type: string example: example-value example: property: example-property range: example-range enableEmptyInterval: true value: example-value ExternalTags: {}