Vaktum

Vaktum empowers developers and businesses to build and maintain reliable, well-tested APIs. This OpenAPI document describes the endpoints, request/response formats, and data models for the Vaktum platform. For a comprehensive guide, see https://vaktum.com/docs/.

Authentication

Vaktum supports two authentication methods:

1. OAuth2 (User Token) Authentication

   • Add the following headers to your request:
     • Authorization: Bearer <token> — The base64-encoded token obtained from Vaktum login.
     • X-WORKSPACE-ID: <workspaceId> — The workspace ID for which the operation is performed.

2. API Key Authentication

   • Add the following header to your request:
     • X-API-KEY: <api-key> — The API key generated from the Vaktum portal. The key encodes the workspaceId and authenticates you directly against a workspace.

You can use either method for all endpoints. If both headers are provided, the API key takes precedence.

• Environment

  • /v1/environment/{environmentId} GET PUT DELETE PATCH OPTIONS
    Get Environment by ID
  • /v1/environment GET POST OPTIONS
    Get Environments

• Job

  • /v1/job GET OPTIONS
    Get Jobs
  • /v1/job/{jobId} GET DELETE OPTIONS
    Get Job by ID
  • /v1/api/{apiId}/job/{jobType} GET OPTIONS
    Get Jobs by Type for API
  • /v1/api/{apiId}/job GET OPTIONS
    Get Jobs for API

• Notification

  • /notification-config GET POST PUT
    List all notification configs for a workspace
  • /notification-config/{eventType} GET DELETE
    Get notification config for event type

• ScheduledTasks

  • /scheduled-tasks GET POST
    List scheduled tasks
  • /scheduled-tasks/run-tasks POST
    Run scheduled tasks
  • /scheduled-tasks/{id} GET PUT DELETE
    Get a scheduled task

• Scraping

  • /v1/scrape POST OPTIONS
    Scrape API Documentation

• Specification

  • /v1/api/{apiId}/specification GET POST OPTIONS
    Get API Specification
  • /v1/specification GET POST OPTIONS
    Get Specifications
  • /v1/specification/{specificationId} GET POST OPTIONS
    Get Specification by ID
  • /v1/api GET POST OPTIONS
    Get APIs
  • /v1/api/{apiId} GET DELETE OPTIONS
    Get API by ID
  • /v1/api/{apiId}/specification/{itemId} GET POST OPTIONS
    Get API Specification by ID
  • /v1/api/{apiId}/data-model/{itemId} GET POST OPTIONS
    Get Data Model by ID
  • /v1/api/{apiId}/data-model GET POST OPTIONS
    Get Data Model

• Steps

  • /v1/test-suite/{testSuiteID}/steps/{stepID} GET PUT DELETE OPTIONS
    Get a specific step from a test suite
  • /v1/test-suite/{testSuiteID}/steps GET POST OPTIONS
    Get all steps for a test suite

• Utility

  • /v1/download/{artefactType}/{itemId} GET OPTIONS
    Download Artefact

• Validation

  • /v1/api/{apiId}/test-suite/run-test POST
    Run Test Suite or Single Test
  • /v1/api/{apiId}/test-suite-generate POST OPTIONS
    Generate Test Suite
  • /run-test-suite/{testSuiteId}/environment/{environmentId}/test/{testId} POST
    Run Single Test in Test Suite
  • /v1/api/{apiId}/test-suite/{itemId} GET POST OPTIONS
    Get Test Suite by ID
  • /v1/validate POST
    Validate an OpenAPI specification from base64 or URL input
  • /v1/api/{apiId}/test-suite GET POST OPTIONS
    Get Test Suite

• Webhook

  • /v1/incoming-webhook/{workspaceId}/{testID} POST
    Receive incoming webhook for a specific test
  • /v1/incoming-webhook/{workspaceId} POST
    Receive incoming webhook for a workspace

• apiKeyAuth [apiKey]
  API Key authentication. Use the X-API-KEY header (generated from the Vaktum portal) to authenticate directly to a workspace.
  In: header
  Name: X-API-KEY
• bearerAuth [http]
  OAuth2 authentication. Use the Authorization header with a Bearer token. Also provide X-WORKSPACE-ID header for workspace context.
  Scheme: bearer
  Bearer Format: JWT