Skip to content

Zephyr Scale Cloud API: Missing attachment upload endpoints for test executions and test cases #456

@HoangNguyen0403

Description

@HoangNguyen0403

Summary

The Zephyr Scale Cloud REST API (api.zephyrscale.smartbear.com/v2) does not expose any attachment upload endpoints, while the Server/DC API (/rest/atm/1.0/) does. This gap prevents automated QA workflows from uploading evidence screenshots to Zephyr test executions via API.

What we tried

curl -X POST \
  "https://api.zephyrscale.smartbear.com/v2/testexecutions/PROJ-E12345/attachments" \
  -H "Authorization: Bearer $ZEPHYR_API_TOKEN" \
  -F "file=@screenshot.png"

# Result: HTTP 503 — "The Lambda function associated with the CloudFront distribution
# is invalid or doesn't have the required permissions"

Same 503 for:

  • GET /v2/testexecutions/{key}/attachments
  • POST /v2/testcases/{key}/attachments
  • GET /v2/testcases/{key}/attachments

Other sub-resources on the same base path work fine:

  • GET /v2/testexecutions/{key}/links → 200 ✅
  • PUT /v2/testexecutions/{key} → 200 ✅

Evidence from the official API spec

The Cloud OpenAPI spec (api.cloud.stripped.yml served from support.smartbear.com/zephyr-scale-cloud/api-docs/) has zero /attachments paths:

  • /testexecutions/{key} sub-resources: links, teststeps — no attachments
  • /testcases/{key} sub-resources: links, testscript, teststeps, versions — no attachments

An AttachmentMetadataInput schema exists but has no endpoint mapped to it.

Server/DC API has it

The Server/DC API v1 (docs) exposes:

  • POST /testcase/{testCaseKey}/attachments
  • GET /testcase/{testCaseKey}/attachments
  • POST /testcase/{testCaseKey}/step/{stepIndex}/attachments
  • GET /testcase/{testCaseKey}/step/{stepIndex}/attachments

Impact

QA automation workflows (AI-assisted and CI/CD) that verify user stories or bugs on UAT need to attach evidence screenshots to Zephyr test executions. Without an API endpoint, evidence must be uploaded manually through the Zephyr UI (drag-and-drop), which breaks the automation chain.

Community reference

This was also raised in the SmartBear community forum with no resolution:
https://community.smartbear.com/discussions/zephyrscale/zephyr-scale-testcase-attachment-api/233575

Feature request

Please add the following endpoints to the Zephyr Scale Cloud API v2:

  1. POST /v2/testexecutions/{testExecutionIdOrKey}/attachments — upload file attachment to a test execution
  2. GET /v2/testexecutions/{testExecutionIdOrKey}/attachments — list attachments on a test execution
  3. POST /v2/testcases/{testCaseKey}/attachments — upload file attachment to a test case
  4. GET /v2/testcases/{testCaseKey}/attachments — list attachments on a test case

And optionally expose an upload_attachment MCP tool in @smartbear/mcp so AI coding agents can attach evidence directly.

Environment

  • Zephyr Scale Cloud (Atlassian Cloud)
  • @smartbear/mcp@latest MCP server
  • Bearer token authentication
  • Zephyr status page shows "All Systems Operational" — this is a missing feature, not an outage
Image

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions