Endpoints
For full request, response, and error details, see the generated reference pages:- List Applications – all applications in your project, including their kind (web or mobile)
- Create Application – creates a web or API application and its default environment (requires a
writekey). If an application with the same name already exists in the project, it is returned unchanged withcreated: false, so repeating the request is safe - Update Application –
PATCH /v1/applications/{applicationShortId}renames an application, changes its color, or changes its session state lifetime: how long cookies and storage saved by a login test stay valid for dependent tests (requires awritekey). Only the fields you pass change - List Application Environments – the environments configured for a specific application, including custom headers and basic auth domains and usernames (basic auth passwords are never returned), and for mobile environments the default
applicationBuildShortId - Create Environment –
POST /v1/applications/{applicationShortId}/environmentsadds an environment, such as staging or production, to a web or API application (requires awritekey). An environment with the same name on that application is returned unchanged withcreated: false - Update Environment –
PATCH /v1/applications/{applicationShortId}/environments/{environmentShortId}renames an environment, changes its URL or production flag, or makes an uploaded build a mobile environment’s default (requires awritekey). See Keep the environment on the latest merged build - Delete Environment –
DELETE /v1/applications/{applicationShortId}/environments/{environmentShortId}deletes an environment, like Delete in Settings → Applications & Envs (requires awritekey). The application’s default environment cannot be deleted and returns409
For mobile applications, the iOS/Android platform is set per build when
uploading application builds, not on the
application itself.
Authentication
All endpoints require Bearer token authentication. Create your API key in the QA.tech dashboard: Organization Settings → API Keys. The key is shown only once, at creation. See the API Introduction for details, including how organization-scoped keys passprojectShortId.
Typical Workflow
A common pattern is to discover IDs dynamically instead of hardcoding them:- Call List Applications to find the application’s
shortId. - Call List Application Environments with that ID to find the environment you want to test against (for example, the first non-production environment, using the
isProductionflag). - Pass the discovered IDs as application/environment overrides when starting a run or creating a chat conversation. To persist auth or protection-bypass headers on that environment, include
customHeaderson the environment override; for HTTP basic auth, includebasicAuth. See Environment custom headers.
Related documentation
- Start Run API – Use application/environment IDs to run tests
- Environment custom headers – Persist auth and protection-bypass headers from the Start Run API
- Environment basic auth – Persist domain-scoped HTTP basic auth from the Start Run API
- Chat API – Use application overrides in chat conversations
- Applications and Environments – Learn about the application model
- API Introduction – Authentication and ID reference