The identity and technical contract details declared by the specification.
GatewayUpdateRequest
object
Partial update for a gateway. Only provided fields are updated.
8 properties
GatewayProvisionRequest
object
12 properties
2 required
GatewayHistoryResponse
object
7 properties
BatchGatewayProvisionRequest
object
1 property
1 required
BatchGatewayProvisionResponse
object
5 properties
BatchFailureRecord
object
3 properties
BatchGatewayDeprovisionRequest
object
1 property
1 required
GatewayDeprovisionItem
object
2 properties
2 required
BatchGatewayDeprovisionResponse
object
5 properties
BatchDeprovisionFailureRecord
object
3 properties
ConfigurationErrorResponse
object
RFC 7807 error envelope (FS section 4.7)
4 properties
ConfigurationErrorDetail
object
3 properties
CompanyResponse
object
5 properties
CompanyUpsertRequest
object
3 properties
2 required
GatewayResponse
object
18 properties
AuthorizedAccountsResponse
object
Paginated list of managed enterprise accounts
4 properties
ManagedAccount
object
A managed enterprise account
2 properties
accountId
integer
Account Id.
dateTime
string
ISO 8601 date time
offset
integer
Position in pagination.
limit
integer
Number of items to retrieve (10000 max).
total
integer
Total number of items available.
iccid
string
Integrated Circuit Card Identifier.
imei
string
IMEI (International Mobile Equipment Identity) of the device.
imsi
string
International Mobile Subscriber Identifier of the device.
msisdn
string
Mobile Station International Subscriber Directory Number.
deviceProfileId
string
Device Profile ID assigned to the device.
endpointFQDN
string
Fully qualified domain name of the endpoint
ReportStatus
string
Report status
ScheduledReport
object
3 properties
ScheduledReportStatus
object
5 properties
Error
object
5 properties
Pagination
object
3 properties
EventSeverity
string
Severity of the Event
EventStatus
string
Status of the Event
EventType
string
Type of the Event
EventCategory
string
Category of the Event
EventConfigSuppressionPeriodType
string
EventDeviceGroup
object
3 properties
Event
object
42 properties
EventConfig
object
7 properties
EventSuppressionConfigCreateRequest
EventSuppressionConfigUpdateRequest
EventSuppressionConfigBase
object
9 properties
ConfigItem
object
2 properties
EventSuppressionTargetDevices
object
1 property
1 required
EventSuppressionMatchingTraffic
object
6 properties
EventConfigActivityLogQuery
EventPolicyActivityLogQuery
PagedEventPolicyActivityLog
PagedEventConfigActivityLog
EventsQueryRequest
object
24 properties
EventsUpdateRequest
object
Object representing an event update request.
5 properties
AggregateEventSecurityItem
string
Aggregate Event Security Item
AggregateEventAssessedSeverity
string
Aggregate Event Severity
AggregateEventRiskCategory
string
Aggregate Event Category
AggregatedEventsQueryRequest
object
3 properties
Field
object
2 properties
2 required
PagedSummaryTableData
object
2 properties
SummaryDataSchema
object
1 property
AccountDailyMetric
string
Supported daily metric names.
AccountDailyMetricsRequest
object
1 property
1 required
DeviceFlowFilter
object
Filter parameters for device-scoped flow aggregate queries. iccid is required to scope the query to a single device.
6 properties
1 required
MetricGroup
string
Selects which group of metrics to retrieve for the /devices/flow-aggregates/metrics/search endpoint. Each group maps to a fixed set of response fields: DATATRA…
DeviceMetricsChartRequest
DeviceIpFlowFilter
object
Filter parameters for device-scoped IP Flow Metrics queries. iccid is required to scope the query to a single device.
8 properties
1 required
DeepForensicsPagedBase
object
3 properties
DeviceMetricsChartResponse
object
Response for the device metrics chart endpoint. Contains all matching time-series rows; no pagination.
1 property
DeviceMetricsChartRow
object
One time-bucket row in the device metrics chart response. Only the fields corresponding to the requested metrics are populated; others are omitted.
9 properties
FlowAggregatesTableRow
object
Per-destination endpoint aggregate row, used by the Flow Aggregates table.
9 properties
DnsQueriesTableRow
object
10 properties
IpFlowMetricsTableRow
object
13 properties
deviceGroupId
integer
Device Group ID.
deviceId
integer
Internal Device ID.
Device
object
2 properties
2 required
DeviceImeiChange
object
8 properties
4 required
DeviceCustomField
object
Information about custom fields. Fill if deviceAssigningType = AUTOBYCUSTOMFIELDS, empty otherwise
2 properties
2 required
DeviceTACCodeInfo
object
6 properties
DeviceGroupAssigningType
string
assign type
DeviceGroupQueryRequest
object
Search for name, assign type and created time range (set to null if don't want to filter)
16 properties
DeviceGroupInfo
object
4 properties
DeviceGroupResourceBase
object
9 properties
DeviceGroupBase
object
18 properties
DeviceGroupActivityLog
object
5 properties
PagedDeviceGroupActivityLog
TACCodeSearchFilter
object
Optional filter body for searching TAC codes. All filters are optional; omit the body or send {} to retrieve all TAC codes for the account.
4 properties
TACCodeEntry
object
TAC code entry with device type metadata and total device count.
5 properties
TACCodeSummaryEntry
object
A name/count pair representing one category in a TAC code metric summary.
2 properties
TACCodeMetrics
object
Full TAC code distribution summary for the account.
4 properties
DeviceGroupActivityLogQuery
BaseActivityLogQueryRequest
object
3 properties
BaseActivityLog
object
4 properties
applicationId
integer
Application identifier
ApplicationBase
object
6 properties
ApplicationsQueryRequest
object
7 properties
ApplicationActivityLogQuery
PagedApplicationActivityLog
protectionPolicyId
integer
Protection Policy identifier
ProtectionPolicyBase
object
7 properties
ProtectionPolicyCreateRequest
ProtectionPolicyUpdateRequest
ProtectionPoliciesQueryRequest
object
8 properties
ProtectionPolicyActivityLogQuery
ProtectionPolicyActivityLog
PagedProtectionPolicyActivityLog
EventPolicyCreateResponse
object
1 property
EventPolicyCreateRequest
object
4 properties
3 required
EventPolicyUpdateRequest
object
4 properties
3 required
EventPolicySearchRequest
object
3 properties
EventPolicyResponse
object
10 properties
EventPolicySummaryResponse
object
10 properties
PagedEventPoliciesTable
object
5 properties
enforcementRuleId
integer
Enforcement Rule identifier
malwareProtectionLevel
string
enforcementRuleStatus
string
EnforcementRuleUpdateRequest
object
10 properties
5 required
EnforcementRuleCreateRequest
EnforcementRulesQueryRequest
object
8 properties
EnforcementRuleBase
object
4 properties
EnforcementRuleActivityLogQuery
EnforcementRuleActivityLog
ServiceConfigurationRequest
object
Service configuration input for create/update
6 properties
3 required
ServiceConfiguration
object
Service configuration in responses (includes server-generated fields)
7 properties
PagedEnforcementRuleActivityLog
LocationListType
string
Type of the location list
LocationListEntry
object
13 properties
LocationListResourceBase
object
5 properties
LocationListCreateRequest
LocationListUpdateRequest
LocationList
object
11 properties
LocationListSummary
object
9 properties
LocationListQueryRequest
object
3 properties
LocationListActivityLogQuery
PagedLocationListActivityLog
ServiceConfigurationActivityLogQuery
ServiceConfigurationActivityLog
PagedServiceConfigurationActivityLog
LocationListSuggestionRequest
object
5 properties
3 required
BlockedIPFlowsSearchRequest
object
25 properties
AllowedIPFlowsSearchRequest
object
20 properties
BlockedFlowsSearchRequest
object
26 properties
AllowedTrafficSearchRequest
object
21 properties
BlockedIPFlowData
object
28 properties
AllowedIPFlowData
object
24 properties
AllowedTrafficData
object
18 properties
AllowedTrafficUsageDetail
object
12 properties
BlockedFlowData
object
15 properties
BlockedFlowDetail
object
17 properties
SecurityReportAppendixRequest
object
21 properties
2 required
SecurityReportAppendixTrigger
object
2 properties
PagedSecurityReportAppendix
SecurityReportSummary
object
12 properties
12 required
SecurityReportDetail
object
2 properties
2 required
SecurityReportCategory
object
5 properties
5 required
SecurityReportSections
object
5 properties
5 required
SecurityReportSectionItem
object
3 properties
2 required
SecurityReportDeviceUsage
object
2 properties
2 required
SecurityReportEndpoint
object
2 properties
2 required
SecurityEventData
object
21 properties
18 required
EndpointData
object
5 properties
5 required
DeviceUsageData
object
3 properties
3 required
SectionsSummary
object
5 properties
5 required
SectionSummary
object
5 properties
5 required
TdsItem
object
5 properties
2 required
TrendData
object
Schema for a trend object.
4 properties
4 required
ExternalRateLimiterCreateRequest
object
2 properties
2 required
ExternalRateLimiterConfig
object
5 properties
5 required
ExternalRateLimiterUpdateRequest
object
5 properties
4 required
ExternalRateLimitersQueryRequest
object
2 properties
ExternalRateLimiterListResponse
object
1 property
RateLimiter
object
12 properties
upstreamRate
integer
Upstream rate in kbps.
upstreamBurstSize
integer
Upstream burst size in kbps.
downstreamRate
integer
Downstream rate in kbps.
downstreamBurstSize
integer
Downstream burst size in kbps.
The full machine-readable OpenAPI contract behind this narrative.