Config reference

API base address; protocol is prepended from defaultProtocol if omitted. Exposed as {{baseUrl}}.

Protocol prepended to baseUrl when none is given (default: https).

"https"

Expected HTTP status code(s). A number or a list; response passes if its code is included. Drives negative testing. Default: [200, 201, 202].

Expected response content type; asserted as a substring of the response Content-Type, so 'json' or a full MIME like 'application/json' both work.

"json"

Set true for requests that return an empty body (e.g. 204). Inverts the body-not-empty assertion.

Maximum allowed response time in milliseconds; fails the test if slower.

Response size budget in bytes. Values <= 0 disable the check.

Assert fields exist (and optionally match a value) at the given JSONPath-lite paths.

Extract-and-save: alias -> spec. Saves the value at path into a Postman variable.

Count entries: alias -> spec. Asserts the number of array/object entries at path.

Shorthand assertion map: field path -> operators. All operators combine.

Validate every element of an array against a set of per-field rules.

One-line structural type checks: field path -> expected type.

Assert an array is sorted by a field.

Assert all array elements are unique (by value, or by a field).

Assert response headers exist / match / are absent.

Authentication plugin. Disabled unless enabled:true.

GraphQL contract checks. GraphQL answers 200 even when the body carries errors[], so status alone proves nothing. true is shorthand for { noErrors: true }.

Response snapshot regression. Disabled unless enabled:true (or record:true).

Top-level alias for snapshot.record: force-overwrite the snapshot baseline on the next run.

JSON Schema validation of the parsed response via tv4 (draft-04/07). Disabled unless enabled:true.

Passive response security audit. Disabled unless enabled:true. Providing a list replaces the corresponding built-in default.

Auto-retry the request while its status is in the list (setNextRequest). Skips the rest of the pipeline on intermediate attempts.

Format for the built-in date variables and dates expressions (tokens: yyyy MM dd hh mm ss nnn tt00). Default: yyyy-MM-dd.

Custom date variables: variable name -> expression (today, yesterday, tomorrow, startOfMonth, endOfMonth, startOfNextMonth, endOfNextMonth, startOfPrevMonth, endOfPrevMonth, startOfYear, endOfYear, today+7d / today-1m / today+1y ...).

Generate pm.variables before the request: variable name -> generator (random.uuid, random.email, random.bool, random.str, random.str:N, random.int:min:max, random.float:min:max:dec, random.date) or a literal string.

Environment variables that must be set (non-empty) before the request is sent.

Emit a structured [HEPHAESTUS_CI] JSON line per request, regardless of logLevel.

Engine output language. Default: ru.

Console verbosity. Default: normal.

Global soft mode: functional assertion failures are logged as warnings instead of failing the run.

Key-name fragments whose values are masked in logs (substring, case-insensitive).

Fail the run when an override contains a key the engine does not know. Off by default: unknown keys only warn.

Key names to treat as known even under strictMode. This is how a third-party plugin allowlists its own config, e.g. the gallery plugins in gallery/plugins/.

Incoming-webhook URL for docs/plugins/slack-notifier.js. Read off ctx.config by that plugin, not by the engine.

slack-notifier: notify only when something failed (default true).

Incoming-webhook URL for docs/plugins/teams-notifier.js.

teams-notifier: notify only when something failed (default true).

Latency ceiling asserted by docs/plugins/custom-assertions.js (default 3000).

custom-assertions: assert an Access-Control-Allow-Origin header is present.

custom-assertions: assert the body follows the JSON:API envelope.

Editor-only JSON Schema association (e.g. ../docs/override.schema.json). Ignored by the engine and stripped from the shipped collection at build time.

Non-engine annotation used in the shipped setup/defaults.json template. Delete before copying into collectionVariables['hephaestus.defaults'].