---
title: "Job Dry Run"
method: POST
path: "/api/v1/pipelines/jobs/dry-run"
tags: ["secure"]
---

# Job Dry Run

`POST /api/v1/pipelines/jobs/dry-run`

Executes a job using input data in a dry-run mode.

## Request body

- JobDryRunBody
  - `job` Job, required
    - `source` Source, required
      - `schema` string, nullable
      - `table` string, nullable
      - `row_format` 'full' | 'partial', nullable
    - `transform` Transform[], nullable
      - `uses` string, required
      - `with` union, required
        - WithInput
          - `expression` string, required
          - `field` string, nullable — This field it available only for a subset of with expressions e.g. `add_field`, `remove_field`.
          - `language` string, required
        - WithFields
          - `fields` union[], required
            - union
              - …
        - WithNest
          - `nest` object, required — Nesting configuration for hierarchical data structures.
          - `on_update` string, nullable
          - `data_type` string, nullable
          - `connection` string, nullable
        - WithConnection
          - `connection` string, nullable
          - `data_type` string, nullable
          - `args` union
            - object
            - unknown[]
              - …
          - `key` WithInput
            - `expression` string, required
            - `field` string, nullable — This field it available only for a subset of with expressions e.g. `add_field`, `remove_field`.
            - `language` string, required
          - `cmd` string, nullable — Redis command to execute, e.g. HGETALL.
          - `language` string, nullable
          - `field` string, nullable — Target field name for the lookup result.
    - `output` Output[], required
      - `uses` string, required
      - `with` union, required
        - WithInput
          - `expression` string, required
          - `field` string, nullable — This field it available only for a subset of with expressions e.g. `add_field`, `remove_field`.
          - `language` string, required
        - WithFields
          - `fields` union[], required
            - union
              - …
        - WithNest
          - `nest` object, required — Nesting configuration for hierarchical data structures.
          - `on_update` string, nullable
          - `data_type` string, nullable
          - `connection` string, nullable
        - WithConnection
          - `connection` string, nullable
          - `data_type` string, nullable
          - `args` union
            - object
            - unknown[]
              - …
          - `key` WithInput
            - `expression` string, required
            - `field` string, nullable — This field it available only for a subset of with expressions e.g. `add_field`, `remove_field`.
            - `language` string, required
          - `cmd` string, nullable — Redis command to execute, e.g. HGETALL.
          - `language` string, nullable
          - `field` string, nullable — Target field name for the lookup result.
    - `name` string, nullable
  - `input_data` object[], required

## Response `200`

Successful Response

- union
  - JobDryRunSuccessResponse
    - `transformation` object[], required
    - `output` unknown[], required
      - unknown
  - RedisDiApiV1ModulesSharedResponseError — Model representing an error status.
    - `status` 'error'
    - `error` string, required

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `422` — Unprocessable Entity

---

[API](https://skmtc.net/redis/apis/redis-data-integration-api.md) · [All operations](https://skmtc.net/redis/apis/redis-data-integration-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/redis/redis-data-integration-api/revisions/30f630f0aac5/schema)