Documentation
PolicyCortex REST API Reference for Secure Multi-Cloud Governance
Comprehensive REST API for integrating PolicyCortex into your workflows and applications.
API Documentation: Quick Start & Installation
PolicyCortex API uses Bearer token authentication. Obtain your API key from the dashboard under Settings → API Keys.
API Scopes and Permissions
| Scope | Permissions | Description |
|---|---|---|
| policy:read | Read policies and rules | View policy configurations and status |
| policy:write | Create and modify policies | Deploy, update, and delete policies |
| scan:execute | Trigger compliance scans | Run on-demand security and compliance scans |
| report:read | Access reports and analytics | View compliance reports and metrics |
| admin:all | Full administrative access | Complete control over the platform |
Authentication Examplebash
# Using curl
curl -H "Authorization: Bearer your_api_key_here" \
-H "Content-Type: application/json" \
https://api.policycortex.com/v1/policies
# Using JavaScript fetch
fetch('https://api.policycortex.com/v1/policies', {
headers: {
'Authorization': 'Bearer your_api_key_here',
'Content-Type': 'application/json'
}
})Policies API
GET
/api/v1/policiesList all policiescurl -X GET "https://api.policycortex.com/v1/policies?limit=10&offset=0" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json"POST
/api/v1/policiesCreate a new policycurl -X POST "https://api.policycortex.com/v1/policies" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "enforce-ebs-encryption",
"description": "Ensure EBS volumes are encrypted",
"resource_type": "aws_ebs_volume",
"rules": [
{
"condition": "encrypted == false",
"action": "enforce",
"remediation": {
"type": "encrypt_volume",
"kms_key": "alias/aws/ebs"
}
}
],
"severity": "high",
"compliance_frameworks": ["soc2", "hipaa"]
}'