Skip to main content
The Vidoc API uses API keys for authentication. All requests must include a valid API key.

Getting an API Key

  1. Go to app.vidocsecurity.com
  2. Select your project
  3. Navigate to SettingsAPI Keys
  4. Click “Create API Key”
  5. Copy and store the key securely
See API Keys for detailed management.

Authentication Methods

Include the API key in the Authorization header:

Header Token

Alternatively, use the X-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

  1. Never commit API keys - Use environment variables
  2. Rotate keys regularly - Create new keys every 90 days
  3. Use separate keys - One per environment/purpose
  4. Monitor usage - Check last used timestamps
  5. Revoke compromised keys - Immediately if exposed

API Keys

Manage API keys

Scanning API

Start scans via API

Issues API

Access issues via API

CLI Authentication

CLI auth methods