{ "openapi": "3.0.2", "info": { "title": "Zeah DomainGuard Monitor API", "version": "1.2.0", "description": "Continuous external attack-surface and security-posture monitoring. Save public domains, establish baselines, retain scan history, detect meaningful control or Surface Map drift, configure signed HTTPS webhooks, and generate white-label portfolio reports. Includes guided/staged remediation planning, explicit approval, applied-state tracking, independent rescan verification, and remediation audit history." }, "servers": [ { "url": "https://api.zeah.ai" } ], "components": { "securitySchemes": { "DomainGuardKey": { "type": "apiKey", "in": "header", "name": "X-DomainGuard-Key" }, "MonitorSession": { "type": "apiKey", "in": "cookie", "name": "dg_monitor_session", "description": "HttpOnly browser session created by the claim or session-login endpoint." } }, "schemas": { "DomainCreate": { "type": "object", "required": [ "domain" ], "properties": { "domain": { "type": "string", "example": "example.com" }, "label": { "type": "string", "example": "Example Client" } } }, "Branding": { "type": "object", "properties": { "brand_name": { "type": "string" }, "report_title": { "type": "string" }, "report_footer": { "type": "string" } } }, "Webhook": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "nullable": true, "example": "https://example.com/webhooks/domainguard" } } } } }, "paths": { "/api/public/domain-monitor/plans": { "get": { "summary": "List service plan limits", "responses": { "200": { "description": "Plan limits" } } } }, "/api/public/domain-monitor/claim": { "post": { "summary": "Claim a one-time Monitor invitation", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "invite" ], "properties": { "invite": { "type": "string" } } } } } }, "responses": { "200": { "description": "Invitation claimed; a Secure HttpOnly browser session cookie is set. No API key is exposed by the browser claim flow." }, "400": { "description": "Invalid, expired, or used invite" } } } }, "/api/public/domain-monitor/status": { "get": { "summary": "Get account and scheduler status", "security": [ { "DomainGuardKey": [] }, { "MonitorSession": [] } ], "responses": { "200": { "description": "Account status" }, "401": { "description": "Invalid customer key" } } } }, "/api/public/domain-monitor/domains": { "get": { "summary": "List monitored domains", "security": [ { "DomainGuardKey": [] }, { "MonitorSession": [] } ], "responses": { "200": { "description": "Domain list" } } }, "post": { "summary": "Add a domain and create its baseline", "security": [ { "DomainGuardKey": [] }, { "MonitorSession": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DomainCreate" } } } }, "responses": { "200": { "description": "Domain added and baseline scanned" }, "400": { "description": "Invalid domain or plan limit reached" } } } }, "/api/public/domain-monitor/domains/{domain_id}": { "parameters": [ { "name": "domain_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "get": { "summary": "Get a monitored domain", "security": [ { "DomainGuardKey": [] }, { "MonitorSession": [] } ], "responses": { "200": { "description": "Domain detail" }, "404": { "description": "Not found" } } }, "delete": { "summary": "Stop monitoring a domain", "security": [ { "DomainGuardKey": [] }, { "MonitorSession": [] } ], "responses": { "200": { "description": "Deleted" }, "404": { "description": "Not found" } } }, "put": { "summary": "Update a monitored domain", "description": "Pause/resume monitoring or update the customer label. Resuming schedules an immediate scan.", "security": [ { "DomainGuardKey": [] }, { "MonitorSession": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "label": { "type": "string", "nullable": true }, "enabled": { "type": "boolean" } } } } } }, "responses": { "200": { "description": "Updated domain state" }, "400": { "description": "Invalid update" }, "404": { "description": "Domain not found" } } } }, "/api/public/domain-monitor/domains/{domain_id}/scan": { "parameters": [ { "name": "domain_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "post": { "summary": "Trigger a manual scan", "security": [ { "DomainGuardKey": [] }, { "MonitorSession": [] } ], "responses": { "200": { "description": "Scan result and detected changes" }, "429": { "description": "Manual scan rate limited" } } } }, "/api/public/domain-monitor/domains/{domain_id}/scans": { "parameters": [ { "name": "domain_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 30, "minimum": 1, "maximum": 100 } } ], "get": { "summary": "Read scan history", "security": [ { "DomainGuardKey": [] }, { "MonitorSession": [] } ], "responses": { "200": { "description": "Scan history" } } } }, "/api/public/domain-monitor/events": { "get": { "summary": "Read recent monitoring events", "security": [ { "DomainGuardKey": [] }, { "MonitorSession": [] } ], "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 100, "minimum": 1, "maximum": 250 } } ], "responses": { "200": { "description": "Event timeline" } } } }, "/api/public/domain-monitor/report": { "get": { "summary": "Generate white-label portfolio report data", "security": [ { "DomainGuardKey": [] }, { "MonitorSession": [] } ], "responses": { "200": { "description": "Portfolio summary, domains, common failures, and recent events" } } } }, "/api/public/domain-monitor/export.csv": { "get": { "summary": "Export domain portfolio as CSV", "security": [ { "DomainGuardKey": [] }, { "MonitorSession": [] } ], "responses": { "200": { "description": "CSV export", "content": { "text/csv": {} } } } } }, "/api/public/domain-monitor/branding": { "put": { "summary": "Update report branding", "security": [ { "DomainGuardKey": [] }, { "MonitorSession": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Branding" } } } }, "responses": { "200": { "description": "Branding updated" } } } }, "/api/public/domain-monitor/webhook": { "put": { "summary": "Set or clear the HTTPS change-alert webhook", "security": [ { "DomainGuardKey": [] }, { "MonitorSession": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Webhook" } } } }, "responses": { "200": { "description": "Webhook setting updated" }, "400": { "description": "Webhook must resolve to a public HTTPS target" } }, "description": "Sets an HTTPS/public-IP webhook destination. Deliveries include X-DomainGuard-Timestamp and X-DomainGuard-Signature (HMAC-SHA256). Failed deliveries are retried with backoff." } }, "/api/public/domain-monitor/webhook/test": { "post": { "summary": "Send a test webhook", "security": [ { "DomainGuardKey": [] }, { "MonitorSession": [] } ], "responses": { "200": { "description": "Delivery result" } } } }, "/api/public/domain-monitor/session": { "post": { "summary": "Exchange a Monitor API key for a browser session", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "api_key" ], "properties": { "api_key": { "type": "string" } } } } } }, "responses": { "200": { "description": "Authenticated; Secure HttpOnly browser session cookie set" }, "401": { "description": "Invalid API key" } } } }, "/api/public/domain-monitor/session/logout": { "post": { "summary": "Revoke the current browser session", "security": [ { "MonitorSession": [] } ], "responses": { "200": { "description": "Signed out and cookie cleared" } } } }, "/api/public/domain-monitor/api-key/rotate": { "post": { "summary": "Generate a new programmatic API key", "description": "Invalidates the previous programmatic API key immediately. Browser sessions remain valid. The new key is returned once.", "security": [ { "DomainGuardKey": [] }, { "MonitorSession": [] } ], "responses": { "200": { "description": "New API key returned once" }, "401": { "description": "Authentication required" } } } }, "/api/public/domain-monitor/webhook/signing-secret": { "get": { "summary": "Get the account webhook verification secret", "description": "Returns the stable per-account secret used to verify DomainGuard webhook HMAC signatures. Treat this value as sensitive.", "security": [ { "DomainGuardKey": [] }, { "MonitorSession": [] } ], "responses": { "200": { "description": "Verification secret and signature format" }, "401": { "description": "Authentication required" } } } }, "/api/public/domain-monitor/remediations": { "get": { "summary": "List remediation work", "security": [ { "cookieAuth": [] }, { "apiKeyAuth": [] } ], "responses": { "200": { "description": "Remediation plans and verified work for the authenticated workspace" }, "401": { "description": "Authentication required" } } } }, "/api/public/domain-monitor/domains/{domain_id}/remediations": { "post": { "summary": "Create a remediation plan for a failed control", "security": [ { "cookieAuth": [] }, { "apiKeyAuth": [] } ], "parameters": [ { "name": "domain_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "control" ], "properties": { "control": { "type": "string" } } } } } }, "responses": { "200": { "description": "Existing or newly-created remediation plan" }, "400": { "description": "Control is passing, unknown, or invalid" }, "401": { "description": "Authentication required" } } } }, "/api/public/domain-monitor/remediations/{remediation_id}/approve": { "post": { "summary": "Approve a remediation plan", "security": [ { "cookieAuth": [] }, { "apiKeyAuth": [] } ], "parameters": [ { "name": "remediation_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Updated remediation state" }, "400": { "description": "Invalid remediation state" }, "401": { "description": "Authentication required" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "note": { "type": "string", "maxLength": 500 } } } } } } } }, "/api/public/domain-monitor/remediations/{remediation_id}/applied": { "post": { "summary": "Mark an approved remediation as applied", "security": [ { "cookieAuth": [] }, { "apiKeyAuth": [] } ], "parameters": [ { "name": "remediation_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Updated remediation state" }, "400": { "description": "Invalid remediation state" }, "401": { "description": "Authentication required" } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "note": { "type": "string", "maxLength": 500 } } } } } } } }, "/api/public/domain-monitor/remediations/{remediation_id}/verify": { "post": { "summary": "Rescan and verify an applied remediation", "security": [ { "cookieAuth": [] }, { "apiKeyAuth": [] } ], "parameters": [ { "name": "remediation_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Updated remediation state" }, "400": { "description": "Invalid remediation state" }, "401": { "description": "Authentication required" } } } }, "/api/public/domain-monitor/remediations/{remediation_id}/cancel": { "post": { "summary": "Cancel an open remediation plan", "security": [ { "cookieAuth": [] }, { "apiKeyAuth": [] } ], "parameters": [ { "name": "remediation_id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Updated remediation state" }, "400": { "description": "Invalid remediation state" }, "401": { "description": "Authentication required" } } } } } }