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

Validation
GET <baseUrl>/v1/api/{apiId}/test-suite/{itemId}

GET Get Test Suite by ID

Retrieve a specific test suite item by its unique identifier.

Responses

200 Test suite retrieved successfully.
application/json
Type: [object] 
{
  "properties": {
    "createdAt": {
      "format": "date-time",
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "tests": {
      "items": {
        "type": "object"
      },
      "type": "array"
    },
    "updatedAt": {
      "format": "date-time",
      "type": "string"
    }
  },
  "type": "object"
}
{
  "createdAt": "2025-01-01T10:00:00Z",
  "description": "Test suite for user management endpoints",
  "id": "ts-123",
  "name": "User API Tests",
  "tests": [
    {
      "endpoint": "/users",
      "id": "test-001",
      "method": "POST",
      "name": "Create User Test"
    }
  ],
  "updatedAt": "2025-01-15T14:30:00Z"
}
401 Unauthorized
404 Test suite not found

OPTIONS Options for test suite by ID

Responses

200 Options successful. Returns allowed HTTP methods.

POST Update Test Suite by ID

Update an existing test suite item by its unique identifier.

Request Body

Required
application/json
{
  "properties": {
    "description": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  },
  "type": "object"
}
{
  "description": "Updated test suite description",
  "name": "Updated Test Suite Name"
}

Responses

200 Test suite updated successfully.
application/json
Type: [object] 
{
  "properties": {
    "description": {
      "type": "string"
    },
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "updatedAt": {
      "format": "date-time",
      "type": "string"
    }
  },
  "type": "object"
}
400 Invalid request
401 Unauthorized
404 Test suite not found

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