Introduction

Vaktum API

Vaktum API

The Vaktum API provides programmatic access to all Vaktum functionality, allowing you to integrate API testing, validation, and monitoring into your own applications and workflows.

Base URL

All API requests should be made to the following base URL:

https://api.vaktum.com/v1/

Authentication Methods

Vaktum API supports two authentication methods. Choose the one that best fits your use case:

1. OAuth2 (User Token) Authentication

  • Headers Required:
    • Authorization: Bearer <token> (token obtained from Vaktum login)
    • X-WORKSPACE-ID: <workspaceId> (the workspace to operate on)
  • Description:
    • Authenticate with a user token (JWT) obtained through Vaktum's login flow.
    • The X-WORKSPACE-ID header specifies the workspace context for the request.
  • OpenAPI Reference:
    • Security scheme: bearerAuth
    • Type: http, Scheme: bearer, Bearer format: JWT

2. API Key Authentication

  • Header Required:
    • X-API-KEY: <api-key> (generated from the Vaktum portal)
  • Description:
    • Authenticate directly against a workspace using an API key.
    • The API key encodes the workspace context, so no additional workspace header is needed.
  • OpenAPI Reference:
    • Security scheme: apiKeyAuth
    • Type: apiKey, In: header, Name: X-API-KEY

Managing API Keys

You can manage your API keys from the Vaktum web portal:

  1. Navigate to your workspace:
    • Go to Manage workspaceAPI Keys
  2. API Key Management Features:
    • Overview: View a list of all API keys associated with your workspace. API Key Overview
    • Create New API Keys: Generate new API keys for programmatic access. API Key Create
    • Retrieve API Keys: View details of already created API keys (note: for security, the key value may only be shown at creation).
    • Delete API Keys: Remove API keys that are no longer needed for security and access control. API Key Delete

API Documentation

Comprehensive API documentation is available at apidocs.vaktum.com, which includes:

  • Interactive API explorer
  • Request and response examples
  • Schema definitions
  • Authentication details
  • Rate limiting information

Rate Limits

The Vaktum API implements rate limiting to ensure fair usage:

  • Free tier: 1,000 requests per day
  • Pro tier: 10,000 requests per day
  • Enterprise tier: Custom limits based on your plan

Rate limit information is included in the response headers:

  • X-RateLimit-Limit: Your total request allocation
  • X-RateLimit-Remaining: Requests remaining in the current period
  • X-RateLimit-Reset: Time (in Unix epoch seconds) when the limit resets

Example API Requests

Create a Test Suite

curl -X POST "https://api.vaktum.com/v1/test-suites" \
  -H "X-API-KEY: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "API Health Check",
    "description": "Basic health check tests",
    "apiId": "api_12345"
  }'

Run Tests

curl -X POST "https://api.vaktum.com/v1/test-runs" \
  -H "X-API-KEY: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "testSuiteId": "ts_12345",
    "environmentId": "env_67890"
  }'

Webhooks

Vaktum can send webhook notifications for various events. See the Notifications section for more details on configuring webhooks.

Support

If you encounter any issues with the API, please contact our support team at api-support@vaktum.com or visit our community forum.