API Overview
The Veltrix Policy-as-Code Security API enables you to programmatically interact with our security automation platform. With this RESTful API, you can integrate security configuration management, version control for security, and security orchestration directly into your existing applications, CI/CD pipelines, and infrastructure as code (IaC) workflows.
Our API follows modern design principles, with JSON-formatted requests and responses, HTTP authentication, and predictable resource-oriented URLs.
Fig 1: Policy-as-Code Security API Integration Architecture with DevSecOps Automation Components
Key Features
- RESTful endpoints for all platform operations
- Policy-as-code implementation and validation
- Security configuration management automation
- Version control for security configurations
- Security approval workflow integration
- CI/CD pipeline security integration
- Comprehensive error handling
- Rate limiting with clear headers
Use Cases
- Automate security configuration across deployments
- Integrate security scanning into deployment pipelines
- Build custom dashboards with security telemetry
- Implement infrastructure security posture validation
- Create custom security approval workflows
- Automate compliance reporting
- Build zero trust architecture systems
- Implement automated threat detection
Getting Started
Authentication
All API requests require authentication using API keys. You can create and manage your API keys in the Veltrix dashboard under Settings > API Keys.
API Key Authentication
curl https://api.veltrixsecops.com/v1/configurations \
-H "Authorization: Bearer YOUR_API_KEY"Making Your First Request
Let's start by retrieving your security configurations:
Request
curl https://api.veltrixsecops.com/v1/configurations \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json"Response
{
"data": [
{
"id": "cfg_12345",
"name": "Firewall Rules",
"description": "Production environment firewall configuration",
"version": 3,
"last_updated": "2025-03-15T14:23:45Z",
"status": "active",
"compliance_status": {
"is_compliant": true,
"frameworks": ["SOC2", "ISO27001"]
}
},
{
"id": "cfg_67890",
"name": "IAM Policies",
"description": "Identity and access management policies",
"version": 7,
"last_updated": "2025-03-28T09:12:32Z",
"status": "pending_approval",
"compliance_status": {
"is_compliant": false,
"frameworks": ["SOC2"],
"issues": [
{
"code": "IAM-007",
"severity": "high",
"description": "Overly permissive access policy detected"
}
]
}
}
],
"pagination": {
"total": 24,
"per_page": 10,
"current_page": 1,
"total_pages": 3
}
}API Reference
Configurations
Manage your security configurations with version control for security and policy-as-code security implementation.
| Endpoint | Method | Description |
|---|---|---|
| /v1/configurations | GET | List all security configurations |
| /v1/configurations/{id} | GET | Get a specific configuration |
| /v1/configurations | POST | Create a new configuration |
| /v1/configurations/{id} | PUT | Update a configuration |
| /v1/configurations/{id}/versions | GET | List configuration version history |
Policies
Manage security policies and implement policy-as-code security principles for automated compliance checks.
| Endpoint | Method | Description |
|---|---|---|
| /v1/policies | GET | List all security policies |
| /v1/policies/{id} | GET | Get a specific policy |
| /v1/policies | POST | Create a new policy |
| /v1/policies/{id}/validate | POST | Validate configuration against policy |
| /v1/policies/{id}/enforce | POST | Enforce policy across all configurations |
For the complete API documentation, including detailed request and response schemas, please download our comprehensive API documentation.
SDKs & Libraries
We provide client libraries for popular programming languages to help you integrate with our security automation API quickly and easily.
JavaScript/Node.js
Integrate DevSecOps automation into your JavaScript applications.
npm install veltrix-secops-sdkPython
Add security configuration management to your Python applications.
pip install veltrix-secopsGo
Build secure infrastructure tools with our Go library.
go get github.com/veltrix/secops-goComing Soon
Additional libraries for Java, Ruby, and .NET are in development.
Request Language Support →Ready to Get Started?
Explore our API and start integrating security automation, version control for security, and policy-as-code security into your workflows today.
Documentation Feedback
Was this API documentation helpful? Let us know how we can improve it.