Developer Documentation

Comprehensive API documentation, SDKs, and integration guides for developers. Build with VaultKey in minutes.

Getting Started

REST API

Complete REST API for all VaultKey operations. Comprehensive OpenAPI documentation with examples for every endpoint.

• Base URL: https://api.vaultkey.io/v1
• Authentication: Bearer token (JWT)
• Rate limiting: 1000 requests per minute
• Response format: JSON

Official SDKs

Officially maintained SDKs for popular programming languages. Type-safe, well-documented, and production-ready.

• Go: github.com/vaultkey/vaultkey-go
• Python: pip install vaultkey
• Node.js: npm install @vaultkey/sdk
• Java: com.vaultkey:vaultkey-sdk
• Ruby: gem install vaultkey

Core Concepts

Understand the fundamental concepts and terminology used in VaultKey.

• Secrets: Any sensitive data you want to protect (passwords, keys, tokens)
• Vaults: Logical groupings of related secrets
• Policies: Rules that govern who can access what
• Roles: Collections of permissions for users and applications

Authentication

Secure authentication mechanisms for API access. Support for API keys, JWT tokens, and OAuth 2.0.

• API Keys for service-to-service communication
• JWT tokens for user authentication
• OAuth 2.0 for third-party integrations
• Multi-factor authentication (MFA) support

Common Use Cases

Explore common patterns and best practices for using VaultKey.

• Injecting secrets into Kubernetes pods
• Rotating database credentials
• Managing CI/CD pipeline secrets
• Securing application configuration

Code Examples

Python SDK Example

from vaultkey import VaultKey

client = VaultKey(api_key="your-api-key")

secret = client.secrets.get("database-password")
print(secret.value)

client.secrets.create(
  name="api-key",
  value="secret-value",
  vault="production"
)

Go SDK Example

package main

import "github.com/vaultkey/vaultkey-go"

client := vaultkey.New("your-api-key")

secret, err := client.Secrets.Get(ctx, "db-password")
if err != nil {
  log.Fatal(err)
}

fmt.Println(secret.Value)

Ready to Build?

Start with our quick-start guide and run your first API call in minutes.

Get API Key