Universal programmatic access to the Companion Sentinel intelligence layer. Build self-healing SOC pipelines with 100% forensic transparency.
REST v1.0
Protocol
TLS 1.3
Encryption
Verified
Intelligence
RFC 6749
Standards
Access Control
All requests must be authenticated via a Personal Access Token (PAT). Generate your sandbox secrets in your dashboard.
Authentication Schema
Authorization: Bearer pat_***Service Limits
To ensure cluster stability, the Public API enforces a strictly monitored rate limit across all endpoints.
Request Ceiling120 Req / Min
Endpoint Catalog
GET
/v1/meRetrieve operator identity and status
GET
/v1/nodesList all active cluster nodes
GET
/v1/nodes/[id]Deep forensic node drill-down
GET
/v1/eventsGlobal security findings stream
GET
/v1/xdr/eventsAdvanced behavioral forensic stream
GET
/v1/xdr/policiesRetrieve the active industrial forensic sensor catalog
System Handshake
Operator Authentication
Review Carefully Before Executing In Your Terminal.
1curl -X GET "https://the-companion.com/api/v1/me" -H "Authorization: Bearer YOUR_PAT_TOKEN"
2# Status: Success
bash
Companion Sentinel Protocol ActiveCluster Synchronization
SDK Integration
Review Carefully Before Executing In Your Terminal.
1const fetchFleet = async () => {\n const res = await fetch('https://the-companion.com/api/v1/nodes', {\n headers: { 'Authorization': 'Bearer YOUR_PAT_TOKEN' }\n });\n return await res.json();\n};\n# Status: Verified.
Node.js
Companion Sentinel Protocol ActiveForensic Schema
Cluster Inventory
Review Carefully Before Executing In Your Terminal.
1{
2 "success": true,
3 "cluster_size": 1,
4 "nodes": [
5 {
6 "id": "node_779c6893",
7 "name": "prod-api-cluster",
8 "hardening_index": 98,
9 "last_pulse": "2025-12-28T17:42:09Z",
10 "ip_address": "1.2.3.4",
11 "os_distribution": "linux"
12 }
13 ]
14}
JSON
Companion Sentinel Protocol ActiveDeep Forensics
Node Detail (FIM/CIS/Malware)
Review Carefully Before Executing In Your Terminal.
1{
2 "success": true,
3 "node": {
4 "id": "node_779c6893",
5 "name": "prod-api-cluster",
6 "hardening_index": 98,
7 "last_heartbeat": "2025-12-28T17:42:09Z",
8 "ip_address": "1.2.3.4",
9 "os_info": {
10 "os": "linux",
11 "arch": "amd64"
12 },
13 "forensics": {
14 "kernel": "Go-Native",
15 "uptime": "Continuous",
16 "open_ports": "22,80,443",
17 "active_conns": "1.2.3.4:443->5.6.7.8:12345"
18 }
19 },
20 "recent_security_checks": [
21 {
22 "id": "check_992b",
23 "type": "firewall",
24 "domain": "hardening",
25 "status": "pass",
26 "details": {
27 "message": "UFW is active."
28 },
29 "last_updated": "2026-01-03T08:42:00Z"
30 }
31 ],
32 "timestamp": "2026-01-06T12:00:00Z"
33}
JSON
Companion Sentinel Protocol ActiveSensor Catalog
Active Policy Registry
Review Carefully Before Executing In Your Terminal.
1{
2 "success": true,
3 "node": "prod-api-cluster",
4 "timestamp": "2026-01-06T12:00:00Z",
5 "policies": [
6 {
7 "slug": "react2shell_rce",
8 "name": "React2Shell Exploit Detection",
9 "severity": "critical",
10 "category": "Application Exploitation",
11 "mitreId": "T1203"
12 }
13 ]
14}
JSON
Companion Sentinel Protocol ActiveBehavioral Forensics
XDR Event Stream (Malware/Ransomware)
Review Carefully Before Executing In Your Terminal.
1{
2 "success": true,
3 "event_count": 1,
4 "events": [
5 {
6 "id": "evt_992b",
7 "node_id": "node_779c",
8 "node_name": "prod-cluster-01",
9 "policy_slug": "ransomware_activity",
10 "policy_name": "Ransomware Encryption Pattern",
11 "severity": "critical",
12 "details": {
13 "message": "High-frequency file pattern deviation detected",
14 "process_details": "PID: 1234 | User: root | Cmd: ./encrypt_fleet"
15 },
16 "timestamp": "2026-01-06T12:42:00Z"
17 }
18 ]
19}
JSON
Companion Sentinel Protocol Active