VaultKey API Documentation

Build secure applications with the VaultKey API. Access passwords, secrets, and security features programmatically.

Authentication

VaultKey uses API keys for authentication. Include your API key in the Authorization header of every request.

Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

Quick Start

Get started with the VaultKey API in minutes. Here's a simple example to retrieve your passwords.

curl -X GET https://api.vaultkey.io/v1/passwords \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

{
  "status": "success",
  "data": {
    "passwords": [
      {
        "id": "pwd_1234567890",
        "name": "Google",
        "username": "john@gmail.com",
        "url": "https://google.com",
        "category": "email",
        "strength": "strong",
        "created_at": "2024-01-15T10:30:00Z"
      }
    ],
    "total": 247,
    "page": 1
  }
}

Passwords API

Manage passwords in your vault programmatically.

{
  "name": "Netflix",
  "username": "john@gmail.com",
  "password": "encrypted_password_string",
  "url": "https://netflix.com",
  "category": "entertainment",
  "notes": "Family account"
}

Password Generator API

Generate secure passwords programmatically.

{
  "length": 16,
  "uppercase": true,
  "lowercase": true,
  "numbers": true,
  "symbols": true,
  "avoid_ambiguous": false
}

{
  "password": "Xk9#mP2$vL7@nQ4",
  "strength": "very_strong",
  "entropy": 95.2
}

Secure Notes API

Store and manage encrypted secure notes including recovery codes, licenses, and sensitive documents.

{
  "title": "AWS Recovery Codes",
  "type": "recovery_code",
  "content": "encrypted_content_string",
  "folder_id": "fld_123456",
  "tags": ["aws", "cloud"]
}

Security Audit API

Analyze your vault's security posture, identify weak passwords, and check for breached credentials.

{
  "security_score": 78,
  "weak_passwords": 5,
  "reused_passwords": 12,
  "old_passwords": 8,
  "breached_passwords": 2,
  "missing_2fa": 15,
  "recommendations": [...]
}

{
  "password_hash": "sha1_prefix_of_password"
}

Team Management API

Manage team members, groups, and shared vault access.

{
  "members": [
    {
      "id": "usr_123",
      "email": "john@company.com",
      "role": "admin",
      "status": "active",
      "groups": ["Engineering", "DevOps"]
    }
  ],
  "total": 12
}

{
  "email": "newmember@company.com",
  "role": "member",
  "groups": ["grp_engineering"]
}

{
  "item_id": "pwd_123456",
  "share_with": ["usr_456", "grp_engineering"],
  "permissions": "read"
}

Webhooks

Receive real-time notifications when events occur in your vault.

{
  "url": "https://yourapp.com/webhooks/vaultkey",
  "events": ["password.created", "security.breach_detected"],
  "secret": "your_webhook_secret"
}

{
  "id": "evt_123456789",
  "event": "password.created",
  "timestamp": "2024-01-15T10:30:00Z",
  "data": {
    "password_id": "pwd_987654321",
    "name": "Netflix",
    "category": "entertainment"
  }
}

Error Codes

The API uses standard HTTP status codes to indicate success or failure.

SDKs & Libraries

Official client libraries for popular programming languages.

Rate Limits