Vaktum - /v1/test-suite/{testSuiteID}/steps/{stepID} Documentation

/v1/test-suite/{testSuiteID}/steps/{stepID}

Steps

DELETE <baseUrl>/v1/test-suite/{testSuiteID}/steps/{stepID}

DELETE Delete a step from a test suite

Deletes a step by ID from the specified test suite. Will return an error if the step is referenced by any tests within the test suite.

Responses

204 Successfully deleted shared step

401 Unauthorized - invalid or expired authentication credentials

application/json

Schema: ErrorResponse

404 Shared step not found

application/json

Schema: ErrorResponse

409 Conflict - shared step is in use by one or more test suites

application/json

Type: [object]

{
  "properties": {
    "error": {
      "description": "Error message",
      "type": "string"
    },
    "testSuites": {
      "description": "List of test suite IDs that reference this shared step",
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  "type": "object"
}

500 Server error while deleting shared step

application/json

Schema: ErrorResponse

GET Get a specific step from a test suite

Retrieves a specific step by ID from the embedded steps in the specified test suite.

Responses

200 Successfully retrieved shared step

application/json

Schema: TestStep

401 Unauthorized - invalid or expired authentication credentials

application/json

Schema: ErrorResponse

404 Shared step not found

application/json

Schema: ErrorResponse

500 Server error while retrieving shared step

application/json

Schema: ErrorResponse

OPTIONS CORS support for specific step

Enable CORS by returning correct headers

Responses

200 CORS headers returned

PUT Update an existing step within a test suite

Updates an existing step by ID within the embedded steps of the specified test suite.

Request Body

Required

Updated shared step

application/json

Schema: TestStep

Responses

200 Successfully updated shared step

application/json

Schema: TestStep

400 Bad request - invalid input

application/json

Schema: ErrorResponse

401 Unauthorized - invalid or expired authentication credentials

application/json

Schema: ErrorResponse

404 Shared step not found

application/json

Schema: ErrorResponse

500 Server error while updating shared step

application/json

Schema: ErrorResponse

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