Overview:
Guardz Open API enables admin users (of all Guardz plans) to programmatically access security and usage data, allowing seamless integration with existing tools such as PSA, SIEM, and billing systems.
What can you do with the Open API?
Receive security alerts (Incidents & Posture Issues)
Query historical data via REST APIs
Access usage data for billing and reconciliation
Key Components:
1. Security Alerts API
Provides full access to security events:
Retrieve incidents (e.g., malware, impossible travel, credential exploitation)
Query posture issues across your tenants
Get real-time alerts via webhooks
2. Usage Reporting API
Access tenant-level usage data:
Active seats
Plan type and status
Commitment (monthly / yearly)
Daily or monthly reporting for billing automation
3. Additional Endpoints
Get tenants
Users
Getting Started
Generate your API key via Guardz portal
Go to 'Organization Setting'
Go to the 'API' section
Click on 'Create API Key'
Provide the key with a name
Select the expiry date
Click 'Create': this creates your api key which is visible only once
(Generated keys can be rotated as needed)
Explore the API documentation
Review the documentation via this link
Click on 'Authorize'
Insert your API key
Create your API requests:
Select the desired endpoint
Click on 'Try it out' near the relevant record
Insert relevant values according to your business and technical needs
click on 'Execute'
Review the response body
Please note:
Each API key is limited to 300 requests per 60-second window. When the budget is exhausted the API responds with 429 Too Many Requests and a Retry-After header indicating when the next request will be accepted.