Skip to main content
POST
Create config

Body

application/json
name
string
required
Required string length: 2 - 100
type
enum<string>
required

Config types that can be created and edited over the API. File, audio, video and SMS phone number configs are managed in the dashboard.

Available options:
USERNAME_PASSWORD,
USERNAME_PASSWORD_2FA,
EMAIL_PASSWORD,
FIXED_EMAIL,
API_KEY,
API_CALL,
CUSTOM_FIELDS,
ONE_TIME_USE_ITEMS
data
object
required

Values for the config type:

  • USERNAME_PASSWORD: username, password, optional enableForBasicAuthentication (boolean).
  • USERNAME_PASSWORD_2FA: username, password, oneTimePasswordGoogleUri (otpauth://totp/...).
  • EMAIL_PASSWORD: password. QA.tech generates an inbox email the agent can receive mail on; it is returned as email.
  • FIXED_EMAIL: none. QA.tech generates an inbox email, returned as email.
  • API_KEY: apiKey.
  • API_CALL: optional url, method (GET, POST, PUT, DELETE, PATCH), headers (object), body (string). At least one of url, headers or body.
  • CUSTOM_FIELDS: fields, an array of { key, value } with unique keys.
  • ONE_TIME_USE_ITEMS: items, an array of strings. Each test run consumes one item.
description
string

When to use this config, e.g. an admin user with billing access.

Maximum string length: 2000
applicationShortId
string

Limit the config to one application. Omit to make it available to every application.

Pattern: ^app(-.+_.+|_.+)$
projectShortId
string

Target a specific project by its prefixed short ID (proj-slug_shortId or proj_shortId), as returned by the projects API. Required for organization-scoped API keys; project-scoped keys may only pass their own project's short ID.

Pattern: ^proj(-.+_.+|_.+)$

Response

200 - application/json

The request has succeeded.

success
boolean
required
config
object
required
email
string

Inbox address QA.tech generated for EMAIL_PASSWORD and FIXED_EMAIL configs.