Getting an API Key
- Go to app.vidocsecurity.com
- Select your project
- Navigate to Settings → API Keys
- Click “Create API Key”
- Copy and store the key securely
Authentication Methods
Bearer Token (Recommended)
Include the API key in theAuthorization header:
Header Token
Alternatively, use theX-API-Key header:
Base URL
All API requests use:Request Format
Headers
Request Body
POST and PUT requests use JSON:Response Format
Success Response
Error Response
Error Codes
Rate Limits
Rate limit headers are included in responses:
Code Examples
JavaScript/Node.js
Python
cURL
Security Best Practices
- Never commit API keys - Use environment variables
- Rotate keys regularly - Create new keys every 90 days
- Use separate keys - One per environment/purpose
- Monitor usage - Check last used timestamps
- Revoke compromised keys - Immediately if exposed
Related Pages
API Keys
Manage API keys
Scanning API
Start scans via API
Issues API
Access issues via API
CLI Authentication
CLI auth methods

