/v1/api/{apiId}/test-suite/run-test

Validation
POST <baseUrl>/v1/api/{apiId}/test-suite/run-test

POST Run Test Suite or Single Test

Run all tests in a test suite, or a single test if 'singleTestId' query parameter is provided.

Parameters

Name In Required Type Description
apiId path Required [string] The unique identifier of the API.
testSuiteId query Required [string] The unique identifier of the test suite.
environmentId query Required [string] The unique identifier of the environment.
singleTestId query Optional [string] If provided, only this test case will be executed within the test suite.

Responses

200 Test suite or single test run successfully. Returns the test results.
application/json
Type: [object] 
{
  "properties": {
    "completedAt": {
      "description": "When the test execution completed",
      "format": "date-time",
      "type": "string"
    },
    "extractedValues": {
      "additionalProperties": {
        "type": "string"
      },
      "description": "Map of values extracted during test execution that can be referenced across test steps",
      "type": "object"
    },
    "id": {
      "description": "Unique ID for the test execution",
      "type": "string"
    },
    "results": {
      "description": "Array of individual test results",
      "items": {
        "properties": {
          "duration": {
            "description": "Test execution time in milliseconds",
            "type": "number"
          },
          "errorMessage": {
            "description": "Error message if the test failed",
            "type": "string"
          },
          "name": {
            "description": "Name of the test",
            "type": "string"
          },
          "notes": {
            "description": "Additional notes or information about the test execution",
            "type": "string"
          },
          "status": {
            "description": "Status of this individual test",
            "enum": [
              "success",
              "failure",
              "skipped"
            ],
            "type": "string"
          },
          "testId": {
            "description": "ID of the individual test",
            "type": "string"
          },
          "timeCompleted": {
            "description": "When this individual test was completed",
            "format": "date-time",
            "type": "string"
          }
        },
        "type": "object"
      },
      "type": "array"
    },
    "startedAt": {
      "description": "When the test execution started",
      "format": "date-time",
      "type": "string"
    },
    "status": {
      "description": "Overall test execution status",
      "enum": [
        "success",
        "failure",
        "partial_success"
      ],
      "type": "string"
    }
  },
  "type": "object"
}
{
  "completedAt": "2025-05-14T14:30:05Z",
  "id": "exec-abc123",
  "results": [
    {
      "duration": 245.5,
      "name": "Verify user creation",
      "status": "success",
      "testId": "test-001"
    },
    {
      "duration": 125.2,
      "errorMessage": "Expected status code 204 but got 403",
      "name": "Verify user deletion",
      "status": "failure",
      "testId": "test-002"
    }
  ],
  "startedAt": "2025-05-14T14:30:00Z",
  "status": "partial_success"
}
400 Bad request - missing required parameters
application/json
Schema: ErrorResponse
401 Unauthorized
404 Test suite or environment not found
500 Internal server error

Security

  • 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