/v1/download/{artefactType}/{itemId}

Utility
GET <baseUrl>/v1/download/{artefactType}/{itemId}

GET Download Artefact

Download a specific artefact by its unique identifier. Artefact types can include API specifications, test results, and other generated files.

Responses

200 Artefact downloaded successfully.
application/json
Type: [object] 
{
  "description": "JSON content (if the artefact is a JSON file)",
  "type": "object"
}
application/octet-stream
Type: [string] 
{
  "description": "Binary content of the requested artefact",
  "format": "binary",
  "type": "string"
}
text/plain
Type: [string] 
{
  "description": "Plain text content (if the artefact is a text file)",
  "type": "string"
}
400 Invalid artefact type or item ID
401 Unauthorized - authentication required
404 Artefact not found

OPTIONS Options for download

Responses

200 Options successful. Returns allowed HTTP methods.

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