7SIGNAL Platform API (Gateway v2)
The 7SIGNAL public REST API gateway. 215 operations across 32 tags covering authentication, users, roles, groups and organizations, API keys, Eyes (agents and sensors), locations, service areas, networks, access points, network keys, sensor targets and default configurations, time-series and KPI metrics, on-demand tests and packet capture, RF scans, impact metrics, agent incidents, alert rules and alert incidents, Meraki integration configs, audits and Eyeris AI analysis. OAuth 2.0 client-credentials authentication with 24-hour bearer tokens.
This API exposes 215 operations across 154 paths, organized into 32 resource areas, and defines 341 schemas. It is described by OpenAPI 3.0.3, at version 2.21.1.
Requests are made against a single base URL, https://api-v2.7signal.com.
215 operations
154 paths
341 schemas
23 DELETE128 GET7 PATCH39 POST18 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
7SIGNAL Platform API (Gateway v2) declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (oauth2) using the clientCredentials flow.
Paths & Operations 215
Across 154 paths, the API surfaces 215 operations — 23 DELETE, 128 GET, 7 PATCH, 39 POST, 18 PUT. They span 32 resource areas, including Authentication, Access, AccessPoints, Adapter Driver Report, API Keys, Audit, ChangeEvents, Clients, and 24 more. Each is listed below with its method, path, parameters, and response codes.
Authentication 1
POST
/oauth2/token
OAuth2 Token Endpoint
Access 1
GET
/access/{userId}/summary
List the access summary for the given user
AccessPoints 10
GET
/access-points/agents
List the Agent Access Points
POST
/access-points/agents
Creates one or many Agent Access Points
GET
/access-points/agents/{accessPointId}
Fetch the specified Access Point
PUT
/access-points/agents/{accessPointId}
Replace the specified Access Point with the details in the payload
PATCH
/access-points/agents/{accessPointId}
Update the specified Access Point with the details in the payload, name being required
DELETE
/access-points/agents/{accessPointId}
Delete the Access Point specified by the UUID
GET
/access-points/sensors
List the Sensor Access Points
GET
/access-points/sensors/{accessPointId}
Fetch the specified Sensor Access Point
PATCH
/access-points/sensors/{accessPointId}
Update the alias of the specified Access Point
DELETE
/access-points/sensors/{accessPointId}
Unbind the specified access point from its managing sensor
Adapter Driver Report 4
GET
/adapter-driver-report
Retrieve Adapter/Driver Report
GET
/adapter-driver-report/summary
Retrieve Adapter/Driver Report Summary
GET
/adapter-driver-report/org
Retrieve Adapter/Driver Report by Organization
GET
/adapter-driver-report/org/summary
Retrieve Adapter/Driver Report Summary by Organization
API Keys 4
GET
/apikeys
List all accessible ApiKeys, optionally filtered by permissions, ids, createdBys and organizationsIds
POST
/apikeys
Create an ApiKey and make it available for usage
GET
/apikeys/{apikeyId}
List the specific ApiKey identified by its UUID, and its associated Permissions
DELETE
/apikeys/{apikeyId}
Delete the ApiKey specified by the UUID
Audit 1
GET
/audit/agents
Agent Audit Entries
ChangeEvents 1
GET
/change-events/sensors
List the change events for the specified element
Clients 1
GET
/clients/sensors
List the Sensor Clients
DefaultConfigurations 2
GET
/default-configurations/sensors
List the Sensor Default Configurations
GET
/default-configurations/sensors/{configurationId}
Fetch the specified Sensor Default Configuration
Eyeris 3
POST
/eyeris/analysis/stream
Request Eyeris Analysis with Streaming Response
POST
/eyeris/agents/client-analysis
Request Eyeris Analysis
GET
/eyeris/agents/client-analysis/{requestId}
Request Eyeris Analysis Results
Eyes 16
GET
/eyes
Summary of Eyes
GET
/eyes/agents
List the Agent Eyes available
PATCH
/eyes/agents
Patch multiple Eye Agents
GET
/eyes/agents/search
Search for Agent Eyes
GET
/eyes/agents/{agentId}
Fetch the specified Eyes Agent
PATCH
/eyes/agents/{agentId}
Patch the specified Eyes Agent
DELETE
/eyes/agents/{agentId}
Delete an Eyes Agent
GET
/eyes/sensors
List the Sensor Eyes available
GET
/eyes/sensors/{sensorId}
Fetch the specified Eyes Sensor
PATCH
/eyes/sensors/{sensorId}
Patch the specified Eyes Sensor
GET
/eyes/sensors/{sensorId}/automated-testing
Get the status of automated test on Sensor
POST
/eyes/sensors/{sensorId}/automated-testing
Start or stopping automated test on Sensor
GET
/eyes/sensors/{sensorId}/packet-captures
List packet capture tests for sensor
GET
/eyes/sensors/{sensorId}/packet-captures/{testKey}/download
Download packet capture file
GET
/eyes/sensors/packet-captures
List packet capture tests across all sensors
POST
/eyes/sensors/registration
Register a new Eye Sensor
Groups 2
GET
/groups
List all accessible Groups
GET
/groups/{groupId}
Get a specific Group by UUID
Impact 5
GET
/impact/agents
Retrieve Agent Impact
GET
/impact/agents/by-status
Retrieve Agent Impact by Status
GET
/impact/agents/summary
Retrieve Agent Impact Summary
GET
/impact/agents/time-series
Retrieve Agent Impact Time Series
GET
/impact/locations
Retrieve Location Impact
Incidents 2
GET
/incidents/agents
List the Agent Incidents
GET
/incidents/agents/{incidentId}
Fetch the specified Agent Incident
Alert Rules 7
GET
/alerting/alert-rules
List alert rules
POST
/alerting/alert-rules
Create an alert rule
GET
/alerting/alert-rules/summary
Get an alert rules summary
GET
/alerting/alert-rules/{id}
Fetch the specified alert rule
PUT
/alerting/alert-rules/{id}
Replace an alert rule
DELETE
/alerting/alert-rules/{id}
Delete an alert rule
PATCH
/alerting/alert-rules/{id}/enabled
Enable or disable an alert rule
Incidents (Alerting) 5
GET
/alerting/incidents
List incidents
GET
/alerting/incidents/by-rule
List incidents aggregated by rule
GET
/alerting/incidents/summary
Get an incidents summary
GET
/alerting/incidents/{id}
Fetch the specified incident
POST
/alerting/incidents/{id}/resolve
Resolve an incident
KPIs 11
GET
/kpis/agentsdeprecated
Retrieve KPI data for all agents
GET
/kpis/agents/access-pointsdeprecated
Retrieve KPI data for all agents by access point
GET
/kpis/agents/adapter-driversdeprecated
Retrieve KPI data for all agents by adapter and driver
GET
/kpis/agents/locationsdeprecated
Retrieve KPI data for all agents by location
GET
/kpis/agents/client-capabilitiesdeprecated
Retrieve KPI data for all agents by client capabilities
GET
/kpis/sensors/organizationsdeprecated
Retrieve KPI data for all sensors by organization
GET
/kpis/sensors/access-points/{accessPointId}deprecated
Retrieve KPI data for all sensors by access point
GET
/kpis/sensors/dest-nw-band-loc/{targetId}deprecated
Retrieve KPI data for all sensors by destination, network, band, and location
GET
/kpis/sensors/locations/{locationId}deprecated
Retrieve KPI data for all sensors by location
GET
/kpis/sensors/eyes/{sensorId}deprecated
Retrieve KPI data for a specific sensor
GET
/kpis/sensors/service-areas/{serviceAreaId}deprecated
Retrieve KPI data for all sensors by service area
Integration Configs 11
GET
/integrations/meraki/configs
List all accessible meraki integration configurations
POST
/integrations/meraki/configs
Create a meraki integration configuration
GET
/integrations/meraki/configs/{id}
List the specific meraki integration configuration identified by its UUID
PUT
/integrations/meraki/configs/{id}
Replace the configurable parameters of a meraki integration configuration specified by its UUID
DELETE
/integrations/meraki/configs/{id}
Delete the meraki integration configuration specified by the UUID
GET
/integrations/servicenow/configs
List all accessible ServiceNow integration configurations
POST
/integrations/servicenow/configs
Create a ServiceNow integration configuration
GET
/integrations/servicenow/configs/{id}
List the specific ServiceNow integration configuration identified by its UUID
PUT
/integrations/servicenow/configs/{id}
Replace the configurable parameters of a ServiceNow integration configuration specified by its UUID
PATCH
/integrations/servicenow/configs/{id}
Patch the configurable parameters of a ServiceNow integration configuration specified by its UUID
DELETE
/integrations/servicenow/configs/{id}
Delete the ServiceNow integration configuration specified by the UUID
Locations 12
GET
/locations/agents
List the Agent Locations
POST
/locations/agents
Creates an Agent Location
GET
/locations/agents/{locationId}
Fetch the specified Agent Location
PUT
/locations/agents/{locationId}
Replace the specified Agent Location with the details in the payload
DELETE
/locations/agents/{locationId}
Delete the Agent Location specified by the UUID
GET
/locations/sensors
List the Sensor Locations
POST
/locations/sensors
Creates Sensor Locations
PUT
/locations/sensors
Updates Sensor Locations
DELETE
/locations/sensors
Deletes Sensor Locations
GET
/locations/sensors/{locationId}
Fetch the specified Sensor Location
PUT
/locations/sensors/{locationId}
Update the specified Sensor Location
DELETE
/locations/sensors/{locationId}
Delete the specified Sensor Location
Network Keys 6
GET
/network-keys/sensors
List the Sensor Network Keys
POST
/network-keys/sensors
Creates a Sensor Network Key
GET
/network-keys/sensors/templates
List the Sensor Network Key templates
GET
/network-keys/sensors/{networkKeyId}
Fetch the specified Sensor Network Key
PUT
/network-keys/sensors/{networkKeyId}
Replace the specified Sensor Network Key with the details in the payload
DELETE
/network-keys/sensors/{networkKeyId}
Delete the Sensor Network Key specified by the id
Networks 10
GET
/networks/agents
List the Agent Networks
POST
/networks/agents
Creates one or many Agent Networks
GET
/networks/agents/{networkId}
Fetch the specified Network
PUT
/networks/agents/{networkId}
Replace the specified Network with the details in the payload
DELETE
/networks/agents/{networkId}
Delete the Network specified by the UUID
GET
/networks/sensors
List the Sensor Networks
POST
/networks/sensors
Creates a Sensor Network
GET
/networks/sensors/{networkId}
Fetch the specified Sensor Network
PUT
/networks/sensors/{networkId}
Replace the specified Sensor Network with the details in the payload
DELETE
/networks/sensors/{networkId}
Delete the Sensor Network specified by the id
OnDemandTests 31
GET
/on-demand-tests/sensors/active-tests
List active on-demand tests
GET
/on-demand-tests/sensors/packet-capture
List packet capture tests
POST
/on-demand-tests/sensors/{sensorId}/packet-capture
Trigger packet capture test
GET
/on-demand-tests/sensors/{sensorId}/packet-capture/{testId}
Get packet capture status
GET
/on-demand-tests/sensors/{sensorId}/packet-capture/{testId}/download
Get packet capture file
POST
/on-demand-tests/sensors/{sensorId}/ping
Trigger ping test
GET
/on-demand-tests/sensors/{sensorId}/ping/{testId}
Get ping status
POST
/on-demand-tests/sensors/{sensorId}/ping-gateway
Trigger ping default gateway test
GET
/on-demand-tests/sensors/{sensorId}/ping-gateway/{testId}
Get ping default gateway status
POST
/on-demand-tests/sensors/{sensorId}/http-download
Trigger http download test
GET
/on-demand-tests/sensors/{sensorId}/http-download/{testId}
Get Http download status and results
POST
/on-demand-tests/sensors/{sensorId}/http-upload
Trigger http upload test
GET
/on-demand-tests/sensors/{sensorId}/http-upload/{testId}
Get Http upload status and results
POST
/on-demand-tests/sensors/{sensorId}/iperf3
Trigger iperf3 test
GET
/on-demand-tests/sensors/{sensorId}/iperf3/{testId}
Get Iperf3 status and results
POST
/on-demand-tests/sensors/{sensorId}/speedtest
Trigger speedtest
GET
/on-demand-tests/sensors/{sensorId}/speedtest/{testId}
Get speedtest status and results
POST
/on-demand-tests/sensors/{sensorId}/traceroute
Trigger Traceroute test
GET
/on-demand-tests/sensors/{sensorId}/traceroute/{testId}
Get traceroute test status and results
POST
/on-demand-tests/sensors/{sensorId}/mos
Trigger Mos/VoIP test
GET
/on-demand-tests/sensors/{sensorId}/mos/{testId}
Get Mos/VoIP test status and results
POST
/on-demand-tests/sensors/{sensorId}/udp-download
Trigger udp download test
GET
/on-demand-tests/sensors/{sensorId}/udp-download/{testId}
Get Udp download status and results
POST
/on-demand-tests/sensors/{sensorId}/udp-upload
Trigger udp upload test
GET
/on-demand-tests/sensors/{sensorId}/udp-upload/{testId}
Get Udp upload status and results
POST
/on-demand-tests/sensors/{sensorId}/tcp-download
Trigger tcp download test
GET
/on-demand-tests/sensors/{sensorId}/tcp-download/{testId}
Get Tcp download status and results
POST
/on-demand-tests/sensors/{sensorId}/tcp-upload
Trigger tcp upload test
GET
/on-demand-tests/sensors/{sensorId}/tcp-upload/{testId}
Get Tcp upload status and results
POST
/on-demand-tests/sensors/{sensorId}/web-download
Trigger web download test
GET
/on-demand-tests/sensors/{sensorId}/web-download/{testId}
Get Web download status and results
Organizations 3
GET
/organizations
List all accessible Organizations
GET
/organizations/{organizationId}
List the specific Organization identified by its UUID
GET
/organizations/{organizationId}/features
List all the features mapped to the Organization specified by the UUID
Permissions 2
GET
/permissions
List all accessible Permissions
GET
/permissions/{permissionId}
List the specific Permission identified by its UUID
Roles 2
GET
/roles
List all accessible Roles
GET
/roles/{roleId}
List the specific Role identified by its UUID
Scans 2
GET
/scans/agents
Retrieve scan data for an agent
GET
/scans/sensors
Retrieve scan data for a sensor
ServiceAreas 15
GET
/service-areas/agents
List the Agent Service Areas
POST
/service-areas/agents
Creates Agent Service Areas
PUT
/service-areas/agents
Updates Agent Service Areas
DELETE
/service-areas/agents
Deletes Agent Service Areas
GET
/service-areas/agents/{serviceAreaId}
Fetch the specified Agent Service Area
PUT
/service-areas/agents/{serviceAreaId}
Update the specified Agent Service Area
DELETE
/service-areas/agents/{serviceAreaId}
Delete the specified Agent Service Area
GET
/service-areas/sensors
List the Sensor Service Areas
POST
/service-areas/sensors
Creates a Sensor Service Area
GET
/service-areas/sensors/{serviceAreaId}
Fetch the specified Service Area
PUT
/service-areas/sensors/{serviceAreaId}
Update the specified Sensor Service Area
DELETE
/service-areas/sensors/{serviceAreaId}
Delete the specified Sensor Service Area
POST
/service-areas/sensors/{serviceAreaId}/eyes
Add Eyes to a service area
POST
/service-areas/sensors/{serviceAreaId}/networks/{networkId}
Bind a wireless network to a service area
DELETE
/service-areas/sensors/{serviceAreaId}/networks/{networkId}
Unbind a wireless network from a service area
Summaries 1
GET
/summaries/users
Gets the summary of the logged in user for the given organization or the primary organization if not specified.
Targets 5
GET
/targets/sensors
List the Sensor Targets
POST
/targets/sensors
Creates a Sensor Target
GET
/targets/sensors/{targetId}
Fetch the specified Sensor Target
PUT
/targets/sensors/{targetId}
Update the specified Sensor Target
DELETE
/targets/sensors/{targetId}
Delete the specified Sensor Target
TimeSeries 13
GET
/time-series/agents/discrete
Retrieve Time Series with discrete aggregation for agents
GET
/time-series/agents/discrete/{groupByDimension}
Retrieve Time Series with discrete aggregation for agents
GET
/time-series/agents/histogram/{groupByDimension}
Retrieve Time Series Histogram for agents
GET
/time-series/agents/numeric-summary/{groupByDimension}
Retrieve Time Series with numeric summary aggregation for agents
GET
/time-series/agents/numeric-summary
Retrieve Time Series with overall numeric summary aggregation for agents
GET
/time-series/agents/numeric
Retrieve Time Series with numeric aggregation for agents
GET
/time-series/agents/numeric/{groupByDimension}
Retrieve Time Series with numeric aggregation for agents
GET
/time-series/agents/metric-types
Retrieve details of all or a subset of the Metric Types
GET
/time-series/sensors/numeric-summary
Retrieve Time Series with overall numeric summary aggregation for sensors
GET
/time-series/sensors/numeric-summary/{groupByDimension}
Retrieve Time Series with numeric summary aggregation for sensors
GET
/time-series/sensors/numeric
Retrieve Time Series with numeric aggregation for sensors by organization
GET
/time-series/sensors/numeric/{groupByDimension}
Retrieve Time Series with numeric aggregation for sensors by the given grouping
GET
/time-series/sensors/metric-types
Retrieve details of all or a subset of the Metric Types
Topologies 8
GET
/topologies/agents/locationsdeprecated
List the Agent Topology Locations
GET
/topologies/agents/locations/{locationId}deprecated
Fetch the specified Topology Location
GET
/topologies/sensors/locationsdeprecated
List the Sensor Topology Locations
GET
/topologies/sensors/locations/{locationId}deprecated
Fetch the specified Topology Location
GET
/topologies/sensors/serviceAreasdeprecated
List the Sensor Topology Service Areas
GET
/topologies/sensors/serviceAreas/{serviceAreaId}deprecated
Fetch the specified Topology Service Area
GET
/topologies/sensors/accessPointsdeprecated
List the Sensor Topology Access Points
GET
/topologies/sensors/accessPoints/{accessPointId}deprecated
List the Sensor Topology Access Point
Users 18
GET
/users
List all accessible Users
POST
/users
Create a User in Metadata service and mark it as 'invited'. User info will be synchronized when the user logs into Auth0
GET
/users/{userId}
List the specific User identified by its UUID
DELETE
/users/{userId}
Delete the User specified by the UUID
GET
/users/{userId}/groups
List all the groups mapped to the User specified by the UUID
PUT
/users/{userId}/groups
Replace User mapping with one or more Groups in the given payload
POST
/users/{userId}/groups
Map User to one or more Groups
DELETE
/users/{userId}/groups/{groupId}
Unmap Group from the User
GET
/users/{userId}/organizations
List all the organizations mapped to the User specified by the UUID
PUT
/users/{userId}/organizations
Replace User mapping with one or more Organizations in the given payload
POST
/users/{userId}/organizations
Map User to one or more Organizations
DELETE
/users/{userId}/organization/{organizationId}
Unmap organization from the User
GET
/users/{userId}/permissions
List all the permissions(assigned via the role and directly) mapped to the User specified by the UUID
PUT
/users/{userId}/permissions
Replace User mapping with one or more Permissions in the given payload
POST
/users/{userId}/permissions
Map User to one or more Permissions
DELETE
/users/{userId}/permission/{permissionId}
Unmap Permission from the User
PUT
/users/{userId}/role
Update user's Role and Synchronize in Auth0
DELETE
/users/{userId}/role
Remove user's Role and Synchronize in Auth0
Schemas 341
The contract defines 341 schemas that model the data the API accepts and returns. The most detailed are network-keys.NetworkKey (54 properties), network-keys.PostNetworkKeyRequest (48 properties), eyes.EyesAgent (24 properties), on-demand-tests.PacketCaptureItem (22 properties). Each schema is shown below with its type and property counts.
oauth2.OAuth2AccessTokenResponse
object
5 properties
2 required
oauth2.OAuth2AccessTokenError
object
3 properties
1 required
metadata.AccessSummaryResponse
object
5 properties
metadata.SapphireApplication
object
2 properties
metadata.Instance
object
2 properties
metadata.MobileEyeApplication
object
2 properties
metadata.Organization
object
4 properties
metadata.UserManagementApplication
object
1 property
metadata.SapphireReDirectorApplication
object
1 property
metadata.UserNotifications
object
2 properties
common.ResponseStatusException
object
6 properties
5 required
access-points.GetAgentAccessPointsResponse
object
2 properties
access-points.AgentAccessPoint
object
9 properties
access-points.AgentAccessPointBssid
object
3 properties
common.Pagination
object
4 properties
4 required
access-points.PostAgentAccessPointsRequest
array
access-points.AgentAccessPointRequest
object
4 properties
access-points.AgentAccessPointBssidRequest
object
2 properties
access-points.GetAgentAccessPointResponse
access-points.GetSensorAccessPointsResponse
object
2 properties
access-points.SensorAccessPoint
object
15 properties
access-points.GetSensorAccessPointResponse
access-points.SensorAccessPointPatchRequest
object
1 property
adapter-driver-report.AdapterDriverReportListResponse
object
2 properties
adapter-driver-report.AdapterDriverEntry
object
7 properties
common.ZeroBasedPagination
object
4 properties
adapter-driver-report.AdapterDriverReportSummary
object
3 properties
metadata.PageModelApiKey
object
2 properties
metadata.ApiKey
object
8 properties
1 required
metadata.AggregateReferenceOrganizationUUID
object
1 property
metadata.AggregateReferenceGroupUUID
object
1 property
metadata.Pagination
object
4 properties
metadata.ApiKeyRequest
object
5 properties
1 required
metadata.ApiKeyResponse
object
10 properties
metadata.Permission
object
4 properties
audits.AuditsAgentsResponse
object
2 properties
audits.AuditAgentRecord
object
8 properties
change-events.GetChangeEventsSensorResponse
object
2 properties
change-events.ChangeEventsSensor
object
5 properties
clients.GetSensorClientsResponse
object
2 properties
clients.SensorClient
object
6 properties
common.Range
object
7 properties
7 required
default-configurations.GetSensorDefaultConfigurationsResponse
object
2 properties
default-configurations.SensorDefaultConfiguration
object
9 properties
default-configurations.GetSensorDefaultConfigurationResponse
eyeris.EyerisCreateStreamRequest
object
2 properties
eyeris.EyerisSseEmitter
array
eyeris.EyerisAnalysisRequest
object
4 properties
4 required
eyeris.EyerisAnalysisResponse
object
3 properties
eyeris.EyerisAnalysisRequestResponse
object
3 properties
eyes.SummaryResponse
object
2 properties
eyes.AgentsSummaryResponse
object
4 properties
2 required
eyes.AgentsLicenseSummary
object
4 properties
4 required
eyes.SensorsSummaryResponse
object
3 properties
eyes.GetEyesAgentsResponse
object
2 properties
eyes.EyesAgent
object
24 properties
eyes.PatchBatchEyesAgentRequest
array
eyes.PatchEyesAgentResponse
object
eyes.GetEyesAgentsSearchResponse
object
2 properties
eyes.EyesAgentSearch
object
9 properties
eyes.GetEyesAgentResponse
eyes.PatchEyesAgentRequest
object
2 properties
eyes.GetEyesSensorsResponse
object
2 properties
eyes.EyesSensor
object
20 properties
eyes.GetEyesSensorResponse
eyes.PatchEyesSensorRequest
object
1 property
eyes.EyesSensorAutomatedTestStatus
object
6 properties
eyes.EyesSensorAutomatedTestRequest
object
1 property
eyes.EyesSensorAutomatedTestResponse
object
2 properties
eyes.PacketCaptureListResponse
object
2 properties
eyes.PacketCaptureItem
object
18 properties
eyes.AssociatedAccessPoint
object
4 properties
eyes.RegistrationRequestBody
object
3 properties
eyes.RegistrationResponse
object
4 properties
metadata.PageModelGroup
object
2 properties
metadata.Group
object
5 properties
metadata.AggregateReferenceInstanceUUID
object
1 property
impact.GetAgentImpactResponse
object
2 properties
impact.AgentImpactRow
object
9 properties
impact.AgentSummary
object
8 properties
impact.GetAgentSummaryResponse
object
2 properties
impact.GetAgentTimeSeriesResponse
object
2 properties
impact.AgentTimeSeriesRow
object
9 properties
impact.GetLocationImpactResponse
object
2 properties
impact.LocationImpactRow
object
9 properties
incidents.GetIncidentsResponse
object
2 properties
incidents.NestedIncident
object
14 properties
incidents.GetIncidentResponse
incidents.FlatIncident
object
20 properties
alert-rules.GetAlertRulesResponse
object
2 properties
2 required
alert-rules.AlertRuleResponse
object
15 properties
alert-rules.Dimension
string
A dimension the metric can be grouped/keyed by
alert-rules.AggregationFunction
string
How matching samples are aggregated before the threshold comparison
alert-rules.ThresholdOperator
string
The comparison operator applied between the aggregated value and the threshold
alert-rules.MissingDataPolicy
string
How missing data is treated while evaluating the rule
alert-rules.NotificationConfig
object
1 property
1 required
alert-rules.Delivery
object
A single notification target, discriminated by kind
1 required
alert-rules.WebhookAuth
object
Authentication mode for a webhook delivery, discriminated by type. Credentials are referenced by Secrets Manager ARN; the secret value is never stored here.
1 required
alert-rules.WebhookFormat
string
Per-destination payload shape for a webhook delivery. Defaults to generic when omitted.
alert-rules.AlertRuleRequest
object
Body for creating (POST) or replacing (PUT) an alert rule. Enum fields use their wire values exactly as listed (e.g. "", "avg", "ignore" in lowercase), not the…
12 properties
5 required
alert-rules.AlertRulesSummary
object
3 properties
alert-rules.EnabledRequest
object
1 property
1 required
alert-incidents.GetIncidentsResponse
object
2 properties
2 required
alert-incidents.IncidentResponse
object
12 properties
alert-incidents.Dimension
string
A dimension the metric is grouped/keyed by
alert-incidents.ResolutionReason
string
Why an incident was resolved
alert-incidents.IncidentSnapshot
object
The rule configuration captured at the time the incident was raised
5 properties
alert-incidents.ThresholdOperator
string
alert-incidents.AggregationFunction
string
alert-incidents.GetIncidentsByRuleResponse
array
alert-incidents.IncidentByRuleResponse
object
4 properties
alert-incidents.IncidentsSummary
object
2 properties
kpis.GetAgentKPIsGlobalResponse
object
2 properties
kpis.AgentKPIGlobal
object
2 properties
kpis.AgentKPIType
object
4 properties
kpis.GetAgentKPIsAccessPointsResponse
object
2 properties
kpis.AgentKPIAccessPoint
object
3 properties
kpis.GetAgentKPIsAdapterDriversResponse
object
2 properties
kpis.AgentKPIAdapterDriver
object
4 properties
kpis.GetAgentKPIsLocationsResponse
object
2 properties
kpis.AgentKPILocation
object
4 properties
kpis.GetAgentKPIsClientCapabilitiesResponse
object
2 properties
kpis.AgentKPIClientCapability
object
8 properties
kpis.GetSensorsKPIsTopologiesResponse
object
2 properties
kpis.KPITopology
object
12 properties
metadata.PageModelMerakiIntegrationConfig
object
2 properties
metadata.MerakiIntegrationConfig
object
11 properties
metadata.AggregateReferenceApiKeyUUID
object
1 property
metadata.MerakiIntegrationConfigRequest
object
10 properties
3 required
metadata.MerakiIntegrationConfigResponse
object
16 properties
metadata.MerakiIntegrationConfigPutRequest
object
7 properties
2 required
locations.GetAgentLocationsResponse
object
2 properties
locations.AgentLocationResponse
object
4 properties
locations.AgentLocationRequest
object
2 properties
locations.GetAgentLocationResponse
object
6 properties
service-areas.AgentServiceArea
object
6 properties
locations.GetSensorLocationsResponse
object
2 properties
locations.SensorLocation
object
9 properties
locations.CountryCodeName
string
A CountryCode enum constant name. The ISO 3166-1 alpha-2 code (e.g. "US") is also accepted on write, case-insensitively, but is not reflected in this enum list
locations.TimeZoneId
string
A valid TimeZone identifier
locations.PostSensorLocationsRequest
object
1 property
locations.SensorCreateLocationRequest
object
6 properties
locations.PutSensorLocationsRequest
object
1 property
locations.SensorUpdateLocationRequest
object
6 properties
locations.GetSensorLocationResponse
locations.SensorSingleUpdateLocationRequest
object
5 properties
network-keys.GetNetworkKeysResponse
object
2 properties
network-keys.NetworkKey
object
The set of properties present depends on the key's type - every type is now documented: WPA1/WPA2 (WPA-PSK), WPA3, WPA3OWE, WPAEAP (all 7 eapMethod variants),…
54 properties
network-keys.NetworkKeyType
string
Determines which other fields are meaningful on a NetworkKey/NetworkKeyRequest. Every value is now documented with request/response fields and examples.
network-keys.CustomFieldEntry
object
3 properties
network-keys.EapMethod
string
Determines which WPAEAP or IEEE8021X request shape applies - see the request examples for each. IEEE8021X only supports 5 of these 7 values - EAPPSK and EAPFAS…
network-keys.WpaVersion
string
The WPA generation a WPAEAP key is used with - distinct from the top-level 'type' WPA1/WPA2/WPA3 values, which instead select a WPA-PSK request shape.
network-keys.EapolVersion
string
Optional on every WPAEAP variant.
network-keys.CertificateFile
object
A certificate/private-key/PAC file. certificateBytes is the raw file content, base64-encoded.
2 properties
network-keys.CertificateType
string
OPENHTTP and HTTPAUTHENTICATION only - PEM vs DER for clientCertificate/privateKey. Required whenever the corresponding certificate is provided; there's no saf…
network-keys.SecureProtocol
string
HTTPAUTHENTICATION only - optional, defaults to AUTOMATIC when omitted
network-keys.HttpAuthenticationPage
object
HTTPAUTHENTICATION only - one step in a multi-step login/logout sequence. Configurator's own UI keys pages by a page number, but that number is purely a transi…
1 property
network-keys.HttpAuthenticationField
object
2 properties
network-keys.ScepKeySize
string
WPAEAPSCEP only - RSA key size for the Eye-generated keypair. Optional, defaults to RSA2048 when omitted.
network-keys.PEAPLabel
string
EAPPEAP only (WPAEAP or IEEE8021X) - optional, defaults to CLIENTEAPENCRYPTION when omitted
network-keys.PEAPVersion
string
EAPPEAP only (WPAEAP or IEEE8021X) - optional, defaults to V0 when omitted
network-keys.PEAPInnerAuthenticationMethod
string
EAPPEAP only (WPAEAP or IEEE8021X) - the caCertificate/clientCertificate/privateKey/privateKeyPassword fields on PeapInnerAuthentication only apply when this i…
network-keys.InnerAuthenticationMethod
string
EAPTTLS only (WPAEAP or IEEE8021X) - a separate, larger enum than PEAP's own PEAPInnerAuthenticationMethod. The caCertificate/clientCertificate/privateKey/priv…
network-keys.TlsVersion
string
EAPFAST only - optional, defaults to TLS10 when omitted or explicitly ANY
network-keys.PostNetworkKeyRequest
object
Request shape is resolved from 'type' (and, for WPAEAP/IEEE8021X, further resolved from 'eapMethod') - see their own descriptions for which values are document…
48 properties
2 required
network-keys.CertificateProperties
object
EAPTLS only (WPAEAP or IEEE8021X) - the outer "Certificate Properties" panel. All fields optional; omitting the whole object, or any certificate within it, on…
4 properties
network-keys.PeapInnerAuthentication
object
EAPPEAP only (WPAEAP or IEEE8021X) - the "Inner Authentication" panel. caCertificate/clientCertificate/privateKey/privateKeyPassword only apply when method is…
5 properties
network-keys.TtlsInnerAuthentication
object
EAPTTLS only (WPAEAP or IEEE8021X) - the "Inner Authentication" panel. caCertificate/clientCertificate/privateKey/privateKeyPassword only apply when method is…
5 properties
network-keys.GetNetworkKeyResponse
network-keys.PutNetworkKeyRequest
networks.GetAgentNetworksResponse
object
2 properties
networks.AgentNetwork
object
5 properties
networks.PostAgentNetworksRequest
array
networks.AgentNetworkRequest
object
2 properties
networks.GetAgentNetworkResponse
networks.GetSensorNetworksResponse
object
2 properties
networks.SensorNetwork
object
14 properties
networks.PostSensorNetworkRequest
object
3 properties
2 required
networks.GetSensorNetworkResponse
networks.PutSensorNetworkRequest
object
13 properties
10 required
on-demand-tests.ActiveTestsListResponse
object
2 properties
on-demand-tests.ActiveTestsItem
object
19 properties
on-demand-tests.PacketCaptureListResponse
object
2 properties
on-demand-tests.PacketCaptureItem
object
22 properties
on-demand-tests.PacketCaptureTestRequest
object
6 properties
2 required
on-demand-tests.OnDemandTestResponse
object
2 properties
on-demand-tests.PacketCaptureTestStatusResponse
on-demand-tests.OnDemandTestStatusBase
object
5 properties
2 required
on-demand-tests.PingTestRequest
on-demand-tests.ActiveTestRequest
on-demand-tests.ActiveTestRequestBase
object
5 properties
2 required
on-demand-tests.IpAddressSettings
object
IP addressing configuration used during the test
9 properties
1 required
on-demand-tests.PingTestEndpointSettings
Ping-specific endpoint settings (testPort is not externally configurable)
on-demand-tests.TestEndpointSettings
object
Base endpoint configuration for active tests
4 properties
on-demand-tests.QosCategoryInRequest
object
QoS configuration for the test traffic
1 property
on-demand-tests.PingTestStatusResponse
on-demand-tests.PingTestResults
on-demand-tests.NetworkAttachResultsBase
object
4 properties
on-demand-tests.PingResultsEntry
object
3 properties
on-demand-tests.PingGatewayTestRequest
on-demand-tests.HttpTestRequest
on-demand-tests.HttpDownloadTestStatusResponse
on-demand-tests.HttpDownloadTestResults
on-demand-tests.HttpResultsEntry
object
3 properties
on-demand-tests.HttpUploadTestStatusResponse
on-demand-tests.HttpUploadTestResults
on-demand-tests.Iperf3TestRequest
on-demand-tests.Iperf3TestStatusResponse
on-demand-tests.Iperf3TestResults
object
3 properties
on-demand-tests.SpeedtestRequest
on-demand-tests.SpeedtestStatusResponse
on-demand-tests.SpeedtestResults
object
7 properties
on-demand-tests.SpeedtestAttribution
object
1 property
on-demand-tests.SpeedtestTransfer
object
9 properties
on-demand-tests.SpeedtestPing
object
7 properties
on-demand-tests.SpeedtestInterface
object
5 properties
on-demand-tests.SpeedtestServerCandidate
object
7 properties
on-demand-tests.TracerouteTestRequest
on-demand-tests.TracerouteTestStatusResponse
on-demand-tests.TracerouteTestResults
on-demand-tests.TraceRouteResultsEntry
object
4 properties
on-demand-tests.MosTestRequest
on-demand-tests.MosTestSender
object
Sender configuration (no IP or port exposure)
4 properties
on-demand-tests.MosTestReceiver
object
Receiver configuration
5 properties
on-demand-tests.MosTestStatusResponse
on-demand-tests.MosTestResults
on-demand-tests.MosResultsEntry
object
MOS measurement results for a sampling interval
6 properties
on-demand-tests.UdpDownloadTestRequest
on-demand-tests.UdpTestRequest
on-demand-tests.UdpDownloadTestStatusResponse
on-demand-tests.UdpDownloadTestResults
on-demand-tests.UdpResultsEntry
object
5 properties
on-demand-tests.UdpUploadTestRequest
on-demand-tests.UdpUploadTestStatusResponse
on-demand-tests.UdpUploadTestResults
on-demand-tests.TcpDownloadTestRequest
on-demand-tests.TcpTestRequest
on-demand-tests.TcpDownloadTestStatusResponse
on-demand-tests.TcpDownloadTestResults
on-demand-tests.TcpResultsEntry
object
4 properties
on-demand-tests.TcpUploadTestRequest
on-demand-tests.TcpUploadTestStatusResponse
on-demand-tests.TcpUploadTestResults
on-demand-tests.WebDownloadTestRequest
on-demand-tests.ActiveTestRequestWithDns
on-demand-tests.IpAddressSettingsWithDns
on-demand-tests.WebDownloadTestStatusResponse
on-demand-tests.WebDownloadTestResults
on-demand-tests.WebDownloadResultsEntry
object
3 properties
metadata.PageModelOrganization
object
2 properties
metadata.PageModelFeature
object
2 properties
metadata.Feature
object
3 properties
metadata.PageModelPermission
object
2 properties
metadata.PageModelRole
object
2 properties
metadata.Role
object
5 properties
1 required
metadata.RoleResponse
object
6 properties
scans.AgentsScanDataResponse
object
2 properties
scans.AgentScanTimestamp
object
5 properties
scans.AgentScanAp
object
16 properties
scans.SensorsScanDataResponse
object
2 properties
scans.SensorScanTimestamp
object
2 properties
scans.SensorScanAp
object
9 properties
service-areas.GetAgentServiceAreasResponse
object
2 properties
service-areas.PostAgentServiceAreasRequest
object
1 property
service-areas.AgentCreateServiceAreaRequest
object
2 properties
service-areas.PutAgentServiceAreasRequest
object
1 property
service-areas.AgentUpdateServiceAreaRequest
object
3 properties
service-areas.GetAgentServiceAreaResponse
service-areas.AgentSingleUpdateServiceAreaRequest
object
2 properties
service-areas.GetSensorServiceAreasResponse
object
2 properties
service-areas.SensorServiceArea
object
9 properties
service-areas.PostSensorServiceAreaRequest
object
5 properties
service-areas.GetSensorServiceAreaResponse
service-areas.PutSensorServiceAreaRequest
object
6 properties
service-areas.PostSensorServiceAreaSensorsRequest
object
1 property
metadata.PageModelServiceNowIntegrationConfig
object
2 properties
metadata.ServiceNowIntegrationConfig
object
9 properties
metadata.AggregateReferenceOrganization
object
2 properties
metadata.ServiceNowIntegrationConfigCreateRequest
object
9 properties
3 required
metadata.ServiceNowIntegrationConfigWithOrgId
object
9 properties
metadata.ServiceNowIntegrationConfigUpdateRequest
object
8 properties
2 required
metadata.ServiceNowIntegrationConfigPatchRequest
object
8 properties
summaries.UserSummaryResponse
object
3 properties
targets.GetSensorTargetsResponse
object
2 properties
targets.SensorTarget
object
8 properties
targets.PostSensorTargetRequest
object
7 properties
targets.GetSensorTargetResponse
targets.PutSensorTargetRequest
object
6 properties
time-series.GetAgentTimeSeriesDiscreteResponse
object
2 properties
time-series.AgentTimeSeriesDiscrete
object
1 property
time-series.MetricDiscreteAggregatesType
object
2 properties
time-series.TimeSeriesDiscreteType
object
3 properties
time-series.GetAgentTimeSeriesDiscreteGroupByResponse
object
2 properties
time-series.AgentTimeSeriesDiscreteGroupBy
object
12 properties
time-series.AgentDriverType
object
2 properties
time-series.GetAgentTimeSeriesHistogramResponse
object
1 property
time-series.AgentTimeSeriesHistogram
object
2 properties
time-series.AgentBinsType
object
3 properties
time-series.GetAgentTimeSeriesNumericSummaryResponse
object
2 properties
time-series.AgentTimeSeriesNumericSummary
object
20 properties
time-series.GetAgentTimeSeriesOverallNumericSummaryResponse
object
2 properties
time-series.AgentTimeSeriesOverallNumericSummary
object
9 properties
time-series.GetAgentTimeSeriesNumericResponse
object
2 properties
time-series.AgentTimeSeriesNumeric
object
1 property
time-series.MetricNumericAggregatesType
object
11 properties
time-series.TimeSeriesNumericType
object
8 properties
time-series.GetAgentTimeSeriesNumericGroupByResponse
object
2 properties
time-series.AgentTimeSeriesNumericGroupBy
object
12 properties
time-series.GetAgentTimeSeriesMetricTypesResponse
object
Map of metric identifiers to AgentMetricType objects
time-series.AgentMetricType
object
3 properties
time-series.GetSensorTimeSeriesOverallNumericSummaryResponse
object
2 properties
time-series.SensorTimeSeriesOverallNumericSummary
object
7 properties
time-series.GetSensorTimeSeriesNumericSummaryResponse
object
2 properties
time-series.SensorTimeSeriesNumericSummary
object
20 properties
time-series.GetSensorsTimeSeriesNumericResponse
object
2 properties
time-series.SensorTimeSeriesNumeric
object
1 property
time-series.GetSensorsTimeSeriesNumericGroupByResponse
object
2 properties
time-series.SensorTimeSeriesNumericGroupBy
object
14 properties
time-series.GetSensorTimeSeriesMetricTypesResponse
object
Map of metric identifiers to SensorMetricType objects
time-series.SensorMetricType
object
5 properties
topologies.GetAgentTopologyLocationsResponse
object
2 properties
topologies.TopologyAgentLocation
object
5 properties
topologies.GetAgentTopologyLocationResponse
topologies.GetSensorTopologyLocationsResponse
object
2 properties
topologies.TopologySensorLocation
object
4 properties
topologies.GetSensorTopologyLocationResponse
topologies.GetSensorTopologyServiceAreasResponse
object
2 properties
topologies.TopologySensorServiceArea
object
5 properties
topologies.GetSensorTopologyServiceAreaResponse
metadata.PageModelUser
object
2 properties
metadata.User
object
7 properties
metadata.AggregateReferenceRoleUUID
object
1 property
metadata.UserRequest
object
7 properties
2 required
metadata.UserResponse
object
10 properties
metadata.UserOrganization
object
5 properties
metadata.UsersGroupsRequest
object
1 property
1 required
metadata.PageModelUserOrganization
object
2 properties
metadata.OrganizationsUsersRequest
object
1 property
1 required
metadata.OrganizationInfo
object
2 properties
1 required
metadata.UsersPermissionsRequest
object
2 properties
metadata.UsersRoleRequest
object
1 property
1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
#Wireless Network Monitoring#Wi-Fi Experience Monitoring#Network Performance Monitoring#Time Series#Endpoint Monitoring#AIOps
Where this information came from
This is an independent, third-party profile of 7SIGNAL Platform API (Gateway v2), published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.