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

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

GET Get Test Suite

Retrieve the test suite associated with the specified API.

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"
}
401 Unauthorized
404 Test suite not found

OPTIONS Options for test suite

Responses

200 Options successful. Returns allowed HTTP methods.

POST Create Test Suite

Create a new test suite for the specified API.

Request Body

Required
application/json
{
  "properties": {
    "description": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  },
  "required": [
    "name"
  ],
  "type": "object"
}
{
  "description": "Validation tests for the e-commerce API endpoints",
  "name": "E-commerce API Tests"
}

Responses

201 Test suite created successfully.
application/json
Type: [object] 
{
  "properties": {
    "createdAt": {
      "format": "date-time",
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    }
  },
  "type": "object"
}
400 Invalid request
401 Unauthorized

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